View a markdown version of this page

使用 解決方案 - AWS Marketplace

AWS Marketplace API 參考已重組。如需支援的 API 操作的詳細資訊,請參閱 AWS Marketplace API 參考

本文為英文版的機器翻譯版本,如內容有任何歧義或不一致之處,概以英文版為準。

使用 解決方案

解決方案是產品和服務的集合,可共同解決特定客戶問題。解決方案可以包含 AWS Marketplace 產品和非 AWS Marketplace 產品。解決方案可協助您展示多個產品如何整合以解決產業特定的使用案例。解決方案說明客戶問題、使用案例、整合詳細資訊和相關產品。

AWS Marketplace 和 AWS Partner Central 中的解決方案

當您從 Partner Central 2.0 遷移至 Partner Central 3.0 時,系統會提示您建立 AWS 帳戶並註冊為 AWS Marketplace 賣方。如需詳細資訊,請參閱註冊和建立您的賣方設定檔。需要此註冊才能:

  • 將您現有的 Partner Central 解決方案遷移至 AWS Marketplace 目錄 (所有解決方案都會遷移至AWSMarketplace目錄)

  • 讓您的 AWS Marketplace 解決方案能夠使用 Partner Central APIs,例如銷售 APIs

了解設定檔連結和遷移

連接 Partner Central 和 AWS Marketplace 帳戶有兩種不同的案例:

僅限設定檔連結 – 如果您在未遷移至 Partner Central 3.0 的情況下連結 AWS Partner Central 和 AWS 帳戶,您的 AWS Marketplace 解決方案和 Partner Central 解決方案會保持獨立。您可以獨立管理每個平台。

設定檔遷移 – 當您使用連結的 AWS Marketplace 賣方設定檔遷移至 Partner Central 3.0 時:

  • 您的 Partner Central 2.0 解決方案遷移至 AWS Marketplace

  • 您僅透過 AWS Marketplace 管理解決方案

  • Partner Central APIs可以存取遷移的解決方案

注意

如果您已連結 AWS Partner Central 和 AWS 帳戶 (請參閱連結 AWS Partner Central 和 AWS 帳戶),則不需要建立新的 AWS 帳戶。不過,請確認您現有的 AWS 帳戶已註冊為 AWS Marketplace 賣方。若要在 AWS Marketplace 買方網站上公開提供您的解決方案,您需要 AWS Marketplace 賣方的公開設定檔。如需 AWS Marketplace 賣方註冊說明,請參閱註冊和建立您的賣方設定檔

讓現有的 AWS Marketplace 解決方案可供 Partner Central APIs使用

Partner Central API 不會自動辨識您在 Partner Central 3.0 設定檔遷移之前建立APIs AWS Marketplace 解決方案。即使您完成遷移並將您的 AWS 帳戶與 Partner Central 帳戶連結後,這也適用。

若要讓 Partner Central APIs可以看到現有的預遷移解決方案,請更新解決方案中的任何欄位。您可以輸入目前所在的相同資訊。針對您在 Partner Central 3.0 設定檔遷移之前建立的每個解決方案重複此程序。

例如,使用UpdateInformation變更類型將解決方案的名稱更新為目前的值。更新解決方案一次後,Partner Central APIs會自動辨識該解決方案的任何未來更新。

解決方案實體

解決方案是一種行銷文件,可協助買方探索和了解您的產品。解決方案包含標題、描述、使用案例、AWS Marketplace 產品和非 AWS Marketplace 產品。解決方案是與產品、優惠和優惠集不同的實體類型。每個解決方案都有自己的探索和列出體驗,買方可以分別瀏覽個別產品。

重要特性

  • 將多個產品分組,包括 AWS Marketplace 產品和非 AWS Marketplace 產品。

  • 為買方建立專用的探索和清單體驗。

  • 將您擁有的產品與其他賣方的產品分組。

解決方案實體類型為 Solution@1.0

實體識別符

解決方案使用soln-*識別符格式 (例如 soln-abc123def456)。

實體 ARN 格式

解決方案遵循標準 AWS ARN 格式:

arn:{aws-partition}:aws-marketplace:{region}:{account-id}:{aws-marketplace-catalog}/Solution/{solution-id}

範例:

arn:aws:aws-marketplace:us-east-1:123456789012:AWSMarketplace/Solution/soln-abc123def456

解決方案入門

本節提供使用 AWS Marketplace 目錄 API 變更類型建立和管理解決方案的詳細資訊。

開始之前,請確定您已:

列出您的解決方案

若要列出您帳戶中的所有解決方案,請呼叫 ListEntities API 操作並EntityType設為 解決方案。

請求

POST /ListEntities HTTP/1.1 Content-type: application/json { "Catalog": "AWSMarketplace", "EntityType": "Solution" }

回應

{ "EntitySummaryList": [ { "EntityArn": "arn:aws:aws-marketplace:us-east-1:123456789012:AWSMarketplace/Solution/soln-abc123456", "EntityId": "soln-abc123456", "EntityType": "Solution", "LastModifiedDate": "2024-10-10T19:50:43Z", "Name": "Test Solution 1", "Visibility": "Limited" } ], "NextToken": null }

依可見性篩選解決方案

您可以使用 FilterList 參數,依可見性篩選解決方案。

請求

POST /ListEntities HTTP/1.1 Content-type: application/json { "Catalog": "AWSMarketplace", "EntityType": "Solution", "FilterList": [ { "Name": "Visibility", "ValueList": [ "Public" ] } ] }

取得解決方案詳細資訊

若要取得特定解決方案的詳細資訊,請呼叫 DescribeEntity API 操作。

注意

DescribeEntity 回應會傳回EntityIdentifierEntityIdRevisionId. For 解決方案結合的 , EntityId是解決方案 ID,RevisionId可用於樂觀鎖定。如需詳細資訊,請參閱識別符

請求

GET /DescribeEntity?catalog=AWSMarketplace&entityId=soln-abc123456 HTTP/1.1

回應

