AWS Marketplace API 参考已重组。有关支持的 API 操作的更多信息，请参阅 AWS Marketplace API 参考。

本文属于机器翻译版本。若本译文内容与英语原文存在差异，则一律以英文原文为准。

使用私有市场合作AWS MarketplaceAPI

您可以使用AWS Marketplace Catalog API来管理您AWS 账户或组织的私有市场。

所有变更类型只能从组织的管理账户调用，也可以由作为私有市场委托管理员的成员账户调用。如果您目前是未AWS Organizations集成私有市场的私有市场客户，则可以通过组织中任何具有 AWSPrivateMarketplaceAdminFullAccess IAM 政策的账户创建和管理私有市场。

有关私有市场的更多信息，请参阅《AWS Marketplace买家指南》中的私有市场。

下表详细介绍了一组用于管理私有市场的任务以及适用于每项任务的变更类型。

创建私有市场

的私人市场AWS 账户可以看作是允许用户使用该账户购买的产品列表以及该市场的品牌推广。在拥有多个账户的组织中，您可以使用AWS Organizations被叫组织单位 (OU) 中的分组与体验关联。例如，您可以拥有一组允许组织内所有账户购买的产品，也可以为组织中的每个 OU 制定不同的产品清单。您也可以为组织中的个人账户制定不同的产品清单。每份经批准的产品和品牌列表都被称为采购体验。

在中AWS Marketplace Catalog API，四个实体代表一种体验：

创建采购体验的步骤如下：

创建实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，但这次是用 o ChangeType f 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符来返回标识符

您可以再次使用DescribeChangeSetCreateProcurementPolicy变更类型来跟踪您的请求的处理情况。

在您创建了采购政策后，您的私有市场将显示在AWS Management Console。（你可以前往 P rivate Marketplace 页面查看。） 完成这些步骤后，您的私有市场将被禁用，使用默认品牌，采购政策为空，并且不会与组织中的任何委托人关联。您可以更新品牌并添加任何您想要的产品，将体验与一个或多个账户相关联，然后启用您的私人市场。

以下各节介绍如何使用管理您的私有市场AWS Marketplace Catalog API。

改变私有市场体验的品牌形象

您可以为用户自定义私有市场的外观。如果不进行自定义，您的私有商城将使用默认的品牌设置，如下所述。在私有市场中，您可以更改品牌的各个方面包括以下方面：

要设置这些值，必须先创建一个具有CreateBrandingSettings更改类型的BrandingSettings实体。然后，您可以申请UpdateBrandingSettings更改以设置或更改品牌。您只需要创建一个BrandingSettings对象一次。要创建此对象，请StartChangeSet使用CreateBrandingSettings更改类型进行调用，如以下代码示例所示。

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"
      }
    }
  ]
}

此示例通过向Experience实体添加BrandingSettings对象来修改实体。实体标识符的修订版已增加到。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，但DetailsDocumentDisabled要将其更改为禁用私有市场。Status

启用或禁用用户请求

您组织中的用户可以查看全部公开AWS Marketplace内容，但他们只能订阅您允许的产品。默认情况下，他们可以请求将不在私有市场上的产品添加到该商城中。这些请求显示在私有市场管理员页面（Privat e Marketplace）中，您可以在其中决定是接受还是拒绝该请求（以及是否阻止对同一商品的进一步请求）。您无法使用目录 API 查看或响应请求。

您可以启用或禁用用户针对您的私有市场体验创建请求的功能。StartChangeSet与UpdateProcurementPolicy更改类型一起使用。在以下代码示例中，发出请求的功能被禁用。

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"
      }
    }
  ]
}

要为用户启用变更请求功能，请使用Allow代替 Deny in 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"
}

在此示例中，采购政策有两个允许的产品和一个被拒绝的产品。该策略允许用户请求资源。

在私人市场中添加或移除商品

默认情况下，私有市场中没有任何经批准的商品。使用变更请求来添加或移除产品。要添加产品，请使用AllowProductProcurement更改类型。要移除商品，请使用DenyProductProcurement更改类型。

以下代码示例显示了AllowProductProcurement变更类型以及向私有市场添加产品的StartChangeSet操作。

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。这些产品将添加到您的ProcurementPolicyExperience实体所包含的实体的允许（或拒绝）列表中。

查找产品

通过获取您的采购政策的详细信息，您可以找到已在私人市场上销售的产品的产品编号。但是，AWS Marketplace Catalog API不提供查找其他商品的商品编码的方法。有两种方法可以获取用于目录 API 服务的产品 ID：

与私人市场合作AWS Organizations

无论您是为账户还是组织使用私有市场，您都使用相同的 API。但是，在组织内工作时会有一些区别：

要列出您自己账户中的Experience对象，请ListEntities按以下代码示例所示调用。

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

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

但是，要列出已与您共享的实体，必须添加FilterList带有 a Scope 的SharedWithMe，如以下代码示例所示。因此，在您自己的账户之外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"]
      }]}

这将返回适用于贵组织共享私有市场的变更集。

将校长与体验联系起来

私有市场体验必须有一个或多个与之关联的委托人，才能对您的组织产生任何影响。对于单曲AWS 账户，您必须将账户与体验关联才能使用私有市场。在一个组织中，您可以将多种体验应用于不同的负责人。

要将委托人与体验相关联，请将AssociateAudience更改类型与StartChangeSet操作结合使用，如以下代码示例所示。

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"
}

存档并重新激活 Private Marketplace 体验

您可以通过存档来删除 Private Marketplace 体验。存档的体验无法更新或用于管理组织中的账户。如果您的受众与已存档的体验关联，则可以将其与其他体验关联起来。如果您决定稍后使用该体验，可以随时重新激活它。管理账户的管理员或作为私有市场委托管理员的成员账户的管理员有权存档和重新激活体验。如果您目前是未与私有市场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 中的错误

以下错误特定于AWS Marketplace目录 API 中的私有市场操作。

由私有市场定义的实体类型

下表列出了私有市场实体类型、目的和可以指定每种类型、目的和操作。每种实体类型都可用于指定可用于 (IAM) 策略的资源 Amazon 资源名称 AWS Identity and Access Management (ARN)。有关 ARN 格式的更多详细信息，请参阅。编录 API 实体