Terjemahan disediakan oleh mesin penerjemah. Jika konten terjemahan yang diberikan bertentangan dengan versi bahasa Inggris aslinya, utamakan versi bahasa Inggris.
Membuat langganan notifikasi peristiwa Amazon DocumentDB. Tindakan ini memerlukan topik Amazon Resource Name (ARN) yang dibuat dengan menggunakan konsol Amazon DocumentDB, konsol Amazon SNS, atau API Amazon SNS. Untuk mendapatkan ARN dengan Amazon SNS, Anda harus membuat topik di Amazon SNS dan berlangganan topik tersebut. ARN ditampilkan di konsol Amazon SNS.
Anda dapat menentukan jenis sumber (SourceType) yang Anda ingin untuk diberi tahu. Anda juga dapat memberikan daftar sumber Amazon DocumentDB (SourceIds) yang memicu peristiwa, dan Anda dapat memberikan daftar kategori peristiwa (EventCategories) untuk peristiwa yang Anda ingin untuk diberi tahu. Misalnya, Anda dapat menentukan SourceType = db-instance, SourceIds = mydbinstance1, mydbinstance2 dan EventCategories = Availability, Backup.
Jika Anda menentukan SourceType dan SourceIds, (seperti SourceType = db-instance dan SourceIdentifier = myDBInstance1), Anda akan diberi tahu tentang semua peristiwa db-instance untuk sumber yang ditentukan. Jika Anda menentukan SourceType, tetapi tidak menentukan SourceIdentifier, Anda menerima pemberitahuan peristiwa untuk jenis sumber tersebut untuk semua sumber Amazon DocumentDB Anda. Jika Anda tidak menentukan SourceType atau SourceIdentifier, Anda menerima pemberitahuan tentang kejadian yang dihasilkan dari semua sumber Amazon DocumentDB milik akun pelanggan Anda.
Parameter Permintaan
Untuk informasi tentang parameter yang umum untuk semua tindakan, lihat Parameter Umum.
- SnsTopicArn
-
Amazon Resource Name (ARN) dari topik SNS yang dibuat untuk notifikasi peristiwa. Amazon SNS membuat ARN saat Anda membuat topik dan berlangganan topik tersebut.
Tipe: String
Diperlukan: Ya
- SubscriptionName
-
Nama dari langganan.
Kendala: Nama harus kurang dari 255 karakter.
Tipe: String
Diperlukan: Ya
- Enabled
-
Nilai Boolean; atur ke
trueuntuk mengaktifkan langganan, atur kefalseuntuk membuat langganan tetapi tidak mengaktifkannya.Tipe: Boolean
Wajib: Tidak
- EventCategories. EventCategory.N
-
Daftar kategori peristiwa untuk
SourceTypeyang ingin Anda langgani.Tipe: Array string
Wajib: Tidak
- SourceIds. SourceId.N
-
Daftar pengidentifikasi sumber acara yang acaranya dikembalikan. Jika tidak ditentukan, maka semua sumber disertakan dalam respons. Pengidentifikasi harus dimulai dengan huruf dan hanya boleh berisi huruf ASCII, angka, dan tanda hubung; tidak boleh diakhiri dengan tanda hubung atau berisi dua tanda hubung berturut-turut.
Batasan:
-
Jika
SourceIdsdisediakan,SourceTypejuga harus disediakan. -
Jika jenis sumber adalah sebuah instans,
DBInstanceIdentifierharus disediakan. -
Jika jenis sumber adalah sebuah grup keamanan,
DBSecurityGroupNameharus disediakan. -
Jika jenis sumber adalah sebuah grup parameter,
DBParameterGroupNameharus disediakan. -
Jika jenis sumber adalah sebuah snapshot,
DBSnapshotIdentifierharus disediakan.
Tipe: Array string
Wajib: Tidak
-
- SourceType
-
Jenis sumber yang menghasilkan peristiwa. Misalnya, jika Anda ingin diberi tahu tentang peristiwa yang dihasilkan oleh sebuah instans, Anda akan mengatur parameter ini ke
db-instance. Jika nilai ini tidak ditentukan, semua peristiwa dikembalikan.Nilai yang valid:
db-instance,db-cluster,db-parameter-group,db-security-group,db-cluster-snapshotTipe: String
Wajib: Tidak
- Tags.Tag.N
-
Tag yang akan ditetapkan ke langganan acara.
Tipe: Array objek Tag
Wajib: Tidak
Elemen Respons
Elemen berikut dikembalikan oleh layanan.
- EventSubscription
-
Informasi mendetail tentang peristiwa yang telah Anda langgani.
Tipe: Objek EventSubscription
Kesalahan
Untuk informasi tentang kesalahan yang umum untuk semua tindakan, lihat Kesalahan Umum.
- EventSubscriptionQuotaExceeded
-
Anda telah mencapai jumlah maksimum langganan peristiwa.
Kode Status HTTP: 400
- SNSInvalidTopic
-
Amazon SNS telah merespons bahwa ada masalah dengan topik yang ditentukan.
Kode Status HTTP: 400
- SNSNoAuthorization
-
Anda tidak memiliki izin untuk memublikasikan ke Amazon Resource Name (ARN) topik SNS.
Kode Status HTTP: 400
- SNSTopicArnNotFound
-
Amazon Resource Name (ARN) topik SNS tidak ada.
Kode Status HTTP: 404
- SourceNotFound
-
Sumber yang diminta tidak dapat ditemukan.
Kode Status HTTP: 404
- SubscriptionAlreadyExist
-
Nama langganan yang diberikan sudah ada.
Kode Status HTTP: 400
- SubscriptionCategoryNotFound
-
Kategori yang diberikan tidak ada.
Kode Status HTTP: 404
Lihat Juga
Untuk informasi selengkapnya tentang penggunaan API ini di salah satu bahasa khusus AWS SDKs, lihat berikut ini:
