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

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

販売者製品を操作する

を使用してAWS Marketplace Catalog API、販売者製品を操作するタスクを自動化できます。これには、製品を作成、更新、表示、一覧表示、ソートする機能が含まれます。これにより、製品管理を自動化できます。たとえば、 でセルフサービス発行機能を提供できますAWS Marketplace 管理ポータル。

製品は、販売する予定のユニットまたはリソースでありAWS Marketplace、ベース製品とも呼ばれます。購入者は、製品情報、デプロイ属性、請求情報を追加するまで、ベース製品を使用できません。

製品は、販売する出品の製品情報、ソフトウェアデプロイ属性、請求メカニズムを記述します。販売可能で購入者が使用できる取引可能なユニットになるには、製品をオファーと組み合わせる必要がありますAWS Marketplace。

を使用して以下を行うこともできますAWS Marketplace Catalog API。

各製品タイプには、異なる製品エンティティがあります。エンティティは、製品でもオファーでもかまいませんAWS Marketplace。以下の製品タイプとエンティティがサポートされています。

以下のトピックでは、 API へのアクセス権があり、「」で説明されているように、販売者の前提条件を満たしていることを前提としていますAWS MarketplaceCatalog API のアクセスコントロール。

以下のリソースを参照してください。

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

製品を作成する

Catalog API を使用して、識別子 (製品コードと製品 ID) を含む AMI、コンテナ、機械学習、または SaaS 製品ドキュメントを作成できますAWS Marketplace。

変更CreateProductタイプを使用して StartChangeSet API オペレーションを呼び出すことで、 Draft状態の製品を作成します。

リクエストが正常に処理されると、 は Draft状態の製品AWS Marketplace Catalog APIを生成します。これは不完全な製品であり、購入者には表示されませんAWS Marketplace。

次に、Update変更タイプを使用して、UpdateInformation、UpdateDimensions、UpdateTargeting、UpdateVisibility という製品作成プロセスを完了します。

製品が完了したら、ReleaseProduct 変更タイプを使用して製品作成プロセスを完了し、オファーをリリースできます。このプロセスでは、製品全体を検証し、製品を Limited状態に移行します。

Draft 状態で製品を作成するには、次の例に示すように、 CreateProduct変更タイプで StartChangeSet API オペレーションを呼び出します。

リクエストの構文

POST /StartChangeSet HTTP/1.1
Content-type: application/json

{
"Catalog": "AWSMarketplace",
"ChangeSet": [ 
  { 
    "ChangeType":"CreateProduct",
    "Entity":{
      "Type": "SaaSProduct@1.0" // choose from ["AmiProduct@1.0", "ContainerProduct@1.0", "SaaSProduct@1.0", "MachineLearningProduct@1.0"]
     },
     "DetailsDocument": {
        "ProductTitle": "Test product title set in CreateProduct"
     }
  }
]
}

CreateProduct 変更タイプを追加するフィールドの情報を入力します。この変更タイプは、 がUpdateInformation変更タイプに送信されるのと同じ制限に従い、 ProductTitle 属性に含めることができます。

レスポンスの構文

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

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

変更リクエストがキューに追加され、処理されます。

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

リクエストが完了すると ( Statusが の場合SUCCEEDED)、新しい ProductId が生成されます。

同期検証

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

非同期エラー

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

製品の詳細を更新する

にすでに製品がある場合はAWS Marketplace、 Catalog API を使用して、AMI、コンテナ、ML、または SaaS 製品の製品の詳細を更新できます。

製品の詳細を更新するには、次の例に示すように、UpdateInformation変更タイプと変更する詳細を使用して StartChangeSet API オペレーションを呼び出します。

リクエストの構文

POST /StartChangeSet HTTP/1.1
Content-type: application/json

{
  "Catalog": "AWSMarketplace",
  "ChangeSet":
  [
    {
      "ChangeType": "UpdateInformation",
      "Entity":
      {
        "Identifier": "prod-example12345",
        "Type": "AmiProduct@1.0"
      },
      "DetailsDocument":
      {
        "ProductTitle": "My Product Title",
        "ShortDescription": "My product short description.",
        "LongDescription": "My product longer description.",
        "Sku": "123example456",
        "LogoUrl": "https://awsmp-logos.s3.amazonaws.com/ca60b754fe05a24257176cdbf31c4e0d",
        "VideoUrls":
        [
          "https://example.com/my-video"
        ],
        "Highlights":
        [
          "123example45"
        ],
        "AdditionalResources":
        [
          {
            "Text": "123example456",
            "Url": "https://example.com/some-link"
          }
        ],
        "SupportDescription": "Need help? Contact our experts at support@example.com \n\nYour purchase includes 24x7 support.",
        "Categories":
        [
          "Operating Systems",
          "Network Infrastructure",
          "Application Development"
        ],
        "SearchKeywords":
        [
          "123example456"
        ]
      }
    }
  ]
}

