DescribeCampaign - Amazon Personalize
請求語法請求參數回應語法回應元素錯誤另請參閱

本文為英文版的機器翻譯版本，如內容有任何歧義或不一致之處，概以英文版為準。

DescribeCampaign

說明指定的行銷活動，包括其狀態。

行銷活動可以處於下列其中一種狀態：

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

  • DELETE PENDING > DELETE IN_PROGRESS

如果status是CREATE FAILED，則響應包含failureReason密鑰，其中描述了原因。

如需促銷活動的詳細資訊，請參閱CreateCampaign。

請求語法

{
   "campaignArn": "string"
}

請求參數

請求接受採用 JSON 格式的下列資料。

campaignArn

行銷活動的 Amazon Resource Name (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 格式的資料。

campaign

行銷活動的屬性。

類型：Campaign 物件

錯誤

InvalidInputException

提供欄位或參數的有效值。

HTTP 狀態碼：400

ResourceNotFoundException

找不到指定的資源。

HTTP 狀態碼：400

另請參閱

如需在其中一個特定語言 AWS SDK 中使用此 API 的詳細資訊，請參閱下列內容：