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

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

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

市场活动可处于以下几种状态之一：
+ CREATE PENDING > CREATE IN\$1PROGRESS > ACTIVE - 或 - 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 资源名称 (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>
仅当市场活动至少接到一个 `latestCampaignUpdate` 电话时，才会返回 `UpdateCampaign` 字段。
市场活动的属性。  
仅当市场活动至少接到一个 `latestCampaignUpdate` 电话时，才会返回 `UpdateCampaign` 字段。
类型：[Campaign](API_Campaign.md) 对象

## 错误
<a name="API_DescribeCampaign_Errors"></a>

 ** InvalidInputException **   
为字段或参数提供有效值。  
HTTP 状态代码：400

 ** ResourceNotFoundException **   
找不到指定的资源。  
HTTP 状态代码：400

## 另请参阅
<a name="API_DescribeCampaign_SeeAlso"></a>

有关以特定语言之一使用此 API 的更多信息 AWS SDKs，请参阅以下内容：
+  [AWS 命令行界面 V2](https://docs.aws.amazon.com/goto/cli2/personalize-2018-05-22/DescribeCampaign) 
+  [AWS 适用于.NET 的 SDK V4](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 v2 的 SDK](https://docs.aws.amazon.com/goto/SdkForGoV2/personalize-2018-05-22/DescribeCampaign) 
+  [AWS 适用于 Java 的 SDK V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/personalize-2018-05-22/DescribeCampaign) 
+  [AWS JavaScript V3 版软件开发工具包](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 的 SDK V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/personalize-2018-05-22/DescribeCampaign) 
+  [AWS Python 软件开发工具包](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)