Provides details about a listing, such as descriptions, badges, categories, pricing model summaries, reviews, and associated products and offers.
", "readonly":true }, "GetOffer":{ "name":"GetOffer", "http":{ "method":"POST", "requestUri":"/2026-02-05/getOffer", "responseCode":200 }, "input":{"shape":"GetOfferInput"}, "output":{"shape":"GetOfferOutput"}, "errors":[ {"shape":"ThrottlingException"}, {"shape":"AccessDeniedException"}, {"shape":"ValidationException"}, {"shape":"ResourceNotFoundException"}, {"shape":"InternalServerException"} ], "documentation":"Provides details about an offer, such as the pricing model, seller of record, availability dates, badges, and associated products.
", "readonly":true }, "GetOfferSet":{ "name":"GetOfferSet", "http":{ "method":"POST", "requestUri":"/2026-02-05/getOfferSet", "responseCode":200 }, "input":{"shape":"GetOfferSetInput"}, "output":{"shape":"GetOfferSetOutput"}, "errors":[ {"shape":"ThrottlingException"}, {"shape":"AccessDeniedException"}, {"shape":"ValidationException"}, {"shape":"ResourceNotFoundException"}, {"shape":"InternalServerException"} ], "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.
", "readonly":true }, "GetOfferTerms":{ "name":"GetOfferTerms", "http":{ "method":"POST", "requestUri":"/2026-02-05/getOfferTerms", "responseCode":200 }, "input":{"shape":"GetOfferTermsInput"}, "output":{"shape":"GetOfferTermsOutput"}, "errors":[ {"shape":"ThrottlingException"}, {"shape":"AccessDeniedException"}, {"shape":"ValidationException"}, {"shape":"ResourceNotFoundException"}, {"shape":"InternalServerException"} ], "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.
", "readonly":true }, "GetProduct":{ "name":"GetProduct", "http":{ "method":"POST", "requestUri":"/2026-02-05/getProduct", "responseCode":200 }, "input":{"shape":"GetProductInput"}, "output":{"shape":"GetProductOutput"}, "errors":[ {"shape":"ThrottlingException"}, {"shape":"AccessDeniedException"}, {"shape":"ValidationException"}, {"shape":"ResourceNotFoundException"}, {"shape":"InternalServerException"} ], "documentation":"Provides details about a product, such as descriptions, highlights, categories, fulfillment option summaries, promotional media, and seller engagement options.
", "readonly":true }, "ListFulfillmentOptions":{ "name":"ListFulfillmentOptions", "http":{ "method":"POST", "requestUri":"/2026-02-05/listFulfillmentOptions", "responseCode":200 }, "input":{"shape":"ListFulfillmentOptionsInput"}, "output":{"shape":"ListFulfillmentOptionsOutput"}, "errors":[ {"shape":"ThrottlingException"}, {"shape":"AccessDeniedException"}, {"shape":"ValidationException"}, {"shape":"ResourceNotFoundException"}, {"shape":"InternalServerException"} ], "documentation":"Returns the fulfillment options available for a product, including deployment details such as version information, operating systems, usage instructions, and release notes.
", "readonly":true }, "ListPurchaseOptions":{ "name":"ListPurchaseOptions", "http":{ "method":"POST", "requestUri":"/2026-02-05/listPurchaseOptions", "responseCode":200 }, "input":{"shape":"ListPurchaseOptionsInput"}, "output":{"shape":"ListPurchaseOptionsOutput"}, "errors":[ {"shape":"ThrottlingException"}, {"shape":"AccessDeniedException"}, {"shape":"ValidationException"}, {"shape":"InternalServerException"} ], "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.
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.
", "readonly":true }, "SearchListings":{ "name":"SearchListings", "http":{ "method":"POST", "requestUri":"/2026-02-05/searchListings", "responseCode":200 }, "input":{"shape":"SearchListingsInput"}, "output":{"shape":"SearchListingsOutput"}, "errors":[ {"shape":"ThrottlingException"}, {"shape":"AccessDeniedException"}, {"shape":"ValidationException"}, {"shape":"InternalServerException"} ], "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.
", "readonly":true } }, "shapes":{ "AccessDeniedException":{ "type":"structure", "members":{ "message":{"shape":"ExceptionMessage"} }, "documentation":"You don't have sufficient access to perform this action.
", "error":{ "httpStatusCode":403, "senderFault":true }, "exception":true }, "AgreementResourceId":{ "type":"string", "max":64, "min":1, "pattern":"[A-Za-z0-9_/-]+" }, "AmazonMachineImageFulfillmentOption":{ "type":"structure", "required":[ "fulfillmentOptionId", "fulfillmentOptionName", "fulfillmentOptionType", "fulfillmentOptionDisplayName", "operatingSystems" ], "members":{ "fulfillmentOptionId":{ "shape":"String", "documentation":"The unique identifier of the fulfillment option.
" }, "fulfillmentOptionName":{ "shape":"String", "documentation":"The display name of the fulfillment option version.
" }, "fulfillmentOptionVersion":{ "shape":"String", "documentation":"The version identifier of the fulfillment option.
" }, "fulfillmentOptionType":{ "shape":"FulfillmentOptionType", "documentation":"The category of the fulfillment option.
" }, "fulfillmentOptionDisplayName":{ "shape":"String", "documentation":"A human-readable name for the fulfillment option type.
" }, "operatingSystems":{ "shape":"AmazonMachineImageOperatingSystemList", "documentation":"The operating systems supported by this AMI.
" }, "recommendation":{ "shape":"AmazonMachineImageRecommendation", "documentation":"Recommended instance types for running this AMI.
" }, "releaseNotes":{ "shape":"String", "documentation":"Release notes describing changes in this version of the fulfillment option.
" }, "usageInstructions":{ "shape":"String", "documentation":"Instructions on how to deploy and use this fulfillment option.
" } }, "documentation":"Describes an Amazon Machine Image (AMI) fulfillment option, including version details, supported operating systems, and recommended instance types.
" }, "AmazonMachineImageOperatingSystem":{ "type":"structure", "required":[ "operatingSystemFamilyName", "operatingSystemName" ], "members":{ "operatingSystemFamilyName":{ "shape":"String", "documentation":"The operating system family, such as Linux or Windows.
" }, "operatingSystemName":{ "shape":"String", "documentation":"The specific operating system name, such as Amazon Linux 2 or Windows Server 2022.
" }, "operatingSystemVersion":{ "shape":"String", "documentation":"The version of the operating system.
" } }, "documentation":"Describes an operating system supported by an AMI fulfillment option.
" }, "AmazonMachineImageOperatingSystemList":{ "type":"list", "member":{"shape":"AmazonMachineImageOperatingSystem"} }, "AmazonMachineImageRecommendation":{ "type":"structure", "required":["instanceType"], "members":{ "instanceType":{ "shape":"String", "documentation":"The recommended EC2 instance type for this AMI.
" } }, "documentation":"Recommended instance types for running an AMI fulfillment option.
" }, "ApiFulfillmentOption":{ "type":"structure", "required":[ "fulfillmentOptionId", "fulfillmentOptionType", "fulfillmentOptionDisplayName", "awsSupportedServices" ], "members":{ "fulfillmentOptionId":{ "shape":"String", "documentation":"The unique identifier of the fulfillment option.
" }, "fulfillmentOptionType":{ "shape":"FulfillmentOptionType", "documentation":"The category of the fulfillment option.
" }, "fulfillmentOptionDisplayName":{ "shape":"String", "documentation":"A human-readable name for the fulfillment option type.
" }, "usageInstructions":{ "shape":"String", "documentation":"Instructions on how to integrate with and use this API.
" }, "awsSupportedServices":{ "shape":"AwsSupportedServiceList", "documentation":"The AWS services supported by this API integration.
" } }, "documentation":"Describes an API-based fulfillment option, where the product is accessed through an API integration.
" }, "AwsSupportedService":{ "type":"structure", "required":[ "supportedServiceType", "displayName", "description" ], "members":{ "supportedServiceType":{ "shape":"String", "documentation":"The machine-readable identifier of the supported service.
" }, "displayName":{ "shape":"String", "documentation":"The human-readable name of the supported service.
" }, "description":{ "shape":"String", "documentation":"A description of the supported service.
" } }, "documentation":"Describes an AWS service supported by a fulfillment option.
" }, "AwsSupportedServiceList":{ "type":"list", "member":{"shape":"AwsSupportedService"} }, "BillingPeriodType":{ "type":"string", "enum":["Monthly"] }, "BoundedString":{ "type":"string", "max":4096, "min":1, "pattern":"(.)+" }, "ByolPricingTerm":{ "type":"structure", "required":[ "id", "type" ], "members":{ "id":{ "shape":"TermId", "documentation":"The unique identifier of the term.
" }, "type":{ "shape":"TermType", "documentation":"The category of the term.
" } }, "documentation":"Defines a Bring Your Own License (BYOL) pricing term, where buyers use their existing license for the product.
" }, "Catalog":{ "type":"string", "max":255, "min":1, "pattern":"[\\w\\-]+" }, "Category":{ "type":"structure", "required":[ "categoryId", "displayName" ], "members":{ "categoryId":{ "shape":"NonEmptyString", "documentation":"The machine-readable identifier of the category.
" }, "displayName":{ "shape":"NonEmptyString", "documentation":"The human-readable name of the category.
" } }, "documentation":"A category used to classify a listing or product into a logical group.
" }, "CategoryList":{ "type":"list", "member":{"shape":"Category"}, "max":30, "min":0 }, "CloudFormationFulfillmentOption":{ "type":"structure", "required":[ "fulfillmentOptionId", "fulfillmentOptionName", "fulfillmentOptionType", "fulfillmentOptionDisplayName" ], "members":{ "fulfillmentOptionId":{ "shape":"String", "documentation":"The unique identifier of the fulfillment option.
" }, "fulfillmentOptionName":{ "shape":"String", "documentation":"The display name of the fulfillment option version.
" }, "fulfillmentOptionType":{ "shape":"FulfillmentOptionType", "documentation":"The category of the fulfillment option.
" }, "fulfillmentOptionDisplayName":{ "shape":"String", "documentation":"A human-readable name for the fulfillment option type.
" }, "fulfillmentOptionVersion":{ "shape":"String", "documentation":"The version identifier of the fulfillment option.
" }, "releaseNotes":{ "shape":"String", "documentation":"Release notes describing changes in this version of the fulfillment option.
" }, "usageInstructions":{ "shape":"String", "documentation":"Instructions on how to deploy and use this CloudFormation template.
" } }, "documentation":"Describes an AWS CloudFormation template fulfillment option for infrastructure deployment.
" }, "ConfigurableUpfrontPricingTerm":{ "type":"structure", "required":[ "id", "type", "currencyCode" ], "members":{ "id":{ "shape":"TermId", "documentation":"The unique identifier of the term.
" }, "type":{ "shape":"TermType", "documentation":"The category of the term.
" }, "currencyCode":{ "shape":"CurrencyCode", "documentation":"Defines the currency for the prices in this term.
" }, "rateCards":{ "shape":"ConfigurableUpfrontRateCardList", "documentation":"The rate cards available for selection, each with a selector, constraints, and per-unit rates.
" } }, "documentation":"Defines a configurable upfront pricing term with selectable rate cards, where buyers choose from predefined pricing configurations.
" }, "ConfigurableUpfrontRateCardItem":{ "type":"structure", "required":[ "selector", "constraints", "rateCard" ], "members":{ "selector":{ "shape":"Selector", "documentation":"The selector criteria for this rate card, such as duration.
" }, "constraints":{ "shape":"Constraints", "documentation":"Constraints on how the buyer can configure this rate card, such as whether multiple dimensions can be selected.
" }, "rateCard":{ "shape":"RateCardList", "documentation":"The per-unit rates for this configuration.
" } }, "documentation":"A rate card item within a configurable upfront pricing term, including a selector for choosing the configuration and per-unit rates.
" }, "ConfigurableUpfrontRateCardList":{ "type":"list", "member":{"shape":"ConfigurableUpfrontRateCardItem"} }, "Constraints":{ "type":"structure", "required":[ "multipleDimensionSelection", "quantityConfiguration" ], "members":{ "multipleDimensionSelection":{ "shape":"RateCardConstraintType", "documentation":"Whether the buyer can select multiple dimensions. Values are Allowed or Disallowed.
Whether the buyer can configure quantities. Values are Allowed or Disallowed.
Constraints that control how a buyer can configure a rate card.
" }, "ContainerFulfillmentOption":{ "type":"structure", "required":[ "fulfillmentOptionId", "fulfillmentOptionName", "fulfillmentOptionType", "fulfillmentOptionDisplayName" ], "members":{ "fulfillmentOptionId":{ "shape":"String", "documentation":"The unique identifier of the fulfillment option.
" }, "fulfillmentOptionName":{ "shape":"String", "documentation":"The display name of the fulfillment option version.
" }, "fulfillmentOptionType":{ "shape":"FulfillmentOptionType", "documentation":"The category of the fulfillment option.
" }, "fulfillmentOptionDisplayName":{ "shape":"String", "documentation":"A human-readable name for the fulfillment option type.
" }, "fulfillmentOptionVersion":{ "shape":"String", "documentation":"The version identifier of the fulfillment option.
" }, "operatingSystems":{ "shape":"ContainerOperatingSystemList", "documentation":"The operating systems supported by this container image.
" }, "awsSupportedServices":{ "shape":"AwsSupportedServiceList", "documentation":"The AWS services supported by this container deployment.
" }, "releaseNotes":{ "shape":"String", "documentation":"Release notes describing changes in this version of the fulfillment option.
" }, "usageInstructions":{ "shape":"String", "documentation":"Instructions on how to deploy and use this container image.
" } }, "documentation":"Describes a container image fulfillment option for container-based deployment.
" }, "ContainerOperatingSystem":{ "type":"structure", "required":[ "operatingSystemFamilyName", "operatingSystemName" ], "members":{ "operatingSystemFamilyName":{ "shape":"String", "documentation":"The operating system family, such as Linux.
" }, "operatingSystemName":{ "shape":"String", "documentation":"The specific operating system name.
" } }, "documentation":"Describes an operating system supported by a container fulfillment option.
" }, "ContainerOperatingSystemList":{ "type":"list", "member":{"shape":"ContainerOperatingSystem"} }, "CurrencyCode":{ "type":"string", "max":3, "min":3, "pattern":"[A-Z]+" }, "DataArtifact":{ "type":"structure", "required":[ "resourceType", "dataClassification" ], "members":{ "description":{ "shape":"String", "documentation":"A description of the data artifact.
" }, "resourceArn":{ "shape":"String", "documentation":"The Amazon Resource Name (ARN) of the data artifact.
" }, "resourceType":{ "shape":"String", "documentation":"The type of the data artifact resource.
" }, "dataClassification":{ "shape":"String", "documentation":"The classification of sensitive data contained in the dataset.
" } }, "documentation":"Describes a data artifact within a Data Exchange fulfillment option.
" }, "DataArtifactList":{ "type":"list", "member":{"shape":"DataArtifact"} }, "DataExchangeFulfillmentOption":{ "type":"structure", "required":[ "fulfillmentOptionId", "fulfillmentOptionType", "fulfillmentOptionDisplayName" ], "members":{ "fulfillmentOptionId":{ "shape":"String", "documentation":"The unique identifier of the fulfillment option.
" }, "fulfillmentOptionType":{ "shape":"FulfillmentOptionType", "documentation":"The category of the fulfillment option.
" }, "fulfillmentOptionDisplayName":{ "shape":"String", "documentation":"A human-readable name for the fulfillment option type.
" }, "dataArtifacts":{ "shape":"DataArtifactList", "documentation":"The data artifacts included in this Data Exchange fulfillment option.
" } }, "documentation":"Describes an AWS Data Exchange fulfillment option for data set delivery.
" }, "DeployedOnAwsStatus":{ "type":"string", "enum":[ "DEPLOYED", "NOT_DEPLOYED", "NOT_APPLICABLE" ] }, "DimensionLabel":{ "type":"structure", "required":[ "labelType", "labelValue" ], "members":{ "labelType":{ "shape":"DimensionLabelType", "documentation":"The type of the dimension label, such as Region or SagemakerOption.
The value used to group dimensions together.
" }, "displayName":{ "shape":"BoundedString", "documentation":"The human-readable display name of the label.
" } }, "documentation":"A label used to group or categorize pricing dimensions, such as by region or SageMaker option.
" }, "DimensionLabelList":{ "type":"list", "member":{"shape":"DimensionLabel"} }, "DimensionLabelType":{ "type":"string", "enum":[ "Region", "SagemakerOption" ] }, "DocumentItem":{ "type":"structure", "required":[ "type", "url" ], "members":{ "type":{ "shape":"LegalDocumentType", "documentation":"The category of the legal document, such as StandardEula or CustomEula.
The URL where the legal document can be accessed.
" }, "version":{ "shape":"String", "documentation":"The version of the standard contract, if applicable.
" } }, "documentation":"A legal document associated with a legal term, such as a EULA or data subscription agreement.
" }, "DocumentList":{ "type":"list", "member":{"shape":"DocumentItem"} }, "Ec2ImageBuilderComponentFulfillmentOption":{ "type":"structure", "required":[ "fulfillmentOptionId", "fulfillmentOptionName", "fulfillmentOptionType", "fulfillmentOptionDisplayName" ], "members":{ "fulfillmentOptionId":{ "shape":"String", "documentation":"The unique identifier of the fulfillment option.
" }, "fulfillmentOptionName":{ "shape":"String", "documentation":"The display name of the fulfillment option version.
" }, "fulfillmentOptionType":{ "shape":"FulfillmentOptionType", "documentation":"The category of the fulfillment option.
" }, "fulfillmentOptionDisplayName":{ "shape":"String", "documentation":"A human-readable name for the fulfillment option type.
" }, "fulfillmentOptionVersion":{ "shape":"String", "documentation":"The version identifier of the fulfillment option.
" }, "operatingSystems":{ "shape":"ContainerOperatingSystemList", "documentation":"The operating systems supported by this EC2 Image Builder component.
" }, "awsSupportedServices":{ "shape":"AwsSupportedServiceList", "documentation":"The AWS services supported by this EC2 Image Builder component.
" }, "releaseNotes":{ "shape":"String", "documentation":"Release notes describing changes in this version of the fulfillment option.
" }, "usageInstructions":{ "shape":"String", "documentation":"Instructions on how to deploy and use this EC2 Image Builder component.
" } }, "documentation":"Describes an EC2 Image Builder component fulfillment option.
" }, "EksAddOnFulfillmentOption":{ "type":"structure", "required":[ "fulfillmentOptionId", "fulfillmentOptionName", "fulfillmentOptionType", "fulfillmentOptionDisplayName" ], "members":{ "fulfillmentOptionId":{ "shape":"String", "documentation":"The unique identifier of the fulfillment option.
" }, "fulfillmentOptionName":{ "shape":"String", "documentation":"The display name of the fulfillment option version.
" }, "fulfillmentOptionType":{ "shape":"FulfillmentOptionType", "documentation":"The category of the fulfillment option.
" }, "fulfillmentOptionDisplayName":{ "shape":"String", "documentation":"A human-readable name for the fulfillment option type.
" }, "fulfillmentOptionVersion":{ "shape":"String", "documentation":"The version identifier of the fulfillment option.
" }, "operatingSystems":{ "shape":"EksAddOnOperatingSystemList", "documentation":"The operating systems supported by this EKS add-on.
" }, "releaseNotes":{ "shape":"String", "documentation":"Release notes describing changes in this version of the fulfillment option.
" }, "usageInstructions":{ "shape":"String", "documentation":"Instructions on how to deploy and use this EKS add-on.
" }, "awsSupportedServices":{ "shape":"AwsSupportedServiceList", "documentation":"The AWS services supported by this EKS add-on.
" } }, "documentation":"Describes an Amazon EKS add-on fulfillment option.
" }, "EksAddOnOperatingSystem":{ "type":"structure", "required":[ "operatingSystemFamilyName", "operatingSystemName" ], "members":{ "operatingSystemFamilyName":{ "shape":"String", "documentation":"The operating system family, such as Linux.
" }, "operatingSystemName":{ "shape":"String", "documentation":"The specific operating system name.
" } }, "documentation":"Describes an operating system supported by an EKS add-on fulfillment option.
" }, "EksAddOnOperatingSystemList":{ "type":"list", "member":{"shape":"EksAddOnOperatingSystem"} }, "ExceptionMessage":{"type":"string"}, "FacetTypeList":{ "type":"list", "member":{"shape":"SearchFacetType"}, "max":30, "min":0 }, "FixedUpfrontPricingTerm":{ "type":"structure", "required":[ "id", "type", "currencyCode", "price", "grants" ], "members":{ "id":{ "shape":"TermId", "documentation":"The unique identifier of the term.
" }, "type":{ "shape":"TermType", "documentation":"The category of the term.
" }, "currencyCode":{ "shape":"CurrencyCode", "documentation":"Defines the currency for the prices in this term.
" }, "duration":{ "shape":"BoundedString", "documentation":"The duration of the fixed pricing term, in ISO 8601 format.
" }, "price":{ "shape":"BoundedString", "documentation":"The price charged upfront for this term.
" }, "grants":{ "shape":"GrantList", "documentation":"The entitlements granted to the buyer as part of this term.
" } }, "documentation":"Defines a fixed upfront pricing term with a pre-paid amount and granted entitlements.
" }, "FreeTrialPricingTerm":{ "type":"structure", "required":[ "id", "type", "grants" ], "members":{ "id":{ "shape":"TermId", "documentation":"The unique identifier of the term.
" }, "type":{ "shape":"TermType", "documentation":"The category of the term.
" }, "duration":{ "shape":"BoundedString", "documentation":"The duration of the free trial period.
" }, "grants":{ "shape":"GrantList", "documentation":"The entitlements granted to the buyer during the free trial.
" } }, "documentation":"Defines a free trial pricing term that enables customers to try the product before purchasing.
" }, "FulfillmentOption":{ "type":"structure", "members":{ "amazonMachineImageFulfillmentOption":{ "shape":"AmazonMachineImageFulfillmentOption", "documentation":"An Amazon Machine Image (AMI) fulfillment option for EC2 deployment.
" }, "apiFulfillmentOption":{ "shape":"ApiFulfillmentOption", "documentation":"An API-based fulfillment option for programmatic integration.
" }, "cloudFormationFulfillmentOption":{ "shape":"CloudFormationFulfillmentOption", "documentation":"An AWS CloudFormation template fulfillment option for infrastructure deployment.
" }, "containerFulfillmentOption":{ "shape":"ContainerFulfillmentOption", "documentation":"A container image fulfillment option for container-based deployment.
" }, "helmFulfillmentOption":{ "shape":"HelmFulfillmentOption", "documentation":"A Helm chart fulfillment option for Kubernetes deployment.
" }, "eksAddOnFulfillmentOption":{ "shape":"EksAddOnFulfillmentOption", "documentation":"An Amazon EKS add-on fulfillment option.
" }, "ec2ImageBuilderComponentFulfillmentOption":{ "shape":"Ec2ImageBuilderComponentFulfillmentOption", "documentation":"An EC2 Image Builder component fulfillment option.
" }, "dataExchangeFulfillmentOption":{ "shape":"DataExchangeFulfillmentOption", "documentation":"An AWS Data Exchange fulfillment option for data set delivery.
" }, "professionalServicesFulfillmentOption":{ "shape":"ProfessionalServicesFulfillmentOption", "documentation":"A professional services fulfillment option.
" }, "saasFulfillmentOption":{ "shape":"SaasFulfillmentOption", "documentation":"A Software as a Service (SaaS) fulfillment option.
" }, "sageMakerAlgorithmFulfillmentOption":{ "shape":"SageMakerAlgorithmFulfillmentOption", "documentation":"An Amazon SageMaker algorithm fulfillment option.
" }, "sageMakerModelFulfillmentOption":{ "shape":"SageMakerModelFulfillmentOption", "documentation":"An Amazon SageMaker model fulfillment option.
" } }, "documentation":"Describes a fulfillment option for a product. Each element contains exactly one fulfillment option type.
", "union":true }, "FulfillmentOptionSummary":{ "type":"structure", "required":[ "fulfillmentOptionType", "displayName" ], "members":{ "fulfillmentOptionType":{ "shape":"FulfillmentOptionType", "documentation":"The machine-readable type of the fulfillment option, such as SAAS or AMAZON_MACHINE_IMAGE.
The human-readable name of the fulfillment option type.
" } }, "documentation":"A summary of a fulfillment option available for deploying or accessing a listing or product.
" }, "FulfillmentOptionSummaryList":{ "type":"list", "member":{"shape":"FulfillmentOptionSummary"}, "max":20, "min":0 }, "FulfillmentOptionType":{ "type":"string", "enum":[ "AMAZON_MACHINE_IMAGE", "API", "CLOUDFORMATION_TEMPLATE", "CONTAINER", "HELM", "EKS_ADD_ON", "EC2_IMAGE_BUILDER_COMPONENT", "DATA_EXCHANGE", "PROFESSIONAL_SERVICES", "SAAS", "SAGEMAKER_ALGORITHM", "SAGEMAKER_MODEL" ] }, "FulfillmentOptionsList":{ "type":"list", "member":{"shape":"FulfillmentOption"} }, "GetListingInput":{ "type":"structure", "required":["listingId"], "members":{ "listingId":{ "shape":"ListingId", "documentation":"The unique identifier of the listing to retrieve.
" } } }, "GetListingOutput":{ "type":"structure", "required":[ "associatedEntities", "badges", "catalog", "categories", "fulfillmentOptionSummaries", "highlights", "listingId", "listingName", "logoThumbnailUrl", "longDescription", "pricingModels", "pricingUnits", "promotionalMedia", "publisher", "resources", "sellerEngagements", "shortDescription", "useCases" ], "members":{ "associatedEntities":{ "shape":"ListingAssociatedEntityList", "documentation":"The products and offers associated with this listing. Each entity contains product and offer information.
" }, "badges":{ "shape":"ListingBadgeList", "documentation":"Badges indicating special attributes of the listing, such as free tier eligibility, free trial availability, or Quick Launch support.
" }, "catalog":{ "shape":"Catalog", "documentation":"The name of the catalog that the listing belongs to.
" }, "categories":{ "shape":"CategoryList", "documentation":"The categories used to classify this listing into logical groups.
" }, "fulfillmentOptionSummaries":{ "shape":"FulfillmentOptionSummaryList", "documentation":"A summary of fulfillment options available for deploying or accessing the listing, such as AMI, SaaS, or Container.
" }, "highlights":{ "shape":"HighlightList", "documentation":"A list of key features that the listing offers to customers.
" }, "integrationGuide":{ "shape":"NullableString", "documentation":"Optional guidance explaining how to use data in this listing. Primarily defines how to integrate with a multi-product listing.
" }, "listingId":{ "shape":"ListingId", "documentation":"The unique identifier of the listing.
" }, "listingName":{ "shape":"NonEmptyString", "documentation":"The human-readable display name of the listing.
" }, "logoThumbnailUrl":{ "shape":"URL", "documentation":"The URL of the logo thumbnail image for the listing.
" }, "longDescription":{ "shape":"GetListingOutputLongDescriptionString", "documentation":"A detailed description of what the listing offers, in paragraph format.
" }, "pricingModels":{ "shape":"PricingModelList", "documentation":"The pricing models for offers associated with this listing, such as usage-based, contract, BYOL, or free.
" }, "pricingUnits":{ "shape":"PricingUnitList", "documentation":"The pricing units that define the billing dimensions for offers associated with this listing, such as users, hosts, or data.
" }, "promotionalMedia":{ "shape":"PromotionalMediaList", "documentation":"Embedded promotional media provided by the creator of the product, such as images and videos.
" }, "publisher":{ "shape":"SellerInformation", "documentation":"The entity who created and published the listing.
" }, "resources":{ "shape":"ResourceList", "documentation":"Resources that provide further information about using the product or requesting support, such as documentation links, support contacts, and usage instructions.
" }, "reviewSummary":{ "shape":"ReviewSummary", "documentation":"A summary of customer reviews available for the listing, including average rating and total review count by source.
" }, "sellerEngagements":{ "shape":"SellerEngagementList", "documentation":"Engagement options available to potential buyers, such as requesting a private offer or requesting a demo.
" }, "shortDescription":{ "shape":"NonEmptyString", "documentation":"A 1–3 sentence summary describing the key aspects of the listing.
" }, "useCases":{ "shape":"UseCaseList", "documentation":"Use cases associated with the listing, describing scenarios where the product can be applied.
" } } }, "GetListingOutputLongDescriptionString":{ "type":"string", "max":32768, "min":0, "pattern":".*\\S.*" }, "GetOfferInput":{ "type":"structure", "required":["offerId"], "members":{ "offerId":{ "shape":"OfferId", "documentation":"The unique identifier of the offer to retrieve.
" } } }, "GetOfferOutput":{ "type":"structure", "required":[ "offerId", "catalog", "agreementProposalId", "sellerOfRecord", "pricingModel", "badges", "associatedEntities" ], "members":{ "offerId":{ "shape":"OfferId", "documentation":"The unique identifier of the offer.
" }, "catalog":{ "shape":"Catalog", "documentation":"The name of the catalog that the offer belongs to.
" }, "offerName":{ "shape":"NullableString", "documentation":"The display name of the offer. This is free-form text provided by the seller.
" }, "agreementProposalId":{ "shape":"AgreementResourceId", "documentation":"An encoded string to be passed by the acceptor of the terms when creating an agreement.
" }, "expirationTime":{ "shape":"Timestamp", "documentation":"The date and time until when the offer can be procured. This value is null for offers that never expire.
" }, "availableFromTime":{ "shape":"Timestamp", "documentation":"The date and time when the offer became available to the buyer.
" }, "sellerOfRecord":{ "shape":"SellerInformation", "documentation":"The entity responsible for selling the product under this offer.
" }, "replacementAgreementId":{ "shape":"AgreementResourceId", "documentation":"The identifier of the existing agreement that this offer would replace. Enables agreement-based offer functionality.
" }, "pricingModel":{ "shape":"PricingModel", "documentation":"The pricing model that determines how buyers are charged, such as usage-based, contract, BYOL, or free.
" }, "badges":{ "shape":"PurchaseOptionBadgeList", "documentation":"Badges indicating special attributes of the offer, such as private pricing, future dated, or replacement offer.
" }, "associatedEntities":{ "shape":"OfferAssociatedEntityList", "documentation":"The products and offer sets associated with this offer.
" } } }, "GetOfferSetInput":{ "type":"structure", "required":["offerSetId"], "members":{ "offerSetId":{ "shape":"OfferSetId", "documentation":"The unique identifier of the offer set to retrieve.
" } } }, "GetOfferSetOutput":{ "type":"structure", "required":[ "offerSetId", "catalog", "sellerOfRecord", "badges", "associatedEntities" ], "members":{ "offerSetId":{ "shape":"OfferSetId", "documentation":"The unique identifier of the offer set.
" }, "catalog":{ "shape":"Catalog", "documentation":"The name of the catalog that the offer set belongs to.
" }, "offerSetName":{ "shape":"NonEmptyString", "documentation":"The display name of the offer set.
" }, "availableFromTime":{ "shape":"Timestamp", "documentation":"The date and time when the offer set became available to the buyer.
" }, "expirationTime":{ "shape":"Timestamp", "documentation":"The date and time when the offer set expires and is no longer available for procurement.
" }, "buyerNotes":{ "shape":"NullableString", "documentation":"Detailed information about the offer set that helps buyers understand its purpose and contents.
" }, "sellerOfRecord":{ "shape":"SellerInformation", "documentation":"The entity responsible for selling the products under this offer set.
" }, "badges":{ "shape":"PurchaseOptionBadgeList", "documentation":"Badges indicating special attributes of the offer set, such as private pricing or future dated.
" }, "associatedEntities":{ "shape":"OfferSetAssociatedEntityList", "documentation":"The products and offers included in this offer set.
" } } }, "GetOfferTermsInput":{ "type":"structure", "required":["offerId"], "members":{ "offerId":{ "shape":"OfferId", "documentation":"The unique identifier of the offer whose terms to retrieve.
" }, "maxResults":{ "shape":"GetOfferTermsInputMaxResultsInteger", "documentation":"The maximum number of results that are returned per call. You can use nextToken to get more results.
If nextToken is returned, there are more results available. Make the call again using the returned token to retrieve the next page.
The terms attached to the offer. Each element contains exactly one term type.
" }, "nextToken":{ "shape":"NextToken", "documentation":"If nextToken is returned, there are more results available. Make the call again using the returned token to retrieve the next page.
The unique identifier of the product to retrieve.
" } } }, "GetProductOutput":{ "type":"structure", "required":[ "productId", "catalog", "productName", "deployedOnAws", "shortDescription", "longDescription", "manufacturer", "logoThumbnailUrl", "fulfillmentOptionSummaries", "categories", "highlights", "promotionalMedia", "resources", "sellerEngagements" ], "members":{ "productId":{ "shape":"ProductId", "documentation":"The unique identifier of the product.
" }, "catalog":{ "shape":"Catalog", "documentation":"The name of the catalog that the product belongs to.
" }, "productName":{ "shape":"NonEmptyString", "documentation":"The human-readable display name of the product.
" }, "deployedOnAws":{ "shape":"DeployedOnAwsStatus", "documentation":"Indicates whether the product is deployed on AWS infrastructure.
" }, "shortDescription":{ "shape":"NonEmptyString", "documentation":"A 1–3 sentence summary describing the key aspects of the product.
" }, "longDescription":{ "shape":"GetProductOutputLongDescriptionString", "documentation":"A detailed description of what the product does, in paragraph format.
" }, "manufacturer":{ "shape":"SellerInformation", "documentation":"The entity who manufactured the product.
" }, "logoThumbnailUrl":{ "shape":"URL", "documentation":"The URL of the logo thumbnail image for the product.
" }, "fulfillmentOptionSummaries":{ "shape":"FulfillmentOptionSummaryList", "documentation":"A summary of fulfillment options available for deploying or accessing the product, such as AMI, SaaS, or Container.
" }, "categories":{ "shape":"CategoryList", "documentation":"The categories used to classify this product into logical groups.
" }, "highlights":{ "shape":"HighlightList", "documentation":"A list of key features that the product offers to customers.
" }, "promotionalMedia":{ "shape":"PromotionalMediaList", "documentation":"Embedded promotional media provided by the creator of the product, such as images and videos.
" }, "resources":{ "shape":"ResourceList", "documentation":"Resources that provide further information about using the product or requesting support, such as documentation links, support contacts, and usage instructions.
" }, "sellerEngagements":{ "shape":"SellerEngagementList", "documentation":"Engagement options available to potential buyers, such as requesting a private offer or requesting a demo.
" } } }, "GetProductOutputLongDescriptionString":{ "type":"string", "max":32768, "min":0, "pattern":".*\\S.*" }, "GrantItem":{ "type":"structure", "required":[ "dimensionKey", "displayName", "unit" ], "members":{ "dimensionKey":{ "shape":"BoundedString", "documentation":"The machine-readable key identifying the entitlement dimension.
" }, "displayName":{ "shape":"BoundedString", "documentation":"The human-readable name of the entitlement dimension.
" }, "description":{ "shape":"BoundedString", "documentation":"A description of the entitlement.
" }, "dimensionLabels":{ "shape":"DimensionLabelList", "documentation":"Labels used to categorize this entitlement, such as by region.
" }, "unit":{ "shape":"BoundedString", "documentation":"The unit of measurement for the entitlement.
" }, "maxQuantity":{ "shape":"Integer", "documentation":"The maximum quantity of the entitlement that can be granted.
" } }, "documentation":"An entitlement granted to the buyer as part of a pricing term.
" }, "GrantList":{ "type":"list", "member":{"shape":"GrantItem"} }, "HelmFulfillmentOption":{ "type":"structure", "required":[ "fulfillmentOptionId", "fulfillmentOptionName", "fulfillmentOptionType", "fulfillmentOptionDisplayName" ], "members":{ "fulfillmentOptionId":{ "shape":"String", "documentation":"The unique identifier of the fulfillment option.
" }, "fulfillmentOptionName":{ "shape":"String", "documentation":"The display name of the fulfillment option version.
" }, "fulfillmentOptionType":{ "shape":"FulfillmentOptionType", "documentation":"The category of the fulfillment option.
" }, "fulfillmentOptionDisplayName":{ "shape":"String", "documentation":"A human-readable name for the fulfillment option type.
" }, "fulfillmentOptionVersion":{ "shape":"String", "documentation":"The version identifier of the fulfillment option.
" }, "operatingSystems":{ "shape":"HelmOperatingSystemList", "documentation":"The operating systems supported by this Helm chart.
" }, "releaseNotes":{ "shape":"String", "documentation":"Release notes describing changes in this version of the fulfillment option.
" }, "awsSupportedServices":{ "shape":"AwsSupportedServiceList", "documentation":"The AWS services supported by this Helm chart deployment.
" }, "usageInstructions":{ "shape":"String", "documentation":"Instructions on how to deploy and use this Helm chart.
" } }, "documentation":"Describes a Helm chart fulfillment option for Kubernetes deployment.
" }, "HelmOperatingSystem":{ "type":"structure", "required":[ "operatingSystemFamilyName", "operatingSystemName" ], "members":{ "operatingSystemFamilyName":{ "shape":"String", "documentation":"The operating system family, such as Linux.
" }, "operatingSystemName":{ "shape":"String", "documentation":"The specific operating system name.
" } }, "documentation":"Describes an operating system supported by a Helm chart fulfillment option.
" }, "HelmOperatingSystemList":{ "type":"list", "member":{"shape":"HelmOperatingSystem"} }, "HighlightList":{ "type":"list", "member":{"shape":"NonEmptyString"}, "max":10, "min":0 }, "Integer":{ "type":"integer", "box":true }, "InternalServerException":{ "type":"structure", "members":{ "message":{"shape":"ExceptionMessage"} }, "documentation":"Unexpected error during processing of the request.
", "error":{"httpStatusCode":500}, "exception":true, "fault":true }, "LegalDocumentType":{ "type":"string", "enum":[ "CustomEula", "CustomDsa", "EnterpriseEula", "StandardEula", "StandardDsa" ] }, "LegalTerm":{ "type":"structure", "required":[ "id", "type", "documents" ], "members":{ "id":{ "shape":"TermId", "documentation":"The unique identifier of the term.
" }, "type":{ "shape":"TermType", "documentation":"The category of the term.
" }, "documents":{ "shape":"DocumentList", "documentation":"The legal documents proposed to the buyer as part of this term.
" } }, "documentation":"Defines a legal term containing documents proposed to buyers, such as EULAs and data subscription agreements.
" }, "ListFulfillmentOptionsInput":{ "type":"structure", "required":["productId"], "members":{ "productId":{ "shape":"ProductId", "documentation":"The unique identifier of the product for which to list fulfillment options.
" }, "maxResults":{ "shape":"ListFulfillmentOptionsInputMaxResultsInteger", "documentation":"The maximum number of results that are returned per call. You can use nextToken to get more results.
If nextToken is returned, there are more results available. Make the call again using the returned token to retrieve the next page.
The fulfillment options available for the product. Each option describes how the buyer can deploy or access the product.
" }, "nextToken":{ "shape":"NextToken", "documentation":"If nextToken is returned, there are more results available. Make the call again using the returned token to retrieve the next page.
Filters to narrow the results. Multiple filters are combined with AND logic. Multiple values within the same filter are combined with OR logic.
" }, "maxResults":{ "shape":"ListPurchaseOptionsInputMaxResultsInteger", "documentation":"The maximum number of results that are returned per call. You can use nextToken to get more results.
If nextToken is returned, there are more results available. Make the call again using the returned token to retrieve the next page.
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":{ "shape":"NextToken", "documentation":"If nextToken is returned, there are more results available. Make the call again using the returned token to retrieve the next page.
Information about the product associated with the listing.
" }, "offer":{ "shape":"OfferInformation", "documentation":"Information about the default offer associated with the listing.
" } }, "documentation":"A product and offer associated with a listing.
" }, "ListingAssociatedEntityList":{ "type":"list", "member":{"shape":"ListingAssociatedEntity"}, "max":100, "min":0 }, "ListingBadge":{ "type":"structure", "required":[ "displayName", "badgeType" ], "members":{ "displayName":{ "shape":"NonEmptyString", "documentation":"The human-readable name of the badge.
" }, "badgeType":{ "shape":"ListingBadgeType", "documentation":"The machine-readable type of the badge.
" } }, "documentation":"A badge indicating a special attribute of a listing, such as free tier eligibility or Quick Launch support.
" }, "ListingBadgeList":{ "type":"list", "member":{"shape":"ListingBadge"}, "max":20, "min":0 }, "ListingBadgeType":{ "type":"string", "enum":[ "AWS_FREE_TIER", "FREE_TRIAL", "DEPLOYED_ON_AWS", "QUICK_LAUNCH", "MULTI_PRODUCT" ] }, "ListingFacet":{ "type":"structure", "required":[ "value", "displayName", "count" ], "members":{ "value":{ "shape":"NonEmptyString", "documentation":"The internal value used for filtering when passed back in a search filter.
" }, "displayName":{ "shape":"NonEmptyString", "documentation":"The human-readable name of the facet value, suitable for display in a user interface.
" }, "parent":{ "shape":"NullableString", "documentation":"The parent facet value for hierarchical facets, such as subcategories.
" }, "count":{ "shape":"NonNegativeCount", "documentation":"The number of listings matching this facet value.
" } }, "documentation":"A facet value with display information and a count of matching listings. Used to build filter and browse experiences.
" }, "ListingFacetList":{ "type":"list", "member":{"shape":"ListingFacet"}, "max":100, "min":0 }, "ListingId":{ "type":"string", "max":255, "min":1, "pattern":"[\\w\\-]+" }, "ListingSummary":{ "type":"structure", "required":[ "listingId", "listingName", "publisher", "catalog", "shortDescription", "logoThumbnailUrl", "categories", "fulfillmentOptionSummaries", "badges", "reviewSummary", "pricingModels", "pricingUnits", "associatedEntities" ], "members":{ "listingId":{ "shape":"ListingId", "documentation":"The unique identifier of the listing.
" }, "listingName":{ "shape":"NonEmptyString", "documentation":"The human-readable display name of the listing.
" }, "publisher":{ "shape":"SellerInformation", "documentation":"The entity who created and published the listing.
" }, "catalog":{ "shape":"Catalog", "documentation":"The name of the catalog that the listing belongs to.
" }, "shortDescription":{ "shape":"NonEmptyString", "documentation":"A 1–3 sentence summary describing the key aspects of the listing.
" }, "logoThumbnailUrl":{ "shape":"URL", "documentation":"The URL of the logo thumbnail image for the listing.
" }, "categories":{ "shape":"CategoryList", "documentation":"The categories used to classify this listing into logical groups.
" }, "fulfillmentOptionSummaries":{ "shape":"FulfillmentOptionSummaryList", "documentation":"A summary of fulfillment options available for the listing.
" }, "badges":{ "shape":"ListingBadgeList", "documentation":"Badges indicating special attributes of the listing.
" }, "reviewSummary":{ "shape":"ReviewSummary", "documentation":"A summary of customer reviews for the listing.
" }, "pricingModels":{ "shape":"PricingModelList", "documentation":"The pricing models for offers associated with this listing.
" }, "pricingUnits":{ "shape":"PricingUnitList", "documentation":"The pricing units that define the billing dimensions for offers associated with this listing.
" }, "associatedEntities":{ "shape":"ListingSummaryAssociatedEntityList", "documentation":"The products associated with this listing.
" } }, "documentation":"Summary information about a listing returned by search operations, including the listing name, description, badges, categories, pricing models, reviews, and associated products.
" }, "ListingSummaryAssociatedEntity":{ "type":"structure", "members":{ "product":{ "shape":"ProductInformation", "documentation":"Information about the associated product.
" } }, "documentation":"A product associated with a listing summary.
" }, "ListingSummaryAssociatedEntityList":{ "type":"list", "member":{"shape":"ListingSummaryAssociatedEntity"}, "max":50, "min":0 }, "ListingSummaryList":{ "type":"list", "member":{"shape":"ListingSummary"} }, "MaxResults":{ "type":"integer", "box":true, "max":100, "min":1 }, "NextToken":{ "type":"string", "max":8192, "min":0, "pattern":"[a-zA-Z0-9+/=]+" }, "NonEmptyString":{ "type":"string", "max":1024, "min":1, "pattern":".*\\S.*" }, "NonNegativeCount":{ "type":"long", "box":true, "min":0 }, "NullableString":{ "type":"string", "max":255, "min":0 }, "OfferAssociatedEntity":{ "type":"structure", "required":["product"], "members":{ "product":{ "shape":"ProductInformation", "documentation":"Information about the product associated with the offer.
" }, "offerSet":{ "shape":"OfferSetInformation", "documentation":"Information about the offer set, if the offer is part of a bundled offer set.
" } }, "documentation":"A product and optional offer set associated with an offer.
" }, "OfferAssociatedEntityList":{ "type":"list", "member":{"shape":"OfferAssociatedEntity"}, "max":100, "min":0 }, "OfferId":{ "type":"string", "max":255, "min":1, "pattern":"[\\w\\-]+" }, "OfferInformation":{ "type":"structure", "required":[ "offerId", "sellerOfRecord" ], "members":{ "offerId":{ "shape":"OfferId", "documentation":"The unique identifier of the offer.
" }, "offerName":{ "shape":"NullableString", "documentation":"The display name of the offer.
" }, "sellerOfRecord":{ "shape":"SellerInformation", "documentation":"The entity responsible for selling the product under this offer.
" } }, "documentation":"Summary information about an offer, including the offer identifier, name, and seller of record.
" }, "OfferSetAssociatedEntity":{ "type":"structure", "required":[ "product", "offer" ], "members":{ "product":{ "shape":"ProductInformation", "documentation":"Information about the product associated with the offer set.
" }, "offer":{ "shape":"OfferInformation", "documentation":"Information about the offer associated with the offer set.
" } }, "documentation":"A product and offer associated with an offer set.
" }, "OfferSetAssociatedEntityList":{ "type":"list", "member":{"shape":"OfferSetAssociatedEntity"}, "max":100, "min":0 }, "OfferSetId":{ "type":"string", "max":255, "min":1, "pattern":"[\\w\\-]+" }, "OfferSetInformation":{ "type":"structure", "required":[ "offerSetId", "sellerOfRecord" ], "members":{ "offerSetId":{ "shape":"OfferSetId", "documentation":"The unique identifier of the offer set.
" }, "sellerOfRecord":{ "shape":"SellerInformation", "documentation":"The entity responsible for selling the products under this offer set.
" } }, "documentation":"Summary information about an offer set, including the identifier and seller of record.
" }, "OfferTerm":{ "type":"structure", "members":{ "byolPricingTerm":{"shape":"ByolPricingTerm"}, "configurableUpfrontPricingTerm":{"shape":"ConfigurableUpfrontPricingTerm"}, "fixedUpfrontPricingTerm":{"shape":"FixedUpfrontPricingTerm"}, "freeTrialPricingTerm":{"shape":"FreeTrialPricingTerm"}, "legalTerm":{"shape":"LegalTerm"}, "paymentScheduleTerm":{"shape":"PaymentScheduleTerm"}, "recurringPaymentTerm":{"shape":"RecurringPaymentTerm"}, "renewalTerm":{"shape":"RenewalTerm"}, "supportTerm":{"shape":"SupportTerm"}, "usageBasedPricingTerm":{"shape":"UsageBasedPricingTerm"}, "validityTerm":{"shape":"ValidityTerm"}, "variablePaymentTerm":{"shape":"VariablePaymentTerm"} }, "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.
", "union":true }, "OfferTermsList":{ "type":"list", "member":{"shape":"OfferTerm"} }, "PaymentScheduleTerm":{ "type":"structure", "required":[ "id", "type", "currencyCode", "schedule" ], "members":{ "id":{ "shape":"TermId", "documentation":"The unique identifier of the term.
" }, "type":{ "shape":"TermType", "documentation":"The category of the term.
" }, "currencyCode":{ "shape":"CurrencyCode", "documentation":"Defines the currency for the prices in this term.
" }, "schedule":{ "shape":"ScheduleList", "documentation":"The payment schedule installments, each with a charge date and amount.
" } }, "documentation":"Defines a payment schedule term with installment payments at specified dates.
" }, "PricingModel":{ "type":"structure", "required":[ "pricingModelType", "displayName" ], "members":{ "pricingModelType":{ "shape":"PricingModelType", "documentation":"The machine-readable type of the pricing model.
" }, "displayName":{ "shape":"NonEmptyString", "documentation":"The human-readable name of the pricing model.
" } }, "documentation":"A pricing model that determines how buyers are charged for a listing, such as usage-based, contract, BYOL, or free.
" }, "PricingModelList":{ "type":"list", "member":{"shape":"PricingModel"}, "max":20, "min":0 }, "PricingModelType":{ "type":"string", "enum":[ "USAGE", "CONTRACT", "BYOL", "FREE" ] }, "PricingUnit":{ "type":"structure", "required":[ "pricingUnitType", "displayName" ], "members":{ "pricingUnitType":{ "shape":"PricingUnitType", "documentation":"The machine-readable type of the pricing unit.
" }, "displayName":{ "shape":"NonEmptyString", "documentation":"The human-readable name of the pricing unit.
" } }, "documentation":"A pricing unit that defines the billing dimension for a listing, such as users, hosts, bandwidth, or data.
" }, "PricingUnitList":{ "type":"list", "member":{"shape":"PricingUnit"}, "max":20, "min":0 }, "PricingUnitType":{ "type":"string", "enum":[ "USERS", "HOSTS", "BANDWIDTH", "DATA", "TIERS", "REQUESTS", "UNITS" ] }, "ProductId":{ "type":"string", "max":255, "min":1, "pattern":"[\\w\\-]+" }, "ProductInformation":{ "type":"structure", "required":[ "productId", "productName", "manufacturer" ], "members":{ "productId":{ "shape":"ProductId", "documentation":"The unique identifier of the product.
" }, "productName":{ "shape":"NonEmptyString", "documentation":"The human-readable display name of the product.
" }, "manufacturer":{ "shape":"SellerInformation", "documentation":"The entity who manufactured the product.
" } }, "documentation":"Summary information about a product, including the identifier, name, and manufacturer.
" }, "ProfessionalServicesFulfillmentOption":{ "type":"structure", "required":[ "fulfillmentOptionId", "fulfillmentOptionType", "fulfillmentOptionDisplayName" ], "members":{ "fulfillmentOptionId":{ "shape":"String", "documentation":"The unique identifier of the fulfillment option.
" }, "fulfillmentOptionType":{ "shape":"FulfillmentOptionType", "documentation":"The category of the fulfillment option.
" }, "fulfillmentOptionDisplayName":{ "shape":"String", "documentation":"A human-readable name for the fulfillment option type.
" } }, "documentation":"Describes a professional services fulfillment option.
" }, "PromotionalEmbeddedImage":{ "type":"structure", "required":[ "title", "url" ], "members":{ "title":{ "shape":"NonEmptyString", "documentation":"The title displayed when hovering over the image.
" }, "url":{ "shape":"URL", "documentation":"The URL of the image file.
" }, "description":{ "shape":"NullableString", "documentation":"An optional description of the image.
" } }, "documentation":"An embedded promotional image for a product.
" }, "PromotionalEmbeddedVideo":{ "type":"structure", "required":[ "title", "url", "preview", "thumbnail" ], "members":{ "title":{ "shape":"NonEmptyString", "documentation":"The title displayed when hovering over the video.
" }, "url":{ "shape":"URL", "documentation":"The URL of the video file.
" }, "preview":{ "shape":"URL", "documentation":"The URL of the high-resolution preview image for the video.
" }, "thumbnail":{ "shape":"URL", "documentation":"The URL of the thumbnail image for the video.
" }, "description":{ "shape":"NullableString", "documentation":"An optional description of the video.
" } }, "documentation":"An embedded promotional video for a product.
" }, "PromotionalMedia":{ "type":"structure", "members":{ "embeddedImage":{"shape":"PromotionalEmbeddedImage"}, "embeddedVideo":{"shape":"PromotionalEmbeddedVideo"} }, "documentation":"Embedded promotional media for a product, such as images or videos. Each element contains exactly one media type.
", "union":true }, "PromotionalMediaList":{ "type":"list", "member":{"shape":"PromotionalMedia"}, "max":100, "min":0 }, "PurchaseOptionAssociatedEntity":{ "type":"structure", "required":[ "product", "offer" ], "members":{ "product":{ "shape":"ProductInformation", "documentation":"Information about the product associated with the purchase option.
" }, "offer":{ "shape":"OfferInformation", "documentation":"Information about the offer associated with the purchase option.
" }, "offerSet":{ "shape":"OfferSetInformation", "documentation":"Information about the offer set, if the purchase option is part of a bundled offer set.
" } }, "documentation":"A product, offer, and optional offer set associated with a purchase option.
" }, "PurchaseOptionAssociatedEntityList":{ "type":"list", "member":{"shape":"PurchaseOptionAssociatedEntity"}, "max":100, "min":0 }, "PurchaseOptionBadge":{ "type":"structure", "required":[ "displayName", "badgeType" ], "members":{ "displayName":{ "shape":"NonEmptyString", "documentation":"The human-readable name of the badge.
" }, "badgeType":{ "shape":"PurchaseOptionBadgeType", "documentation":"The machine-readable type of the badge.
" } }, "documentation":"A badge indicating a special attribute of a purchase option, such as private pricing or future dated.
" }, "PurchaseOptionBadgeList":{ "type":"list", "member":{"shape":"PurchaseOptionBadge"}, "max":20, "min":0 }, "PurchaseOptionBadgeType":{ "type":"string", "enum":[ "PRIVATE_PRICING", "FUTURE_DATED", "REPLACEMENT_OFFER" ] }, "PurchaseOptionFilter":{ "type":"structure", "required":[ "filterType", "filterValues" ], "members":{ "filterType":{ "shape":"PurchaseOptionFilterType", "documentation":"The type of filter to apply, such as PRODUCT_ID, VISIBILITY_SCOPE, or PURCHASE_OPTION_TYPE.
The values to filter by. Multiple values within the same filter are combined with OR logic.
" } }, "documentation":"A filter used to narrow purchase option results by product, seller, type, visibility, or availability.
" }, "PurchaseOptionFilterList":{ "type":"list", "member":{"shape":"PurchaseOptionFilter"}, "max":10, "min":1 }, "PurchaseOptionFilterType":{ "type":"string", "enum":[ "PRODUCT_ID", "SELLER_OF_RECORD_PROFILE_ID", "PURCHASE_OPTION_TYPE", "VISIBILITY_SCOPE", "AVAILABILITY_STATUS" ] }, "PurchaseOptionFilterValue":{ "type":"string", "max":255, "min":1, "pattern":"[\\w\\-]+" }, "PurchaseOptionFilterValueList":{ "type":"list", "member":{"shape":"PurchaseOptionFilterValue"}, "max":10, "min":1 }, "PurchaseOptionSummary":{ "type":"structure", "required":[ "purchaseOptionId", "catalog", "purchaseOptionType", "sellerOfRecord", "associatedEntities" ], "members":{ "purchaseOptionId":{ "shape":"NonEmptyString", "documentation":"The unique identifier of the purchase option.
" }, "catalog":{ "shape":"Catalog", "documentation":"The name of the catalog that the purchase option belongs to.
" }, "purchaseOptionType":{ "shape":"PurchaseOptionType", "documentation":"The type of purchase option. Values are OFFER for a single-product offer or OFFERSET for a bundled offer set.
The display name of the purchase option.
" }, "availableFromTime":{ "shape":"Timestamp", "documentation":"The date and time when the purchase option became available to the buyer.
" }, "expirationTime":{ "shape":"Timestamp", "documentation":"The date and time when the purchase option expires and is no longer available for procurement.
" }, "sellerOfRecord":{ "shape":"SellerInformation", "documentation":"The entity responsible for selling the product under this purchase option.
" }, "badges":{ "shape":"PurchaseOptionBadgeList", "documentation":"Badges indicating special attributes of the purchase option, such as private pricing or future dated.
" }, "associatedEntities":{ "shape":"PurchaseOptionAssociatedEntityList", "documentation":"The products, offers, and offer sets associated with this purchase option.
" } }, "documentation":"Summary information about a purchase option (offer or offer set) available to the buyer, including the seller, badges, and associated products.
" }, "PurchaseOptionSummaryList":{ "type":"list", "member":{"shape":"PurchaseOptionSummary"}, "max":100, "min":0 }, "PurchaseOptionType":{ "type":"string", "enum":[ "OFFER", "OFFERSET" ] }, "RateCardConstraintType":{ "type":"string", "enum":[ "Allowed", "Disallowed" ] }, "RateCardItem":{ "type":"structure", "required":[ "dimensionKey", "displayName", "unit", "price" ], "members":{ "dimensionKey":{ "shape":"BoundedString", "documentation":"The machine-readable key identifying the dimension being priced.
" }, "displayName":{ "shape":"BoundedString", "documentation":"The human-readable name of the dimension.
" }, "description":{ "shape":"BoundedString", "documentation":"A description of the dimension being priced.
" }, "dimensionLabels":{ "shape":"DimensionLabelList", "documentation":"Labels used to categorize this dimension, such as by region.
" }, "unit":{ "shape":"BoundedString", "documentation":"The unit of measurement for the dimension.
" }, "price":{ "shape":"BoundedString", "documentation":"The price per unit for the dimension.
" } }, "documentation":"A per-unit rate within a rate card, defining the price for a specific dimension.
" }, "RateCardList":{ "type":"list", "member":{"shape":"RateCardItem"} }, "RecurringPaymentTerm":{ "type":"structure", "required":[ "id", "type", "currencyCode", "billingPeriod", "price" ], "members":{ "id":{ "shape":"TermId", "documentation":"The unique identifier of the term.
" }, "type":{ "shape":"TermType", "documentation":"The category of the term.
" }, "currencyCode":{ "shape":"CurrencyCode", "documentation":"Defines the currency for the prices in this term.
" }, "billingPeriod":{ "shape":"BillingPeriodType", "documentation":"The billing period frequency, such as Monthly.
The amount charged each billing period.
" } }, "documentation":"Defines a recurring payment term with fixed charges at regular billing intervals.
" }, "RenewalTerm":{ "type":"structure", "required":[ "id", "type" ], "members":{ "id":{ "shape":"TermId", "documentation":"The unique identifier of the term.
" }, "type":{ "shape":"TermType", "documentation":"The category of the term.
" } }, "documentation":"Defines a renewal term that enables automatic agreement renewal.
" }, "Resource":{ "type":"structure", "required":[ "resourceType", "contentType", "value" ], "members":{ "resourceType":{ "shape":"ResourceType", "documentation":"The category of the resource, such as manufacturer support or usage instructions.
" }, "contentType":{ "shape":"ResourceContentType", "documentation":"The format of the resource content, such as a URL, email address, or text.
" }, "value":{ "shape":"NonEmptyString", "documentation":"The resource content. Interpretation depends on the content type.
" }, "displayName":{ "shape":"NullableString", "documentation":"An optional human-readable label for the resource.
" } }, "documentation":"A resource that provides supplementary information about a product, such as documentation links, support contacts, or usage instructions.
" }, "ResourceContentType":{ "type":"string", "enum":[ "EMAIL", "PHONE_NUMBER", "LINK", "OTHER" ] }, "ResourceList":{ "type":"list", "member":{"shape":"Resource"}, "max":100, "min":0 }, "ResourceNotFoundException":{ "type":"structure", "members":{ "message":{"shape":"ExceptionMessage"} }, "documentation":"The specified resource doesn't exist.
", "error":{ "httpStatusCode":404, "senderFault":true }, "exception":true }, "ResourceType":{ "type":"string", "enum":[ "MANUFACTURER_SUPPORT", "MANUFACTURER_INSTRUCTIONS" ] }, "ReviewSourceId":{ "type":"string", "enum":["AWS_MARKETPLACE"] }, "ReviewSourceSummary":{ "type":"structure", "required":[ "sourceName", "sourceId", "averageRating", "totalReviews" ], "members":{ "sourceName":{ "shape":"NonEmptyString", "documentation":"The name of the review source, such as AWS Marketplace.
" }, "sourceId":{ "shape":"ReviewSourceId", "documentation":"The machine-readable identifier of the review source.
" }, "sourceUrl":{ "shape":"URL", "documentation":"The URL where the reviews can be accessed at the source.
" }, "averageRating":{ "shape":"NonEmptyString", "documentation":"The average rating across all reviews from this source.
" }, "totalReviews":{ "shape":"NonNegativeCount", "documentation":"The total number of reviews available from this source.
" } }, "documentation":"A review summary from a specific source, including the average rating and total review count.
" }, "ReviewSourceSummaryList":{ "type":"list", "member":{"shape":"ReviewSourceSummary"}, "max":10, "min":0 }, "ReviewSummary":{ "type":"structure", "required":["reviewSourceSummaries"], "members":{ "reviewSourceSummaries":{ "shape":"ReviewSourceSummaryList", "documentation":"Review summaries from different sources, such as AWS Marketplace.
" } }, "documentation":"A summary of customer reviews available for a listing, aggregated by review source.
" }, "SaasFulfillmentOption":{ "type":"structure", "required":[ "fulfillmentOptionId", "fulfillmentOptionType", "fulfillmentOptionDisplayName" ], "members":{ "fulfillmentOptionId":{ "shape":"String", "documentation":"The unique identifier of the fulfillment option.
" }, "fulfillmentOptionType":{ "shape":"FulfillmentOptionType", "documentation":"The category of the fulfillment option.
" }, "fulfillmentOptionDisplayName":{ "shape":"String", "documentation":"A human-readable name for the fulfillment option type.
" }, "fulfillmentUrl":{ "shape":"String", "documentation":"The URL of the seller's software registration landing page.
" }, "usageInstructions":{ "shape":"String", "documentation":"Instructions on how to access and use this SaaS product.
" } }, "documentation":"Describes a Software as a Service (SaaS) fulfillment option.
" }, "SageMakerAlgorithmFulfillmentOption":{ "type":"structure", "required":[ "fulfillmentOptionId", "fulfillmentOptionType", "fulfillmentOptionDisplayName" ], "members":{ "fulfillmentOptionId":{ "shape":"String", "documentation":"The unique identifier of the fulfillment option.
" }, "fulfillmentOptionType":{ "shape":"FulfillmentOptionType", "documentation":"The category of the fulfillment option.
" }, "fulfillmentOptionDisplayName":{ "shape":"String", "documentation":"A human-readable name for the fulfillment option type.
" }, "fulfillmentOptionVersion":{ "shape":"String", "documentation":"The version identifier of the fulfillment option.
" }, "releaseNotes":{ "shape":"String", "documentation":"Release notes describing changes in this version of the fulfillment option.
" }, "usageInstructions":{ "shape":"String", "documentation":"Instructions on how to use this SageMaker algorithm.
" }, "recommendation":{ "shape":"SageMakerAlgorithmRecommendation", "documentation":"Recommended instance types for training and inference with this algorithm.
" } }, "documentation":"Describes an Amazon SageMaker algorithm fulfillment option, including version details and recommended instance types.
" }, "SageMakerAlgorithmRecommendation":{ "type":"structure", "required":[ "recommendedBatchTransformInstanceType", "recommendedTrainingInstanceType" ], "members":{ "recommendedBatchTransformInstanceType":{ "shape":"String", "documentation":"The recommended instance type for batch inference.
" }, "recommendedRealtimeInferenceInstanceType":{ "shape":"String", "documentation":"The recommended instance type for real-time inference.
" }, "recommendedTrainingInstanceType":{ "shape":"String", "documentation":"The recommended instance type for training.
" } }, "documentation":"Recommended instance types for training and inference with a SageMaker algorithm.
" }, "SageMakerModelFulfillmentOption":{ "type":"structure", "required":[ "fulfillmentOptionId", "fulfillmentOptionType", "fulfillmentOptionDisplayName" ], "members":{ "fulfillmentOptionId":{ "shape":"String", "documentation":"The unique identifier of the fulfillment option.
" }, "fulfillmentOptionType":{ "shape":"FulfillmentOptionType", "documentation":"The category of the fulfillment option.
" }, "fulfillmentOptionDisplayName":{ "shape":"String", "documentation":"A human-readable name for the fulfillment option type.
" }, "fulfillmentOptionVersion":{ "shape":"String", "documentation":"The version identifier of the fulfillment option.
" }, "releaseNotes":{ "shape":"String", "documentation":"Release notes describing changes in this version of the fulfillment option.
" }, "usageInstructions":{ "shape":"String", "documentation":"Instructions on how to use this SageMaker model.
" }, "recommendation":{ "shape":"SageMakerModelRecommendation", "documentation":"Recommended instance types for inference with this model.
" } }, "documentation":"Describes an Amazon SageMaker model fulfillment option, including version details and recommended instance types.
" }, "SageMakerModelRecommendation":{ "type":"structure", "required":["recommendedBatchTransformInstanceType"], "members":{ "recommendedBatchTransformInstanceType":{ "shape":"String", "documentation":"The recommended instance type for batch inference.
" }, "recommendedRealtimeInferenceInstanceType":{ "shape":"String", "documentation":"The recommended instance type for real-time inference.
" } }, "documentation":"Recommended instance types for inference with a SageMaker model.
" }, "ScheduleItem":{ "type":"structure", "required":[ "chargeDate", "chargeAmount" ], "members":{ "chargeDate":{ "shape":"Timestamp", "documentation":"The date when the payment is due.
" }, "chargeAmount":{ "shape":"BoundedString", "documentation":"The amount to be charged on the charge date.
" } }, "documentation":"A payment installment within a payment schedule term.
" }, "ScheduleList":{ "type":"list", "member":{"shape":"ScheduleItem"} }, "SearchFacetType":{ "type":"string", "enum":[ "AVERAGE_CUSTOMER_RATING", "CATEGORY", "PUBLISHER", "FULFILLMENT_OPTION_TYPE", "PRICING_MODEL", "PRICING_UNIT", "DEPLOYED_ON_AWS", "NUMBER_OF_PRODUCTS" ] }, "SearchFacetsInput":{ "type":"structure", "members":{ "searchText":{ "shape":"SearchText", "documentation":"The search query text to filter listings before retrieving facets.
" }, "filters":{ "shape":"SearchFilterList", "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":{ "shape":"FacetTypeList", "documentation":"A list of specific facet types to retrieve. If empty or null, all available facets are returned.
" }, "nextToken":{ "shape":"NextToken", "documentation":"If nextToken is returned, there are more results available. Make the call again using the returned token to retrieve the next page.
The total number of listings matching the search criteria.
" }, "listingFacets":{ "shape":"TypeToFacetMap", "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.
" }, "nextToken":{ "shape":"NextToken", "documentation":"If nextToken is returned, there are more results available. Make the call again using the returned token to retrieve the next page.
The type of filter to apply.
" }, "filterValues":{ "shape":"SearchFilterFilterValuesList", "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.
" } }, "documentation":"A filter used to narrow search results by attribute, such as category, pricing model, or fulfillment type.
" }, "SearchFilterFilterValuesList":{ "type":"list", "member":{"shape":"SearchFilterValue"}, "max":30, "min":1 }, "SearchFilterList":{ "type":"list", "member":{"shape":"SearchFilter"}, "max":30, "min":1 }, "SearchFilterType":{ "type":"string", "enum":[ "MIN_AVERAGE_CUSTOMER_RATING", "MAX_AVERAGE_CUSTOMER_RATING", "CATEGORY", "PUBLISHER", "FULFILLMENT_OPTION_TYPE", "PRICING_MODEL", "PRICING_UNIT", "DEPLOYED_ON_AWS", "NUMBER_OF_PRODUCTS" ] }, "SearchFilterValue":{ "type":"string", "max":128, "min":1, "pattern":"[\\w\\-\\.]+" }, "SearchListingsInput":{ "type":"structure", "members":{ "searchText":{ "shape":"SearchText", "documentation":"The search query text to find relevant listings.
" }, "filters":{ "shape":"SearchFilterList", "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":{ "shape":"MaxResults", "documentation":"The maximum number of results that are returned per call. You can use nextToken to get more results.
The field to sort results by. Valid values are RELEVANCE and AVERAGE_CUSTOMER_RATING.
The sort direction. Valid values are DESCENDING and ASCENDING.
If nextToken is returned, there are more results available. Make the call again using the returned token to retrieve the next page.
The total number of listings matching the search criteria.
" }, "listingSummaries":{ "shape":"ListingSummaryList", "documentation":"The listing summaries matching the search criteria. Each summary includes the listing name, description, badges, categories, pricing models, reviews, and associated products.
" }, "nextToken":{ "shape":"NextToken", "documentation":"If nextToken is returned, there are more results available. Make the call again using the returned token to retrieve the next page.
The category of the selector, such as Duration.
The value of the selector.
" } }, "documentation":"A selector used to choose a specific configuration within a configurable upfront rate card.
" }, "SelectorType":{ "type":"string", "enum":["Duration"] }, "SellerEngagement":{ "type":"structure", "required":[ "engagementType", "contentType", "value" ], "members":{ "engagementType":{ "shape":"SellerEngagementType", "documentation":"The type of engagement, such as REQUEST_FOR_PRIVATE_OFFER or REQUEST_FOR_DEMO.
The format of the engagement value, such as a URL.
" }, "value":{ "shape":"NonEmptyString", "documentation":"The engagement value, such as a URL to the engagement form.
" } }, "documentation":"An engagement option available to potential buyers of a product, such as requesting a private offer or a demo.
" }, "SellerEngagementContentType":{ "type":"string", "enum":["LINK"] }, "SellerEngagementList":{ "type":"list", "member":{"shape":"SellerEngagement"}, "max":100, "min":0 }, "SellerEngagementType":{ "type":"string", "enum":[ "REQUEST_FOR_PRIVATE_OFFER", "REQUEST_FOR_DEMO" ] }, "SellerInformation":{ "type":"structure", "required":[ "sellerProfileId", "displayName" ], "members":{ "sellerProfileId":{ "shape":"SellerProfileId", "documentation":"The unique identifier of the seller profile.
" }, "displayName":{ "shape":"NonEmptyString", "documentation":"The human-readable name of the seller.
" } }, "documentation":"Information about a seller, including the profile identifier and display name.
" }, "SellerProfileId":{ "type":"string", "max":255, "min":1, "pattern":"[\\w\\-]+" }, "String":{"type":"string"}, "SupportTerm":{ "type":"structure", "required":[ "id", "type", "refundPolicy" ], "members":{ "id":{ "shape":"TermId", "documentation":"The unique identifier of the term.
" }, "type":{ "shape":"TermType", "documentation":"The category of the term.
" }, "refundPolicy":{ "shape":"BoundedString", "documentation":"The refund policy description for the offer.
" } }, "documentation":"Defines a support term that includes the refund policy for the offer.
" }, "TermId":{ "type":"string", "max":256, "min":1, "pattern":"[A-Za-z0-9+=;,.@\\-_]+" }, "TermType":{ "type":"string", "enum":[ "ByolPricingTerm", "ConfigurableUpfrontPricingTerm", "FixedUpfrontPricingTerm", "UsageBasedPricingTerm", "FreeTrialPricingTerm", "LegalTerm", "PaymentScheduleTerm", "RecurringPaymentTerm", "RenewalTerm", "SupportTerm", "ValidityTerm", "VariablePaymentTerm" ] }, "ThrottlingException":{ "type":"structure", "members":{ "message":{"shape":"ExceptionMessage"} }, "documentation":"The request was denied due to request throttling.
", "error":{ "httpStatusCode":429, "senderFault":true }, "exception":true }, "Timestamp":{"type":"timestamp"}, "TypeToFacetMap":{ "type":"map", "key":{"shape":"SearchFacetType"}, "value":{"shape":"ListingFacetList"} }, "URL":{ "type":"string", "max":2048, "min":1, "pattern":"https?://.*" }, "UsageBasedPricingTerm":{ "type":"structure", "required":[ "id", "type", "currencyCode", "rateCards" ], "members":{ "id":{ "shape":"TermId", "documentation":"The unique identifier of the term.
" }, "type":{ "shape":"TermType", "documentation":"The category of the term.
" }, "currencyCode":{ "shape":"CurrencyCode", "documentation":"Defines the currency for the prices in this term.
" }, "rateCards":{ "shape":"UsageBasedRateCardList", "documentation":"The rate cards containing per-unit rates for usage-based pricing.
" } }, "documentation":"Defines a usage-based pricing term (typically pay-as-you-go), where buyers are charged based on product usage.
" }, "UsageBasedRateCardItem":{ "type":"structure", "required":["rateCard"], "members":{ "rateCard":{ "shape":"RateCardList", "documentation":"The per-unit rates for this usage-based rate card.
" } }, "documentation":"A rate card within a usage-based pricing term, containing per-unit rates.
" }, "UsageBasedRateCardList":{ "type":"list", "member":{"shape":"UsageBasedRateCardItem"} }, "UseCase":{ "type":"structure", "required":[ "description", "displayName", "value" ], "members":{ "description":{ "shape":"NonEmptyString", "documentation":"A description of the use case.
" }, "displayName":{ "shape":"NonEmptyString", "documentation":"The human-readable name of the use case.
" }, "value":{ "shape":"NonEmptyString", "documentation":"The machine-readable identifier of the use case.
" } }, "documentation":"A use case describing a scenario where the product can be applied.
" }, "UseCaseEntry":{ "type":"structure", "required":["useCase"], "members":{ "useCase":{ "shape":"UseCase", "documentation":"The use case details.
" } }, "documentation":"An entry in the list of use cases for a listing.
" }, "UseCaseList":{ "type":"list", "member":{"shape":"UseCaseEntry"}, "max":100, "min":0 }, "ValidationException":{ "type":"structure", "members":{ "message":{"shape":"ExceptionMessage"}, "reason":{ "shape":"ValidationExceptionReason", "documentation":"The reason that the input fails to satisfy the constraints specified by the service.
" } }, "documentation":"The input fails to satisfy the constraints specified by the service.
", "error":{ "httpStatusCode":400, "senderFault":true }, "exception":true }, "ValidationExceptionReason":{ "type":"string", "enum":[ "INVALID_PAGINATION_TOKEN", "MALFORMED_REQUEST_PARAMETERS", "PAGINATION_LIMIT_EXCEEDED" ] }, "ValidityTerm":{ "type":"structure", "required":[ "id", "type" ], "members":{ "id":{ "shape":"TermId", "documentation":"The unique identifier of the term.
" }, "type":{ "shape":"TermType", "documentation":"The category of the term.
" }, "agreementDuration":{ "shape":"BoundedString", "documentation":"The duration of the agreement, in ISO 8601 format.
" }, "agreementEndDate":{ "shape":"Timestamp", "documentation":"The date when the agreement ends.
" }, "agreementStartDate":{ "shape":"Timestamp", "documentation":"The date when the agreement starts.
" } }, "documentation":"Defines a validity term that specifies the duration or date range of an agreement.
" }, "VariablePaymentTerm":{ "type":"structure", "required":[ "id", "type", "currencyCode", "maxTotalChargeAmount" ], "members":{ "id":{ "shape":"TermId", "documentation":"The unique identifier of the term.
" }, "type":{ "shape":"TermType", "documentation":"The category of the term.
" }, "currencyCode":{ "shape":"CurrencyCode", "documentation":"Defines the currency for the prices in this term.
" }, "maxTotalChargeAmount":{ "shape":"BoundedString", "documentation":"The maximum total amount that can be charged under this term.
" } }, "documentation":"Defines a variable payment term with a maximum total charge amount.
" } }, "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.
" }