{ "smithy": "2.0", "shapes": { "com.amazonaws.marketplacediscovery#AWSMarketplaceDiscovery": { "type": "service", "version": "2026-02-05", "operations": [ { "target": "com.amazonaws.marketplacediscovery#GetListing" }, { "target": "com.amazonaws.marketplacediscovery#GetOffer" }, { "target": "com.amazonaws.marketplacediscovery#GetOfferSet" }, { "target": "com.amazonaws.marketplacediscovery#GetOfferTerms" }, { "target": "com.amazonaws.marketplacediscovery#GetProduct" }, { "target": "com.amazonaws.marketplacediscovery#ListFulfillmentOptions" }, { "target": "com.amazonaws.marketplacediscovery#ListPurchaseOptions" }, { "target": "com.amazonaws.marketplacediscovery#SearchFacets" }, { "target": "com.amazonaws.marketplacediscovery#SearchListings" } ], "errors": [ { "target": "com.amazonaws.marketplacediscovery#AccessDeniedException" }, { "target": "com.amazonaws.marketplacediscovery#InternalServerException" }, { "target": "com.amazonaws.marketplacediscovery#ThrottlingException" }, { "target": "com.amazonaws.marketplacediscovery#ValidationException" } ], "traits": { "aws.api#service": { "sdkId": "Marketplace Discovery", "arnNamespace": "aws-marketplace", "endpointPrefix": "discovery-marketplace" }, "aws.auth#sigv4": { "name": "aws-marketplace" }, "aws.auth#sigv4a": { "name": "aws-marketplace" }, "aws.endpoints#dualStackOnlyEndpoints": {}, "aws.endpoints#standardRegionalEndpoints": {}, "aws.protocols#restJson1": {}, "smithy.api#auth": [ "aws.auth#sigv4", "aws.auth#sigv4a" ], "smithy.api#documentation": "

The AWS Marketplace Discovery API provides programmatic access to the AWS Marketplace catalog, including searching and browsing listings, retrieving product details and fulfillment options, and accessing public and private offer pricing and terms.

", "smithy.api#title": "AWS Marketplace Discovery", "smithy.rules#endpointBdd": { "version": "1.1", "parameters": { "UseFIPS": { "builtIn": "AWS::UseFIPS", "required": true, "default": false, "documentation": "When true, send this request to the FIPS-compliant regional endpoint. If the configured endpoint does not have a FIPS compliant endpoint, dispatching the request will return an error.", "type": "boolean" }, "Endpoint": { "builtIn": "SDK::Endpoint", "required": false, "documentation": "Override the endpoint used to send this request", "type": "string" }, "Region": { "builtIn": "AWS::Region", "required": false, "documentation": "The AWS region used to dispatch the request.", "type": "string" } }, "conditions": [ { "fn": "isSet", "argv": [ { "ref": "Endpoint" } ] }, { "fn": "isSet", "argv": [ { "ref": "Region" } ] }, { "fn": "aws.partition", "argv": [ { "ref": "Region" } ], "assign": "PartitionResult" }, { "fn": "booleanEquals", "argv": [ { "ref": "UseFIPS" }, true ] } ], "results": [ { "conditions": [], "error": "Invalid Configuration: FIPS and custom endpoint are not supported", "type": "error" }, { "conditions": [], "endpoint": { "url": { "ref": "Endpoint" }, "properties": {}, "headers": {} }, "type": "endpoint" }, { "conditions": [], "endpoint": { "url": "https://discovery-marketplace-fips.{Region}.{PartitionResult#dualStackDnsSuffix}", "properties": {}, "headers": {} }, "type": "endpoint" }, { "conditions": [], "endpoint": { "url": "https://discovery-marketplace.{Region}.{PartitionResult#dualStackDnsSuffix}", "properties": {}, "headers": {} }, "type": "endpoint" }, { "conditions": [], "error": "Invalid Configuration: Missing Region", "type": "error" } ], "root": 2, "nodeCount": 6, "nodes": "/////wAAAAH/////AAAAAAAAAAYAAAADAAAAAQAAAAQF9eEFAAAAAgAAAAUF9eEFAAAAAwX14QMF9eEEAAAAAwX14QEF9eEC" }, "smithy.rules#endpointRuleSet": { "version": "1.0", "parameters": { "UseFIPS": { "builtIn": "AWS::UseFIPS", "required": true, "default": false, "documentation": "When true, send this request to the FIPS-compliant regional endpoint. If the configured endpoint does not have a FIPS compliant endpoint, dispatching the request will return an error.", "type": "boolean" }, "Endpoint": { "builtIn": "SDK::Endpoint", "required": false, "documentation": "Override the endpoint used to send this request", "type": "string" }, "Region": { "builtIn": "AWS::Region", "required": false, "documentation": "The AWS region used to dispatch the request.", "type": "string" } }, "rules": [ { "conditions": [ { "fn": "isSet", "argv": [ { "ref": "Endpoint" } ] } ], "rules": [ { "conditions": [ { "fn": "booleanEquals", "argv": [ { "ref": "UseFIPS" }, true ] } ], "error": "Invalid Configuration: FIPS and custom endpoint are not supported", "type": "error" }, { "conditions": [], "endpoint": { "url": { "ref": "Endpoint" }, "properties": {}, "headers": {} }, "type": "endpoint" } ], "type": "tree" }, { "conditions": [], "rules": [ { "conditions": [ { "fn": "isSet", "argv": [ { "ref": "Region" } ] } ], "rules": [ { "conditions": [ { "fn": "aws.partition", "argv": [ { "ref": "Region" } ], "assign": "PartitionResult" } ], "rules": [ { "conditions": [ { "fn": "booleanEquals", "argv": [ { "ref": "UseFIPS" }, true ] } ], "endpoint": { "url": "https://discovery-marketplace-fips.{Region}.{PartitionResult#dualStackDnsSuffix}", "properties": {}, "headers": {} }, "type": "endpoint" }, { "conditions": [], "endpoint": { "url": "https://discovery-marketplace.{Region}.{PartitionResult#dualStackDnsSuffix}", "properties": {}, "headers": {} }, "type": "endpoint" } ], "type": "tree" } ], "type": "tree" }, { "conditions": [], "error": "Invalid Configuration: Missing Region", "type": "error" } ], "type": "tree" } ] }, "smithy.rules#endpointTests": { "testCases": [ { "documentation": "For custom endpoint with region not set and fips disabled", "expect": { "endpoint": { "url": "https://example.com" } }, "params": { "Endpoint": "https://example.com", "UseFIPS": false } }, { "documentation": "For custom endpoint with fips enabled", "expect": { "error": "Invalid Configuration: FIPS and custom endpoint are not supported" }, "params": { "Endpoint": "https://example.com", "UseFIPS": true } }, { "documentation": "For region us-east-1 with FIPS enabled and DualStack enabled", "expect": { "endpoint": { "url": "https://discovery-marketplace-fips.us-east-1.api.aws" } }, "params": { "Region": "us-east-1", "UseFIPS": true } }, { "documentation": "For region us-east-1 with FIPS disabled and DualStack enabled", "expect": { "endpoint": { "url": "https://discovery-marketplace.us-east-1.api.aws" } }, "params": { "Region": "us-east-1", "UseFIPS": false } }, { "documentation": "For region cn-northwest-1 with FIPS enabled and DualStack enabled", "expect": { "endpoint": { "url": "https://discovery-marketplace-fips.cn-northwest-1.api.amazonwebservices.com.cn" } }, "params": { "Region": "cn-northwest-1", "UseFIPS": true } }, { "documentation": "For region cn-northwest-1 with FIPS disabled and DualStack enabled", "expect": { "endpoint": { "url": "https://discovery-marketplace.cn-northwest-1.api.amazonwebservices.com.cn" } }, "params": { "Region": "cn-northwest-1", "UseFIPS": false } }, { "documentation": "For region us-gov-west-1 with FIPS enabled and DualStack enabled", "expect": { "endpoint": { "url": "https://discovery-marketplace-fips.us-gov-west-1.api.aws" } }, "params": { "Region": "us-gov-west-1", "UseFIPS": true } }, { "documentation": "For region us-gov-west-1 with FIPS disabled and DualStack enabled", "expect": { "endpoint": { "url": "https://discovery-marketplace.us-gov-west-1.api.aws" } }, "params": { "Region": "us-gov-west-1", "UseFIPS": false } }, { "documentation": "Missing region", "expect": { "error": "Invalid Configuration: Missing Region" } } ], "version": "1.0" } } }, "com.amazonaws.marketplacediscovery#AccessDeniedException": { "type": "structure", "members": { "message": { "target": "com.amazonaws.marketplacediscovery#ExceptionMessage" } }, "traits": { "smithy.api#documentation": "

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

", "smithy.api#error": "client", "smithy.api#httpError": 403 } }, "com.amazonaws.marketplacediscovery#AgreementResourceId": { "type": "string", "traits": { "smithy.api#length": { "min": 1, "max": 64 }, "smithy.api#pattern": "^[A-Za-z0-9_/-]+$" } }, "com.amazonaws.marketplacediscovery#AmazonMachineImageCidrIpAddressList": { "type": "list", "member": { "target": "smithy.api#String" } }, "com.amazonaws.marketplacediscovery#AmazonMachineImageEbsVolume": { "type": "structure", "members": { "volumeTypes": { "target": "com.amazonaws.marketplacediscovery#AmazonMachineImageEbsVolumeTypeList", "traits": { "smithy.api#documentation": "

The supported Amazon EBS volume types.

", "smithy.api#required": {} } }, "iops": { "target": "smithy.api#Integer", "traits": { "smithy.api#documentation": "

The total number of provisioned IOPS supported.

", "smithy.api#range": { "min": 0 } } } }, "traits": { "smithy.api#documentation": "

Contains supported Amazon EBS volume information for an AMI fulfillment option.

" } }, "com.amazonaws.marketplacediscovery#AmazonMachineImageEbsVolumeTypeList": { "type": "list", "member": { "target": "smithy.api#String", "traits": { "smithy.api#length": { "max": 256 } } }, "traits": { "smithy.api#length": { "max": 20 } } }, "com.amazonaws.marketplacediscovery#AmazonMachineImageFulfillmentOption": { "type": "structure", "members": { "fulfillmentOptionId": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "

The unique identifier of the fulfillment option.

", "smithy.api#required": {} } }, "fulfillmentOptionName": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "

The display name of the fulfillment option version.

", "smithy.api#required": {} } }, "fulfillmentOptionVersion": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "

The version identifier of the fulfillment option.

" } }, "fulfillmentOptionType": { "target": "com.amazonaws.marketplacediscovery#FulfillmentOptionType", "traits": { "smithy.api#documentation": "

The category of the fulfillment option.

", "smithy.api#required": {} } }, "fulfillmentOptionDisplayName": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "

A human-readable name for the fulfillment option type.

", "smithy.api#required": {} } }, "operatingSystems": { "target": "com.amazonaws.marketplacediscovery#AmazonMachineImageOperatingSystemList", "traits": { "smithy.api#documentation": "

The operating systems supported by this AMI.

", "smithy.api#required": {} } }, "recommendation": { "target": "com.amazonaws.marketplacediscovery#AmazonMachineImageRecommendation", "traits": { "smithy.api#documentation": "

Recommended instance types for running this AMI.

" } }, "releaseNotes": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "

Release notes describing changes in this version of the fulfillment option.

" } }, "usageInstructions": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "

Instructions on how to deploy and use this fulfillment option.

" } }, "availableFromTime": { "target": "smithy.api#Timestamp", "traits": { "smithy.api#documentation": "

The date and time when the AMI became available for fulfillment.

" } }, "accessUrlTemplate": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "

The URL pattern for accessing the product when an instance is running.

", "smithy.api#length": { "max": 1024 } } }, "architecture": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "

The architecture of the AMI, such as x86_64.

", "smithy.api#length": { "max": 256 }, "smithy.api#required": {} } }, "amiAlias": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "

The alias of the AMI associated with this fulfillment option.

", "smithy.api#length": { "max": 1024 } } }, "ebsVolume": { "target": "com.amazonaws.marketplacediscovery#AmazonMachineImageEbsVolume", "traits": { "smithy.api#documentation": "

The supported Amazon EBS volume configuration for the AMI.

" } }, "shortDescription": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "

A short description of the fulfillment option.

", "smithy.api#length": { "max": 4096 } } } }, "traits": { "smithy.api#documentation": "

Describes an Amazon Machine Image (AMI) fulfillment option, including version details, supported operating systems, and recommended instance types.

" } }, "com.amazonaws.marketplacediscovery#AmazonMachineImageOperatingSystem": { "type": "structure", "members": { "operatingSystemFamilyName": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "

The operating system family, such as Linux or Windows.

", "smithy.api#required": {} } }, "operatingSystemName": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "

The specific operating system name, such as Amazon Linux 2 or Windows Server 2022.

", "smithy.api#required": {} } }, "operatingSystemVersion": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "

The version of the operating system.

" } } }, "traits": { "smithy.api#documentation": "

Describes an operating system supported by an AMI fulfillment option.

" } }, "com.amazonaws.marketplacediscovery#AmazonMachineImageOperatingSystemList": { "type": "list", "member": { "target": "com.amazonaws.marketplacediscovery#AmazonMachineImageOperatingSystem" } }, "com.amazonaws.marketplacediscovery#AmazonMachineImageRecommendation": { "type": "structure", "members": { "instanceType": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "

The recommended EC2 instance type for this AMI.

", "smithy.api#required": {} } }, "securityGroups": { "target": "com.amazonaws.marketplacediscovery#AmazonMachineImageSecurityGroupList", "traits": { "smithy.api#documentation": "

The recommended security group configurations for this AMI.

" } } }, "traits": { "smithy.api#documentation": "

Recommended instance types for running an AMI fulfillment option.

" } }, "com.amazonaws.marketplacediscovery#AmazonMachineImageSecurityGroup": { "type": "structure", "members": { "protocol": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "

The IP protocol name, such as tcp.

", "smithy.api#required": {} } }, "fromPort": { "target": "smithy.api#Integer", "traits": { "smithy.api#documentation": "

The start of the port range.

", "smithy.api#required": {} } }, "toPort": { "target": "smithy.api#Integer", "traits": { "smithy.api#documentation": "

The end of the port range.

", "smithy.api#required": {} } }, "cidrIpAddresses": { "target": "com.amazonaws.marketplacediscovery#AmazonMachineImageCidrIpAddressList", "traits": { "smithy.api#documentation": "

The IP address ranges in CIDR format.

", "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "

Contains a recommended security group configuration for an AMI fulfillment option.

" } }, "com.amazonaws.marketplacediscovery#AmazonMachineImageSecurityGroupList": { "type": "list", "member": { "target": "com.amazonaws.marketplacediscovery#AmazonMachineImageSecurityGroup" } }, "com.amazonaws.marketplacediscovery#ApiFulfillmentOption": { "type": "structure", "members": { "fulfillmentOptionId": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "

The unique identifier of the fulfillment option.

", "smithy.api#required": {} } }, "fulfillmentOptionType": { "target": "com.amazonaws.marketplacediscovery#FulfillmentOptionType", "traits": { "smithy.api#documentation": "

The category of the fulfillment option.

", "smithy.api#required": {} } }, "fulfillmentOptionDisplayName": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "

A human-readable name for the fulfillment option type.

", "smithy.api#required": {} } }, "usageInstructions": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "

Instructions on how to integrate with and use this API.

" } }, "awsSupportedServices": { "target": "com.amazonaws.marketplacediscovery#AwsSupportedServiceList", "traits": { "smithy.api#documentation": "

The AWS services supported by this API integration.

", "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "

Describes an API-based fulfillment option, where the product is accessed through an API integration.

" } }, "com.amazonaws.marketplacediscovery#AwsSupportedService": { "type": "structure", "members": { "supportedServiceType": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "

The machine-readable identifier of the supported service.

", "smithy.api#required": {} } }, "displayName": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "

The human-readable name of the supported service.

", "smithy.api#required": {} } }, "description": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "

A description of the supported service.

", "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "

Describes an AWS service supported by a fulfillment option.

" } }, "com.amazonaws.marketplacediscovery#AwsSupportedServiceList": { "type": "list", "member": { "target": "com.amazonaws.marketplacediscovery#AwsSupportedService" } }, "com.amazonaws.marketplacediscovery#BillingPeriodType": { "type": "enum", "members": { "MONTHLY": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "Monthly" } } } }, "com.amazonaws.marketplacediscovery#BoundedString": { "type": "string", "traits": { "smithy.api#length": { "min": 1, "max": 4096 }, "smithy.api#pattern": "^(.)+$" } }, "com.amazonaws.marketplacediscovery#ByolPricingTerm": { "type": "structure", "members": { "id": { "target": "com.amazonaws.marketplacediscovery#TermId", "traits": { "smithy.api#documentation": "

The unique identifier of the term.

", "smithy.api#required": {} } }, "type": { "target": "com.amazonaws.marketplacediscovery#TermType", "traits": { "smithy.api#documentation": "

The category of the term.

", "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "

Defines a Bring Your Own License (BYOL) pricing term, where buyers use their existing license for the product.

" } }, "com.amazonaws.marketplacediscovery#Catalog": { "type": "string", "traits": { "smithy.api#length": { "min": 1, "max": 255 }, "smithy.api#pattern": "^[\\w\\-]+$" } }, "com.amazonaws.marketplacediscovery#Category": { "type": "structure", "members": { "categoryId": { "target": "com.amazonaws.marketplacediscovery#NonEmptyString", "traits": { "smithy.api#documentation": "

The machine-readable identifier of the category.

", "smithy.api#required": {} } }, "displayName": { "target": "com.amazonaws.marketplacediscovery#NonEmptyString", "traits": { "smithy.api#documentation": "

The human-readable name of the category.

", "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "

A category used to classify a listing or product into a logical group.

" } }, "com.amazonaws.marketplacediscovery#CategoryList": { "type": "list", "member": { "target": "com.amazonaws.marketplacediscovery#Category" }, "traits": { "smithy.api#length": { "max": 30 } } }, "com.amazonaws.marketplacediscovery#CloudFormationFulfillmentOption": { "type": "structure", "members": { "fulfillmentOptionId": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "

The unique identifier of the fulfillment option.

", "smithy.api#required": {} } }, "fulfillmentOptionName": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "

The display name of the fulfillment option version.

", "smithy.api#required": {} } }, "fulfillmentOptionType": { "target": "com.amazonaws.marketplacediscovery#FulfillmentOptionType", "traits": { "smithy.api#documentation": "

The category of the fulfillment option.

", "smithy.api#required": {} } }, "fulfillmentOptionDisplayName": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "

A human-readable name for the fulfillment option type.

", "smithy.api#required": {} } }, "fulfillmentOptionVersion": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "

The version identifier of the fulfillment option.

" } }, "releaseNotes": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "

Release notes describing changes in this version of the fulfillment option.

" } }, "usageInstructions": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "

Instructions on how to deploy and use this CloudFormation template.

" } }, "availableFromTime": { "target": "smithy.api#Timestamp", "traits": { "smithy.api#documentation": "

The date and time when the CloudFormation fulfillment option became available for fulfillment.

" } }, "shortDescription": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "

A short description of the fulfillment option.

", "smithy.api#length": { "max": 4096 } } }, "longDescription": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "

A detailed description of the fulfillment option.

", "smithy.api#length": { "max": 8192 } } } }, "traits": { "smithy.api#documentation": "

Describes an AWS CloudFormation template fulfillment option for infrastructure deployment.

" } }, "com.amazonaws.marketplacediscovery#ConfigurableUpfrontPricingTerm": { "type": "structure", "members": { "id": { "target": "com.amazonaws.marketplacediscovery#TermId", "traits": { "smithy.api#documentation": "

The unique identifier of the term.

", "smithy.api#required": {} } }, "type": { "target": "com.amazonaws.marketplacediscovery#TermType", "traits": { "smithy.api#documentation": "

The category of the term.

", "smithy.api#required": {} } }, "currencyCode": { "target": "com.amazonaws.marketplacediscovery#CurrencyCode", "traits": { "smithy.api#documentation": "

Defines the currency for the prices in this term.

", "smithy.api#required": {} } }, "rateCards": { "target": "com.amazonaws.marketplacediscovery#ConfigurableUpfrontRateCardList", "traits": { "smithy.api#documentation": "

The rate cards available for selection, each with a selector, constraints, and per-unit rates.

" } } }, "traits": { "smithy.api#documentation": "

Defines a configurable upfront pricing term with selectable rate cards, where buyers choose from predefined pricing configurations.

" } }, "com.amazonaws.marketplacediscovery#ConfigurableUpfrontRateCardItem": { "type": "structure", "members": { "selector": { "target": "com.amazonaws.marketplacediscovery#Selector", "traits": { "smithy.api#documentation": "

The selector criteria for this rate card, such as duration.

", "smithy.api#required": {} } }, "constraints": { "target": "com.amazonaws.marketplacediscovery#Constraints", "traits": { "smithy.api#documentation": "

Constraints on how the buyer can configure this rate card, such as whether multiple dimensions can be selected.

", "smithy.api#required": {} } }, "rateCard": { "target": "com.amazonaws.marketplacediscovery#RateCardList", "traits": { "smithy.api#documentation": "

The per-unit rates for this configuration.

", "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "

A rate card item within a configurable upfront pricing term, including a selector for choosing the configuration and per-unit rates.

" } }, "com.amazonaws.marketplacediscovery#ConfigurableUpfrontRateCardList": { "type": "list", "member": { "target": "com.amazonaws.marketplacediscovery#ConfigurableUpfrontRateCardItem" } }, "com.amazonaws.marketplacediscovery#Constraints": { "type": "structure", "members": { "multipleDimensionSelection": { "target": "com.amazonaws.marketplacediscovery#RateCardConstraintType", "traits": { "smithy.api#documentation": "

Whether the buyer can select multiple dimensions. Values are Allowed or Disallowed.

", "smithy.api#required": {} } }, "quantityConfiguration": { "target": "com.amazonaws.marketplacediscovery#RateCardConstraintType", "traits": { "smithy.api#documentation": "

Whether the buyer can configure quantities. Values are Allowed or Disallowed.

", "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "

Constraints that control how a buyer can configure a rate card.

" } }, "com.amazonaws.marketplacediscovery#ContainerFulfillmentOption": { "type": "structure", "members": { "fulfillmentOptionId": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "

The unique identifier of the fulfillment option.

", "smithy.api#required": {} } }, "fulfillmentOptionName": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "

The display name of the fulfillment option version.

", "smithy.api#required": {} } }, "fulfillmentOptionType": { "target": "com.amazonaws.marketplacediscovery#FulfillmentOptionType", "traits": { "smithy.api#documentation": "

The category of the fulfillment option.

", "smithy.api#required": {} } }, "fulfillmentOptionDisplayName": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "

A human-readable name for the fulfillment option type.

", "smithy.api#required": {} } }, "fulfillmentOptionVersion": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "

The version identifier of the fulfillment option.

" } }, "operatingSystems": { "target": "com.amazonaws.marketplacediscovery#ContainerOperatingSystemList", "traits": { "smithy.api#documentation": "

The operating systems supported by this container image.

" } }, "awsSupportedServices": { "target": "com.amazonaws.marketplacediscovery#AwsSupportedServiceList", "traits": { "smithy.api#documentation": "

The AWS services supported by this container deployment.

" } }, "releaseNotes": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "

Release notes describing changes in this version of the fulfillment option.

" } }, "usageInstructions": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "

Instructions on how to deploy and use this container image.

" } } }, "traits": { "smithy.api#documentation": "

Describes a container image fulfillment option for container-based deployment.

" } }, "com.amazonaws.marketplacediscovery#ContainerOperatingSystem": { "type": "structure", "members": { "operatingSystemFamilyName": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "

The operating system family, such as Linux.

", "smithy.api#required": {} } }, "operatingSystemName": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "

The specific operating system name.

", "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "

Describes an operating system supported by a container fulfillment option.

" } }, "com.amazonaws.marketplacediscovery#ContainerOperatingSystemList": { "type": "list", "member": { "target": "com.amazonaws.marketplacediscovery#ContainerOperatingSystem" } }, "com.amazonaws.marketplacediscovery#CurrencyCode": { "type": "string", "traits": { "smithy.api#length": { "min": 3, "max": 3 }, "smithy.api#pattern": "^[A-Z]+$" } }, "com.amazonaws.marketplacediscovery#DataArtifact": { "type": "structure", "members": { "description": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "

A description of the data artifact.

" } }, "resourceArn": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the data artifact.

" } }, "resourceType": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "

The type of the data artifact resource.

", "smithy.api#required": {} } }, "dataClassification": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "

The classification of sensitive data contained in the dataset.

", "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "

Describes a data artifact within a Data Exchange fulfillment option.

" } }, "com.amazonaws.marketplacediscovery#DataArtifactList": { "type": "list", "member": { "target": "com.amazonaws.marketplacediscovery#DataArtifact" } }, "com.amazonaws.marketplacediscovery#DataExchangeFulfillmentOption": { "type": "structure", "members": { "fulfillmentOptionId": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "

The unique identifier of the fulfillment option.

", "smithy.api#required": {} } }, "fulfillmentOptionType": { "target": "com.amazonaws.marketplacediscovery#FulfillmentOptionType", "traits": { "smithy.api#documentation": "

The category of the fulfillment option.

", "smithy.api#required": {} } }, "fulfillmentOptionDisplayName": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "

A human-readable name for the fulfillment option type.

", "smithy.api#required": {} } }, "dataArtifacts": { "target": "com.amazonaws.marketplacediscovery#DataArtifactList", "traits": { "smithy.api#documentation": "

The data artifacts included in this Data Exchange fulfillment option.

" } } }, "traits": { "smithy.api#documentation": "

Describes an AWS Data Exchange fulfillment option for data set delivery.

" } }, "com.amazonaws.marketplacediscovery#DeployedOnAwsStatus": { "type": "enum", "members": { "DEPLOYED": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "DEPLOYED" } }, "NOT_DEPLOYED": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "NOT_DEPLOYED" } }, "NOT_APPLICABLE": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "NOT_APPLICABLE" } } } }, "com.amazonaws.marketplacediscovery#DimensionLabel": { "type": "structure", "members": { "labelType": { "target": "com.amazonaws.marketplacediscovery#DimensionLabelType", "traits": { "smithy.api#documentation": "

The type of the dimension label, such as Region or SagemakerOption.

", "smithy.api#required": {} } }, "labelValue": { "target": "com.amazonaws.marketplacediscovery#BoundedString", "traits": { "smithy.api#documentation": "

The value used to group dimensions together.

", "smithy.api#required": {} } }, "displayName": { "target": "com.amazonaws.marketplacediscovery#BoundedString", "traits": { "smithy.api#documentation": "

The human-readable display name of the label.

" } } }, "traits": { "smithy.api#documentation": "

A label used to group or categorize pricing dimensions, such as by region or SageMaker option.

" } }, "com.amazonaws.marketplacediscovery#DimensionLabelList": { "type": "list", "member": { "target": "com.amazonaws.marketplacediscovery#DimensionLabel" } }, "com.amazonaws.marketplacediscovery#DimensionLabelType": { "type": "enum", "members": { "REGION": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "Region" } }, "SAGEMAKER_OPTION": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "SagemakerOption" } } } }, "com.amazonaws.marketplacediscovery#DocumentItem": { "type": "structure", "members": { "type": { "target": "com.amazonaws.marketplacediscovery#LegalDocumentType", "traits": { "smithy.api#documentation": "

The category of the legal document, such as StandardEula or CustomEula.

", "smithy.api#required": {} } }, "url": { "target": "com.amazonaws.marketplacediscovery#URL", "traits": { "smithy.api#documentation": "

The URL where the legal document can be accessed.

", "smithy.api#required": {} } }, "version": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "

The version of the standard contract, if applicable.

" } } }, "traits": { "smithy.api#documentation": "

A legal document associated with a legal term, such as a EULA or data subscription agreement.

" } }, "com.amazonaws.marketplacediscovery#DocumentList": { "type": "list", "member": { "target": "com.amazonaws.marketplacediscovery#DocumentItem" } }, "com.amazonaws.marketplacediscovery#Ec2ImageBuilderComponentFulfillmentOption": { "type": "structure", "members": { "fulfillmentOptionId": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "

The unique identifier of the fulfillment option.

", "smithy.api#required": {} } }, "fulfillmentOptionName": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "

The display name of the fulfillment option version.

", "smithy.api#required": {} } }, "fulfillmentOptionType": { "target": "com.amazonaws.marketplacediscovery#FulfillmentOptionType", "traits": { "smithy.api#documentation": "

The category of the fulfillment option.

", "smithy.api#required": {} } }, "fulfillmentOptionDisplayName": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "

A human-readable name for the fulfillment option type.

", "smithy.api#required": {} } }, "fulfillmentOptionVersion": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "

The version identifier of the fulfillment option.

" } }, "operatingSystems": { "target": "com.amazonaws.marketplacediscovery#ContainerOperatingSystemList", "traits": { "smithy.api#documentation": "

The operating systems supported by this EC2 Image Builder component.

" } }, "awsSupportedServices": { "target": "com.amazonaws.marketplacediscovery#AwsSupportedServiceList", "traits": { "smithy.api#documentation": "

The AWS services supported by this EC2 Image Builder component.

" } }, "releaseNotes": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "

Release notes describing changes in this version of the fulfillment option.

" } }, "usageInstructions": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "

Instructions on how to deploy and use this EC2 Image Builder component.

" } } }, "traits": { "smithy.api#documentation": "

Describes an EC2 Image Builder component fulfillment option.

" } }, "com.amazonaws.marketplacediscovery#EksAddOnFulfillmentOption": { "type": "structure", "members": { "fulfillmentOptionId": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "

The unique identifier of the fulfillment option.

", "smithy.api#required": {} } }, "fulfillmentOptionName": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "

The display name of the fulfillment option version.

", "smithy.api#required": {} } }, "fulfillmentOptionType": { "target": "com.amazonaws.marketplacediscovery#FulfillmentOptionType", "traits": { "smithy.api#documentation": "

The category of the fulfillment option.

", "smithy.api#required": {} } }, "fulfillmentOptionDisplayName": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "

A human-readable name for the fulfillment option type.

", "smithy.api#required": {} } }, "fulfillmentOptionVersion": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "

The version identifier of the fulfillment option.

" } }, "operatingSystems": { "target": "com.amazonaws.marketplacediscovery#EksAddOnOperatingSystemList", "traits": { "smithy.api#documentation": "

The operating systems supported by this EKS add-on.

" } }, "releaseNotes": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "

Release notes describing changes in this version of the fulfillment option.

" } }, "usageInstructions": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "

Instructions on how to deploy and use this EKS add-on.

" } }, "awsSupportedServices": { "target": "com.amazonaws.marketplacediscovery#AwsSupportedServiceList", "traits": { "smithy.api#documentation": "

The AWS services supported by this EKS add-on.

" } } }, "traits": { "smithy.api#documentation": "

Describes an Amazon EKS add-on fulfillment option.

" } }, "com.amazonaws.marketplacediscovery#EksAddOnOperatingSystem": { "type": "structure", "members": { "operatingSystemFamilyName": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "

The operating system family, such as Linux.

", "smithy.api#required": {} } }, "operatingSystemName": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "

The specific operating system name.

", "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "

Describes an operating system supported by an EKS add-on fulfillment option.

" } }, "com.amazonaws.marketplacediscovery#EksAddOnOperatingSystemList": { "type": "list", "member": { "target": "com.amazonaws.marketplacediscovery#EksAddOnOperatingSystem" } }, "com.amazonaws.marketplacediscovery#ExceptionMessage": { "type": "string" }, "com.amazonaws.marketplacediscovery#FacetTypeList": { "type": "list", "member": { "target": "com.amazonaws.marketplacediscovery#SearchFacetType" }, "traits": { "smithy.api#length": { "max": 30 } } }, "com.amazonaws.marketplacediscovery#FixedPercentage": { "type": "structure", "members": { "percentageValue": { "target": "com.amazonaws.marketplacediscovery#BoundedString", "traits": { "smithy.api#documentation": "

The percentage value applied at each renewal cycle.

", "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "

A single fixed price increase percentage applied at each renewal cycle.

" } }, "com.amazonaws.marketplacediscovery#FixedUpfrontPricingTerm": { "type": "structure", "members": { "id": { "target": "com.amazonaws.marketplacediscovery#TermId", "traits": { "smithy.api#documentation": "

The unique identifier of the term.

", "smithy.api#required": {} } }, "type": { "target": "com.amazonaws.marketplacediscovery#TermType", "traits": { "smithy.api#documentation": "

The category of the term.

", "smithy.api#required": {} } }, "currencyCode": { "target": "com.amazonaws.marketplacediscovery#CurrencyCode", "traits": { "smithy.api#documentation": "

Defines the currency for the prices in this term.

", "smithy.api#required": {} } }, "duration": { "target": "com.amazonaws.marketplacediscovery#BoundedString", "traits": { "smithy.api#documentation": "

The duration of the fixed pricing term, in ISO 8601 format.

" } }, "price": { "target": "com.amazonaws.marketplacediscovery#BoundedString", "traits": { "smithy.api#documentation": "

The price charged upfront for this term.

", "smithy.api#required": {} } }, "grants": { "target": "com.amazonaws.marketplacediscovery#GrantList", "traits": { "smithy.api#documentation": "

The entitlements granted to the buyer as part of this term.

", "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "

Defines a fixed upfront pricing term with a pre-paid amount and granted entitlements.

" } }, "com.amazonaws.marketplacediscovery#FreeTrialPricingTerm": { "type": "structure", "members": { "id": { "target": "com.amazonaws.marketplacediscovery#TermId", "traits": { "smithy.api#documentation": "

The unique identifier of the term.

", "smithy.api#required": {} } }, "type": { "target": "com.amazonaws.marketplacediscovery#TermType", "traits": { "smithy.api#documentation": "

The category of the term.

", "smithy.api#required": {} } }, "duration": { "target": "com.amazonaws.marketplacediscovery#BoundedString", "traits": { "smithy.api#documentation": "

The duration of the free trial period.

" } }, "grants": { "target": "com.amazonaws.marketplacediscovery#GrantList", "traits": { "smithy.api#documentation": "

The entitlements granted to the buyer during the free trial.

", "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "

Defines a free trial pricing term that enables customers to try the product before purchasing.

" } }, "com.amazonaws.marketplacediscovery#FulfillmentOption": { "type": "union", "members": { "amazonMachineImageFulfillmentOption": { "target": "com.amazonaws.marketplacediscovery#AmazonMachineImageFulfillmentOption", "traits": { "smithy.api#documentation": "

An Amazon Machine Image (AMI) fulfillment option for EC2 deployment.

" } }, "apiFulfillmentOption": { "target": "com.amazonaws.marketplacediscovery#ApiFulfillmentOption", "traits": { "smithy.api#documentation": "

An API-based fulfillment option for programmatic integration.

" } }, "cloudFormationFulfillmentOption": { "target": "com.amazonaws.marketplacediscovery#CloudFormationFulfillmentOption", "traits": { "smithy.api#documentation": "

An AWS CloudFormation template fulfillment option for infrastructure deployment.

" } }, "containerFulfillmentOption": { "target": "com.amazonaws.marketplacediscovery#ContainerFulfillmentOption", "traits": { "smithy.api#documentation": "

A container image fulfillment option for container-based deployment.

" } }, "helmFulfillmentOption": { "target": "com.amazonaws.marketplacediscovery#HelmFulfillmentOption", "traits": { "smithy.api#documentation": "

A Helm chart fulfillment option for Kubernetes deployment.

" } }, "eksAddOnFulfillmentOption": { "target": "com.amazonaws.marketplacediscovery#EksAddOnFulfillmentOption", "traits": { "smithy.api#documentation": "

An Amazon EKS add-on fulfillment option.

" } }, "ec2ImageBuilderComponentFulfillmentOption": { "target": "com.amazonaws.marketplacediscovery#Ec2ImageBuilderComponentFulfillmentOption", "traits": { "smithy.api#documentation": "

An EC2 Image Builder component fulfillment option.

" } }, "dataExchangeFulfillmentOption": { "target": "com.amazonaws.marketplacediscovery#DataExchangeFulfillmentOption", "traits": { "smithy.api#documentation": "

An AWS Data Exchange fulfillment option for data set delivery.

" } }, "professionalServicesFulfillmentOption": { "target": "com.amazonaws.marketplacediscovery#ProfessionalServicesFulfillmentOption", "traits": { "smithy.api#documentation": "

A professional services fulfillment option.

" } }, "saasFulfillmentOption": { "target": "com.amazonaws.marketplacediscovery#SaasFulfillmentOption", "traits": { "smithy.api#documentation": "

A Software as a Service (SaaS) fulfillment option.

" } }, "sageMakerAlgorithmFulfillmentOption": { "target": "com.amazonaws.marketplacediscovery#SageMakerAlgorithmFulfillmentOption", "traits": { "smithy.api#documentation": "

An Amazon SageMaker algorithm fulfillment option.

" } }, "sageMakerModelFulfillmentOption": { "target": "com.amazonaws.marketplacediscovery#SageMakerModelFulfillmentOption", "traits": { "smithy.api#documentation": "

An Amazon SageMaker model fulfillment option.

" } } }, "traits": { "smithy.api#documentation": "

Describes a fulfillment option for a product. Each element contains exactly one fulfillment option type.

" } }, "com.amazonaws.marketplacediscovery#FulfillmentOptionSummary": { "type": "structure", "members": { "fulfillmentOptionType": { "target": "com.amazonaws.marketplacediscovery#FulfillmentOptionType", "traits": { "smithy.api#documentation": "

The machine-readable type of the fulfillment option, such as SAAS or AMAZON_MACHINE_IMAGE.

", "smithy.api#required": {} } }, "displayName": { "target": "com.amazonaws.marketplacediscovery#NonEmptyString", "traits": { "smithy.api#documentation": "

The human-readable name of the fulfillment option type.

", "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "

A summary of a fulfillment option available for deploying or accessing a listing or product.

" } }, "com.amazonaws.marketplacediscovery#FulfillmentOptionSummaryList": { "type": "list", "member": { "target": "com.amazonaws.marketplacediscovery#FulfillmentOptionSummary" }, "traits": { "smithy.api#length": { "max": 20 } } }, "com.amazonaws.marketplacediscovery#FulfillmentOptionType": { "type": "enum", "members": { "AMAZON_MACHINE_IMAGE": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "AMAZON_MACHINE_IMAGE" } }, "API": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "API" } }, "CLOUDFORMATION_TEMPLATE": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "CLOUDFORMATION_TEMPLATE" } }, "CONTAINER": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "CONTAINER" } }, "HELM": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "HELM" } }, "EKS_ADD_ON": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "EKS_ADD_ON" } }, "EC2_IMAGE_BUILDER_COMPONENT": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "EC2_IMAGE_BUILDER_COMPONENT" } }, "DATA_EXCHANGE": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "DATA_EXCHANGE" } }, "PROFESSIONAL_SERVICES": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "PROFESSIONAL_SERVICES" } }, "SAAS": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "SAAS" } }, "SAGEMAKER_ALGORITHM": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "SAGEMAKER_ALGORITHM" } }, "SAGEMAKER_MODEL": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "SAGEMAKER_MODEL" } } } }, "com.amazonaws.marketplacediscovery#FulfillmentOptionsList": { "type": "list", "member": { "target": "com.amazonaws.marketplacediscovery#FulfillmentOption" } }, "com.amazonaws.marketplacediscovery#GetListing": { "type": "operation", "input": { "target": "com.amazonaws.marketplacediscovery#GetListingInput" }, "output": { "target": "com.amazonaws.marketplacediscovery#GetListingOutput" }, "errors": [ { "target": "com.amazonaws.marketplacediscovery#ResourceNotFoundException" } ], "traits": { "smithy.api#documentation": "

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

", "smithy.api#examples": [ { "title": "GetListing for SaaS listing", "input": { "locale": "en-US", "listingId": "prodview-sampleSaasId" }, "output": { "locale": "en-US", "listingId": "prodview-sampleSaasId", "catalog": "AWSMarketplace", "listingName": "sample SaaS listing", "logoThumbnailUrl": "https://example.com/logos/sample-saas-logo.png", "shortDescription": "A sample SaaS product for cloud development environments.", "longDescription": "A sample SaaS product that provides automated, ready-to-code development environments in the cloud.", "publisher": { "sellerProfileId": "seller-sampleSaasId", "displayName": "sample SaaS seller" }, "badges": [], "categories": [ { "categoryId": "developer-tools", "displayName": "Developer Tools" }, { "categoryId": "ide", "displayName": "IDE" } ], "highlights": [ "Automated dev environments", "Works with any Git repository", "Secure and compliant" ], "promotionalMedia": [ { "embeddedImage": { "title": "Sample Dashboard", "url": "https://example.com/screenshots/sample-dashboard.png", "description": "The sample product workspace dashboard" } } ], "resources": [ { "resourceType": "MANUFACTURER_INSTRUCTIONS", "contentType": "LINK", "value": "https://example.com/demo", "displayName": "Request a Demo" } ], "associatedEntities": [ { "product": { "productId": "prod-sampleSaasId", "productName": "sample SaaS product", "manufacturer": { "sellerProfileId": "seller-sampleSaasId", "displayName": "sample SaaS seller" } } } ], "reviewSummary": { "reviewSourceSummaries": [ { "sourceName": "AWS Marketplace", "sourceId": "AWS_MARKETPLACE", "sourceUrl": "https://aws.amazon.com/marketplace/reviews/prodview-sampleSaasId", "averageRating": "4.5", "totalReviews": 128 }, { "sourceName": "G2", "sourceId": "G2", "sourceUrl": "https://www.g2.com/products/sample-product/reviews", "averageRating": "4.6", "totalReviews": 1368 }, { "sourceName": "PeerSpot", "sourceId": "PEERSPOT", "sourceUrl": "https://www.peerspot.com/products/sample-product-reviews", "averageRating": "4.2", "totalReviews": 19 } ] }, "pricingModels": [ { "pricingModelType": "CONTRACT", "displayName": "Contract" } ], "pricingUnits": [ { "pricingUnitType": "USERS", "displayName": "Users" } ], "fulfillmentOptionSummaries": [ { "displayName": "SaaS", "fulfillmentOptionType": "SAAS" } ], "sellerEngagements": [ { "contentType": "LINK", "engagementType": "REQUEST_FOR_DEMO", "value": "https://aws.amazon.com/marketplace/customer-connect/demo/prodview-sampleSaasId" }, { "contentType": "LINK", "engagementType": "REQUEST_FOR_PRIVATE_OFFER", "value": "https://aws.amazon.com/marketplace/customer-connect/private-offer/prodview-sampleSaasId" } ], "useCases": [ { "useCase": { "displayName": "Contextual Analysis", "value": "CONTEXTUAL_ANALYSIS", "description": "Advanced contextual analysis for targeted advertising campaigns" } } ] } }, { "title": "GetListing for AMI listing with video", "input": { "locale": "en-US", "listingId": "prodview-sampleAmiId" }, "output": { "locale": "en-US", "listingId": "prodview-sampleAmiId", "catalog": "AWSMarketplace", "listingName": "sample AMI listing", "logoThumbnailUrl": "https://example.com/logos/sample-ami-logo.png", "shortDescription": "A sample high-performance load balancer and web server.", "longDescription": "A sample AMI product that provides load balancing, content caching, and API gateway capabilities optimized for cloud-native architectures.", "publisher": { "sellerProfileId": "seller-sampleAmiId", "displayName": "sample AMI seller" }, "badges": [ { "displayName": "Deployed on AWS", "badgeType": "DEPLOYED_ON_AWS" }, { "displayName": "Quick Launch", "badgeType": "QUICK_LAUNCH" } ], "categories": [ { "categoryId": "infrastructure", "displayName": "Infrastructure Software" }, { "categoryId": "load-balancing", "displayName": "Load Balancing" } ], "highlights": [ "Advanced load balancing", "API gateway capabilities", "High availability", "Real-time monitoring" ], "promotionalMedia": [ { "embeddedVideo": { "title": "Sample AMI Product Overview", "url": "https://example.com/videos/sample-overview.mp4", "preview": "https://example.com/videos/sample-cover.png", "thumbnail": "https://example.com/videos/sample-thumb.png", "description": "Learn about sample AMI product features" } } ], "resources": [ { "resourceType": "MANUFACTURER_INSTRUCTIONS", "contentType": "LINK", "value": "https://example.com/request-demo", "displayName": "Request Demo" }, { "resourceType": "MANUFACTURER_SUPPORT", "contentType": "LINK", "value": "https://example.com/docs", "displayName": "Documentation" } ], "associatedEntities": [ { "product": { "productId": "prod-sampleAmiId", "productName": "sample AMI product", "manufacturer": { "sellerProfileId": "seller-sampleAmiId", "displayName": "sample AMI seller" } }, "offer": { "offerId": "offer-sampleAmiId", "offerName": "sample AMI offer", "sellerOfRecord": { "sellerProfileId": "seller-sampleAmiId", "displayName": "sample AMI seller" } } } ], "reviewSummary": { "reviewSourceSummaries": [ { "sourceName": "AWS Marketplace", "sourceId": "AWS_MARKETPLACE", "sourceUrl": "https://aws.amazon.com/marketplace/reviews/prodview-sampleAmiId", "averageRating": "4.8", "totalReviews": 542 } ] }, "pricingModels": [ { "pricingModelType": "USAGE", "displayName": "Usage" } ], "pricingUnits": [ { "pricingUnitType": "HOSTS", "displayName": "Hosts" } ], "fulfillmentOptionSummaries": [ { "displayName": "SaaS", "fulfillmentOptionType": "SAAS" } ], "sellerEngagements": [ { "contentType": "LINK", "engagementType": "REQUEST_FOR_DEMO", "value": "https://aws.amazon.com/marketplace/customer-connect/demo/prodview-sampleAmiId" }, { "contentType": "LINK", "engagementType": "REQUEST_FOR_PRIVATE_OFFER", "value": "https://aws.amazon.com/marketplace/customer-connect/private-offer/prodview-sampleAmiId" } ], "useCases": [ { "useCase": { "displayName": "Contextual Analysis", "value": "CONTEXTUAL_ANALYSIS", "description": "Advanced contextual analysis for targeted advertising campaigns" } } ] } }, { "title": "GetListing for multi-product listing", "input": { "locale": "en-US", "listingId": "prodview-sampleMultiProductId" }, "output": { "locale": "en-US", "listingId": "prodview-sampleMultiProductId", "catalog": "AWSMarketplace", "listingName": "sample multi-product listing", "logoThumbnailUrl": "https://example.com/logos/sample-multi-product-logo.png", "shortDescription": "A sample multi-product listing that delivers a unified experience with AI.", "longDescription": "A sample multi-product listing that connects content management with a unified AI platform. Users can securely search, analyze, and extract valuable insights from their files.", "publisher": { "sellerProfileId": "seller-sampleMultiProductId", "displayName": "sample multi-product seller" }, "badges": [ { "displayName": "Deployed on AWS", "badgeType": "DEPLOYED_ON_AWS" }, { "displayName": "Multi-product", "badgeType": "MULTI_PRODUCT" } ], "categories": [], "highlights": [], "resources": [ { "resourceType": "MANUFACTURER_INSTRUCTIONS", "contentType": "LINK", "value": "https://developer.box.com/guides/box-mcp/remote/#amazon-quick-suite", "displayName": "Developer Documentation" } ], "promotionalMedia": [], "associatedEntities": [ { "product": { "productId": "prod-sampleMultiProduct1Id", "productName": "sample multi-product 1", "manufacturer": { "sellerProfileId": "seller-sampleMultiProductId", "displayName": "sample multi-product seller" } } }, { "product": { "productId": "prod-sampleMultiProduct2Id", "productName": "sample multi-product 2", "manufacturer": { "sellerProfileId": "seller-sampleMultiProduct2Id", "displayName": "sample multi-product seller 2" } } } ], "useCases": [ { "useCase": { "displayName": "Content Management System", "value": "content_management_system", "description": "This integration allows enterprises to securely access and interact with content in Box directly from the Amazon Quick Suite chat experience." } }, { "useCase": { "displayName": "Intelligent Document Processing", "value": "intelligent_document_processing", "description": "Build automated workflows and design custom AI agents for context-aware document processing." } } ], "integrationGuide": "To add the remote Box MCP server in Amazon Quick Suite, follow these steps: In the Amazon Quick Suite console, choose Integrations and create new integration by choosing Model Content Protocol.", "reviewSummary": { "reviewSourceSummaries": [] }, "pricingModels": [ { "pricingModelType": "FREE", "displayName": "Free" } ], "pricingUnits": [], "fulfillmentOptionSummaries": [ { "displayName": "SaaS", "fulfillmentOptionType": "SAAS" } ], "sellerEngagements": [ { "contentType": "LINK", "engagementType": "REQUEST_FOR_DEMO", "value": "https://aws.amazon.com/marketplace/customer-connect/demo/prodview-sampleMultiProductId" }, { "contentType": "LINK", "engagementType": "REQUEST_FOR_PRIVATE_OFFER", "value": "https://aws.amazon.com/marketplace/customer-connect/private-offer/prodview-sampleMultiProductId" } ] } } ], "smithy.api#http": { "code": 200, "method": "POST", "uri": "/2026-02-05/getListing" }, "smithy.api#readonly": {}, "smithy.test#smokeTests": [ { "id": "GetListingFailure", "params": { "listingId": "non-existent-listing-id" }, "expect": { "failure": { "errorId": "com.amazonaws.marketplacediscovery#ResourceNotFoundException" } }, "vendorParamsShape": "aws.test#AwsVendorParams", "vendorParams": { "region": "us-east-1" } } ] } }, "com.amazonaws.marketplacediscovery#GetListingInput": { "type": "structure", "members": { "locale": { "target": "com.amazonaws.marketplacediscovery#Locale", "traits": { "smithy.api#documentation": "

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.

" } }, "listingId": { "target": "com.amazonaws.marketplacediscovery#ListingId", "traits": { "smithy.api#documentation": "

The unique identifier of the listing to retrieve.

", "smithy.api#required": {} } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.marketplacediscovery#GetListingOutput": { "type": "structure", "members": { "locale": { "target": "com.amazonaws.marketplacediscovery#Locale", "traits": { "smithy.api#documentation": "

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.

" } }, "associatedEntities": { "target": "com.amazonaws.marketplacediscovery#ListingAssociatedEntityList", "traits": { "smithy.api#documentation": "

The products and offers associated with this listing. Each entity contains product and offer information.

", "smithy.api#required": {} } }, "badges": { "target": "com.amazonaws.marketplacediscovery#ListingBadgeList", "traits": { "smithy.api#documentation": "

Badges indicating special attributes of the listing, such as free tier eligibility, free trial availability, or Quick Launch support.

", "smithy.api#required": {} } }, "catalog": { "target": "com.amazonaws.marketplacediscovery#Catalog", "traits": { "smithy.api#documentation": "

The name of the catalog that the listing belongs to.

", "smithy.api#required": {} } }, "categories": { "target": "com.amazonaws.marketplacediscovery#CategoryList", "traits": { "smithy.api#documentation": "

The categories used to classify this listing into logical groups.

", "smithy.api#required": {} } }, "fulfillmentOptionSummaries": { "target": "com.amazonaws.marketplacediscovery#FulfillmentOptionSummaryList", "traits": { "smithy.api#documentation": "

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

", "smithy.api#required": {} } }, "highlights": { "target": "com.amazonaws.marketplacediscovery#HighlightList", "traits": { "smithy.api#documentation": "

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

", "smithy.api#required": {} } }, "integrationGuide": { "target": "com.amazonaws.marketplacediscovery#NullableString", "traits": { "smithy.api#documentation": "

Optional guidance explaining how to use data in this listing. Primarily defines how to integrate with a multi-product listing.

" } }, "listingId": { "target": "com.amazonaws.marketplacediscovery#ListingId", "traits": { "smithy.api#documentation": "

The unique identifier of the listing.

", "smithy.api#required": {} } }, "listingName": { "target": "com.amazonaws.marketplacediscovery#NonEmptyString", "traits": { "smithy.api#documentation": "

The human-readable display name of the listing.

", "smithy.api#required": {} } }, "logoThumbnailUrl": { "target": "com.amazonaws.marketplacediscovery#URL", "traits": { "smithy.api#documentation": "

The URL of the logo thumbnail image for the listing.

", "smithy.api#required": {} } }, "longDescription": { "target": "com.amazonaws.marketplacediscovery#NonEmptyString", "traits": { "smithy.api#documentation": "

A detailed description of what the listing offers, in paragraph format.

", "smithy.api#length": { "max": 32768 }, "smithy.api#required": {} } }, "pricingModels": { "target": "com.amazonaws.marketplacediscovery#PricingModelList", "traits": { "smithy.api#documentation": "

The pricing models for offers associated with this listing, such as usage-based, contract, BYOL, or free.

", "smithy.api#required": {} } }, "pricingUnits": { "target": "com.amazonaws.marketplacediscovery#PricingUnitList", "traits": { "smithy.api#documentation": "

The pricing units that define the billing dimensions for offers associated with this listing, such as users, hosts, or data.

", "smithy.api#required": {} } }, "promotionalMedia": { "target": "com.amazonaws.marketplacediscovery#PromotionalMediaList", "traits": { "smithy.api#documentation": "

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

", "smithy.api#required": {} } }, "publisher": { "target": "com.amazonaws.marketplacediscovery#SellerInformation", "traits": { "smithy.api#documentation": "

The entity who created and published the listing.

", "smithy.api#required": {} } }, "resources": { "target": "com.amazonaws.marketplacediscovery#ResourceList", "traits": { "smithy.api#documentation": "

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

", "smithy.api#required": {} } }, "reviewSummary": { "target": "com.amazonaws.marketplacediscovery#ReviewSummary", "traits": { "smithy.api#documentation": "

A summary of customer reviews available for the listing, including average rating and total review count by source.

" } }, "sellerEngagements": { "target": "com.amazonaws.marketplacediscovery#SellerEngagementList", "traits": { "smithy.api#documentation": "

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

", "smithy.api#required": {} } }, "shortDescription": { "target": "com.amazonaws.marketplacediscovery#NonEmptyString", "traits": { "smithy.api#documentation": "

A 1\u20133 sentence summary describing the key aspects of the listing.

", "smithy.api#required": {} } }, "useCases": { "target": "com.amazonaws.marketplacediscovery#UseCaseList", "traits": { "smithy.api#documentation": "

Use cases associated with the listing, describing scenarios where the product can be applied.

", "smithy.api#required": {} } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.marketplacediscovery#GetOffer": { "type": "operation", "input": { "target": "com.amazonaws.marketplacediscovery#GetOfferInput" }, "output": { "target": "com.amazonaws.marketplacediscovery#GetOfferOutput" }, "errors": [ { "target": "com.amazonaws.marketplacediscovery#ResourceNotFoundException" } ], "traits": { "smithy.api#documentation": "

Provides details about an offer, such as the pricing model, seller of record, availability dates, badges, and associated products.

", "smithy.api#examples": [ { "title": "Invoke GetOffer for Contract Pricing offer", "input": { "locale": "en-US", "offerId": "offer-sampleContractId" }, "output": { "locale": "en-US", "offerId": "offer-sampleContractId", "catalog": "AWSMarketplace", "offerName": "sample contract offer", "agreementProposalId": "at-sampleToken", "availableFromTime": "2023-01-01T00:00:00.000Z", "expirationTime": "2023-10-08T21:40:43.644Z", "sellerOfRecord": { "sellerProfileId": "seller-sampleContractId", "displayName": "sample contract seller" }, "replacementAgreementId": "agmt-sampleId", "pricingModel": { "pricingModelType": "CONTRACT", "displayName": "Contract" }, "badges": [ { "displayName": "Private Pricing", "badgeType": "PRIVATE_PRICING" }, { "displayName": "Replacement Offer", "badgeType": "REPLACEMENT_OFFER" } ], "associatedEntities": [ { "product": { "productId": "prod-sampleContractId", "productName": "sample contract product", "manufacturer": { "sellerProfileId": "seller-sampleContractId", "displayName": "sample contract seller" } }, "offerSet": { "offerSetId": "offerset-sampleId", "sellerOfRecord": { "sellerProfileId": "seller-sampleContractId", "displayName": "sample contract seller" } } } ] } }, { "title": "Invoke GetOffer for Usage Pricing offer", "input": { "locale": "en-US", "offerId": "offer-sampleUsageId" }, "output": { "locale": "en-US", "offerId": "offer-sampleUsageId", "catalog": "AWSMarketplace", "offerName": "sample usage offer", "agreementProposalId": "at-sampleToken", "expirationTime": "2022-03-29T23:59:59.999Z", "sellerOfRecord": { "sellerProfileId": "seller-sampleUsageId", "displayName": "sample usage seller" }, "replacementAgreementId": "agmt-sampleId", "pricingModel": { "pricingModelType": "USAGE", "displayName": "Usage" }, "badges": [ { "displayName": "Future Dated", "badgeType": "FUTURE_DATED" } ], "associatedEntities": [ { "product": { "productId": "prod-sampleUsageId", "productName": "sample usage product", "manufacturer": { "sellerProfileId": "seller-sampleUsageId", "displayName": "sample usage seller" } } } ] } }, { "title": "Invoke GetOffer for BYOL Pricing offer", "input": { "locale": "en-US", "offerId": "offer-sampleByolId" }, "output": { "locale": "en-US", "offerId": "offer-sampleByolId", "catalog": "AWSMarketplace", "offerName": "sample BYOL offer", "agreementProposalId": "at-sampleToken", "expirationTime": "2022-03-29T23:59:59.999Z", "sellerOfRecord": { "sellerProfileId": "seller-sampleByolId", "displayName": "sample BYOL seller" }, "replacementAgreementId": "agmt-sampleId", "pricingModel": { "pricingModelType": "BYOL", "displayName": "Bring Your Own License" }, "badges": [], "associatedEntities": [ { "product": { "productId": "prod-sampleByolId", "productName": "sample BYOL product", "manufacturer": { "sellerProfileId": "seller-sampleByolId", "displayName": "sample BYOL seller" } } } ] } }, { "title": "Invoke GetOffer for FREE Pricing offer", "input": { "locale": "en-US", "offerId": "offer-sampleFreeId" }, "output": { "locale": "en-US", "offerId": "offer-sampleFreeId", "catalog": "AWSMarketplace", "offerName": "sample free offer", "agreementProposalId": "at-sampleToken", "expirationTime": "2022-03-29T23:59:59.999Z", "sellerOfRecord": { "sellerProfileId": "seller-sampleFreeId", "displayName": "sample free seller" }, "replacementAgreementId": "agmt-sampleId", "pricingModel": { "pricingModelType": "FREE", "displayName": "Free" }, "badges": [], "associatedEntities": [ { "product": { "productId": "prod-sampleFreeId", "productName": "sample free product", "manufacturer": { "sellerProfileId": "seller-sampleFreeId", "displayName": "sample free seller" } } } ] } } ], "smithy.api#http": { "code": 200, "method": "POST", "uri": "/2026-02-05/getOffer" }, "smithy.api#readonly": {}, "smithy.test#smokeTests": [ { "id": "GetOfferFailure", "params": { "offerId": "non-existent-offer-id" }, "expect": { "failure": { "errorId": "com.amazonaws.marketplacediscovery#ResourceNotFoundException" } }, "vendorParamsShape": "aws.test#AwsVendorParams", "vendorParams": { "region": "us-east-1" } } ] } }, "com.amazonaws.marketplacediscovery#GetOfferInput": { "type": "structure", "members": { "locale": { "target": "com.amazonaws.marketplacediscovery#Locale", "traits": { "smithy.api#documentation": "

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.

" } }, "offerId": { "target": "com.amazonaws.marketplacediscovery#OfferId", "traits": { "smithy.api#documentation": "

The unique identifier of the offer to retrieve.

", "smithy.api#required": {} } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.marketplacediscovery#GetOfferOutput": { "type": "structure", "members": { "locale": { "target": "com.amazonaws.marketplacediscovery#Locale", "traits": { "smithy.api#documentation": "

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.

" } }, "offerId": { "target": "com.amazonaws.marketplacediscovery#OfferId", "traits": { "smithy.api#documentation": "

The unique identifier of the offer.

", "smithy.api#required": {} } }, "catalog": { "target": "com.amazonaws.marketplacediscovery#Catalog", "traits": { "smithy.api#documentation": "

The name of the catalog that the offer belongs to.

", "smithy.api#required": {} } }, "offerName": { "target": "com.amazonaws.marketplacediscovery#NullableString", "traits": { "smithy.api#documentation": "

The display name of the offer. This is free-form text provided by the seller.

" } }, "expirationTime": { "target": "smithy.api#Timestamp", "traits": { "smithy.api#documentation": "

The date and time until when the offer can be procured. This value is null for offers that never expire.

" } }, "availableFromTime": { "target": "smithy.api#Timestamp", "traits": { "smithy.api#documentation": "

The date and time when the offer became available to the buyer.

" } }, "sellerOfRecord": { "target": "com.amazonaws.marketplacediscovery#SellerInformation", "traits": { "smithy.api#documentation": "

The entity responsible for selling the product under this offer.

", "smithy.api#required": {} } }, "associatedEntities": { "target": "com.amazonaws.marketplacediscovery#OfferAssociatedEntityList", "traits": { "smithy.api#documentation": "

The products and offer sets associated with this offer.

", "smithy.api#required": {} } }, "agreementProposalId": { "target": "com.amazonaws.marketplacediscovery#AgreementResourceId", "traits": { "smithy.api#documentation": "

An encoded string to be passed by the acceptor of the terms when creating an agreement.

", "smithy.api#required": {} } }, "replacementAgreementId": { "target": "com.amazonaws.marketplacediscovery#AgreementResourceId", "traits": { "smithy.api#documentation": "

The identifier of the existing agreement that this offer would replace. Enables agreement-based offer functionality.

" } }, "pricingModel": { "target": "com.amazonaws.marketplacediscovery#PricingModel", "traits": { "smithy.api#documentation": "

The pricing model that determines how buyers are charged, such as usage-based, contract, BYOL, or free.

", "smithy.api#required": {} } }, "badges": { "target": "com.amazonaws.marketplacediscovery#PurchaseOptionBadgeList", "traits": { "smithy.api#documentation": "

Badges indicating special attributes of the offer, such as private pricing, future dated, or replacement offer.

", "smithy.api#required": {} } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.marketplacediscovery#GetOfferSet": { "type": "operation", "input": { "target": "com.amazonaws.marketplacediscovery#GetOfferSetInput" }, "output": { "target": "com.amazonaws.marketplacediscovery#GetOfferSetOutput" }, "errors": [ { "target": "com.amazonaws.marketplacediscovery#ResourceNotFoundException" } ], "traits": { "smithy.api#documentation": "

Provides details about an offer set, which is a bundle of offers across multiple products. Includes the seller, availability dates, buyer notes, and associated product-offer pairs.

", "smithy.api#examples": [ { "title": "Get offer set with multiple products", "input": { "locale": "en-US", "offerSetId": "offerset-sampleId" }, "output": { "locale": "en-US", "catalog": "AWSMarketplace", "offerSetId": "offerset-sampleId", "offerSetName": "sample offer set", "availableFromTime": "2024-03-20T00:00:00.000Z", "expirationTime": "2025-03-20T00:00:00.000Z", "buyerNotes": "This bundle includes CrowdStrike Falcon and Splunk Enterprise for comprehensive security monitoring.", "sellerOfRecord": { "sellerProfileId": "seller-sampleResellerId", "displayName": "sample reseller" }, "badges": [ { "displayName": "Private Pricing", "badgeType": "PRIVATE_PRICING" }, { "displayName": "Future Dated", "badgeType": "FUTURE_DATED" }, { "displayName": "Replacement Offer", "badgeType": "REPLACEMENT_OFFER" } ], "associatedEntities": [ { "product": { "productId": "prod-sampleId1", "productName": "sample product name 1", "manufacturer": { "sellerProfileId": "seller-sampleId1", "displayName": "sample seller name 1" } }, "offer": { "offerId": "offer-sampleId1", "offerName": "sample offer name 1", "sellerOfRecord": { "sellerProfileId": "seller-sampleResellerId", "displayName": "sample reseller" } } }, { "product": { "productId": "prod-sampleId2", "productName": "sample product name 2", "manufacturer": { "sellerProfileId": "seller-sampleId2", "displayName": "sample seller name 2" } }, "offer": { "offerId": "offer-sampleId2", "offerName": "sample offer name 2", "sellerOfRecord": { "sellerProfileId": "seller-sampleResellerId", "displayName": "sample reseller" } } } ] } }, { "title": "Get offer set with only required fields", "input": { "offerSetId": "offerset-sampleMinimalId" }, "output": { "catalog": "AWSMarketplace", "offerSetId": "offerset-sampleMinimalId", "sellerOfRecord": { "sellerProfileId": "seller-sampleResellerId", "displayName": "sample reseller" }, "badges": [], "associatedEntities": [ { "product": { "productId": "prod-sampleMinimalId", "productName": "sample product name", "manufacturer": { "sellerProfileId": "seller-sampleId1", "displayName": "sample seller name 1" } }, "offer": { "offerId": "offer-sampleMinimalId", "sellerOfRecord": { "sellerProfileId": "seller-sampleResellerId", "displayName": "sample reseller" } } } ] } }, { "title": "Get offer set that never expires from a first-party seller", "input": { "locale": "en-US", "offerSetId": "offerset-samplePerpetualId" }, "output": { "locale": "en-US", "catalog": "AWSMarketplace", "offerSetId": "offerset-samplePerpetualId", "offerSetName": "sample perpetual offer set", "availableFromTime": "2024-03-20T00:00:00.000Z", "buyerNotes": "This offer set does not expire. Omitting expirationTime indicates the offer set remains available for procurement indefinitely.", "sellerOfRecord": { "sellerProfileId": "seller-sampleFirstPartyId", "displayName": "sample first-party seller" }, "badges": [ { "displayName": "Private Pricing", "badgeType": "PRIVATE_PRICING" } ], "associatedEntities": [ { "product": { "productId": "prod-samplePerpetualId", "productName": "sample perpetual product", "manufacturer": { "sellerProfileId": "seller-sampleFirstPartyId", "displayName": "sample first-party seller" } }, "offer": { "offerId": "offer-samplePerpetualId", "offerName": "sample perpetual offer", "sellerOfRecord": { "sellerProfileId": "seller-sampleFirstPartyId", "displayName": "sample first-party seller" } } } ] } } ], "smithy.api#http": { "code": 200, "method": "POST", "uri": "/2026-02-05/getOfferSet" }, "smithy.api#readonly": {}, "smithy.test#smokeTests": [ { "id": "GetOfferSetFailure", "params": { "offerSetId": "non-existent-offerset-id" }, "expect": { "failure": { "errorId": "com.amazonaws.marketplacediscovery#ResourceNotFoundException" } }, "vendorParamsShape": "aws.test#AwsVendorParams", "vendorParams": { "region": "us-east-1" } } ] } }, "com.amazonaws.marketplacediscovery#GetOfferSetInput": { "type": "structure", "members": { "locale": { "target": "com.amazonaws.marketplacediscovery#Locale", "traits": { "smithy.api#documentation": "

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.

" } }, "offerSetId": { "target": "com.amazonaws.marketplacediscovery#OfferSetId", "traits": { "smithy.api#documentation": "

The unique identifier of the offer set to retrieve.

", "smithy.api#required": {} } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.marketplacediscovery#GetOfferSetOutput": { "type": "structure", "members": { "locale": { "target": "com.amazonaws.marketplacediscovery#Locale", "traits": { "smithy.api#documentation": "

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.

" } }, "offerSetId": { "target": "com.amazonaws.marketplacediscovery#OfferSetId", "traits": { "smithy.api#documentation": "

The unique identifier of the offer set.

", "smithy.api#required": {} } }, "catalog": { "target": "com.amazonaws.marketplacediscovery#Catalog", "traits": { "smithy.api#documentation": "

The name of the catalog that the offer set belongs to.

", "smithy.api#required": {} } }, "offerSetName": { "target": "com.amazonaws.marketplacediscovery#NonEmptyString", "traits": { "smithy.api#documentation": "

The display name of the offer set.

" } }, "availableFromTime": { "target": "smithy.api#Timestamp", "traits": { "smithy.api#documentation": "

The date and time when the offer set became available to the buyer.

" } }, "expirationTime": { "target": "smithy.api#Timestamp", "traits": { "smithy.api#documentation": "

The date and time when the offer set expires and is no longer available for procurement.

" } }, "buyerNotes": { "target": "com.amazonaws.marketplacediscovery#NullableString", "traits": { "smithy.api#documentation": "

Detailed information about the offer set that helps buyers understand its purpose and contents.

" } }, "sellerOfRecord": { "target": "com.amazonaws.marketplacediscovery#SellerInformation", "traits": { "smithy.api#documentation": "

The entity responsible for selling the products under this offer set.

", "smithy.api#required": {} } }, "badges": { "target": "com.amazonaws.marketplacediscovery#PurchaseOptionBadgeList", "traits": { "smithy.api#documentation": "

Badges indicating special attributes of the offer set, such as private pricing or future dated.

", "smithy.api#required": {} } }, "associatedEntities": { "target": "com.amazonaws.marketplacediscovery#OfferSetAssociatedEntityList", "traits": { "smithy.api#documentation": "

The products and offers included in this offer set.

", "smithy.api#required": {} } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.marketplacediscovery#GetOfferTerms": { "type": "operation", "input": { "target": "com.amazonaws.marketplacediscovery#GetOfferTermsInput" }, "output": { "target": "com.amazonaws.marketplacediscovery#GetOfferTermsOutput" }, "errors": [ { "target": "com.amazonaws.marketplacediscovery#ResourceNotFoundException" } ], "traits": { "smithy.api#documentation": "

Returns the terms attached to an offer, such as pricing terms (usage-based, contract, BYOL, free trial), legal terms, payment schedules, validity terms, support terms, and renewal terms.

", "smithy.api#examples": [ { "title": "GetOfferTerms for Usage-based ML Model offer", "input": { "locale": "en-US", "offerId": "offer-sampleUsageBasedId" }, "output": { "locale": "en-US", "offerTerms": [ { "usageBasedPricingTerm": { "id": "term-sampleUsageBasedPricingId", "type": "UsageBasedPricingTerm", "currencyCode": "USD", "rateCards": [ { "rateCard": [ { "dimensionKey": "ml.m5.2xlarge.m.i.b", "displayName": "ml.m5.2xlarge Inference (Batch)", "description": "Model inference on the ml.m5.2xlarge instance type, batch mode", "dimensionLabels": [ { "labelType": "SagemakerOption", "labelValue": "Model Batch Transform", "displayName": "Model Batch Transform" } ], "unit": "HostHrs", "price": "2.00000000" }, { "dimensionKey": "ml.m5.2xlarge.m.i.r", "displayName": "ml.m5.2xlarge Inference (Real-Time)", "description": "Model inference on the ml.m5.2xlarge instance type, real-time mode", "dimensionLabels": [ { "labelType": "SagemakerOption", "labelValue": "Model Real-Time Inference", "displayName": "Model Real-Time Inference" } ], "unit": "HostHrs", "price": "2.00000000" }, { "dimensionKey": "ml.m5.large.m.i.b", "displayName": "ml.m5.large Inference (Batch)", "description": "Model inference on the ml.m5.large instance type, batch mode", "dimensionLabels": [ { "labelType": "SagemakerOption", "labelValue": "Model Batch Transform", "displayName": "Model Batch Transform" } ], "unit": "HostHrs", "price": "2.00000000" }, { "dimensionKey": "ml.m5.large.m.i.r", "displayName": "ml.m5.large Inference (Real-Time)", "description": "Model inference on the ml.m5.large instance type, real-time mode", "dimensionLabels": [ { "labelType": "SagemakerOption", "labelValue": "Model Real-Time Inference", "displayName": "Model Real-Time Inference" } ], "unit": "HostHrs", "price": "2.00000000" } ] } ] } }, { "fixedUpfrontPricingTerm": { "id": "term-sampleFixedUpfrontPricingId", "type": "FixedUpfrontPricingTerm", "currencyCode": "USD", "duration": "P365D", "price": "0.00000000", "grants": [ { "dimensionKey": "ml.m5.2xlarge.m.i.b", "displayName": "ml.m5.2xlarge Inference (Batch)", "description": "Model inference on the ml.m5.2xlarge instance type, batch mode", "dimensionLabels": [ { "labelType": "SagemakerOption", "labelValue": "Model Batch Transform", "displayName": "Model Batch Transform" } ], "unit": "HostHrs", "maxQuantity": 2147483647 }, { "dimensionKey": "ml.m5.2xlarge.m.i.r", "displayName": "ml.m5.2xlarge Inference (Real-Time)", "description": "Model inference on the ml.m5.2xlarge instance type, real-time mode", "dimensionLabels": [ { "labelType": "SagemakerOption", "labelValue": "Model Real-Time Inference", "displayName": "Model Real-Time Inference" } ], "unit": "HostHrs", "maxQuantity": 2147483647 }, { "dimensionKey": "ml.m5.large.m.i.b", "displayName": "ml.m5.large Inference (Batch)", "description": "Model inference on the ml.m5.large instance type, batch mode", "dimensionLabels": [ { "labelType": "SagemakerOption", "labelValue": "Model Batch Transform", "displayName": "Model Batch Transform" } ], "unit": "HostHrs", "maxQuantity": 2147483647 }, { "dimensionKey": "ml.m5.large.m.i.r", "displayName": "ml.m5.large Inference (Real-Time)", "description": "Model inference on the ml.m5.large instance type, real-time mode", "dimensionLabels": [ { "labelType": "SagemakerOption", "labelValue": "Model Real-Time Inference", "displayName": "Model Real-Time Inference" } ], "unit": "HostHrs", "maxQuantity": 2147483647 } ] } }, { "legalTerm": { "id": "term-sampleLegalId", "type": "LegalTerm", "documents": [ { "type": "StandardEula", "url": "https://example.com/legal/standard-eula" } ] } }, { "validityTerm": { "id": "term-sampleValidityId", "type": "ValidityTerm", "agreementDuration": "P2011D" } }, { "paymentScheduleTerm": { "id": "term-samplePaymentScheduleId", "type": "PaymentScheduleTerm", "currencyCode": "USD", "schedule": [ { "chargeDate": "2026-07-15T00:00:00.000Z", "chargeAmount": "5.00000000" } ] } } ] } }, { "title": "GetOfferTerms for BYOL offer", "input": { "locale": "en-US", "offerId": "offer-sampleByolId" }, "output": { "locale": "en-US", "offerTerms": [ { "byolPricingTerm": { "id": "term-byol-001", "type": "ByolPricingTerm" } }, { "legalTerm": { "id": "term-legal-003", "type": "LegalTerm", "documents": [ { "type": "CustomEula", "url": "https://example.com/eula" } ] } } ] } }, { "title": "GetOfferTerms for configurable upfront pricing", "input": { "locale": "en-US", "offerId": "offer-sampleConfigUpfrontId" }, "output": { "locale": "en-US", "offerTerms": [ { "configurableUpfrontPricingTerm": { "id": "term-config-001", "type": "ConfigurableUpfrontPricingTerm", "currencyCode": "USD", "rateCards": [ { "selector": { "type": "Duration", "value": "P12M" }, "constraints": { "multipleDimensionSelection": "Allowed", "quantityConfiguration": "Allowed" }, "rateCard": [ { "dimensionKey": "api_calls_us_east_1", "displayName": "API Calls (US East)", "dimensionLabels": [ { "labelType": "Region", "labelValue": "us-east-1", "displayName": "US East (N. Virginia)" } ], "unit": "Requests", "price": "0.001" }, { "dimensionKey": "api_calls_us_west_2", "displayName": "API Calls (US West)", "dimensionLabels": [ { "labelType": "Region", "labelValue": "us-west-2", "displayName": "US West (Oregon)" } ], "unit": "Requests", "price": "0.001" } ] } ] } } ] } }, { "title": "GetOfferTerms for free trial offer", "input": { "locale": "en-US", "offerId": "offer-sampleFreeTrialId" }, "output": { "locale": "en-US", "offerTerms": [ { "freeTrialPricingTerm": { "id": "term-trial-001", "type": "FreeTrialPricingTerm", "duration": "P30D", "grants": [ { "dimensionKey": "ml.m5.large.m.i.r", "displayName": "ml.m5.large Inference (Real-Time)", "dimensionLabels": [ { "labelType": "SagemakerOption", "labelValue": "Model Real-Time Inference", "displayName": "Model Real-Time Inference" } ], "unit": "HostHrs", "maxQuantity": 100 } ] } } ] } }, { "title": "GetOfferTerms for recurring payment", "input": { "locale": "en-US", "offerId": "offer-sampleRecurringId" }, "output": { "locale": "en-US", "offerTerms": [ { "recurringPaymentTerm": { "id": "term-recurring-001", "type": "RecurringPaymentTerm", "currencyCode": "USD", "billingPeriod": "Monthly", "price": "99.00" } } ] } }, { "title": "GetOfferTerms for variable payment", "input": { "locale": "en-US", "offerId": "offer-sampleVariableId" }, "output": { "locale": "en-US", "offerTerms": [ { "variablePaymentTerm": { "id": "term-variable-001", "type": "VariablePaymentTerm", "currencyCode": "USD", "maxTotalChargeAmount": "10000.00" } } ] } }, { "title": "GetOfferTerms for renewal term", "input": { "locale": "en-US", "offerId": "offer-sampleRenewalId" }, "output": { "locale": "en-US", "offerTerms": [ { "renewalTerm": { "id": "term-renewal-001", "type": "RenewalTerm", "maxRenewals": 3, "lockoutPeriod": "P30D", "adjustmentDeadline": "P30D", "priceIncrease": { "percentageRange": { "minimumValue": "3.00", "maximumValue": "10.00", "defaultValue": "5.00" } }, "termTemplates": [ { "paymentScheduleTermTemplate": { "schedule": [ { "chargeDateOffset": "P0D", "chargePercentage": "50.00" }, { "chargeDateOffset": "P6M", "chargePercentage": "25.00", "dayOfMonth": 1 }, { "chargeDateOffset": "P12M", "chargePercentage": "25.00", "dayOfMonth": 1 } ] } } ] } } ] } }, { "title": "GetOfferTerms for renewal term with fixed percentage", "input": { "locale": "en-US", "offerId": "offer-sampleRenewalFixedId" }, "output": { "locale": "en-US", "offerTerms": [ { "renewalTerm": { "id": "term-renewal-002", "type": "RenewalTerm", "maxRenewals": 5, "lockoutPeriod": "P60D", "priceIncrease": { "fixedPercentage": { "percentageValue": "5.00" } } } } ] } }, { "title": "GetOfferTerms for renewal term with identical pricing (no price increase)", "input": { "locale": "en-US", "offerId": "offer-sampleRenewalNoPriceIncreaseId" }, "output": { "locale": "en-US", "offerTerms": [ { "renewalTerm": { "id": "term-renewal-003", "type": "RenewalTerm", "maxRenewals": 2, "lockoutPeriod": "P30D" } } ] } }, { "title": "GetOfferTerms for support term", "input": { "locale": "en-US", "offerId": "offer-sampleSupportId" }, "output": { "locale": "en-US", "offerTerms": [ { "supportTerm": { "id": "term-support-001", "type": "SupportTerm", "refundPolicy": "30-day money back guarantee" } } ] } }, { "title": "GetOfferTerms for validity term with dates", "input": { "locale": "en-US", "offerId": "offer-sampleValidityId" }, "output": { "locale": "en-US", "offerTerms": [ { "validityTerm": { "id": "term-validity-001", "type": "ValidityTerm", "agreementDuration": "P365D", "agreementStartDate": "2026-01-01T00:00:00.000Z", "agreementEndDate": "2026-12-31T23:59:59.000Z" } } ] } }, { "title": "GetOfferTerms for net payment term", "input": { "locale": "en-US", "offerId": "offer-sampleNetPaymentId" }, "output": { "locale": "en-US", "offerTerms": [ { "netPaymentTerm": { "id": "term-netpay-001", "type": "NetPaymentTerm", "paymentDuePeriod": "P30D" } } ] } } ], "smithy.api#http": { "code": 200, "method": "POST", "uri": "/2026-02-05/getOfferTerms" }, "smithy.api#paginated": { "inputToken": "nextToken", "outputToken": "nextToken", "items": "offerTerms", "pageSize": "maxResults" }, "smithy.api#readonly": {}, "smithy.test#smokeTests": [ { "id": "GetOfferTermsFailure", "params": { "offerId": "non-existent-offer-id" }, "expect": { "failure": { "errorId": "com.amazonaws.marketplacediscovery#ResourceNotFoundException" } }, "vendorParamsShape": "aws.test#AwsVendorParams", "vendorParams": { "region": "us-east-1" } } ] } }, "com.amazonaws.marketplacediscovery#GetOfferTermsInput": { "type": "structure", "members": { "locale": { "target": "com.amazonaws.marketplacediscovery#Locale", "traits": { "smithy.api#documentation": "

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.

" } }, "offerId": { "target": "com.amazonaws.marketplacediscovery#OfferId", "traits": { "smithy.api#documentation": "

The unique identifier of the offer whose terms to retrieve.

", "smithy.api#required": {} } }, "maxResults": { "target": "smithy.api#Integer", "traits": { "smithy.api#default": 10, "smithy.api#documentation": "

The maximum number of results that are returned per call. You can use nextToken to get more results.

", "smithy.api#range": { "min": 1, "max": 25 } } }, "nextToken": { "target": "com.amazonaws.marketplacediscovery#NextToken", "traits": { "smithy.api#documentation": "

If nextToken is returned, there are more results available. Make the call again using the returned token to retrieve the next page.

" } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.marketplacediscovery#GetOfferTermsOutput": { "type": "structure", "members": { "locale": { "target": "com.amazonaws.marketplacediscovery#Locale", "traits": { "smithy.api#documentation": "

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.

" } }, "offerTerms": { "target": "com.amazonaws.marketplacediscovery#OfferTermsList", "traits": { "smithy.api#documentation": "

The terms attached to the offer. Each element contains exactly one term type.

", "smithy.api#required": {} } }, "nextToken": { "target": "com.amazonaws.marketplacediscovery#NextToken", "traits": { "smithy.api#documentation": "

If nextToken is returned, there are more results available. Make the call again using the returned token to retrieve the next page.

" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.marketplacediscovery#GetProduct": { "type": "operation", "input": { "target": "com.amazonaws.marketplacediscovery#GetProductInput" }, "output": { "target": "com.amazonaws.marketplacediscovery#GetProductOutput" }, "errors": [ { "target": "com.amazonaws.marketplacediscovery#ResourceNotFoundException" } ], "traits": { "smithy.api#documentation": "

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

", "smithy.api#examples": [ { "title": "GetProduct for SaaS product with DEPLOYED status", "input": { "locale": "en-US", "productId": "prod-sampleSaasId" }, "output": { "locale": "en-US", "productId": "prod-sampleSaasId", "catalog": "AWSMarketplace", "productName": "sample SaaS product", "deployedOnAws": "DEPLOYED", "shortDescription": "Gitpod provides on-demand, secure cloud development environments or CDEs.", "longDescription": "Gitpod is a developer platform that provides on-demand, pre-configured cloud development environments (CDEs) that automatically integrate into any tool, library, or dependency required for creating software.", "manufacturer": { "sellerProfileId": "seller-sampleSaasId", "displayName": "sample SaaS seller" }, "logoThumbnailUrl": "https://d7umqicpi7263.cloudfront.net/img/product/07afb7c8-32f1-4851-8289-7e200d817ab1.png", "fulfillmentOptionSummaries": [ { "fulfillmentOptionType": "SAAS", "displayName": "SaaS" }, { "fulfillmentOptionType": "API", "displayName": "API" }, { "fulfillmentOptionType": "DATA_EXCHANGE", "displayName": "Data Exchange" } ], "categories": [ { "categoryId": "0625e4fd-88dd-4dd9-9e57-4a0461f97fb4", "displayName": "Security" } ], "highlights": [ "Configured to your specs: Pre-configured environments, out-of-the-box." ], "promotionalMedia": [ { "embeddedImage": { "title": "Dashboard Overview", "url": "https://assets.example.com/images/dashboard-main.png", "description": "Main security dashboard showing threat analytics" } } ], "resources": [ { "resourceType": "MANUFACTURER_SUPPORT", "contentType": "LINK", "value": "https://www.gitpod.io/blog", "displayName": "Blog" }, { "resourceType": "MANUFACTURER_SUPPORT", "contentType": "EMAIL", "value": "support@gitpod.io", "displayName": "Email Support" } ], "sellerEngagements": [ { "engagementType": "REQUEST_FOR_DEMO", "contentType": "LINK", "value": "https://aws.amazon.com/marketplace/customer-connect/demo/prodview-sampleSaasId" } ], "listingId": "listing-sampleSaasId" } }, { "title": "GetProduct for AMI product with NOT_DEPLOYED status", "input": { "locale": "en-US", "productId": "prod-sampleAmiId" }, "output": { "locale": "en-US", "productId": "prod-sampleAmiId", "catalog": "AWSMarketplace", "productName": "sample AMI product", "deployedOnAws": "NOT_DEPLOYED", "shortDescription": "Enterprise-grade data encryption and key management solution.", "longDescription": "SecureVault Enterprise provides comprehensive data encryption, key management, and security compliance tools for organizations.", "manufacturer": { "sellerProfileId": "seller-sampleAmiId", "displayName": "sample AMI seller" }, "logoThumbnailUrl": "https://d7umqicpi7263.cloudfront.net/img/product/securevault-logo.png", "fulfillmentOptionSummaries": [ { "fulfillmentOptionType": "AMAZON_MACHINE_IMAGE", "displayName": "Amazon Machine Image" }, { "fulfillmentOptionType": "CLOUDFORMATION_TEMPLATE", "displayName": "CloudFormation Template" }, { "fulfillmentOptionType": "CONTAINER", "displayName": "Container" }, { "fulfillmentOptionType": "HELM", "displayName": "Helm" } ], "categories": [ { "categoryId": "security-category-001", "displayName": "Security" } ], "highlights": [ "AES-256 encryption at rest and in transit" ], "promotionalMedia": [ { "embeddedVideo": { "title": "SecureVault Introduction", "url": "https://assets.example.com/videos/intro.mp4", "preview": "https://assets.example.com/videos/intro-preview.jpg", "thumbnail": "https://assets.example.com/videos/intro-thumb.jpg", "description": "A comprehensive overview of SecureVault features" } } ], "resources": [ { "resourceType": "MANUFACTURER_SUPPORT", "contentType": "PHONE_NUMBER", "value": "+1-555-123-4567", "displayName": "Phone Support" }, { "resourceType": "MANUFACTURER_INSTRUCTIONS", "contentType": "OTHER", "value": "Contact your account manager for installation assistance.", "displayName": "Installation Help" } ], "sellerEngagements": [ { "engagementType": "REQUEST_FOR_PRIVATE_OFFER", "contentType": "LINK", "value": "https://aws.amazon.com/marketplace/customer-connect/private-offer/prodview-sampleAmiId" } ], "listingId": "listing-sampleAmiId" } }, { "title": "GetProduct for professional services with NOT_APPLICABLE status", "input": { "locale": "en-US", "productId": "prod-sampleProServId" }, "output": { "locale": "en-US", "productId": "prod-sampleProServId", "catalog": "AWSMarketplace", "productName": "sample professional services product", "deployedOnAws": "NOT_APPLICABLE", "shortDescription": "Expert cloud migration and modernization consulting services.", "longDescription": "Professional consulting services to help organizations plan and execute their cloud migration strategy.", "manufacturer": { "sellerProfileId": "seller-sampleProServId", "displayName": "sample professional services seller" }, "logoThumbnailUrl": "https://d7umqicpi7263.cloudfront.net/img/product/cloudexperts-logo.png", "fulfillmentOptionSummaries": [ { "fulfillmentOptionType": "PROFESSIONAL_SERVICES", "displayName": "Professional Services" }, { "fulfillmentOptionType": "EKS_ADD_ON", "displayName": "EKS Add-on" }, { "fulfillmentOptionType": "EC2_IMAGE_BUILDER_COMPONENT", "displayName": "EC2 Image Builder Component" }, { "fulfillmentOptionType": "SAGEMAKER_ALGORITHM", "displayName": "SageMaker Algorithm" }, { "fulfillmentOptionType": "SAGEMAKER_MODEL", "displayName": "SageMaker Model" } ], "categories": [ { "categoryId": "consulting-category-001", "displayName": "Consulting" } ], "highlights": [ "Certified AWS migration specialists" ], "resources": [ { "resourceType": "MANUFACTURER_INSTRUCTIONS", "contentType": "LINK", "value": "https://www.cloudexperts.example.com/docs", "displayName": "Documentation" } ], "promotionalMedia": [], "sellerEngagements": [ { "contentType": "LINK", "engagementType": "REQUEST_FOR_DEMO", "value": "https://aws.amazon.com/marketplace/customer-connect/demo/prodview-sampleProServId" } ], "listingId": "listing-sampleProServId" } } ], "smithy.api#http": { "code": 200, "method": "POST", "uri": "/2026-02-05/getProduct" }, "smithy.api#readonly": {}, "smithy.test#smokeTests": [ { "id": "GetProductFailure", "params": { "productId": "non-existent-product-id" }, "expect": { "failure": { "errorId": "com.amazonaws.marketplacediscovery#ResourceNotFoundException" } }, "vendorParamsShape": "aws.test#AwsVendorParams", "vendorParams": { "region": "us-east-1" } } ] } }, "com.amazonaws.marketplacediscovery#GetProductInput": { "type": "structure", "members": { "locale": { "target": "com.amazonaws.marketplacediscovery#Locale", "traits": { "smithy.api#documentation": "

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": { "target": "com.amazonaws.marketplacediscovery#ProductId", "traits": { "smithy.api#documentation": "

The unique identifier of the product to retrieve.

", "smithy.api#required": {} } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.marketplacediscovery#GetProductOutput": { "type": "structure", "members": { "locale": { "target": "com.amazonaws.marketplacediscovery#Locale", "traits": { "smithy.api#documentation": "

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": { "target": "com.amazonaws.marketplacediscovery#ProductId", "traits": { "smithy.api#documentation": "

The unique identifier of the product.

", "smithy.api#required": {} } }, "catalog": { "target": "com.amazonaws.marketplacediscovery#Catalog", "traits": { "smithy.api#documentation": "

The name of the catalog that the product belongs to.

", "smithy.api#required": {} } }, "productName": { "target": "com.amazonaws.marketplacediscovery#NonEmptyString", "traits": { "smithy.api#documentation": "

The human-readable display name of the product.

", "smithy.api#required": {} } }, "manufacturer": { "target": "com.amazonaws.marketplacediscovery#SellerInformation", "traits": { "smithy.api#documentation": "

The entity who manufactured the product.

", "smithy.api#required": {} } }, "deployedOnAws": { "target": "com.amazonaws.marketplacediscovery#DeployedOnAwsStatus", "traits": { "smithy.api#documentation": "

Indicates whether the product is deployed on AWS infrastructure.

", "smithy.api#required": {} } }, "shortDescription": { "target": "com.amazonaws.marketplacediscovery#NonEmptyString", "traits": { "smithy.api#documentation": "

A 1\u20133 sentence summary describing the key aspects of the product.

", "smithy.api#required": {} } }, "longDescription": { "target": "com.amazonaws.marketplacediscovery#NonEmptyString", "traits": { "smithy.api#documentation": "

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

", "smithy.api#length": { "max": 32768 }, "smithy.api#required": {} } }, "logoThumbnailUrl": { "target": "com.amazonaws.marketplacediscovery#URL", "traits": { "smithy.api#documentation": "

The URL of the logo thumbnail image for the product.

", "smithy.api#required": {} } }, "fulfillmentOptionSummaries": { "target": "com.amazonaws.marketplacediscovery#FulfillmentOptionSummaryList", "traits": { "smithy.api#documentation": "

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

", "smithy.api#required": {} } }, "categories": { "target": "com.amazonaws.marketplacediscovery#CategoryList", "traits": { "smithy.api#documentation": "

The categories used to classify this product into logical groups.

", "smithy.api#required": {} } }, "highlights": { "target": "com.amazonaws.marketplacediscovery#HighlightList", "traits": { "smithy.api#documentation": "

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

", "smithy.api#required": {} } }, "promotionalMedia": { "target": "com.amazonaws.marketplacediscovery#PromotionalMediaList", "traits": { "smithy.api#documentation": "

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

", "smithy.api#required": {} } }, "resources": { "target": "com.amazonaws.marketplacediscovery#ResourceList", "traits": { "smithy.api#documentation": "

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

", "smithy.api#required": {} } }, "sellerEngagements": { "target": "com.amazonaws.marketplacediscovery#SellerEngagementList", "traits": { "smithy.api#documentation": "

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

", "smithy.api#required": {} } }, "listingId": { "target": "com.amazonaws.marketplacediscovery#ListingId", "traits": { "smithy.api#documentation": "

The default listing identifier associated with the product.

", "smithy.api#required": {} } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.marketplacediscovery#GrantItem": { "type": "structure", "members": { "dimensionKey": { "target": "com.amazonaws.marketplacediscovery#BoundedString", "traits": { "smithy.api#documentation": "

The machine-readable key identifying the entitlement dimension.

", "smithy.api#required": {} } }, "displayName": { "target": "com.amazonaws.marketplacediscovery#BoundedString", "traits": { "smithy.api#documentation": "

The human-readable name of the entitlement dimension.

", "smithy.api#required": {} } }, "description": { "target": "com.amazonaws.marketplacediscovery#BoundedString", "traits": { "smithy.api#documentation": "

A description of the entitlement.

" } }, "dimensionLabels": { "target": "com.amazonaws.marketplacediscovery#DimensionLabelList", "traits": { "smithy.api#documentation": "

Labels used to categorize this entitlement, such as by region.

" } }, "unit": { "target": "com.amazonaws.marketplacediscovery#BoundedString", "traits": { "smithy.api#documentation": "

The unit of measurement for the entitlement.

", "smithy.api#required": {} } }, "maxQuantity": { "target": "smithy.api#Integer", "traits": { "smithy.api#documentation": "

The maximum quantity of the entitlement that can be granted.

" } } }, "traits": { "smithy.api#documentation": "

An entitlement granted to the buyer as part of a pricing term.

" } }, "com.amazonaws.marketplacediscovery#GrantList": { "type": "list", "member": { "target": "com.amazonaws.marketplacediscovery#GrantItem" } }, "com.amazonaws.marketplacediscovery#HelmFulfillmentOption": { "type": "structure", "members": { "fulfillmentOptionId": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "

The unique identifier of the fulfillment option.

", "smithy.api#required": {} } }, "fulfillmentOptionName": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "

The display name of the fulfillment option version.

", "smithy.api#required": {} } }, "fulfillmentOptionType": { "target": "com.amazonaws.marketplacediscovery#FulfillmentOptionType", "traits": { "smithy.api#documentation": "

The category of the fulfillment option.

", "smithy.api#required": {} } }, "fulfillmentOptionDisplayName": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "

A human-readable name for the fulfillment option type.

", "smithy.api#required": {} } }, "fulfillmentOptionVersion": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "

The version identifier of the fulfillment option.

" } }, "operatingSystems": { "target": "com.amazonaws.marketplacediscovery#HelmOperatingSystemList", "traits": { "smithy.api#documentation": "

The operating systems supported by this Helm chart.

" } }, "releaseNotes": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "

Release notes describing changes in this version of the fulfillment option.

" } }, "awsSupportedServices": { "target": "com.amazonaws.marketplacediscovery#AwsSupportedServiceList", "traits": { "smithy.api#documentation": "

The AWS services supported by this Helm chart deployment.

" } }, "usageInstructions": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "

Instructions on how to deploy and use this Helm chart.

" } } }, "traits": { "smithy.api#documentation": "

Describes a Helm chart fulfillment option for Kubernetes deployment.

" } }, "com.amazonaws.marketplacediscovery#HelmOperatingSystem": { "type": "structure", "members": { "operatingSystemFamilyName": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "

The operating system family, such as Linux.

", "smithy.api#required": {} } }, "operatingSystemName": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "

The specific operating system name.

", "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "

Describes an operating system supported by a Helm chart fulfillment option.

" } }, "com.amazonaws.marketplacediscovery#HelmOperatingSystemList": { "type": "list", "member": { "target": "com.amazonaws.marketplacediscovery#HelmOperatingSystem" } }, "com.amazonaws.marketplacediscovery#HighlightList": { "type": "list", "member": { "target": "com.amazonaws.marketplacediscovery#NonEmptyString" }, "traits": { "smithy.api#length": { "max": 10 } } }, "com.amazonaws.marketplacediscovery#InternalServerException": { "type": "structure", "members": { "message": { "target": "com.amazonaws.marketplacediscovery#ExceptionMessage" } }, "traits": { "smithy.api#documentation": "

Unexpected error during processing of the request.

", "smithy.api#error": "server", "smithy.api#httpError": 500 } }, "com.amazonaws.marketplacediscovery#LegalDocumentType": { "type": "enum", "members": { "CUSTOM_EULA": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "CustomEula" } }, "CUSTOM_DSA": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "CustomDsa" } }, "ENTERPRISE_EULA": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "EnterpriseEula" } }, "STANDARD_EULA": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "StandardEula" } }, "STANDARD_DSA": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "StandardDsa" } } } }, "com.amazonaws.marketplacediscovery#LegalTerm": { "type": "structure", "members": { "id": { "target": "com.amazonaws.marketplacediscovery#TermId", "traits": { "smithy.api#documentation": "

The unique identifier of the term.

", "smithy.api#required": {} } }, "type": { "target": "com.amazonaws.marketplacediscovery#TermType", "traits": { "smithy.api#documentation": "

The category of the term.

", "smithy.api#required": {} } }, "documents": { "target": "com.amazonaws.marketplacediscovery#DocumentList", "traits": { "smithy.api#documentation": "

The legal documents proposed to the buyer as part of this term.

", "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "

Defines a legal term containing documents proposed to buyers, such as EULAs and data subscription agreements.

" } }, "com.amazonaws.marketplacediscovery#ListFulfillmentOptions": { "type": "operation", "input": { "target": "com.amazonaws.marketplacediscovery#ListFulfillmentOptionsInput" }, "output": { "target": "com.amazonaws.marketplacediscovery#ListFulfillmentOptionsOutput" }, "errors": [ { "target": "com.amazonaws.marketplacediscovery#ResourceNotFoundException" } ], "traits": { "smithy.api#documentation": "

Returns the fulfillment options available for a product, including deployment details such as version information, operating systems, usage instructions, and release notes.

", "smithy.api#examples": [ { "title": "List AMI Fulfillment Options", "input": { "locale": "en-US", "productId": "prod-sampleAmiId" }, "output": { "locale": "en-US", "fulfillmentOptions": [ { "amazonMachineImageFulfillmentOption": { "fulfillmentOptionId": "fo-sampleAmiId", "fulfillmentOptionName": "64-bit (x86) Amazon Machine Image (AMI)", "fulfillmentOptionVersion": "2.0.20260120.1", "fulfillmentOptionType": "AMAZON_MACHINE_IMAGE", "fulfillmentOptionDisplayName": "Amazon Machine Image", "operatingSystems": [ { "operatingSystemFamilyName": "AMAZONLINUX", "operatingSystemName": "AmazonLinux 2.0.20250623.0", "operatingSystemVersion": "2.0.20250623.0" } ], "recommendation": { "instanceType": "t3a.medium", "securityGroups": [ { "protocol": "tcp", "fromPort": 22, "toPort": 22, "cidrIpAddresses": [ "0.0.0.0/0" ] } ] }, "releaseNotes": "https://aws.amazon.com/amazon-linux-2/release-notes/", "usageInstructions": "The Amazon Linux 2 AMI can be launched through the EC2 console's Quick Launch page.", "availableFromTime": "2022-03-07T00:00:00Z", "accessUrlTemplate": "http://{0}:8888/", "architecture": "x86_64", "amiAlias": "/aws/service/marketplace/prod-sampleAmiId/2.0.20260120.1", "ebsVolume": { "volumeTypes": [ "gp2" ] }, "shortDescription": "Amazon Linux 2 AMI for x86_64 EC2 instances." } } ] } }, { "title": "List API Fulfillment Options", "input": { "locale": "en-US", "productId": "prod-sampleApiId" }, "output": { "locale": "en-US", "fulfillmentOptions": [ { "apiFulfillmentOption": { "fulfillmentOptionId": "fo-sampleApiId", "fulfillmentOptionType": "API", "fulfillmentOptionDisplayName": "API-Based Agents & Tools", "usageInstructions": "Please refer to the MCP usage instructions.", "awsSupportedServices": [ { "supportedServiceType": "BEDROCK_AGENTCORE", "displayName": "Amazon Bedrock AgentCore", "description": "A managed service that enables you to develop, deploy, and maintain AI agents seamlessly." } ] } } ] } }, { "title": "List CloudFormation Template Fulfillment Options", "input": { "locale": "en-US", "productId": "prod-sampleCftId" }, "output": { "locale": "en-US", "fulfillmentOptions": [ { "cloudFormationFulfillmentOption": { "fulfillmentOptionId": "fo-sampleCftId", "fulfillmentOptionName": "Sophos Standalone Firewall for AWS", "fulfillmentOptionVersion": "21.5 MR1", "fulfillmentOptionType": "CLOUDFORMATION_TEMPLATE", "fulfillmentOptionDisplayName": "CloudFormation Template", "releaseNotes": "https://community.sophos.com/products/xg-firewall/b/blog", "usageInstructions": "You can manage your Sophos XG Firewall on AWS from the Web Interface using HTTPS (TCP port 4444).", "availableFromTime": "2021-12-15T00:00:00Z", "shortDescription": "Deploy Sophos XG Firewall on AWS with high availability.", "longDescription": "This CloudFormation template deploys the Sophos XG Firewall with auto-scaling and load balancing for enterprise environments." } } ] } }, { "title": "List Container Fulfillment Options", "input": { "locale": "en-US", "productId": "prod-sampleContainerId" }, "output": { "locale": "en-US", "fulfillmentOptions": [ { "containerFulfillmentOption": { "fulfillmentOptionId": "fo-sampleContainerId", "fulfillmentOptionName": "New delivery option 1", "fulfillmentOptionVersion": "Elastic MCP Version 1", "fulfillmentOptionType": "CONTAINER", "fulfillmentOptionDisplayName": "Container Image", "operatingSystems": [ { "operatingSystemFamilyName": "Linux", "operatingSystemName": "Linux" } ], "awsSupportedServices": [ { "supportedServiceType": "BEDROCK_AGENTCORE", "displayName": "Amazon Bedrock AgentCore", "description": "A managed service that enables you to develop, deploy, and maintain AI agents seamlessly." } ], "releaseNotes": "Version 1 of Elastic MCP Server", "usageInstructions": "See Elastic MCP GitHub instructions" } } ] } }, { "title": "List Helm Fulfillment Options", "input": { "locale": "en-US", "productId": "prod-sampleHelmId" }, "output": { "locale": "en-US", "fulfillmentOptions": [ { "helmFulfillmentOption": { "fulfillmentOptionId": "fo-sampleHelmId", "fulfillmentOptionName": "NGINX Ingress Controller", "fulfillmentOptionVersion": "1.14.3-0-r03", "fulfillmentOptionType": "HELM", "fulfillmentOptionDisplayName": "Helm Chart", "operatingSystems": [ { "operatingSystemFamilyName": "Linux", "operatingSystemName": "Linux" } ], "releaseNotes": "* Maintenance release", "awsSupportedServices": [ { "supportedServiceType": "EKS", "displayName": "Amazon EKS", "description": "Amazon Elastic Kubernetes Service" } ], "usageInstructions": "helm install nginx-ingress" } } ] } }, { "title": "List EKS Add-On Fulfillment Options", "input": { "locale": "en-US", "productId": "prod-sampleEksId" }, "output": { "locale": "en-US", "fulfillmentOptions": [ { "eksAddOnFulfillmentOption": { "fulfillmentOptionId": "fo-sampleEksId", "fulfillmentOptionName": "Splunk Distribution of the OpenTelemetry Collector Chart", "fulfillmentOptionVersion": "0.144.0", "fulfillmentOptionType": "EKS_ADD_ON", "fulfillmentOptionDisplayName": "Add-on for Amazon EKS", "operatingSystems": [ { "operatingSystemFamilyName": "Linux", "operatingSystemName": "Linux" } ], "releaseNotes": "https://github.com/signalfx/splunk-otel-collector-chart/releases/tag/splunk-otel-collector-0.144.0", "usageInstructions": "https://help.splunk.com/en/splunk-observability-cloud/manage-data/splunk-distribution-of-the-opentelemetry-collector/get-started-with-the-splunk-distribution-of-the-opentelemetry-collector/collector-for-kubernetes/kubernetes-eks-add-on", "awsSupportedServices": [ { "supportedServiceType": "EKS", "displayName": "Amazon EKS", "description": "Amazon Elastic Kubernetes Service" } ] } } ] } }, { "title": "List EC2 Image Builder Component Fulfillment Options", "input": { "locale": "en-US", "productId": "prod-sampleImageBuilderId" }, "output": { "locale": "en-US", "fulfillmentOptions": [ { "ec2ImageBuilderComponentFulfillmentOption": { "fulfillmentOptionId": "fo-sampleImageBuilderId", "fulfillmentOptionName": "Linux v1.2.3", "fulfillmentOptionVersion": "1.2.3", "fulfillmentOptionType": "EC2_IMAGE_BUILDER_COMPONENT", "fulfillmentOptionDisplayName": "EC2 Image Builder Component", "operatingSystems": [ { "operatingSystemFamilyName": "Linux", "operatingSystemName": "Linux" } ], "awsSupportedServices": [ { "supportedServiceType": "IMAGEBUILDER", "displayName": "Amazon EC2 Image Builder", "description": "EC2 Image Builder is a fully managed AWS service. It automates creation, management, and deployment of custom, secure, and up-to-date server images." } ], "releaseNotes": "https://github.com/CrowdStrike/aws-ec2-image-builder/releases", "usageInstructions": "https://github.com/CrowdStrike/aws-ec2-image-builder" } } ] } }, { "title": "List Data Exchange Fulfillment Options", "input": { "locale": "en-US", "productId": "prod-sampleDataExchangeId" }, "output": { "locale": "en-US", "fulfillmentOptions": [ { "dataExchangeFulfillmentOption": { "fulfillmentOptionId": "fo-sampleDataExchangeId", "fulfillmentOptionType": "DATA_EXCHANGE", "fulfillmentOptionDisplayName": "Data Exchange", "dataArtifacts": [ { "description": "Sample testing dataset.", "resourceArn": "arn:aws:dataexchange:us-east-2::DataSet/sample-dataset-id", "resourceType": "API_GATEWAY_APIS", "dataClassification": "NONE" } ] } } ] } }, { "title": "List Professional Services Fulfillment Options", "input": { "locale": "en-US", "productId": "prod-sampleProServId" }, "output": { "locale": "en-US", "fulfillmentOptions": [ { "professionalServicesFulfillmentOption": { "fulfillmentOptionId": "fo-sampleProServId", "fulfillmentOptionType": "PROFESSIONAL_SERVICES", "fulfillmentOptionDisplayName": "Professional Services" } } ] } }, { "title": "List SaaS Fulfillment Options", "input": { "locale": "en-US", "productId": "prod-sampleSaasId" }, "output": { "locale": "en-US", "fulfillmentOptions": [ { "saasFulfillmentOption": { "fulfillmentOptionId": "fo-sampleSaasId", "fulfillmentOptionType": "SAAS", "fulfillmentOptionDisplayName": "SaaS", "fulfillmentUrl": "https://example.com/order/SAMPLE123", "usageInstructions": "Refer to the seller's setup guide to configure and start using this SaaS product.", "availableFromTime": "2018-08-07T00:00:00.000Z", "launchUrl": "https://example.com/saas/launch", "quickLaunch": "ENABLED" } } ] } }, { "title": "List SageMaker Algorithm Fulfillment Options", "input": { "locale": "en-US", "productId": "prod-sampleSmAlgoId" }, "output": { "locale": "en-US", "fulfillmentOptions": [ { "sageMakerAlgorithmFulfillmentOption": { "fulfillmentOptionId": "fo-sampleSmAlgoId", "fulfillmentOptionVersion": "v1.0.0", "fulfillmentOptionType": "SAGEMAKER_ALGORITHM", "fulfillmentOptionDisplayName": "SageMaker Algorithm", "releaseNotes": "Bug fixes", "usageInstructions": "A zip file called train should be provided.", "recommendation": { "recommendedBatchTransformInstanceType": "ml.m5.large", "recommendedRealtimeInferenceInstanceType": "ml.m5.large", "recommendedTrainingInstanceType": "ml.g4dn.xlarge" } } } ] } }, { "title": "List SageMaker Model Fulfillment Options", "input": { "locale": "en-US", "productId": "prod-sampleSmModelId" }, "output": { "locale": "en-US", "fulfillmentOptions": [ { "sageMakerModelFulfillmentOption": { "fulfillmentOptionId": "fo-sampleSmModelId", "fulfillmentOptionVersion": "1.2.3", "fulfillmentOptionType": "SAGEMAKER_MODEL", "fulfillmentOptionDisplayName": "SageMaker Model", "releaseNotes": "Initial release", "usageInstructions": "See Input Summary", "recommendation": { "recommendedBatchTransformInstanceType": "ml.g5.12xlarge", "recommendedRealtimeInferenceInstanceType": "ml.g5.12xlarge" }, "supportedContentTypes": [ "application/json", "text/csv" ], "supportedResponseMimeTypes": [ "application/json" ] } } ] } } ], "smithy.api#http": { "code": 200, "method": "POST", "uri": "/2026-02-05/listFulfillmentOptions" }, "smithy.api#paginated": { "inputToken": "nextToken", "outputToken": "nextToken", "pageSize": "maxResults", "items": "fulfillmentOptions" }, "smithy.api#readonly": {}, "smithy.test#smokeTests": [ { "id": "ListFulfillmentOptionsFailure", "params": { "productId": "non-existent-product-id" }, "expect": { "failure": { "errorId": "com.amazonaws.marketplacediscovery#ResourceNotFoundException" } }, "vendorParamsShape": "aws.test#AwsVendorParams", "vendorParams": { "region": "us-east-1" } } ] } }, "com.amazonaws.marketplacediscovery#ListFulfillmentOptionsInput": { "type": "structure", "members": { "locale": { "target": "com.amazonaws.marketplacediscovery#Locale", "traits": { "smithy.api#documentation": "

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": { "target": "com.amazonaws.marketplacediscovery#ProductId", "traits": { "smithy.api#documentation": "

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

", "smithy.api#required": {} } }, "maxResults": { "target": "smithy.api#Integer", "traits": { "smithy.api#default": 25, "smithy.api#documentation": "

The maximum number of results that are returned per call. You can use nextToken to get more results.

", "smithy.api#range": { "min": 1, "max": 50 } } }, "nextToken": { "target": "com.amazonaws.marketplacediscovery#NextToken", "traits": { "smithy.api#documentation": "

If nextToken is returned, there are more results available. Make the call again using the returned token to retrieve the next page.

" } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.marketplacediscovery#ListFulfillmentOptionsOutput": { "type": "structure", "members": { "locale": { "target": "com.amazonaws.marketplacediscovery#Locale" }, "fulfillmentOptions": { "target": "com.amazonaws.marketplacediscovery#FulfillmentOptionsList", "traits": { "smithy.api#documentation": "

The fulfillment options available for the product. Each option describes how the buyer can deploy or access the product.

", "smithy.api#required": {} } }, "nextToken": { "target": "com.amazonaws.marketplacediscovery#NextToken", "traits": { "smithy.api#documentation": "

If nextToken is returned, there are more results available. Make the call again using the returned token to retrieve the next page.

" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.marketplacediscovery#ListPurchaseOptions": { "type": "operation", "input": { "target": "com.amazonaws.marketplacediscovery#ListPurchaseOptionsInput" }, "output": { "target": "com.amazonaws.marketplacediscovery#ListPurchaseOptionsOutput" }, "traits": { "smithy.api#documentation": "

Returns the purchase options (offers and offer sets) available to the buyer. You can filter results by product, seller, purchase option type, visibility scope, and availability status.

You must include at least one of the following filters in the request: a PRODUCT_ID filter to specify the product for which to retrieve purchase options, or a VISIBILITY_SCOPE filter to retrieve purchase options by visibility.

", "smithy.api#examples": [ { "title": "Filter by Product ID", "input": { "locale": "en-US", "filters": [ { "filterType": "PRODUCT_ID", "filterValues": [ "prod-sampleOfferId" ] } ] }, "output": { "purchaseOptions": [ { "purchaseOptionId": "offer-sampleOfferId", "catalog": "AWS_MARKETPLACE", "purchaseOptionType": "OFFER", "purchaseOptionName": "sample offer", "availableFromTime": "2021-12-15T00:00:00.000Z", "sellerOfRecord": { "sellerProfileId": "seller-sampleOfferId", "displayName": "sample offer seller" }, "badges": [], "associatedEntities": [ { "product": { "productId": "prod-sampleOfferId", "productName": "sample offer product", "manufacturer": { "sellerProfileId": "seller-sampleOfferId", "displayName": "sample offer seller" } }, "offer": { "offerId": "offer-sampleOfferId", "sellerOfRecord": { "sellerProfileId": "seller-sampleOfferId", "displayName": "sample offer seller" } } } ] } ] } }, { "title": "Filter by Seller with Private Offerset", "input": { "locale": "en-US", "filters": [ { "filterType": "SELLER_OF_RECORD_PROFILE_ID", "filterValues": [ "seller-sampleResellerId" ] }, { "filterType": "PURCHASE_OPTION_TYPE", "filterValues": [ "OFFERSET" ] }, { "filterType": "VISIBILITY_SCOPE", "filterValues": [ "PRIVATE" ] } ] }, "output": { "purchaseOptions": [ { "purchaseOptionId": "offerset-sampleId", "catalog": "AWS_MARKETPLACE", "purchaseOptionType": "OFFERSET", "purchaseOptionName": "sample offerset", "availableFromTime": "2024-03-20T00:00:00.000Z", "expirationTime": "2025-03-20T00:00:00.000Z", "sellerOfRecord": { "sellerProfileId": "seller-sampleResellerId", "displayName": "sample reseller" }, "badges": [ { "displayName": "Private Pricing", "badgeType": "PRIVATE_PRICING" } ], "associatedEntities": [ { "product": { "productId": "prod-sampleId1", "productName": "sample product name 1", "manufacturer": { "sellerProfileId": "seller-sampleId1", "displayName": "sample seller name 1" } }, "offer": { "offerId": "offer-sampleId1", "sellerOfRecord": { "sellerProfileId": "seller-sampleResellerId", "displayName": "sample reseller" } } }, { "product": { "productId": "prod-sampleId2", "productName": "sample product name 2", "manufacturer": { "sellerProfileId": "seller-sampleId2", "displayName": "sample seller name 2" } }, "offer": { "offerId": "offer-sampleId2", "sellerOfRecord": { "sellerProfileId": "seller-sampleResellerId", "displayName": "sample reseller" } } } ] } ] } } ], "smithy.api#http": { "code": 200, "method": "POST", "uri": "/2026-02-05/listPurchaseOptions" }, "smithy.api#paginated": { "inputToken": "nextToken", "outputToken": "nextToken", "items": "purchaseOptions" }, "smithy.api#readonly": {}, "smithy.test#smokeTests": [ { "id": "ListPurchaseOptionsSuccess", "params": { "filters": [ { "filterType": "PRODUCT_ID", "filterValues": [ "non-existent-product-id" ] } ] }, "expect": { "success": {} }, "vendorParamsShape": "aws.test#AwsVendorParams", "vendorParams": { "region": "us-east-1" } } ] } }, "com.amazonaws.marketplacediscovery#ListPurchaseOptionsInput": { "type": "structure", "members": { "locale": { "target": "com.amazonaws.marketplacediscovery#Locale", "traits": { "smithy.api#documentation": "

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.

" } }, "filters": { "target": "com.amazonaws.marketplacediscovery#PurchaseOptionFilterList", "traits": { "smithy.api#documentation": "

Filters to narrow the results. Multiple filters are combined with AND logic. Multiple values within the same filter are combined with OR logic.

" } }, "maxResults": { "target": "com.amazonaws.marketplacediscovery#MaxResults", "traits": { "smithy.api#default": 25, "smithy.api#documentation": "

The maximum number of results that are returned per call. You can use nextToken to get more results.

", "smithy.api#range": { "min": 1, "max": 100 } } }, "nextToken": { "target": "com.amazonaws.marketplacediscovery#NextToken", "traits": { "smithy.api#documentation": "

If nextToken is returned, there are more results available. Make the call again using the returned token to retrieve the next page.

" } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.marketplacediscovery#ListPurchaseOptionsOutput": { "type": "structure", "members": { "purchaseOptions": { "target": "com.amazonaws.marketplacediscovery#PurchaseOptionSummaryList", "traits": { "smithy.api#documentation": "

The purchase options available to the buyer. Each option is either an offer for a single product or an offer set spanning multiple products.

" } }, "nextToken": { "target": "com.amazonaws.marketplacediscovery#NextToken", "traits": { "smithy.api#documentation": "

If nextToken is returned, there are more results available. Make the call again using the returned token to retrieve the next page.

" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.marketplacediscovery#ListingAssociatedEntity": { "type": "structure", "members": { "product": { "target": "com.amazonaws.marketplacediscovery#ProductInformation", "traits": { "smithy.api#documentation": "

Information about the product associated with the listing.

" } }, "offer": { "target": "com.amazonaws.marketplacediscovery#OfferInformation", "traits": { "smithy.api#documentation": "

Information about the default offer associated with the listing.

" } } }, "traits": { "smithy.api#documentation": "

A product and offer associated with a listing.

" } }, "com.amazonaws.marketplacediscovery#ListingAssociatedEntityList": { "type": "list", "member": { "target": "com.amazonaws.marketplacediscovery#ListingAssociatedEntity" }, "traits": { "smithy.api#length": { "max": 100 } } }, "com.amazonaws.marketplacediscovery#ListingBadge": { "type": "structure", "members": { "displayName": { "target": "com.amazonaws.marketplacediscovery#NonEmptyString", "traits": { "smithy.api#documentation": "

The human-readable name of the badge.

", "smithy.api#required": {} } }, "badgeType": { "target": "com.amazonaws.marketplacediscovery#ListingBadgeType", "traits": { "smithy.api#documentation": "

The machine-readable type of the badge.

", "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "

A badge indicating a special attribute of a listing, such as free tier eligibility or Quick Launch support.

" } }, "com.amazonaws.marketplacediscovery#ListingBadgeList": { "type": "list", "member": { "target": "com.amazonaws.marketplacediscovery#ListingBadge" }, "traits": { "smithy.api#length": { "max": 20 } } }, "com.amazonaws.marketplacediscovery#ListingBadgeType": { "type": "enum", "members": { "AWS_FREE_TIER": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "AWS_FREE_TIER" } }, "FREE_TRIAL": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "FREE_TRIAL" } }, "DEPLOYED_ON_AWS": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "DEPLOYED_ON_AWS" } }, "QUICK_LAUNCH": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "QUICK_LAUNCH" } }, "MULTI_PRODUCT": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "MULTI_PRODUCT" } } } }, "com.amazonaws.marketplacediscovery#ListingFacet": { "type": "structure", "members": { "value": { "target": "com.amazonaws.marketplacediscovery#NonEmptyString", "traits": { "smithy.api#documentation": "

The internal value used for filtering when passed back in a search filter.

", "smithy.api#required": {} } }, "displayName": { "target": "com.amazonaws.marketplacediscovery#NonEmptyString", "traits": { "smithy.api#documentation": "

The human-readable name of the facet value, suitable for display in a user interface.

", "smithy.api#required": {} } }, "parent": { "target": "com.amazonaws.marketplacediscovery#NullableString", "traits": { "smithy.api#documentation": "

The parent facet value for hierarchical facets, such as subcategories.

" } }, "count": { "target": "com.amazonaws.marketplacediscovery#NonNegativeCount", "traits": { "smithy.api#documentation": "

The number of listings matching this facet value.

", "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "

A facet value with display information and a count of matching listings. Used to build filter and browse experiences.

" } }, "com.amazonaws.marketplacediscovery#ListingFacetList": { "type": "list", "member": { "target": "com.amazonaws.marketplacediscovery#ListingFacet" }, "traits": { "smithy.api#length": { "max": 100 } } }, "com.amazonaws.marketplacediscovery#ListingId": { "type": "string", "traits": { "smithy.api#length": { "min": 1, "max": 255 }, "smithy.api#pattern": "^[\\w\\-]+$" } }, "com.amazonaws.marketplacediscovery#ListingSummary": { "type": "structure", "members": { "listingId": { "target": "com.amazonaws.marketplacediscovery#ListingId", "traits": { "smithy.api#documentation": "

The unique identifier of the listing.

", "smithy.api#required": {} } }, "listingName": { "target": "com.amazonaws.marketplacediscovery#NonEmptyString", "traits": { "smithy.api#documentation": "

The human-readable display name of the listing.

", "smithy.api#required": {} } }, "publisher": { "target": "com.amazonaws.marketplacediscovery#SellerInformation", "traits": { "smithy.api#documentation": "

The entity who created and published the listing.

", "smithy.api#required": {} } }, "fulfillmentOptionSummaries": { "target": "com.amazonaws.marketplacediscovery#FulfillmentOptionSummaryList", "traits": { "smithy.api#documentation": "

A summary of fulfillment options available for the listing.

", "smithy.api#required": {} } }, "catalog": { "target": "com.amazonaws.marketplacediscovery#Catalog", "traits": { "smithy.api#documentation": "

The name of the catalog that the listing belongs to.

", "smithy.api#required": {} } }, "shortDescription": { "target": "com.amazonaws.marketplacediscovery#NonEmptyString", "traits": { "smithy.api#documentation": "

A 1\u20133 sentence summary describing the key aspects of the listing.

", "smithy.api#required": {} } }, "logoThumbnailUrl": { "target": "com.amazonaws.marketplacediscovery#URL", "traits": { "smithy.api#documentation": "

The URL of the logo thumbnail image for the listing.

", "smithy.api#required": {} } }, "categories": { "target": "com.amazonaws.marketplacediscovery#CategoryList", "traits": { "smithy.api#documentation": "

The categories used to classify this listing into logical groups.

", "smithy.api#required": {} } }, "badges": { "target": "com.amazonaws.marketplacediscovery#ListingBadgeList", "traits": { "smithy.api#documentation": "

Badges indicating special attributes of the listing.

", "smithy.api#required": {} } }, "reviewSummary": { "target": "com.amazonaws.marketplacediscovery#ReviewSummary", "traits": { "smithy.api#documentation": "

A summary of customer reviews for the listing.

", "smithy.api#required": {} } }, "pricingModels": { "target": "com.amazonaws.marketplacediscovery#PricingModelList", "traits": { "smithy.api#documentation": "

The pricing models for offers associated with this listing.

", "smithy.api#required": {} } }, "pricingUnits": { "target": "com.amazonaws.marketplacediscovery#PricingUnitList", "traits": { "smithy.api#documentation": "

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

", "smithy.api#required": {} } }, "associatedEntities": { "target": "com.amazonaws.marketplacediscovery#ListingSummaryAssociatedEntityList", "traits": { "smithy.api#documentation": "

The products associated with this listing.

", "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "

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

" } }, "com.amazonaws.marketplacediscovery#ListingSummaryAssociatedEntity": { "type": "structure", "members": { "product": { "target": "com.amazonaws.marketplacediscovery#ProductInformation", "traits": { "smithy.api#documentation": "

Information about the associated product.

" } } }, "traits": { "smithy.api#documentation": "

A product associated with a listing summary.

" } }, "com.amazonaws.marketplacediscovery#ListingSummaryAssociatedEntityList": { "type": "list", "member": { "target": "com.amazonaws.marketplacediscovery#ListingSummaryAssociatedEntity" }, "traits": { "smithy.api#length": { "max": 50 } } }, "com.amazonaws.marketplacediscovery#ListingSummaryList": { "type": "list", "member": { "target": "com.amazonaws.marketplacediscovery#ListingSummary" } }, "com.amazonaws.marketplacediscovery#Locale": { "type": "string", "traits": { "smithy.api#documentation": "

A 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 below.

The field is optional. If omitted or null, the service returns content in the default locale (en-US).

Supported locales:

Fallback behavior:

Response locale field (Get APIs): 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.

Examples:

", "smithy.api#length": { "min": 1, "max": 256 }, "smithy.api#pattern": "^[^;,]+(\\s*,\\s*[^;,]+){0,1}$" } }, "com.amazonaws.marketplacediscovery#MaxResults": { "type": "integer", "traits": { "smithy.api#default": 25, "smithy.api#range": { "min": 1, "max": 100 } } }, "com.amazonaws.marketplacediscovery#NetPaymentTerm": { "type": "structure", "members": { "id": { "target": "com.amazonaws.marketplacediscovery#TermId", "traits": { "smithy.api#documentation": "

The unique identifier of the term.

", "smithy.api#required": {} } }, "type": { "target": "com.amazonaws.marketplacediscovery#TermType", "traits": { "smithy.api#documentation": "

The category of the term.

", "smithy.api#required": {} } }, "paymentDuePeriod": { "target": "com.amazonaws.marketplacediscovery#BoundedString", "traits": { "smithy.api#documentation": "

The duration after invoice date by which payment is due.

", "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "

Defines a net payment term that sets how many days after the invoice date the payment is due.

" } }, "com.amazonaws.marketplacediscovery#NextToken": { "type": "string", "traits": { "smithy.api#length": { "min": 0, "max": 8192 }, "smithy.api#pattern": "^[a-zA-Z0-9+/=]+$" } }, "com.amazonaws.marketplacediscovery#NonEmptyString": { "type": "string", "traits": { "smithy.api#length": { "min": 1, "max": 1024 }, "smithy.api#pattern": "^.*\\S.*$" } }, "com.amazonaws.marketplacediscovery#NonNegativeCount": { "type": "long", "traits": { "smithy.api#range": { "min": 0 } } }, "com.amazonaws.marketplacediscovery#NullableString": { "type": "string", "traits": { "smithy.api#length": { "max": 255 } } }, "com.amazonaws.marketplacediscovery#OfferAssociatedEntity": { "type": "structure", "members": { "product": { "target": "com.amazonaws.marketplacediscovery#ProductInformation", "traits": { "smithy.api#documentation": "

Information about the product associated with the offer.

", "smithy.api#required": {} } }, "offerSet": { "target": "com.amazonaws.marketplacediscovery#OfferSetInformation", "traits": { "smithy.api#documentation": "

Information about the offer set, if the offer is part of a bundled offer set.

" } } }, "traits": { "smithy.api#documentation": "

A product and optional offer set associated with an offer.

" } }, "com.amazonaws.marketplacediscovery#OfferAssociatedEntityList": { "type": "list", "member": { "target": "com.amazonaws.marketplacediscovery#OfferAssociatedEntity" }, "traits": { "smithy.api#length": { "max": 100 } } }, "com.amazonaws.marketplacediscovery#OfferId": { "type": "string", "traits": { "smithy.api#length": { "min": 1, "max": 255 }, "smithy.api#pattern": "^[\\w\\-]+$" } }, "com.amazonaws.marketplacediscovery#OfferInformation": { "type": "structure", "members": { "offerId": { "target": "com.amazonaws.marketplacediscovery#OfferId", "traits": { "smithy.api#documentation": "

The unique identifier of the offer.

", "smithy.api#required": {} } }, "offerName": { "target": "com.amazonaws.marketplacediscovery#NullableString", "traits": { "smithy.api#documentation": "

The display name of the offer.

" } }, "sellerOfRecord": { "target": "com.amazonaws.marketplacediscovery#SellerInformation", "traits": { "smithy.api#documentation": "

The entity responsible for selling the product under this offer.

", "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "

Summary information about an offer, including the offer identifier, name, and seller of record.

" } }, "com.amazonaws.marketplacediscovery#OfferSetAssociatedEntity": { "type": "structure", "members": { "product": { "target": "com.amazonaws.marketplacediscovery#ProductInformation", "traits": { "smithy.api#documentation": "

Information about the product associated with the offer set.

", "smithy.api#required": {} } }, "offer": { "target": "com.amazonaws.marketplacediscovery#OfferInformation", "traits": { "smithy.api#documentation": "

Information about the offer associated with the offer set.

", "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "

A product and offer associated with an offer set.

" } }, "com.amazonaws.marketplacediscovery#OfferSetAssociatedEntityList": { "type": "list", "member": { "target": "com.amazonaws.marketplacediscovery#OfferSetAssociatedEntity" }, "traits": { "smithy.api#length": { "max": 100 } } }, "com.amazonaws.marketplacediscovery#OfferSetId": { "type": "string", "traits": { "smithy.api#length": { "min": 1, "max": 255 }, "smithy.api#pattern": "^[\\w\\-]+$" } }, "com.amazonaws.marketplacediscovery#OfferSetInformation": { "type": "structure", "members": { "offerSetId": { "target": "com.amazonaws.marketplacediscovery#OfferSetId", "traits": { "smithy.api#documentation": "

The unique identifier of the offer set.

", "smithy.api#required": {} } }, "sellerOfRecord": { "target": "com.amazonaws.marketplacediscovery#SellerInformation", "traits": { "smithy.api#documentation": "

The entity responsible for selling the products under this offer set.

", "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "

Summary information about an offer set, including the identifier and seller of record.

" } }, "com.amazonaws.marketplacediscovery#OfferTerm": { "type": "union", "members": { "byolPricingTerm": { "target": "com.amazonaws.marketplacediscovery#ByolPricingTerm" }, "configurableUpfrontPricingTerm": { "target": "com.amazonaws.marketplacediscovery#ConfigurableUpfrontPricingTerm" }, "fixedUpfrontPricingTerm": { "target": "com.amazonaws.marketplacediscovery#FixedUpfrontPricingTerm" }, "freeTrialPricingTerm": { "target": "com.amazonaws.marketplacediscovery#FreeTrialPricingTerm" }, "legalTerm": { "target": "com.amazonaws.marketplacediscovery#LegalTerm" }, "paymentScheduleTerm": { "target": "com.amazonaws.marketplacediscovery#PaymentScheduleTerm" }, "recurringPaymentTerm": { "target": "com.amazonaws.marketplacediscovery#RecurringPaymentTerm" }, "renewalTerm": { "target": "com.amazonaws.marketplacediscovery#RenewalTerm" }, "supportTerm": { "target": "com.amazonaws.marketplacediscovery#SupportTerm" }, "usageBasedPricingTerm": { "target": "com.amazonaws.marketplacediscovery#UsageBasedPricingTerm" }, "validityTerm": { "target": "com.amazonaws.marketplacediscovery#ValidityTerm" }, "variablePaymentTerm": { "target": "com.amazonaws.marketplacediscovery#VariablePaymentTerm" }, "netPaymentTerm": { "target": "com.amazonaws.marketplacediscovery#NetPaymentTerm", "traits": { "smithy.api#documentation": "

A net payment term.

" } } }, "traits": { "smithy.api#documentation": "

A term attached to an offer. Each element contains exactly one term type, such as a pricing term, legal term, or payment schedule term.

" } }, "com.amazonaws.marketplacediscovery#OfferTermsList": { "type": "list", "member": { "target": "com.amazonaws.marketplacediscovery#OfferTerm" } }, "com.amazonaws.marketplacediscovery#PaymentScheduleEntry": { "type": "structure", "members": { "chargeDateOffset": { "target": "com.amazonaws.marketplacediscovery#BoundedString", "traits": { "smithy.api#documentation": "

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

", "smithy.api#required": {} } }, "chargePercentage": { "target": "com.amazonaws.marketplacediscovery#BoundedString", "traits": { "smithy.api#documentation": "

The percentage of the increased Total Contract Value (TCV) to charge in this installment. All entries in a schedule sum to 100.00.

", "smithy.api#required": {} } }, "dayOfMonth": { "target": "smithy.api#Integer", "traits": { "smithy.api#documentation": "

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.

", "smithy.api#range": { "min": 1, "max": 31 } } } }, "traits": { "smithy.api#documentation": "

A single installment entry in the renewal payment schedule.

" } }, "com.amazonaws.marketplacediscovery#PaymentScheduleEntryList": { "type": "list", "member": { "target": "com.amazonaws.marketplacediscovery#PaymentScheduleEntry" }, "traits": { "smithy.api#length": { "min": 1, "max": 200 } } }, "com.amazonaws.marketplacediscovery#PaymentScheduleTerm": { "type": "structure", "members": { "id": { "target": "com.amazonaws.marketplacediscovery#TermId", "traits": { "smithy.api#documentation": "

The unique identifier of the term.

", "smithy.api#required": {} } }, "type": { "target": "com.amazonaws.marketplacediscovery#TermType", "traits": { "smithy.api#documentation": "

The category of the term.

", "smithy.api#required": {} } }, "currencyCode": { "target": "com.amazonaws.marketplacediscovery#CurrencyCode", "traits": { "smithy.api#documentation": "

Defines the currency for the prices in this term.

", "smithy.api#required": {} } }, "schedule": { "target": "com.amazonaws.marketplacediscovery#ScheduleList", "traits": { "smithy.api#documentation": "

The payment schedule installments, each with a charge date and amount.

", "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "

Defines a payment schedule term with installment payments at specified dates.

" } }, "com.amazonaws.marketplacediscovery#PaymentScheduleTermTemplate": { "type": "structure", "members": { "schedule": { "target": "com.amazonaws.marketplacediscovery#PaymentScheduleEntryList", "traits": { "smithy.api#documentation": "

An ordered list of installment entries for the renewal payment schedule.

", "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "

A template for the payment schedule term on the renewal offer.

" } }, "com.amazonaws.marketplacediscovery#PercentageRange": { "type": "structure", "members": { "minimumValue": { "target": "com.amazonaws.marketplacediscovery#BoundedString", "traits": { "smithy.api#documentation": "

The minimum percentage by which the price can increase at each renewal cycle.

", "smithy.api#required": {} } }, "maximumValue": { "target": "com.amazonaws.marketplacediscovery#BoundedString", "traits": { "smithy.api#documentation": "

The maximum percentage by which the price can increase at each renewal cycle.

", "smithy.api#required": {} } }, "defaultValue": { "target": "com.amazonaws.marketplacediscovery#BoundedString", "traits": { "smithy.api#documentation": "

The percentage increase applied by default when no other value is finalized before the adjustment deadline. Falls between minimumValue and maximumValue.

", "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "

A price increase percentage range with minimum, maximum, and default values.

" } }, "com.amazonaws.marketplacediscovery#PriceIncrease": { "type": "union", "members": { "fixedPercentage": { "target": "com.amazonaws.marketplacediscovery#FixedPercentage", "traits": { "smithy.api#documentation": "

A single fixed percentage applied uniformly at every renewal cycle.

" } }, "percentageRange": { "target": "com.amazonaws.marketplacediscovery#PercentageRange", "traits": { "smithy.api#documentation": "

A percentage band with minimum, maximum, and default values that bound the price increase at each renewal cycle.

" } } }, "traits": { "smithy.api#documentation": "

The pricing adjustment that applies at each renewal cycle, expressed as either a fixed percentage or a percentage range. Exactly one variant is present.

" } }, "com.amazonaws.marketplacediscovery#PricingModel": { "type": "structure", "members": { "pricingModelType": { "target": "com.amazonaws.marketplacediscovery#PricingModelType", "traits": { "smithy.api#documentation": "

The machine-readable type of the pricing model.

", "smithy.api#required": {} } }, "displayName": { "target": "com.amazonaws.marketplacediscovery#NonEmptyString", "traits": { "smithy.api#documentation": "

The human-readable name of the pricing model.

", "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "

A pricing model that determines how buyers are charged for a listing, such as usage-based, contract, BYOL, or free.

" } }, "com.amazonaws.marketplacediscovery#PricingModelList": { "type": "list", "member": { "target": "com.amazonaws.marketplacediscovery#PricingModel" }, "traits": { "smithy.api#length": { "max": 20 } } }, "com.amazonaws.marketplacediscovery#PricingModelType": { "type": "enum", "members": { "USAGE": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "USAGE" } }, "CONTRACT": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "CONTRACT" } }, "BYOL": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "BYOL" } }, "FREE": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "FREE" } } } }, "com.amazonaws.marketplacediscovery#PricingUnit": { "type": "structure", "members": { "pricingUnitType": { "target": "com.amazonaws.marketplacediscovery#PricingUnitType", "traits": { "smithy.api#documentation": "

The machine-readable type of the pricing unit.

", "smithy.api#required": {} } }, "displayName": { "target": "com.amazonaws.marketplacediscovery#NonEmptyString", "traits": { "smithy.api#documentation": "

The human-readable name of the pricing unit.

", "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "

A pricing unit that defines the billing dimension for a listing, such as users, hosts, bandwidth, or data.

" } }, "com.amazonaws.marketplacediscovery#PricingUnitList": { "type": "list", "member": { "target": "com.amazonaws.marketplacediscovery#PricingUnit" }, "traits": { "smithy.api#length": { "max": 20 } } }, "com.amazonaws.marketplacediscovery#PricingUnitType": { "type": "enum", "members": { "USERS": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "USERS" } }, "HOSTS": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "HOSTS" } }, "BANDWIDTH": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "BANDWIDTH" } }, "DATA": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "DATA" } }, "TIERS": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "TIERS" } }, "REQUESTS": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "REQUESTS" } }, "UNITS": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "UNITS" } } } }, "com.amazonaws.marketplacediscovery#ProductId": { "type": "string", "traits": { "smithy.api#length": { "min": 1, "max": 255 }, "smithy.api#pattern": "^[\\w\\-]+$" } }, "com.amazonaws.marketplacediscovery#ProductInformation": { "type": "structure", "members": { "productId": { "target": "com.amazonaws.marketplacediscovery#ProductId", "traits": { "smithy.api#documentation": "

The unique identifier of the product.

", "smithy.api#required": {} } }, "productName": { "target": "com.amazonaws.marketplacediscovery#NonEmptyString", "traits": { "smithy.api#documentation": "

The human-readable display name of the product.

", "smithy.api#required": {} } }, "manufacturer": { "target": "com.amazonaws.marketplacediscovery#SellerInformation", "traits": { "smithy.api#documentation": "

The entity who manufactured the product.

", "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "

Summary information about a product, including the identifier, name, and manufacturer.

" } }, "com.amazonaws.marketplacediscovery#ProfessionalServicesFulfillmentOption": { "type": "structure", "members": { "fulfillmentOptionId": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "

The unique identifier of the fulfillment option.

", "smithy.api#required": {} } }, "fulfillmentOptionType": { "target": "com.amazonaws.marketplacediscovery#FulfillmentOptionType", "traits": { "smithy.api#documentation": "

The category of the fulfillment option.

", "smithy.api#required": {} } }, "fulfillmentOptionDisplayName": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "

A human-readable name for the fulfillment option type.

", "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "

Describes a professional services fulfillment option.

" } }, "com.amazonaws.marketplacediscovery#PromotionalEmbeddedImage": { "type": "structure", "members": { "title": { "target": "com.amazonaws.marketplacediscovery#NonEmptyString", "traits": { "smithy.api#documentation": "

The title displayed when hovering over the image.

", "smithy.api#required": {} } }, "url": { "target": "com.amazonaws.marketplacediscovery#URL", "traits": { "smithy.api#documentation": "

The URL of the image file.

", "smithy.api#required": {} } }, "description": { "target": "com.amazonaws.marketplacediscovery#NullableString", "traits": { "smithy.api#documentation": "

An optional description of the image.

" } } }, "traits": { "smithy.api#documentation": "

An embedded promotional image for a product.

" } }, "com.amazonaws.marketplacediscovery#PromotionalEmbeddedVideo": { "type": "structure", "members": { "title": { "target": "com.amazonaws.marketplacediscovery#NonEmptyString", "traits": { "smithy.api#documentation": "

The title displayed when hovering over the video.

", "smithy.api#required": {} } }, "url": { "target": "com.amazonaws.marketplacediscovery#URL", "traits": { "smithy.api#documentation": "

The URL of the video file.

", "smithy.api#required": {} } }, "preview": { "target": "com.amazonaws.marketplacediscovery#URL", "traits": { "smithy.api#documentation": "

The URL of the high-resolution preview image for the video.

", "smithy.api#required": {} } }, "thumbnail": { "target": "com.amazonaws.marketplacediscovery#URL", "traits": { "smithy.api#documentation": "

The URL of the thumbnail image for the video.

", "smithy.api#required": {} } }, "description": { "target": "com.amazonaws.marketplacediscovery#NullableString", "traits": { "smithy.api#documentation": "

An optional description of the video.

" } } }, "traits": { "smithy.api#documentation": "

An embedded promotional video for a product.

" } }, "com.amazonaws.marketplacediscovery#PromotionalMedia": { "type": "union", "members": { "embeddedImage": { "target": "com.amazonaws.marketplacediscovery#PromotionalEmbeddedImage" }, "embeddedVideo": { "target": "com.amazonaws.marketplacediscovery#PromotionalEmbeddedVideo" } }, "traits": { "smithy.api#documentation": "

Embedded promotional media for a product, such as images or videos. Each element contains exactly one media type.

" } }, "com.amazonaws.marketplacediscovery#PromotionalMediaList": { "type": "list", "member": { "target": "com.amazonaws.marketplacediscovery#PromotionalMedia" }, "traits": { "smithy.api#length": { "max": 100 } } }, "com.amazonaws.marketplacediscovery#PurchaseOptionAssociatedEntity": { "type": "structure", "members": { "product": { "target": "com.amazonaws.marketplacediscovery#ProductInformation", "traits": { "smithy.api#documentation": "

Information about the product associated with the purchase option.

", "smithy.api#required": {} } }, "offer": { "target": "com.amazonaws.marketplacediscovery#OfferInformation", "traits": { "smithy.api#documentation": "

Information about the offer associated with the purchase option.

", "smithy.api#required": {} } }, "offerSet": { "target": "com.amazonaws.marketplacediscovery#OfferSetInformation", "traits": { "smithy.api#documentation": "

Information about the offer set, if the purchase option is part of a bundled offer set.

" } } }, "traits": { "smithy.api#documentation": "

A product, offer, and optional offer set associated with a purchase option.

" } }, "com.amazonaws.marketplacediscovery#PurchaseOptionAssociatedEntityList": { "type": "list", "member": { "target": "com.amazonaws.marketplacediscovery#PurchaseOptionAssociatedEntity" }, "traits": { "smithy.api#length": { "max": 100 } } }, "com.amazonaws.marketplacediscovery#PurchaseOptionBadge": { "type": "structure", "members": { "displayName": { "target": "com.amazonaws.marketplacediscovery#NonEmptyString", "traits": { "smithy.api#documentation": "

The human-readable name of the badge.

", "smithy.api#required": {} } }, "badgeType": { "target": "com.amazonaws.marketplacediscovery#PurchaseOptionBadgeType", "traits": { "smithy.api#documentation": "

The machine-readable type of the badge.

", "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "

A badge indicating a special attribute of a purchase option, such as private pricing or future dated.

" } }, "com.amazonaws.marketplacediscovery#PurchaseOptionBadgeList": { "type": "list", "member": { "target": "com.amazonaws.marketplacediscovery#PurchaseOptionBadge" }, "traits": { "smithy.api#length": { "max": 20 } } }, "com.amazonaws.marketplacediscovery#PurchaseOptionBadgeType": { "type": "enum", "members": { "PRIVATE_PRICING": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "PRIVATE_PRICING" } }, "FUTURE_DATED": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "FUTURE_DATED" } }, "REPLACEMENT_OFFER": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "REPLACEMENT_OFFER" } }, "AUTO_RENEW": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "AUTO_RENEW" } } } }, "com.amazonaws.marketplacediscovery#PurchaseOptionFilter": { "type": "structure", "members": { "filterType": { "target": "com.amazonaws.marketplacediscovery#PurchaseOptionFilterType", "traits": { "smithy.api#documentation": "

The type of filter to apply, such as PRODUCT_ID, VISIBILITY_SCOPE, or PURCHASE_OPTION_TYPE.

", "smithy.api#required": {} } }, "filterValues": { "target": "com.amazonaws.marketplacediscovery#PurchaseOptionFilterValueList", "traits": { "smithy.api#documentation": "

The values to filter by. Supported values depend on filterType:

To retrieve private offers and offer sets visible to you, use VISIBILITY_SCOPE with PRIVATE. OR logic combines multiple values within the same filter.

", "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "

A filter used to narrow purchase option results by product, seller, type, visibility, or availability.

" } }, "com.amazonaws.marketplacediscovery#PurchaseOptionFilterList": { "type": "list", "member": { "target": "com.amazonaws.marketplacediscovery#PurchaseOptionFilter" }, "traits": { "smithy.api#length": { "min": 1, "max": 10 } } }, "com.amazonaws.marketplacediscovery#PurchaseOptionFilterType": { "type": "enum", "members": { "PRODUCT_ID": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "PRODUCT_ID" } }, "SELLER_OF_RECORD_PROFILE_ID": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "SELLER_OF_RECORD_PROFILE_ID" } }, "PURCHASE_OPTION_TYPE": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "PURCHASE_OPTION_TYPE" } }, "VISIBILITY_SCOPE": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "VISIBILITY_SCOPE" } }, "AVAILABILITY_STATUS": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "AVAILABILITY_STATUS" } } } }, "com.amazonaws.marketplacediscovery#PurchaseOptionFilterValue": { "type": "string", "traits": { "smithy.api#length": { "min": 1, "max": 255 }, "smithy.api#pattern": "^[\\w\\-]+$" } }, "com.amazonaws.marketplacediscovery#PurchaseOptionFilterValueList": { "type": "list", "member": { "target": "com.amazonaws.marketplacediscovery#PurchaseOptionFilterValue" }, "traits": { "smithy.api#length": { "min": 1, "max": 10 } } }, "com.amazonaws.marketplacediscovery#PurchaseOptionSummary": { "type": "structure", "members": { "purchaseOptionId": { "target": "com.amazonaws.marketplacediscovery#NonEmptyString", "traits": { "smithy.api#documentation": "

The unique identifier of the purchase option.

", "smithy.api#required": {} } }, "catalog": { "target": "com.amazonaws.marketplacediscovery#Catalog", "traits": { "smithy.api#documentation": "

The name of the catalog that the purchase option belongs to.

", "smithy.api#required": {} } }, "purchaseOptionType": { "target": "com.amazonaws.marketplacediscovery#PurchaseOptionType", "traits": { "smithy.api#documentation": "

The type of purchase option. Values are OFFER for a single-product offer or OFFERSET for a bundled offer set.

", "smithy.api#required": {} } }, "purchaseOptionName": { "target": "com.amazonaws.marketplacediscovery#NonEmptyString", "traits": { "smithy.api#documentation": "

The display name of the purchase option.

" } }, "availableFromTime": { "target": "smithy.api#Timestamp", "traits": { "smithy.api#documentation": "

The date and time when the purchase option became available to the buyer.

" } }, "expirationTime": { "target": "smithy.api#Timestamp", "traits": { "smithy.api#documentation": "

The date and time when the purchase option expires and is no longer available for procurement.

" } }, "sellerOfRecord": { "target": "com.amazonaws.marketplacediscovery#SellerInformation", "traits": { "smithy.api#documentation": "

The entity responsible for selling the product under this purchase option.

", "smithy.api#required": {} } }, "badges": { "target": "com.amazonaws.marketplacediscovery#PurchaseOptionBadgeList", "traits": { "smithy.api#documentation": "

Badges indicating special attributes of the purchase option, such as private pricing or future dated.

" } }, "associatedEntities": { "target": "com.amazonaws.marketplacediscovery#PurchaseOptionAssociatedEntityList", "traits": { "smithy.api#documentation": "

The products, offers, and offer sets associated with this purchase option.

", "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "

Summary information about a purchase option (offer or offer set) available to the buyer, including the seller, badges, and associated products.

" } }, "com.amazonaws.marketplacediscovery#PurchaseOptionSummaryList": { "type": "list", "member": { "target": "com.amazonaws.marketplacediscovery#PurchaseOptionSummary" }, "traits": { "smithy.api#length": { "max": 100 } } }, "com.amazonaws.marketplacediscovery#PurchaseOptionType": { "type": "enum", "members": { "OFFER": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "OFFER" } }, "OFFERSET": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "OFFERSET" } } } }, "com.amazonaws.marketplacediscovery#RateCardConstraintType": { "type": "enum", "members": { "ALLOWED": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "Allowed" } }, "DISALLOWED": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "Disallowed" } } } }, "com.amazonaws.marketplacediscovery#RateCardItem": { "type": "structure", "members": { "dimensionKey": { "target": "com.amazonaws.marketplacediscovery#BoundedString", "traits": { "smithy.api#documentation": "

The machine-readable key identifying the dimension being priced.

", "smithy.api#required": {} } }, "displayName": { "target": "com.amazonaws.marketplacediscovery#BoundedString", "traits": { "smithy.api#documentation": "

The human-readable name of the dimension.

", "smithy.api#required": {} } }, "description": { "target": "com.amazonaws.marketplacediscovery#BoundedString", "traits": { "smithy.api#documentation": "

A description of the dimension being priced.

" } }, "dimensionLabels": { "target": "com.amazonaws.marketplacediscovery#DimensionLabelList", "traits": { "smithy.api#documentation": "

Labels used to categorize this dimension, such as by region.

" } }, "unit": { "target": "com.amazonaws.marketplacediscovery#BoundedString", "traits": { "smithy.api#documentation": "

The unit of measurement for the dimension.

", "smithy.api#required": {} } }, "price": { "target": "com.amazonaws.marketplacediscovery#BoundedString", "traits": { "smithy.api#documentation": "

The price per unit for the dimension.

", "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "

A per-unit rate within a rate card, defining the price for a specific dimension.

" } }, "com.amazonaws.marketplacediscovery#RateCardList": { "type": "list", "member": { "target": "com.amazonaws.marketplacediscovery#RateCardItem" } }, "com.amazonaws.marketplacediscovery#RecurringPaymentTerm": { "type": "structure", "members": { "id": { "target": "com.amazonaws.marketplacediscovery#TermId", "traits": { "smithy.api#documentation": "

The unique identifier of the term.

", "smithy.api#required": {} } }, "type": { "target": "com.amazonaws.marketplacediscovery#TermType", "traits": { "smithy.api#documentation": "

The category of the term.

", "smithy.api#required": {} } }, "currencyCode": { "target": "com.amazonaws.marketplacediscovery#CurrencyCode", "traits": { "smithy.api#documentation": "

Defines the currency for the prices in this term.

", "smithy.api#required": {} } }, "billingPeriod": { "target": "com.amazonaws.marketplacediscovery#BillingPeriodType", "traits": { "smithy.api#documentation": "

The billing period frequency, such as Monthly.

", "smithy.api#required": {} } }, "price": { "target": "com.amazonaws.marketplacediscovery#BoundedString", "traits": { "smithy.api#documentation": "

The amount charged each billing period.

", "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "

Defines a recurring payment term with fixed charges at regular billing intervals.

" } }, "com.amazonaws.marketplacediscovery#RenewalTerm": { "type": "structure", "members": { "id": { "target": "com.amazonaws.marketplacediscovery#TermId", "traits": { "smithy.api#documentation": "

The unique identifier of the term.

", "smithy.api#required": {} } }, "type": { "target": "com.amazonaws.marketplacediscovery#TermType", "traits": { "smithy.api#documentation": "

The category of the term.

", "smithy.api#required": {} } }, "maxRenewals": { "target": "smithy.api#Integer", "traits": { "smithy.api#documentation": "

The maximum number of renewals allowed on this offer. Absent means unlimited renewals.

", "smithy.api#range": { "min": 1 } } }, "lockoutPeriod": { "target": "com.amazonaws.marketplacediscovery#BoundedString", "traits": { "smithy.api#documentation": "

The duration before the agreement end date when the lockout window begins, in ISO 8601 format (for example, P30D). Absent means no lockout.

" } }, "adjustmentDeadline": { "target": "com.amazonaws.marketplacediscovery#BoundedString", "traits": { "smithy.api#documentation": "

The duration before the agreement end date by which the renewal price is finalized, represented in ISO 8601 format (for example, P30D). Only applicable with PercentageRange.

" } }, "priceIncrease": { "target": "com.amazonaws.marketplacediscovery#PriceIncrease", "traits": { "smithy.api#documentation": "

The price increase applied at each renewal cycle. Absent means identical pricing on renewal.

" } }, "termTemplates": { "target": "com.amazonaws.marketplacediscovery#TermTemplateList", "traits": { "smithy.api#documentation": "

Structural templates defining how specific terms are reshaped on each renewal cycle. Absent for upfront-only offers.

" } } }, "traits": { "smithy.api#documentation": "

Defines a renewal term that enables automatic agreement renewal.

" } }, "com.amazonaws.marketplacediscovery#Resource": { "type": "structure", "members": { "resourceType": { "target": "com.amazonaws.marketplacediscovery#ResourceType", "traits": { "smithy.api#documentation": "

The category of the resource, such as manufacturer support or usage instructions.

", "smithy.api#required": {} } }, "contentType": { "target": "com.amazonaws.marketplacediscovery#ResourceContentType", "traits": { "smithy.api#documentation": "

The format of the resource content, such as a URL, email address, or text.

", "smithy.api#required": {} } }, "value": { "target": "com.amazonaws.marketplacediscovery#NonEmptyString", "traits": { "smithy.api#documentation": "

The resource content. Interpretation depends on the content type.

", "smithy.api#required": {} } }, "displayName": { "target": "com.amazonaws.marketplacediscovery#NullableString", "traits": { "smithy.api#documentation": "

An optional human-readable label for the resource.

" } } }, "traits": { "smithy.api#documentation": "

A resource that provides supplementary information about a product, such as documentation links, support contacts, or usage instructions.

" } }, "com.amazonaws.marketplacediscovery#ResourceContentType": { "type": "enum", "members": { "EMAIL": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "EMAIL" } }, "PHONE_NUMBER": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "PHONE_NUMBER" } }, "LINK": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "LINK" } }, "OTHER": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "OTHER" } } } }, "com.amazonaws.marketplacediscovery#ResourceList": { "type": "list", "member": { "target": "com.amazonaws.marketplacediscovery#Resource" }, "traits": { "smithy.api#length": { "max": 100 } } }, "com.amazonaws.marketplacediscovery#ResourceNotFoundException": { "type": "structure", "members": { "message": { "target": "com.amazonaws.marketplacediscovery#ExceptionMessage" } }, "traits": { "smithy.api#documentation": "

The specified resource doesn't exist.

", "smithy.api#error": "client", "smithy.api#httpError": 404 } }, "com.amazonaws.marketplacediscovery#ResourceType": { "type": "enum", "members": { "MANUFACTURER_SUPPORT": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "MANUFACTURER_SUPPORT" } }, "MANUFACTURER_INSTRUCTIONS": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "MANUFACTURER_INSTRUCTIONS" } } } }, "com.amazonaws.marketplacediscovery#ReviewSourceId": { "type": "enum", "members": { "AWS_MARKETPLACE": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "AWS_MARKETPLACE" } }, "G2": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "G2" } }, "PEERSPOT": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "PEERSPOT" } } } }, "com.amazonaws.marketplacediscovery#ReviewSourceSummary": { "type": "structure", "members": { "sourceName": { "target": "com.amazonaws.marketplacediscovery#NonEmptyString", "traits": { "smithy.api#documentation": "

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

", "smithy.api#required": {} } }, "sourceId": { "target": "com.amazonaws.marketplacediscovery#ReviewSourceId", "traits": { "smithy.api#documentation": "

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

", "smithy.api#required": {} } }, "sourceUrl": { "target": "com.amazonaws.marketplacediscovery#URL", "traits": { "smithy.api#documentation": "

The URL where the reviews can be accessed at the source.

" } }, "averageRating": { "target": "com.amazonaws.marketplacediscovery#NonEmptyString", "traits": { "smithy.api#documentation": "

The average rating across all reviews from this source.

", "smithy.api#required": {} } }, "totalReviews": { "target": "com.amazonaws.marketplacediscovery#NonNegativeCount", "traits": { "smithy.api#documentation": "

The total number of reviews available from this source.

", "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "

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

" } }, "com.amazonaws.marketplacediscovery#ReviewSourceSummaryList": { "type": "list", "member": { "target": "com.amazonaws.marketplacediscovery#ReviewSourceSummary" }, "traits": { "smithy.api#length": { "max": 10 } } }, "com.amazonaws.marketplacediscovery#ReviewSummary": { "type": "structure", "members": { "reviewSourceSummaries": { "target": "com.amazonaws.marketplacediscovery#ReviewSourceSummaryList", "traits": { "smithy.api#documentation": "

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

", "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "

A summary of customer reviews available for a listing, aggregated by review source.

" } }, "com.amazonaws.marketplacediscovery#SaasFulfillmentOption": { "type": "structure", "members": { "fulfillmentOptionId": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "

The unique identifier of the fulfillment option.

", "smithy.api#required": {} } }, "fulfillmentOptionType": { "target": "com.amazonaws.marketplacediscovery#FulfillmentOptionType", "traits": { "smithy.api#documentation": "

The category of the fulfillment option.

", "smithy.api#required": {} } }, "fulfillmentOptionDisplayName": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "

A human-readable name for the fulfillment option type.

", "smithy.api#required": {} } }, "fulfillmentUrl": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "

The URL of the seller's software registration landing page.

" } }, "usageInstructions": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "

Instructions on how to access and use this SaaS product.

" } }, "availableFromTime": { "target": "smithy.api#Timestamp", "traits": { "smithy.api#documentation": "

The date and time when the SaaS product became available for fulfillment.

" } }, "launchUrl": { "target": "com.amazonaws.marketplacediscovery#URL", "traits": { "smithy.api#documentation": "

The URL that a buyer uses to launch the seller's SaaS product. This URL is distinct from fulfillmentUrl, which is the seller's software registration landing page.

" } }, "quickLaunch": { "target": "com.amazonaws.marketplacediscovery#SaasQuickLaunchStatus", "traits": { "smithy.api#documentation": "

Specifies whether the SaaS product supports quick-launch deployment.

", "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "

Describes a Software as a Service (SaaS) fulfillment option.

" } }, "com.amazonaws.marketplacediscovery#SaasQuickLaunchStatus": { "type": "enum", "members": { "ENABLED": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "ENABLED" } }, "DISABLED": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "DISABLED" } } } }, "com.amazonaws.marketplacediscovery#SageMakerAlgorithmFulfillmentOption": { "type": "structure", "members": { "fulfillmentOptionId": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "

The unique identifier of the fulfillment option.

", "smithy.api#required": {} } }, "fulfillmentOptionType": { "target": "com.amazonaws.marketplacediscovery#FulfillmentOptionType", "traits": { "smithy.api#documentation": "

The category of the fulfillment option.

", "smithy.api#required": {} } }, "fulfillmentOptionDisplayName": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "

A human-readable name for the fulfillment option type.

", "smithy.api#required": {} } }, "fulfillmentOptionVersion": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "

The version identifier of the fulfillment option.

" } }, "releaseNotes": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "

Release notes describing changes in this version of the fulfillment option.

" } }, "usageInstructions": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "

Instructions on how to use this SageMaker algorithm.

" } }, "recommendation": { "target": "com.amazonaws.marketplacediscovery#SageMakerAlgorithmRecommendation", "traits": { "smithy.api#documentation": "

Recommended instance types for training and inference with this algorithm.

" } } }, "traits": { "smithy.api#documentation": "

Describes an Amazon SageMaker algorithm fulfillment option, including version details and recommended instance types.

" } }, "com.amazonaws.marketplacediscovery#SageMakerAlgorithmRecommendation": { "type": "structure", "members": { "recommendedBatchTransformInstanceType": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "

The recommended instance type for batch inference.

", "smithy.api#required": {} } }, "recommendedRealtimeInferenceInstanceType": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "

The recommended instance type for real-time inference.

" } }, "recommendedTrainingInstanceType": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "

The recommended instance type for training.

", "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "

Recommended instance types for training and inference with a SageMaker algorithm.

" } }, "com.amazonaws.marketplacediscovery#SageMakerModelContentTypeList": { "type": "list", "member": { "target": "smithy.api#String", "traits": { "smithy.api#length": { "max": 256 } } }, "traits": { "smithy.api#length": { "max": 50 } } }, "com.amazonaws.marketplacediscovery#SageMakerModelFulfillmentOption": { "type": "structure", "members": { "fulfillmentOptionId": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "

The unique identifier of the fulfillment option.

", "smithy.api#required": {} } }, "fulfillmentOptionType": { "target": "com.amazonaws.marketplacediscovery#FulfillmentOptionType", "traits": { "smithy.api#documentation": "

The category of the fulfillment option.

", "smithy.api#required": {} } }, "fulfillmentOptionDisplayName": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "

A human-readable name for the fulfillment option type.

", "smithy.api#required": {} } }, "fulfillmentOptionVersion": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "

The version identifier of the fulfillment option.

" } }, "releaseNotes": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "

Release notes describing changes in this version of the fulfillment option.

" } }, "usageInstructions": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "

Instructions on how to use this SageMaker model.

" } }, "recommendation": { "target": "com.amazonaws.marketplacediscovery#SageMakerModelRecommendation", "traits": { "smithy.api#documentation": "

Recommended instance types for inference with this model.

" } }, "supportedContentTypes": { "target": "com.amazonaws.marketplacediscovery#SageMakerModelContentTypeList", "traits": { "smithy.api#documentation": "

The MIME types that this model accepts as input.

" } }, "supportedResponseMimeTypes": { "target": "com.amazonaws.marketplacediscovery#SageMakerModelResponseMimeTypeList", "traits": { "smithy.api#documentation": "

The MIME types that this model returns as output.

" } } }, "traits": { "smithy.api#documentation": "

Describes an Amazon SageMaker model fulfillment option, including version details and recommended instance types.

" } }, "com.amazonaws.marketplacediscovery#SageMakerModelRecommendation": { "type": "structure", "members": { "recommendedBatchTransformInstanceType": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "

The recommended instance type for batch inference.

", "smithy.api#required": {} } }, "recommendedRealtimeInferenceInstanceType": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "

The recommended instance type for real-time inference.

" } } }, "traits": { "smithy.api#documentation": "

Recommended instance types for inference with a SageMaker model.

" } }, "com.amazonaws.marketplacediscovery#SageMakerModelResponseMimeTypeList": { "type": "list", "member": { "target": "smithy.api#String", "traits": { "smithy.api#length": { "max": 256 } } }, "traits": { "smithy.api#length": { "max": 50 } } }, "com.amazonaws.marketplacediscovery#ScheduleItem": { "type": "structure", "members": { "chargeDate": { "target": "smithy.api#Timestamp", "traits": { "smithy.api#documentation": "

The date when the payment is due.

", "smithy.api#required": {} } }, "chargeAmount": { "target": "com.amazonaws.marketplacediscovery#BoundedString", "traits": { "smithy.api#documentation": "

The amount to be charged on the charge date.

", "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "

A payment installment within a payment schedule term.

" } }, "com.amazonaws.marketplacediscovery#ScheduleList": { "type": "list", "member": { "target": "com.amazonaws.marketplacediscovery#ScheduleItem" } }, "com.amazonaws.marketplacediscovery#SearchFacetType": { "type": "enum", "members": { "AVERAGE_CUSTOMER_RATING": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "AVERAGE_CUSTOMER_RATING" } }, "CATEGORY": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "CATEGORY" } }, "PUBLISHER": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "PUBLISHER" } }, "FULFILLMENT_OPTION_TYPE": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "FULFILLMENT_OPTION_TYPE" } }, "PRICING_MODEL": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "PRICING_MODEL" } }, "PRICING_UNIT": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "PRICING_UNIT" } }, "DEPLOYED_ON_AWS": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "DEPLOYED_ON_AWS" } }, "NUMBER_OF_PRODUCTS": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "NUMBER_OF_PRODUCTS" } } } }, "com.amazonaws.marketplacediscovery#SearchFacets": { "type": "operation", "input": { "target": "com.amazonaws.marketplacediscovery#SearchFacetsInput" }, "output": { "target": "com.amazonaws.marketplacediscovery#SearchFacetsOutput" }, "traits": { "smithy.api#documentation": "

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

", "smithy.api#examples": [ { "title": "Get facets for machine learning category", "documentation": "Retrieve available facet values for listings in the machine learning category", "input": { "locale": "en-US", "searchText": "analytics", "filters": [ { "filterType": "CATEGORY", "filterValues": [ "machine-learning" ] } ], "facetTypes": [ "FULFILLMENT_OPTION_TYPE", "PRICING_MODEL" ] }, "output": { "totalResults": 450, "listingFacets": { "FULFILLMENT_OPTION_TYPE": [ { "value": "SAAS", "displayName": "SaaS", "count": 250 }, { "value": "CONTAINER", "displayName": "Container", "count": 120 }, { "value": "SAGEMAKER_ALGORITHM", "displayName": "SageMaker Algorithm", "count": 80 } ], "PRICING_MODEL": [ { "value": "USAGE", "displayName": "Usage-Based", "count": 300 }, { "value": "FREE", "displayName": "Free", "count": 100 }, { "value": "CONTRACT", "displayName": "Upfront Commitment", "count": 50 } ] } } }, { "title": "Get facets with term and rating range filters", "documentation": "Retrieve facets for security listings with ratings between 3.0 and 5.0 stars", "input": { "locale": "en-US", "filters": [ { "filterType": "CATEGORY", "filterValues": [ "security" ] }, { "filterType": "MIN_AVERAGE_CUSTOMER_RATING", "filterValues": [ "3.0" ] }, { "filterType": "MAX_AVERAGE_CUSTOMER_RATING", "filterValues": [ "5.0" ] } ], "facetTypes": [ "PRICING_MODEL", "AVERAGE_CUSTOMER_RATING" ] }, "output": { "totalResults": 85, "listingFacets": { "PRICING_MODEL": [ { "value": "USAGE", "displayName": "Usage-Based", "count": 50 }, { "value": "FREE", "displayName": "Free", "count": 35 } ], "AVERAGE_CUSTOMER_RATING": [ { "value": "5.0", "displayName": "5.0", "count": 30 }, { "value": "4.0", "displayName": "4.0", "count": 35 }, { "value": "3.0", "displayName": "3.0", "count": 20 } ] } } } ], "smithy.api#http": { "code": 200, "method": "POST", "uri": "/2026-02-05/searchFacets" }, "smithy.api#paginated": { "inputToken": "nextToken", "outputToken": "nextToken", "items": "listingFacets" }, "smithy.api#readonly": {}, "smithy.test#smokeTests": [ { "id": "SearchFacetsSuccess", "params": {}, "expect": { "success": {} }, "vendorParamsShape": "aws.test#AwsVendorParams", "vendorParams": { "region": "us-east-1" } } ] } }, "com.amazonaws.marketplacediscovery#SearchFacetsInput": { "type": "structure", "members": { "locale": { "target": "com.amazonaws.marketplacediscovery#Locale", "traits": { "smithy.api#documentation": "

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.

" } }, "searchText": { "target": "com.amazonaws.marketplacediscovery#SearchText", "traits": { "smithy.api#documentation": "

The search query text to filter listings before retrieving facets.

" } }, "filters": { "target": "com.amazonaws.marketplacediscovery#SearchFilterList", "traits": { "smithy.api#documentation": "

Filters to apply before retrieving facets. Multiple filters are combined with AND logic. Multiple values within the same filter are combined with OR logic.

" } }, "facetTypes": { "target": "com.amazonaws.marketplacediscovery#FacetTypeList", "traits": { "smithy.api#documentation": "

A list of specific facet types to retrieve. If empty or null, all available facets are returned.

" } }, "nextToken": { "target": "com.amazonaws.marketplacediscovery#NextToken", "traits": { "smithy.api#documentation": "

If nextToken is returned, there are more results available. Make the call again using the returned token to retrieve the next page.

" } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.marketplacediscovery#SearchFacetsOutput": { "type": "structure", "members": { "totalResults": { "target": "com.amazonaws.marketplacediscovery#NonNegativeCount", "traits": { "smithy.api#documentation": "

The total number of listings matching the search criteria.

", "smithy.api#required": {} } }, "listingFacets": { "target": "com.amazonaws.marketplacediscovery#TypeToFacetMap", "traits": { "smithy.api#documentation": "

A map of facet types to their corresponding facet values. Each facet value includes a display name, internal value, and count of matching listings.

", "smithy.api#required": {} } }, "nextToken": { "target": "com.amazonaws.marketplacediscovery#NextToken", "traits": { "smithy.api#documentation": "

If nextToken is returned, there are more results available. Make the call again using the returned token to retrieve the next page.

" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.marketplacediscovery#SearchFilter": { "type": "structure", "members": { "filterType": { "target": "com.amazonaws.marketplacediscovery#SearchFilterType", "traits": { "smithy.api#documentation": "

The type of filter to apply.

", "smithy.api#required": {} } }, "filterValues": { "target": "com.amazonaws.marketplacediscovery#SearchFilterValueList", "traits": { "smithy.api#documentation": "

The values to filter by. Term filters accept multiple values (OR logic). Range filters (MIN/MAX_AVERAGE_CUSTOMER_RATING) accept a single value between 0.0 and 5.0.

", "smithy.api#length": { "min": 1, "max": 30 }, "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "

A filter used to narrow search results by attribute, such as category, pricing model, or fulfillment type.

" } }, "com.amazonaws.marketplacediscovery#SearchFilterList": { "type": "list", "member": { "target": "com.amazonaws.marketplacediscovery#SearchFilter" }, "traits": { "smithy.api#length": { "min": 1, "max": 30 } } }, "com.amazonaws.marketplacediscovery#SearchFilterType": { "type": "enum", "members": { "MIN_AVERAGE_CUSTOMER_RATING": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "MIN_AVERAGE_CUSTOMER_RATING" } }, "MAX_AVERAGE_CUSTOMER_RATING": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "MAX_AVERAGE_CUSTOMER_RATING" } }, "CATEGORY": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "CATEGORY" } }, "PUBLISHER": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "PUBLISHER" } }, "FULFILLMENT_OPTION_TYPE": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "FULFILLMENT_OPTION_TYPE" } }, "PRICING_MODEL": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "PRICING_MODEL" } }, "PRICING_UNIT": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "PRICING_UNIT" } }, "DEPLOYED_ON_AWS": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "DEPLOYED_ON_AWS" } }, "NUMBER_OF_PRODUCTS": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "NUMBER_OF_PRODUCTS" } } } }, "com.amazonaws.marketplacediscovery#SearchFilterValue": { "type": "string", "traits": { "smithy.api#length": { "min": 1, "max": 128 }, "smithy.api#pattern": "^[\\w\\-\\.]+$" } }, "com.amazonaws.marketplacediscovery#SearchFilterValueList": { "type": "list", "member": { "target": "com.amazonaws.marketplacediscovery#SearchFilterValue" }, "traits": { "smithy.api#length": { "min": 1, "max": 30 } } }, "com.amazonaws.marketplacediscovery#SearchListings": { "type": "operation", "input": { "target": "com.amazonaws.marketplacediscovery#SearchListingsInput" }, "output": { "target": "com.amazonaws.marketplacediscovery#SearchListingsOutput" }, "traits": { "smithy.api#documentation": "

Returns a list of product listings based on 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.

", "smithy.api#examples": [ { "title": "Search for machine learning listings", "documentation": "Search for SaaS listings in the machine learning category with sorting by relevance", "input": { "locale": "en-US", "searchText": "computer vision", "filters": [ { "filterType": "CATEGORY", "filterValues": [ "machine-learning" ] }, { "filterType": "FULFILLMENT_OPTION_TYPE", "filterValues": [ "SAAS" ] } ], "maxResults": 25, "sortBy": "RELEVANCE", "sortOrder": "DESCENDING" }, "output": { "totalResults": 1250, "listingSummaries": [ { "listingId": "prodview-sampleSearchId", "catalog": "AWSMarketplace", "listingName": "sample search listing", "shortDescription": "Advanced computer vision solution for object detection and classification.", "logoThumbnailUrl": "https://awsmp-logos.s3.amazonaws.com/product-logos/ai-vision-pro.png", "categories": [ { "categoryId": "machine-learning", "displayName": "Machine Learning" } ], "fulfillmentOptionSummaries": [ { "fulfillmentOptionType": "SAAS", "displayName": "SaaS" } ], "badges": [ { "badgeType": "FREE_TRIAL", "displayName": "Free Trial" } ], "reviewSummary": { "reviewSourceSummaries": [ { "sourceName": "AWS Marketplace", "sourceId": "AWS_MARKETPLACE", "averageRating": "4.5", "totalReviews": 100 }, { "sourceName": "G2", "sourceId": "G2", "averageRating": "4.6", "totalReviews": 1368 }, { "sourceName": "PeerSpot", "sourceId": "PEERSPOT", "averageRating": "4.2", "totalReviews": 19 } ] }, "publisher": { "sellerProfileId": "seller-sampleSearchId", "displayName": "sample search seller" }, "pricingModels": [ { "pricingModelType": "USAGE", "displayName": "Usage" } ], "pricingUnits": [ { "pricingUnitType": "REQUESTS", "displayName": "Requests" } ], "associatedEntities": [ { "product": { "productId": "prod-sampleSearchId", "productName": "sample search product", "manufacturer": { "sellerProfileId": "seller-sampleSearchId", "displayName": "sample search seller" } } } ] } ], "nextToken": "eyJsYXN0RXZhbHVhdGVkS2V5Ijp7Imxpc3RpbmdJZCI6InByb2R2aWV3LXNhbXBsZVNlYXJjaElkIn19" } } ], "smithy.api#http": { "code": 200, "method": "POST", "uri": "/2026-02-05/searchListings" }, "smithy.api#paginated": { "inputToken": "nextToken", "outputToken": "nextToken", "pageSize": "maxResults", "items": "listingSummaries" }, "smithy.api#readonly": {}, "smithy.test#smokeTests": [ { "id": "SearchListingsSuccess", "params": {}, "expect": { "success": {} }, "vendorParamsShape": "aws.test#AwsVendorParams", "vendorParams": { "region": "us-east-1" } } ] } }, "com.amazonaws.marketplacediscovery#SearchListingsInput": { "type": "structure", "members": { "locale": { "target": "com.amazonaws.marketplacediscovery#Locale", "traits": { "smithy.api#documentation": "

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.

" } }, "searchText": { "target": "com.amazonaws.marketplacediscovery#SearchText", "traits": { "smithy.api#documentation": "

The search query text to find relevant listings.

" } }, "filters": { "target": "com.amazonaws.marketplacediscovery#SearchFilterList", "traits": { "smithy.api#documentation": "

Filters to narrow search results. Multiple filters are combined with AND logic. Multiple values within the same filter are combined with OR logic.

" } }, "maxResults": { "target": "com.amazonaws.marketplacediscovery#MaxResults", "traits": { "smithy.api#default": 25, "smithy.api#documentation": "

The maximum number of results that are returned per call. You can use nextToken to get more results.

" } }, "sortBy": { "target": "com.amazonaws.marketplacediscovery#SearchListingsSortBy", "traits": { "smithy.api#default": "RELEVANCE", "smithy.api#documentation": "

The field to sort results by. Valid values are RELEVANCE and AVERAGE_CUSTOMER_RATING.

" } }, "sortOrder": { "target": "com.amazonaws.marketplacediscovery#SearchListingsSortOrder", "traits": { "smithy.api#default": "DESCENDING", "smithy.api#documentation": "

The sort direction. Valid values are DESCENDING and ASCENDING.

" } }, "nextToken": { "target": "com.amazonaws.marketplacediscovery#NextToken", "traits": { "smithy.api#documentation": "

If nextToken is returned, there are more results available. Make the call again using the returned token to retrieve the next page.

" } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.marketplacediscovery#SearchListingsOutput": { "type": "structure", "members": { "totalResults": { "target": "com.amazonaws.marketplacediscovery#NonNegativeCount", "traits": { "smithy.api#documentation": "

The total number of listings matching the search criteria.

", "smithy.api#required": {} } }, "listingSummaries": { "target": "com.amazonaws.marketplacediscovery#ListingSummaryList", "traits": { "smithy.api#documentation": "

The listing summaries matching the search criteria. Each summary includes the listing name, description, badges, categories, pricing models, reviews, and associated products.

", "smithy.api#required": {} } }, "nextToken": { "target": "com.amazonaws.marketplacediscovery#NextToken", "traits": { "smithy.api#documentation": "

If nextToken is returned, there are more results available. Make the call again using the returned token to retrieve the next page.

" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.marketplacediscovery#SearchListingsSortBy": { "type": "enum", "members": { "RELEVANCE": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "RELEVANCE" } }, "AVERAGE_CUSTOMER_RATING": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "AVERAGE_CUSTOMER_RATING" } } } }, "com.amazonaws.marketplacediscovery#SearchListingsSortOrder": { "type": "enum", "members": { "DESCENDING": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "DESCENDING" } }, "ASCENDING": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "ASCENDING" } } } }, "com.amazonaws.marketplacediscovery#SearchText": { "type": "string", "traits": { "smithy.api#length": { "min": 1, "max": 512 }, "smithy.api#pattern": "[^\n]*" } }, "com.amazonaws.marketplacediscovery#Selector": { "type": "structure", "members": { "type": { "target": "com.amazonaws.marketplacediscovery#SelectorType", "traits": { "smithy.api#documentation": "

The category of the selector, such as Duration.

", "smithy.api#required": {} } }, "value": { "target": "com.amazonaws.marketplacediscovery#BoundedString", "traits": { "smithy.api#documentation": "

The value of the selector.

", "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "

A selector used to choose a specific configuration within a configurable upfront rate card.

" } }, "com.amazonaws.marketplacediscovery#SelectorType": { "type": "enum", "members": { "DURATION": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "Duration" } } } }, "com.amazonaws.marketplacediscovery#SellerEngagement": { "type": "structure", "members": { "engagementType": { "target": "com.amazonaws.marketplacediscovery#SellerEngagementType", "traits": { "smithy.api#documentation": "

The type of engagement, such as REQUEST_FOR_PRIVATE_OFFER or REQUEST_FOR_DEMO.

", "smithy.api#required": {} } }, "contentType": { "target": "com.amazonaws.marketplacediscovery#SellerEngagementContentType", "traits": { "smithy.api#documentation": "

The format of the engagement value, such as a URL.

", "smithy.api#required": {} } }, "value": { "target": "com.amazonaws.marketplacediscovery#NonEmptyString", "traits": { "smithy.api#documentation": "

The engagement value, such as a URL to the engagement form.

", "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "

An engagement option available to potential buyers of a product, such as requesting a private offer or a demo.

" } }, "com.amazonaws.marketplacediscovery#SellerEngagementContentType": { "type": "enum", "members": { "LINK": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "LINK" } } } }, "com.amazonaws.marketplacediscovery#SellerEngagementList": { "type": "list", "member": { "target": "com.amazonaws.marketplacediscovery#SellerEngagement" }, "traits": { "smithy.api#length": { "max": 100 } } }, "com.amazonaws.marketplacediscovery#SellerEngagementType": { "type": "enum", "members": { "REQUEST_FOR_PRIVATE_OFFER": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "REQUEST_FOR_PRIVATE_OFFER" } }, "REQUEST_FOR_DEMO": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "REQUEST_FOR_DEMO" } } } }, "com.amazonaws.marketplacediscovery#SellerInformation": { "type": "structure", "members": { "sellerProfileId": { "target": "com.amazonaws.marketplacediscovery#SellerProfileId", "traits": { "smithy.api#documentation": "

The unique identifier of the seller profile.

", "smithy.api#required": {} } }, "displayName": { "target": "com.amazonaws.marketplacediscovery#NonEmptyString", "traits": { "smithy.api#documentation": "

The human-readable name of the seller.

", "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "

Information about a seller, including the profile identifier and display name.

" } }, "com.amazonaws.marketplacediscovery#SellerProfileId": { "type": "string", "traits": { "smithy.api#length": { "min": 1, "max": 255 }, "smithy.api#pattern": "^[\\w\\-]+$" } }, "com.amazonaws.marketplacediscovery#SupportTerm": { "type": "structure", "members": { "id": { "target": "com.amazonaws.marketplacediscovery#TermId", "traits": { "smithy.api#documentation": "

The unique identifier of the term.

", "smithy.api#required": {} } }, "type": { "target": "com.amazonaws.marketplacediscovery#TermType", "traits": { "smithy.api#documentation": "

The category of the term.

", "smithy.api#required": {} } }, "refundPolicy": { "target": "com.amazonaws.marketplacediscovery#BoundedString", "traits": { "smithy.api#documentation": "

The refund policy description for the offer.

", "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "

Defines a support term that includes the refund policy for the offer.

" } }, "com.amazonaws.marketplacediscovery#TermId": { "type": "string", "traits": { "smithy.api#length": { "min": 1, "max": 256 }, "smithy.api#pattern": "^[A-Za-z0-9+=;,.@\\-_]+$" } }, "com.amazonaws.marketplacediscovery#TermTemplate": { "type": "union", "members": { "paymentScheduleTermTemplate": { "target": "com.amazonaws.marketplacediscovery#PaymentScheduleTermTemplate", "traits": { "smithy.api#documentation": "

The installment schedule used to structure payments on the renewal offer.

" } } }, "traits": { "smithy.api#documentation": "

A structural template defining how a specific term type is reshaped on each renewal cycle. Exactly one variant is present.

" } }, "com.amazonaws.marketplacediscovery#TermTemplateList": { "type": "list", "member": { "target": "com.amazonaws.marketplacediscovery#TermTemplate" }, "traits": { "smithy.api#length": { "max": 10 } } }, "com.amazonaws.marketplacediscovery#TermType": { "type": "enum", "members": { "BYOL_PRICING_TERM": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "ByolPricingTerm" } }, "CONFIGURABLE_UPFRONT_PRICING_TERM": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "ConfigurableUpfrontPricingTerm" } }, "FIXED_UPFRONT_PRICING_TERM": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "FixedUpfrontPricingTerm" } }, "USAGE_BASED_PRICING_TERM": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "UsageBasedPricingTerm" } }, "FREE_TRIAL_PRICING_TERM": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "FreeTrialPricingTerm" } }, "LEGAL_TERM": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "LegalTerm" } }, "PAYMENT_SCHEDULE_TERM": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "PaymentScheduleTerm" } }, "RECURRING_PAYMENT_TERM": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "RecurringPaymentTerm" } }, "RENEWAL_TERM": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "RenewalTerm" } }, "SUPPORT_TERM": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "SupportTerm" } }, "VALIDITY_TERM": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "ValidityTerm" } }, "VARIABLE_PAYMENT_TERM": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "VariablePaymentTerm" } }, "NET_PAYMENT_TERM": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "NetPaymentTerm" } } } }, "com.amazonaws.marketplacediscovery#ThrottlingException": { "type": "structure", "members": { "message": { "target": "com.amazonaws.marketplacediscovery#ExceptionMessage" } }, "traits": { "smithy.api#documentation": "

The request was denied due to request throttling.

", "smithy.api#error": "client", "smithy.api#httpError": 429 } }, "com.amazonaws.marketplacediscovery#TypeToFacetMap": { "type": "map", "key": { "target": "com.amazonaws.marketplacediscovery#SearchFacetType" }, "value": { "target": "com.amazonaws.marketplacediscovery#ListingFacetList" } }, "com.amazonaws.marketplacediscovery#URL": { "type": "string", "traits": { "smithy.api#length": { "min": 1, "max": 2048 }, "smithy.api#pattern": "^https?://.*$" } }, "com.amazonaws.marketplacediscovery#UsageBasedPricingTerm": { "type": "structure", "members": { "id": { "target": "com.amazonaws.marketplacediscovery#TermId", "traits": { "smithy.api#documentation": "

The unique identifier of the term.

", "smithy.api#required": {} } }, "type": { "target": "com.amazonaws.marketplacediscovery#TermType", "traits": { "smithy.api#documentation": "

The category of the term.

", "smithy.api#required": {} } }, "currencyCode": { "target": "com.amazonaws.marketplacediscovery#CurrencyCode", "traits": { "smithy.api#documentation": "

Defines the currency for the prices in this term.

", "smithy.api#required": {} } }, "rateCards": { "target": "com.amazonaws.marketplacediscovery#UsageBasedRateCardList", "traits": { "smithy.api#documentation": "

The rate cards containing per-unit rates for usage-based pricing.

", "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "

Defines a usage-based pricing term (typically pay-as-you-go), where buyers are charged based on product usage.

" } }, "com.amazonaws.marketplacediscovery#UsageBasedRateCardItem": { "type": "structure", "members": { "rateCard": { "target": "com.amazonaws.marketplacediscovery#RateCardList", "traits": { "smithy.api#documentation": "

The per-unit rates for this usage-based rate card.

", "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "

A rate card within a usage-based pricing term, containing per-unit rates.

" } }, "com.amazonaws.marketplacediscovery#UsageBasedRateCardList": { "type": "list", "member": { "target": "com.amazonaws.marketplacediscovery#UsageBasedRateCardItem" } }, "com.amazonaws.marketplacediscovery#UseCase": { "type": "structure", "members": { "description": { "target": "com.amazonaws.marketplacediscovery#NonEmptyString", "traits": { "smithy.api#documentation": "

A description of the use case.

", "smithy.api#required": {} } }, "displayName": { "target": "com.amazonaws.marketplacediscovery#NonEmptyString", "traits": { "smithy.api#documentation": "

The human-readable name of the use case.

", "smithy.api#required": {} } }, "value": { "target": "com.amazonaws.marketplacediscovery#NonEmptyString", "traits": { "smithy.api#documentation": "

The machine-readable identifier of the use case.

", "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "

A use case describing a scenario where the product can be applied.

" } }, "com.amazonaws.marketplacediscovery#UseCaseEntry": { "type": "structure", "members": { "useCase": { "target": "com.amazonaws.marketplacediscovery#UseCase", "traits": { "smithy.api#documentation": "

The use case details.

", "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "

An entry in the list of use cases for a listing.

" } }, "com.amazonaws.marketplacediscovery#UseCaseList": { "type": "list", "member": { "target": "com.amazonaws.marketplacediscovery#UseCaseEntry" }, "traits": { "smithy.api#length": { "max": 100 } } }, "com.amazonaws.marketplacediscovery#ValidationException": { "type": "structure", "members": { "message": { "target": "com.amazonaws.marketplacediscovery#ExceptionMessage" }, "reason": { "target": "com.amazonaws.marketplacediscovery#ValidationExceptionReason", "traits": { "smithy.api#documentation": "

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

" } } }, "traits": { "smithy.api#documentation": "

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

", "smithy.api#error": "client", "smithy.api#httpError": 400 } }, "com.amazonaws.marketplacediscovery#ValidationExceptionReason": { "type": "enum", "members": { "INVALID_PAGINATION_TOKEN": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "INVALID_PAGINATION_TOKEN" } }, "MALFORMED_REQUEST_PARAMETERS": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "MALFORMED_REQUEST_PARAMETERS" } }, "PAGINATION_LIMIT_EXCEEDED": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "PAGINATION_LIMIT_EXCEEDED" } } } }, "com.amazonaws.marketplacediscovery#ValidityTerm": { "type": "structure", "members": { "id": { "target": "com.amazonaws.marketplacediscovery#TermId", "traits": { "smithy.api#documentation": "

The unique identifier of the term.

", "smithy.api#required": {} } }, "type": { "target": "com.amazonaws.marketplacediscovery#TermType", "traits": { "smithy.api#documentation": "

The category of the term.

", "smithy.api#required": {} } }, "agreementDuration": { "target": "com.amazonaws.marketplacediscovery#BoundedString", "traits": { "smithy.api#documentation": "

The duration of the agreement, in ISO 8601 format.

" } }, "agreementEndDate": { "target": "smithy.api#Timestamp", "traits": { "smithy.api#documentation": "

The date when the agreement ends.

" } }, "agreementStartDate": { "target": "smithy.api#Timestamp", "traits": { "smithy.api#documentation": "

The date when the agreement starts.

" } } }, "traits": { "smithy.api#documentation": "

Defines a validity term that specifies the duration or date range of an agreement.

" } }, "com.amazonaws.marketplacediscovery#VariablePaymentTerm": { "type": "structure", "members": { "id": { "target": "com.amazonaws.marketplacediscovery#TermId", "traits": { "smithy.api#documentation": "

The unique identifier of the term.

", "smithy.api#required": {} } }, "type": { "target": "com.amazonaws.marketplacediscovery#TermType", "traits": { "smithy.api#documentation": "

The category of the term.

", "smithy.api#required": {} } }, "currencyCode": { "target": "com.amazonaws.marketplacediscovery#CurrencyCode", "traits": { "smithy.api#documentation": "

Defines the currency for the prices in this term.

", "smithy.api#required": {} } }, "maxTotalChargeAmount": { "target": "com.amazonaws.marketplacediscovery#BoundedString", "traits": { "smithy.api#documentation": "

The maximum total amount that can be charged under this term.

", "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "

Defines a variable payment term with a maximum total charge amount.

" } } } }