更新版本資訊

您可以使用 Catalog API 來更新機器學習產品現有版本的詳細資訊 AWS Marketplace。

重要

您無法更新版本的 ARN。如果您需要修改 ARN，則必須改為建立新的版本。

使用 StartChangeSet 新增版本：

• 若要更新版本資訊，請使用UpdateDeliveryOptions變更類型呼叫 StartChangeSet操作。

請求語法

POST /StartChangeSet HTTP/1.1
Content-type: application/json

{
  "Catalog": "AWSMarketplace",
  "ChangeSet":
  [
    {
      "ChangeType": "UpdateDeliveryOptions",
      "Entity":
      {
        "Identifier": "example1-abcd-1234-5ef6-7890abcdef12@1",
        "Type": "MachineLearningProduct@1.0"
      },
      "DetailsDocument":
      {
        "Version":
        {
          "ReleaseNotes": "Adding support for new parameters"
        },
        "DeliveryOptions":
        [
          {
            "Id": "example1-2222-cccc-2222-cccccccccccc",
            "Details":
            {
              "SagemakerModelPackageDeliveryOptionDetails":
              {
                "SampleNotebookUrl": "https://www.amazon.com",
                "RepositoryUrl":"https://www,amazon.com",
                "InputProperties": 
                { 
                    "SampleInput": {
                        "RealtimeInferenceUrl": "https://www.sampleData.com",
                        "BatchTranformUrl": "https://www.sampleData.com",
                     },
                 },
                 "RecommendedInstanceTypes": {
                        "BatchTransform": "ml.m4.large",
                        "RealtimeInference": "ml.m4.large"
                  }
            }
          }
        ]
      }
    }
  ]
}

必要欄位

• Entity （物件）—必要

  包含 ML 產品的相關資訊。

  • Identifier （字串）—必要

    您的產品 ID。如需詳細資訊，請參閱識別符。

  • Type （字串）—必要

    指定交付方法 （產品類型）。它必須是 MachineLearningProduct@1.0。

• DetailsDocument （物件）—必要

  包含更新的版本資訊。

  • Version （物件）—必要

    定義版本特定資訊。

    • VersionTitle （字串）—必要

      向買方顯示的版本識別符，例如「1.1 版」或「1.1 版」。買方使用此標題來選取要部署的版本。

    • ReleaseNotes （字串）—必要

      此版本的詳細備註，限制為 30，000 個字元。

  • DeliveryOptions （陣列）—必要

    指定產品版本的交付方法。每個版本僅限一個交付選項。

    • Id （字串）—必要

      DeliveryOption 的唯一識別符。在您的產品上使用 DescribeEntity 動作來擷取此項目。

    • Details （物件）—必要

      包含交付選項規格。

      • SageMakerModelPackageSubscriptionDetails 或 SageMakerAlgorithmSubscriptionDetails（物件） - 必要

        交付選項的詳細資訊。

        • SampleNotebookUrl （字串）—必要

          提供程式碼供買方使用的 Jupyter 筆記本連結範例。

        • RepositoryUrl （字串）—必要

          用於複製筆記本和範例資料的 Git 儲存庫 URL。

        • UsageInstructions （字串）—必要

          對於演算法：訓練資訊。對於模型：其他用量資訊。

        • InputProperties （物件）—必要

          模型/演算法輸入需求的詳細資訊。

          • Description （字串）—必要

            必要輸入的描述。

          • Limitations (string)

            任何輸入限制。

          • SampleInput （物件）—必要

            不同操作的範例輸入資料。

            • RealtimeInferenceUrl (string)

              即時推論的輸入 URL 範例。

            • RealtimeInferenceText (string)

              即時推論的輸入文字範例。

            • BatchTransformUrl (string)

              批次轉換任務的範例輸入 URL。

            • BatchTransformText (string)

              批次轉換任務的範例輸入文字。

          • Parameters (Array<Object>)

            每個輸入參數的詳細資訊。

            • Name （字串）—必要

              輸入參數的名稱。

            • Description （字串）—必要

              輸入參數的描述。

            • Constraints (string)

              參數限制條件 (MinValue、MaxValue、AllowedValues、MinLength、MaxLength、Mode 等）。

            • Required （布林值）

              指出是否需要 參數。預設為 false。

          • SageMakerCustomAttributes (Array<Object>)

            支援的 CustomAttributes 詳細資訊。

            • Name （字串）—必要

              自訂屬性的名稱。

            • Description （字串）—必要

              自訂屬性的描述。

            • Constraints (string)

              屬性限制條件 (MinValue、MaxValue、AllowedValues、MinLength、MaxLength、Mode 等）。

            • Required （布林值）

              指出是否需要 屬性。預設為 false。

        • OutputProperties （物件）—必要

          模型/演算法輸出的詳細資訊。

          • Description （字串）—必要

            模型/演算法輸出的說明。

          • SampleOutput (Array<Object>)—必要

            不同操作的範例輸出資料。

            • RealtimeInferenceUrl (string)

              即時推論的輸出 URL 範例。

            • RealtimeInferenceText (string)

              即時推論的輸出文字範例。

            • BatchTransformUrl (string)

              批次轉換任務的輸出 URL 範例。

            • BatchTransformText (string)

              批次轉換任務的輸出文字範例。

          • Parameters （陣列）

            每個輸出參數的詳細資訊。

            • Name （字串）—必要

              輸出參數的名稱。

            • Description （字串）—必要

              輸出參數的說明。

            • AlwaysReturned （布林值）

              指出是否一律傳回 參數。預設為 false。

        • RecommendedInstanceTypes （物件）—必要

          最佳效能的建議執行個體類型。

          • BatchTransform （字串）—必要

            批次轉換操作的建議執行個體類型。

          • RealtimeInference （字串）—必要

            即時推論操作的建議執行個體類型。

          • Training （字串）—必要

            演算法訓練操作的建議執行個體類型。僅適用於 SageMaker 演算法。

回應語法

成功的請求會傳回：

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

變更集處理

變更請求會進入處理佇列，其中會經歷幾個步驟：

1. 驗證：系統會檢查所有資訊是否符合 AWS Marketplace 準則。

   • 處理時間：幾分鐘到幾個小時

   • 如需驗證錯誤，請參閱變更集狀態和錯誤。

2. 狀態監控：您可以用兩種方式檢查請求的狀態。

   • 透過 AWS Marketplace 管理入口網站

   • 使用 DescribeChangeSet 操作

3. 完成：核准後，新版本會更新。

錯誤

非同步錯誤

變更集開始處理後，可以使用 DescribeChangeSet操作擷取UpdateDeliveryOptions動作的特定錯誤。如需錯誤詳細資訊和疑難排解，請參閱變更集狀態和錯誤。

錯誤碼	錯誤訊息
INCOMPATIBLE_PRODUCT_STATUS	使用現有的有限或公開產品。
INVALID_DELIVERY_OPTION_ID	提供可在產品中找到的交付選項 IDs。找不到 IDs：【x】
INCOMPATIBLE_DELIVERY_OPTION_STATUS	無法更新交付選項，因為它處於受限狀態。請改為嘗試新增版本。
INCOMPATIBLE_DELIVERY_OPTIONS	之前使用 【X 】 做為交付選項的產品，因此所有即將到來的交付選項都應該是 【X】 類型
INVALID_RECOMMENDED_INSTANCE_TYPE	提供 【X】 的現有可用執行個體類型 (X 可以是批次轉換、即時推論或ALgorithm訓練）
DUPLICATE_VERSION_TITLE	版本標題必須與此產品的任何其他版本標題不同。
FIELD_NOT_ALLOWED_TO_CHANGE	不允許變更欄位 X。