ListForecasts - Amazon Forecast
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.

ListForecasts

Mengembalikan daftar prakiraan yang dibuat menggunakan CreateForecast operasi. Untuk setiap perkiraan, operasi ini mengembalikan ringkasan propertinya, termasuk Nama Sumber Daya Amazon (ARN). Untuk mengambil set lengkap properti, tentukan ARN dengan DescribeForecast operasi. Anda dapat memfilter daftar menggunakan array Filter objek.

Sintaksis Permintaan

{
   "Filters": [ 
      { 
         "Condition": "string",
         "Key": "string",
         "Value": "string"
      }
   ],
   "MaxResults": number,
   "NextToken": "string"
}

Parameter Permintaan

Permintaan menerima data berikut dalam format JSON.

Filters

Array filter. Untuk setiap filter, Anda memberikan kondisi dan pernyataan kecocokan. Kondisi ini adalah salah satu IS atauIS_NOT, yang menentukan apakah akan memasukkan atau mengecualikan prakiraan yang cocok dengan pernyataan dari daftar, masing-masing. Pernyataan pertandingan terdiri dari kunci dan nilai.

Sifat filter

  • Condition- Kondisi untuk diterapkan. Nilai yang valid adalah IS dan IS_NOT. Untuk memasukkan perkiraan yang cocok dengan pernyataan, tentukanIS. Untuk mengecualikan perkiraan yang cocok, tentukanIS_NOT.

  • Key- Nama parameter untuk memfilter. Nilai yang valid adalah DatasetGroupArn, PredictorArn, dan Status.

  • Value- Nilai untuk mencocokkan.

Misalnya, untuk mencantumkan semua perkiraan yang statusnya tidak AKTIF, Anda akan menentukan:

"Filters": [ { "Condition": "IS_NOT", "Key": "Status", "Value": "ACTIVE" } ]

Tipe: Array objek Filter

Wajib: Tidak

MaxResults

Jumlah item yang akan dikembalikan dalam respons.

Jenis: Integer

Rentang yang Valid: Nilai minimum 1. Nilai maksimum 100.

Wajib: Tidak

NextToken

Jika hasil dari permintaan sebelumnya terpotong, responsnya mencakup a. NextToken Untuk mengambil set hasil berikutnya, gunakan token dalam permintaan berikutnya. Token kedaluwarsa setelah 24 jam.

Jenis: String

Batasan Panjang: Panjang minimum 1. Panjang maksimum 3000.

Pola: .+

Diperlukan: Tidak

Sintaksis Respons

{
   "Forecasts": [ 
      { 
         "CreatedUsingAutoPredictor": boolean,
         "CreationTime": number,
         "DatasetGroupArn": "string",
         "ForecastArn": "string",
         "ForecastName": "string",
         "LastModificationTime": number,
         "Message": "string",
         "PredictorArn": "string",
         "Status": "string"
      }
   ],
   "NextToken": "string"
}

Elemen Respons

Jika tindakan berhasil, layanan mengirimkan kembali respons HTTP 200.

Layanan mengembalikan data berikut dalam format JSON.

Forecasts

Array objek yang merangkum properti masing-masing ramalan.

Tipe: Array objek ForecastSummary

NextToken

Jika respons terpotong, Amazon Forecast mengembalikan token ini. Untuk mengambil set hasil berikutnya, gunakan token dalam permintaan berikutnya.

Jenis: String

Batasan Panjang: Panjang minimum 1. Panjang maksimum 3000.

Pola: .+

Kesalahan

InvalidInputException

Kami tidak dapat memproses permintaan karena menyertakan nilai yang tidak valid atau nilai yang melebihi rentang yang valid.

Kode Status HTTP: 400

InvalidNextTokenException

Token tidak valid. Token kedaluwarsa setelah 24 jam.

Kode Status HTTP: 400

Lihat Juga

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