UpdateInformation 変更タイプを追加するフィールドの情報を入力します。

レスポンスの構文

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

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

変更リクエストがキューに追加され、処理されます。

リクエストのステータスを確認するには、 を使用するAWS Marketplace 管理ポータルか、 DescribeChangeSet API を呼び出します。

同期検証

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

非同期エラー

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

料金設定ディメンションを追加する

AWS Marketplace Catalog Service Actions を使用して、AMI、コンテナ、または SaaS 製品の料金をユーザーに請求できる請求可能な料金ディメンションを追加できます。

料金ディメンションは、販売者が購入者に請求するために定義する測定単位です。販売者は、使用量ベースまたは契約ベースの料金モデルを問わず、製品の使用について購入者に請求するためにこの情報を設定する必要があります。ディメンションのタイプは、製品の料金モデルによって異なります。

製品の料金の詳細については、 AWS Marketplace販売者ガイドの以下のトピックを参照してください。

を使用して料金ディメンションを追加する方法の詳細についてはAWS Marketplace 管理ポータル、 AWS Marketplace販売者ガイドの以下のトピックを参照してください。

料金ディメンションを追加するには、次の例に示すように、AddDimensions変更タイプを使用して StartChangeSet API を呼び出します。

リクエストの構文

POST /StartChangeSet HTTP/1.1
Content-type: application/json

{
  "Catalog": "AWSMarketplace",
  "ChangeSet":
  [
    {
      "ChangeType": "AddDimensions",
      "DetailsDocument":
      [
        {
          "Description": "Description of the dimension",
          "Key": "UniqueApiKey",
          "Unit": "HostHrs",
          "Name": "First Dimension",
          "Types":
          [
            "ExternallyMetered"
          ]
        }
      ],
      "Entity":
      {
        "Identifier": "prod-example12345",
        "Type": "SaaSProduct@1.0"
      }
    }
  ]
}

AddDimensions 変更タイプに次のフィールドを指定します。

レスポンスの構文

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

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

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

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

同期検証

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

非同期エラー

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

料金設定ディメンションを更新する

Catalog API を使用して、 の AMI、コンテナ、または SaaS 製品の既存の料金ディメンションを更新できますAWS Marketplace。

各ディメンションは、更新を実行するディメンションキーとディメンションタイプによって一意に識別されます。ディメンションを更新しても、元のディメンションが作成したアクティブなオファーや顧客には影響しません。

料金ディメンションを更新するには、次の例に示すように、UpdateDimensions変更タイプを使用して StartChangeSet API オペレーションを呼び出します。

リクエストの構文

POST /StartChangeSet HTTP/1.1
Content-type: application/json

{
  "Catalog": "AWSMarketplace",
  "ChangeSet":
  [
    {
      "ChangeType": "UpdateDimensions",
      "DetailsDocument":
      [
        {
          "Key": "UniqueApiKey",
          "Types":
          [
            "ExternallyMetered"
          ],
          "Name": "First Dimension",
          "Description": "Description of the dimension"
        }
      ],
      "Entity":
      {
        "Identifier": "prod-example12345",
        "Type": "SaaSProduct@1.0"
      }
    }
  ]
}

UpdateDimensions 変更タイプで次のフィールドを使用します。

レスポンスの構文

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

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

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

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

同期検証

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

非同期エラー

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

料金ディメンションを制限する

Catalog API を使用して、 の AMI または SaaS 製品の既存の料金ディメンションを制限できますAWS Marketplace。

各ディメンションは、更新を実行するディメンションキーとディメンションタイプによって一意に識別されます。ディメンションを制限しても、元のディメンションが作成したアクティブなオファーや顧客には影響しません。

料金ディメンションを制限するには、 RestrictDimensions変更タイプを使用して StartChangeSet API を呼び出します。

次の例は、SaaS 製品のEntitledディメンションを制限する方法を示しています。

リクエストの構文

POST /StartChangeSet HTTP/1.1
Content-type: application/json

{
  "Catalog": "AWSMarketplace",
  "ChangeSet":
  [
    {
      "ChangeType": "RestrictDimensions",
      "DetailsDocument":
      [
        {
          "Key": "UniqueApiKey",
          "Types": ["Entitled"]
        }
      ],
      "Entity":
      {
        "Identifier": "prod-example12345",
        "Type": "SaaSProduct@1.0"
      }
    }
  ]
}

RestrictDimensions 変更タイプで次のフィールドを使用します。

レスポンスの構文

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

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

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

リクエストのステータスを確認するには、 を使用するかAWS Marketplace 管理ポータル、 DescribeChangeSet API を呼び出します。

同期検証

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

非同期エラー

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

ターゲット設定を更新する

Catalog API を使用して、UpdateTargeting変更タイプを呼び出すことで、PublicAMI、コンテナ、ML、または SaaS 製品が表示されるAWS Marketplace前に で表示できる AWS アカウントIDs を追加できます。

マネージドカタログオペレーション (MCO) アカウントは、新しい製品の作成時に、許可されたアカウントリストに自動的に追加されます。これらの MCO アカウントは、許可されたアカウントを表示するときにAWS Marketplace管理ポータル (AMMP) で販売者に表示され、DescribeEntityAPI レスポンスの Targetingセクションに表示されます。

AMI、コンテナ、ML、または SaaS 製品を表示できる AWS アカウントIDs を表示するには、次の例に示すように、UpdateTargeting変更タイプを使用して StartChangeSet API オペレーションを呼び出します。

リクエストの構文

POST /StartChangeSet HTTP/1.1
Content-type: application/json

{
  "Catalog": "AWSMarketplace",
  "ChangeSet":
  [
    {
      "ChangeType": "UpdateTargeting",
      "Entity":
      {
        "Type": "SaaSProduct@1.0",
        "Identifier": "prod-example12345"
      },
      "DetailsDocument":
      {
        "PositiveTargeting":
        {
          "BuyerAccounts":
          [
            "1112223334444"
          ]
        }
      }
    }
  ]
}

UpdateTargeting 変更タイプで次のフィールドを使用します。

レスポンスの構文

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

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

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

リクエストのステータスを確認するには、 を使用するAWS Marketplace 管理ポータルか、 DescribeChangeSet API を呼び出します。

リクエストが完了すると ( Statusが の場合SUCCEEDED)、新しい ProductId が生成されます。

同期検証

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

非同期エラー

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

製品の可視性を更新する

Catalog API を使用して、 の AMI、コンテナ、ML、または SaaS 製品の可視性 (ライフサイクル状態とも呼ばれます) を更新できますAWS Marketplace。

許可されるターゲットライフサイクルの状態は、Limited、Public、または ですRestricted。

製品の可視性を更新するには、次の例に示すように、UpdateVisibility変更タイプを使用して StartChangeSet API オペレーションを呼び出します。

リクエストの構文

TargetVisibility が Publicまたは の場合Limited。

POST /StartChangeSet HTTP/1.1
Content-type: application/json

{
  "Catalog": "AWSMarketplace",
  "ChangeSet":
  [
    {
      "ChangeType": "UpdateVisibility",
      "Entity":
      {
        "Type": "SaaSProduct@1.0",
        "Identifier": "prod-example12345"
      },
      "DetailsDocument":
      {
        "TargetVisibility": "Public"
      }
    }
  ]
}

TargetVisibility が の場合Restricted。

POST /StartChangeSet HTTP/1.1
Content-type: application/json

{
  "Catalog": "AWSMarketplace",
  "ChangeSet":
  [
    {
      "ChangeType": "UpdateVisibility",
      "Entity":
      {
        "Type": "SaaSProduct@1.0",
        "Identifier": "prod-example12345"
      },
      "DetailsDocument":
      {
        "TargetVisibility": "Restricted",
        "ReplacementProductId": "prod-example54321"
      }
    }
  ]
}

UpdateVisibility 変更タイプを追加するフィールドの情報を入力します。

同期検証

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

