CreateCampaign - Amazon Personalize
Amazon Web Services 文档中描述的 Amazon Web Services 服务或功能可能因区域而异。要查看适用于中国区域的差异,请参阅 中国的 Amazon Web Services 服务入门 (PDF)

CreateCampaign

创建可部署解决方案版本的市场活动。当客户端调用 GetRecommendationsGetPersonalizedRanking API 时,会在请求中指定一个市场活动。

最低预调配 TPS 和自动扩缩

重要

minProvisionedTPS 会增加您的成本。我们建议从 1 开始设置 minProvisionedTPS(默认值)。使用 Amazon CloudWatch 指标跟踪您的使用情况,并在必要时增加 minProvisionedTPS

在创建 Amazon Personalize 市场活动时,您可以为该市场活动指定预置的每秒最低事务数 (minProvisionedTPS)。这是 Amazon Personalize 为该市场活动预置的基准事务吞吐量。它会设置市场活动处于活动状态时的最低账单费用。事务是单个 GetRecommendationsGetPersonalizedRanking 请求。默认 minProvisionedTPS 为 1。

如果您的 TPS 增加到超过 minProvisionedTPS,则 Amazon Personalize 会自动纵向扩展和缩减预置容量,但从不会低于 minProvisionedTPS。增加容量时会有短时间延迟,这可能会导致事务丢失。当您的流量减少时,容量将恢复到 minProvisionedTPS

您需要为预置的最低 TPS 付费,或者,如果您的请求超过 minProvisionedTPS,则需要为实际 TPS 付费。实际 TPS 是您发出的建议请求的总数。我们建议从低 minProvisionedTPS 开始,使用 Amazon CloudWatch 指标跟踪您的使用情况,然后根据需要增加 minProvisionedTPS

有关市场活动成本的更多信息,请参阅 Amazon Personalize 定价

状态

市场活动可处于以下几种状态之一:

  • CREATE PENDING > CREATE IN_PROGRESS > ACTIVE - 或 - CREATE FAILED

  • DELETE PENDING > DELETE IN_PROGRESS

要获取市场活动状态,请调用 DescribeCampaign

注意

等到市场活动的 statusACTIVE 时,再向市场活动询问建议。

请求语法

{ "campaignConfig": { "enableMetadataWithRecommendations": boolean, "itemExplorationConfig": { "string" : "string" } }, "minProvisionedTPS": number, "name": "string", "solutionVersionArn": "string", "tags": [ { "tagKey": "string", "tagValue": "string" } ] }

请求参数

请求接受采用 JSON 格式的以下数据。

campaignConfig

市场活动的配置详情。

类型:CampaignConfig 对象

必需:否

minProvisionedTPS

指定 Amazon Personalize 将支持的请求的最低预调配每秒事务数(建议)。高 minProvisionedTPS 会增加您的账单费用。我们建议从 1 开始设置 minProvisionedTPS(默认值)。使用 Amazon CloudWatch 指标跟踪您的使用情况,并在必要时增加 minProvisionedTPS

类型:整数

有效范围:最小值为 1。

必需:否

name

新市场活动的名称。市场活动名称在您的账户内必须是唯一的。

类型:字符串

长度限制:最小长度为 1。最大长度为 63。

模式:^[a-zA-Z0-9][a-zA-Z0-9\-_]*

必需:是

solutionVersionArn

要部署的解决方案版本的 Amazon 资源名称 (ARN)。

类型:字符串

长度限制:最大长度为 256。

模式:arn:([a-z\d-]+):personalize:.*:.*:.+

必需:是

tags

要应用于市场活动的标签列表。

类型:Tag 对象数组

数组成员:最少 0 个物品。最多 200 个物品。

必需:否

响应语法

{ "campaignArn": "string" }

响应元素

如果此操作成功,则该服务将会发送回 HTTP 200 响应。

服务以 JSON 格式返回以下数据。

campaignArn

市场活动的 Amazon 资源名称 (ARN)。

类型:字符串

长度限制:最大长度为 256。

模式:arn:([a-z\d-]+):personalize:.*:.*:.+

错误

InvalidInputException

为字段或参数提供有效值。

HTTP 状态代码:400

LimitExceededException

超出每秒请求次数的限制。

HTTP 状态代码:400

ResourceAlreadyExistsException

指定资源已经存在。

HTTP 状态代码:400

ResourceInUseException

指定的资源正在使用中。

HTTP 状态代码:400

ResourceNotFoundException

找不到指定的资源。

HTTP 状态代码:400

TooManyTagsException

您已超出您可以应用到此资源的最大标签数量。

HTTP 状态代码:400

另请参阅

有关在特定语言的 Amazon SDK 中使用此 API 的更多信息,请参阅以下内容: