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

# DescribeCampaign
<a name="API_DescribeCampaign"></a>

描述指定的行銷活動，包括其狀態。

行銷活動可以處於下列其中一種狀態：
+ CREATE PENDING > CREATE IN\$1PROGRESS > ACTIVE -or- CREATE FAILED
+ DELETE PENDING > DELETE IN\$1PROGRESS

當 `status`為 時`CREATE FAILED`，回應會包含 `failureReason`金鑰，說明原因。

如需行銷活動的詳細資訊，請參閱 [CreateCampaign](https://docs.aws.amazon.com/personalize/latest/dg/API_CreateCampaign.html)。

## 請求語法
<a name="API_DescribeCampaign_RequestSyntax"></a>

```
{
   "campaignArn": "string"
}
```

## 請求參數
<a name="API_DescribeCampaign_RequestParameters"></a>

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

 ** [campaignArn](#API_DescribeCampaign_RequestSyntax) **   <a name="personalize-DescribeCampaign-request-campaignArn"></a>
行銷活動的 Amazon Resource Name (ARN)。  
類型：字串  
長度限制：長度上限為 256。  
模式：`arn:([a-z\d-]+):personalize:.*:.*:.+`  
必要：是

## 回應語法
<a name="API_DescribeCampaign_ResponseSyntax"></a>

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

## 回應元素
<a name="API_DescribeCampaign_ResponseElements"></a>

如果動作成功，則服務傳回 HTTP 200 回應。

服務會傳回下列 JSON 格式的資料。

 ** [campaign](#API_DescribeCampaign_ResponseSyntax) **   <a name="personalize-DescribeCampaign-response-campaign"></a>
只有當行銷活動至少有一個`UpdateCampaign`呼叫時，才會傳回 `latestCampaignUpdate` 欄位。
行銷活動的屬性。  
只有當行銷活動至少有一個`UpdateCampaign`呼叫時，才會傳回 `latestCampaignUpdate` 欄位。
類型：[Campaign](API_Campaign.md) 物件

## 錯誤
<a name="API_DescribeCampaign_Errors"></a>

 ** InvalidInputException **   
提供欄位或參數的有效值。  
HTTP 狀態碼：400

 ** ResourceNotFoundException **   
找不到指定的資源。  
HTTP 狀態碼：400

## 另請參閱
<a name="API_DescribeCampaign_SeeAlso"></a>

如需在其中一種語言特定 AWS SDKs中使用此 API 的詳細資訊，請參閱下列內容：
+  [AWS 命令列界面 V2](https://docs.aws.amazon.com/goto/cli2/personalize-2018-05-22/DescribeCampaign) 
+  [AWS 適用於 .NET V4 的 SDK](https://docs.aws.amazon.com/goto/DotNetSDKV4/personalize-2018-05-22/DescribeCampaign) 
+  [AWS 適用於 C\$1\$1 的 SDK](https://docs.aws.amazon.com/goto/SdkForCpp/personalize-2018-05-22/DescribeCampaign) 
+  [AWS 適用於 Go 的 SDK v2](https://docs.aws.amazon.com/goto/SdkForGoV2/personalize-2018-05-22/DescribeCampaign) 
+  [AWS 適用於 Java V2 的 SDK](https://docs.aws.amazon.com/goto/SdkForJavaV2/personalize-2018-05-22/DescribeCampaign) 
+  [AWS 適用於 JavaScript V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/personalize-2018-05-22/DescribeCampaign) 
+  [AWS 適用於 Kotlin 的 SDK](https://docs.aws.amazon.com/goto/SdkForKotlin/personalize-2018-05-22/DescribeCampaign) 
+  [AWS 適用於 PHP V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForPHPV3/personalize-2018-05-22/DescribeCampaign) 
+  [AWS 適用於 Python 的 SDK](https://docs.aws.amazon.com/goto/boto3/personalize-2018-05-22/DescribeCampaign) 
+  [AWS 適用於 Ruby V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForRubyV3/personalize-2018-05-22/DescribeCampaign)