{ "Details": "{...}", "DetailsDocument": { "Lifecycle": { "Visibility": "Limited" }, "Identifiers": { "Id": "soln-abc123456" }, "Presentation": { "Title": "My Solution", "Name": "solution_for_customer_X", "ShortDescription": "Solution value proposition", "LongDescription": "Detailed solution description", "LogoUrl": "https://s3.amazonaws.com/logo.jpg", "UseCases": [ { "Group": "advertising_and_marketing", "SubGroup": "ad_intelligence_and_measurement", "Item": "amazon_ads_insights", "Description": "Use case description" } ] }, "RelatedProducts": { "AwsMarketplaceProducts": [ { "ProductId": "prod-123" } ], "IntegrationDescription": "How products work together", "NonAwsMarketplaceProducts": [ { "Type": "Hardware", "Title": "A hardware product", "Url": "https://example.com", "Description": "My hardware product description" } ] }, "BuyerEngagement": [ { "EngagementOption": "RequestPrivateOffer" } ] }, "EntityArn": "arn:aws:aws-marketplace:us-east-1:123456789012:AWSMarketplace/Solution/soln-abc123456", "EntityIdentifier": "soln-abc123456@12", "EntityType": "Solution@1.0", "LastModifiedDate": "2025-04-22T01:02:48Z" }

列出解決方案的變更歷史記錄

若要檢視特定解決方案的變更歷史記錄,請使用實體篩選條件呼叫 ListChangeSets API 操作。

請求語法

POST /ListChangeSets HTTP/1.1 Content-type: application/json { "Catalog": "AWSMarketplace", "FilterList": [ { "Name": "EntityId", "ValueList": [ "soln-abc123456" ] } ] }

標記解決方案和變更集

您可以在建立或稍後更新時,將標籤新增至解決方案和變更集。

建立期間的標籤

您只能將 EntityTags新增至CreateSolution變更類型,不能新增至其他解決方案變更類型。您可以將 ChangeSetTags新增至任何StartChangeSet承載。

POST /StartChangeSet HTTP/1.1 Content-type: application/json { "Catalog": "AWSMarketplace", "ChangeSet": [ { "ChangeType": "CreateSolution", "Entity": { "Type": "Solution@1.0" }, "DetailsDocument": { "Name": "Test solution resource name" }, "EntityTags": [ { "Key": "Team", "Value": "Solutions" } ] } ], "ChangeSetTags": [ { "Key": "Environment", "Value": "Production" } ] }

管理現有資源上的標籤

使用 TagResourceUntagResource API 操作來管理現有解決方案和變更集上的標籤。使用 ListTagsForResource 來檢視目前的標籤。

如需詳細資訊,請參閱管理 資源上的標籤將標籤新增至實體,以及在建立期間變更集

建立解決方案

您可以使用CreateSolution變更類型來建立只有解決方案 ID 和名稱的新解決方案文件。其他值尚未填入。

成功處理您的請求時,AWS Marketplace 會為您建立Draft狀態為 的解決方案。AWS Marketplace 上的買方看不到這個不完整的解決方案。

然後,您可以使用其他變更類型來完成解決方案:UpdateInformationUpdateRelatedProductsUpdateBuyerEngagementOptions(建立Limited解決方案的選用) 和 ReleaseSolutionReleaseSolution 變更類型會驗證Limited解決方案所需的所有必要欄位是否存在於解決方案上,然後將其移至Limited可見性。

注意

若要將解決方案移至公有狀態或變更解決方案的狀態,請在提供必要值後使用UpdateVisibility變更類型。

請求語法

POST /StartChangeSet HTTP/1.1 Content-type: application/json { "Catalog": "AWSMarketplace", "ChangeSet": [ { "ChangeType": "CreateSolution", "Entity": { "Type": "Solution@1.0" }, "ChangeName": "CreateSolutionChange", "DetailsDocument": { "Name": "solution_for_customerX_en", "Title": "New Partner Solution" } } ] }

提供要新增CreateSolution變更類型的欄位資訊:

  • Entity (物件) (必要) – 所建立解決方案實體的命名類型。

    • Type (字串) (必要) – Type必須是 Solution@1.0

  • DetailsDocument (物件) (必要) – 請求的詳細資訊。

    • Name (字串) (必要) – 僅限賣方自己的參考的 AWS 資源名稱 (買方看不到)。長度上限:100 個字元。不得包含開頭或結尾空格、換行符號或控制字元。您也可以透過UpdateInformation變更類型更新解決方案圖磚。

    • Title (字串) (選用) – 解決方案的標題。長度上限:255 個字元。不得包含開頭或結尾空格、換行符號或控制字元。您也可以透過UpdateInformation變更類型來設定或更新解決方案標題。

回應語法

為您的請求建立變更集。回應為您提供 ChangeSetIdChangeSetArn

{ "ChangeSetId": "example123456789012abcdef", "ChangeSetArn": "arn:aws:aws-marketplace:us-east-1:123456789012:AWSMarketplace/ChangeSet/example123456789012abcdef" }

變更請求會新增至佇列並進行處理。您可以使用 AWS Marketplace 管理入口網站或 DescribeChangeSet API 操作來檢查狀態。

當請求成功完成時 (如果 StatusSUCCEEDED),會產生新的解決方案 ID。

非同步錯誤

CreateSolution 動作會傳回特定錯誤,以及常見的非同步錯誤。變更集完成處理DescribeChangeSet後,您會收到這些錯誤。若要了解如何取得變更請求狀態,請參閱使用變更集

錯誤碼 錯誤訊息
INVALID_NAME 解決方案名稱長度無效。輸入介於 1 到 100 個字元的名稱,然後再試一次。
MISSING_NAME 名稱值為必要項目。指定名稱值,然後再試一次。
INVALID_TITLE 解決方案標題長度無效。輸入介於 1 到 255 個字元之間的標題,然後再試一次。

更新解決方案資訊

如果您在 AWS Marketplace 中已有解決方案,您可以使用目錄 API 來更新解決方案資訊。

若要更新解決方案資訊,請使用UpdateInformation變更類型和更新後的詳細資訊呼叫 StartChangeSet API 操作。請參閱以下範例。

注意

