View a markdown version of this page

更新版本信息 - AWS Marketplace
请求语法必填字段响应语法错误

AWS Marketplace API 参考已重组。有关支持的 API 操作的更多信息，请参阅 AWS Marketplace API 参考。

本文属于机器翻译版本。若本译文内容与英语原文存在差异，则一律以英文原文为准。

更新版本信息

您可以在中使用目录 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（对象）-必填

    包含有关您的机器学习产品的信息。

    • Identifier（字符串）-必填

      您的产品编号。有关更多信息，请参阅标识符。

    • 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（对象）-必填

            的输入要求 model/algorithm的详细信息。

            • Description（字符串）-必填

              所需输入的描述。

            • Limitations（字符串）

              任何输入限制。

            • SampleInput（对象）-必填

              不同操作的输入数据示例。

              • RealtimeInferenceUrl（字符串）

                用于实时推理的示例输入 URL。

              • RealtimeInferenceText（字符串）

                用于实时推理的示例输入文本。

              • BatchTransformUrl（字符串）

                批量转换作业的输入 URL 示例。

              • BatchTransformText（字符串）

                批量转换作业的输入文本示例。

            • Parameters（数组<Object>）

              每个输入参数的详细信息。

              • Name（字符串）-必填

                输入参数的名称。

              • Description（字符串）-必填

                输入参数的描述。

              • Constraints（字符串）

                参数约束（MinValue、 MaxValue、 AllowedValues、 MinLength、 MaxLength、Pattern 等）。

              • Required（布尔值）

                表示该参数是否为必填项。默认设置为“false”。

            • SageMakerCustomAttributes（数组<Object>）

              支持的详细信息 CustomAttributes。

              • Name（字符串）-必填

                自定义属性的名称。

              • Description（字符串）-必填

                自定义属性的描述。

              • Constraints（字符串）

                属性约束（MinValue MaxValue、 AllowedValues MinLength、 MaxLength、、、模式等）。

              • Required（布尔值）

                表示该属性是否为必填项。默认设置为“false”。

          • OutputProperties（对象）-必填

            的输 model/algorithm出的详细信息。

            • Description（字符串）-必填

              model/algorithm产出描述。

            • SampleOutput（数组<Object>）-必填

              不同操作的输出数据示例。

              • RealtimeInferenceUrl（字符串）

                用于实时推理的输出网址示例。

              • RealtimeInferenceText（字符串）

                用于实时推理的示例输出文本。

              • BatchTransformUrl（字符串）

                批量转换作业的输出网址示例。

              • BatchTransformText（字符串）

                批量转换作业的输出文本示例。

            • 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有关错误详情和疑难解答，请参阅更改集合状态和错误。

错误代码 错误消息
不兼容产品状态 使用现有的限量产品或公共产品。
无效的配送选项_ID 提供可在产品中找到的配送选项编号。找不到身份证：[x]
不兼容配送选项状态 无法更新配送选项，因为它处于受限状态。改为尝试添加新版本。
不兼容的配送选项 商品之前使用 [X] 作为配送选项，因此所有即将推出的配送选项都应为 [X]
无效_推荐_实例_类型 为 [X] 提供现有可用的实例类型（X 可以是 Batch Transform、Realtime Inference 或算法训练）
重复版本标题 版本标题必须与本产品的任何其他版本标题不同。
字段_不允许_更改 不允许更改字段 X。