

Terjemahan disediakan oleh mesin penerjemah. Jika konten terjemahan yang diberikan bertentangan dengan versi bahasa Inggris aslinya, utamakan versi bahasa Inggris.

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

Menjelaskan kampanye yang diberikan, termasuk statusnya.

Kampanye dapat berada di salah satu negara bagian berikut:
+ BUAT TERTUNDA > BUAT IN\$1PROGRESS> AKTIF -atau- BUAT GAGAL
+ HAPUS TERTUNDA > HAPUS IN\$1PROGRESS

Ketika `status` ada`CREATE FAILED`, respon termasuk `failureReason` kunci, yang menjelaskan mengapa.

Untuk informasi selengkapnya tentang kampanye, lihat [CreateCampaign](https://docs.aws.amazon.com/personalize/latest/dg/API_CreateCampaign.html).

## Sintaksis Permintaan
<a name="API_DescribeCampaign_RequestSyntax"></a>

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

## Parameter Permintaan
<a name="API_DescribeCampaign_RequestParameters"></a>

Permintaan menerima data berikut dalam format JSON.

 ** [campaignArn](#API_DescribeCampaign_RequestSyntax) **   <a name="personalize-DescribeCampaign-request-campaignArn"></a>
Amazon Resource Name (ARN) dari kampanye.  
Tipe: String  
Batasan Panjang: Panjang maksimum 256.  
Pola: `arn:([a-z\d-]+):personalize:.*:.*:.+`   
Diperlukan: Ya

## Sintaksis Respons
<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"
   }
}
```

## Elemen Respons
<a name="API_DescribeCampaign_ResponseElements"></a>

Jika tindakan berhasil, layanan mengirimkan kembali respons HTTP 200.

Layanan mengembalikan data berikut dalam format JSON.

 ** [campaign](#API_DescribeCampaign_ResponseSyntax) **   <a name="personalize-DescribeCampaign-response-campaign"></a>
`latestCampaignUpdate`Bidang hanya dikembalikan ketika kampanye telah memiliki setidaknya satu `UpdateCampaign` panggilan. 
Sifat-sifat kampanye.  
`latestCampaignUpdate`Bidang hanya dikembalikan ketika kampanye telah memiliki setidaknya satu `UpdateCampaign` panggilan.
Tipe: Objek [Campaign](API_Campaign.md)

## Kesalahan
<a name="API_DescribeCampaign_Errors"></a>

 ** InvalidInputException **   
Berikan nilai yang valid untuk bidang atau parameter.  
Kode Status HTTP: 400

 ** ResourceNotFoundException **   
Tidak dapat menemukan sumber daya yang ditentukan.  
Kode Status HTTP: 400

## Lihat Juga
<a name="API_DescribeCampaign_SeeAlso"></a>

Untuk informasi selengkapnya tentang penggunaan API ini di salah satu bahasa khusus AWS SDKs, lihat berikut ini:
+  [AWS Antarmuka Baris Perintah V2](https://docs.aws.amazon.com/goto/cli2/personalize-2018-05-22/DescribeCampaign) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/personalize-2018-05-22/DescribeCampaign) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/personalize-2018-05-22/DescribeCampaign) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/personalize-2018-05-22/DescribeCampaign) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/personalize-2018-05-22/DescribeCampaign) 
+  [AWS SDK untuk V3 JavaScript ](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/personalize-2018-05-22/DescribeCampaign) 
+  [AWS SDK para Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/personalize-2018-05-22/DescribeCampaign) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/personalize-2018-05-22/DescribeCampaign) 
+  [AWS SDK untuk Python](https://docs.aws.amazon.com/goto/boto3/personalize-2018-05-22/DescribeCampaign) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/personalize-2018-05-22/DescribeCampaign) 