UpdateInformation 變更類型的行為類似於頂層屬性的 HTTP PATCH 操作。如何更新欄位:

  • 如果最上層屬性存在於 中DetailsDocument,工作流程會驗證您的輸入並覆寫現有的值。

  • 如果最上層欄位不存在於 中DetailsDocument,則會保留現有的值。

  • 若要取消設定選用欄位,null請為該欄位傳送明確的 JSON。

AWS Marketplace 會驗證標誌和促銷媒體資產並將其擷取到 AWS Marketplace 擁有的位置。DescribeEntity 會傳回擷取檔案的可存取 URL,而不是來自 StartChangeSet 的原始輸入。若要查看原始提交URLs,請使用 DescribeChangeSet API。

注意

當您在Public解決方案上修改PromotionalMedia資產檔案 (透過提供新的 URLs) 時, UpdateInformation需要 AWS Marketplace Seller Operations 團隊手動檢閱。這會增加執行時間。在此案例中,請在自己的變更集中UpdateInformation分別使用 。

請求語法

POST /StartChangeSet HTTP/1.1 Content-type: application/json { "Catalog": "AWSMarketplace", "ChangeSet": [ { "ChangeType": "UpdateInformation", "Entity": { "Identifier": "soln-1234abcd", "Type": "Solution@1.0" }, "DetailsDocument": { "Name": "project_cold_harbor", "Title": "My Awesome Solution", "ShortDescription": "Solution value proposition", "LongDescription": "Detailed solution description explaining how this addresses customer needs", "LogoUrl": "https://s3.amazonaws.com/awsmp-logos/logo.jpg", "PromotionalMedia": [ { "Type": "Image", "Url": "https://s3.amazonaws.com/awsmp-media/image.jpg", "Title": "Sample image", "Description": "Sample image description" }, { "Type": "Video", "Url": "https://s3.amazonaws.com/awsmp-media/video.mp4", "Title": "Sample video", "PreviewUrl": "https://s3.amazonaws.com/awsmp-media/preview.png", "Description": "Sample video description" } ], "AdditionalResources": [ { "Text": "Troubleshooting guide", "Url": "https://example.com/troubleshooting" } ], "UseCases": [ { "Group": "advertising_and_marketing", "SubGroup": "ad_intelligence_and_measurement", "Item": "amazon_ads_insights", "Description": "Highlight description of this use case" } ] } } ] }

提供要新增UpdateInformation變更類型的欄位資訊:

  • Entity (物件) (必要) – 要更新的實體的命名類型。

    • Identifier (字串) (必要) – 解決方案 ID。

    • Type (字串) (必要) – 必須為 Solution@1.0

  • DetailsDocument (物件) (必要) – 請求的詳細資訊,包括您要為解決方案更新的資訊。每個欄位都是選用的,但您必須至少包含一個要更新的變更。

    • Name (字串) — 解決方案的資源名稱,僅透過目錄 API 讀取操作對賣方可見,買方不可見。長度上限:100 個字元。不得包含開頭或結尾空格、換行符號或控制字元。

    • Title (字串) – 要向買方顯示的解決方案標題。長度上限:255 個字元。不得包含開頭或結尾空格、換行符號或控制字元。

    • ShortDescription (字串) – 要向買方顯示之解決方案關鍵層面的值主張描述。這通常是 2-3 個句子。長度上限:1000 個字元。不得包含開頭或結尾空格或控制字元。

    • LongDescription (字串) – 要向買方顯示的此解決方案的較長描述。這通常是 1-3 個段落。長度上限:5000 個字元。不得包含開頭或結尾空格或控制字元。

    • LogoUrl (字串) – 可公開存取的 Amazon S3 儲存貯體中影像的 URL 或預先簽章的 S3 URL。必須是直接 S3 URL (而非 CloudFront 或 API Gateway 後方)。長度上限:2048 個字元。如需標誌規格,請參閱公司和產品標誌需求

    • PromotionalMedia (物件陣列) – 促銷影像和影片的清單。最多 15 個項目 (5 個影片和 10 個影像)。如需促銷媒體規格,請參閱使用促銷媒體增強您的 AWS Marketplace 產品

      • Type (字串) (必要) – ImageVideo

      • Url (字串) (必要) – 媒體檔案的 URL。必須是直接 S3 URL 或預先簽章的 S3 URL。長度上限:2048 個字元。必須是 https URL。

      • Title (字串) (必要) – 媒體的標題。長度上限:100 個字元。不得包含開頭或結尾空格、換行符號或控制字元。

      • Description (字串) (必要) – 媒體的描述。最大長度:200 個字元。不得包含開頭或結尾空格或控制字元。

      • PreviewUrl (字串) (選用) – 僅適用於影片的預覽影像 URL。長度上限:2048 個字元。必須是 https URL。

    • AdditionalResources (物件陣列) – 其他資源的參考清單。最多 8 個項目。

      • Text (字串) – 資源的名稱或標題。長度上限:500 個字元。不得包含開頭或結尾空格、換行符號或控制字元。

      • Url (字串) – 資源的 URL。長度上限:2048 個字元。必須是 https URL。

    • UseCases (物件陣列) – 此解決方案解決的使用案例清單。最多 3 個項目。如需有效的使用案例類別 (群組、SubGroup和項目的組合),請參閱使用案例類別清單以取得作用中接受的值及其簡介標籤。群組、SubGroup和項目的組合必須是使用案例類別清單中的有效項目。

      • Group (字串) – 產業或技術類別。必須是使用案例類別清單中的群組值之一。

      • SubGroup (字串) – 在 類別中使用案例群組。必須是使用案例類別清單中的其中一個 SubGroup 值。

      • Item (字串) – 特定使用案例。必須是使用案例類別清單中的其中一個項目值。

      • Description (字串) – 此解決方案如何處理使用案例的說明。長度上限:500 個字元。不得包含開頭或結尾空格或控制字元。

如需預先簽章的 URL 資訊,請參閱使用預先簽章URLs 共用物件

注意

呼叫 UpdateInformation 變更類型時,您可以隨時在 DetailsDocument 物件中提供要更新的欄位子集。不過,在將解決方案從 移至 Draft 之前Limited,必須正確設定下列欄位:TitleLongDescriptionShortDescriptionLogoUrl

不過,當您更新解決方案上的現有欄位時,您只能在變更類型的 DetailsDocument 物件中包含需要UpdateInformation變更的屬性。

回應語法

為您的請求建立變更集。對此請求的回應為您提供變更集ChangeSetIdChangeSetArn的 和 ,如下所示。

{ "ChangeSetId": "example123456789012abcdef", "ChangeSetArn": "arn:aws:aws-marketplace:us-east-1:123456789012:AWSMarketplace/ChangeSet/example123456789012abcdef" }

變更請求會新增至佇列並進行處理。若要檢查請求狀態,請使用 AWS Marketplace 管理入口網站或呼叫 DescribeChangeSet API。

使用針對Public解決方案修改的PromotionalMedia資產觸發此變更類型後,最多可能需要 37 天才能完成。這包括 AWS Marketplace 賣方操作團隊需要檢閱、稽核和核准的時間。

非同步錯誤

除了常見的非同步錯誤之外,下列錯誤專用於 AWS Marketplace Catalog API 中的UpdateInformation動作。當您在處理變更集DescribeChangeSet之後呼叫 時,會傳回這些錯誤。如需使用 DescribeChangeSet 取得變更請求狀態的詳細資訊,請參閱使用變更集

錯誤碼 錯誤訊息
INVALID_SHORT_DESCRIPTION 解決方案 ShortDescription 長度無效。輸入介於 1 到 1000 個字元之間的 ShortDescription,然後再試一次。
INVALID_LONG_DESCRIPTION 解決方案 LongDescription 長度無效。輸入介於 1 到 5000 個字元之間的 LongDescription,然後再試一次。
INVALID_NAME 解決方案名稱長度無效。輸入介於 1 到 100 個字元的名稱,然後再試一次。
INVALID_TITLE 解決方案標題長度無效。輸入介於 1 到 255 個字元之間的標題,然後再試一次。
INVALID_ADDITIONAL_RESOURCES 解決方案 AdditionalResources【%d】。文字長度無效。輸入介於 1 到 500 個字元之間的文字,然後再試一次。
INVALID_ADDITIONAL_RESOURCES 所提供的其他資源中的下列 URLs 無法存取:【%s】。提供有效且可存取URLs
INVALID_ADDITIONAL_RESOURCES 需要 Url 值。指定 Url 值,然後再試一次。
INVALID_ADDITIONAL_RESOURCES 文字無法遺失。提供文字
INVALID_USE_CASE 解決方案 UseCases【%d】。描述長度無效。輸入介於 1 到 500 個字元之間的描述,然後再試一次。
INVALID_USE_CASE UseCases【%d】。群組:提供的群組 (%s) 無效。提供有效的 群組。
INVALID_USE_CASE UseCases【%d】。SubGroup:提供的群組 (%s) 無效。提供有效的 SubGroup。
INVALID_USE_CASE UseCases【%d】。項目:提供的項目 (%s) 無效。提供有效的項目。
INVALID_USE_CASE UseCases【%d】。項目:提供的使用案例為非作用中。提供作用中的使用案例
INVALID_USE_CASE UseCases【%d】。群組:群組無法遺失。提供 群組。
INVALID_USE_CASE UseCases【%d】。SubGroup:SubGroup無法遺失。提供 SubGroup。
INVALID_USE_CASE UseCases【%d】。項目:無法遺失 SubGroup。提供項目。
INVALID_MEDIA 解決方案 PromotionalMedia【%d】。標題長度無效。輸入介於 1 到 100 個字元之間的標題,然後再試一次。
INVALID_MEDIA 解決方案 PromotionalMedia【%d】。描述長度無效。輸入介於 1 到 200 個字元之間的描述,然後再試一次。
INVALID_MEDIA 無效的 URL:%s 為存放在 S3 中的媒體提供新的 URL。
INVALID_MEDIA 無法存取媒體位置:%s 為存放在下列其中一個位置的媒體提供可存取的新 URL:【S3】。
INVALID_MEDIA 影像大小超過 %s。提供低於 %s 的影像。
INVALID_MEDIA 影片大小超過 %s。提供低於 %s 的影片。
INVALID_MEDIA 標誌大小超過 %s。提供低於 %s 的標誌。
INVALID_MEDIA 在 %s 中偵測到惡意軟體。提供不含惡意軟體的媒體。
INVALID_MEDIA 不適當的內容:偵測到 %s。提供沒有不適當內容的媒體
INVALID_MEDIA %s 中的明確內容:偵測到 '{ExplicitContent}'。提供沒有明確內容的媒體。
INVALID_MEDIA PromotionalMedia【%s】。Url:%s 不是支援的格式 (%s)。使用格式良好的影像,格式為支援的格式:【JPEG、PNG】。
INVALID_MEDIA PromotionalMedia【%s】。Url:%s 不是支援的格式 (%s)。以支援的格式使用格式良好的影片:【MP4、MOV】。
INVALID_MEDIA %s 的 LogoUrl 具有無效的長寬比。提供長寬比為 1:1 (平方) 或 2:1 (寬) 的影像。
INVALID_MEDIA 標誌:%s 具有無效的維度。提供介於 120x120 和 1080x1080 像素之間的影像。
INVALID_MEDIA PromotionalMedia【%d】。不支援類型。以支援的類型提供 PromotionalMedia:%s
DUPLICATE_MEDIA 偵測到重複的媒體:【%s】 提供沒有重複的媒體項目。
INVALID_MEDIA PromotionalMedia【%d】。Url:在 %s 中偵測到惡意軟體。提供不含惡意軟體的媒體。
TOO_MANY_ITEMS 提供不超過 %d 個 %s。

您可以使用目錄 API 來更新解決方案中包含的產品和服務,包括 AWS Marketplace 產品和非 AWS Marketplace 產品。

若要更新相關產品,請使用UpdateRelatedProducts變更類型呼叫 StartChangeSet API 操作,如下列範例所示。

注意

UpdateRelatedProducts 變更類型的行為類似於頂層屬性的 HTTP PATCH 操作。您可以如 AwsMarketplaceProducts 中提供所有目前的 AWS Marketplace 產品類型UpdateRelatedProducts

請求語法

