AWS Marketplace API リファレンスが再構築されました。サポートされている API オペレーションの詳細については、[AWS Marketplace API リファレンス](https://docs.aws.amazon.com/marketplace/latest/APIReference/Welcome.html)を参照してください。
翻訳は機械翻訳により提供されています。提供された翻訳内容と英語版の間で齟齬、不一致または矛盾がある場合、英語版が優先します。
# AWS MarketplaceAPIs を使用してコンテナベースの製品を操作する
AWS MarketplaceCatalog API を使用して、コンテナベースの製品を操作するタスクを自動化できます。
Catalog API を使用してコンテナベースの製品を作成する方法については、「」を参照してください[製品を作成する](work-with-seller-products.md#create-product)。
以下のトピックでは、 Catalog API を使用してコンテナベースの製品に対してアクションを実行する方法について説明します。
**Topics**
+ [新しいバージョンを追加する](#container-add-version)
+ [Amazon EKS アドオンの可視性を更新する](#update-delivery-option-visibility)
+ [リポジトリとリソースを作成する](#container-repos)
+ [バージョン情報を更新する](#container-update-version)
+ [バージョンを制限する](#container-restrict-version)
## 新しいバージョンを追加する
にコンテナベースの製品がすでにある場合はAWS Marketplace、 AWS Marketplace Catalog APIを使用して新しいバージョンを追加できます。そのためには、製品の一部であるコンテナイメージまたはアーティファクトAWS Marketplaceごとに にリポジトリを既に作成し、ローカル Docker および Helm ファイルからコピーできる必要があります。
**注記**
を使用してコンテナベースの製品を作成する方法の詳細についてはAWS Marketplace 管理ポータル、[「 Seller Guide」の「Getting started with container products](https://docs.aws.amazon.com/marketplace/latest/userguide/container-product-getting-started.html)」を参照してください。 *AWS Marketplace *
を使用してリポジトリを作成し、 Dockerおよび Helm ファイルをそれらのリポジトリに構築するなど、新しいバージョンを追加する方法の詳細についてはAWS Marketplace 管理ポータル、「 *AWS Marketplace販売者ガイド*」の[「製品の新しいバージョンを追加する](https://docs.aws.amazon.com/marketplace/latest/userguide/container-product-getting-started.html#container-add-version)」を参照してください。
新しいリポジトリをまだ作成していない場合は、Catalog API を使用して作成できます。「」を参照してください[リポジトリとリソースを作成する](#container-repos)。
新しいバージョンを追加するには、次の例に示すように、`AddDeliveryOptions`変更タイプを使用して `StartChangeSet` API オペレーションを呼び出します。
**注記**
コンテナベースの製品のバージョンは、1 つ以上の配信オプションで構成されます。たとえば、2 つの配信オプションがあり、1 つは noSQL データベースで動作し、もう 1 つは MySQL で動作します。これにより、ユーザーは製品の操作方法を選択できます。製品のバージョンを作成し、 を使用して 1 つのリクエストに複数の配信オプションを追加します`AddDeliveryOptions`。
**コンテナイメージ配信リクエストの構文**
```
POST /StartChangeSet HTTP/1.1
Content-type: application/json
{
"Catalog": "AWSMarketplace",
"ChangeSet":
[
{
"ChangeType": "AddDeliveryOptions",
"Entity":
{
"Identifier": "{{example1-abcd-1234-5ef6-7890abcdef12}}",
"Type": "ContainerProduct@1.0"
},
"DetailsDocument":
{
"Version":
{
"VersionTitle": "1.1",
"ReleaseNotes": "{{Minor bug fix}}"
},
"DeliveryOptions":
[
{
"DeliveryOptionTitle": "{{EKS Container image only delivery option}}",
"Details":
{
"EcrDeliveryOptionDetails":
{
"ContainerImages":
[
"{{111122223333}}.dkr.ecr.us-east-1.amazonaws.com/sellername/reponame1:1.1"
],
"DeploymentResources":
[
{
"Name": "HelmDeploymentTemplate",
"Url": "{{111122223333}}.dkr.ecr.us-east-1.amazonaws.com/sellername/reponame2:mychart1.1"
}
],
"CompatibleServices":
[
"EKS"
],
"Description": "Sample Description",
"UsageInstructions": "helm pull {{111122223333}}.dkr.ecr.us-east-1.amazonaws.com/sellername/reponame2:mychart1.1"
}
}
}
]
}
}
]
}
```
**Amazon Bedrock AgentCore ランタイム配信リクエスト構文**
```
POST /StartChangeSet HTTP/1.1
Content-type: application/json
{
"Catalog": "AWSMarketplace",
"ChangeSet":
[
{
"ChangeType": "AddDeliveryOptions",
"Entity":
{
"Identifier": "{{example1-abcd-1234-5ef6-7890abcdef12}}",
"Type": "ContainerProduct@1.0"
},
"DetailsDocument":
{
"Version":
{
"VersionTitle": "{{1.1}}",
"ReleaseNotes": "{{Minor bug fix}}"
},
"DeliveryOptions":
[
{
"DeliveryOptionTitle": "{{Amazon Bedrock AgentCore Runtime Delivery Option}}",
"Details":
{
"EcrDeliveryOptionDetails":
{
"ContainerImages":
[
"{{111122223333.dkr.ecr.us-east-1.amazonaws.com/sellername/reponame1:1.1}}"
],
"CompatibleServices":
[
"Bedrock-AgentCore"
],
"AgenticType":
[
"{{AGENT}}"
],
"Description": "{{Sample Description}}",
"UsageInstructions": "{{To launch and invoke this agent on Amazon Bedrock AgentCore Runtime}}",
"EnvironmentVariables":
[
{
"Name": "{{HTTP_PORT}}",
"Description": "{{Port of the server}}",
"DefaultValue": "{{8080}}"
},
{
"Name": "{{API_KEY}}",
"Description": "{{Provide your unique API key here.}}"
}
]
}
}
}
]
}
}
]
}
```
**Helm チャート配信リクエストの構文**
```
POST /StartChangeSet HTTP/1.1
Content-type: application/json
{
"Catalog": "AWSMarketplace",
"ChangeSet":
[
{
"ChangeType": "AddDeliveryOptions",
"Entity":
{
"Identifier": "{{example1-abcd-1234-5ef6-7890abcdef12}}",
"Type": "ContainerProduct@1.0"
},
"DetailsDocument":
{
"Version":
{
"VersionTitle": "1.1",
"ReleaseNotes": "{{Minor bug fix}}"
},
"DeliveryOptions":
[
{
"DeliveryOptionTitle": "{{HelmChartDeliveryOption}}",
"Details":
{
"HelmDeliveryOptionDetails":
{
"CompatibleServices":
[
"EKS",
"EKS-Anywhere"
],
"ContainerImages":
[
"{{111122223333}}.dkr.ecr.us-east-1.amazonaws.com/sellername/reponame1:1.1"
],
"HelmChartUri": "{{111122223333}}.dkr.ecr.us-east-1.amazonaws.com/sellername/reponame1:helmchart1.1",
"Description": "{{Helm chart description}}",
"UsageInstructions": "{{Usage instructions}}",
"MarketplaceServiceAccountName": "{{Service account name}}",
"ReleaseName": "{{Optional release name}}",
"Namespace": "{{Optional Kubernetes namespace}}",
"OverrideParameters":
[
{
"Key": "{{HelmKeyName1}}",
"DefaultValue": "${{{AWSMP_LICENSE_SECRET}}}"
},
{
"Key": "{{HelmKeyName2}}",
"DefaultValue": "${{{AWSMP_SERVICE_ACCOUNT}}}"
}
]
}
}
}
]
}
}
]
}
```
**Amazon EKS アドオン配信リクエストの構文**
```
POST /StartChangeSet HTTP/1.1
Content-type: application/json
{
"Catalog": "AWSMarketplace",
"ChangeSet": [
{
"ChangeType": "AddDeliveryOptions",
"Entity": {
"Type": "ContainerProduct@1.0",
"Identifier": "$CreateProductChange.Entity.Identifier"
},
"DetailsDocument": {
"Version": {
"VersionTitle": "1.1",
"ReleaseNotes": "{{New Add-on Release}}"
},
"DeliveryOptions": [
{
"DeliveryOptionTitle": "{{AWS Marketplace Test AddOn from CAPI 1}}",
"Visibility": "Limited",
"Details": {
"EksAddOnDeliveryOptionDetails": {
"ContainerImages": [
"{{111122223333}}.dkr.ecr.us-east-1.amazonaws.com/test-seller/canary-test-repo-product-6:mongo"
],
"HelmChartUri": "{{111122223333}}.dkr.ecr.us-east-1.amazonaws.com/rocket/rocket-product-helm:1.0",
"Description": "{{Description for delivery option provided by ISV}}",
"UsageInstructions": "{{Usage instructions with launch instructions}}",
"AddOnName": "{{aws-mp-test}}",
"AddOnVersion": "{{1.2.1}}",
"AddOnType": "networking",
"CompatibleKubernetesVersions": [
"1.25",
"1.26"
],
"SupportedArchitectures": [
"amd64",
"arm64"
],
"Namespace": "{{my-test-namespace}}",
"EnvironmentOverrideParameters": [
{
"Key": "cluster-name",
"Value": "${{{AWS_EKS_CLUSTER_NAME}}}"
},
{
"Key": "region-name",
"Value": "${{{AWS_REGION}}}"
}
]
}
}
}
]
},
"ChangeName": "{{PublishAddonNew}}"
}
]
}
```
`AddDeliveryOptions` 変更タイプを追加するフィールドの情報を入力します。
+ `Entity` (オブジェクト) (必須) – コンテナベースの製品。
+ `Identifier` (文字列) (必須) – 製品 ID。詳細については、「[識別子](catalog-apis.md#identifier)」を参照してください。
+ `Type` (文字列) (必須) – `Type`は、製品が使用する配信方法 (製品タイプ) に基づいています。 `ContainerProduct@1.0`
+ `DetailsDocument` (オブジェクト) (必須) – リクエストの詳細。追加するバージョンに関するすべての情報が含まれます。このフィールドは文字列フィールドです。
+ `Version` (オブジェクト) – 製品に追加するバージョンに関する詳細。
+ `VersionTitle` (文字列) – 作成するバージョンのタイトル。通常、これは **Version 1.1**または のようなバージョンの説明です**1.1**。購入者は、バージョンタイトルのリストからデプロイするバージョンを選択できます。
+ `ReleaseNotes` (文字列) – このバージョンに関する詳細な注意事項。30,000 文字未満にする必要があります。
+ `DeliveryOptions` (オブジェクトの配列) – 配信オプションの配列。各 は製品バージョンの配信方法です。例えば、Amazon Elastic Container Service (Amazon ECS) には 1 つの配信オプションがあり、Amazon Elastic Kubernetes Service (Amazon EKS) には 2 つの配信オプションが必要です。
+ `DeliveryOptionTitle` (文字列) – 購入者が配信オプションから選択するのに役立つ簡単な説明。
+ `Details` (オブジェクト) – この配信オプションに使用されるリソース。これは、詳細フィールド内の詳細フィールドです。このフィールドでは、二重のエスケープ文字は必要ありません。
+ `AddOnName – `購入者が Amazon EKS カタログに表示する一意のアドオン名。この名前は、後で を使用してプレフィックスを追加します`SellerAlias`。たとえば、 `isv-alias_`は ISV が提供するアドオン名です。
+ `AddOnType – `Amazon EKS からサポートされている値のリストから選択されたアドオンのタイプ: Gitops \| モニタリング \| ログ記録 \| 証明書管理 \| ポリシー管理 \| コスト管理 \| 自動スケーリング \| ストレージ \| kubernetes-management \| service-mesh \| etcd-backup \| ingress-service-type \| load-balancer \| local-registry\| networking \| Security \| backup \| ingress-controller \| observability
+ `AddOnVersion – `セマンティックバージョン。これにより、購入者はインストールまたはアップグレードする必要がある特定のバージョンの AddOn を選択できます。
+ `CompatibleKubernetesVersions` – このソフトウェアと互換性がある Amazon EKS Kubernetes バージョン。
+ `CompatibleServices` (文字列の配列) – リリースと互換性があるサービスの配列。有効なオプション: `ECS`、`EKS`、`ECS-Anywhere`、`EKS-Anywhere`、および `Bedrock-AgentCore`。
+ `ContainerImages` (文字列の配列) – このバージョンで使用されるコンテナイメージ URLsの配列。パスは、イメージをアップロードしたリポジトリであり、このバージョンで使用されるイメージのタグが付きます。リストには、以前のバージョンから変更されていないイメージも含め、必要なすべてのイメージを含める必要があります。Catalog API を使用してリポジトリを作成する方法については、次のセクションを参照してください。
+ `Description` (文字列) – 購入者に詳細を提供する配信オプションの長い説明。また、他の場所で提供されている詳細な手順へのリンクを含めることもできます。
+ `EcrDeliveryOptionDetails` – `AgenticType` – ランタイムエージェントのタイプ。有効なオプション: `AGENT`、`MCP_SERVER`、または `A2A_SERVER`。
+ `EcrDeliveryOptionDetails` – `EnvironmentVariables` – AgentCore ランタイムコンテナで必要であり、デプロイ時に購入者用に事前入力される環境変数のリスト。変数ごとに、コンテナで想定されている*名前*、*説明*、オプションの *defaultValue* をオブジェクトに指定します。一意の認証情報や API キーなどの変数の場合は、デフォルト値を指定しないでください。説明を使用して、変数の詳細と可能な値を指定できます。購入者が製品を起動すると、提供されたすべての変数にデフォルト値があらかじめ入力されます。
+ `EcrDeliveryOptionDetails – ``DeploymentResources (array of objects)` – Helmグラフなど、バージョンに必要な他のリソースの配列。各リソースには、それを記述`Name`する と、リソース`URL`を指す が含まれます。
+ `EnvironmentOverrideParameters – `アドオンで使用されるシステムパラメータのリスト。ISV が提供するAddOn (HelmChart) の一部では、Amazon EKS 実行環境の状態 (/システム情報) から派生した情報を含む設定が必要になる場合があります。たとえば、、 `EksClusterRegion` `EKSClusterName`などです。Amazon EKS AddOn の起動時にこれらの値を動的に置き換えることで、購入者からの追加のアクションを回避できます。Amazon EKS System は、アドオンのシステムパラメータの自動置換を既にサポートしています。AWS MarketplaceISV エクスペリエンスを拡張して、置換を必要とするこのパラメータを収集できます。
置換する一般的なシステム情報は、Helm置換と同様の規則に従ってAWS Marketplace指定された定数を指定することで示すことができます。サポートされる値は `${AWS_REGION}` と `${AWS_EKS_CLUSTER_NAME}` です。
```
"EnvironmentOverrideParameters" : [ {
"Key" : "my-field.region"
"Value" : "${{{AWS_REGION}}}"
},
{
"Key" : "my-second-field"
"Value" : "${{{AWS_EKS_CLUSTER_NAME}}}"
},
```
+ `HelmDeliveryOptionDetails` – `HelmChartUri (string)` – 購入者がソフトウェアを起動するためにインストールする Amazon ECR でホストされているHelmチャートへの URL。
+ `HelmDeliveryOptionDetails – ``MarketplaceServiceAccountName (string)` – *オプション * – Kubernetes サービスアカウントの名前。サービスアカウントは、 を呼び出すアクセス許可のために AWS Identity and Access Management(IAM) に接続するために使用されますAWS のサービス。
+ `HelmDeliveryOptionDetails – ``ReleaseName (string)` – *オプション * – 購入者がソフトウェアを起動するために使用する`helm install`コマンドに提供されるHelmリリースの名前。含まれていない場合、 Helmは自動的に生成されたリリース名を提供します。
+ `HelmDeliveryOptionDetails – ``Namespace (string)` – *オプション * – HelmチャートをインストールするKubernetes名前空間。
+ `HelmDeliveryOptionDetails – ``OverrideParameters (array of objects)` – アプリケーションを起動するHelmコマンドで使用されるパラメータ。購入者はデフォルト値を上書きできます。
**注記**
Amazon EKS Anywhere 製品の場合、ライセンスシークレットに少なくとも 1 つのオーバーライドパラメータを指定します。`DefaultValue` の を指定します`"${AWSMP_LICENSE_SECRET}"`。
有料製品の場合、サービスアカウント設定に少なくとも 1 つのオーバーライドパラメータを指定します。`DefaultValue` の を指定します`"${AWSMP_SERVICE_ACCOUNT}"`。
+ `Key` (文字列) – ドット表記 (override.example.key) の パラメータのキー。
+ `DefaultValue` (文字列) – このオーバーライドパラメータのデフォルト値。
+ `Namespace – `ISV が提供するアドオンインストール用の名前空間。
+ `SupportedArchitectures – `amd64 や arm64 など、サポートされているアーキテクチャのリスト。
+ `UsageInstructions` (文字列) – この配信オプションの使用に関する手順を提供します。最大 4,000 文字です。
**レスポンスの構文**
リクエストの変更セットが作成されます。このリクエストに対するレスポンスは、変更セット`ChangeSetArn`の `ChangeSetId`と を提供し、次のようになります。
```
{
"ChangeSetId": "{{example123456789012abcdef}}",
"ChangeSetArn": "arn:aws:aws-marketplace:{{us-east-1}}:{{123456789012}}:AWSMarketplace/ChangeSet/{{example123456789012abcdef}}"
}
```
変更リクエストはキューに追加され、コンテナイメージとその他の情報をスキャンして[AWS Marketplaceコンテナ製品のガイドラインを満たしていることを確認するなど、処理されます](https://docs.aws.amazon.com/marketplace/latest/userguide/container-product-policies.html)。コンテナの数とサイズによっては、このプロセスに数分から数時間かかる場合があります。
リクエストのステータスは、 を通じてAWS Marketplace 管理ポータル、または API オペレーションを使用して Catalog `[DescribeChangeSet](https://docs.aws.amazon.com/marketplace-catalog/latest/api-reference/API_DescribeChangeSet.html)` API から直接確認できます。
変更セットに関する詳細については、「[変更セットの使用](catalog-apis.md#working-with-change-sets)」を参照してください。販売者製品変更セットのエラーの詳細については、「」を参照してください[変更セットのステータスとエラー](work-with-seller-products.md#seller-product-change-set-errors)。
**非同期エラー**
以下のエラーは、 の`AddDeliveryOptions`アクションに固有のものですAWS Marketplace Catalog API。これらのエラーは、変更セットの処理`DescribeChangeSet`後に を呼び出すと返されます。`DescribeChangeSet` を使用して変更リクエストのステータスを取得する方法の詳細については、「」を参照してください[変更セットの使用](catalog-apis.md#working-with-change-sets)。
| エラーコード | エラーメッセージ |
| --- | --- |
| INCOMPATIBLE\_PRODUCT\_STATUS | 既存の制限付き製品またはパブリック製品を使用します。 |
| INCOMPATIBLE\_SERVICES | サービスリストに互換性のないサービスが含まれています。[incompatible\_services] 互換性のあるサービスの有効なリストを提供します。 |
| NO\_SERVICE\_SPECIFIED | 少なくとも 1 つの互換性のあるサービスを提供します。 |
| DUPLICATE\_COMPATIBLE\_AWS\_SERVICES | サービスリストには重複するエントリが含まれています。それらを削除します。各エントリは一意である必要があります。 |
| INVALID\_VERSION\_TITLE | 商標記号の前にスペースを削除します。 |
| INVALID\_VERSION\_TITLE | サポートされていない次の文字を削除します: [x, y, z] |
| INVALID\_VERSION\_TITLE | バージョンタイトルの先頭からスペースを削除します。 |
| INVALID\_VERSION\_TITLE | [x] 文字未満のバージョンタイトルを指定します。 |
| DUPLICATE\_VERSION\_TITLE | バージョンタイトル [duplicate\_version\_title] が重複しています。タイトルを削除または変更します。 |
| INVALID\_RELEASE\_NOTES | 商標記号の前にスペースを削除します。 |
| INVALID\_RELEASE\_NOTES | サポートされていない文字を削除する: [x, y, z] |
| INVALID\_RELEASE\_NOTES | リリースノートの先頭からスペースを削除します。 |
| INVALID\_RELEASE\_NOTES | (x) 文字未満のリリースノートを指定します。 |
| INVALID\_USAGE\_INSTRUCTIONS | 商標記号の前にスペースを削除します。 |
| INVALID\_USAGE\_INSTRUCTIONS | サポートされていない文字を削除する: [x, y, z] |
| INVALID\_USAGE\_INSTRUCTIONS | (x) 文字未満の使用手順を指定します。 |
| INVALID\_USAGE\_INSTRUCTIONS | 使用手順を指定します。 |
| MISSING\_CONTAINER\_IMAGES | コンテナイメージを少なくとも 1 つ指定します。 |
| NO\_LICENSE\_SECRET\_KEYS | Amazon EKS Anywhere 製品の場合、ライセンスシークレットに 1 つのオーバーライドパラメータを指定します。のニーズについては"${AWSMP\_LICENSE\_SECRET}"、DefaultValue「」セクションの例を参照してください。 |
| TOO\_MANY\_CONTAINER\_IMAGES | コンテナイメージの数は 50 未満です。 |
| DUPLICATE\_CONTAINER\_IMAGES | コンテナイメージリストには、重複したイメージ [duplicate\_images] が含まれています。一意のイメージのリストを指定します。 |
| INVALID\_CONTAINER\_IMAGES | コンテナイメージに有効な URI を指定します。 |
| INVALID\_CONTAINER\_IMAGE\_URI | イメージ [invalid\_image\_uri] はこの製品にアクセスできません。対応する製品リポジトリにイメージをアップロードします。アップロードの詳細については、[「コンテナ製品の開始方法](https://docs.aws.amazon.com/marketplace/latest/userguide/container-product-getting-started.html)」を参照してください。 |
| INVALID\_CONTAINER\_IMAGE\_TAG | 「最新」タグは使用しないでください。 |
| DUPLICATE\_DELIVERY\_OPTION\_TITLES | 配信オプションのタイトルが重複しています: [duplicate\_titles]。重複を削除する |
| INVALID\_DELIVERY\_OPTION\_TITLES | 配信オプションタイトル [existing\_titles] は既に存在します。別のタイトルを指定します。 |
| INVALID\_FULFILLMENT\_OPTION\_TITLE | (x) 文字未満の配信オプションタイトルを指定します。 |
| NO\_SERVICE\_ACCOUNT\_CONFIGURATION | 有料製品の場合は、サービスアカウント設定のオーバーライドパラメータを 1 つ指定します。のニーズについては"${AWSMP\_SERVICE\_ACCOUNT}"、DefaultValue「」セクションの例を参照してください。 |
| INVALID\_DETAILS | 指定された詳細は無効です。 |
| EMPTY\_RESOURCE\_NAME | リソース名を指定します。 |
| EMPTY\_RESOURCE\_URL | リソース URL を指定します。 |
| INVALID\_RESOURCE\_NAME | 256 文字未満のリソース名を指定します。 |
| INVALID\_RESOURCE\_URL | 256 文字未満のリソース URL を指定します。 |
| INVALID\_SHORT\_DESCRIPTION | 1,000 文字未満の短い説明を入力します。 |
| INVALID\_SHORT\_DESCRIPTION | 簡単な説明を入力します。 |
| SCAN\_ERROR | イメージ「[x]」のセキュリティ脆弱性「[y]」を修正しました。 |
| IMAGE\_NOT\_FOUND | パブリックイメージ URI [invalid\_image\_uri] が無効です。有効な URI を指定してください。 |
| INVALID\_ARN | イメージアクセスに有効な ARN を指定します。 |
| IMAGE\_INACCESSIBLE | イメージアクセスに有効な ARN を指定します。 |
| DUPLICATE\_ADDON\_NAME | 指定したAddOn名は、別の製品で既に使用されています。別の名前を指定します。 |
| DUPLICATE\_ADDON\_VERSION | アドオンバージョンタイトル [duplicate\_version\_title] は既に使用されています。別のタイトルを指定します。 |
| INVALID\_ADDON\_TYPE | アドオンタイプ [invalid\_types] が無効です。サポートされているリストからタイプを指定します: [eks\_addon\_do\_supported\_types]。 |
| INVALID\_KUBERNETES\_VERSION | Kubernetes バージョン [invalid\_versions] が無効です。サポートされているリストからバージョンを指定します: [eks\_addon\_do\_supported\_kubernetes\_versions]。 |
| DUPLICATE\_KUBERNETES\_VERSIONS | 重複する Kubernetes バージョン: [duplicate\_versions]。一意のバージョンのリストを指定します。 |
| INVALID\_ARCHITECTURE | アーキテクチャ [invalid\_architectures] が無効です。Amazon EKS でサポートされているアーキテクチャ : [eks\_addon\_do\_supported\_architectures] からアーキテクチャを提供します。 |
| DUPLICATE\_SUPPORTED\_ARCHITECTURES | 重複アーキテクチャ: [duplicate\_architectures]。サポートされている一意のアーキテクチャのリストを提供します。 |
| INVALID\_VISIBILITY\_STATE | 状態 [invalid\_states] は {EKS\_DO} 配信オプションでは無効です。次の許可された値から有効な可視性状態を指定します: 制限あり。 |
| INVALID\_ENVIRONMENT\_OVERRIDE\_PARAMETER\_VALUE | オーバーライドパラメータ値 [invalid\_values] が無効です。次のリストから有効な値を指定します: [eks\_addon\_do\_environment\_override\_parameter\_values]。 |
| DUPLICATE\_ENVIRONMENT\_OVERRIDE\_PARAMETER\_KEY | 環境オーバーライドパラメータに重複するキーが含まれています: [duplicate\_keys]。それらを削除します。 |
| TOO\_MANY\_EKS\_ADDON\_DELIVERY\_OPTIONS | バージョンに Amazon EKS アドオン配信オプションを 1 つだけ指定します。 |
| INCOMPATIBLE\_ADDON\_NAME | アドオン名 [provided\_name] が既存の名前と一致しません。このアドオンのパブリックバージョンまたは以前のバージョンから既存の名前を再利用します。各製品に使用できるアドオン名は 1 つだけです。 |
| INCOMPATIBLE\_ADDON\_TYPE | アドオンタイプ [provided\_type] が既存のタイプと一致しません。このアドオンのパブリックバージョンまたは以前のバージョンから既存のタイプを再利用します。製品ごとに 1 つのアドオン タイプのみを使用できます。 |
| INCOMPATIBLE\_ADDON\_NAMESPACE | アドオン名前空間 [provided\_namespace] が既存の名前空間 と一致しません 。このアドオンのパブリックバージョンまたは以前のバージョンから既存の 名前空間を再利用します。各製品に使用できるアドオン 名前空間は 1 つだけです。 |
| INVALID\_HELM\_C"\_URI | Helm チャート URI [invalid\_uri] が無効です。SemVer 2 形式で URI を指定します。 |
| INCOMPATIBLE\_HELM\_OBJECTS(INVALID\_HELM\_OBJECTS) | サポートされていないオブジェクト を使用せずにHelmグラフを指定します。 |
| INVALID\_DEPENDENT\_HELM\_CHARTS | 外部ソースではなく、親チャートディレクトリに直接次の依存グラフを含む Helm チャートを指定します: 。 |
| INVALID\_HELM\_SENSITIVE\_CONFIG | 機密情報やシークレットなしで高度な設定スキーマを提供します。キーワード: |
| INVALID\_HELM\_UNDECLARED\_IMAGES | リクエストの配信オプション内に次の Helm チャートイメージを指定します: 。 |
| INVALID\_HELM\_CHART\_IMAGES | AddRepositories 変更タイプを介して作成されたリポジトリ内のイメージを含む Helm チャートを指定します。外部イメージ: 。 |
| INVALID\_HELM\_LINT | Helm lint を正常に渡す Helm チャートを指定します。 |
| INVALID\_HELM\_TEMPLATE | Helm テンプレートを正常に渡す Helm チャートを指定します。 |
| INVALID\_HELM\_C" | 「 Seller AWS MarketplaceGuide」の「Helm Charts bulleted list」で特定されたAWS Marketplaceガイダンスに準拠した Helm チャートを提供します。 [https://docs.aws.amazon.com/marketplace/latest/userguide/container-product-policies.html](https://docs.aws.amazon.com/marketplace/latest/userguide/container-product-policies.html) |
| INVALID\_ADDON\_NAME | 次の正規表現パターンに従うAddOn名を指定します: xx |
| INVALID\_ADDON\_NAMESPACE | 名前空間値 [invalid\_namespaces] が無効です。名前空間は { EKS\_ADD\_ON\_NAMESPACE\_REGEX} 正規表現に従う必要があります。例えば、名前空間、名前空間テストなどです。 |
| INVALID\_ADDON\_NAME\_PATTERN | 文字または数字で始まるアドオン名と、文字、数字、ハイフンの組み合わせを指定します。例: test-addon、eksaddon |
| INVALID\_ADDON\_VERSION\_PATTERN | 「..」というパターンを使用してアドオンバージョンを指定します (例: 1.2.3、0.1.2、0.1.1)。 |
| EMPTY\_DELIVERY\_OPTION\_IDS | 配信オプション IDsのリストを指定します。 |
| INVALID\_DELIVERY\_OPTIONS\_INPUT | リストには、1 つ以上の無効な配信オプションが含まれています。有効なリストを指定し、各オプションに 1 つの配信方法があることを確認します。 |
| OVERRIDE\_PARAMETER\_KEYS\_CONTAINS\_SPECIAL\_CHARS | オーバーライドパラメータキー [invalid\_keys] に無効な文字が含まれています。キーは、文字、数字、二重引用符 ("")、プラス記号 (\+) のみを使用する必要があります。 |
| INVALID\_CONTAINER\_IMAGE\_REPOSITORY | リポジトリ [invalid\_repositories] が無効です。AddRepositories 変更タイプを使用して作成されたリポジトリを指定します。 |
| INVALID\_CONTAINER\_IMAGE\_TAG\_FORMAT | コンテナイメージタグ [invalid\_image\_tag] が無効です。{CONTAINER\_IMAGE\_TAG\_REGEX} 正規表現に準拠したタグを指定します。 |
| DUPLICATE\_OVERRIDE\_PARAMETER\_KEYS | オーバーライドパラメータには重複キー [duplicate\_keys] が含まれています。重複を削除します。 |
| サポートされていないコンテナイメージ URI | コンテナイメージ [unsupported\_image] はサポートされていません。Image [Manifest V 2、スキーマ 1 ](https://docker-docs.uclv.cu/registry/spec/manifest-v2-1/)に続くイメージを指定します。 |
| DUPLICATE\_REPOSITORY\_NAMES | リポジトリ名の重複: [duplicate\_repo\_names]。一意の名前を指定します。 |
| INVALID\_NAMESPACE | 名前空間値 [invalid\_namespaces] が無効です。{HELM\_RELEASE\_PARAM\_REGEX} 正規表現に準拠する値を指定します。 |
| INVALID\_RELEASE\_NAME | releaseName 値 [invalid\_release\_names] が無効です。{HELM\_RELEASE\_PARAM\_REGEX} 正規表現に準拠する値を指定します。 |
| OVERRIDE\_PARAMETER\_KEYS\_CONTAINS\_RESERVED\_PARAMETER\_KEYS | 配信オプションタイトル [invalid\_keys] のオーバーライドパラメータキーは予約されています。予約キー: [reserved\_param\_keys]。別のキーを指定します。 |
## Amazon EKS アドオンの可視性を更新する
Catalog API を使用して、 の製品バージョンの Amazon EKS アドオン配信オプションの可視性を更新できますAWS Marketplace。コンテナ製品のコンテナオプションとHelm配信オプションは、「公開」の可視性ステータスで自動的に作成されます。
**注記**
製品バージョンの可視性を更新する機能は、リストされているバージョンの Amazon EKS アドオン配信オプションでのみサポートされています。製品がまだ「Public」でない場合は、 を使用して「Public」の可視性ステータスの製品を公開するリクエストを送信しますAWS Marketplace 管理ポータル。
デフォルトでは、Amazon EKS アドオン配信オプションを使用してバージョンを作成すると、「制限済み」ステータスで公開されます。「制限済み」ステータスは、購入者が Amazon EKS クラスターで使用およびデプロイできる製品がすべてのリージョンで公開されていないことを意味します。API `StartChangeSet`オペレーションを変更`UpdateDeliveryOptionsVisibility`タイプで呼び出すことで、配信オプションの可視性を「制限」から「公開」に更新できます。Amazon EKS アドオン配信オプションに対応する製品バージョン`DeliveryOptions Id`から を指定します。
**リクエストの構文**
```
{
"Catalog": "AWSMarketplace",
"ChangeSet":
[
{
"ChangeType": "UpdateDeliveryOptionsVisibility",
"Entity":
{
"Identifier": "{{prod-example12345}}",
"Type": "ContainerProduct@1.0"
},
"DetailsDocument":
{
"DeliveryOptions":
[
{
"Id": "do-{{1234567891234567891234}}",
"TargetVisibility": "Public"
}
]
}
}
]
}
```
`UpdateDeliveryOptionsVisibility` 変更タイプを追加するには、次のフィールド の情報を入力します。
+ `Entity` (オブジェクト) (必須) – コンテナベースの製品。
+ `Identifier` (文字列) (必須) – 製品 ID。詳細については、「[識別子](catalog-apis.md#identifier)」を参照してください。
+ `Type` (文字列) (必須) – `Type`は、製品が使用する配信方法 (製品タイプ) に基づいています。 `ContainerProduct@1.0`
+ `DetailsDocument` (オブジェクト) (必須) – 作成するリポジトリに関する情報を含む、リクエストの詳細。以下のフィールドはすべて必須です。
+ `DeliveryOptions` (オブジェクトのリスト) – 各オブジェクトの詳細を含む`DeliveryOption`オブジェクトのリスト。
+ `Id` (文字列) – の一意の識別子`DeliveryOption`。( の一意の識別子を取得するには`DeliveryOption`、更新する製品の `DescribeEntity`アクションを呼び出します。
+ `TargetVisibility` – 製品の意図した新しい可視性。
**レスポンスの構文**
リクエストの変更セットが作成されます。このリクエストに対するレスポンスは、変更セット`ChangeSetArn`の `ChangeSetId`と を提供します。
```
{
"ChangeSetId": "{{example123456789012abcdef}}",
"ChangeSetArn": "arn:aws:aws-marketplace:{{us-east-1}}:{{123456789012}}:AWSMarketplace/ChangeSet/{{example123456789012abcdef}}"
}
```
変更リクエストはキューに追加され、処理されます。これには、コンテナ[AWS Marketplace製品のガイドライン](https://docs.aws.amazon.com/marketplace/latest/userguide/container-product-policies.html)を満たしていることを確認するためのコンテナイメージやその他の情報のスキャンが含まれます。コンテナの数とサイズによっては、このプロセスに数分から数時間かかる場合があります。
リクエストのステータスは、 を通じてAWS Marketplace 管理ポータル、または `[DescribeChangeSet](https://docs.aws.amazon.com/marketplace-catalog/latest/api-reference/API_DescribeChangeSet.html)` API オペレーションAWS Marketplace Catalog APIを使用して を通じて確認できます。
変更セットに関する詳細については、「[変更セットの使用](catalog-apis.md#working-with-change-sets)」を参照してください。販売者製品変更セットのエラーの詳細については、「」を参照してください[変更セットのステータスとエラー](work-with-seller-products.md#seller-product-change-set-errors)。
**非同期エラー**
次の表は、 の`AddDeliveryOptions`アクションに固有のエラーを示していますAWS Marketplace Catalog API。これらのエラーは、変更セットの処理`DescribeChangeSet`後に を呼び出すと返されます。`DescribeChangeSet` を使用して変更リクエストのステータスを取得する方法の詳細については、「」を参照してください[変更セットの使用](catalog-apis.md#working-with-change-sets)。
| エラーコード | エラーメッセージ |
| --- | --- |
| EMPTY\_DELIVERY\_OPTION\_IDS | 配信オプション IDsのリストを指定します。 |
| INVALID\_VISIBILITY\_STATE | 指定したTargetVisibilityオプションはサポートされていません。許可されたオプションでもう一度試してください。許可されるオプション (複数可) は次のとおりです。 Public |
| INVALID\_DELIVERY\_OPTION\_IDS | 無効な配信オプションの詳細を指定しました。製品にある配信オプション IDs を指定します。IDsが見つかりません: [x] |
| DUPLICATE\_DELIVERY\_OPTION\_IDS | 重複する配信オプション IDs: [duplicate\_ids]。一意の配信オプション IDs。 |
| AUDIT\_ERROR | Amazon EKS アドオンバージョン (複数可) の互換性のあるすべての Amazon EKS クラスターバージョンについて、独立系ソフトウェアベンダー (ISV) テストを完了していません。配信オプション (複数可) をリリースする前に、テストを完了する必要があります。 |
| INVALID\_DELIVERY\_OPTION\_TYPE | 指定した配信オプションタイプが無効です。配信オプションのタイプが であることを確認しEksAddOn、もう一度試してください。 |
| INCOMPATIBLE\_HELM\_OBJECTS | サポートされていないHelmオブジェクトのないHelmグラフを提供する: サポートされていないHelmオブジェクトは、すべてのリリースオブジェクト (.Name および .Namespace を除く）、Helmフック、ルックアップ関数です。 |
| INCOMPATIBLE\_ADDON\_NAME | アドオン名 [provided\_name] がパブリックバージョン名と一致しません。リリースする前にパブリック名を更新します。 |
| NCOMPATIBLE\_ADDON\_TYPE | アドオンタイプが一致しません。この製品のパブリックアドオンバージョンまたは以前のアドオンバージョンから既存のアドオンタイプを再利用します。製品ごとにサポートされるアドオンは 1 つだけです。 |
| INCOMPATIBLE\_ADDON\_NAMESPACE | 指定されたアドオン名前空間 [provided\_namespace] がパブリックバージョンの名前空間と一致しません。リリースする前にアドオン名前空間を更新します。 |
## リポジトリとリソースを作成する
コンテナベースの製品の新しいバージョンを作成するには、 AWS Marketplaceリポジトリで使用可能なバージョンのリソースが必要です。リポジトリを作成し、 Docker (および ) リソースをリポジトリにプッシュ (アップロードHelm) します。を使用してリポジトリを作成する方法についてはAWS Marketplace 管理ポータル、「 Seller *AWS MarketplaceGuide*」の[「Add a new version of your product](https://docs.aws.amazon.com/marketplace/latest/userguide/container-product-getting-started.html#container-add-version)」を参照してください。
新しいリポジトリを作成するには、次の例に示すように、`AddRepositories`変更タイプ`StartChangeSet`で を呼び出します。
**リクエストの構文**
```
POST /StartChangeSet HTTP/1.1
Content-type: application/json
{
"Catalog": "AWSMarketplace",
"ChangeSet":
[
{
"ChangeType": "AddRepositories",
"Entity":
{
"Identifier": "{{example1-abcd-1234-5ef6-7890abcdef12}}",
"Type": "ContainerProduct@1.0"
},
"DetailsDocument":
{
"Repositories":
[
{
"RepositoryName": "{{new-repo-1}}",
"RepositoryType": "ECR"
},
{
"RepositoryName": "{{new-repo-2}}",
"RepositoryType": "ECR"
}
]
}
}
]
}
```
`AddRepositories` 変更タイプを追加するフィールドの情報を入力します。
リポジトリの作成の詳細については、*AWS Marketplace「 Seller Guide*」の[「Adding a new version](https://docs.aws.amazon.com/marketplace/latest/userguide/ami-single-ami-products.html#single-ami-adding-version)」を参照してください。
+ `Entity` (オブジェクト) (必須) – コンテナベースの製品。
+ **識別子** (文字列) (必須) – 製品 ID。詳細については、「[識別子](catalog-apis.md#identifier)」を参照してください。
+ `Type` (文字列) (必須) – `Type`は、製品が使用する配信方法 (製品タイプ) に基づいています。 `ContainerProduct@1.0`
+ `DetailsDocument` (オブジェクト) (必須) – リクエストの詳細。これには、作成するリポジトリに関する情報が含まれます。含まれるフィールドはすべて必須です。
+ `Repositories` (構造の配列) – リポジトリオブジェクトのリスト。各リポジトリオブジェクトには名前とタイプが含まれます。
+ `RepositoryName` (文字列) – 作成するリポジトリの名前。
+ `RepositoryType` (文字列) – 作成するリポジトリのタイプ。許容されている値は `ECR` のみです。
**注記**
製品ごとに最大 70 個のリポジトリを持つことができますが、プッシュ時に異なるタグを付けることで、複数のリソースとバージョンのリソースを 1 つのリポジトリに追加できます。
1 つ以上のリポジトリを作成したら、リソースをリポジトリに追加します。リソースをリポジトリにプッシュする方法については、*Amazon Elastic Container Registry ユーザーガイド*の[「イメージのプッシュ](https://docs.aws.amazon.com/AmazonECR/latest/userguide/image-push.html)」を参照してください。いずれかのリポジトリに必要な特定のプッシュコマンドの詳細については、*AWS Marketplace「 Seller Guide*」の[「Adding a new version](https://docs.aws.amazon.com/marketplace/latest/userguide/ami-single-ami-products.html#single-ami-adding-version)」を参照してください。
**非同期エラー**
以下のエラーは、 の`AddRepositories`アクションに固有ですAWS Marketplace Catalog API。これらのエラーは、変更セットの処理`DescribeChangeSet`後に を呼び出すと返されます。`DescribeChangeSet` を使用して変更リクエストのステータスを取得する方法の詳細については、「」を参照してください[変更セットの使用](catalog-apis.md#working-with-change-sets)。
| エラーコード | エラーメッセージ |
| --- | --- |
| INVALID\_ECR\_REPOSITORY\_NAME | リポジトリ名を「nginx-web-app」の形式で指定します。 |
| DUPLICATE\_ECR\_REPOSITORY\_NAME | リポジトリ [duplicate\_repo\_names] は既に存在します。別の名前を選択します。 |
| MISSING\_REPOSITORY\_INFORMATION | リポジトリ名を少なくとも 1 つ指定します。 |
| INVALID\_ECR\_REPOSITORY\_NAME | 最大文字長 256 に達しました。文字長の数には、販売者の名前空間が含まれます。 |
## バージョン情報を更新する
Catalog API を使用して、 のコンテナベースの製品の既存のバージョンの詳細を更新できますAWS Marketplace。
**注記**
製品が公開されている場合、そのバージョンのバージョンタイトル、コンテナイメージ、配信オプションタイトル、またはデプロイリソースを更新することはできません。製品のこれらの側面を更新する必要がある場合は、代わりに新しいバージョンを作成します。
コンテナベースの製品の既存のバージョンを更新するには、次の例に示すように、`UpdateDeliveryOptions`変更タイプを使用して `StartChangeSet` API オペレーションを呼び出します。これにより、指定した配信オプションの詳細と、関連するバージョンが更新されます。少なくとも 1 つの配信オプションを含める必要があります。
**コンテナイメージ配信リクエストの構文**
```
POST /StartChangeSet HTTP/1.1
Content-type: application/json
{
"Catalog":"AWSMarketplace",
"ChangeSet":[
{
"ChangeType":"UpdateDeliveryOptions",
"Entity":{
"Identifier":"{{example1-abcd-1234-5ef6-7890abcdef12}}",
"Type":"ContainerProduct@1.0"
},
"DetailsDocument":{
"Version":{
"ReleaseNotes":"New release notes",
"VersionTitle":"Version 1.2"
},
"DeliveryOptions":[
{
"Id":"{{example4-2222-cccc-2222-cccccccccccc}}",
"Details":{
"EcrDeliveryOptionDetails":{
"DeliveryOptionTitle":"{{New Delivery Option Title}}",
"Description":"New description",
"UsageInstructions":"{{New usage instructions}}",
"CompatibleServices":[
"EKS"
]
}
}
}
]
}
}
]
}
```
**Helm チャート配信リクエストの構文**
```
POST /StartChangeSet HTTP/1.1
Content-type: application/json
{
"Catalog":"AWSMarketplace",
"ChangeSet":[
{
"ChangeType":"UpdateDeliveryOptions",
"Entity":{
"Identifier":"{{example1-abcd-1234-5ef6-7890abcdef12}}",
"Type":"ContainerProduct@1.0"
},
"DetailsDocument":{
"Version":{
"ReleaseNotes":"New release notes",
"VersionTitle":"Version 1.2"
},
"DeliveryOptions":[
{
"Id":"{{example5-2222-cccc-2222-cccccccccccc}}",
"Details":{
"HelmDeliveryOptionDetails":{
"DeliveryOptionTitle":"{{New Delivery Option Title}}",
"ContainerImages":[
"{{111122223333}}.dkr.ecr.us-east-1.amazonaws.com/sellername/imagename:1.0"
],
"HelmChartUri":"{{111122223333}}.dkr.ecr.us-east-1.amazonaws.com/sellername/helmname:1.0",
"CompatibleServices":[
"EKS-Anywhere"
],
"Description":"{{New description}}",
"UsageInstructions":"{{New usage instructions}}",
"MarketplaceServiceAccountName":"{{new-service-account-name}}",
"ReleaseName":"{{new-release-name}}",
"Namespace":"{{new-cluster-namespace}}",
"OverrideParameters":[
{
"Key":"new.parameter.key",
"DefaultValue":"{{New parameter default value}}"
}
]
}
}
}
]
}
}
]
}
```
**Amazon EKS アドオン配信リクエストの構文**
```
POST /StartChangeSet HTTP/1.1
Content-type: application/json
{
"Catalog":"AWSMarketplace",
"ChangeSet":[
{
"ChangeType":"UpdateDeliveryOptions",
"Entity":{
"Identifier":"{{example1-abcd-1234-5ef6-7890abcdef12}}",
"Type":"ContainerProduct@1.0"
},
"DetailsDocument":{
"Version":{
"ReleaseNotes":"{{New release notes}}",
"VersionTitle":"{{Version 1.2}}"
},
"DeliveryOptions":[
{
"Id":"{{example4-2222-cccc-2222-cccccccccccc}}",
"Details":{
"EksAddOnDeliveryOptionDetails":{
"ContainerImages":[
"{{709825985650}}.dkr.ecr.us-east-1.amazonaws.com/{{test-seller}}/{{canary-test-repo-product-6}}:mongo"
],
"Description":"{{Description for delivery option provided by ISV}}",
"UsageInstructions":"{{Usage instructions with launch instructions}}",
"HelmChartUri":"{{709825985650}}.dkr.ecr.us-east-1.amazonaws.com/{{rocket}}/{{rocket-product-helm}}:1.0",
"AddOnName":"{{aws-mp-test}}",
"AddOnVersion":"{{1.2.1}}",
"AddOnType":"networking",
"CompatibleKubernetesVersions":[
"1.19",
"1.20"
],
"SupportedArchitectures":[
"amd64",
"arm64"
],
"Namespace":"{{my-test-namespace}}",
"EnvironmentOverrideParameters":[
{
"Key":"my-field",
"Value":"${{{AWS_EKS_CLUSTER_NAME}}}"
}
]
}
}
}
]
}
}
]
}
```
`UpdateDeliveryOptions` 変更タイプを追加するフィールドの情報を入力します。
これらのフィールドの詳細については、*AWS Marketplace「 Seller Guide*」の[「Adding a new version](https://docs.aws.amazon.com/marketplace/latest/userguide/ami-single-ami-products.html#single-ami-adding-version)」を参照してください。
+ `Entity` (オブジェクト) (必須) – コンテナベースの製品。
+ `Identifier` (文字列) (必須) – 製品 ID。詳細については、「[識別子](catalog-apis.md#identifier)」を参照してください。
+ `Type` (文字列) (必須) – `Type`は、製品が使用する配信方法 (製品タイプ) に基づいています。 `ContainerProduct@1.0`
+ `DetailsDocument` (オブジェクト) (必須) – リクエストの詳細。これには、更新するコンテナベースの製品のバージョンに関する情報が含まれます。含まれるフィールドはすべてオプションですが、更新するには少なくとも 1 つのフィールドを含める必要があります。
+ `Version` (オブジェクト) – ソフトウェアバージョンに関する詳細。
+ `VersionTitle` (文字列) – 作成するバージョンのタイトル。通常、これは **Version 1.1**や単に など、バージョンの説明です**1.1**。購入者は、すべてのバージョンタイトルのリストからデプロイするバージョンを選択できます。
製品がすでに公開されている場合は、このプロパティを更新できません。
+ `ReleaseNotes` (文字列) – あるバージョンから次のバージョンへの変更について購入者に伝えるためのメモ。
+ `DeliveryOptions` (オブジェクトのリスト) – 各オブジェクトの詳細を含む`DeliveryOption`オブジェクトのリスト。
+ `Id` (文字列) – の一意の識別子 `DeliveryOption` (更新する製品の `DescribeEntity`アクションを呼び出す`DeliveryOption`ことで、 の一意の識別子を取得できます）。
+ `Details` (オブジェクト) – 配信オプションの詳細を保持します。このネストされた詳細オブジェクトは、二重エスケープ*する必要はありません*。
+ `EcrDeliveryOptionDetails` (オブジェクト) – コンテナイメージ配信オプションの詳細。
+ `DeliveryOptionTitle` (文字列) – 購入者が配信オプションから選択できるようにする簡単な説明。
製品がすでに公開されている場合は、このプロパティを更新できません。
+ `ContainerImages` (文字列の配列) – このバージョンで使用されるコンテナイメージ URLsの配列。パスは、イメージをアップロードしたリポジトリであり、このバージョンで使用されるイメージのタグが付きます。このフィールドが含まれている場合、リストには、変更されていないイメージであっても、必要なすべてのイメージが含まれている必要があります。
製品がすでに公開されている場合は、このプロパティを更新できません。
+ `DeploymentResources` (オブジェクトの配列) – Helmグラフや他のドキュメントへのリンクなど、バージョンに必要な他のデプロイリソースの配列。各リソースには、それを記述する名前と、リソースを指す URL が含まれます。バージョンの起動ページで、リンクのリストとして表示されます。
製品がすでに公開されている場合は、このプロパティを更新できません。
+ `Name` (文字列) – 購入者に表示されるハイパーリンクのテキスト。
+ `Url` (文字列) – 購入者に表示されるハイパーリンクの URL。
+ `CompatibleServices` (文字列の配列) – リリースと互換性があるサービスの配列。有効なオプション: `ECS`、`EKS`、`ECS-Anywhere`、`EKS-Anywhere`、および `Bedrock-AgentCore`。
+ `AgenticType` ランタイムエージェントのタイプ。有効なオプション: `AGENT`、`MCP_SERVER`、または `A2A_SERVER`。
+ `Description` (文字列) – 購入者に詳細を提供する配信オプションの長い説明。他の場所でホストされている他の手順へのリンクを含めることもできます。
+ `UsageInstructions` (文字列) – 製品をデプロイして使用する方法の手順を提供します。他の場所でホストされている使用手順へのリンクを追加することもできます。最大 4,000 文字です。
+ `EnvironmentVariables` – AgentCore ランタイムコンテナで必要であり、デプロイ時に購入者に事前入力される環境変数のリスト。変数ごとに、コンテナで想定されている*名前*、*説明*、オプションの *defaultValue* をオブジェクトに指定します。一意の認証情報や API キーなどの変数の場合は、デフォルト値を指定しないでください。説明を使用して、変数の詳細と可能な値を指定できます。購入者が製品を起動すると、提供されたすべての変数にデフォルト値があらかじめ入力されます。
+ `Id` (文字列) – の一意の識別子 `DeliveryOption` (更新する製品の `DescribeEntity`アクションを呼び出す`DeliveryOption`ことで、 の一意の識別子を取得できます）。
+ `Details` (オブジェクト) – 配信オプションの詳細を保持します。このネストされた詳細オブジェクトは、二重エスケープ*する必要はありません*。
+ `HelmDeliveryOptionDetails` (オブジェクト) – Helmチャート配信オプションの詳細。
+ `DeliveryOptionTitle` (文字列) – 購入者が配信オプションから選択できるようにする簡単な説明。
製品がすでに公開されている場合は、このプロパティを更新できません。
+ `ContainerImages` (文字列の配列) – このバージョンで使用されるコンテナイメージ URLsの配列。パスは、イメージをアップロードしたリポジトリであり、このバージョンで使用されるイメージのタグが付きます。リストには、以前のバージョンから変更されていないイメージも含め、必要なすべてのイメージを含める必要があります。Catalog API を使用してリポジトリを作成する方法については、次のセクションを参照してください。
+ `HelmChartUri` (文字列) – 購入者がソフトウェアを起動するためにインストールする Amazon ECR でホストされているHelmチャートへの URL。
+ `CompatibleServices` (文字列の配列) – リリースと互換性があるサービスの配列。有効なオプションは、`ECS` と `EKS` です。
+ `Description` (文字列) – 購入者に詳細を提供する配信オプションの長い説明。また、他の場所で提供されている詳細な手順へのリンクを含めることもできます。
+ `UsageInstructions` (文字列) – この配信オプションの使用に関する手順を提供します。最大 4,000 文字です。
+ `MarketplaceServiceAccountName` (文字列) – Kubernetesサービスアカウントの名前。サービスアカウントは、サービスを呼び出すAWSアクセス許可AWS Identity and Access Managementのために に接続するために使用されます。
+ `ReleaseName` (文字列) – 購入者がソフトウェアを起動するために使用する `helm install` コマンドに提供されたHelmリリースの名前。
+ `Namespace` (文字列) – HelmチャートをインストールするKubernetes名前空間。
+ `OverrideParameters` (オブジェクトの配列) – アプリケーションを起動するHelmコマンドで使用されるパラメータ。購入者はデフォルト値を上書きできます。
+ `Key` (文字列) – ドット表記 (override.example.key) の パラメータのキー。
+ `DefaultValue` (文字列) – このオーバーライドパラメータのデフォルト値。
**レスポンスの構文**
リクエストの変更セットが作成されます。このリクエストに対するレスポンスは、変更セット`ChangeSetArn`の `ChangeSetId`と を提供し、次のようになります。
```
{
"ChangeSetId": "{{example123456789012abcdef}}",
"ChangeSetArn": "arn:aws:aws-marketplace:{{us-east-1}}:{{123456789012}}:AWSMarketplace/ChangeSet/{{example123456789012abcdef}}"
}
```
変更リクエストはキューに追加され、コンテナイメージとその他の情報をスキャンして[AWS Marketplaceコンテナ製品のガイドラインを満たしていることを確認するなど、処理されます](https://docs.aws.amazon.com/marketplace/latest/userguide/container-product-policies.html)。コンテナの数とサイズによっては、このプロセスに数分から数時間かかる場合があります。
リクエストのステータスは、 を通じてAWS Marketplace 管理ポータル、または API オペレーションを使用して Catalog `[DescribeChangeSet](https://docs.aws.amazon.com/marketplace-catalog/latest/api-reference/API_DescribeChangeSet.html)` API から直接確認できます。
変更セットに関する詳細については、「[変更セットの使用](catalog-apis.md#working-with-change-sets)」を参照してください。販売者製品変更セットのエラーの詳細については、「」を参照してください[変更セットのステータスとエラー](work-with-seller-products.md#seller-product-change-set-errors)。
**非同期エラー**
以下のエラーは、 の`UpdateDeliveryOptions`アクションに固有のものですAWS Marketplace Catalog API。これらのエラーは、変更セットの処理`DescribeChangeSet`後に を呼び出すと返されます。`DescribeChangeSet` を使用して変更リクエストのステータスを取得する方法の詳細については、「」を参照してください[変更セットの使用](catalog-apis.md#working-with-change-sets)。
| エラーコード | エラーメッセージ |
| --- | --- |
| INCOMPATIBLE\_PRODUCT\_STATUS | 既存の制限付き製品またはパブリック製品を使用します。 |
| INCOMPATIBLE\_SERVICES | サービスリストに互換性のないサービスが含まれています。[incompatible\_services] 互換性のあるサービスの有効なリストを提供します。 |
| NO\_SERVICE\_SPECIFIED | 少なくとも 1 つの互換性のあるサービスを提供します。 |
| DUPLICATE\_COMPATIBLE\_AWS\_SERVICES | サービスリストには重複するエントリが含まれています。それらを削除します。各エントリは一意である必要があります。 |
| INVALID\_VERSION\_TITLE | 商標記号の前にスペースを削除します。 |
| INVALID\_VERSION\_TITLE | サポートされていない次の文字を削除します: [x, y, z] |
| INVALID\_VERSION\_TITLE | バージョンタイトルの先頭からスペースを削除します。 |
| INVALID\_VERSION\_TITLE | [x] 文字未満のバージョンタイトルを指定します。 |
| DUPLICATE\_VERSION\_TITLE | バージョンタイトル [duplicate\_version\_title] が重複しています。タイトルを削除または変更します。 |
| INVALID\_RELEASE\_NOTES | 商標記号の前にスペースを削除します。 |
| INVALID\_RELEASE\_NOTES | サポートされていない文字を削除する: [x, y, z] |
| INVALID\_RELEASE\_NOTES | リリースノートの先頭からスペースを削除します。 |
| INVALID\_RELEASE\_NOTES | (x) 文字未満のリリースノートを指定します。 |
| INVALID\_USAGE\_INSTRUCTIONS | 商標記号の前にスペースを削除します。 |
| INVALID\_USAGE\_INSTRUCTIONS | サポートされていない文字を削除する: [x, y, z] |
| INVALID\_USAGE\_INSTRUCTIONS | (x) 文字未満の使用手順を指定します。 |
| INVALID\_USAGE\_INSTRUCTIONS | 使用手順を指定します。 |
| MISSING\_CONTAINER\_IMAGES | コンテナイメージを少なくとも 1 つ指定します。 |
| TOO\_MANY\_CONTAINER\_IMAGES | コンテナイメージの数は 50 未満です。 |
| DUPLICATE\_CONTAINER\_IMAGES | コンテナイメージリストには、重複したイメージ [duplicate\_images] が含まれています。一意のイメージのリストを指定します。 |
| INVALID\_CONTAINER\_IMAGES | コンテナイメージに有効な URI を指定します。 |
| INVALID\_CONTAINER\_IMAGE\_URI | イメージ [invalid\_image\_uri] はこの製品にアクセスできません。対応する製品リポジトリにイメージをアップロードします。アップロードの詳細については、[「コンテナ製品の開始方法](https://docs.aws.amazon.com/marketplace/latest/userguide/container-product-getting-started.html)」を参照してください。 |
| INVALID\_CONTAINER\_IMAGE\_TAG | 「最新」タグは使用しないでください。 |
| MISSING\_DELIVERY\_OPTION\_IDS | 既存の ID リストから配信オプションを指定します。 |
| EMPTY\_DELIVERY\_OPTION\_IDS | 配信オプション IDs の空でないリストを指定します。 |
| DUPLICATE\_DELIVERY\_OPTION\_IDS | 重複する配信オプション IDs: [duplicate\_ids]。一意の配信オプション IDs。 |
| DUPLICATE\_DELIVERY\_OPTION\_TITLES | 配信オプションのタイトルが重複しています: [duplicate\_titles]。重複を削除する |
| INVALID\_DELIVERY\_OPTION\_TITLES | 配信オプションタイトル [existing\_titles] は既に存在します。別のタイトルを指定します。 |
| INVALID\_FULFILLMENT\_OPTION\_TITLE | (x) 文字未満の配信オプションタイトルを指定します。 |
| EMPTY\_RESOURCE\_NAME | リソース名を指定します。 |
| EMPTY\_RESOURCE\_URL | リソース URL を指定します。 |
| INVALID\_RESOURCE\_NAME | 256 文字未満のリソース名を指定します。 |
| INVALID\_RESOURCE\_URL | 256 文字未満のリソース URL を指定します。 |
| INVALID\_SHORT\_DESCRIPTION | 1,000 文字未満の短い説明を入力します。 |
| INVALID\_SHORT\_DESCRIPTION | 簡単な説明を入力します。 |
| NO\_LICENSE\_SECRET\_KEYS | Amazon EKS Anywhere 製品の場合、ライセンスシークレットに 1 つのオーバーライドパラメータを指定します。のニーズについては"${AWSMP\_LICENSE\_SECRET}"、 DefaultValue「」セクションの例を参照してください。 |
| NO\_SERVICE\_ACCOUNT\_CONFIGURATION | 有料製品の場合は、サービスアカウント設定のオーバーライドパラメータを 1 つ指定します。のニーズについては"${AWSMP\_SERVICE\_ACCOUNT}"、DefaultValue「」セクションの例を参照してください。 |
| SCAN\_ERROR | イメージ「[x]」のセキュリティ脆弱性「[y]」を修正しました。 |
| FIELD\_NOT\_ALLOWED\_TO\_CHANGE | フィールド [x] は変更できません。 |
| INVALID\_DELIVERY\_OPTIONS\_STATUS | 配信オプション IDs [invalid\_ids] が無効です。制限付きまたはパブリック状態の配信オプションを指定します。 |
| NO\_CHANGE\_FOUND | 少なくとも 1 つの変更を指定します。 |
| MULTIPLE\_VERSION\_UPDATE | 同じバージョンの配信オプション IDs。 |
| OVERRIDE\_PARAMETER\_KEYS\_CONTAINS\_SPECIAL\_CHARS | オーバーライドパラメータキー [invalid\_keys] に無効な文字が含まれています。キーは、文字、数字、二重引用符 ("")、プラス記号 (\+) のみを使用する必要があります。 |
| INVALID\_CONTAINER\_IMAGE\_REPOSITORY | リポジトリ [invalid\_repositories] が無効です。AddRepositories 変更タイプを使用して作成されたリポジトリを指定します。 |
| INVALID\_CONTAINER\_IMAGE\_TAG\_FORMAT | コンテナイメージタグ [invalid\_image\_tag] が無効です。{CONTAINER\_IMAGE\_TAG\_REGEX} 正規表現に準拠したタグを指定します。 |
| DUPLICATE\_OVERRIDE\_PARAMETER\_KEYS | オーバーライドパラメータには重複キー [duplicate\_keys] が含まれています。重複を削除します。 |
| サポートされていないコンテナイメージ URI | コンテナイメージ [unsupported\_image] はサポートされていません。Image [Manifest V 2、スキーマ 1 ](https://docker-docs.uclv.cu/registry/spec/manifest-v2-1/)に続くイメージを指定します。 |
| INVALID\_NAMESPACE | 名前空間値 [invalid\_namespaces] が無効です。{HELM\_RELEASE\_PARAM\_REGEX} 正規表現に準拠する値を指定します。 |
| INVALID\_RELEASE\_NAME | releaseName 値 [invalid\_release\_names] が無効です。{HELM\_RELEASE\_PARAM\_REGEX} 正規表現に準拠する値を指定します。 |
| OVERRIDE\_PARAMETER\_KEYS\_CONTAINS\_RESERVED\_PARAMETER\_KEYS | 配信オプションタイトル [invalid\_keys] のオーバーライドパラメータキーは予約されています。予約キー: [reserved\_param\_keys]。別のキーを指定します。 |
| INCOMPATIBLE\_ADDON\_NAME | アドオン名 [provided\_name] が既存の名前と一致しません。このアドオンのパブリックバージョンまたは以前のバージョンから既存の名前を再利用します。各製品に使用できるアドオン名は 1 つだけです。 |
| INCOMPATIBLE\_ADDON\_NAMESPACE | アドオン名前空間 [provided\_namespace] が既存の名前空間 と一致しません 。このアドオンのパブリックバージョンまたは以前のバージョンから既存の 名前空間を再利用します。各製品に使用できるアドオン 名前空間は 1 つだけです。 |
## バージョンを制限する
Catalog API を使用して、コンテナベースの製品のバージョンを制限できますAWS Marketplace。これにより、新しい購入者がそのバージョンを使用できなくなります。製品には、少なくとも 1 つのパブリックに利用可能なバージョンが必要です。製品の公開されている唯一のバージョンを制限することはできません。
バージョンを制限するには、次の例に示すように、`RestrictDeliveryOptions`変更タイプを使用して `StartChangeSet` API オペレーションを呼び出します。
**注記**
バージョンから 1 つ以上の配信オプションを制限すると、購入者がこれらのオプションを使用できなくなります。バージョンのすべての配信オプションを制限すると、そのバージョンがAWS Marketplaceカタログから削除されます。
Amazon EKS アドオンの制限は、現在 Catalog API ではサポートされていません。
制限付きバージョンは、既存のお客様に引き続きご利用いただけます。
**リクエストの構文**
```
POST /StartChangeSet HTTP/1.1
Content-type: application/json
{
"Catalog": "AWSMarketplace",
"ChangeSet":
[
{
"ChangeType": "RestrictDeliveryOptions",
"Entity":
{
"Identifier": "{{example1-abcd-1234-5ef6-7890abcdef12}}",
"Type": "ContainerProduct@1.0"
},
"DetailsDocument":
{
"DeliveryOptionIds":
[
"{{example1-2222-cccc-2222-cccccccccccc}}"
]
}
}
]
}
```
`RestrictDeliveryOptions` 変更タイプを追加するフィールドの情報を入力します。
+ `Entity` (オブジェクト) (必須) – コンテナベースの製品。
+ `Identifier` (文字列) (必須) – 製品 ID。詳細については、「[識別子](catalog-apis.md#identifier)」を参照してください。
+ `Type` (文字列) (必須) – `Type`は、製品が使用する配信方法 (製品タイプ) に基づいています。 `ContainerProduct@1.0`
+ `DetailsDocument` (オブジェクト) (必須) – リクエストの詳細。これには、制限するコンテナベースの製品の配信オプションの IDs が含まれます。
+ `DeliveryOptionIds` (文字列の配列) – 制限するバージョンの `DeliveryOption` IDs のリスト。制限する製品に対して `DescribeEntity`アクションを呼び出す`DeliveryOption`ことで、 の一意の識別子を取得できます。
**レスポンスの構文**
リクエストの変更セットが作成されます。このリクエストに対するレスポンスは、変更セット`ChangeSetArn`の `ChangeSetId`と を提供し、次のようになります。
```
{
"ChangeSetId": "{{example123456789012abcdef}}",
"ChangeSetArn": "arn:aws:aws-marketplace:{{us-east-1}}:{{123456789012}}:AWSMarketplace/ChangeSet/{{example123456789012abcdef}}"
}
```
変更リクエストがキューに追加され、処理されます。このプロセスには数分から数時間かかる場合があります。
リクエストのステータスは、 を通じてAWS Marketplace 管理ポータル、または API オペレーションを使用して Catalog `[DescribeChangeSet](https://docs.aws.amazon.com/marketplace-catalog/latest/api-reference/API_DescribeChangeSet.html)` API から直接確認できます。
変更セットに関する詳細については、「[変更セットの使用](catalog-apis.md#working-with-change-sets)」を参照してください。販売者製品変更セットのエラーの詳細については、「」を参照してください[変更セットのステータスとエラー](work-with-seller-products.md#seller-product-change-set-errors)。
**非同期エラー**
以下のエラーは、 の`RestrictDeliveryOptions`アクションに固有のものですAWS Marketplace Catalog API。これらのエラーは、変更セットの処理`DescribeChangeSet`後に を呼び出すと返されます。`DescribeChangeSet` を使用して変更リクエストのステータスを取得する方法の詳細については、「」を参照してください[変更セットの使用](catalog-apis.md#working-with-change-sets)。
| エラーコード | エラーメッセージ |
| --- | --- |
| INCOMPATIBLE\_PRODUCT\_STATUS | パブリック製品を使用します。 |
| MISSING\_DELIVERY\_OPTION\_IDS | 既存の IDs リストから配信オプションを指定します。 |
| INVALID\_DELIVERY\_OPTIONS\_STATUS | 配信オプション IDs [invalid\_ids] が無効です。パブリック状態で配信オプションを指定します。 |
| EMPTY\_DELIVERY\_OPTION\_IDS | 配信オプション IDs の空でないリストを指定します。 |
| INVALID\_MINIMUM\_PUBLIC\_DELIVERY\_OPTIONS | すべての配信オプション IDsを制限することはできません。 |
| DUPLICATE\_DELIVERY\_OPTION\_IDS | 重複する配信オプション IDs: [duplicate\_ids]。一意の配信オプション IDs。 |