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

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

DescribeCampaign

描述给定的市场活动,包括其状态。

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

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

  • DELETE PENDING > DELETE IN_PROGRESS

statusCREATE FAILED 时,响应将包含 failureReason 键,该键描述了原因。

有关市场活动的更多信息,请参阅 CreateCampaign

请求语法

{ "campaignArn": "string" }

请求参数

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

campaignArn

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

类型:字符串

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

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

必需:是

响应语法

{ "campaign": { "campaignArn": "string", "campaignConfig": { "enableMetadataWithRecommendations": boolean, "itemExplorationConfig": { "string" : "string" } }, "creationDateTime": number, "failureReason": "string", "lastUpdatedDateTime": number, "latestCampaignUpdate": { "campaignConfig": { "enableMetadataWithRecommendations": boolean, "itemExplorationConfig": { "string" : "string" } }, "creationDateTime": number, "failureReason": "string", "lastUpdatedDateTime": number, "minProvisionedTPS": number, "solutionVersionArn": "string", "status": "string" }, "minProvisionedTPS": number, "name": "string", "solutionVersionArn": "string", "status": "string" } }

响应元素

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

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

campaign

市场活动的属性。

类型:Campaign 对象

错误

InvalidInputException

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

HTTP 状态代码:400

ResourceNotFoundException

找不到指定的资源。

HTTP 状态代码:400

另请参阅

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