この変更タイプをトリガーした後、完了までに最大 37 日かかる場合があります。これには、 AWS MarketplaceSeller Operations Team がレビュー、監査、承認する必要がある時間が含まれます。製品を制限する場合、 AWS MarketplaceSeller Operations Team が監査を開始する前に、 を呼び出しCancelChangeSetて 24 時間変更する必要があります。詳細については、「CancelChangeSet」を参照してください。

レスポンスの構文

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

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

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

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

リクエストが完了すると ( Statusが の場合SUCCEEDED)、新しい ProductId が生成されます。

非同期エラー

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

製品を公開する

Catalog API を使用して、DraftAMI、コンテナ、ML、または SaaS 製品を Limited状態に公開できますAWS Marketplace。

製品を公開するには、次の例に示すように、ReleaseProduct変更タイプを使用して StartChangeSet API オペレーションを呼び出します。

リクエストの構文

POST /StartChangeSet HTTP/1.1
Content-type: application/json

{
  "Catalog": "AWSMarketplace",
  "ChangeSet":
  [
    {
      "ChangeType": "ReleaseProduct",
      "Entity":
      {
        "Type": "SaaSProduct@1.0",
        "Identifier": "prod-example12345"
      },
      "DetailsDocument": {}
    }
  ]
}

ReleaseProduct 変更タイプに追加するフィールドの情報を入力します。この変更タイプはパラメータペイロードを受け取りません。

レスポンスの構文

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

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

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

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

リクエストが完了すると ( Statusが の場合SUCCEEDED)、新しい ProductId が生成されます。

非同期エラー

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

製品 ID を検索する

Catalog API でAWS Marketplace変更する前に、製品の製品 ID を取得する必要があります。サーバー製品の製品 ID を検索するには、次の 2 つの方法があります。

以下のトピックでは、エンティティ ID、製品タイトル、最終更新日、または可視性をフィルタリングして製品を検索する方法について説明します。

製品タイトルに基づいて製品を検索する

リクエスト

POST /ListEntities HTTP/1.1
Content-Type: application/json
      
{
    "Catalog": "AWSMarketplace",
    "EntityType": "AmiProduct",
    "MaxResults": 10,
    "EntityTypeFilters": {
        "AmiProductFilters": {
            "ProductTitle": {
                "WildCardValue": "XYZ"
            }
        }
    }
}

レスポンス

HTTP/1.1 200
Content-type: application/json

{ 
  "EntitySummaryList": [ 
    { 
      "EntityArn": "arn:aws:aws-marketplace:us-east-1:123456789012:AWSMarketplace/AmiProduct/example-abcd-1234",
      "EntityId": "example1-abcd-1234-5ef6-7890abcdef12@1",
      "EntityType": "AmiProduct",
      "LastModifiedDate": "2018-02-27T13:45:22Z",
       "AmiProductSummary": {
            "ProductTitle": "ABC-XYZ-123",
            "Visibility": "Public"
       }
    } 
  ],
  "NextToken": "" 
}

最終変更日に基づいて製品を検索する

リクエスト

POST /ListEntities HTTP/1.1
Content-Type: application/json
      
{
    "Catalog": "AWSMarketplace",
    "EntityType": "AmiProduct",
    "MaxResults": 10,
    "EntityTypeFilters": {
        "AmiProductFilters": {
            "LastModifiedDate": {
                "DateRange": {
                    "BeforeValue": "2018-03-27T13:45:22Z",
                    "AfterValue": "2018-01-27T13:45:22Z"
                }
            }
        }
    }
}

レスポンス

HTTP/1.1 200
Content-type: application/json

{ 
  "EntitySummaryList": [ 
    { 
      "EntityArn": "arn:aws:aws-marketplace:us-east-1:123456789012:AWSMarketplace/AmiProduct/example-abcd-1234",
      "EntityId": "example1-abcd-1234-5ef6-7890abcdef12@1",
      "EntityType": "AmiProduct",
      "LastModifiedDate": "2018-02-27T13:45:22Z",
       "AmiProductSummary": {
            "ProductTitle": "ABC-XYZ-123",
            "Visibility": "Public"
       }
    } 
  ],
  "NextToken": "" 
}

製品の可視性に基づいて製品を検索する

リクエスト

POST /ListEntities HTTP/1.1
Content-Type: application/json
      
{
    "Catalog": "AWSMarketplace",
    "EntityType": "AmiProduct",
    "MaxResults": 10,
    "EntityTypeFilters": {
        "AmiProductFilters": {
            "Visibility": {
                "ValueList": [
                    "Public"
                ]
            }
        }
    }
}

レスポンス

HTTP/1.1 200
Content-type: application/json

{ 
  "EntitySummaryList": [ 
    { 
      "EntityArn": "arn:aws:aws-marketplace:us-east-1:123456789012:AWSMarketplace/AmiProduct/example-abcd-1234",
      "EntityId": "example1-abcd-1234-5ef6-7890abcdef12@1",
      "EntityType": "AmiProduct",
      "LastModifiedDate": "2018-02-27T13:45:22Z",
       "AmiProductSummary": {
            "ProductTitle": "ABC-XYZ-123",
            "Visibility": "Public"
       }
    } 
  ],
  "NextToken": "" 
}

製品のタイトル、最終更新日、製品の可視性に基づいて製品を検索する

リクエスト

POST /ListEntities HTTP/1.1
Content-Type: application/json
      
{
    "Catalog": "AWSMarketplace",
    "EntityType": "AmiProduct",
    "MaxResults": 10,
    "EntityTypeFilters": {
        "AmiProductFilters": {
            "LastModifiedDate": {
                "DateRange": {
                    "BeforeValue": "2018-03-27T13:45:22Z",
                    "AfterValue": "2018-01-27T13:45:22Z"
                }
            },
            "Visibility": {
                "ValueList": [
                    "Public"
                ]
            },
            "ProductTitle": {
                "ValueList": [
                    "ABC-XYZ-123"
                ]
            }
        }
    }
}

レスポンス

HTTP/1.1 200
Content-type: application/json

{ 
  "EntitySummaryList": [ 
    { 
      "EntityArn": "arn:aws:aws-marketplace:us-east-1:123456789012:AWSMarketplace/AmiProduct/example-abcd-1234",
      "EntityId": "example1-abcd-1234-5ef6-7890abcdef12@1",
      "EntityType": "AmiProduct",
      "LastModifiedDate": "2018-02-27T13:45:22Z",
       "AmiProductSummary": {
            "ProductTitle": "ABC-XYZ-123",
            "Visibility": "Public"
       }
    } 
  ],
  "NextToken": "" 
}

製品に関する追加の詳細を取得する

エンティティ ID と DescribeEntityアクションを使用して、製品に関する追加の詳細を取得できます。

リクエスト

GET /DescribeEntity?catalog=AWSMarketplace&entityId=example-abcd-1234 HTTP/1.1

レスポンス

HTTP/1.1 200
Content-type: application/json

{
   "DetailsDocument": {
        "ProductTitle": "ABC-XYZ-123",
        "ShortDescription": "My product short description.", 
        "LongDescription": "My product longer description.", 
        "Sku": "123example456", 
        "SupportDescription": "Need help? Contact our experts at support@example.com \n\nYour purchase includes 24x7 support.", 
        "Categories": [ 
            "Operating Systems", 
            "Network Infrastructure", 
            "Application Development" 
            ] 
   }
    "EntityArn": "arn:aws:aws-marketplace:us-east-1:123456789012:AWSMarketplace/AmiProduct/example-abcd-1234",
    "EntityId": "example1-abcd-1234-5ef6-7890abcdef12@1",
    "EntityType": "AmiProduct",
    "LastModifiedDate": "2018-02-27T13:45:22Z",
}

変更セットのステータスとエラー

AWS MarketplaceCatalog API で販売者製品に変更を加えるには、実行する変更を記述する変更セットを作成し、 StartChangeSetアクションを使用して変更を開始します。リクエストからの変更の完了には、リクエストに応じて数分から数時間以上かかる場合があります。このリクエストに対するレスポンスは次のようになります。

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

変更リクエストはキューに追加され、製品のAWS Marketplaceガイドラインを満たしていることを確認するためにファイルと情報をスキャンするなど、処理されます。変更リクエストによっては、このプロセスに数分から数日かかる場合があります。リクエストのステータスは、 を通じてAWS Marketplace 管理ポータル、または DescribeChangeSetアクションを使用して Catalog API で確認できます。変更セットに関する詳細については、「変更セットの使用」を参照してください。

リクエストのステータスを確認するには、 DescribeChangeSetアクションを使用します。

POST /DescribeChangeSet HTTP/1.1
Content-type: application/json

