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

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

AWS MarketplaceAPI を使用してプライベートマーケットプレイスを操作する

を使用してAWS Marketplace Catalog API、 AWS アカウントまたは組織のプライベートマーケットプレイスを管理できます。

すべての変更タイプは、組織の管理アカウントまたはプライベートマーケットプレイスの委任管理者であるメンバーアカウントからのみ呼び出すことができます。プライベートマーケットプレイスAWS Organizationsの統合がない現在のプライベートマーケットプレイスのお客様は、IAM AWSPrivateMarketplaceAdminFullAccess ポリシーを持つ組織内の任意のアカウントからプライベートマーケットプレイスを作成および管理できます。

プライベートマーケットプレイスの詳細については、「 AWS Marketplace購入者ガイド」の「プライベートマーケットプレイス」を参照してください。

次の表は、プライベートマーケットプレイスを管理するタスクのセットと、各タスクに適用される変更タイプの詳細を示しています。

プライベートマーケットプレイスの作成

のプライベートマーケットプレイスは、ユーザーがそのアカウントで調達できる製品のリストと、マーケットプレイスのブランドと考えるAWS アカウントことができます。複数のアカウントを持つ組織では、呼び出された組織単位 (OU) からのAWS Organizationsグループ化を使用して、 エクスペリエンスに関連付けることができます。たとえば、組織内のすべてのアカウントが調達できる製品のセットを 1 つ持つか、組織内の OU ごとに異なる製品リストを持つことができます。組織内の個々のアカウントの製品の別のリストを作成することもできます。承認された製品とブランドの各リストは、調達エクスペリエンスと呼ばれます。

ではAWS Marketplace Catalog API、4 つのエンティティがエクスペリエンスを表します。

調達エクスペリエンスを作成する手順は次のとおりです。

Experienceエンティティを作成する

Experience エンティティを作成するには、 ChangeTypeパラメータCreateExperienceの値を持つ StartChangeSetアクションを使用して、エクスペリエンスの作成をリクエストしますAWS Marketplace。次のコード例を参照してください。

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

{
  "Catalog": "AWSMarketplace",
  "ChangeSet":
  [
    {
      "ChangeType": "CreateExperience",
      "DetailsDocument":
      {
        "Name": "ExamplePrivateMarketplace"
      },
      "Entity":
      {
        "Type": "Experience@1.0"
      }
    }
  ],
  "ChangeSetName": "Create Private Marketplace Example"
}

このアクションでは、 Entityは作成するエンティティのテンプレートです。作成EntityId時に が割り当てられます。 は変更ChangeSetNameを識別し、後で見つけるのに役立ちます。

レスポンスは以下のようになります。

{
   "ChangeSetArn": "arn:...:AWSMarketplace/ChangeSet/abcd1234example5678frjzkz",
   "ChangeSetId": "abcd1234example5678frjzkz"
}

レスポンスには、 で処理ChangeSetIdされる変更リクエストのステータスを取得するために使用できる が含まれていますDescribeChangeSet。ListEntities を使用して、 なしでExperienceエンティティを検索することもできますChangeSetId。変更セットに関する詳細については、「変更セットの使用」を参照してください。

新しく作成されたExperienceエンティティには、デフォルトでは調達ポリシーがありません。また、ブランディングのデフォルト設定で作成されます。カスタマイズ方法など、ブランド設定の詳細については、「」を参照してくださいプライベートマーケットプレイスエクスペリエンスのブランドの変更。

ProcurementPolicyエンティティを作成する

ProcurementPolicy エンティティを作成する必要があります。デフォルトでは、新しいExperienceエンティティが無効になっているため、有効にする前に調達ポリシーを作成できます。

プライベートマーケットプレイスで製品を許可または拒否するには、調達ポリシーを作成する必要があります。これを行うには、 を再度呼び出しますがStartChangeSet、今回は ChangeTypeの を使用しますCreateProcurementPolicy。次のコード例では、空の調達ポリシーを作成します。

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

{
  "Catalog": "AWSMarketplace",
  "ChangeSet":
  [
    {
      "ChangeType": "CreateProcurementPolicy",
      "DetailsDocument":
      {
        "Name": "ExampleProcurementPolicy"
      },
      "Entity":
      {
        "Type": "Experience@1.0",
        "Identifier": "exp-1234example@1"
      }
    }
  ]
}

このアクションでEntity指定する は、調達ポリシーを作成するExperienceエンティティであるため、前に作成したエンティティの識別子を含める必要があります。ListEntities を使用してExperienceエンティティを検索します。CreateExperience アクションの変更セット識別子DescribeChangeSetとともに を使用して識別子を返すこともできます。

CreateProcurementPolicy 変更タイプDescribeChangeSetで を再度使用して、リクエストの処理に従うことができます。

調達ポリシーを作成すると、プライベートマーケットプレイスが に表示されますAWS Management Console。(Private Marketplace ページに移動して確認できます）。これらのステップを完了すると、プライベートマーケットプレイスは無効になり、デフォルトのブランドが設定され、空の調達ポリシーが設定され、組織内のプリンシパルに関連付けられません。ブランドを更新し、必要な製品を追加し、エクスペリエンスを 1 つ以上のアカウントに関連付けてから、プライベートマーケットプレイスを有効にできます。

以下のセクションでは、 を使用したプライベートマーケットプレイスの管理について説明しますAWS Marketplace Catalog API。

プライベートマーケットプレイスエクスペリエンスのブランドの変更

ユーザーのプライベートマーケットプレイスの外観をカスタマイズできます。カスタマイズしない場合、プライベートマーケットプレイスには、以下に説明するデフォルトのブランド設定があります。プライベートマーケットプレイスで変更できるブランドの側面は次のとおりです。

これらの値を設定するには、まずCreateBrandingSettings変更タイプを使用してBrandingSettingsエンティティを作成する必要があります。その後、ブランドを設定または変更するUpdateBrandingSettings変更をリクエストできます。BrandingSettings オブジェクトを作成する必要があるのは 1 回だけです。このオブジェクトを作成するには、次のコード例に示すように、CreateBrandingSettings変更タイプStartChangeSetで を呼び出します。

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

{
  "Catalog": "AWSMarketplace",
  "ChangeSet":
  [
    {
      "ChangeType": "CreateBrandingSettings",
      "DetailsDocument":
      {
        "Name": "ExampleBrandingSettingsName"
      },
      "Entity":
      {
        "Type": "Experience@1.0",
        "Identifier": "exp-1234example@2"
      }
    }
  ]
}

この例では、 BrandingSettings オブジェクトを追加してExperienceエンティティを変更します。エンティティ識別子のリビジョンが に増加しました2。識別子のリビジョンの詳細については、「」を参照してください識別子。

設定を変更するには、 UpdateBrandingSettings を変更タイプStartChangeSetで呼び出します。設定は、 DetailsDocument オブジェクトConfigurationの の一部です。

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

{
  "Catalog": "AWSMarketplace",
  "ChangeSet":
  [
    {
      "ChangeType": "UpdateBrandingSettings",
      "DetailsDocument":
      {
        "Name": "ExampleBrandingSettingsName",
        "Description": "Example description",
        "Configuration":
        {
          "Title": "ExampleName",
          "Information": "Example description.",
          "ThemeColor": "#0e7f74",
          "LogoUrl": "https://example.com/path/mylogo.png"
        }
      },
      "Entity":
      {
        "Type": "Experience@1.0",
        "Identifier": "exp-1234example@3"
      }
    }
  ]
}

プライベートマーケットプレイスエクスペリエンスの有効化または無効化

プライベートマーケットプレイスが有効になっている (および調達ポリシーがある) 場合、関連付けられたアカウントのユーザーは、承認された製品のみを購入できます。アカウントでプライベートマーケットプレイスエクスペリエンスが有効になっていない場合、ユーザーはAWS Marketplaceカタログ全体で製品を購入できます。

プライベートマーケットプレイスを有効にするには、UpdateExperience変更タイプで StartChangeRequestアクションを使用します。

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

{
  "Catalog": "AWSMarketplace",
  "ChangeSet":
  [
    {
      "ChangeType": "UpdateExperience",
      "DetailsDocument":
      {
        "Status": "Enabled"
      },
      "Entity":
      {
        "Type": "Experience@1.0",
        "Identifier": "exp-1234example@4"
      }
    }
  ]
}

同様に、同じアクション と を使用できますがChangeType、 Statusの DetailsDocumentを に変更Disabledしてプライベートマーケットプレイスを無効にします。

ユーザーリクエストの有効化または無効化

組織内のユーザーはフルパブリックを表示できますがAWS Marketplace、許可された製品にのみサブスクライブできます。デフォルトでは、プライベートマーケットプレイスにない製品の追加をリクエストできます。これらのリクエストは、プライベートマーケットプレイス管理者ページ (Private Marketplace) に表示され、リクエストを受け入れるか拒否するか (および同じ製品のリクエストをさらにブロックするかどうか) を決定できます。Catalog API を使用してリクエストを表示または応答することはできません。

ユーザーがプライベートマーケットプレイスエクスペリエンスのリクエストを作成する機能を有効または無効にできます。UpdateProcurementPolicy 変更タイプStartChangeSetで を使用します。次のコード例では、リクエストを行う機能は無効になっています。

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

{
  "Catalog": "AWSMarketplace",
  "ChangeSet":
  [
    {
      "ChangeType": "UpdateProcurementPolicy",
      "DetailsDocument":
      {
        "Configuration":
        {
          "PolicyResourceRequests": "Deny"
        }
      },
      "Entity":
      {
        "Type": "Experience@1.0",
        "Identifier": "exp-1234example@5"
      }
    }
  ]
}

ユーザーの変更リクエスト機能を有効にするには、 Deny で Allowの代わりに を使用しますPolicyResourceRequests。

この設定の現在のステータスを取得する方法については、次のセクション「」を参照してくださいプライベートマーケットプレイスエクスペリエンスの製品リストの取得。

プライベートマーケットプレイスエクスペリエンスの製品リストの取得

プライベートマーケットプレイスで許可 (および拒否) された製品は、Experienceエンティティの調達ポリシーの一部です。プライベートマーケットプレイスの調達ポリシーの詳細を取得するには、まずExperienceエンティティから調達ポリシー識別子を取得し、その識別子DescribeEntityを使用して を呼び出します。

調達ポリシー識別子を取得するには、次のコマンドに示すように、関心のあるExperienceエンティティDescribeEntityで を使用します。

GET /DescribeEntity?catalog=AWSMarketplace&entityId=exp-example01

以下に、応答の例を示します。

{
  "Details": "{\"Name\":\"New Private Marketplace\", \"Status\":\"Enabled\", \"ProcurementPolicies\":[\"procpolicy-123example456\"], \"BrandingSettings\":[\"brandsettings-456example123\"]}",
  "DetailsDocument":
  {
    "Name": "New Private Marketplace",
    "Status": "Enabled",
    "ProcurementPolicies":
    [
      "procpolicy-123example456"
    ],
    "BrandingSettings":
    [
      "brandsettings-456example123"
    ]
  },
  "EntityArn": "arn:<...>:AWSMarketplace/Experience/exp-example-01",
  "EntityIdentifier": "exp-example01@6",
  "EntityType": "Experience@1.0",
  "LastModifiedDate": "2021-01-13T20:31:36Z"
}

次のコマンドに示すように、調達ポリシーEntityIdに返された を使用して詳細を取得できます。

GET /DescribeEntity?catalog=AWSMarketplace&entityId=procpolicy-123example456

これにより、許可された製品と拒否された製品の両方を含む、ポリシーの完全な詳細が返されます。以下に、応答の例を示します。

{
  "Details": "{\"Name\":\"ExampleProcurementPolicy\", \"Statements\":[{\"Effect\":\"Allow\",\"Resources\":[{\"Type\":\"Product\",\"Ids\":[\"example1-1234-abcd-5678-90abcdef1234\"]},{\"Type\":\"Product\",\"Ids\":[\"example2-2345-bcde-6789-01bcdea2345\"]}]},{\"Effect\":\"Deny\",\"Resources\":[{\"Type\":\"Product\",\"Ids\":[\"example3-3456-cdef-7890-12defabc5678\"]}]}],\"Configuration\":{\"PolicyResourceRequests\":\"Allow\"}}",
  "DetailsDocument":
  {
    "Name": "ExampleProcurementPolicy",
    "Statements":
    [
      {
        "Effect": "Allow",
        "Resources":
        [
          {
            "Type": "Product",
            "Ids":
            [
              "example1-1234-abcd-5678-90abcdef1234"
            ]
          },
          {
            "Type": "Product",
            "Ids":
            [
              "example2-2345-bcde-6789-01bcdea2345"
            ]
          }
        ]
      },
      {
        "Effect": "Deny",
        "Resources":
        [
          {
            "Type": "Product",
            "Ids":
            [
              "example3-3456-cdef-7890-12defabc5678"
            ]
          }
        ]
      }
    ],
    "Configuration":
    {
      "PolicyResourceRequests": "Allow"
    }
  },
  "EntityArn": "arn:<...>AWSMarketplace/ProcurementPolicy/procpolicy-123example456",
  "EntityIdentifier": "procpolicy-123example456@4",
  "EntityType": "ProcurementPolicy@1.0",
  "LastModifiedDate": "2020-10-01T12:00:00Z"
}

この例では、調達ポリシーに 2 つの許可された製品と 1 つの拒否された製品があります。このポリシーは、ユーザーリソースリクエストを許可します。

プライベートマーケットプレイスへの製品の追加または削除

デフォルトでは、プライベートマーケットプレイスには承認された製品はありません。変更リクエストを使用して、製品を追加または削除します。製品を追加するには、 AllowProductProcurement 変更タイプを使用します。製品を削除するには、 DenyProductProcurement 変更タイプを使用します。

次のコード例は、プライベートマーケットプレイスに製品を追加するStartChangeSetアクションを含むAllowProductProcurement変更タイプを示しています。

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

{
  "Catalog": "AWSMarketplace",
  "ChangeSet":
  [
    {
      "ChangeType": "AllowProductProcurement",
      "DetailsDocument":
      {
        "Products":
        [
          {
            "Ids":
            [
              "example-1234-abcd-5678-90abcded1234"
            ],
            "Notes": "Useful product"
          }
        ]
      },
      "Entity":
      {
        "Identifier": "exp-1234example@6",
        "Type": "Experience@1.0"
      }
    }
  ]
}

を使用して、プライベートマーケットプレイスのExperienceエンティティに製品を追加しますAllowProductProcurement。プライベートマーケットプレイスから製品を削除する構文は同じですが、 DenyProductProcurementChangeTypeの代わりに を使用する点が異なりますAllowProductProcurement。製品は、エンティティに含まれるProcurementPolicyエンティティの許可 (または拒否) リストに追加されますExperience。

製品を検索する

調達ポリシーの詳細を取得することで、すでにプライベートマーケットプレイスにある製品の製品 IDs を見つけることができます。ただし、 AWS Marketplace Catalog APIでは、他の製品の製品 IDsを検索することはできません。Catalog API サービスで使用する製品 IDsを取得するには、次の 2 つの方法があります。

のプライベートマーケットプレイスの使用AWS Organizations

アカウントまたは組織のプライベートマーケットプレイスを使用している場合でも、同じ API を使用します。ただし、組織内での作業には違いがあります。

自分のアカウントのExperienceオブジェクトを一覧表示するには、次のコード例ListEntitiesに示すように を呼び出します。

POST /ListEntities HTTP/1.1
Content-Type: application/json

{
    "Catalog":"AWSMarketplace", 
    "EntityType":"Experience"
}

ただし、共有されているエンティティを一覧表示するには、次のコード例に示すようにSharedWithMe、 を Scopeの FilterList で追加する必要があります。その結果、 は自分のアカウントの外部AWS Marketplaceを検索して、共有されているエンティティを検索します。

POST /ListEntities HTTP/1.1
Content-Type: application/json

{"Catalog":"AWSMarketplace", 
"EntityType":"Experience",
 "FilterList": 
  [{
     "Name": "Scope",
     "ValueList":
      ["SharedWithMe"]
      }]}

この場合、アカウント外のエンティティ (組織のエンティティ) のみが返されます。

同様に、 を呼び出すにはListChangeSets、次のコード例に示すように、スコープを設定する必要があります。

POST /ListChangeSets HTTP/1.1
Content-Type: application/json

{"Catalog":"AWSMarketplace", 
 "FilterList": 
  [{
     "Name": "Scope",
     "ValueList":
      ["SharedWithMe"]
      }]}

これにより、組織の共有プライベートマーケットプレイスに適用される変更セットが返されます。

プリンシパルをエクスペリエンスに関連付ける

組織に影響を与えるには、プライベートマーケットプレイスエクスペリエンスに 1 つ以上のプリンシパルが関連付けられている必要があります。単一の の場合AWS アカウント、プライベートマーケットプレイスを使用するには、アカウントをエクスペリエンスに関連付ける必要があります。組織では、さまざまなプリンシパルに複数のエクスペリエンスを適用できます。

プリンシパルをエクスペリエンスに関連付けるには、次のコード例に示すようにStartChangeSet、 AssociateAudience アクションに変更タイプを使用します。

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

{
  "Catalog": "AWSMarketplace",
  "ChangeSet":
  [
    {
      "Entity":
      {
        "Type": "Experience@1.0",
        "Identifier": "exp-example01@1"
      },
      "ChangeType": "AssociateAudience",
      "DetailsDocument":
      {
        "Name": "AudienceName",
        "Description": "Audience example.",
        "Principals":
        [
          "012345678901",
          "ou-abcd-01234567",
          "o-0123456789"
        ]
      }
    }
  ],
  "ChangeSetName": "Set Audience for experience 01"
}

対象者は、 に関連付けられているプリンシパルのリストですExperience。プリンシパルは、その ID で定義される AWS アカウント、組織単位、または組織です。 Principalsはリストであるため、エクスペリエンスに関連付ける複数のプリンシパルを含めることができます。最初の呼び出しの後、AssociateAudience変更タイプへの後続の呼び出しは、エクスペリエンスの関連付けにプリンシパルを追加します。

エクスペリエンスからアカウントを削除することもできます。次のコード例に示すように、DisassociateAudience変更タイプを使用してこれを行います。

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

{
  "Catalog": "AWSMarketplace",
  "ChangeSet":
  [
    {
      "Entity":
      {
        "Type": "Experience@1.0",
        "Identifier": "exp-example01@02"
      },
      "ChangeType": "DisassociateAudience",
      "DetailsDocument":
      {
        "Principals":
        [
          "012345678901",
          "ou-abcd-01234567",
          "o-0123456789"
        ]
      }
    }
  ],
  "ChangeSetName": "Disassociate audience example"
}

プライベートマーケットプレイスエクスペリエンスのアーカイブと再有効化

プライベートマーケットプレイスエクスペリエンスはアーカイブして削除できます。アーカイブされたエクスペリエンスを更新したり、組織内のアカウントを管理するために使用したりすることはできません。アーカイブされたエクスペリエンスに関連付けられているオーディエンスがいる場合は、それらを別のエクスペリエンスに関連付けられます。後でエクスペリエンスを使用する場合は、いつでも再有効化できます。管理アカウントまたはプライベートマーケットプレイスの委任管理者であるメンバーアカウントの管理者には、エクスペリエンスをアーカイブおよび再アクティブ化するアクセス許可があります。プライベートマーケットプレイスAWS Organizationsの統合がない現在のプライベートマーケットプレイスのお客様の場合、エクスペリエンスを作成したアカウントの管理者には、エクスペリエンスをアーカイブして再アクティブ化するアクセス許可があります。

エクスペリエンスをアーカイブするには、次のコード例に示すように、 StartChangeSet アクションで RestrictExperience 変更タイプを使用します。

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

{
  "Catalog": "AWSMarketplace",
  "ChangeSet":
  [
    {
      "ChangeType": "RestrictExperience",
      "DetailsDocument":
      {},
      "Entity":
      {
        "Type": "Experience@1.0",
        "Identifier": "exp-1234example"
      }
    }
  ]
}

エクスペリエンスを再アクティブ化するには、次のコード例に示すように、 StartChangeSet アクションで ReviveExperience 変更タイプを使用します。

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

{
  "Catalog": "AWSMarketplace",
  "ChangeSet":
  [
    {
      "ChangeType": "ReviveExperience",
      "DetailsDocument":
      {},
      "Entity":
      {
        "Type": "Experience@1.0",
        "Identifier": "exp-1234example"
      }
    }
  ]
}

プライベートマーケットプレイス API のエラー

以下のエラーは、 Catalog API のプライベートマーケットプレイスアクションに固有ですAWS Marketplace。

プライベートマーケットプレイスで定義されるエンティティタイプ

次の表に、それぞれを指定できるプライベートマーケットプレイスのエンティティタイプ、目的、アクションを示します。各エンティティタイプを使用して、AWS Identity and Access Management(IAM) ポリシーで使用できるリソース Amazon リソースネーム (ARN) を指定できます。ARN 形式の詳細については、「」を参照してくださいカタログ API エンティティ。