Panduan Referensi API AWS SDK untuk JavaScript V3 menjelaskan secara rinci semua operasi API untuk AWS SDK untuk JavaScript versi 3 (V3).
Terjemahan disediakan oleh mesin penerjemah. Jika konten terjemahan yang diberikan bertentangan dengan versi bahasa Inggris aslinya, utamakan versi bahasa Inggris.
Konstruktor klien
Daftar ini diindeks oleh parameter konfigurasi v2.
-
-
v2: Apakah akan menghitung MD5 checksum untuk badan muatan saat layanan menerimanya (saat ini hanya didukung di S3).
-
v3: perintah yang berlaku dari S3 (PutObject, PutBucketCors, dll.) akan secara otomatis menghitung MD5 checksum untuk payload permintaan. Anda juga dapat menentukan algoritma checksum yang berbeda dalam
ChecksumAlgorithm
parameter perintah untuk menggunakan algoritma checksum yang berbeda. Anda dapat menemukan informasi lebih lanjut di pengumuman fitur S3.
-
-
-
v2: Apakah jenis dikonversi saat mengurai data respons.
-
v3: Usang. Opsi ini dianggap tidak aman untuk tipe karena tidak mengonversi tipe seperti stempel waktu atau binari base64 dari respons JSON.
-
-
-
v2: Apakah akan menerapkan koreksi kemiringan jam dan permintaan coba lagi yang gagal karena jam klien yang miring.
-
v3: Usang. SDK selalu menerapkan koreksi kemiringan jam.
-
-
-
v2: Nilai offset dalam milidetik untuk diterapkan ke semua waktu penandatanganan.
-
v3: Tidak ada perubahan.
-
-
-
v2: AWS Kredensi untuk menandatangani permintaan dengan.
-
v3: Tidak ada perubahan. Ini juga bisa menjadi fungsi async yang mengembalikan kredensil. Jika fungsi mengembalikan
expiration (Date)
, fungsi akan dipanggil lagi ketika datetime kedaluwarsa mendekati. Lihat referensi API v3 untukAwsAuthInputConfig
kredensialnya.
-
-
-
v2: Ukuran cache global yang menyimpan titik akhir dari operasi penemuan titik akhir.
-
v3: Tidak ada perubahan.
-
-
-
v2: Apakah akan memanggil operasi dengan titik akhir yang diberikan oleh layanan secara dinamis.
-
v3: Tidak ada perubahan.
-
-
-
v2: Apakah akan meminta parameter marshal ke awalan nama host.
-
v3: Usang. SDK selalu menyuntikkan awalan nama host bila diperlukan.
-
-
Satu set opsi untuk diteruskan ke permintaan HTTP tingkat rendah. Opsi ini digabungkan secara berbeda di v3. Anda dapat mengonfigurasinya dengan memasok yang baru
requestHandler
. Berikut adalah contoh pengaturan opsi http di runtime Node.js. Anda dapat menemukan lebih banyak di referensi API v3 untuk NodeHttpHandler.Semua permintaan v3 menggunakan HTTPS secara default. Anda hanya perlu menyediakan httpAgent khusus.
const { Agent } = require("https"); const { Agent: HttpAgent } = require("http"); const { NodeHttpHandler } = require("@smithy/node-http-handler"); const dynamodbClient = new DynamoDBClient({ requestHandler: new NodeHttpHandler({ httpsAgent: new Agent({ /*params*/ }), connectionTimeout: /*number in milliseconds*/, socketTimeout: /*number in milliseconds*/ }), });
Jika Anda melewati titik akhir kustom yang menggunakan http, maka Anda perlu menyediakan HttpAgent.
const { Agent } = require("http"); const { NodeHttpHandler } = require("@smithy/node-http-handler"); const dynamodbClient = new DynamoDBClient({ requestHandler: new NodeHttpHandler({ httpAgent: new Agent({ /*params*/ }), }), endpoint: "http://example.com", });
Jika klien berjalan di browser, serangkaian opsi yang berbeda tersedia. Anda dapat menemukan lebih banyak di referensi API v3 untuk FetchHttpHandler.
const { FetchHttpHandler } = require("@smithy/fetch-http-handler"); const dynamodbClient = new DynamoDBClient({ requestHandler: new FetchHttpHandler({ requestTimeout: /* number in milliseconds */ }), });
Setiap opsi
httpOptions
ditentukan di bawah ini:-
proxy
-
v2: URL ke permintaan proxy melalui.
-
v3: Anda dapat mengatur proxy dengan agen berikut Mengonfigurasi proxy untuk Node.js.
-
-
agent
-
v2: Objek Agen untuk melakukan permintaan HTTP dengan. Digunakan untuk penyatuan koneksi.
-
v3: Anda dapat mengkonfigurasi
httpAgent
atauhttpsAgent
seperti yang ditunjukkan pada contoh di atas.
-
-
connectTimeout
-
v2: Mengatur soket ke batas waktu setelah gagal membuat koneksi dengan server setelah
connectTimeout
milidetik. -
v3:
connectionTimeout
tersedia dalamNodeHttpHandler
opsi.
-
-
timeout
-
v2: Jumlah milidetik yang dapat diambil permintaan sebelum dihentikan secara otomatis.
-
v3:
socketTimeout
tersedia dalamNodeHttpHandler
opsi.
-
-
xhrAsync
-
v2: Apakah SDK akan mengirim permintaan HTTP asinkron.
-
v3: Usang. Permintaan selalu asinkron.
-
-
xhrWithCredentials
-
v2: Menetapkan properti “withCredentials” dari objek XMLHttp Request.
-
v3: Tidak tersedia. SDK mewarisi konfigurasi pengambilan default
.
-
-
-
-
v2: Objek yang merespons
.write()
(seperti aliran) atau.log()
(seperti objek konsol) untuk mencatat informasi tentang permintaan. -
v3: Tidak ada perubahan. Lebih banyak log granular tersedia di v3.
-
-
-
v2: Jumlah maksimum pengalihan yang harus diikuti untuk permintaan layanan.
-
v3: Usang. SDK tidak mengikuti pengalihan untuk menghindari permintaan lintas wilayah yang tidak disengaja.
-
-
-
v2: Jumlah maksimum percobaan ulang untuk melakukan permintaan layanan.
-
v3: Diubah menjadi
maxAttempts
. Lihat selengkapnya di referensi API v3 untuk RetryInputConfig. Perhatikan bahwamaxAttempts
seharusnyamaxRetries + 1
.
-
-
-
v2: Apakah parameter input harus divalidasi terhadap deskripsi operasi sebelum mengirim permintaan.
-
v3: Usang. SDK tidak melakukan validasi di sisi klien saat runtime.
-
-
-
v2: Wilayah untuk mengirim permintaan layanan ke.
-
v3: Tidak ada perubahan. Ini juga bisa menjadi fungsi async yang mengembalikan string wilayah.
-
-
-
v2: Satu set opsi untuk mengonfigurasi penundaan coba lagi pada kesalahan yang dapat dicoba ulang.
-
v3: Usang. SDK mendukung strategi coba ulang yang lebih fleksibel dengan opsi konstruktor
retryStrategy
klien. Lihat selengkapnya di referensi API v3.
-
-
-
v2: Apakah titik akhir yang disediakan menangani bucket individual (false jika membahas titik akhir API root).
-
v3: Diubah menjadi
bucketEndpoint
. Lihat selengkapnya di referensi API v3 untuk BucketEndPoint. Perhatikan bahwa ketika diatur ketrue
, Anda menentukan titik akhir permintaan dalam parameterBucket
permintaan, titik akhir asli akan ditimpa. Sedangkan di v2, titik akhir permintaan di konstruktor klien menimpa parameter permintaan.Bucket
-
-
-
v2: Apakah akan menonaktifkan penandatanganan badan S3 saat menggunakan versi tanda tangan v4.
-
v3: Berganti nama menjadi.
applyChecksum
-
-
-
v2: Apakah akan memaksa gaya jalur URLs untuk objek S3.
-
v3: Berganti nama menjadi.
forcePathStyle
-
-
-
v2: Apakah akan mengganti wilayah permintaan dengan wilayah yang disimpulkan dari ARN sumber daya yang diminta.
-
v3: Berganti nama menjadi.
useArnRegion
-
-
-
v2: Ketika wilayah disetel ke 'us-east-1', apakah akan mengirim permintaan s3 ke titik akhir global atau titik akhir regional 'us-east-1'.
-
v3: Usang. Klien S3 akan selalu menggunakan titik akhir regional jika wilayah disetel ke.
us-east-1
Anda dapat mengatur wilayah untuk mengirim permintaanaws-global
ke titik akhir global S3.
-
-
-
v2: Apakah tanda tangan untuk menandatangani permintaan dengan (mengganti konfigurasi API) di-cache.
-
v3: Usang. SDK selalu menyimpan kunci penandatanganan yang di-hash.
-
-
-
v2: Versi tanda tangan untuk menandatangani permintaan dengan (mengganti konfigurasi API).
-
v3: Usang. Signature V2 yang didukung di v2 SDK tidak digunakan lagi oleh AWS. v3 hanya mendukung signature v4.
-
-
-
v2: Apakah SSL diaktifkan untuk permintaan.
-
v3: Berganti nama menjadi.
tls
-
-
-
v2: Apakah akan mengirim permintaan sts ke titik akhir global atau titik akhir regional.
-
v3: Usang. Klien STS akan selalu menggunakan titik akhir regional jika disetel ke wilayah tertentu. Anda dapat mengatur wilayah untuk mengirim permintaan
aws-global
ke titik akhir global STS.
-
-
-
v2: Apakah akan menggunakan titik akhir Accelerate dengan layanan S3.
-
v3: Tidak ada perubahan.
-