AWS Marketplace API リファレンスが再構築されました。サポートされている API オペレーションの詳細については、AWS Marketplace API リファレンスを参照してください。

翻訳は機械翻訳により提供されています。提供された翻訳内容と英語版の間で齟齬、不一致または矛盾がある場合、英語版が優先します。

AMI ベースの製品を使用する

を使用してAWS Marketplace Catalog API、Amazon マシンイメージ (AMI) ベースの製品を操作するためのタスクを自動化できます。

Catalog API を使用して AMI ベースの製品を作成する方法については、「」を参照してください製品を作成する。

以下のトピックでは、 Catalog API を使用して AMI ベースの製品に対してアクションを実行する方法について説明します。

新しいバージョンを追加する

Catalog API を使用して、既存の AMI ベースの製品に新しいバージョンを追加できますAWS Marketplace。を使用して製品に新しい AMI バージョンを追加する方法の詳細についてはAWS Marketplace 管理ポータル、「 AWS Marketplace販売者ガイド」の「新しいバージョンの追加」を参照してください。

AWS Marketplace への新しい AMI の追加を含むリクエストを作成する場合、AMI を AWS Marketplace システムにコピーし、セキュリティ上の問題がないかスキャンする必要があります。AMI でアクションを実行するアクセス許可を持つ AWS Identity and Access Management (IAM) ロールを作成して、AWS Marketplace に AMI へのアクセスを許可する必要があります。必要なアクセス許可の詳細については、AWS Marketplace「 Seller Guide」の「Giving AWS Marktplace access to your AMI」を参照してください。

新しいバージョンを追加するには、次の例に示すように、AMI ベースの製品のAddDeliveryOptions変更タイプを使用して StartChangeSet API オペレーションを呼び出します。実際に新しいバージョンを作成せずに API コールをテストするには、 Intentパラメータを に設定しますVALIDATE。詳細については、「インテント」を参照してください。

リクエストの構文

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」を参照してください。

レスポンスの構文

リクエストの変更セットが作成されます。このリクエストに対するレスポンスは、変更セットChangeSetArnの ChangeSetIdと を提供し、次のようになります。

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

変更リクエストがキューに追加され、処理されます。これには、AWS Marketplaceガイドラインを満たしていることを確認するための情報の検証が含まれていました。検証プロセスには数分から数時間かかる場合があります。

リクエストのステータスは、 を通じてAWS Marketplace 管理ポータル、または API オペレーションを使用して Catalog DescribeChangeSet API から直接確認できます。

販売者製品変更セットのエラーの詳細については、「」を参照してください変更セットのステータスとエラー。

リクエストが完了すると、バージョンが追加され、既存のサブスクライバーには新しいバージョンに関する E メールメッセージが表示されます。新しいバージョンを追加するプロセスの詳細については、AWS Marketplace「 Seller Guide」の「Adding a new version」を参照してください。

非同期エラー

以下のエラーは、 のAddDeliveryOptionsアクションに固有のものですAWS Marketplace Catalog API。これらのエラーは、変更セットの処理DescribeChangeSet後に を呼び出すと返されます。DescribeChangeSet を使用して変更リクエストのステータスを取得する方法の詳細については、「」を参照してください変更セットの使用。

を使用して AMI ベースの製品を作成することもできますAWS Marketplace 管理ポータル。詳細については、「 AWS Marketplace販売者ガイド」の「AMI 製品」を参照してください。

AMI ベースの製品の更新を自動化する方法を示すチュートリアルについては、「Catalog API AWS Marketplaceを使用した の製品リストの更新を自動化する」(5:08) の動画も参照してください。

バージョン情報を更新する

Catalog API を使用して、 の AMI ベースの製品の既存のバージョンの詳細を更新できますAWS Marketplace。

バージョンの 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」を参照してください。

レスポンスの構文

リクエストの変更セットが作成されます。このリクエストに対するレスポンスは、変更セットChangeSetArnの ChangeSetIdと を提供し、次のようになります。

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

変更リクエストがキューに追加され、処理されます。これには、AWS Marketplaceガイドラインを満たしていることを確認するための情報の検証が含まれていました。検証プロセスには数分から数時間かかる場合があります。

リクエストのステータスは、 を通じてAWS Marketplace 管理ポータル、または API オペレーションを使用して Catalog DescribeChangeSet API から直接確認できます。

変更セットに関する詳細については、「変更セットの使用」を参照してください。販売者製品変更セットのエラーの詳細については、「」を参照してください変更セットのステータスとエラー。

非同期エラー

以下のエラーは、 のUpdateDeliveryOptionsアクションに固有のものですAWS Marketplace Catalog API。これらのエラーは、変更セットの処理DescribeChangeSet後に を呼び出すと返されます。DescribeChangeSet を使用して変更リクエストのステータスを取得する方法の詳細については、「」を参照してください変更セットの使用。

変更セットの処理が開始された後、 DescribeChangeSetオペレーションを使用してUpdatePricingTermsアクションを取得できます。エラーの詳細とトラブルシューティングの詳細については、このガイドの前半の変更セットのステータスとエラー「」を参照してください。

バージョンを制限する

Catalog API を使用して、AMI ベースの製品のバージョンを制限できます。これにより、新しい購入者がそのバージョンを使用できなくなりますが、既存の購入者はそれを使用できます。バージョンからすべての配信オプションを制限すると、バージョンが制限されます。バージョンから 1 つ以上の配信オプションを制限すると、そのバージョンの配信オプションのみが制限されます。製品の最終公開バージョンを制限できないように、常に製品の無制限バージョンを 1 つ以上用意する必要があります。

バージョンを制限するには、次の例に示すように、RestrictDeliveryOptions変更タイプを使用して StartChangeSet API オペレーションを呼び出します。

リクエストの構文

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変更タイプを追加するために指定する入力フィールドに関する情報です。

レスポンスの構文

リクエストの変更セットが作成されます。このリクエストに対するレスポンスは、変更セットChangeSetArnの ChangeSetIdと を提供し、次のようになります。

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

変更リクエストがキューに追加され、処理されます。これには、AWS Marketplaceガイドラインを満たしていることを確認するための情報の検証が含まれていました。検証プロセスには数分から数時間かかる場合があります。

リクエストのステータスは、 を通じてAWS Marketplace 管理ポータル、または API オペレーションを使用して Catalog DescribeChangeSet API から直接確認できます。

非同期エラー

以下のエラーは、 のRestrictDeliveryOptionsアクションに固有のものですAWS Marketplace Catalog API。これらのエラーは、変更セットの処理DescribeChangeSet後に を呼び出すと返されます。DescribeChangeSet を使用して変更リクエストのステータスを取得する方法の詳細については、「」を参照してください変更セットの使用。

今後のAWS リージョンサポートの更新

Catalog API を使用して、AMI ベースの製品の今後のAWS リージョンサポート設定を変更できますAWS Marketplace。

今後の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 変更タイプを追加するフィールドの情報を入力します。

レスポンスの構文

リクエストの変更セットが作成されます。このリクエストに対するレスポンスは、変更セットChangeSetArnの ChangeSetIdと を提供し、次のようになります。

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

変更リクエストがキューに追加され、処理されます。これには、AWS Marketplaceガイドラインを満たしていることを確認するための情報の検証が含まれていました。検証プロセスには数分から数時間かかる場合があります。

リクエストのステータスは、 を通じてAWS Marketplace 管理ポータル、または API オペレーションを使用して Catalog DescribeChangeSet API から直接確認できます。

非同期エラー

以下のエラーは、 のUpdateFutureRegionSupportアクションに固有のものですAWS Marketplace Catalog API。これらのエラーは、変更セットの処理DescribeChangeSet後に を呼び出すと返されます。DescribeChangeSet を使用して変更リクエストのステータスを取得する方法の詳細については、「」を参照してください変更セットの使用。

サポートされている を追加するAWS リージョン

Catalog API を使用して、AMI ベースの製品AWS リージョンでサポートされている新しい を追加できますAWS Marketplace。

サポートされている新しいリージョンを追加するには、次の例に示すように、 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 変更タイプを追加するフィールドの情報を入力します。

レスポンスの構文

リクエストの変更セットが作成されます。このリクエストに対するレスポンスは、変更セットChangeSetArnの ChangeSetIdと を提供し、次のようになります。

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

変更リクエストがキューに追加され、処理されます。これには、AWS Marketplaceガイドラインを満たしていることを確認するための情報の検証が含まれていました。検証プロセスには数分から数時間かかる場合があります。

リクエストのステータスは、 を通じてAWS Marketplace 管理ポータル、または API オペレーションを使用して Catalog DescribeChangeSet API から直接確認できます。

非同期エラー

以下のエラーは、 のAddRegionsアクションに固有のものですAWS Marketplace Catalog API。これらのエラーは、変更セットの処理DescribeChangeSet後に を呼び出すと返されます。DescribeChangeSet を使用して変更リクエストのステータスを取得する方法の詳細については、「」を参照してください変更セットの使用。

の制限AWS リージョン

Catalog API を使用して、 の AMI ベースの製品AWS リージョンで以前にサポートされている を制限できますAWS Marketplace。

以前にサポートされたリージョンを制限するには、次の例に示すように、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 変更タイプを追加するフィールドの情報を入力します。

レスポンスの構文

リクエストの変更セットが作成されます。このリクエストに対するレスポンスは、変更セットChangeSetArnの ChangeSetIdと を提供し、次のようになります。

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

変更リクエストがキューに追加され、処理されます。これには、AWS Marketplaceガイドラインを満たしていることを確認するための情報の検証が含まれていました。検証プロセスには数分から数時間かかる場合があります。

リクエストのステータスは、 を通じてAWS Marketplace 管理ポータル、または API オペレーションを使用して Catalog DescribeChangeSet API から直接確認できます。

非同期エラー

以下のエラーは、 のAddRegionsアクションに固有のものですAWS Marketplace Catalog API。これらのエラーは、変更セットの処理DescribeChangeSet後に を呼び出すと返されます。DescribeChangeSet を使用して変更リクエストのステータスを取得する方法の詳細については、「」を参照してください変更セットの使用。

新しいインスタンスタイプを追加する

Catalog API を使用して、AMI ベースの製品の新しいインスタンスタイプを追加できますAWS Marketplace。

AddInstanceTypes は、製品の作成時に既存の製品と新しく作成された製品に新しいインスタンスタイプを追加します。変更タイプは、製品ドキュメントのすべてのバージョンを新しいインスタンスタイプで更新します。

制限されたインスタンスタイプを追加する場合、制限されたリストからインスタンスタイプを削除し、使用可能なインスタンスタイプリストに追加できます。これにより、販売者は製品制限の変更をより詳細に制御できます。インスタンスタイプリストは交換可能であり、製品の永続的な制限付きステータスではありません。

内部計測製品の場合、販売者は個別の変更タイプ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 変更タイプを追加するフィールドの情報を入力します。

レスポンスの構文

リクエストの変更セットが作成されます。このリクエストに対するレスポンスは、変更セットChangeSetArnの ChangeSetIdと を提供し、次のようになります。

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

変更リクエストがキューに追加され、処理されます。これには、AWS Marketplaceガイドラインを満たしていることを確認するための情報の検証が含まれていました。検証プロセスには数分から数時間かかる場合があります。

リクエストのステータスは、 を通じてAWS Marketplace 管理ポータル、または API オペレーションを使用して Catalog DescribeChangeSet API から直接確認できます。

同期検証

以下のスキーマ検証は、 のAddInstanceTypesアクションに固有ですAWS Marketplace Catalog API。これらの検証は、 を呼び出すときに実行されますStartChangeSet。リクエストが次の要件を満たしていない場合、HTTP レスポンスで失敗します。

非同期エラー

以下のエラーは、 のAddInstanceTypesアクションに固有のものですAWS Marketplace Catalog API。これらのエラーは、変更セットの処理DescribeChangeSet後に を呼び出すと返されます。DescribeChangeSet を使用して変更リクエストのステータスを取得する方法の詳細については、「」を参照してください変更セットの使用。

インスタンスタイプの制限

Catalog API を使用して、AMI ベースの製品で使用できるインスタンスタイプを制限または制限できますAWS Marketplace。

既存のサブスクライバーは、この変更の影響を受けず、制限されたインスタンスタイプを使用できます。ただし、新しい購入者は制限されたインスタンスタイプを使用できません。現在のインスタンスタイプのサブスクリプションを停止するには (インスタンスタイプが制限されたら）、 AWS MarketplaceSeller Operations チームに連絡する必要があります。

RestrictInstanctTypes は、インスタンスタイプを製品ドキュメントのすべてのバージョンに制限します。AddInstanceTypes 変更タイプでは、製品のすべてのバージョンを更新します。推奨されるインスタンスタイプを制限することはできません。推奨されるインスタンスタイプはバージョンレベルであるため、販売者は複数のインスタンスタイプを制限できない可能性があります。

内部計測製品の場合、 を呼び出すときに個別の変更タイプを呼び出す必要がありますRestrictDimensions。これにより、制限されたインスタンスタイプに対して新しいオファーが作成されなくなります。

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 変更タイプを追加するフィールドの情報を入力します。

レスポンスの構文

リクエストの変更セットが作成されます。このリクエストに対するレスポンスは、変更セットChangeSetArnの ChangeSetIdと を提供し、次のようになります。

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

変更リクエストがキューに追加され、処理されます。これには、AWS Marketplaceガイドラインを満たしていることを確認するための情報の検証が含まれていました。検証プロセスには数分から数時間かかる場合があります。

リクエストのステータスは、 を通じてAWS Marketplace 管理ポータル、または API オペレーションを使用して Catalog DescribeChangeSet API から直接確認できます。

同期検証

以下のスキーマ検証は、 のRestrictInstanceTypesアクションに固有ですAWS Marketplace Catalog API。これらの検証は、 を呼び出すときに実行されますStartChangeSet。リクエストが次の要件を満たしていない場合、HTTP レスポンスで失敗します。

非同期エラー

以下のエラーは、 のRestrictInstanceTypesアクションに固有のものですAWS Marketplace Catalog API。これらのエラーは、変更セットの処理DescribeChangeSet後に を呼び出すと返されます。DescribeChangeSet を使用して変更リクエストのステータスを取得する方法の詳細については、「」を参照してください変更セットの使用。