AWS Marketplace API リファレンスが再構築されました。サポートされている API オペレーションの詳細については、AWS Marketplace API リファレンスを参照してください。
翻訳は機械翻訳により提供されています。提供された翻訳内容と英語版の間で齟齬、不一致または矛盾がある場合、英語版が優先します。
新しいバージョンを追加する
Catalog API または AWS Marketplace Management Portal を使用して、機械学習製品に新しいバージョンを追加できます。ポータルの使用の詳細については、AWS Marketplace 販売者ガイドの「新しいバージョンの追加」を参照してください。
注記
ML 製品の場合、バージョンは 1 つの配信オプションで構成されます。これは、利用可能にする製品を表します。Catalog API では、ML 製品の配信オプションを使用して、製品のバージョンを効果的に変更します。
新しいインスタンスタイプを追加するときは、UpdatePricingTerms変更セットに変更タイプを含めて、新しいインスタンスタイプの料金を指定します。新製品の場合、 はサポートされているすべてのインスタンスタイプをカバーするUpdatePricingTerms必要があります。 UpdatePricingDimensionsは、サポートされているすべてのインスタンスタイプに対してディメンションが自動的に生成されるため、ML 製品では必須またはサポートされません。詳細については、料金設定ディメンションを更新する を参照してください。
StartChangeSet を使用してバージョンを追加する
新しいバージョンを追加するには、AddDeliveryOptions変更タイプを使用して StartChangeSetオペレーションを呼び出します。
-
バージョンを作成せずに API コールを検証するには、
Intentを に設定しますVALIDATE。 -
実際のバージョンを作成するには、
Intentを に設定しますAPPLY。
リクエストの構文
POST /StartChangeSet HTTP/1.1 Content-type: application/json { "Catalog": "AWSMarketplace", "ChangeSet": [{ "ChangeType": "AddDeliveryOptions", "Entity": { "Identifier": "example1-abcd-1234-5ef6-7890abcdef12@1", "Type": "MachineLearningProduct@1.0" }, "DetailsDocument": { "Version": { "VersionTitle": "version 1.1", "ReleaseNotes": "Patch update for small bugfix in version 1.0" }, "DeliveryOptions": [{ "Details": { "SageMakerAlgorithmDeliveryOptionDetails": { "SageMakerAlgorithmArn": "arn:aws:sagemaker:us-east-2:605142612156:algorithm/scikit-decision-trees-1552343220", "AccessRoleArn": "arn:aws:iam::12345678901:role/AwsMarketplaceSageMakerIngestion", "UsageInstructions":"This is how you use your algorithm", "SampleNotebookUrl": "https://www.amazon.com", "RepositoryUrl": "https://www,amazon.com", "InputProperties": { "Description": "Input should have all columns in the train/test file except for 'is_fraud' column.", "Limitations": "Can predict on 1 input in the CSV only at a time", "SampleInput": { "RealtimeInferenceText": "{\"prompt\":\"Write summary\", \"maxTokens\": 1 }", "BatchTransformUrl": "https://www.sampleData.com", }, "Parameters": [{ "Name": "prompt", "Description": "Represents the instruct-style prompt for the model. DataType is String", "Constraints": "Minimum length should be 1", "Required": true }, { "Name": "maxTokens", "Description": "Denotes the number of tokens to predict per generation. See BPE Tokens for more details.", "Constraints": "Minvalue: 1, MaxValue: 30" } ], "SageMakerCustomAttributes": [{ "Name": "threshold", "Description": "Threshold of the confidence score of the detected object", "Constraints": "Should be an Integer" }] }, "OutputProperties": { "Description": "The output is a JSON object that has the generated text along with likelihoods of tokens, if requested. See example json.", "SampleOutput": { "RealtimeInferenceUrl": "https://www.sampledata.com", "BatchTransformUrl": "https://www.sampleData.com", }, "Parameters": [{ "Name": "id", "Description": "An identifier for response" "AlwaysReturned": true }, { "Name": "generations", "Description": "The generated text along with the likelihoods for tokens requested.", } ], }, "RecommendedInstanceTypes": { "BatchTransform": "ml.m4.large", "RealtimeInference": "ml.m4.large", "Training": "ml.m4.large" } } }] } }], "Intent": "APPLY" }
必須フィールド
-
Entity(オブジェクト) — 必須ML 製品に関する情報が含まれています。
-
Identifier(文字列) — 必須製品 ID。詳細については、「識別子」を参照してください。
-
Type(文字列) — 必須配信方法 (製品タイプ) を指定します。これは
MachineLearningProduct@1.0である必要があります。
-
-
DetailsDocument(オブジェクト) — 必須製品の新しいバージョンに関するすべての詳細が含まれます。
-
Version(オブジェクト) — 必須追加するバージョンの詳細。
-
VersionTitle(文字列) — 必須「バージョン 1.1」や「1.1」などのバージョンのタイトル。購入者は、これらのタイトルからバージョンを選択します。
-
ReleaseNotes(文字列) — 必須このバージョンに関する詳細な注意事項。30,000 文字未満にする必要があります。
-
-
DeliveryOptions(配列) — 必須製品バージョンの配信方法の配列。バージョンごとに 1 つの配信オプションに制限されています。
-
Details(オブジェクト) — 必須-
SagemakerModelPackageDeliveryOptionDetailsまたはSageMakerAlgorithmDeliveryOptionDetails(オブジェクト)-
SageMakerModelPackageArnまたはSageMakerAlgorithmArn(文字列) — 必須モデルパッケージまたはアルゴリズムの Amazon リソースネーム (ARN)。
-
AccessRoleArn(文字列) — 必須AWS Marketplace が SageMaker リソースにアクセスするための IAM ロール ARN。
-
SampleNotebookUrl(文字列) — 必須使用コードを含むサンプル Jupyter Notebook へのリンク。詳細については、GitHub のサンプルノートブックテンプレート
を参照してください。 -
RepositoryUrl(文字列) — 必須ノートブックおよびサンプルデータアクセス用の Git リポジトリ URL。詳細については、GitHub のサンプル Git リポジトリ
を参照してください。 GitHub -
UsageInstructions(文字列) — 必須アルゴリズムのトレーニング情報またはモデルの使用に関する詳細。
-
InputProperties(オブジェクト) — 必須-
Description(文字列) — 必須モデル/アルゴリズム入力の説明
-
Limitations(文字列)入力制限
-
SampleInput(オブジェクト) — 必須RealtimeInferenceUrl (文字列) | RealtimeInferenceText (文字列) | BatchTransformUrl (文字列) | BatchTransformText (文字列)
-
Parameters(配列<Object>)名前 (文字列) - 必須 | 説明 (文字列) - 必須 | 制約 (文字列) | 必須 (ブール値)
-
SageMakerCustomAttributes(配列<Object>)モデルでサポートされている CustomAttributes について説明します。
Name(文字列) - 必須 |Description(文字列) - 必須 |Constraints(文字列) |Required(ブール値)
-
-
OutputProperties(オブジェクト) — 必須-
Description(文字列) — 必須 -
SampleOutput(配列<Object>) — 必須RealtimeInferenceUrl (文字列) | RealtimeInferenceText (文字列) | BatchTransformUrl (文字列) | BatchTransformText (文字列)
-
Parameters(配列)名前 (文字列) — 必須 | 説明 (文字列) — 必須 | AlwaysReturned (ブール値)
-
-
RecommendedInstanceTypes(オブジェクト) — 必須-
BatchTransform(文字列) - 必須 -
RealtimeInference(文字列) - 必須 -
Training(文字列) — SageMaker アルゴリズムにのみ必要です
-
-
-
-
-
レスポンスの構文
リクエストを送信すると、変更セットが作成され、API は以下を返します。
{ "ChangeSetId": "example123456789012abcdef", "ChangeSetArn": "arn:aws:aws-marketplace:us-east-1:123456789012:AWSMarketplace/ChangeSet/example123456789012abcdef" }
変更セット処理
変更リクエストは処理キューに入り、いくつかのステップを実行します。
-
検証: システムはすべての情報が AWS Marketplace ガイドラインを満たしていることを確認します。
-
処理時間: 数分から数時間
-
検証エラーについては、「Change set status and errors」を参照してください。
-
-
ステータスモニタリング: リクエストのステータスは 2 つの方法で確認できます。
-
AWS Marketplace 管理ポータル経由
-
DescribeChangeSet操作の使用
-
-
完了: 承認されると、新しいバージョンが追加されます。
エラー
非同期エラー
次のエラーは、 AWS Marketplace Catalog API の AddDeliveryOptionsアクションに固有です。これらのエラーは、変更セットの処理DescribeChangeSet中に を呼び出すと表示されます。DescribeChangeSet を使用して変更リクエストのステータスを確認する方法の詳細については、「変更セットの使用」を参照してください。
| エラーコード | エラーメッセージ |
|---|---|
| INCOMPATIBLE_PRODUCT_STATUS | 提供された製品が見つかりませんでした。有効な製品を指定してください。 |
| DUPLICATE_VERSION_TITLE | 指定されたバージョンタイトルは既に使用されています。一意のバージョンタイトルを作成します。 |
| INVALID_RECOMMENDED_INSTANCE_TYPE | [x] に有効なインスタンスタイプが指定されていません。有効なインスタンスタイプを入力して、もう一度試してください。有効なタイプ: [valids] |
| INCOMPATIBLE_DELIVERY_OPTIONS | 指定した配信オプションが、前の選択 [前の選択] と一致しません。配信オプションを更新して、もう一度試してください。 |
| INVALID_ASSET_ARN | SageMakerAlgorithmDeliveryOption に有効な ARN が指定されていません。有効な ARN を入力して、もう一度試してください。 |
| DUPLICATE_ASSET | この製品に一意の ARN を指定していません。一意の ARN を入力して、もう一度試してください。 |
| ASSET_NOT_FOUND | 指定した ARN が見つかりませんでした。ARN が正しく、必要なアクセス許可があることを確認します。 |
| ASSET_VALIDATION_EXCEPTION | SagemakerModelArn/SagemakerAlgorithmArn [x] を AWS Sagemaker アカウントに取り込めない |
| INVALID_ACCESS_ROLE | 指定した IAM ロール ARN が見つかりませんでした。ARN が正しいことを確認し、もう一度試してください。 |
| UPDATE_PRICING_REQUIRED | UpdatePricingTerms は必須です。 |