{
   "Catalog": "AWSMarketplace",
   "ChangeSetID": "example123456789012abcdef"
}

この呼び出しの結果は次のようになります (この場合は、コンテナ製品に新しいバージョンを追加する場合）。

{
  "ChangeSetId": "example123456789012abcdef",
  "ChangeSetArn": "arn:aws:aws-marketplace:us-east-1:123456789012:AWSMarketplace/ChangeSet/example123456789012abcdef",
  "ChangeSetName": "Submitted by 123456789012",
  "StartTime": "2020-10-27T22:21:26Z",
  "EndTime": "2020-10-27T22:32:19Z",
  "Status": "SUCCEEDED",
  "ChangeSet":
  [
    {
      "ChangeType": "AddDeliveryOptions",
      "Entity":
      {
        "Type": "ContainerProduct@1.0",
        "Identifier": "example-1234-abcd-56ef-abcdef12345678@4"
      },
      "Details": "{\"Version\": {\"VersionTitle\": \"1.1\",\"ReleaseNotes\": \"Minor bug fix\"},\"DeliveryOptions\": [{\"DeliveryOptionTitle\": \"EKSDelivery\",\"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\"}}},{\"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}\"}]}}}]}",
      "DetailsDocument":
      {
        "Version":
        {
          "VersionTitle": "1.1",
          "ReleaseNotes": "Minor bug fix"
        },
        "DeliveryOptions":
        [
          {
            "DeliveryOptionTitle": "EKSDelivery",
            "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"
              }
            }
          },
          {
            "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}"
                  }
                ]
              }
            }
          }
        ]
      },
      "ErrorDetailList":
      []
    }
  ]
}

Status フィールドには、リクエストの現在のステータスが表示されます。この場合は、 ですSUCCEEDED。

失敗した場合、結果には 2 種類のエラーが含まれる可能性があります。ほとんどのエラーの場合、エラーメッセージは直接含まれます。ただし、製品のセキュリティ脆弱性のスキャン中に見つかったエラーには、 ErrorMessageフィールドで見つかったすべてのエラーを一覧表示するファイルへの URL が含まれます。スキャン中に見つかったエラーにはErrorCodeSCAN_ERROR「」があります。

{
  "ChangeSetId": "example123456789012abcdef",
  "ChangeSetArn": "arn:aws:aws-marketplace:us-east-1:123456789012:AWSMarketplace/ChangeSet/example123456789012abcdef",
  "ChangeSetName": "Submitted by 123456789012",
  "StartTime": "2020-10-27T22:21:26Z",
  "EndTime": "2020-10-27T22:32:19Z",
  "Status": "FAILED",
  "FailureDescription": "Change set preparation has failed. For details see 'ErrorDetailList'.",
  "ChangeSet":
  [
    {
      "ChangeType": "AddDeliveryOptions",
      "Entity":
      {
        "Type": "ContainerProduct@1.0",
        "Identifier": "example-1234-abcd-56ef-abcdef12345678@4"
      },
      "Details": "{\"Version\": {\"VersionTitle\": \"1.1\",\"ReleaseNotes\": \"Minor bug fix\"},\"DeliveryOptions\": [{\"DeliveryOptionTitle\": \"EKSDelivery\",\"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\"}}},{\"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}\"}]}}}]}",
      "DetailsDocument":
      {
        "Version":
        {
          "VersionTitle": "1.1",
          "ReleaseNotes": "Minor bug fix"
        },
        "DeliveryOptions":
        [
          {
            "DeliveryOptionTitle": "EKSDelivery",
            "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"
              }
            }
          },
          {
            "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}"
                  }
                ]
              }
            }
          }
        ]
      },
      "ErrorDetailList":
      [
        {
          "ErrorCode": "DUPLICATE_VERSION_TITLE",
          "ErrorMessage": "The version title must be different from any other version titles of this product."
        },
        {
          "ErrorCode": "SCAN_ERROR",
          "ErrorMessage": "https://123sample456.cloudfront.net/example-1234-abcd-5678-abcdef12345678/1234abcdef567890"
        }
      ]
    }
  ]
}

この例では、1 つのエラーが直接報告されています (DUPLICATE_VERSION_TITLE)。もう 1 つのエラーには、エラーメッセージを含むファイルがあります (1 つの は、リンクされているファイルで複数のエラーを検出SCAN_ERRORできます）。