POST /StartChangeSet HTTP/1.1 Content-type: application/json { "Catalog": "AWSMarketplace", "ChangeSet": [ { "ChangeType": "UpdateRelatedProducts", "Entity": { "Type": "Solution@1.0", "Identifier": "soln-123456" }, "DetailsDocument": { "IntegrationDescription": "How to use the products in this solution (usage guide)", "AwsMarketplaceProducts": [ { "ProductId": "prod-123" }, { "ProductId": "prod-456" } ], "NonAwsMarketplaceProducts": [ { "Type": "Hardware", "Title": "Diamond engine", "Description": "Hardware details", "Url": "https://example.com/hardware-product-specs.html" } ] } } ] }

提供要新增UpdateRelatedProducts變更類型的欄位資訊:

  • Entity (物件) (必要) – 要更新的實體的命名類型。

    • Identifier (字串) (必要) – 解決方案 ID。

    • Type (字串) (必要) – 必須為 Solution@1.0

  • DetailsDocument (物件) (必要) – 請求的詳細資訊。每個欄位都是選用的,但您必須至少包含一個要更新的變更。

    • IntegrationDescription (字串) – 描述產品如何在此解決方案中一起運作。長度上限:5000 個字元。不得包含開頭或結尾空格或控制字元。

    • AwsMarketplaceProducts (物件陣列) – 此解決方案中包含的 AWS Marketplace 產品。最多 5 個項目

      • ProductId (字串) – AWS Marketplace 產品 ID (UUID 或以 開頭的字串prod-)。長度上限:50 個字元。

    • NonAwsMarketplaceProducts (物件陣列) – 產品無法在 AWS Marketplace 上使用。最多 5 個項目。

      • Type (字串) (必要) – 產品的類型。可能的值:SoftwareConsultingHardwareCommunicationProfessional ServiceManaged ServiceValue-Added ResaleTraining

      • Title (字串) (必要) – 產品的標題。長度上限:255 個字元。不得包含開頭或結尾空格、換行符號或控制字元。

      • Description (字串) (選用) – 產品的描述。長度上限:220 個字元。不得包含開頭或結尾空格或控制字元。

      • Url (字串) (選用) – 產品詳細資訊的 URL。長度上限:2048 個字元。必須是 https URL。

回應語法

為您的請求建立變更集。對此請求的回應為您提供變更集ChangeSetIdChangeSetArn的 和 ,如下所示。

{ "ChangeSetId": "example123456789012abcdef", "ChangeSetArn": "arn:aws:aws-marketplace:us-east-1:123456789012:AWSMarketplace/ChangeSet/example123456789012abcdef" }

變更請求會新增至佇列並進行處理。

若要檢查請求狀態,請使用 AWS Marketplace 管理入口網站或呼叫 DescribeChangeSet API。

非同步錯誤

除了常見的非同步錯誤之外,下列錯誤專用於 AWS Marketplace Catalog API 中的UpdateRelatedProducts動作。當您在處理變更集DescribeChangeSet之後呼叫 時,會傳回這些錯誤。如需使用 DescribeChangeSet 取得變更請求狀態的詳細資訊,請參閱使用變更集

錯誤碼 錯誤訊息
INCOMPATIBLE_OPERATION_UPDATE_RELATED_PRODUCTS_SOLUTION 公有解決方案不支援更新相關產品的操作。若要進行此變更,請先將解決方案的可見性變更為有限,然後再試一次。
INVALID_AWS_MARKETPLACE_PRODUCTS 您的帳戶無法使用 AWS Marketplace 產品 '%s'。選擇您可以允許清單存取的公有產品或有限產品,或聯絡賣方請求存取。
INVALID_AWS_MARKETPLACE_PRODUCTS 不支援指定的產品類型 '%s'。提供下列其中一種有效的產品類型:【AmiProduct、SaaSProduct、ContainerProduct、MachineLearningProduct、ProfessionalServicesProduct、DataProduct】,然後再試一次。
INVALID_AWS_MARKETPLACE_PRODUCTS 找不到產品 '%s'。在相同的目錄中提供有效的產品 ID。
INVALID_NON_AWS_MARKETPLACE_PRODUCTS 無法存取指定的非 AWS Marketplace URLs:【%s】。請確認 URLs有效且可公開存取,然後再試一次。
INVALID_INTEGRATION_DESCRIPTION 提供解決方案 IntegrationDescription 介於 1 到 5000 個字元之間。
INVALID_NON_AWS_MARKETPLACE_PRODUCTS NonAwsMarketplaceProduct【%d】 解決方案。標題長度無效。輸入介於 1 到 255 個字元之間的描述,然後再試一次。
INVALID_NON_AWS_MARKETPLACE_PRODUCTS NonAwsMarketplaceProduct【%d】 解決方案。描述長度無效。輸入介於 1 到 220 個字元之間的描述,然後再試一次。
INVALID_NON_AWS_MARKETPLACE_PRODUCTS NonAwsMarketplaceProduct【%d】 解決方案。類型長度無效。輸入介於 1 到 50 個字元的類型,然後再試一次。
INVALID_NON_AWS_MARKETPLACE_PRODUCTS NonAwsMarketplaceProduct【%d】。類型 不是有效的非 AWS Marketplace 產品類型。提供下列其中一個非 AWS Marketplace 產品類型:【%s】
INVALID_NON_AWS_MARKETPLACE_PRODUCTS NonAwsMarketplaceProduct【%d】。標題值為必要項目。指定標題值,然後再試一次。
INVALID_NON_AWS_MARKETPLACE_PRODUCTS NonAwsMarketplaceProduct【%d】。類型值為必要。指定類型值,然後再試一次。
TOO_MANY_PRODUCTS 您可以連結的 AWS Marketplace 產品數量上限為 %d。在新增之前移除現有的連結產品。
TOO_MANY_PRODUCTS 您可以新增的 AWS Marketplace 產品數量上限為 %d。在新增 AWS Marketplace 產品之前,請先移除現有的無 AWS Marketplace 產品。
INVALID_AWS_MARKETPLACE_PRODUCTS 不允許重複的 AWS Marketplace 產品 IDs。每個產品 ID 在您的解決方案中必須是唯一的。
INVALID_REMOVE_OPERATION 無效操作,您無法移除所有產品。

