DescribeCampaign - Amazon Personalize
Sintaksis PermintaanParameter PermintaanSintaksis ResponsElemen ResponsKesalahanLihat Juga

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

DescribeCampaign

Menjelaskan kampanye yang diberikan, termasuk statusnya.

Kampanye dapat berada di salah satu negara bagian berikut:

  • BUAT TERTUNDA > BUAT IN_PROGRESS> AKTIF -atau- BUAT GAGAL

  • HAPUS TERTUNDA > HAPUS IN_PROGRESS

Ketika status adaCREATE FAILED, respon termasuk failureReason kunci, yang menjelaskan mengapa.

Untuk informasi selengkapnya tentang kampanye, lihat CreateCampaign.

Sintaksis Permintaan

{
   "campaignArn": "string"
}

Parameter Permintaan

Permintaan menerima data berikut dalam format JSON.

campaignArn

Amazon Resource Name (ARN) dari kampanye.

Jenis: String

Batasan Panjang: Panjang maksimum 256.

Pola: arn:([a-z\d-]+):personalize:.*:.*:.+

Diperlukan: Ya

Sintaksis Respons

{
   "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"
   }
}

Elemen Respons

Jika tindakan berhasil, layanan mengirimkan kembali respons HTTP 200.

Layanan mengembalikan data berikut dalam format JSON.

campaign

Sifat-sifat kampanye.

Tipe: Objek Campaign

Kesalahan

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

Untuk informasi selengkapnya tentang penggunaan API ini di salah satu AWS SDK khusus bahasa, lihat berikut ini: