UpdateDataRetention - Amazon Kinesis Video Streams
Minta SintaksParameter Permintaan URIIsi PermintaanSintaksis ResponsElemen ResponsKesalahanLihat Juga

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

UpdateDataRetention

Meningkatkan atau mengurangi periode retensi data stream dengan nilai yang Anda tentukan. Untuk menunjukkan apakah Anda ingin menambah atau mengurangi periode retensi data, tentukan Operation parameter di badan permintaan. Dalam permintaan, Anda harus menentukan salah satu StreamName atauStreamARN.

Operasi ini memerlukan izin untuk tindakan KinesisVideo:UpdateDataRetention.

Mengubah periode retensi data mempengaruhi data dalam aliran sebagai berikut:

  • Jika periode retensi data meningkat, data yang ada disimpan untuk periode retensi baru. Misalnya, jika periode retensi data ditingkatkan dari satu jam menjadi tujuh jam, semua data yang ada disimpan selama tujuh jam.

  • Jika periode retensi data menurun, data yang ada disimpan untuk periode retensi baru. Misalnya, jika periode retensi data berkurang dari tujuh jam menjadi satu jam, semua data yang ada disimpan selama satu jam, dan data yang lebih lama dari satu jam segera dihapus.

Minta Sintaks

POST /updateDataRetention HTTP/1.1
Content-type: application/json

{
   "CurrentVersion": "string",
   "DataRetentionChangeInHours": number,
   "Operation": "string",
   "StreamARN": "string",
   "StreamName": "string"
}

Parameter Permintaan URI

Permintaan tidak menggunakan parameter URI apa pun.

Isi Permintaan

Permintaan menerima data berikut dalam format JSON.

CurrentVersion

Versi aliran yang periode retensinya ingin Anda ubah. Untuk mendapatkan versinya, hubungi API DescribeStream atau ListStreams API.

Jenis: String

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

Pola: [a-zA-Z0-9]+

Wajib: Ya

DataRetentionChangeInHours

Jumlah jam untuk menyesuaikan retensi saat ini oleh. Nilai yang Anda tentukan ditambahkan atau dikurangi dari nilai saat ini, tergantung pada nilai. operation

Nilai minimum untuk retensi data adalah 0 dan nilai maksimum adalah 87600 (sepuluh tahun).

Jenis: Integer

Rentang yang Valid: Nilai minimum 1.

Wajib: Ya

Operation

Menunjukkan apakah Anda ingin menambah atau mengurangi periode retensi.

Jenis: String

Nilai yang Valid: INCREASE_DATA_RETENTION | DECREASE_DATA_RETENTION

Wajib: Ya

StreamARN

Nama Sumber Daya Amazon (ARN) dari aliran yang periode retensinya ingin Anda ubah.

Jenis: String

Batasan Panjang: Panjang minimum 1. Panjang maksimum 1024.

Pola: arn:[a-z\d-]+:kinesisvideo:[a-z0-9-]+:[0-9]+:[a-z]+/[a-zA-Z0-9_.-]+/[0-9]+

Wajib: Tidak

StreamName

Nama aliran yang periode retensinya ingin Anda ubah.

Jenis: String

Batasan Panjang: Panjang minimum 1. Panjang maksimum 256.

Pola: [a-zA-Z0-9_.-]+

Diperlukan: Tidak

Sintaksis Respons

HTTP/1.1 200

Elemen Respons

Jika tindakan berhasil, layanan mengirimkan kembali respons HTTP 200 dengan isi HTTP kosong.

Kesalahan

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

ClientLimitExceededException

Kinesis Video Streams telah membatasi permintaan karena Anda telah melampaui batas panggilan klien yang diizinkan. Coba buat panggilan nanti.

Kode Status HTTP: 400

InvalidArgumentException

Nilai untuk parameter input ini tidak valid.

Kode Status HTTP: 400

NotAuthorizedException

Penelepon tidak berwenang untuk melakukan operasi ini.

Kode Status HTTP: 401

ResourceInUseException

Ketika input StreamARN atau ChannelARN in sudah CLOUD_STORAGE_MODE dipetakan ke sumber Kinesis Video Stream yang berbeda, atau jika StreamARN input ChannelARN yang disediakan atau tidak dalam status Aktif, coba salah satu dari berikut ini:

  1. DescribeMediaStorageConfigurationAPI untuk menentukan saluran aliran yang diberikan dipetakan.

  2. DescribeMappedResourceConfigurationAPI untuk menentukan saluran tempat aliran yang diberikan dipetakan.

  3. DescribeSignalingChannelAPI DescribeStream atau untuk menentukan status sumber daya.

Kode Status HTTP: 400

ResourceNotFoundException

Amazon Kinesis Video Streams tidak dapat menemukan aliran yang Anda tentukan.

Kode Status HTTP: 404

VersionMismatchException

Versi streaming yang Anda tentukan bukan versi terbaru. Untuk mendapatkan versi terbaru, gunakan DescribeStreamAPI.

Kode Status HTTP: 400

Lihat Juga

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