發行解決方案

您可以使用目錄 API 將Draft解決方案發佈至 AWS Marketplace 中的Limited可見性。

ReleaseSolution 變更類型會驗證Limited解決方案的所有必要欄位都存在。然後,它會將解決方案從 Draft 移至Limited可見性。一旦解決方案處於Limited可見性,您就無法將其移回Draft可見性。

若要釋出解決方案,請使用ReleaseSolution變更類型呼叫 StartChangeSet API 操作,如下列範例所示。

請求語法

POST /StartChangeSet HTTP/1.1 Content-type: application/json { "Catalog": "AWSMarketplace", "ChangeSet": [ { "ChangeType": "ReleaseSolution", "Entity": { "Type": "Solution@1.0", "Identifier": "soln-1234abcd" }, "DetailsDocument": {} } ] }

提供要新增ReleaseSolution變更類型的欄位資訊:

  • Entity (物件) (必要) – 要釋放的實體的命名類型。

    • Identifier (字串) (必要) – 解決方案 ID。

    • Type (字串) (必要) – 必須為 Solution@1.0

  • DetailsDocument (物件) (必要) – 必須是空白物件。變更類型ReleaseSolution不接受任何詳細資訊。

回應語法

為您的請求建立變更集。對此請求的回應為您提供變更集ChangeSetIdChangeSetArn的 和 ,如下所示。

{ "ChangeSetId": "example123456789012abcdef", "ChangeSetArn": "arn:aws:aws-marketplace:us-east-1:123456789012:AWSMarketplace/ChangeSet/example123456789012abcdef" }

變更請求會新增至佇列並進行處理。您可以透過 AWS Marketplace 管理入口網站,或使用 API 操作直接透過目錄 DescribeChangeSet API 來檢查請求的狀態。

非同步錯誤

除了常見的非同步錯誤之外,下列錯誤是 AWS Marketplace Catalog API 中ReleaseSolution動作的特定錯誤。當您在處理變更集DescribeChangeSet之後呼叫 時,會傳回這些錯誤。如需使用 DescribeChangeSet 取得變更請求狀態的詳細資訊,請參閱使用變更集

錯誤碼 錯誤訊息
MISSING_REQUIRED_FIELDS 請求缺少必要的參數:【%s】。指定所有必要參數的值,然後再試一次。
INCOMPATIBLE_OPERATION_RELEASE_SOLUTION 變更類型只能在處於草稿狀態的解決方案上調用。將解決方案的可見性更新為草稿,然後再試一次。

更新買方參與選項

您可以使用目錄 API 來設定買方如何就您的解決方案與您互動。

注意

若要使用此變更類型,您必須在 APN Customer Engagements (ACE) 計劃中註冊作用中。您還必須將 AWS 帳戶與已註冊 ACE 的 AWS Partner Central 帳戶連結。如需說明,請參閱連結 AWS Partner Central 和 AWS 帳戶

若要更新買方參與選項,請使用UpdateBuyerEngagementOptions變更類型呼叫 StartChangeSet API 操作,如下列範例所示。

請求語法

POST /StartChangeSet HTTP/1.1 Content-type: application/json { "Catalog": "AWSMarketplace", "ChangeSet": [ { "ChangeType": "UpdateBuyerEngagementOptions", "Entity": { "Type": "Solution@1.0", "Identifier": "soln-1234abcd" }, "DetailsDocument": [ { "EngagementOption": "RequestProductDemo" }, { "EngagementOption": "RequestPrivateOffer" } ] } ] }

提供要新增UpdateBuyerEngagementOptions變更類型的欄位資訊:

  • Entity (物件) (必要) – 要更新的實體的命名類型。

    • Identifier (字串) (必要) – 解決方案 ID。

    • Type (字串) (必要) – 必須為 Solution@1.0

  • DetailsDocument (物件陣列) (必要) – 要啟用的買方參與選項。

    • EngagementOption (字串) (必要) – 參與選項的類型。有效值:RequestPrivateOfferRequestProductDemo

回應語法

為您的請求建立變更集。對此請求的回應為您提供變更集ChangeSetIdChangeSetArn的 和 ,如下所示。

{ "ChangeSetId": "example123456789012abcdef", "ChangeSetArn": "arn:aws:aws-marketplace:us-east-1:123456789012:AWSMarketplace/ChangeSet/example123456789012abcdef" }

變更請求會新增至佇列並進行處理。

若要檢查請求狀態,請使用 AWS Marketplace 管理入口網站或呼叫 DescribeChangeSet API。

非同步錯誤

除了常見的非同步錯誤之外,下列錯誤專用於 AWS Marketplace Catalog API 中的UpdateBuyerEngagementOptions動作。當您在處理變更集DescribeChangeSet之後呼叫 時,會傳回這些錯誤。如需使用 DescribeChangeSet 取得變更請求狀態的詳細資訊,請參閱使用變更集

錯誤碼 錯誤訊息
INELIGIBLE_SELLER ACE 資格驗證未完成。若要繼續:1) 將您的 AWS Marketplace 帳戶連結至您的 APN 帳戶,2) 完成 ACE 資格要求。

更新解決方案可見性

您可以使用目錄 API 來更新 AWS Marketplace 中解決方案的可見性。

您可以將目標可見性設定為 LimitedPublicRestricted

  • Limited – 解決方案已完成,且已成功完成ReleaseSolution變更類型。在此可見性中,您可以預覽解決方案的買方網站詳細資訊。在 AWS Marketplace 買方網站上,只有擁有的帳戶、解決方案中包含的每個 AWS Marketplace 產品的擁有者,以及 AWS Marketplace 賣方營運團隊可以看到解決方案。

  • Public – 解決方案在 AWS Marketplace 上可見。買方可以檢視解決方案並與之互動。

  • Restricted – AWS Marketplace 買方網站上不再公開解決方案。

注意

