AWS Marketplace API リファレンスが再構築されました。サポートされている API オペレーションの詳細については、[AWS Marketplace API リファレンス](https://docs.aws.amazon.com/marketplace/latest/APIReference/Welcome.html)を参照してください。
翻訳は機械翻訳により提供されています。提供された翻訳内容と英語版の間で齟齬、不一致または矛盾がある場合、英語版が優先します。
# AMI ベースの製品を使用する
を使用して AWS Marketplace Catalog API 、Amazon マシンイメージ (AMI) ベースの製品を操作するためのタスクを自動化できます。
Catalog API を使用して AMI ベースの製品を作成する方法については、「」を参照してください[製品を作成する](work-with-seller-products.md#create-product)。
以下のトピックでは、 Catalog API を使用して AMI ベースの製品に対してアクションを実行する方法について説明します。
**Topics**
+ [新しいバージョンを追加する](#ami-add-version)
+ [バージョン情報を更新する](#ami-update-version)
+ [バージョンを制限する](#ami-restrict-version)
+ [今後の AWS リージョン サポートの更新](#update-future-region-support)
+ [サポートされている を追加する AWS リージョン](#add-regions)
+ [の制限 AWS リージョン](#restrict-regions)
+ [新しいインスタンスタイプを追加する](#add-instance-types)
+ [インスタンスタイプの制限](#restrict-instance-types)
## 新しいバージョンを追加する
Catalog API を使用して、既存の AMI ベースの製品に新しいバージョンを追加できます AWS Marketplace。を使用して製品に新しい AMI バージョンを追加する方法の詳細については AWS Marketplace 管理ポータル、「 *AWS Marketplace 販売者ガイド*[」の「新しいバージョンの追加](https://docs.aws.amazon.com/marketplace/latest/userguide/ami-single-ami-products.html#single-ami-adding-version)」を参照してください。
AWS Marketplace への新しい AMI の追加を含むリクエストを作成する場合、AMI を AWS Marketplace システムにコピーし、セキュリティ上の問題がないかスキャンする必要があります。AMI でアクションを実行するアクセス許可を持つ AWS Identity and Access Management (IAM) ロールを作成して、AWS Marketplace に AMI へのアクセスを許可する必要があります。必要なアクセス許可の詳細については、「 Seller *AWS Marketplace Guide*」の「[Giving AWS Marktplace access to your AMI](https://docs.aws.amazon.com/marketplace/latest/userguide/single-ami-marketplace-ami-access.html)」を参照してください。
新しいバージョンを追加するには、次の例に示すように、AMI ベースの製品の`AddDeliveryOptions`変更タイプを使用して `StartChangeSet` API オペレーションを呼び出します。実際に新しいバージョンを作成せずに API コールをテストするには、 `Intent`パラメータを に設定します`VALIDATE`。詳細については、[「インテント](https://docs.aws.amazon.com/marketplace-catalog/latest/api-reference/API_StartChangeSet.html#API_StartChangeSet_RequestBody)」を参照してください。
**注記**
AMI 製品の場合、バージョンは 1 つ以上の配信オプションで構成されます。同じバージョンのすべての配信オプションには、同じ詳細を持つ同じ`AmiSource`オブジェクトが必要です。バージョンの作成時に、すべての配信オプションをバージョンに追加する必要があります。既存のバージョンに配信オプションを追加することはできません。
**リクエストの構文**
```
POST /StartChangeSet HTTP/1.1
Content-type: application/json
{
"Catalog": "AWSMarketplace",
"ChangeSet":
[
{
"ChangeType": "AddDeliveryOptions",
"Entity":
{
"Type": "AmiProduct@1.0",
"Identifier": "prod-example12345"
},
"DetailsDocument":
{
"Version":
{
"VersionTitle": "My new title",
"ReleaseNotes": "My new Release notes"
},
"DeliveryOptions":
[
{
"Details":
{
"AmiDeliveryOptionDetails":
{
"AmiSource":
{
"AmiId": "ami-1234567890abcdef",
"AccessRoleArn": "arn:aws:iam::12345678901:role/AwsMarketplaceAmiIngestion",
"UserName": "ec2-user",
"OperatingSystemName": "AMAZONLINUX",
"OperatingSystemVersion": "Amazon Linux 2 AMI 2.0.20210126.0 x86_64 HVM gp2",
"AfiIds": ["afi-1234567890abcdefg", "afi-abcdefg1234567890"] //Optional (Required only for FPGA products)
},
"UsageInstructions": "Easy to use AMI",
"RecommendedInstanceType": "m4.xlarge",
"SecurityGroups":
[
{
"IpProtocol": "tcp",
"FromPort": 443,
"ToPort": 443,
"IpRanges":
[
"0.0.0.0/0"
]
}
]
}
}
},
{
"DeliveryOptionTitle": "My new AMI with CFTdelivery option",
"Details":
{
"DeploymentTemplateDeliveryOptionDetails":
{
"ShortDescription": "My new short description",
"LongDescription": "My new long description",
"UsageInstructions": "My new usage instructions",
"RecommendedInstanceType": "m4.xlarge",
"ArchitectureDiagram": "https://my-bucket.s3.amazonaws.com/my-folder/diagram.png",
"Template": "https://my-bucket.s3.amazonaws.com/my-folder/cft.template",
"TemplateSources":
[
{
"ParameterName": "MyAmiParam",
"AmiSource":
{
"AmiId": "ami-1234567890abcdef",
"AccessRoleArn": "arn:aws:iam::12345678901:role/AwsMarketplaceAmiIngestion",
"UserName": "ec2-user",
"OperatingSystemName": "AMAZONLINUX",
"OperatingSystemVersion": "Amazon Linux 2 AMI 2.0.20210126.0 x86_64 HVM gp2"
}
}
]
}
}
}
]
}
}
],
"Intent": "APPLY"
}
```
次のリストは、`AddDeliveryOptions`変更タイプで使用する入力フィールドに関する情報を示しています。特に明記されていない限り、すべてのフィールドは必須です。これらのフィールドの詳細については、 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)」を参照してください。
+ **DeliveryOptions** (オブジェクトの配列) – 各オブジェクトの詳細を含む配信オプションオブジェクトのリスト。少なくとも 1 つ含める必要があります。
+ *AMI (スタンドアロン)* 配信オプションでは、以下の詳細を含むオブジェクトを指定します。このタイプの配信オプションは 1 つだけです。
+ **詳細** (オブジェクト) – この配信オプションの詳細を保持します。このネストされた詳細オブジェクトは、二重エスケープする必要はありません。
+ **AmiDeliveryOptionDetails** (オブジェクト) – を使用して、各 AMI 配信オプションの詳細を指定します。
+ **AmiSource** (オブジェクト) – 追加バージョンに使用する AMI に関する詳細。
+ **AmiId** (文字列) – API が呼び出される にあるソース AMI AWS リージョン の ID。これは Catalog API が利用可能な唯一のリージョンであるため、常に米国東部 (バージニア北部) である必要があります。発信者アカウントに属している必要があります。
+ **AccessRoleArn **(文字列) – が提供する AMI にアクセス AWS Marketplaceするために で使用される IAM ロール Amazon リソースネーム (ARN)。この ARN の作成と使用の詳細については、*AWS Marketplace 「 Seller Guide*」の「[Giving AWS Marketplace access to your AMI](https://docs.aws.amazon.com/marketplace/latest/userguide/ami-single-ami-products.html#single-ami-marketplace-ami-access)」を参照してください。
+ **UserName** (文字列) – AMI のオペレーティングシステム (OS) にアクセスするためのログインユーザー名。通常、Linux AMIs の場合は ec2-user、Windows の場合は Administrator。
+ **ScanningPort** (整数) – OS へのアクセスに使用される SSH または RDP ポート。提供された AMI でセキュリティの脆弱性をスキャンするために使用されます。デフォルトは 22 です。
+ **OperatingSystemName** (文字列) – 購入者に表示されるオペレーティングシステムの名前。
+ **OperatingSystemVersion** (文字列) – 購入者に表示されるオペレーティングシステムのバージョン文字列。
+ **AfiIds** (文字列の配列) (オプション) – このバージョンの FPGA サポートを有効にする Amazon FPGA イメージ (AFI) IDs。これにより、FPGA 対応 F2 インスタンスタイプで製品を実行できます。バージョンごとに最大 15 個の AFI IDs を指定できます。指定するすべての AFI ID は、米国東部 (バージニア北部) リージョンを発行元とし、AWS Marketplace 販売者アカウント内に存在する必要があります。また、提供された IAM アクセスロールには、この AFI を AWS Marketplace と共有するためのアクセス許可が必要です。必要なアクセス許可の詳細については、*AWS Marketplace 「 Seller Guide*」の「[Giving AWS Marketplace access to your FPGA images](https://docs.aws.amazon.com/marketplace/latest/userguide/single-ami-marketplace-ami-access.html#single-ami-marketplace-afi-access)」を参照してください。
+ **UsageInstructions** (文字列) – AMI を使用する手順、または AMI に関する詳細情報へのリンク。
+ **AccessEndpointUrl** (オブジェクト) (オプション) – AMI の使用後にアクセスするためのパスを作成するために使用されます。
+ **ポート** (文字列) — AMI で実行されているサービスへのアクセスに使用されるポート番号。
+ **プロトコル** (文字列) – AMI で実行されているサービスへのアクセスに使用されるプロトコル (http または https)。
+ **RelativePath** (文字列) – AMI で実行されているサービスにアクセスするためのウェブルートからのパス (/index.html など）。
+ **RecommendedInstanceType** (文字列) – AMI でサービスを実行するために推奨されるインスタンスタイプで、サービスのワンクリックインストールのデフォルトです。インスタンスタイプのリストについては、Linux [インスタンス用 Amazon Elastic Compute Cloud ユーザーガイドの「インスタンスタイプ](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/instance-types.html)**」を参照してください。
+ **SecurityGroups** (オブジェクトの配列) – バージョンの自動的に作成されたグループの進入ルールを表すオブジェクトのリスト。
+ **IpProtocol** (文字列) – 使用するプロトコル (tcp または udp)。
+ **FromPort** (整数) – ソースポート。
+ **ToPort** (整数) – 送信先ポート。
+ **IpRanges** (文字列の配列) – CIDR 形式 (xxx.xxx.xxx.xxx/nn の形式、例えば {{192.0.2.0/24}}) で許可する IP 範囲。
+ *CloudFormation 配信オプションを使用する AMI* の場合は、以下の詳細を含むオブジェクトを指定します。このタイプの配信オプションは最大 3 つまで設定できます。
+ **DeliveryOptionTitle** (文字列) – 配信オプションのタイトル。
+ **詳細** (オブジェクト) – AMI 配信オプションの詳細を保持します。このネストされた詳細オブジェクトは、二重エスケープする必要はありません。
+ **DeploymentTemplateDeliveryOptionDetails** (オブジェクト) – を使用して、各 CFT 配信オプションの詳細を指定します。
+ **ShortDescription** (文字列) – CloudFormation テンプレート配信オプションの簡単な説明。
+ **LongDescription** (文字列) – CloudFormation テンプレート配信オプションの詳細な説明。
+ **UsageInstructions** (文字列) – AMI を使用する手順、または AMI に関する詳細情報へのリンク。
+ **RecommendedInstanceType** (文字列) – AMI でサービスを実行するために推奨されるインスタンスタイプで、サービスのワンクリックインストールのデフォルトです。インスタンスタイプのリストについては、Linux [インスタンス用 Amazon Elastic Compute Cloud ユーザーガイドの「インスタンスタイプ](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/instance-types.html)**」を参照してください。
+ **ArchitectureDiagram** (文字列) – Amazon S3 のアーキテクチャ図の場所への URL。
+ **テンプレート** (文字列) – Amazon S3 の CloudFormation テンプレートの場所への URL。
+ **TemplateSources** (オブジェクトの配列)
+ **ParameterName** (文字列) – このバージョンの AMI を渡す CloudFormation テンプレートのパラメータの名前。詳細については、「[AMI 詳細の要件](https://docs.aws.amazon.com/marketplace/latest/userguide/cloudformation.html#ami-requirements-sse)」を参照してください。
+ **AmiSource** (オブジェクト)
+ **AmiId** (文字列) – AWS リージョン API が呼び出されている にあるソース AMI の ID (現在は、米国東部 (バージニア北部) が Catalog API が利用可能な唯一のリージョンであるため）。発信者アカウントに属している必要があります。
+ **AccessRoleArn** (文字列) – が提供する AMI にアクセス AWS リージョン するために が使用する IAM ロール Amazon リソースネーム (ARN)。この ARN の作成と使用の詳細については、「 Seller *AWS Marketplace Guide*」の「[Giving AWS Marketplace access to your AMI](https://docs.aws.amazon.com/marketplace/latest/userguide/ami-single-ami-products.html#single-ami-marketplace-ami-access)」を参照してください。
+ **UserName** (文字列) – AMI のオペレーティングシステム (OS) にアクセスするためのログインユーザー名。通常`ec2-user`、Linux AMIs、Windows `Administrator`の場合は です。
+ **OperatingSystemName** (文字列) – 購入者に表示されるオペレーティングシステムの名前。
+ **OperatingSystemVersion** (文字列) – 購入者に表示されるオペレーティングシステムのバージョン文字列。
**レスポンスの構文**
リクエストの変更セットが作成されます。このリクエストに対するレスポンスは、変更セット`ChangeSetArn`の `ChangeSetId`と を提供し、次のようになります。
```
{
"ChangeSetId": "example123456789012abcdef",
"ChangeSetArn": "arn:aws:aws-marketplace:us-east-1:123456789012:AWSMarketplace/ChangeSet/example123456789012abcdef"
}
```
変更リクエストがキューに追加され、処理されます。これには、 AWS Marketplace ガイドラインを満たしていることを確認するための情報の検証が含まれていました。検証プロセスには数分から数時間かかる場合があります。
リクエストのステータスは、 を通じて AWS Marketplace 管理ポータル、または API オペレーションを使用して Catalog `[DescribeChangeSet](https://docs.aws.amazon.com/marketplace-catalog/latest/api-reference/API_DescribeChangeSet.html)` API から直接確認できます。
販売者製品変更セットのエラーの詳細については、「」を参照してください[変更セットのステータスとエラー](work-with-seller-products.md#seller-product-change-set-errors)。
リクエストが完了すると、バージョンが追加され、既存のサブスクライバーには新しいバージョンに関する E メールメッセージが表示されます。新しいバージョンを追加するプロセスの詳細については、*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)」を参照してください。
**非同期エラー**
以下のエラーは、 の`AddDeliveryOptions`アクションに固有のものです AWS Marketplace Catalog API。これらのエラーは、変更セットの処理`DescribeChangeSet`後に を呼び出すと返されます。`DescribeChangeSet` を使用して変更リクエストのステータスを取得する方法の詳細については、「」を参照してください[変更セットの使用](catalog-apis.md#working-with-change-sets)。
| エラーコード | エラーメッセージ |
| --- | --- |
| INVALID\_AMI\_NAME | AMI 名のプレフィックス (x) が無効です。会社名またはブランド名をプレフィックスとして使用して、新しい名前を指定します。 |
| INVALID\_PRODUCT | 既存の制限付き製品またはパブリック製品を使用します。 |
| DUPLICATE\_VERSION\_TITLE | バージョンタイトルは、この製品の他のバージョンタイトルとは異なる必要があります。 |
| INVALID\_VERSION\_TITLE | 商標記号の前にスペースを削除します。 |
| INVALID\_VERSION\_TITLE | サポートされていない文字を削除する: [x, y, z] |
| INVALID\_VERSION\_TITLE | バージョンタイトルの先頭からスペースを削除します。 |
| INVALID\_VERSION\_TITLE | [x] 文字未満のバージョンタイトルを指定します。 |
| 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 | リリースノートの先頭からスペースを削除します。 |
| INVALID\_USAGE\_INSTRUCTIONS | (x) 文字未満の使用手順を指定します。 |
| RECOMMENDED\_INSTANCE\_TYPE\_NOT\_AVAILABLE | 既存の使用可能なインスタンスタイプを指定します。 |
| INVALID\_RECOMMENDED\_INSTANCE\_TYPE | 有効なインスタンスタイプを指定します。 |
| INVALID\_SECURITY\_GROUP | セキュリティグループのポートは 1～〔最大] の間である必要があります。 |
| INVALID\_SECURITY\_GROUP | CIDR IP 範囲の値を指定します。 |
| INVALID\_SECURITY\_GROUP | 終了ポート以下のセキュリティグループ開始ポートを指定します。 |
| INVALID\_SECURITY\_GROUP\_PROTOCOL | セキュリティグループプロトコルは「tcp」または「udp」のいずれかである必要があります。 |
| INVALID\_CIDR\_IP | '0.0.0.0/0' 形式で標準の CIDR IP 範囲を指定します。 |
| INVALID\_ACCESS\_ENDPOINT\_PORT | [x] 未満のエンドポイントポートを指定します。 |
| INVALID\_ACCESS\_ENDPOINT\_PORT | エンドポイントポートを 1 ～ [最大] の間で指定します。 |
| INVALID\_ACCESS\_ENDPOINT\_PORT | エンドポイントポートを指定します。 |
| INVALID\_ACCESS\_ENDPOINT\_RELATIVE\_PATH | 相対パスのスペースを削除します。 |
| INVALID\_ACCESS\_ENDPOINT\_RELATIVE\_PATH | 相対パスから前述の「/」を削除します。 |
| INCOMPATIBLE\_OPERATING\_SYSTEM | インスタンスタイプと互換性のあるオペレーティングシステムの名前とバージョンを指定します: [x] |
| INCOMPATIBLE\_OPERATING\_SYSTEM\_NAME | (x) 文字未満の名前を指定します。 |
| INCOMPATIBLE\_OPERATING\_SYSTEM\_NAME | サポートされているオペレーティングシステム名を指定します。 |
| INCOMPATIBLE\_OPERATING\_SYSTEM\_VERSION | (x) 文字未満のバージョンを指定します。 |
| INVALID\_SCANNING\_PORT | スキャンポートを 1 ～ [最大] の間で指定します。 |
| INVALID\_AMI\_ID | 有効な AMI ID を指定します。 |
| EXISTING\_AMI\_PRODUCT\_CODE | イメージ X にアタッチされている製品コードを削除します。 |
| INVALID\_AMI\_ARCHITECTURE | アーキテクチャ [x] で新しい AMI を提供します。 |
| INVALID\_AMI\_VIRTUALIZATION\_TYPE | 仮想化タイプ [x] の新しい AMI を指定します。 |
| INVALID\_AMI\_VIRTUALIZATION\_TYPE | イメージ [x] で予想される [z] ボリュームを指定します。 |
| INCOMPATIBLE\_AMI | [y] のアーキテクチャ [x] として新しい AMI を提供する は、次のインスタンスタイプではサポートされていません: [z] |
| INCOMPATIBLE\_AMI | [y] の仮想化タイプ [x] として新しい AMI を指定すると、次のインスタンスタイプではサポートされていません: [z] |
| INCOMPATIBLE\_AMI | 次のインスタンスタイプでは ENA サポートが必要なため、イメージ x の ENA サポートを有効にします: [y] |
| ASSET\_NOT\_FOUND | [ami-id] が [account-id] の us-east-1 リージョンに存在し AWS アカウント 、AccessARN指定された [ARN] にこの AMI を と共有するためのアクセス許可があるかどうかを確認します AWS Marketplace。 |
| ASSET\_ACCESS\_EXCEPTION | AMI [x] を AWS Marketplace アカウントにコピーできません。 |
| SCAN\_ERROR | イメージ [x] のセキュリティ脆弱性 [y] を修正しました。 |
| ASSET\_NOT\_FOUND | [afi-id] が [account-id] の us-east-1 リージョンに存在し AWS アカウント 、AccessARN指定された [ARN] にこの AFI を と共有するためのアクセス許可があるかどうかを確認します AWS Marketplace。 |
| ASSET\_ACCESS\_EXCEPTION | AFI にアクセスできません。AccessARN が提供する [ARN] に、この AFI を と共有するためのアクセス許可があり AWS Marketplace 、アクセスロール Account が AFI 所有者であるかどうかを確認します。 |
| MISSING\_FPGA\_INSTANCE\_TYPE | FPGA ベースのインスタンスタイプが見つかりません。AddInstanceTypes 変更タイプを使用して、FPGA ベースのインスタンスタイプを追加します。 |
を使用して AMI ベースの製品を作成することもできます AWS Marketplace 管理ポータル。詳細については、「 *AWS Marketplace 販売者ガイド*」の[「AMI 製品](https://docs.aws.amazon.com/marketplace/latest/userguide/ami-single-ami-products.html)」を参照してください。
AMI ベースの製品の更新を自動化する方法を示すチュートリアルについては、[「Catalog API AWS Marketplace を使用した の製品リストの更新を自動化する](https://www.youtube.com/watch?v=7KpUJ6Wcqrg)」(5:08) の動画も参照してください。
## バージョン情報を更新する
Catalog API を使用して、 の AMI ベースの製品の既存のバージョンの詳細を更新できます AWS Marketplace。
**注記**
を使用したバージョン情報の更新の詳細については AWS Marketplace 管理ポータル、「 *AWS Marketplace 販売者ガイド*」の[「バージョン情報の更新](https://docs.aws.amazon.com/marketplace/latest/userguide/ami-single-ami-products.html#single-ami-updating-version)」を参照してください。
バージョンの AMI を更新することはできません。AMI を更新する必要がある場合は、代わりに新しいバージョンを作成します。
新しいバージョンを追加するには、次の例に示すように、`UpdateDeliveryOptions`変更タイプを使用して `StartChangeSet` API オペレーションを呼び出します。
**リクエストの構文**
```
POST /StartChangeSet HTTP/1.1
Content-type: application/json
{
"Catalog": "AWSMarketplace",
"ChangeSet":
[
{
"ChangeType": "UpdateDeliveryOptions",
"Entity":
{
"Identifier": "example1-abcd-1234-5ef6-7890abcdef12@1",
"Type": "AmiProduct@1.0"
},
"DetailsDocument":
{
"Version":
{
"ReleaseNotes": "*My new Release notes*"
},
"DeliveryOptions":
[
{
"Id": "example1-2222-cccc-2222-cccccccccccc",
"Details":
{
"AmiDeliveryOptionDetails":
{
"UsageInstructions": "Easy to use AMI"
}
}
},
{
"Id": "example1-2222-dddd-2222-dddddddddddd",
"Details":
{
"DeploymentTemplateDeliveryOptionDetails":
{work with ami
"DeliveryOptionTitle": "My updated delivery option title",
"UsageInstructions": "Updated usage instructions here."
}
}
}
]
}
}
]
}
```
以下は、`UpdateDeliveryOptions`変更タイプを追加するために指定する入力フィールドに関する情報です。これらのフィールドの詳細については、 AWS Marketplace 「 Seller Guide」の[「Updating version information](https://docs.aws.amazon.com/marketplace/latest/userguide/ami-single-ami-products.html#single-ami-updating-version)」を参照してください。
+ **エンティティ** (オブジェクト) (必須) – AMI ベースの製品。
+ **識別子** (文字列) (必須) – 製品 ID。詳細については、「[識別子](catalog-apis.md#identifier)」を参照してください。
+ **タイプ** (文字列) (必須) – `Type`は、製品が使用する配信方法 (製品タイプ) に基づいています。 `AmiProduct@1.0`
+ **DetailsDocument** (オブジェクト) (必須) – リクエストの詳細。これには、更新する AMI ベースの製品のバージョンに関する情報が含まれます。含まれるフィールドはすべてオプションですが、更新するには少なくとも 1 つのフィールドを含める必要があります。
+ **バージョン** (オブジェクト) – ソフトウェアバージョンに関する詳細。
+ **ReleaseNotes** (文字列) – あるバージョンから次のバージョンへの変更について購入者に伝えるためのメモ。
+ **DeliveryOptions** (オブジェクトの配列) – 配信オプションオブジェクトのリスト。更新する配信オプションのみを含めます。
+ *AMI (スタンドアロン)* 配信オプションでは、以下の詳細を含むオブジェクトを指定します。更新するフィールドのみを含めます。特に明記されていない限り、すべてのフィールドはオプションです。
+ **ID** (文字列) (必須) – 配信オプションの一意の識別子 (更新する製品の `DescribeEntity`アクションを呼び出すことで、配信オプションの一意の識別子を取得できます）。
+ **詳細** (オブジェクト) – AMI 配信オプションの詳細を保持します。このネストされた詳細オブジェクトは、二重エスケープ*する必要はありません*。
+ **AmiDeliveryOptionDetails** (オブジェクト) – 1 つの AMI 配信オプションの詳細。
+ **UsageInstructions** (文字列) – AMI を使用する手順、または AMI に関する詳細情報へのリンク。
+ **AccessEndpointUrl** (オブジェクト) – AMI の使用後にアクセスするためのパスを作成するために使用されます。
+ **ポート** (文字列) — AMI で実行されているサービスへのアクセスに使用されるポート番号。
+ **プロトコル** (文字列) – AMI で実行されているサービスへのアクセスに使用されるプロトコル (`http` または `https`)。
+ **RelativePath** (文字列) – AMI で実行されているサービスにアクセスするためのウェブルートからのパス ({{/index.html}} など）。
+ **RecommendedInstanceType** (文字列) – AMI でサービスを実行するために推奨されるインスタンスタイプで、サービスのワンクリックインストールのデフォルトです。
+ **SecurityGroups** (オブジェクトの配列) – バージョンに自動的に作成されたグループの進入ルールを表すオブジェクトのリスト。
+ **FromPort** (整数) – ソースポート。
+ **IpProtocol** (文字列) – 使用するプロトコル (`tcp` または `idp`)。
+ **IpRanges** (文字列の配列) – CIDR 形式 (*xxx.xxx.xxx.xxx/nn* の形式、例えば {{192.0.2.0/24}}) で許可する IP 範囲。
+ **ToPort** (整数) – 送信先ポート。
+ *CloudFormation 配信オプションを使用する AMI* の場合は、以下の詳細を含むオブジェクトを指定します。更新するフィールドのみを含めます。特に明記されていない限り、すべてのフィールドはオプションです。
+ **ID** (文字列) (必須) – 配信オプションの一意の識別子 (更新する製品の `DescribeEntity`アクションを呼び出すことで、配信オプションの一意の識別子を取得できます）。
+ **詳細** (オブジェクト) – AMI 配信オプションの詳細を保持します。このネストされた詳細オブジェクトは、二重エスケープ*する必要はありません*。
+ **DeploymentTemplateDeliveryOptionDetails** (オブジェクト) – を使用して、各 CFT 配信オプションの詳細を指定します。
+ **DeliveryOptionTitle** (文字列) – 配信オプションのタイトル。
+ **ShortDescription** (文字列) – CloudFormation テンプレート配信オプションの簡単な説明。
+ **LongDescription** (文字列) – CloudFormation テンプレート配信オプションの詳細な説明。
+ **UsageInstructions** (文字列) – AMI を使用する手順、または AMI に関する詳細情報へのリンク。
+ **RecommendedInstanceType** (文字列) – AMI でサービスを実行するために推奨されるインスタンスタイプで、サービスのワンクリックインストールのデフォルトです。インスタンスタイプのリストについては、Linux [インスタンス用 Amazon Elastic Compute Cloud ユーザーガイドの「インスタンスタイプ](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/instance-types.html)**」を参照してください。
+ **ArchitectureDiagram** (文字列) – Amazon S3 のアーキテクチャ図の場所への URL。
+ **テンプレート** (文字列) – Amazon S3 の CloudFormation テンプレートの場所への URL。
+ **TemplateSources** (オブジェクトの配列)
+ **ParameterName** (文字列) – このバージョンの AMI を渡す CloudFormation テンプレートの パラメータの名前。詳細については、「[AMI 詳細の要件](https://docs.aws.amazon.com/marketplace/latest/userguide/cloudformation.html#ami-requirements-sse)」を参照してください。
+ **AmiSource** (オブジェクト)
+ **AmiId** (文字列) – AWS リージョン API が呼び出されている にあるソース AMI の ID (現在は、米国東部 (バージニア北部) がカタログ API が利用可能な唯一のリージョンであるため）。発信者アカウントに属している必要があります。
+ **AccessRoleArn** (文字列) – が提供する AMI にアクセス AWS リージョン するために で使用される IAM ロール Amazon リソースネーム (ARN)。この ARN の作成と使用の詳細については、*AWS Marketplace 「 Seller Guide*」の「[Giving AWS Marketplace access to your AMI](https://docs.aws.amazon.com/marketplace/latest/userguide/ami-single-ami-products.html#single-ami-marketplace-ami-access)」を参照してください。
+ **UserName** (文字列) – AMI のオペレーティングシステム (OS) にアクセスするためのログインユーザー名。通常`ec2-user`、Linux AMIs、Windows `Administrator`の場合は です。
+ **OperatingSystemName** (文字列) – 購入者に表示されるオペレーティングシステムの名前。
+ **OperatingSystemVersion** (文字列) – 購入者に表示されるオペレーティングシステムのバージョン文字列。
**レスポンスの構文**
リクエストの変更セットが作成されます。このリクエストに対するレスポンスは、変更セット`ChangeSetArn`の `ChangeSetId`と を提供し、次のようになります。
```
{
"ChangeSetId": "example123456789012abcdef",
"ChangeSetArn": "arn:aws:aws-marketplace:us-east-1:123456789012:AWSMarketplace/ChangeSet/example123456789012abcdef"
}
```
変更リクエストがキューに追加され、処理されます。これには、 AWS Marketplace ガイドラインを満たしていることを確認するための情報の検証が含まれていました。検証プロセスには数分から数時間かかる場合があります。
リクエストのステータスは、 を通じて 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)。
変更セットの処理が開始された後、 `DescribeChangeSet`オペレーションを使用して`UpdatePricingTerms`アクションを取得できます。エラーの詳細とトラブルシューティングの詳細については、このガイドの前半の[変更セットのステータスとエラー](work-with-seller-products.md#seller-product-change-set-errors)「」を参照してください。
| エラーコード | エラーメッセージ |
| --- | --- |
| INVALID\_PRODUCT | 既存の制限付き製品またはパブリック製品を使用します。 |
| MISSING\_DELIVERY\_OPTION\_IDS | 少なくとも 1 つの配信オプション ID を指定します。 |
| INVALID\_DELIVERY\_OPTION\_IDS | 製品にある配信オプション IDs を指定します。IDsが見つかりません: [x] |
| INVALID\_DELIVERY\_OPTIONS | 同じバージョンに属する配信オプション IDs を指定します。 |
## バージョンを制限する
Catalog API を使用して、AMI ベースの製品のバージョンを制限できます。これにより、新しい購入者がそのバージョンを使用できなくなりますが、既存の購入者はそれを引き続き使用できます。バージョンからすべての配信オプションを制限すると、バージョンが制限されます。バージョンから 1 つ以上の配信オプションを制限すると、そのバージョンの配信オプションのみが制限されます。製品の最終公開バージョンを制限できないように、常に製品の無制限バージョンを 1 つ以上用意する必要があります。
**注記**
AWS Marketplace 経由で で AMI バージョンを制限する方法の詳細については AWS Marketplace 管理ポータル、「 *AWS Marketplace 販売者ガイド*」の[「バージョンの制限](https://docs.aws.amazon.com/marketplace/latest/userguide/ami-single-ami-products.html#single-ami-restricting-version)」を参照してください。
バージョンを制限するには、次の例に示すように、`RestrictDeliveryOptions`変更タイプを使用して `StartChangeSet` API オペレーションを呼び出します。
**注記**
すべてのサブスクライバーは、制限ステータスに関係なく、現在のバージョンを使用できます。 AWS Marketplace ガイドラインでは、バージョンを制限してから 90 日間、既存の購入者に引き続きサポートを提供する必要があります。バージョンが制限されると、AMI は非推奨としてマークされます。詳細については、「Windows インスタンス用 Amazon Elastic Compute Cloud ユーザーガイド」の「[AMI を非推奨にする](https://docs.aws.amazon.com/AWSEC2/latest/WindowsGuide/ami-deprecate.html)」を参照してください。**
**リクエストの構文**
```
POST /StartChangeSet HTTP/1.1
Content-type: application/json
{
"Catalog": "AWSMarketplace",
"ChangeSet":
[
{
"ChangeType": "RestrictDeliveryOptions",
"Entity":
{
"Identifier": "{{example1-abcd-1234-5ef6-7890abcdef12@1}}",
"Type": "AmiProduct@1.0"
},
"DetailsDocument":
{
"DeliveryOptionIds":
[
"{{example1-2222-cccc-2222-cccccccccccc}}"
]
}
}
]
}
```
以下は、`RestrictDeliveryOptions`変更タイプを追加するために指定する入力フィールドに関する情報です。
+ **エンティティ** (オブジェクト) (必須) – AMI ベースの製品。
+ **識別子** (文字列) (必須) – 製品 ID。詳細については、「[識別子](catalog-apis.md#identifier)」を参照してください。
+ **タイプ** (文字列) (必須) – `Type`は、製品が使用する配信方法 (製品タイプ) に基づいています。 `AmiProduct@1.0`
+ **DetailsDocument** (オブジェクト) (必須) – リクエストの詳細。これには、制限する AMI ベースの製品のバージョンの IDs が含まれます。
+ **DeliveryOptionIds** (オブジェクトの配列) – 制限するバージョンの `DeliveryOption` IDs のリスト。制限するバージョンで `DescribeEntity`アクションを呼び出す`DeliveryOption`ことで、 の一意の識別子を取得できます。
**レスポンスの構文**
リクエストの変更セットが作成されます。このリクエストに対するレスポンスは、変更セット`ChangeSetArn`の `ChangeSetId`と を提供し、次のようになります。
```
{
"ChangeSetId": "example123456789012abcdef",
"ChangeSetArn": "arn:aws:aws-marketplace:us-east-1:{{123456789012}}:AWSMarketplace/ChangeSet/{{example123456789012abcdef}}"
}
```
変更リクエストがキューに追加され、処理されます。これには、 AWS Marketplace ガイドラインを満たしていることを確認するための情報の検証が含まれていました。検証プロセスには数分から数時間かかる場合があります。
リクエストのステータスは、 を通じて AWS Marketplace 管理ポータル、または API オペレーションを使用して Catalog `[DescribeChangeSet](https://docs.aws.amazon.com/marketplace-catalog/latest/api-reference/API_DescribeChangeSet.html)` API から直接確認できます。
**非同期エラー**
以下のエラーは、 の`RestrictDeliveryOptions`アクションに固有のものです AWS Marketplace Catalog API。これらのエラーは、変更セットの処理`DescribeChangeSet`後に を呼び出すと返されます。`DescribeChangeSet` を使用して変更リクエストのステータスを取得する方法の詳細については、「」を参照してください[変更セットの使用](catalog-apis.md#working-with-change-sets)。
| エラーコード | エラーメッセージ |
| --- | --- |
| INVALID\_PRODUCT | 既存のパブリック製品を使用します。 |
| MISSING\_DELIVERY\_OPTION\_IDS | 少なくとも 1 つの配信オプション ID を指定します。 |
| INVALID\_DELIVERY\_OPTION\_IDS | 製品にある配信オプション IDs を指定します。IDsが見つかりません: [x] |
| INVALID\_DELIVERY\_OPTION | パブリック状態にある配信オプション IDs を指定します。パブリック状態でない IDs: [x] |
| ALL\_DELIVERY\_OPTIONS\_RESTRICTED | 少なくとも 1 つをパブリック状態に保つ必要があるため、制限する配信オプションの数を減らします。 |
## 今後の AWS リージョン サポートの更新
Catalog API を使用して、AMI ベースの製品の今後の AWS リージョン サポート設定を変更できます AWS Marketplace。
**注記**
を使用した今後のリージョンサポートの変更の詳細については AWS Marketplace 管理ポータル、*AWS Marketplace 「 Seller Guide*」の[「Update support for future AWS Regions](https://docs.aws.amazon.com/marketplace/latest/userguide/ami-single-ami-products.html#single-ami-updating-future-region-support)」を参照してください。
**注記**
`UpdateFutureRegionSupport` 変更タイプは でのみ使用できます`AmiProduct@1.0`。
今後の AWS リージョン サポート設定を変更するには、次の例に示すように、`UpdateFutureRegionSupport`変更タイプを使用して `StartChangeSet` API オペレーションを呼び出します。
**リクエストの構文**
```
POST /StartChangeSet HTTP/1.1
Content-type: application/json
{
"Catalog": "AWSMarketplace",
"ChangeSet":
[
{
"ChangeType": "UpdateFutureRegionSupport",
"Entity":
{
"Identifier": "{{prod-example12345}}",
"Type": "AmiProduct@1.0"
},
"DetailsDocument":
{
"FutureRegionSupport":
{
"SupportedRegions":
[
"All"
]
}
}
}
]
}
```
`UpdateFutureRegionSupport` 変更タイプを追加するフィールドの情報を入力します。
+ `Entity` (オブジェクト) (必須) – AMI ベースの製品。
+ `Identifier` (文字列) (必須) – 製品 ID。詳細については、「[識別子](catalog-apis.md#identifier)」を参照してください。
+ `Type` (文字列) (必須) – `Type`は、製品が使用する配信方法 (製品タイプ) に基づいています。 `AmiProduct@1.0`
+ `DetailsDocument` (オブジェクト) (必須) – ChangeSet の実行に必要な詳細。
+ `FutureRegionSupport` – オブジェクト
+ `SupportedRegions` – 文字列の単一要素配列
要素でサポートされている値: [`"All"`、`"US"`、`"None"`] のいずれか
**レスポンスの構文**
リクエストの変更セットが作成されます。このリクエストに対するレスポンスは、変更セット`ChangeSetArn`の `ChangeSetId`と を提供し、次のようになります。
```
{
"ChangeSetId": "{{example123456789012abcdef}}",
"ChangeSetArn": "arn:aws:aws-marketplace:{{us-east-1}}:{{123456789012}}:AWSMarketplace/ChangeSet/{{example123456789012abcdef}}"
}
```
変更リクエストがキューに追加され、処理されます。これには、 AWS Marketplace ガイドラインを満たしていることを確認するための情報の検証が含まれていました。検証プロセスには数分から数時間かかる場合があります。
リクエストのステータスは、 を通じて AWS Marketplace 管理ポータル、または API オペレーションを使用して Catalog `[DescribeChangeSet](https://docs.aws.amazon.com/marketplace-catalog/latest/api-reference/API_DescribeChangeSet.html)` API から直接確認できます。
**非同期エラー**
以下のエラーは、 の`UpdateFutureRegionSupport`アクションに固有のものです AWS Marketplace Catalog API。これらのエラーは、変更セットの処理`DescribeChangeSet`後に を呼び出すと返されます。`DescribeChangeSet` を使用して変更リクエストのステータスを取得する方法の詳細については、「」を参照してください[変更セットの使用](catalog-apis.md#working-with-change-sets)。
| エラーコード | エラーメッセージ |
| --- | --- |
| TOO\_MANY\_REGIONS | 現在、FutureRegionSupport では、すべて、米国、またはなしの 1 つの値のみがサポートされています。 |
| 無効なリージョン | リクエストされたリージョン [a、b、c] が無効または使用できません。サポートされている値のみが [x, y, z] です。 |
| INVALID\_INPUT | SupportedRegions を空にすることはできません。 |
## サポートされている を追加する AWS リージョン
Catalog API を使用して、AMI ベースの製品 AWS リージョン でサポートされている新しい を追加できます AWS Marketplace。
**注記**
を使用してサポートされている新しいリージョンを追加する方法の詳細については AWS Marketplace 管理ポータル、*AWS Marketplace 「 Seller Guide*」の「Add [ an AWS Region](https://docs.aws.amazon.com/marketplace/latest/userguide/ami-single-ami-products.html#single-ami-adding-regions)」を参照してください。
**注記**
`AddRegions` 変更タイプは でのみ使用できます`AmiProduct@1.0`。
サポートされている新しいリージョンを追加するには、次の例に示すように、`AddRegions`変更タイプを使用して `StartChangeSet` API オペレーションを呼び出します。
**リクエストの構文**
```
POST /StartChangeSet HTTP/1.1
Content-type: application/json
{
"Catalog": "AWSMarketplace",
"ChangeSet": [
{
"ChangeType": "AddRegions",
"DetailsDocument": {
"Regions": [
"{{us-east-1}}",
"{{ap-northeast-2}}"
]
},
"Entity": {
"Identifier": "{{prod-123456@1}}",
"Type": "AmiProduct@1.0"
}
}
]
}
```
`AddRegions` 変更タイプを追加するフィールドの情報を入力します。
+ `Entity` (オブジェクト) (必須) – AMI ベースの製品。
+ `Identifier` (文字列) (必須) – 製品 ID。詳細については、「[識別子](catalog-apis.md#identifier)」を参照してください。
+ `Type` (文字列) (必須) – `Type`は、製品が使用する配信方法 (製品タイプ) に基づいています。 `AmiProduct@1.0`
+
**Example**
+ `Regions`: 文字列の配列
要素でサポートされている値: 有効な AWS リージョン コード文字列。
例えば、[] です`"us-east- 1"`。
**レスポンスの構文**
リクエストの変更セットが作成されます。このリクエストに対するレスポンスは、変更セット`ChangeSetArn`の `ChangeSetId`と を提供し、次のようになります。
```
{
"ChangeSetId": "{{example123456789012abcdef}}",
"ChangeSetArn": "arn:aws:aws-marketplace:{{us-east-1}}:{{123456789012}}:AWSMarketplace/ChangeSet/{{example123456789012abcdef}}"
}
```
変更リクエストがキューに追加され、処理されます。これには、 AWS Marketplace ガイドラインを満たしていることを確認するための情報の検証が含まれていました。検証プロセスには数分から数時間かかる場合があります。
リクエストのステータスは、 を通じて AWS Marketplace 管理ポータル、または API オペレーションを使用して Catalog `[DescribeChangeSet](https://docs.aws.amazon.com/marketplace-catalog/latest/api-reference/API_DescribeChangeSet.html)` API から直接確認できます。
+ 変更セットの実行ステータスが の場合`SUCCEEDED`: 新しいエンティティ `Identifier` (または `EntityId`) が生成されます。製品エンティティの [`DescribeEntity`](https://docs.aws.amazon.com/marketplace-catalog/latest/api-reference/API_DescribeEntity.html) API オペレーションを使用して、結果を確認できます。
+ 変更セットの実行ステータスが の場合`CLIENT_ERROR`: `DescribeChangeSet`レスポンスは、エラーの詳細と、エラーを修正するために実行する対応するアクションを提供します。
**非同期エラー**
以下のエラーは、 の`AddRegions`アクションに固有のものです AWS Marketplace Catalog API。これらのエラーは、変更セットの処理`DescribeChangeSet`後に を呼び出すと返されます。`DescribeChangeSet` を使用して変更リクエストのステータスを取得する方法の詳細については、「」を参照してください[変更セットの使用](catalog-apis.md#working-with-change-sets)。
| エラーコード | エラーメッセージ |
| --- | --- |
| 無効なリージョン | リクエストされたリージョン [a、b、c] が無効または使用できません。サポートされている値のみが [x, y, z] です。 |
| INVALID\_INPUT | リージョンを空にすることはできません。 |
## の制限 AWS リージョン
Catalog API を使用して、 の AMI ベースの製品 AWS リージョン で以前にサポートされている を制限できます AWS Marketplace。
**注記**
を使用して以前にサポートされたリージョンを制限する方法の詳細については AWS Marketplace 管理ポータル、「 *AWS Marketplace 販売者ガイド*」の[「AWS リージョンの制限](https://docs.aws.amazon.com/marketplace/latest/userguide/ami-single-ami-products.html#single-ami-restricting-regions)」を参照してください。
**注記**
`RestrictRegions` 変更タイプは でのみ使用できます`AmiProduct@1.0`。
以前にサポートされたリージョンを制限するには、次の例に示すように、`RestrictRegions`変更タイプを使用して `StartChangeSet` API オペレーションを呼び出します。
**リクエストの構文**
```
POST /StartChangeSet HTTP/1.1
Content-type: application/json
{
"Catalog": "AWSMarketplace",
"ChangeSet": [
{
"ChangeType": "RestrictRegions",
"DetailsDocument": {
"Regions": [
"{{us-east-1}}",
"{{ap-northeast-2}}"
]
},
"Entity": {
"Identifier": "{{prod-123456@1}}",
"Type": "AmiProduct@1.0"
}
}
]
}
```
`AddRegions` 変更タイプを追加するフィールドの情報を入力します。
+ `Entity` (オブジェクト) (必須) – AMI ベースの製品。
+ `Identifier` (文字列) (必須) – 製品 ID。詳細については、「[識別子](catalog-apis.md#identifier)」を参照してください。
+ `Type` (文字列) (必須) – `Type`は、製品が使用する配信方法 (製品タイプ) に基づいています。 `AmiProduct@1.0`
+ **DetailsDocument** (オブジェクト) (必須) – ChangeSet の実行に必要な詳細。
+ `Regions` – 文字列の配列
要素でサポートされている値: などの有効な AWS リージョン コード文字列`"us-east-1"`。
**レスポンスの構文**
リクエストの変更セットが作成されます。このリクエストに対するレスポンスは、変更セット`ChangeSetArn`の `ChangeSetId`と を提供し、次のようになります。
```
{
"ChangeSetId": "{{example123456789012abcdef}}",
"ChangeSetArn": "arn:aws:aws-marketplace:{{us-east-1}}:{{123456789012}}:AWSMarketplace/ChangeSet/{{example123456789012abcdef}}"
}
```
変更リクエストがキューに追加され、処理されます。これには、 AWS Marketplace ガイドラインを満たしていることを確認するための情報の検証が含まれていました。検証プロセスには数分から数時間かかる場合があります。
リクエストのステータスは、 を通じて AWS Marketplace 管理ポータル、または API オペレーションを使用して Catalog `[DescribeChangeSet](https://docs.aws.amazon.com/marketplace-catalog/latest/api-reference/API_DescribeChangeSet.html)` API から直接確認できます。
+ 変更セットの実行ステータスが `SUCCEEDED`の場合 – 新しいエンティティ `Identifier` (または `EntityId`) が生成されます。製品エンティティ`DescribeEntity`で を使用して結果を確認できます。詳細については、「[`DescribeEntity`](https://docs.aws.amazon.com/marketplace-catalog/latest/api-reference/API_DescribeEntity.html)」を参照してください。
+ 変更セットの実行ステータスが の場合`CLIENT_ERROR`: `DescribeChangeSet`レスポンスは、エラーの詳細と、エラーを修正するために実行する対応するアクションを提供します。
**非同期エラー**
以下のエラーは、 の`AddRegions`アクションに固有のものです AWS Marketplace Catalog API。これらのエラーは、変更セットの処理`DescribeChangeSet`後に を呼び出すと返されます。`DescribeChangeSet` を使用して変更リクエストのステータスを取得する方法の詳細については、「」を参照してください[変更セットの使用](catalog-apis.md#working-with-change-sets)。
| エラーコード | エラーメッセージ |
| --- | --- |
| 無効なリージョン | リクエストされたリージョン [a、b、c] が無効または使用できません。サポートされている値のみが [x, y, z] です。 |
| INVALID\_INPUT | リージョンを空にすることはできません。 |
## 新しいインスタンスタイプを追加する
Catalog API を使用して、AMI ベースの製品の新しいインスタンスタイプを追加できます AWS Marketplace。
**注記**
を使用してインスタンスタイプを追加する方法の詳細については AWS Marketplace 管理ポータル、*AWS Marketplace 「 Seller Guide*」の[「Add an instance](https://docs.aws.amazon.com/marketplace/latest/userguide/ami-single-ami-products.html#single-ami-adding-instance-types)」を参照してください。
`AddInstanceTypes` は、製品の作成時に既存の製品と新しく作成された製品に新しいインスタンスタイプを追加します。変更タイプは、製品ドキュメントのすべてのバージョンを新しいインスタンスタイプで更新します。
**注記**
`AddInstanceTypes` 変更タイプは でのみ使用できます`AmiProduct@1.0`。
制限されたインスタンスタイプを追加する場合、制限されたリストからインスタンスタイプを削除し、使用可能なインスタンスタイプリストに追加できます。これにより、販売者は製品制限の変更をより詳細に制御できます。インスタンスタイプリストは交換可能であり、製品の永続的な制限付きステータスではありません。
内部計測製品の場合、販売者は個別の変更タイプ`UpdatePricingTerms`を呼び出し`AddDimensions`、インスタンスタイプの料金を更新する必要があります。
新しいインスタンスタイプを追加するには、次の例に示すように、`RestrictRegions`変更タイプを使用して `StartChangeSet` API オペレーションを呼び出します。
**リクエストの構文**
`AddInstanceTypes` 変更タイプのみを以下に示します。ただし、内部で計測された AMI 販売者は、AMI の を呼び出し`AddInstanceTypes`、タイプ`UpdatePricingTerms`を変更する必要があります。
```
POST /StartChangeSet HTTP/1.1
Content-type: application/json
{
"Catalog": "AWSMarketplace",
"ChangeSet":
[
{
"ChangeType": "AddInstanceTypes",
"Entity":
{
"Identifier": "{{prod-example12345}}",
"Type": "AmiProduct@1.0"
},
"DetailsDocument":
{
"InstanceTypes":
[
"m1.medium"
]
}
}
]
}
```
`AddInstanceTypes` 変更タイプを追加するフィールドの情報を入力します。
+ `Entity` (オブジェクト) (必須) – AMI ベースの製品。
+ `Identifier` (文字列) (必須) – 製品 ID。詳細については、「[識別子](catalog-apis.md#identifier)」を参照してください。
+ `Type` (文字列) (必須) – `Type`は、製品が使用する配信方法 (製品タイプ) に基づいています。 `AmiProduct@1.0`
+ **DetailsDocument** (オブジェクト) (必須) – を実行するために必要な詳細`ChangeSet`。この場合は です`InstanceTypes`。
+ `InstanceTypes` (文字列の配列) (必須) – 製品`InstanceTypes`に追加する のリスト。これらのインスタンスは既存の に追加されます`InstanceTypes`。
**レスポンスの構文**
リクエストの変更セットが作成されます。このリクエストに対するレスポンスは、変更セット`ChangeSetArn`の `ChangeSetId`と を提供し、次のようになります。
```
{
"ChangeSetId": "{{example123456789012abcdef}}",
"ChangeSetArn": "arn:aws:aws-marketplace:{{us-east-1}}:{{123456789012}}:AWSMarketplace/ChangeSet/{{example123456789012abcdef}}"
}
```
変更リクエストがキューに追加され、処理されます。これには、 AWS Marketplace ガイドラインを満たしていることを確認するための情報の検証が含まれていました。検証プロセスには数分から数時間かかる場合があります。
リクエストのステータスは、 を通じて AWS Marketplace 管理ポータル、または API オペレーションを使用して Catalog `[DescribeChangeSet](https://docs.aws.amazon.com/marketplace-catalog/latest/api-reference/API_DescribeChangeSet.html)` API から直接確認できます。
**同期検証**
以下のスキーマ検証は、 の`AddInstanceTypes`アクションに固有です AWS Marketplace Catalog API。これらの検証は、 を呼び出すときに実行されます`StartChangeSet`。リクエストが次の要件を満たしていない場合、HTTP レスポンスで失敗します。
| 入力フィールド | 検証ルール | HTTP |
| --- | --- | --- |
| InstanceTypes | 必須 | 422 |
| InstanceTypes | 空にすることはできません | 422 |
| InstanceTypes | エントリの長さは 1～24 文字にする必要があります。^[A-Za-z0-9\_.-]\+$ と一致する必要があります | 422 |
| InstanceTypes | エントリは一意である必要があります | 422 |
| InstanceTypes | エントリ数は 1500 以下にする必要があります | 422 |
| 不明なプロパティ | 追加のプロパティは許可されません | 422 |
**非同期エラー**
以下のエラーは、 の`AddInstanceTypes`アクションに固有のものです AWS Marketplace Catalog API。これらのエラーは、変更セットの処理`DescribeChangeSet`後に を呼び出すと返されます。`DescribeChangeSet` を使用して変更リクエストのステータスを取得する方法の詳細については、「」を参照してください[変更セットの使用](catalog-apis.md#working-with-change-sets)。
| エラーコード | エラーメッセージ |
| --- | --- |
| INVALID\_INSTANCE\_TYPES | 次のインスタンスタイプは無効です: [x] |
| INVALID\_INSTANCE\_VIRTUALIZATION | 製品の仮想化は [x] です。次のインスタンスタイプではサポートされていません: [x] |
| INVALID\_AMI\_ARCHITECTURE | 製品の CPU アーキテクチャは '%s' です。" \+ "次のインスタンスタイプではサポートされていません: [x] |
| INCOMPATIBLE\_OPERATING\_SYSTEM | インスタンスタイプは、製品で定義されている OS と互換性がありません。製品で定義されている OS と互換性のあるインスタンスタイプを指定します。 |
| INVALID\_PRODUCT\_TYPE | 既存の単一の AMI 製品を使用します。 |
| INVALID\_ENA\_SETTING | 製品は ENA をサポートしていません。ENA サポートは、次のインスタンスタイプで必要です: [x] |
| INVALID\_DImenSIONS | インスタンスタイプの内部計測ディメンションが見つかりません: [x] |
| MISSING\_DImenSIONS | 製品のディメンションが見つかりません。AddInstanceTypes の前に AddDimensions AddInstanceTypes が必要です。 |
| UPDATE\_PRICING\_REQUIRED | UpdatePricingTerms の変更タイプは、内部で計測されたディメンションが製品で使用できる場合に必要です。 |
## インスタンスタイプの制限
Catalog API を使用して、AMI ベースの製品で使用できるインスタンスタイプを制限または制限できます AWS Marketplace。
**注記**
を使用して使用可能なインスタンスタイプの制限または制限の詳細については AWS Marketplace 管理ポータル、「 *AWS Marketplace 販売者ガイド*」の[「インスタンスの制限](https://docs.aws.amazon.com/marketplace/latest/userguide/ami-single-ami-products.html#single-ami-restricting-instance-types)」を参照してください。
既存のサブスクライバーは、この変更の影響を受けず、制限されたインスタンスタイプを使用できます。ただし、新しい購入者は制限されたインスタンスタイプを使用できません。現在のインスタンスタイプのサブスクリプションを停止するには (インスタンスタイプが制限されたら）、 AWS Marketplace Seller Operations Team に連絡する必要があります。
`RestrictInstanctTypes` は、インスタンスタイプを製品ドキュメントのすべてのバージョンに制限します。`AddInstanceTypes` 変更タイプでは、製品のすべてのバージョンを更新します。推奨されるインスタンスタイプを制限することはできません。推奨されるインスタンスタイプはバージョンレベルであるため、販売者は複数のインスタンスタイプを制限できない可能性があります。
内部計測製品の場合は、 を呼び出すときに個別の変更タイプを呼び出す必要があります`RestrictDimensions`。これにより、制限されたインスタンスタイプに対して新しいオファーが作成されなくなります。
**注記**
`RestrictInstanceTypes` 変更タイプは でのみ使用できます`AmiProduct@1.0`。
AMI ベースの製品で使用できるインスタンスタイプを制限または制限するには、次の例に示すように、 `RestrictInstanceTypes`変更タイプを使用して `StartChangeSet` API オペレーションを呼び出します。
**リクエストの構文**
```
POST /StartChangeSet HTTP/1.1
Content-type: application/json
{
"Catalog": "AWSMarketplace",
"ChangeSet":
[
{
"ChangeType": "RestrictInstanceTypes",
"Entity":
{
"Identifier": "{{prod-example12345}}",
"Type": "AmiProduct@1.0"
},
"DetailsDocument":
{
"InstanceTypes":
[
"m1.medium"
]
}
}
]
}
```
`RestrictInstanceTypes` 変更タイプを追加するフィールドの情報を入力します。
+ `Entity` (オブジェクト) (必須) – AMI ベースの製品。
+ `Identifier` (文字列) (必須) – 製品 ID。詳細については、「[識別子](catalog-apis.md#identifier)」を参照してください。
+ `Type` (文字列) (必須) – `Type`は、製品が使用する配信方法 (製品タイプ) に基づいています。 `AmiProduct@1.0`
+ **DetailsDocument** (オブジェクト) (必須) – を実行するために必要な詳細`ChangeSet`、この場合は `InstanceTypes`。
+ `InstanceTypes` (文字列の配列) (必須) – 製品に制限`InstanceTypes`する のリスト。これらのインスタンスは、制限された に現在のインスタンスタイプ (または既存のインスタンスタイプがない場合は追加されます) に追加されます`InstanceTypes`。
**レスポンスの構文**
リクエストの変更セットが作成されます。このリクエストに対するレスポンスは、変更セット`ChangeSetArn`の `ChangeSetId`と を提供し、次のようになります。
```
{
"ChangeSetId": "{{example123456789012abcdef}}",
"ChangeSetArn": "arn:aws:aws-marketplace:{{us-east-1}}:{{123456789012}}:AWSMarketplace/ChangeSet/{{example123456789012abcdef}}"
}
```
変更リクエストがキューに追加され、処理されます。これには、 AWS Marketplace ガイドラインを満たしていることを確認するための情報の検証が含まれていました。検証プロセスには数分から数時間かかる場合があります。
リクエストのステータスは、 を通じて AWS Marketplace 管理ポータル、または API オペレーションを使用して Catalog `[DescribeChangeSet](https://docs.aws.amazon.com/marketplace-catalog/latest/api-reference/API_DescribeChangeSet.html)` API から直接確認できます。
**同期検証**
以下のスキーマ検証は、 の`RestrictInstanceTypes`アクションに固有です AWS Marketplace Catalog API。これらの検証は、 を呼び出すときに実行されます`StartChangeSet`。リクエストが次の要件を満たしていない場合、HTTP レスポンスで失敗します。
| 入力フィールド | 検証ルール | HTTP |
| --- | --- | --- |
| InstanceTypes | 必須 | 422 |
| InstanceTypes | 空にすることはできません | 422 |
| InstanceTypes | エントリの長さは 1～24 文字にする必要があります。^[A-Za-z0-9\_.-]\+$ と一致する必要があります | 422 |
| InstanceTypes | エントリは一意である必要があります | 422 |
| InstanceTypes | エントリ数は 1500 以下にする必要があります | 422 |
| 不明なプロパティ | 追加のプロパティは許可されません | 422 |
**非同期エラー**
以下のエラーは、 の`RestrictInstanceTypes`アクションに固有のものです AWS Marketplace Catalog API。これらのエラーは、変更セットの処理`DescribeChangeSet`後に を呼び出すと返されます。`DescribeChangeSet` を使用して変更リクエストのステータスを取得する方法の詳細については、「」を参照してください[変更セットの使用](catalog-apis.md#working-with-change-sets)。
| エラーコード | エラーメッセージ |
| --- | --- |
| INVALID\_ INSTANCE\_TYPES | 次のインスタンスタイプは無効です: [x] |
| INVALID\_ PRODUCT\_TYPE | 既存の単一の AMI 製品を使用します。 |
| DUPLICATE\_INSTANCE\_TYPE | 重複しないインスタンスタイプを指定します。 |
| UNAVAILABLE\_INSTANCE\_TYPE | 使用可能なインスタンスタイプを指定します。 |
| RECOMMENDED\_INSTANCE\_TYPE\_RESTRICTED | 次のインスタンスタイプは制限できません。推奨されるインスタンスタイプは、制限する前に別のインスタンスタイプに変更する必要があります。配信オプション ID [X] インスタンスタイプ [X] |
| DImenSIONS\_NOT\_RESTICTED | 内部計測インスタンスタイプを制限する前にディメンションを制限する: [x] |
| リージョン\_NO\_INSTANCES | 制限されたインスタンスタイプでは、リージョン X で製品起動が失敗します。インスタンス数の制限を検討してください。 |
| INCOMPATIBLE\_RESTRICTION | 制限されたインスタンスタイプでは、AFIs の FPGA ベースのインスタンスタイプを持たない製品が発生します。製品は、少なくとも 1 つの FPGA ベースのインスタンスタイプをサポートする必要があります。 |