CreateScheduledQuery - Amazon Timestream
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.

CreateScheduledQuery

Buat kueri terjadwal yang akan dijalankan atas nama Anda pada jadwal yang dikonfigurasi. Timestream mengasumsikan peran eksekusi yang disediakan sebagai bagian dari ScheduledQueryExecutionRoleArn parameter untuk menjalankan kueri. Anda dapat menggunakan NotificationConfiguration parameter untuk mengonfigurasi notifikasi untuk operasi kueri terjadwal Anda.

Sintaksis Permintaan

{
   "ClientToken": "string",
   "ErrorReportConfiguration": { 
      "S3Configuration": { 
         "BucketName": "string",
         "EncryptionOption": "string",
         "ObjectKeyPrefix": "string"
      }
   },
   "KmsKeyId": "string",
   "Name": "string",
   "NotificationConfiguration": { 
      "SnsConfiguration": { 
         "TopicArn": "string"
      }
   },
   "QueryString": "string",
   "ScheduleConfiguration": { 
      "ScheduleExpression": "string"
   },
   "ScheduledQueryExecutionRoleArn": "string",
   "Tags": [ 
      { 
         "Key": "string",
         "Value": "string"
      }
   ],
   "TargetConfiguration": { 
      "TimestreamConfiguration": { 
         "DatabaseName": "string",
         "DimensionMappings": [ 
            { 
               "DimensionValueType": "string",
               "Name": "string"
            }
         ],
         "MeasureNameColumn": "string",
         "MixedMeasureMappings": [ 
            { 
               "MeasureName": "string",
               "MeasureValueType": "string",
               "MultiMeasureAttributeMappings": [ 
                  { 
                     "MeasureValueType": "string",
                     "SourceColumn": "string",
                     "TargetMultiMeasureAttributeName": "string"
                  }
               ],
               "SourceColumn": "string",
               "TargetMeasureName": "string"
            }
         ],
         "MultiMeasureMappings": { 
            "MultiMeasureAttributeMappings": [ 
               { 
                  "MeasureValueType": "string",
                  "SourceColumn": "string",
                  "TargetMultiMeasureAttributeName": "string"
               }
            ],
            "TargetMultiMeasureName": "string"
         },
         "TableName": "string",
         "TimeColumn": "string"
      }
   }
}

Parameter Permintaan

Untuk informasi tentang parameter yang umum untuk semua tindakan, lihat Parameter Umum.

Permintaan menerima data berikut dalam format JSON.

ClientToken

Menggunakan ClientToken membuat panggilan ke CreateScheduledQuery idempoten, dengan kata lain, membuat permintaan yang sama berulang kali akan menghasilkan hasil yang sama. Membuat beberapa CreateScheduledQuery permintaan identik memiliki efek yang sama seperti membuat satu permintaan.

  • Jika CreateScheduledQuery dipanggil tanpa aClientToken, Query SDK menghasilkan atas nama Anda. ClientToken

  • Setelah 8 jam, permintaan apa pun dengan hal ClientToken yang sama diperlakukan sebagai permintaan baru.

Tipe: String

Kendala Panjang: Panjang minimum 32. Panjang maksimum 128.

Wajib: Tidak

ErrorReportConfiguration

Konfigurasi untuk pelaporan kesalahan. Laporan kesalahan akan dihasilkan ketika masalah ditemui saat menulis hasil kueri.

Tipe: Objek ErrorReportConfiguration

Wajib: Ya

KmsKeyId

Kunci Amazon KMS digunakan untuk mengenkripsi sumber daya kueri terjadwal, saat istirahat. Jika kunci Amazon KMS tidak ditentukan, sumber kueri terjadwal akan dienkripsi dengan kunci Amazon KMS milik Timestream. Untuk menentukan kunci KMS, gunakan ID kunci, kunci ARN, nama alias, atau alias ARN. Saat menggunakan nama alias, awali nama dengan alias/

