本文属于机器翻译版本。若本译文内容与英语原文存在差异,则一律以英文原文为准。
DescribeCampaign
描述给定的市场活动,包括其状态。
市场活动可处于以下几种状态之一:
-
CREATE PENDING > CREATE IN_PROGRESS > ACTIVE - 或 - CREATE FAILED
-
DELETE PENDING > DELETE IN_PROGRESS
当 status
为 CREATE FAILED
时,响应将包含 failureReason
键,该键描述了原因。
有关活动的更多信息,请参阅CreateCampaign。
请求语法
{
"campaignArn": "string
"
}
请求参数
请求接受采用 JSON 格式的以下数据。
- campaignArn
-
市场活动的 Amazon 资源名称 (ARN)。
类型:字符串
长度约束:最大长度为 256。
模式:
arn:([a-z\d-]+):personalize:.*:.*:.+
必需:是
响应语法
{
"campaign": {
"campaignArn": "string",
"campaignConfig": {
"enableMetadataWithRecommendations": boolean,
"itemExplorationConfig": {
"string" : "string"
},
"syncWithLatestSolutionVersion": boolean
},
"creationDateTime": number,
"failureReason": "string",
"lastUpdatedDateTime": number,
"latestCampaignUpdate": {
"campaignConfig": {
"enableMetadataWithRecommendations": boolean,
"itemExplorationConfig": {
"string" : "string"
},
"syncWithLatestSolutionVersion": boolean
},
"creationDateTime": number,
"failureReason": "string",
"lastUpdatedDateTime": number,
"minProvisionedTPS": number,
"solutionVersionArn": "string",
"status": "string"
},
"minProvisionedTPS": number,
"name": "string",
"solutionVersionArn": "string",
"status": "string"
}
}
响应元素
如果此操作成功,则该服务将会发送回 HTTP 200 响应。
服务以 JSON 格式返回以下数据。
错误
- InvalidInputException
-
为字段或参数提供有效值。
HTTP 状态代码:400
- ResourceNotFoundException
-
找不到指定的资源。
HTTP 状态代码:400
另请参阅
有关在特定语言的 Amazon SDK 中使用此 API 的更多信息,请参阅以下内容: