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

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

AWS Marketplace APIs を使用してコンテナベースの製品を操作する

AWS Marketplace Catalog API を使用して、コンテナベースの製品を操作するタスクを自動化できます。

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

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

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

にコンテナベースの製品がすでにある場合は AWS Marketplace、 AWS Marketplace Catalog API を使用して新しいバージョンを追加できます。そのためには、製品の一部であるコンテナイメージまたはアーティファクト AWS Marketplace ごとに にリポジトリを既に作成し、ローカル Docker および Helm ファイルからコピーできる必要があります。

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

コンテナイメージ配信リクエストの構文

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

レスポンスの構文

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

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

変更リクエストはキューに追加され、コンテナAWS Marketplace 製品のガイドラインを満たしていることを確認するためにコンテナイメージやその他の情報をスキャンするなど、処理されます。コンテナの数とサイズによっては、このプロセスに数分から数時間かかる場合があります。

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

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

非同期エラー

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

Amazon EKS アドオンの可視性を更新する

Catalog API を使用して、 の製品バージョンの Amazon EKS アドオン配信オプションの可視性を更新できます AWS Marketplace。コンテナ製品のコンテナオプションとHelm配信オプションは、「公開」の可視性ステータスで自動的に作成されます。

デフォルトでは、Amazon EKS アドオン配信オプションを使用してバージョンを作成すると、「制限済み」ステータスで公開されます。「制限あり」ステータスは、購入者が Amazon EKS クラスターで使用およびデプロイできる製品がすべてのリージョンで公開されていないことを意味します。UpdateDeliveryOptionsVisibility 変更タイプで StartChangeSet API オペレーションを呼び出すことで、配信オプションの可視性を「制限」から「公開」に更新できます。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 変更タイプを追加するには、次のフィールド の情報を入力します。

レスポンスの構文

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

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

変更リクエストはキューに追加され、処理されます。これには、コンテナイメージやその他の情報をスキャンして、AWS Marketplace コンテナ製品のガイドラインを満たしていることを確認します。コンテナの数とサイズによっては、このプロセスに数分から数時間かかる場合があります。

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

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

非同期エラー

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

リポジトリとリソースを作成する

コンテナベースの製品の新しいバージョンを作成するには、 AWS Marketplace リポジトリで使用可能なバージョンのリソースが必要です。リポジトリを作成し、 Docker (および ) リソースをリポジトリにプッシュ (アップロードHelm) します。を使用してリポジトリを作成する方法については AWS Marketplace 管理ポータル、「 Seller AWS Marketplace Guide」の「Add a new version of your product」を参照してください。

新しいリポジトリを作成するには、次の例に示すように、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」を参照してください。

1 つ以上のリポジトリを作成したら、リソースをリポジトリに追加します。リソースをリポジトリにプッシュする方法については、Amazon Elastic Container Registry ユーザーガイドの「イメージのプッシュ」を参照してください。いずれかのリポジトリに必要な特定のプッシュコマンドの詳細については、「 AWS Marketplace 販売者ガイド」の「新しいバージョンの追加」を参照してください。

非同期エラー

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

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

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

レスポンスの構文

リクエストの変更セットが作成されます。このリクエストに対するレスポンスは、変更セット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 を使用して変更リクエストのステータスを取得する方法の詳細については、「」を参照してください変更セットの使用。

バージョンを制限する

Catalog API を使用して、コンテナベースの製品のバージョンを制限できます AWS Marketplace。これにより、新しい購入者がそのバージョンを使用できなくなります。製品には、少なくとも 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",
        "Type": "ContainerProduct@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 管理ポータル、または API オペレーションを使用して Catalog DescribeChangeSet API から直接確認できます。

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

非同期エラー

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