Jika ErrorReportConfiguration digunakan SSE_KMS sebagai jenis enkripsi, hal yang sama KmsKeyId digunakan untuk mengenkripsi laporan kesalahan saat istirahat.

Tipe: String

Batasan Panjang: Panjang minimum 1. Panjang maksimum 2048.

Wajib: Tidak

Name

Nama kueri terjadwal.

Tipe: String

Batasan Panjang: Panjang minimum 1. Panjang maksimum adalah 64.

Pola: [a-zA-Z0-9|!\-_*'\(\)]([a-zA-Z0-9]|[!\-_*'\(\)\/.])+

Wajib: Ya

NotificationConfiguration

Konfigurasi pemberitahuan untuk kueri terjadwal. Pemberitahuan dikirim oleh Timestream saat proses kueri selesai, saat status diperbarui atau saat Anda menghapusnya.

Tipe: Objek NotificationConfiguration

Wajib: Ya

QueryString

String query untuk dijalankan. Nama parameter dapat ditentukan dalam @ karakter string query diikuti oleh identifier. Parameter bernama @scheduled_runtime dicadangkan dan dapat digunakan dalam kueri untuk mendapatkan waktu di mana kueri dijadwalkan untuk dijalankan.

Stempel waktu yang dihitung sesuai dengan ScheduleConfiguration parameter, akan menjadi nilai @scheduled_runtime paramater untuk setiap kueri yang dijalankan. Misalnya, pertimbangkan instance kueri terjadwal yang dijalankan pada 2021-12-01 00:00:00. Untuk contoh ini, @scheduled_runtime parameter diinisialisasi ke stempel waktu 2021-12-01 00:00:00 saat menjalankan kueri.

Tipe: String

Batasan Panjang: Panjang minimum 1. Panjang maksimum 262144.

Wajib: Ya

ScheduleConfiguration

Konfigurasi jadwal untuk kueri.

Tipe: Objek ScheduleConfiguration

Wajib: Ya

ScheduledQueryExecutionRoleArn

ARN untuk peran IAM yang Timestream akan asumsikan saat menjalankan kueri terjadwal.

Tipe: String

Batasan Panjang: Panjang minimum 1. Panjang maksimum 2048.

Wajib: Ya

Tags

Daftar pasangan kunci-nilai untuk memberi label pada kueri terjadwal.

Tipe: Array objek Tag

Anggota Array: Jumlah minimum 0 item. Jumlah maksimum 200 item.

Wajib: Tidak

TargetConfiguration

Konfigurasi yang digunakan untuk menulis hasil query.

Tipe: Objek TargetConfiguration

Wajib: Tidak

Sintaksis Respons

{
   "Arn": "string"
}

Elemen Respons

Jika tindakan berhasil, layanan mengirimkan kembali respons HTTP 200.

Layanan mengembalikan data berikut dalam format JSON.

Arn

ARN untuk kueri terjadwal yang dibuat.

Tipe: String

Batasan Panjang: Panjang minimum 1. Panjang maksimum 2048.

Kesalahan

Untuk informasi tentang kesalahan yang umum untuk semua tindakan, lihat Kesalahan Umum.

AccessDeniedException

Anda tidak memiliki izin yang diperlukan untuk mengakses pengaturan akun.

Kode Status HTTP: 400

ConflictException

Tidak dapat melakukan polling hasil untuk kueri yang dibatalkan.

Kode Status HTTP: 400

InternalServerException

Terjadi kesalahan server internal saat memproses permintaan.

Kode Status HTTP: 400

InvalidEndpointException

Endpoint yang diminta tidak valid.

Kode Status HTTP: 400

ServiceQuotaExceededException

Anda telah melampaui kuota layanan.

Kode Status HTTP: 400

ThrottlingException

Permintaan itu dibatasi karena permintaan yang berlebihan.

Kode Status HTTP: 400

ValidationException

Permintaan tidak valid atau cacat.

Kode Status HTTP: 400

Lihat Juga

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