若要將解決方案移至Public可見性,您必須符合下列要求:

  • 您必須在 AWS Marketplace 上擁有公有設定檔。

  • 解決方案必須沒有非 Public產品。

  • 解決方案必須至少有 2 個 Public AWS Marketplace 產品。

  • 解決方案必須擁有來自相同 AWS 帳戶的至少 1 個 AWS Marketplace 產品。

  • 解決方案必須啟用RequestPrivateOffer買方參與選項。

  • AWS Marketplace Seller Operations 團隊會檢閱將解決方案移至Public可見性的所有請求。如需支援,請參閱取得 AWS Marketplace 的支援

當您將 TargetVisibility設定為 時PublicUpdateVisibility變更類型需要 AWS Marketplace Seller Operations 團隊手動檢閱。這會增加執行時間。在自己的變更集中UpdateVisibility分別使用 。

若要更新解決方案的可見性,請使用UpdateVisibility變更類型呼叫 StartChangeSet API 操作,如下列範例所示。

請求語法

對於 TargetVisibilityPublic或 的 Limited

POST /StartChangeSet HTTP/1.1 Content-type: application/json { "Catalog": "AWSMarketplace", "ChangeSet": [ { "ChangeType": "UpdateVisibility", "Entity": { "Type": "Solution@1.0", "Identifier": "soln-1234abcd" }, "DetailsDocument": { "TargetVisibility": "Public" } } ] }

對於 TargetVisibility為 的 Restricted

POST /StartChangeSet HTTP/1.1 Content-type: application/json { "Catalog": "AWSMarketplace", "ChangeSet": [ { "ChangeType": "UpdateVisibility", "Entity": { "Type": "Solution@1.0", "Identifier": "soln-1234abcd" }, "DetailsDocument": { "TargetVisibility": "Restricted" } } ] }

提供要新增UpdateVisibility變更類型的欄位資訊:

  • Entity (物件) (必要) – 要更新的實體的命名類型。

    • Identifier (字串) (必要) – 解決方案 ID。

    • Type (字串) (必要) – 必須為 Solution@1.0

  • DetailsDocument (物件) (必要) – 執行變更集所需的詳細資訊。

    • TargetVisibility (字串) (必要) – 解決方案的預期新可見性。可能的值:PublicLimitedRestricted

回應語法

為您的請求建立變更集。對此請求的回應為您提供變更集ChangeSetIdChangeSetArn的 和 ,如下所示。

{ "ChangeSetId": "example123456789012abcdef", "ChangeSetArn": "arn:aws:aws-marketplace:us-east-1:123456789012:AWSMarketplace/ChangeSet/example123456789012abcdef" }

變更請求會新增至佇列並進行處理。

您可以透過 AWS Marketplace 管理入口網站,或使用 API 操作直接透過目錄 DescribeChangeSet API 來檢查請求的狀態。

TargetVisibility觸發此變更類型後Public,最多可能需要 37 天才能完成。這包括 AWS Marketplace 賣方操作團隊需要檢閱、稽核和核准的時間。

非同步錯誤

下列錯誤專屬於 AWS Marketplace Catalog API 中的UpdateVisibility動作。當您在處理變更集DescribeChangeSet之後呼叫 時,會傳回這些錯誤。如需使用 DescribeChangeSet 取得變更請求狀態的詳細資訊,請參閱使用變更集

錯誤碼 錯誤訊息
INVALID_VISIBILITY_TRANSITION 解決方案無法移回草稿狀態。一旦發佈,解決方案只能在有限、公有和受限狀態之間轉換。
TOO_FEW_USE_CASES 至少需要一個使用案例,才能公開解決方案。新增使用案例,然後再試一次。
TOO_FEW_PUBLIC_PRODUCTS 至少需要 2 個公有 AWS Marketplace 產品才能公開解決方案。新增必要的產品,然後再試一次。
INCOMPATIBLE_PRODUCTS 解決方案包含一或多個非公有 AWS Marketplace 產品。若要公開解決方案,請移除所有非公開產品,然後再試一次。
TOO_FEW_SELF_OWNED_PRODUCTS 解決方案需要解決方案擁有者擁有的至少一個 AWS Marketplace 產品。從您的帳戶新增 AWS Marketplace 產品,然後再試一次。
INCOMPATIBLE_BUYER_ENGAGEMENT_OPTIONS 必須啟用 RequestPrivateOffer 買方參與選項,才能公開此解決方案。啟用 RequestPrivateOffer,然後再試一次。
INCOMPATIBLE_OPERATION_UPDATE_VISIBILITY 處於草稿狀態的解決方案不支援 UpdateVisibility。先使用 ReleaseSolution 將解決方案從 Draft 發佈至 Limited,然後使用 UpdateVisibility 變更為 Public 或 Restricted。
LIMIT_EXCEEDED_TOO_MANY_PUBLIC_SOLUTIONS 此帳戶已達到 5 個公有解決方案的限制。將現有的公有解決方案更新為有限或受限可見性,然後再試一次。
MISSING_SELLER_PROFILE_INFORMATION 公有賣方描述檔是公開解決方案的必要項目。在您的賣方帳戶中建立公有設定檔,然後再試一次。

常見的非同步錯誤代碼

有一些非同步驗證適用於所有解決方案變更類型,例如檢查 URL 有效性和不支援的字元,其錯誤碼和錯誤訊息列於此處。

提供的每個 URL 欄位都必須使用 HTTPS 通訊協定,並符合 RFC2396 或 RFC 2732 標準。

錯誤碼 錯誤訊息
INVALID_INPUT 無效的 '%s' 欄位。移除不支援的字元 %s。
INVALID_INPUT 在 %s 欄位中發現不適當的內容 '%s'。提供沒有不適當內容的 %s。
UNSUPPORTED_CATALOG 此變更類型不支援請求的目錄 %s。
INVALID_REMOVE_OPERATION 無效操作,您無法移除 %s
AUDIT_ERROR (根據 AWS Marketplace Seller Operations 團隊稽核結果而有所不同)

解決方案生命週期

解決方案會繼續進行下列可見性值:

  • Draft - 建立後的初始可見性。您可以使用其他變更類型逐步新增資訊。

  • Limited - 解決方案已完成,可供您和產品擁有者預覽。您可以使用 達成此目標ReleaseSolution

  • Public - 瀏覽 AWS Marketplace 網站的所有買方都可看見解決方案。這需要額外的驗證。

  • Restricted - 新買方無法再看到解決方案。

重要

一旦解決方案從 Draft 移至Limited可見性,您就無法將其移回 Draft。 在轉換為Limited可見性之前, 會ReleaseSolution驗證Limited解決方案的所有必要欄位都存在。

完整解決方案的最低需求

若要建立完整的解決方案並將其發佈到草稿狀態之外,您需要下列變更類型和屬性:

  • CreateSolution: Name

  • UpdateInformation: Title, ShortDescription, LongDescription, LogoUrl

  • UpdateRelatedProductsIntegrationDescription,跨 AwsMarketplaceProducts和 至少有一個項目 NonAwsMarketplaceProducts

  • ReleaseSolution

下列範例說明如何在單一變更集中建立Limited可見性的完整解決方案:

{ "Catalog": "AWSMarketplace", "ChangeSet": [ { "ChangeType": "CreateSolution", "Entity": { "Type": "Solution@1.0" }, "ChangeName": "CreateSolutionChange", "DetailsDocument": { "Name": "complete_solution_example", "Title": "Complete Solution Example" } }, { "ChangeType": "UpdateInformation", "Entity": { "Type": "Solution@1.0", "Identifier": "$CreateSolutionChange.Entity.Identifier" }, "ChangeName": "UpdateInformationChange", "DetailsDocument": { "ShortDescription": "A comprehensive solution for customer needs", "LongDescription": "This solution combines multiple products to address specific customer requirements in the advertising and marketing space.", "LogoUrl": "https://s3.amazonaws.com/awsmp-logos/solution-logo.jpg", "UseCases": [ { "Group": "advertising_and_marketing", "SubGroup": "ad_intelligence_and_measurement", "Item": "amazon_ads_insights", "Description": "Provides comprehensive advertising insights and measurement capabilities" } ] } }, { "ChangeType": "UpdateRelatedProducts", "Entity": { "Type": "Solution@1.0", "Identifier": "$CreateSolutionChange.Entity.Identifier" }, "ChangeName": "UpdateRelatedProductsChange", "DetailsDocument": { "AwsMarketplaceProducts": [ { "ProductId": "prod-123" } ], "IntegrationDescription": "These products work together to provide end-to-end advertising analytics and optimization capabilities." } }, { "ChangeType": "UpdateBuyerEngagementOptions", "Entity": { "Type": "Solution@1.0", "Identifier": "$CreateSolutionChange.Entity.Identifier" }, "ChangeName": "UpdateBuyerEngagementChange", "DetailsDocument": [ { "EngagementOption": "RequestPrivateOffer" } ] }, { "ChangeType": "ReleaseSolution", "Entity": { "Type": "Solution@1.0", "Identifier": "$CreateSolutionChange.Entity.Identifier" }, "ChangeName": "ReleaseSolutionChange", "DetailsDocument": {} } ] }

解決方案的 IAM 許可

AWS Marketplace Catalog API 使用標準 IAM 許可。如需詳細資訊,請參閱 AWS Marketplace Catalog API 的存取控制

您可以使用 AWSMarketplaceSellerProductFullAccess 執行透過 AWS 管理主控台中的目錄 API 和 Partner Central 3.0 存取解決方案所需的所有操作。

解決方案的 IAM 政策範例

下列範例 IAM 政策允許對Solution@1.0實體執行特定動作 (ListEntitiesDescribeEntityStartChangeSet)。您可以進一步縮小範圍,以限制委託人對特定實體 IDs 上特定變更類型的存取,或將其擴大為允許委託人也在目錄 API 支援的其他實體類型上操作。

{ "Statement": [ { "Effect": "Allow", "Action": [ "aws-marketplace:StartChangeSet" ], "Resource": [ "arn:aws:aws-marketplace:us-east-1:123456789012:AWSMarketplace/Solution/*", "arn:aws:aws-marketplace:us-east-1:123456789012:AWSMarketplace/ChangeSet/*" ], "Condition": { "StringEquals": { "catalog:ChangeType": [ "CreateSolution", "UpdateInformation", "UpdateRelatedProducts", "ReleaseSolution", "UpdateBuyerEngagementOptions", "UpdateVisibility" ] } } }, { "Effect": "Allow", "Action": [ "aws-marketplace:ListEntities", "aws-marketplace:DescribeEntity" ], "Resource": [ "arn:aws:aws-marketplace:us-east-1:123456789012:AWSMarketplace/Solution/*" ] }, { "Effect": "Allow", "Action": [ "aws-marketplace:DescribeChangeSet", "aws-marketplace:ListChangeSets", "aws-marketplace:CancelChangeSet" ], "Resource": [ "arn:aws:aws-marketplace:us-east-1:123456789012:AWSMarketplace/ChangeSet/*" ] }, { "Effect": "Allow", "Action": [ "aws-marketplace:TagResource", "aws-marketplace:UntagResource", "aws-marketplace:ListTagsForResource" ], "Resource": [ "arn:aws:aws-marketplace:us-east-1:123456789012:AWSMarketplace/Solution/*", "arn:aws:aws-marketplace:us-east-1:123456789012:AWSMarketplace/ChangeSet/*" ] } ] }

限制對特定解決方案的存取

您可以使用資源 ARN 中的解決方案 ID 來限制對特定解決方案的存取:

{ "Statement": [ { "Effect": "Allow", "Action": [ "aws-marketplace:DescribeEntity", "aws-marketplace:StartChangeSet" ], "Resource": [ "arn:aws:aws-marketplace:us-east-1:123456789012:AWSMarketplace/Solution/soln-specific123" ] } ] }

限制對特定變更類型的存取

您可以使用條件索引鍵限制對特定變更類型的存取:

{ "Statement": [ { "Effect": "Allow", "Action": [ "aws-marketplace:StartChangeSet" ], "Resource": [ "arn:aws:aws-marketplace:us-east-1:123456789012:AWSMarketplace/Solution/*" ], "Condition": { "StringEquals": { "catalog:ChangeType": [ "UpdateInformation", "UpdateRelatedProducts" ] } } } ] }