Terjemahan disediakan oleh mesin penerjemah. Jika konten terjemahan yang diberikan bertentangan dengan versi bahasa Inggris aslinya, utamakan versi bahasa Inggris.
# Amazon CloudSearch API Referensi
Anda menggunakan tiga APIs untuk berinteraksi dengan Amazon CloudSearch:
+ [API Konfigurasi](configuration-api.md) —Siapkan dan kelola domain penelusuran Anda.
+ [Document Service API](document-service-api.md) —Kirim data yang ingin Anda cari.
+ [API Pencarian](search-api.md) —Cari domain Anda.
# Referensi API Konfigurasi untuk Amazon CloudSearch
Anda menggunakan API CloudSearch Konfigurasi Amazon untuk membuat, mengonfigurasi, dan mengelola domain penelusuran. Untuk informasi selengkapnya mengonfigurasi domain penelusuran, lihat. [Membuat dan Mengelola Domain Pencarian](creating-managing-domains.md)
Yang lain yang APIs Anda gunakan untuk berinteraksi dengan Amazon CloudSearch adalah:
+ [Referensi API Layanan Dokumen](document-service-api.md)—Kirim data yang ingin Anda cari.
+ [Cari Referensi API](search-api.md)—Cari domain Anda.
**Topics**
+ [
# Mengirimkan Permintaan Konfigurasi di Amazon CloudSearch
](submitting-configuration-requests.md)
+ [
# Tindakan
](API_Operations.md)
+ [
# Jenis Data
](API_Types.md)
+ [
# Parameter Umum
](CommonParameters.md)
+ [
# Kesalahan Umum
](CommonErrors.md)
# Mengirimkan Permintaan Konfigurasi di Amazon CloudSearch
**penting**
Cara termudah untuk mengirimkan permintaan konfigurasi adalah dengan menggunakan CloudSearch konsol Amazon, alat baris CloudSearch perintah Amazon, atau AWS SDK for Java JavaScript, .NET, PHP, Ruby, atau Python (Boto). Alat baris perintah dan SDKs menangani proses penandatanganan untuk Anda dan memastikan bahwa permintaan CloudSearch konfigurasi Amazon dibentuk dengan benar. Untuk informasi selengkapnya tentang AWS SDKs, lihat [AWS Software Development Kit](https://aws.amazon.com/code).
Anda mengirimkan permintaan CloudSearch konfigurasi Amazon ke CloudSearch titik akhir Amazon untuk wilayah Anda menggunakan protokol AWS Query. Untuk daftar wilayah dan titik akhir yang didukung saat ini, lihat [Wilayah dan Titik Akhir](https://docs.aws.amazon.com/general/latest/gr/rande.html#cloudsearch_region).
Permintaan AWS Query adalah permintaan HTTP atau HTTPS yang dikirimkan melalui HTTP GET atau POST dengan parameter Query bernama Action. Anda harus menentukan versi API di semua permintaan konfigurasi dan versi tersebut harus cocok dengan versi API yang ditentukan saat domain dibuat.
Anda harus menyertakan parameter otorisasi dan tanda tangan digital dalam setiap permintaan. Amazon CloudSearch mendukung AWS Signature Versi 4. Untuk petunjuk penandatanganan terperinci, lihat [Proses Penandatanganan V4 Tanda Tangan](https://docs.aws.amazon.com/general/latest/gr/signature-version-4.html) di Referensi Umum AWS.
**catatan**
Amazon CloudSearch membatasi permintaan berlebihan ke layanan konfigurasi. Pelambatan terjadi karena *tindakan*, sehingga `DescribeDomains` permintaan yang berlebihan tidak menyebabkan Amazon CloudSearch membatasi `DescribeIndexFields` permintaan. Batas permintaan berubah berdasarkan kebutuhan layanan, tetapi memungkinkan banyak panggilan ke setiap tindakan per jam.
## Struktur Permintaan Konfigurasi
Referensi ini menunjukkan permintaan CloudSearch konfigurasi Amazon sebagai URLs, yang dapat digunakan langsung di browser. (Meskipun permintaan GET ditampilkan sebagai URLs, nilai parameter ditampilkan tanpa kode untuk membuatnya lebih mudah dibaca. Ingatlah bahwa Anda harus menyandikan URL nilai parameter saat mengirimkan permintaan.) URL berisi tiga bagian:
+ Endpoint—titik masuk layanan Web untuk ditindaklanjuti,. `cloudsearch.us-east-1.amazonaws.com`
+ Action—tindakan konfigurasi CloudSearch Amazon yang ingin Anda lakukan. Untuk daftar lengkap tindakan, lihat[Tindakan](API_Operations.md).
+ Parameter—parameter permintaan apa pun yang diperlukan untuk tindakan yang ditentukan. Setiap permintaan kueri juga harus menyertakan beberapa parameter umum untuk menangani otentikasi. Untuk informasi selengkapnya, lihat [Minta Otentikasi](#configuration-request-authentication).
Anda harus menentukan `Version` parameter di setiap permintaan CloudSearch konfigurasi Amazon. Versi Amazon CloudSearch API saat ini adalah 2013-01-01.
Misalnya, permintaan GET berikut membuat domain pencarian baru yang disebut *film*:
```
https://cloudsearch.us-east-1.amazonaws.com
?Action=CreateDomain
&DomainName=movies
&Version=2013-01-01
&X-Amz-Algorithm=AWS4-HMAC-SHA256
&X-Amz-Credential=AKIAIOSFODNN7EXAMPLE/20120712/us-east-1/cloudsearch/aws4
_request
&X-Amz-Date=2012-07-12T21:41:29.094Z
&X-Amz-SignedHeaders=host
&X-Amz-Signature=c7600a00fea082dac002b247f9d6812f25195fbaf7f0a6fc4ce08a39666c6a10
3c8dcb
```
## Minta Otentikasi
Permintaan yang dikirimkan ke API Konfigurasi diautentikasi menggunakan kunci akses AWS Anda. Anda harus menyertakan parameter otorisasi dan tanda tangan digital dalam setiap permintaan. Amazon CloudSearch mendukung AWS Signature Versi 4. Untuk petunjuk penandatanganan terperinci, lihat [Proses Penandatanganan V4 Tanda Tangan](https://docs.aws.amazon.com/general/latest/gr/signature-version-4.html) di Referensi Umum AWS.
**catatan**
Jika Anda baru mulai menandatangani permintaan AWS Anda sendiri, lihat bagaimana penandatanganan SDKs implementasi. Sumber untuk sebagian besar AWS SDKs tersedia di [https://github.com/aws](https://github.com/aws).
Misalnya, untuk membuat `CreateDomain` permintaan, Anda memerlukan informasi berikut:
```
Region name: us-east-1
Service name: cloudsearch
API version: 2013-01-01
Date: 2014-03-12T21:41:29.094Z
Access key: AKIAIOSFODNN7EXAMPLE
Secret key: wJalrXUtnFEMI/K7MDENG/bPxRfiCYEXAMPLEKEY
Action: CreateDomain
Action Parameters: DomainName=movies
```
String kueri kanonik untuk `CreateDomain` permintaan terlihat seperti ini:
```
Action=CreateDomain
&DomainName=movies
&Version=2013-01-01
&X-Amz-Algorithm=AWS4-HMAC-SHA256
&X-Amz-Credential=AKIAIOSFODNN7EXAMPLE/20120712/us-east-1/cloudsearch/aws4
_request
&X-Amz-Date=2012-07-12T21:41:29.094Z
&X-Amz-SignedHeaders=host
```
Permintaan terakhir yang ditandatangani terlihat seperti ini:
```
https://cloudsearch.us-east-1.amazonaws.com
?Action=CreateDomain
&DomainName=movies
&Version=2013-01-01
&X-Amz-Algorithm=AWS4-HMAC-SHA256
&X-Amz-Credential=AKIAIOSFODNN7EXAMPLE/20120712/us-east-1/cloudsearch/aws4
_request
&X-Amz-Date=2014-03-12T21:41:29.094Z
&X-Amz-SignedHeaders=host
&X-Amz-Signature=c7600a00fea082dac002b247f9d6812f25195fbaf7f0a6fc4ce08a39666c6a10
```
# Tindakan
Tindakan berikut didukung:
+ [BuildSuggesters](API_BuildSuggesters.md)
+ [CreateDomain](API_CreateDomain.md)
+ [DefineAnalysisScheme](API_DefineAnalysisScheme.md)
+ [DefineExpression](API_DefineExpression.md)
+ [DefineIndexField](API_DefineIndexField.md)
+ [DefineSuggester](API_DefineSuggester.md)
+ [DeleteAnalysisScheme](API_DeleteAnalysisScheme.md)
+ [DeleteDomain](API_DeleteDomain.md)
+ [DeleteExpression](API_DeleteExpression.md)
+ [DeleteIndexField](API_DeleteIndexField.md)
+ [DeleteSuggester](API_DeleteSuggester.md)
+ [DescribeAnalysisSchemes](API_DescribeAnalysisSchemes.md)
+ [DescribeAvailabilityOptions](API_DescribeAvailabilityOptions.md)
+ [DescribeDomains](API_DescribeDomains.md)
+ [DescribeExpressions](API_DescribeExpressions.md)
+ [DescribeIndexFields](API_DescribeIndexFields.md)
+ [DescribeScalingParameters](API_DescribeScalingParameters.md)
+ [DescribeServiceAccessPolicies](API_DescribeServiceAccessPolicies.md)
+ [DescribeSuggesters](API_DescribeSuggesters.md)
+ [IndexDocuments](API_IndexDocuments.md)
+ [ListDomainNames](API_ListDomainNames.md)
+ [UpdateAvailabilityOptions](API_UpdateAvailabilityOptions.md)
+ [UpdateScalingParameters](API_UpdateScalingParameters.md)
+ [UpdateServiceAccessPolicies](API_UpdateServiceAccessPolicies.md)
# BuildSuggesters
## Deskripsi
Mengindeks saran pencarian. Untuk informasi selengkapnya, lihat [Mengonfigurasi Saran di Panduan](https://docs.aws.amazon.com/cloudsearch/latest/developerguide/getting-suggestions.html#configuring-suggesters) Pengembang *Amazon CloudSearch *.
## Parameter Permintaan
Untuk informasi tentang parameter umum yang digunakan semua tindakan, lihat[Parameter Umum](CommonParameters.md).
**DomainName**
String yang mewakili nama domain. Nama domain unik di seluruh domain yang dimiliki oleh akun dalam wilayah AWS. Nama domain dimulai dengan huruf atau angka dan dapat berisi karakter berikut: a-z (huruf kecil), 0-9, dan - (tanda hubung).
Tipe: String
Kendala panjang: Panjang minimum 3. Panjang maksimum 28.
Wajib: Ya
## Elemen Respons
Elemen berikut dikembalikan dalam struktur bernama`BuildSuggestersResult`.
**FieldNames**
Daftar nama bidang.
Jenis: Daftar string
Panjang batasan: Panjang minimum 1. Panjang maksimum adalah 64.
## Kesalahan
Untuk informasi tentang kesalahan yang umum untuk semua tindakan, lihat [Kesalahan Umum](CommonErrors.md).
**Basis**
Terjadi kesalahan saat memproses permintaan.
Kode Status HTTP: 400
**Internal**
Terjadi kesalahan internal saat memproses permintaan. Jika masalah ini berlanjut, laporkan masalah dari [Service Health Dashboard](https://status.aws.amazon.com/).
Kode Status HTTP: 500
**ResourceNotFound**
Permintaan ditolak karena berusaha mereferensikan sumber daya yang tidak ada.
Kode Status HTTP: 409
# CreateDomain
## Deskripsi
Membuat domain pencarian baru. Untuk informasi selengkapnya, lihat [Membuat Domain Pencarian](https://docs.aws.amazon.com/cloudsearch/latest/developerguide/creating-domains.html) di *Panduan CloudSearch Pengembang Amazon*.
## Parameter Permintaan
Untuk informasi tentang parameter umum yang digunakan semua tindakan, lihat[Parameter Umum](CommonParameters.md).
**DomainName**
Nama untuk domain yang Anda buat. Karakter yang diizinkan adalah a-z (huruf kecil), 0-9, dan tanda hubung (-). Nama domain harus dimulai dengan huruf atau angka dan setidaknya 3 dan tidak lebih dari 28 karakter.
Tipe: String
Kendala panjang: Panjang minimum 3. Panjang maksimum 28.
Wajib: Ya
## Elemen Respons
Elemen berikut dikembalikan dalam struktur bernama`CreateDomainResult`.
**DomainStatus**
Status domain pencarian saat ini.
Tipe: [DomainStatus](API_DomainStatus.md)
## Kesalahan
Untuk informasi tentang kesalahan yang umum untuk semua tindakan, lihat [Kesalahan Umum](CommonErrors.md).
**Basis**
Terjadi kesalahan saat memproses permintaan.
Kode Status HTTP: 400
**Internal**
Terjadi kesalahan internal saat memproses permintaan. Jika masalah ini berlanjut, laporkan masalah dari [Service Health Dashboard](https://status.aws.amazon.com/).
Kode Status HTTP: 500
**LimitExceeded**
Permintaan ditolak karena batas sumber daya telah dipenuhi.
Kode Status HTTP: 409
# DefineAnalysisScheme
## Deskripsi
Mengkonfigurasi skema analisis yang dapat diterapkan ke `text-array` bidang `text` atau untuk menentukan opsi pemrosesan teks khusus bahasa. Untuk informasi selengkapnya, lihat [Mengonfigurasi Skema Analisis](https://docs.aws.amazon.com/cloudsearch/latest/developerguide/configuring-analysis-schemes.html) di *Panduan CloudSearch Pengembang Amazon*.
## Parameter Permintaan
Untuk informasi tentang parameter umum yang digunakan semua tindakan, lihat[Parameter Umum](CommonParameters.md).
**AnalysisScheme**
Informasi konfigurasi untuk skema analisis. Setiap skema analisis memiliki nama yang unik dan menentukan bahasa teks yang akan diproses. Opsi berikut dapat dikonfigurasi untuk skema analisis:`Synonyms`,`Stopwords`,`StemmingDictionary`, `JapaneseTokenizationDictionary` dan`AlgorithmicStemming`.
Tipe: [AnalysisScheme](API_AnalysisScheme.md)
Wajib: Ya
**DomainName**
String yang mewakili nama domain. Nama domain unik di seluruh domain yang dimiliki oleh akun dalam wilayah AWS. Nama domain dimulai dengan huruf atau angka dan dapat berisi karakter berikut: a-z (huruf kecil), 0-9, dan - (tanda hubung).
Tipe: String
Kendala panjang: Panjang minimum 3. Panjang maksimum 28.
Wajib: Ya
## Elemen Respons
Elemen berikut dikembalikan dalam struktur bernama`DefineAnalysisSchemeResult`.
**AnalysisScheme**
Status dan konfigurasi file`AnalysisScheme`.
Tipe: [AnalysisSchemeStatus](API_AnalysisSchemeStatus.md)
## Kesalahan
Untuk informasi tentang kesalahan yang umum untuk semua tindakan, lihat [Kesalahan Umum](CommonErrors.md).
**Basis**
Terjadi kesalahan saat memproses permintaan.
Kode Status HTTP: 400
**Internal**
Terjadi kesalahan internal saat memproses permintaan. Jika masalah ini berlanjut, laporkan masalah dari [Service Health Dashboard](https://status.aws.amazon.com/).
Kode Status HTTP: 500
**InvalidType**
Permintaan ditolak karena ditentukan definisi tipe yang tidak valid.
Kode Status HTTP: 409
**LimitExceeded**
Permintaan ditolak karena batas sumber daya telah dipenuhi.
Kode Status HTTP: 409
**ResourceNotFound**
Permintaan ditolak karena berusaha mereferensikan sumber daya yang tidak ada.
Kode Status HTTP: 409
# DefineExpression
## Deskripsi
Mengkonfigurasi ` Expression ` untuk domain pencarian. Digunakan untuk membuat ekspresi baru dan memodifikasi yang sudah ada. Jika ekspresi ada, konfigurasi baru menggantikan yang lama. Untuk informasi selengkapnya, lihat [Mengonfigurasi Ekspresi](https://docs.aws.amazon.com/cloudsearch/latest/developerguide/configuring-expressions.html) di *Panduan CloudSearch Pengembang Amazon*.
## Parameter Permintaan
Untuk informasi tentang parameter umum yang digunakan semua tindakan, lihat[Parameter Umum](CommonParameters.md).
**DomainName**
String yang mewakili nama domain. Nama domain unik di seluruh domain yang dimiliki oleh akun dalam wilayah AWS. Nama domain dimulai dengan huruf atau angka dan dapat berisi karakter berikut: a-z (huruf kecil), 0-9, dan - (tanda hubung).
Tipe: String
Kendala panjang: Panjang minimum 3. Panjang maksimum 28.
Wajib: Ya
**Ekspresi**
Ekspresi bernama yang dapat dievaluasi pada waktu pencarian. Dapat digunakan untuk mengurutkan hasil pencarian, menentukan ekspresi lain, atau mengembalikan informasi yang dihitung dalam hasil pencarian.
Tipe: [Ekspresi](API_Expression.md)
Wajib: Ya
## Elemen Respons
Elemen berikut dikembalikan dalam struktur bernama`DefineExpressionResult`.
**Ekspresi**
Nilai `Expression` dan statusnya saat ini.
Tipe: [ExpressionStatus](API_ExpressionStatus.md)
## Kesalahan
Untuk informasi tentang kesalahan yang umum untuk semua tindakan, lihat [Kesalahan Umum](CommonErrors.md).
**Basis**
Terjadi kesalahan saat memproses permintaan.
Kode Status HTTP: 400
**Internal**
Terjadi kesalahan internal saat memproses permintaan. Jika masalah ini berlanjut, laporkan masalah dari [Service Health Dashboard](https://status.aws.amazon.com/).
Kode Status HTTP: 500
**InvalidType**
Permintaan ditolak karena ditentukan definisi tipe yang tidak valid.
Kode Status HTTP: 409
**LimitExceeded**
Permintaan ditolak karena batas sumber daya telah dipenuhi.
Kode Status HTTP: 409
**ResourceNotFound**
Permintaan ditolak karena berusaha mereferensikan sumber daya yang tidak ada.
Kode Status HTTP: 409
# DefineIndexField
## Deskripsi
Mengkonfigurasi ` IndexField ` untuk domain pencarian. Digunakan untuk membuat bidang baru dan memodifikasi yang sudah ada. Anda harus menentukan nama domain yang Anda konfigurasikan dan konfigurasi bidang indeks. Konfigurasi bidang indeks menentukan nama unik, jenis bidang indeks, dan opsi yang ingin Anda konfigurasikan untuk bidang tersebut. Opsi yang dapat Anda tentukan tergantung pada` IndexFieldType `. Jika bidang ada, konfigurasi baru menggantikan yang lama. Untuk informasi selengkapnya, lihat [Mengonfigurasi Bidang Indeks](https://docs.aws.amazon.com/cloudsearch/latest/developerguide/configuring-index-fields.html) di *Panduan CloudSearch Pengembang Amazon*.
## Parameter Permintaan
Untuk informasi tentang parameter umum yang digunakan semua tindakan, lihat[Parameter Umum](CommonParameters.md).
**DomainName**
String yang mewakili nama domain. Nama domain unik di seluruh domain yang dimiliki oleh akun dalam wilayah AWS. Nama domain dimulai dengan huruf atau angka dan dapat berisi karakter berikut: a-z (huruf kecil), 0-9, dan - (tanda hubung).
Tipe: String
Kendala panjang: Panjang minimum 3. Panjang maksimum 28.
Wajib: Ya
**IndexField**
Bidang indeks dan opsi bidang yang ingin Anda konfigurasikan.
Tipe: [IndexField](API_IndexField.md)
Wajib: Ya
## Elemen Respons
Elemen berikut dikembalikan dalam struktur bernama`DefineIndexFieldResult`.
**IndexField**
Nilai dari sebuah `IndexField` dan statusnya saat ini.
Tipe: [IndexFieldStatus](API_IndexFieldStatus.md)
## Kesalahan
Untuk informasi tentang kesalahan yang umum untuk semua tindakan, lihat [Kesalahan Umum](CommonErrors.md).
**Basis**
Terjadi kesalahan saat memproses permintaan.
Kode Status HTTP: 400
**Internal**
Terjadi kesalahan internal saat memproses permintaan. Jika masalah ini berlanjut, laporkan masalah dari [Service Health Dashboard](https://status.aws.amazon.com/).
Kode Status HTTP: 500
**InvalidType**
Permintaan ditolak karena ditentukan definisi tipe yang tidak valid.
Kode Status HTTP: 409
**LimitExceeded**
Permintaan ditolak karena batas sumber daya telah dipenuhi.
Kode Status HTTP: 409
**ResourceNotFound**
Permintaan ditolak karena berusaha mereferensikan sumber daya yang tidak ada.
Kode Status HTTP: 409
# DefineSuggester
## Deskripsi
Mengkonfigurasi sugester untuk domain. Sebuah sugester memungkinkan Anda untuk menampilkan kemungkinan kecocokan sebelum pengguna selesai mengetik kueri mereka. Saat Anda mengonfigurasi sugester, Anda harus menentukan nama bidang teks yang ingin Anda cari kemungkinan kecocokan dan nama unik untuk pemberi saran. Untuk informasi selengkapnya, lihat [Mendapatkan Saran Penelusuran](https://docs.aws.amazon.com/cloudsearch/latest/developerguide/getting-suggestions.html) di *Panduan CloudSearch Pengembang Amazon*.
## Parameter Permintaan
Untuk informasi tentang parameter umum yang digunakan semua tindakan, lihat[Parameter Umum](CommonParameters.md).
**DomainName**
String yang mewakili nama domain. Nama domain unik di seluruh domain yang dimiliki oleh akun dalam wilayah AWS. Nama domain dimulai dengan huruf atau angka dan dapat berisi karakter berikut: a-z (huruf kecil), 0-9, dan - (tanda hubung).
Tipe: String
Kendala panjang: Panjang minimum 3. Panjang maksimum 28.
Wajib: Ya
**Suggester**
Informasi konfigurasi untuk penelusuran penelusuran. Setiap sugester memiliki nama unik dan menentukan bidang teks yang ingin Anda gunakan untuk saran. Opsi berikut dapat dikonfigurasi untuk sugester:`FuzzyMatching`,`SortExpression`.
Tipe: [Suggester](API_Suggester.md)
Wajib: Ya
## Elemen Respons
Elemen berikut dikembalikan dalam struktur bernama`DefineSuggesterResult`.
**Suggester**
Nilai a `Suggester` dan statusnya saat ini.
Tipe: [SuggesterStatus](API_SuggesterStatus.md)
## Kesalahan
Untuk informasi tentang kesalahan yang umum untuk semua tindakan, lihat [Kesalahan Umum](CommonErrors.md).
**Basis**
Terjadi kesalahan saat memproses permintaan.
Kode Status HTTP: 400
**Internal**
Terjadi kesalahan internal saat memproses permintaan. Jika masalah ini berlanjut, laporkan masalah dari [Service Health Dashboard](https://status.aws.amazon.com/).
Kode Status HTTP: 500
**InvalidType**
Permintaan ditolak karena ditentukan definisi tipe yang tidak valid.
Kode Status HTTP: 409
**LimitExceeded**
Permintaan ditolak karena batas sumber daya telah dipenuhi.
Kode Status HTTP: 409
**ResourceNotFound**
Permintaan ditolak karena berusaha mereferensikan sumber daya yang tidak ada.
Kode Status HTTP: 409
# DeleteAnalysisScheme
## Deskripsi
Menghapus skema analisis. Untuk informasi selengkapnya, lihat [Mengonfigurasi Skema Analisis](https://docs.aws.amazon.com/cloudsearch/latest/developerguide/configuring-analysis-schemes.html) di *Panduan CloudSearch Pengembang Amazon*.
## Parameter Permintaan
Untuk informasi tentang parameter umum yang digunakan semua tindakan, lihat[Parameter Umum](CommonParameters.md).
**AnalysisSchemeName**
Nama skema analisis yang ingin Anda hapus.
Tipe: String
Panjang batasan: Panjang minimum 1. Panjang maksimum adalah 64.
Wajib: Ya
**DomainName**
String yang mewakili nama domain. Nama domain unik di seluruh domain yang dimiliki oleh akun dalam wilayah AWS. Nama domain dimulai dengan huruf atau angka dan dapat berisi karakter berikut: a-z (huruf kecil), 0-9, dan - (tanda hubung).
Tipe: String
Kendala panjang: Panjang minimum 3. Panjang maksimum 28.
Wajib: Ya
## Elemen Respons
Elemen berikut dikembalikan dalam struktur bernama`DeleteAnalysisSchemeResult`.
**AnalysisScheme**
Status skema analisis dihapus.
Tipe: [AnalysisSchemeStatus](API_AnalysisSchemeStatus.md)
## Kesalahan
Untuk informasi tentang kesalahan yang umum untuk semua tindakan, lihat [Kesalahan Umum](CommonErrors.md).
**Basis**
Terjadi kesalahan saat memproses permintaan.
Kode Status HTTP: 400
**Internal**
Terjadi kesalahan internal saat memproses permintaan. Jika masalah ini berlanjut, laporkan masalah dari [Service Health Dashboard](https://status.aws.amazon.com/).
Kode Status HTTP: 500
**InvalidType**
Permintaan ditolak karena ditentukan definisi tipe yang tidak valid.
Kode Status HTTP: 409
**ResourceNotFound**
Permintaan ditolak karena berusaha mereferensikan sumber daya yang tidak ada.
Kode Status HTTP: 409
# DeleteDomain
## Deskripsi
Secara permanen menghapus domain pencarian dan semua datanya. Setelah domain dihapus, itu tidak dapat dipulihkan. Untuk informasi selengkapnya, lihat [Menghapus Domain Pencarian](https://docs.aws.amazon.com/cloudsearch/latest/developerguide/deleting-domains.html) di *Panduan CloudSearch Pengembang Amazon*.
## Parameter Permintaan
Untuk informasi tentang parameter umum yang digunakan semua tindakan, lihat[Parameter Umum](CommonParameters.md).
**DomainName**
Nama domain yang ingin Anda hapus secara permanen.
Tipe: String
Kendala panjang: Panjang minimum 3. Panjang maksimum 28.
Wajib: Ya
## Elemen Respons
Elemen berikut dikembalikan dalam struktur bernama`DeleteDomainResult`.
**DomainStatus**
Status domain pencarian saat ini.
Tipe: [DomainStatus](API_DomainStatus.md)
## Kesalahan
Untuk informasi tentang kesalahan yang umum untuk semua tindakan, lihat [Kesalahan Umum](CommonErrors.md).
**Basis**
Terjadi kesalahan saat memproses permintaan.
Kode Status HTTP: 400
**Internal**
Terjadi kesalahan internal saat memproses permintaan. Jika masalah ini berlanjut, laporkan masalah dari [Service Health Dashboard](https://status.aws.amazon.com/).
Kode Status HTTP: 500
# DeleteExpression
## Deskripsi
Menghapus ` Expression ` dari domain pencarian. Untuk informasi selengkapnya, lihat [Mengonfigurasi Ekspresi](https://docs.aws.amazon.com/cloudsearch/latest/developerguide/configuring-expressions.html) di *Panduan CloudSearch Pengembang Amazon*.
## Parameter Permintaan
Untuk informasi tentang parameter umum yang digunakan semua tindakan, lihat[Parameter Umum](CommonParameters.md).
**DomainName**
String yang mewakili nama domain. Nama domain unik di seluruh domain yang dimiliki oleh akun dalam wilayah AWS. Nama domain dimulai dengan huruf atau angka dan dapat berisi karakter berikut: a-z (huruf kecil), 0-9, dan - (tanda hubung).
Tipe: String
Kendala panjang: Panjang minimum 3. Panjang maksimum 28.
Wajib: Ya
**ExpressionName**
Nama yang akan ` Expression ` dihapus.
Tipe: String
Panjang batasan: Panjang minimum 1. Panjang maksimum adalah 64.
Wajib: Ya
## Elemen Respons
Elemen berikut dikembalikan dalam struktur bernama`DeleteExpressionResult`.
**Ekspresi**
Status ekspresi yang dihapus.
Tipe: [ExpressionStatus](API_ExpressionStatus.md)
## Kesalahan
Untuk informasi tentang kesalahan yang umum untuk semua tindakan, lihat [Kesalahan Umum](CommonErrors.md).
**Basis**
Terjadi kesalahan saat memproses permintaan.
Kode Status HTTP: 400
**Internal**
Terjadi kesalahan internal saat memproses permintaan. Jika masalah ini berlanjut, laporkan masalah dari [Service Health Dashboard](https://status.aws.amazon.com/).
Kode Status HTTP: 500
**InvalidType**
Permintaan ditolak karena ditentukan definisi tipe yang tidak valid.
Kode Status HTTP: 409
**ResourceNotFound**
Permintaan ditolak karena berusaha mereferensikan sumber daya yang tidak ada.
Kode Status HTTP: 409
# DeleteIndexField
## Deskripsi
Menghapus ` IndexField ` dari domain pencarian. Untuk informasi selengkapnya, lihat [Mengonfigurasi Bidang Indeks](https://docs.aws.amazon.com/cloudsearch/latest/developerguide/configuring-index-fields.html) di *Panduan CloudSearch Pengembang Amazon*.
## Parameter Permintaan
Untuk informasi tentang parameter umum yang digunakan semua tindakan, lihat[Parameter Umum](CommonParameters.md).
**DomainName**
String yang mewakili nama domain. Nama domain unik di seluruh domain yang dimiliki oleh akun dalam wilayah AWS. Nama domain dimulai dengan huruf atau angka dan dapat berisi karakter berikut: a-z (huruf kecil), 0-9, dan - (tanda hubung).
Tipe: String
Kendala panjang: Panjang minimum 3. Panjang maksimum 28.
Wajib: Ya
**IndexFieldName**
Nama bidang indeks yang ingin Anda hapus dari opsi pengindeksan domain.
Tipe: String
Panjang batasan: Panjang minimum 1. Panjang maksimum adalah 64.
Wajib: Ya
## Elemen Respons
Elemen berikut dikembalikan dalam struktur bernama`DeleteIndexFieldResult`.
**IndexField**
Status bidang indeks yang dihapus.
Tipe: [IndexFieldStatus](API_IndexFieldStatus.md)
## Kesalahan
Untuk informasi tentang kesalahan yang umum untuk semua tindakan, lihat [Kesalahan Umum](CommonErrors.md).
**Basis**
Terjadi kesalahan saat memproses permintaan.
Kode Status HTTP: 400
**Internal**
Terjadi kesalahan internal saat memproses permintaan. Jika masalah ini berlanjut, laporkan masalah dari [Service Health Dashboard](https://status.aws.amazon.com/).
Kode Status HTTP: 500
**InvalidType**
Permintaan ditolak karena ditentukan definisi tipe yang tidak valid.
Kode Status HTTP: 409
**ResourceNotFound**
Permintaan ditolak karena berusaha mereferensikan sumber daya yang tidak ada.
Kode Status HTTP: 409
# DeleteSuggester
## Deskripsi
Menghapus sugester. Untuk informasi selengkapnya, lihat [Mendapatkan Saran Penelusuran](https://docs.aws.amazon.com/cloudsearch/latest/developerguide/getting-suggestions.html) di *Panduan CloudSearch Pengembang Amazon*.
## Parameter Permintaan
Untuk informasi tentang parameter umum yang digunakan semua tindakan, lihat[Parameter Umum](CommonParameters.md).
**DomainName**
String yang mewakili nama domain. Nama domain unik di seluruh domain yang dimiliki oleh akun dalam wilayah AWS. Nama domain dimulai dengan huruf atau angka dan dapat berisi karakter berikut: a-z (huruf kecil), 0-9, dan - (tanda hubung).
Tipe: String
Kendala panjang: Panjang minimum 3. Panjang maksimum 28.
Wajib: Ya
**SuggesterName**
Menentukan nama sugester yang ingin Anda hapus.
Tipe: String
Panjang batasan: Panjang minimum 1. Panjang maksimum adalah 64.
Wajib: Ya
## Elemen Respons
Elemen berikut dikembalikan dalam struktur bernama`DeleteSuggesterResult`.
**Suggester**
Status sugester dihapus.
Tipe: [SuggesterStatus](API_SuggesterStatus.md)
## Kesalahan
Untuk informasi tentang kesalahan yang umum untuk semua tindakan, lihat [Kesalahan Umum](CommonErrors.md).
**Basis**
Terjadi kesalahan saat memproses permintaan.
Kode Status HTTP: 400
**Internal**
Terjadi kesalahan internal saat memproses permintaan. Jika masalah ini berlanjut, laporkan masalah dari [Service Health Dashboard](https://status.aws.amazon.com/).
Kode Status HTTP: 500
**InvalidType**
Permintaan ditolak karena ditentukan definisi tipe yang tidak valid.
Kode Status HTTP: 409
**ResourceNotFound**
Permintaan ditolak karena berusaha mereferensikan sumber daya yang tidak ada.
Kode Status HTTP: 409
# DescribeAnalysisSchemes
## Deskripsi
Mendapatkan skema analisis yang dikonfigurasi untuk domain. Skema analisis mendefinisikan opsi pemrosesan teks khusus bahasa untuk suatu bidang. `text` Dapat dibatasi pada skema analisis spesifik berdasarkan nama. Secara default, menampilkan semua skema analisis dan menyertakan perubahan yang tertunda pada konfigurasi. Tetapkan `Deployed` opsi `true` untuk menampilkan konfigurasi aktif dan mengecualikan perubahan yang tertunda. Untuk informasi selengkapnya, lihat [Mengonfigurasi Skema Analisis](https://docs.aws.amazon.com/cloudsearch/latest/developerguide/configuring-analysis-schemes.html) di *Panduan CloudSearch Pengembang Amazon*.
## Parameter Permintaan
Untuk informasi tentang parameter umum yang digunakan semua tindakan, lihat[Parameter Umum](CommonParameters.md).
**AnalysisSchemeNames.member.n**
Skema analisis yang ingin Anda gambarkan.
Jenis: Daftar string
Panjang batasan: Panjang minimum 1. Panjang maksimum adalah 64.
Wajib: Tidak
**Dikerahkan**
Apakah akan menampilkan konfigurasi yang diterapkan (`true`) atau menyertakan perubahan yang tertunda (`false`). Default ke `false`.
Tipe: Boolean
Wajib: Tidak
**DomainName**
Nama domain yang ingin Anda gambarkan.
Tipe: String
Kendala panjang: Panjang minimum 3. Panjang maksimum 28.
Wajib: Ya
## Elemen Respons
Elemen berikut dikembalikan dalam struktur bernama`DescribeAnalysisSchemesResult`.
**AnalysisSchemes**
Deskripsi skema analisis.
Jenis: [AnalysisSchemeStatus](API_AnalysisSchemeStatus.md) daftar
## Kesalahan
Untuk informasi tentang kesalahan yang umum untuk semua tindakan, lihat [Kesalahan Umum](CommonErrors.md).
**Basis**
Terjadi kesalahan saat memproses permintaan.
Kode Status HTTP: 400
**Internal**
Terjadi kesalahan internal saat memproses permintaan. Jika masalah ini berlanjut, laporkan masalah dari [Service Health Dashboard](https://status.aws.amazon.com/).
Kode Status HTTP: 500
**ResourceNotFound**
Permintaan ditolak karena berusaha mereferensikan sumber daya yang tidak ada.
Kode Status HTTP: 409
# DescribeAvailabilityOptions
## Deskripsi
Mendapatkan opsi ketersediaan yang dikonfigurasi untuk domain. Secara default, menampilkan konfigurasi dengan perubahan yang tertunda. Tetapkan `Deployed` opsi `true` untuk menampilkan konfigurasi aktif dan mengecualikan perubahan yang tertunda. Untuk informasi selengkapnya, lihat [Mengonfigurasi Opsi Ketersediaan](https://docs.aws.amazon.com/cloudsearch/latest/developerguide/configuring-availability-options.html) di *Panduan CloudSearch Pengembang Amazon*.
## Parameter Permintaan
Untuk informasi tentang parameter umum yang digunakan semua tindakan, lihat[Parameter Umum](CommonParameters.md).
**Dikerahkan**
Apakah akan menampilkan konfigurasi yang diterapkan (`true`) atau menyertakan perubahan yang tertunda (`false`). Default ke `false`.
Tipe: Boolean
Wajib: Tidak
**DomainName**
Nama domain yang ingin Anda gambarkan.
Tipe: String
Kendala panjang: Panjang minimum 3. Panjang maksimum 28.
Wajib: Ya
## Elemen Respons
Elemen berikut dikembalikan dalam struktur bernama`DescribeAvailabilityOptionsResult`.
**AvailabilityOptions**
Opsi ketersediaan dikonfigurasi untuk domain. Menunjukkan apakah Multi-AZ diaktifkan untuk domain.
Tipe: [AvailabilityOptionsStatus](API_AvailabilityOptionsStatus.md)
## Kesalahan
Untuk informasi tentang kesalahan yang umum untuk semua tindakan, lihat [Kesalahan Umum](CommonErrors.md).
**Basis**
Terjadi kesalahan saat memproses permintaan.
Kode Status HTTP: 400
**DisabledOperation**
Permintaan ditolak karena mencoba operasi yang tidak diaktifkan.
Kode Status HTTP: 409
**Internal**
Terjadi kesalahan internal saat memproses permintaan. Jika masalah ini berlanjut, laporkan masalah dari [Service Health Dashboard](https://status.aws.amazon.com/).
Kode Status HTTP: 500
**InvalidType**
Permintaan ditolak karena ditentukan definisi tipe yang tidak valid.
Kode Status HTTP: 409
**LimitExceeded**
Permintaan ditolak karena batas sumber daya telah dipenuhi.
Kode Status HTTP: 409
**ResourceNotFound**
Permintaan ditolak karena berusaha mereferensikan sumber daya yang tidak ada.
Kode Status HTTP: 409
# DescribeDomains
## Deskripsi
Mendapat informasi tentang domain pencarian yang dimiliki oleh akun ini. Dapat dibatasi untuk domain tertentu. Menampilkan semua domain secara default. Untuk mendapatkan jumlah dokumen yang dapat dicari di domain, gunakan konsol atau kirimkan `matchall` permintaan ke titik akhir penelusuran domain Anda:. `q=matchall&q.parser=structured&size=0` Untuk informasi selengkapnya, lihat [Mendapatkan Informasi tentang Domain Pencarian](https://docs.aws.amazon.com/cloudsearch/latest/developerguide/getting-domain-info.html) di *Panduan CloudSearch Pengembang Amazon*.
## Parameter Permintaan
Untuk informasi tentang parameter umum yang digunakan semua tindakan, lihat[Parameter Umum](CommonParameters.md).
**DomainNames.member.n**
Nama-nama domain yang ingin Anda sertakan dalam respons.
Jenis: Daftar string
Kendala panjang: Panjang minimum 3. Panjang maksimum 28.
Wajib: Tidak
## Elemen Respons
Elemen berikut dikembalikan dalam struktur bernama`DescribeDomainsResult`.
**DomainStatusList**
Daftar yang berisi status setiap domain yang diminta.
Jenis: [DomainStatus](API_DomainStatus.md) daftar
## Kesalahan
Untuk informasi tentang kesalahan yang umum untuk semua tindakan, lihat [Kesalahan Umum](CommonErrors.md).
**Basis**
Terjadi kesalahan saat memproses permintaan.
Kode Status HTTP: 400
**Internal**
Terjadi kesalahan internal saat memproses permintaan. Jika masalah ini berlanjut, laporkan masalah dari [Service Health Dashboard](https://status.aws.amazon.com/).
Kode Status HTTP: 500
# DescribeExpressions
## Deskripsi
Mendapat ekspresi yang dikonfigurasi untuk domain pencarian. Dapat dibatasi pada ekspresi tertentu berdasarkan nama. Secara default, menampilkan semua ekspresi dan menyertakan perubahan yang tertunda pada konfigurasi. Tetapkan `Deployed` opsi `true` untuk menampilkan konfigurasi aktif dan mengecualikan perubahan yang tertunda. Untuk informasi selengkapnya, lihat [Mengonfigurasi Ekspresi](https://docs.aws.amazon.com/cloudsearch/latest/developerguide/configuring-expressions.html) di *Panduan CloudSearch Pengembang Amazon*.
## Parameter Permintaan
Untuk informasi tentang parameter umum yang digunakan semua tindakan, lihat[Parameter Umum](CommonParameters.md).
**Dikerahkan**
Apakah akan menampilkan konfigurasi yang diterapkan (`true`) atau menyertakan perubahan yang tertunda (`false`). Default ke `false`.
Tipe: Boolean
Wajib: Tidak
**DomainName**
Nama domain yang ingin Anda gambarkan.
Tipe: String
Kendala panjang: Panjang minimum 3. Panjang maksimum 28.
Wajib: Ya
**ExpressionNames.member.n**
Membatasi ` DescribeExpressions ` respons terhadap ekspresi yang ditentukan. Jika tidak ditentukan, semua ekspresi ditampilkan.
Jenis: Daftar string
Panjang batasan: Panjang minimum 1. Panjang maksimum adalah 64.
Wajib: Tidak
## Elemen Respons
Elemen berikut dikembalikan dalam struktur bernama`DescribeExpressionsResult`.
**Ekspresi**
Ekspresi dikonfigurasi untuk domain.
Jenis: [ExpressionStatus](API_ExpressionStatus.md) daftar
## Kesalahan
Untuk informasi tentang kesalahan yang umum untuk semua tindakan, lihat [Kesalahan Umum](CommonErrors.md).
**Basis**
Terjadi kesalahan saat memproses permintaan.
Kode Status HTTP: 400
**Internal**
Terjadi kesalahan internal saat memproses permintaan. Jika masalah ini berlanjut, laporkan masalah dari [Service Health Dashboard](https://status.aws.amazon.com/).
Kode Status HTTP: 500
**ResourceNotFound**
Permintaan ditolak karena berusaha mereferensikan sumber daya yang tidak ada.
Kode Status HTTP: 409
# DescribeIndexFields
## Deskripsi
Mendapat informasi tentang bidang indeks yang dikonfigurasi untuk domain pencarian. Dapat dibatasi untuk bidang tertentu berdasarkan nama. Secara default, menampilkan semua bidang dan menyertakan perubahan yang tertunda pada konfigurasi. Tetapkan `Deployed` opsi `true` untuk menampilkan konfigurasi aktif dan mengecualikan perubahan yang tertunda. Untuk informasi selengkapnya, lihat [Mendapatkan Informasi Domain](https://docs.aws.amazon.com/cloudsearch/latest/developerguide/getting-domain-info.html) di *Panduan CloudSearch Pengembang Amazon*.
## Parameter Permintaan
Untuk informasi tentang parameter umum yang digunakan semua tindakan, lihat[Parameter Umum](CommonParameters.md).
**Dikerahkan**
Apakah akan menampilkan konfigurasi yang diterapkan (`true`) atau menyertakan perubahan yang tertunda (`false`). Default ke `false`.
Tipe: Boolean
Wajib: Tidak
**DomainName**
Nama domain yang ingin Anda gambarkan.
Tipe: String
Kendala panjang: Panjang minimum 3. Panjang maksimum 28.
Wajib: Ya
**FieldNames.member.n**
Daftar bidang indeks yang ingin Anda jelaskan. Jika tidak ditentukan, informasi dikembalikan untuk semua bidang indeks yang dikonfigurasi.
Jenis: Daftar string
Panjang batasan: Panjang minimum 1. Panjang maksimum adalah 64.
Wajib: Tidak
## Elemen Respons
Elemen berikut dikembalikan dalam struktur bernama`DescribeIndexFieldsResult`.
**IndexFields**
Bidang indeks dikonfigurasi untuk domain.
Jenis: [IndexFieldStatus](API_IndexFieldStatus.md) daftar
## Kesalahan
Untuk informasi tentang kesalahan yang umum untuk semua tindakan, lihat [Kesalahan Umum](CommonErrors.md).
**Basis**
Terjadi kesalahan saat memproses permintaan.
Kode Status HTTP: 400
**Internal**
Terjadi kesalahan internal saat memproses permintaan. Jika masalah ini berlanjut, laporkan masalah dari [Service Health Dashboard](https://status.aws.amazon.com/).
Kode Status HTTP: 500
**ResourceNotFound**
Permintaan ditolak karena berusaha mereferensikan sumber daya yang tidak ada.
Kode Status HTTP: 409
# DescribeScalingParameters
## Deskripsi
Mendapatkan parameter penskalaan yang dikonfigurasi untuk domain. Parameter penskalaan domain menentukan jenis instance pencarian dan jumlah replikasi yang diinginkan. Untuk informasi selengkapnya, lihat [Mengonfigurasi Opsi Penskalaan](https://docs.aws.amazon.com/cloudsearch/latest/developerguide/configuring-scaling-options.html) di Panduan * CloudSearch Pengembang Amazon*.
## Parameter Permintaan
Untuk informasi tentang parameter umum yang digunakan semua tindakan, lihat[Parameter Umum](CommonParameters.md).
**DomainName**
String yang mewakili nama domain. Nama domain unik di seluruh domain yang dimiliki oleh akun dalam wilayah AWS. Nama domain dimulai dengan huruf atau angka dan dapat berisi karakter berikut: a-z (huruf kecil), 0-9, dan - (tanda hubung).
Tipe: String
Kendala panjang: Panjang minimum 3. Panjang maksimum 28.
Wajib: Ya
## Elemen Respons
Elemen berikut dikembalikan dalam struktur bernama`DescribeScalingParametersResult`.
**ScalingParameters**
Status dan konfigurasi parameter penskalaan domain pencarian.
Tipe: [ScalingParametersStatus](API_ScalingParametersStatus.md)
## Kesalahan
Untuk informasi tentang kesalahan yang umum untuk semua tindakan, lihat [Kesalahan Umum](CommonErrors.md).
**Basis**
Terjadi kesalahan saat memproses permintaan.
Kode Status HTTP: 400
**Internal**
Terjadi kesalahan internal saat memproses permintaan. Jika masalah ini berlanjut, laporkan masalah dari [Service Health Dashboard](https://status.aws.amazon.com/).
Kode Status HTTP: 500
**ResourceNotFound**
Permintaan ditolak karena berusaha mereferensikan sumber daya yang tidak ada.
Kode Status HTTP: 409
# DescribeDomainEndpointOptions
## Deskripsi
Mengembalikan opsi endpoint domain, khususnya apakah semua permintaan ke domain harus tiba melalui HTTPS. Untuk informasi selengkapnya, lihat [Mengonfigurasi Opsi Titik Akhir Domain](https://docs.aws.amazon.com/cloudsearch/latest/developerguide/configuring-domain-endpoint-options.html) di Panduan * CloudSearchPengembang Amazon*.
## Parameter Permintaan
Untuk informasi tentang parameter umum yang digunakan semua tindakan, lihat[Parameter Umum](CommonParameters.md).
**DomainName**
String yang mewakili nama domain.
Tipe: String
Diperlukan: Ya
**dikerahkan**
Apakah akan mengambil konfigurasi terbaru (yang mungkin dalam `Processing` status) atau konfigurasi aktif saat ini (`?deployed=true`).
Tipe: Boolean
Wajib: Tidak
## Elemen Respons
**DomainEndpointOptions**
Status dan konfigurasi opsi endpoint domain pencarian.
Tipe: [DomainEndpointOptionsStatus](API_DomainEndpointOptionsStatus.md)
## Kesalahan
Untuk informasi tentang kesalahan yang umum untuk semua tindakan, lihat [Kesalahan Umum](CommonErrors.md).
**Basis**
Terjadi kesalahan saat memproses permintaan.
Kode Status HTTP: 400
**Internal**
Terjadi kesalahan internal saat memproses permintaan. Jika masalah ini berlanjut, laporkan masalah dari [Service Health Dashboard](https://status.aws.amazon.com/).
Kode Status HTTP: 500
**LimitExceeded**
Permintaan ditolak karena batas sumber daya telah dipenuhi.
Kode Status HTTP: 409
**ResourceNotFound**
Permintaan ditolak karena berusaha mereferensikan sumber daya yang tidak ada.
Kode Status HTTP: 409
# DescribeServiceAccessPolicies
## Deskripsi
Mendapatkan informasi tentang kebijakan akses yang mengontrol akses ke dokumen domain dan titik akhir pencarian. Secara default, menampilkan konfigurasi dengan perubahan yang tertunda. Tetapkan `Deployed` opsi `true` untuk menampilkan konfigurasi aktif dan mengecualikan perubahan yang tertunda. Untuk informasi selengkapnya, lihat [Mengonfigurasi Akses untuk Domain Penelusuran](https://docs.aws.amazon.com/cloudsearch/latest/developerguide/configuring-access.html) di *Panduan CloudSearch Pengembang Amazon*.
## Parameter Permintaan
Untuk informasi tentang parameter umum yang digunakan semua tindakan, lihat[Parameter Umum](CommonParameters.md).
**Dikerahkan**
Apakah akan menampilkan konfigurasi yang diterapkan (`true`) atau menyertakan perubahan yang tertunda (`false`). Default ke `false`.
Tipe: Boolean
Wajib: Tidak
**DomainName**
Nama domain yang ingin Anda gambarkan.
Tipe: String
Kendala panjang: Panjang minimum 3. Panjang maksimum 28.
Wajib: Ya
## Elemen Respons
Elemen berikut dikembalikan dalam struktur bernama`DescribeServiceAccessPoliciesResult`.
**AccessPolicies**
Aturan akses yang dikonfigurasi untuk domain yang ditentukan dalam permintaan.
Tipe: [AccessPoliciesStatus](API_AccessPoliciesStatus.md)
## Kesalahan
Untuk informasi tentang kesalahan yang umum untuk semua tindakan, lihat [Kesalahan Umum](CommonErrors.md).
**Basis**
Terjadi kesalahan saat memproses permintaan.
Kode Status HTTP: 400
**Internal**
Terjadi kesalahan internal saat memproses permintaan. Jika masalah ini berlanjut, laporkan masalah dari [Service Health Dashboard](https://status.aws.amazon.com/).
Kode Status HTTP: 500
**ResourceNotFound**
Permintaan ditolak karena berusaha mereferensikan sumber daya yang tidak ada.
Kode Status HTTP: 409
# DescribeSuggesters
## Deskripsi
Mendapatkan sugester yang dikonfigurasi untuk domain. Sebuah sugester memungkinkan Anda untuk menampilkan kemungkinan kecocokan sebelum pengguna selesai mengetik kueri mereka. Dapat dibatasi untuk pemberi saran tertentu berdasarkan nama. Secara default, menampilkan semua pemberi saran dan menyertakan perubahan yang tertunda pada konfigurasi. Tetapkan `Deployed` opsi `true` untuk menampilkan konfigurasi aktif dan mengecualikan perubahan yang tertunda. Untuk informasi selengkapnya, lihat [Mendapatkan Saran Penelusuran](https://docs.aws.amazon.com/cloudsearch/latest/developerguide/getting-suggestions.html) di *Panduan CloudSearch Pengembang Amazon*.
## Parameter Permintaan
Untuk informasi tentang parameter umum yang digunakan semua tindakan, lihat[Parameter Umum](CommonParameters.md).
**Dikerahkan**
Apakah akan menampilkan konfigurasi yang diterapkan (`true`) atau menyertakan perubahan yang tertunda (`false`). Default ke `false`.
Tipe: Boolean
Wajib: Tidak
**DomainName**
Nama domain yang ingin Anda gambarkan.
Tipe: String
Kendala panjang: Panjang minimum 3. Panjang maksimum 28.
Wajib: Ya
**SuggesterNames.member.n**
Saran yang ingin Anda gambarkan.
Jenis: Daftar string
Panjang batasan: Panjang minimum 1. Panjang maksimum adalah 64.
Wajib: Tidak
## Elemen Respons
Elemen berikut dikembalikan dalam struktur bernama`DescribeSuggestersResult`.
**Penyarankan**
Para sugester dikonfigurasi untuk domain yang ditentukan dalam permintaan.
Jenis: [SuggesterStatus](API_SuggesterStatus.md) daftar
## Kesalahan
Untuk informasi tentang kesalahan yang umum untuk semua tindakan, lihat [Kesalahan Umum](CommonErrors.md).
**Basis**
Terjadi kesalahan saat memproses permintaan.
Kode Status HTTP: 400
**Internal**
Terjadi kesalahan internal saat memproses permintaan. Jika masalah ini berlanjut, laporkan masalah dari [Service Health Dashboard](https://status.aws.amazon.com/).
Kode Status HTTP: 500
**ResourceNotFound**
Permintaan ditolak karena berusaha mereferensikan sumber daya yang tidak ada.
Kode Status HTTP: 409
# IndexDocuments
## Deskripsi
Memberitahu domain pencarian untuk mulai mengindeks dokumennya menggunakan opsi pengindeksan terbaru. Operasi ini harus dipanggil untuk mengaktifkan opsi yang [OptionStatus](API_OptionStatus.md) ada`RequiresIndexDocuments`.
## Parameter Permintaan
Untuk informasi tentang parameter umum yang digunakan semua tindakan, lihat[Parameter Umum](CommonParameters.md).
**DomainName**
String yang mewakili nama domain. Nama domain unik di seluruh domain yang dimiliki oleh akun dalam wilayah AWS. Nama domain dimulai dengan huruf atau angka dan dapat berisi karakter berikut: a-z (huruf kecil), 0-9, dan - (tanda hubung).
Tipe: String
Kendala panjang: Panjang minimum 3. Panjang maksimum 28.
Wajib: Ya
## Elemen Respons
Elemen berikut dikembalikan dalam struktur bernama`IndexDocumentsResult`.
**FieldNames**
Nama-nama bidang yang saat ini sedang diindeks.
Jenis: Daftar string
Panjang batasan: Panjang minimum 1. Panjang maksimum adalah 64.
## Kesalahan
Untuk informasi tentang kesalahan yang umum untuk semua tindakan, lihat [Kesalahan Umum](CommonErrors.md).
**Basis**
Terjadi kesalahan saat memproses permintaan.
Kode Status HTTP: 400
**Internal**
Terjadi kesalahan internal saat memproses permintaan. Jika masalah ini berlanjut, laporkan masalah dari [Service Health Dashboard](https://status.aws.amazon.com/).
Kode Status HTTP: 500
**ResourceNotFound**
Permintaan ditolak karena berusaha mereferensikan sumber daya yang tidak ada.
Kode Status HTTP: 409
# ListDomainNames
## Deskripsi
Daftar semua domain pencarian yang dimiliki oleh akun.
## Elemen Respons
Elemen berikut dikembalikan dalam struktur bernama`ListDomainNamesResult`.
**DomainNames**
Nama-nama domain pencarian yang dimiliki oleh akun.
Tipe: Peta String ke String
## Kesalahan
Untuk informasi tentang kesalahan yang umum untuk semua tindakan, lihat [Kesalahan Umum](CommonErrors.md).
**Basis**
Terjadi kesalahan saat memproses permintaan.
Kode Status HTTP: 400
# UpdateAvailabilityOptions
## Deskripsi
Mengkonfigurasi opsi ketersediaan untuk domain. Mengaktifkan opsi Multi-AZ memperluas CloudSearch domain Amazon ke Availability Zone tambahan di Wilayah yang sama untuk meningkatkan toleransi kesalahan jika terjadi gangguan layanan. Perubahan pada opsi Multi-AZ dapat memakan waktu sekitar setengah jam untuk menjadi aktif. Untuk informasi selengkapnya, lihat [Mengonfigurasi Opsi Ketersediaan](https://docs.aws.amazon.com/cloudsearch/latest/developerguide/configuring-availability-options.html) di *Panduan CloudSearch Pengembang Amazon*.
## Parameter Permintaan
Untuk informasi tentang parameter umum yang digunakan semua tindakan, lihat[Parameter Umum](CommonParameters.md).
**DomainName**
String yang mewakili nama domain. Nama domain unik di seluruh domain yang dimiliki oleh akun dalam wilayah AWS. Nama domain dimulai dengan huruf atau angka dan dapat berisi karakter berikut: a-z (huruf kecil), 0-9, dan - (tanda hubung).
Tipe: String
Kendala panjang: Panjang minimum 3. Panjang maksimum 28.
Wajib: Ya
**MultiAZ**
Anda memperluas domain pencarian yang ada ke Availability Zone kedua dengan menyetel opsi Multi-AZ ke true. Demikian pula, Anda dapat mematikan opsi Multi-AZ untuk menurunkan versi domain ke Availability Zone tunggal dengan menyetel opsi Multi-AZ ke. `false`
Jenis: Boolean
Wajib: Ya
## Elemen Respons
Elemen berikut dikembalikan dalam struktur bernama`UpdateAvailabilityOptionsResult`.
**AvailabilityOptions**
Opsi ketersediaan yang baru dikonfigurasi. Menunjukkan apakah Multi-AZ diaktifkan untuk domain.
Tipe: [AvailabilityOptionsStatus](API_AvailabilityOptionsStatus.md)
## Kesalahan
Untuk informasi tentang kesalahan yang umum untuk semua tindakan, lihat [Kesalahan Umum](CommonErrors.md).
**Basis**
Terjadi kesalahan saat memproses permintaan.
Kode Status HTTP: 400
**DisabledOperation**
Permintaan ditolak karena mencoba operasi yang tidak diaktifkan.
Kode Status HTTP: 409
**Internal**
Terjadi kesalahan internal saat memproses permintaan. Jika masalah ini berlanjut, laporkan masalah dari [Service Health Dashboard](https://status.aws.amazon.com/).
Kode Status HTTP: 500
**InvalidType**
Permintaan ditolak karena ditentukan definisi tipe yang tidak valid.
Kode Status HTTP: 409
**LimitExceeded**
Permintaan ditolak karena batas sumber daya telah dipenuhi.
Kode Status HTTP: 409
**ResourceNotFound**
Permintaan ditolak karena berusaha mereferensikan sumber daya yang tidak ada.
Kode Status HTTP: 409
# UpdateScalingParameters
## Deskripsi
Mengkonfigurasi parameter penskalaan untuk domain. Parameter penskalaan domain menentukan jenis instance pencarian dan jumlah replikasi yang diinginkan. Amazon CloudSearch akan tetap secara otomatis menskalakan domain Anda berdasarkan volume data dan lalu lintas, tetapi tidak di bawah jenis instans dan jumlah replikasi yang diinginkan. Jika opsi Multi-AZ diaktifkan, nilai-nilai ini mengontrol sumber daya yang digunakan per Availability Zone. Untuk informasi selengkapnya, lihat [Mengonfigurasi Opsi Penskalaan](https://docs.aws.amazon.com/cloudsearch/latest/developerguide/configuring-scaling-options.html) di Panduan * CloudSearch Pengembang Amazon*.
## Parameter Permintaan
Untuk informasi tentang parameter umum yang digunakan semua tindakan, lihat[Parameter Umum](CommonParameters.md).
**DomainName**
String yang mewakili nama domain. Nama domain unik di seluruh domain yang dimiliki oleh akun dalam wilayah AWS. Nama domain dimulai dengan huruf atau angka dan dapat berisi karakter berikut: a-z (huruf kecil), 0-9, dan - (tanda hubung).
Tipe: String
Kendala panjang: Panjang minimum 3. Panjang maksimum 28.
Wajib: Ya
**ScalingParameters**
Jenis instance yang diinginkan dan jumlah replika yang diinginkan dari setiap partisi indeks.
Tipe: [ScalingParameters](API_ScalingParameters.md)
Wajib: Ya
## Elemen Respons
Elemen berikut dikembalikan dalam struktur bernama`UpdateScalingParametersResult`.
**ScalingParameters**
Status dan konfigurasi parameter penskalaan domain pencarian.
Tipe: [ScalingParametersStatus](API_ScalingParametersStatus.md)
## Kesalahan
Untuk informasi tentang kesalahan yang umum untuk semua tindakan, lihat [Kesalahan Umum](CommonErrors.md).
**Basis**
Terjadi kesalahan saat memproses permintaan.
Kode Status HTTP: 400
**Internal**
Terjadi kesalahan internal saat memproses permintaan. Jika masalah ini berlanjut, laporkan masalah dari [Service Health Dashboard](https://status.aws.amazon.com/).
Kode Status HTTP: 500
**InvalidType**
Permintaan ditolak karena ditentukan definisi tipe yang tidak valid.
Kode Status HTTP: 409
**LimitExceeded**
Permintaan ditolak karena batas sumber daya telah dipenuhi.
Kode Status HTTP: 409
**ResourceNotFound**
Permintaan ditolak karena berusaha mereferensikan sumber daya yang tidak ada.
Kode Status HTTP: 409
# UpdateDomainEndpointOptions
## Deskripsi
Memperbarui opsi endpoint domain, khususnya apakah semua permintaan ke domain harus tiba melalui HTTPS. Untuk informasi selengkapnya, lihat [Mengonfigurasi Opsi Titik Akhir Domain](https://docs.aws.amazon.com/cloudsearch/latest/developerguide/configuring-domain-endpoint-options.html) di Panduan * CloudSearchPengembang Amazon*.
## Parameter Permintaan
**DomainName**
String yang mewakili nama domain.
Tipe: String
Diperlukan: Ya
**DomainEndpointOptions**
Kontainer untuk opsi titik akhir.
Tipe: [DomainEndpointOptions](API_DomainEndpointOptions.md)
Wajib: Ya
## Elemen Respons
**DomainEndpointOptionsStatus**
Status dan konfigurasi opsi endpoint domain.
Tipe: [DomainEndpointOptionsStatus](API_DomainEndpointOptionsStatus.md)
## Kesalahan
Untuk informasi tentang kesalahan yang umum untuk semua tindakan, lihat [Kesalahan Umum](CommonErrors.md).
**Basis**
Terjadi kesalahan saat memproses permintaan.
Kode Status HTTP: 400
**Internal**
Terjadi kesalahan internal saat memproses permintaan. Jika masalah ini berlanjut, laporkan masalah dari [Service Health Dashboard](https://status.aws.amazon.com/).
Kode Status HTTP: 500
InvalidType
Permintaan ditolak karena ditentukan definisi tipe yang tidak valid.
Kode Status HTTP: 409
**LimitExceeded**
Permintaan ditolak karena batas sumber daya telah dipenuhi.
Kode Status HTTP: 409
**ResourceNotFound**
Permintaan ditolak karena berusaha mereferensikan sumber daya yang tidak ada.
Kode Status HTTP: 409
**ValidationException**
Permintaan berisi input yang tidak valid atau tidak ada input yang diperlukan.
Kode status HTTP 400.
**DisabledOperation**
Permintaan ditolak karena mencoba operasi yang tidak diaktifkan.
Kode Status HTTP: 409
# UpdateServiceAccessPolicies
## Deskripsi
Mengkonfigurasi aturan akses yang mengontrol akses ke dokumen domain dan titik akhir pencarian. Untuk informasi selengkapnya, lihat [Mengonfigurasi Akses untuk CloudSearch Domain Amazon](https://docs.aws.amazon.com/cloudsearch/latest/developerguide/configuring-access.html).
## Parameter Permintaan
Untuk informasi tentang parameter umum yang digunakan semua tindakan, lihat[Parameter Umum](CommonParameters.md).
**AccessPolicies**
Aturan akses yang ingin Anda konfigurasikan. Aturan-aturan ini menggantikan aturan yang ada.
Tipe: String
Diperlukan: Ya
**DomainName**
String yang mewakili nama domain. Nama domain unik di seluruh domain yang dimiliki oleh akun dalam wilayah AWS. Nama domain dimulai dengan huruf atau angka dan dapat berisi karakter berikut: a-z (huruf kecil), 0-9, dan - (tanda hubung).
Tipe: String
Kendala panjang: Panjang minimum 3. Panjang maksimum 28.
Wajib: Ya
## Elemen Respons
Elemen berikut dikembalikan dalam struktur bernama`UpdateServiceAccessPoliciesResult`.
**AccessPolicies**
Aturan akses yang dikonfigurasi untuk domain.
Tipe: [AccessPoliciesStatus](API_AccessPoliciesStatus.md)
## Kesalahan
Untuk informasi tentang kesalahan yang umum untuk semua tindakan, lihat [Kesalahan Umum](CommonErrors.md).
**Basis**
Terjadi kesalahan saat memproses permintaan.
Kode Status HTTP: 400
**Internal**
Terjadi kesalahan internal saat memproses permintaan. Jika masalah ini berlanjut, laporkan masalah dari [Service Health Dashboard](https://status.aws.amazon.com/).
Kode Status HTTP: 500
**InvalidType**
Permintaan ditolak karena ditentukan definisi tipe yang tidak valid.
Kode Status HTTP: 409
**LimitExceeded**
Permintaan ditolak karena batas sumber daya telah dipenuhi.
Kode Status HTTP: 409
**ResourceNotFound**
Permintaan ditolak karena berusaha mereferensikan sumber daya yang tidak ada.
Kode Status HTTP: 409
# Jenis Data
Amazon CloudSearch Configuration Service API berisi beberapa tipe data yang digunakan berbagai tindakan. Bagian ini menjelaskan setiap tipe data secara detail.
**catatan**
Urutan setiap elemen dalam respons tidak dijamin. Aplikasi tidak harus mengambil urutan tertentu.
Tipe data berikut didukung:
+ [AccessPoliciesStatus](API_AccessPoliciesStatus.md)
+ [AnalysisOptions](API_AnalysisOptions.md)
+ [AnalysisScheme](API_AnalysisScheme.md)
+ [AnalysisSchemeStatus](API_AnalysisSchemeStatus.md)
+ [AvailabilityOptionsStatus](API_AvailabilityOptionsStatus.md)
+ [BuildSuggestersResult](API_BuildSuggestersResult.md)
+ [CreateDomainResult](API_CreateDomainResult.md)
+ [DateArrayOptions](API_DateArrayOptions.md)
+ [DateOptions](API_DateOptions.md)
+ [DefineAnalysisSchemeResult](API_DefineAnalysisSchemeResult.md)
+ [DefineExpressionResult](API_DefineExpressionResult.md)
+ [DefineIndexFieldResult](API_DefineIndexFieldResult.md)
+ [DefineSuggesterResult](API_DefineSuggesterResult.md)
+ [DeleteAnalysisSchemeResult](API_DeleteAnalysisSchemeResult.md)
+ [DeleteDomainResult](API_DeleteDomainResult.md)
+ [DeleteExpressionResult](API_DeleteExpressionResult.md)
+ [DeleteIndexFieldResult](API_DeleteIndexFieldResult.md)
+ [DeleteSuggesterResult](API_DeleteSuggesterResult.md)
+ [DescribeAnalysisSchemesResult](API_DescribeAnalysisSchemesResult.md)
+ [DescribeAvailabilityOptionsResult](API_DescribeAvailabilityOptionsResult.md)
+ [DescribeDomainsResult](API_DescribeDomainsResult.md)
+ [DescribeExpressionsResult](API_DescribeExpressionsResult.md)
+ [DescribeIndexFieldsResult](API_DescribeIndexFieldsResult.md)
+ [DescribeScalingParametersResult](API_DescribeScalingParametersResult.md)
+ [DescribeServiceAccessPoliciesResult](API_DescribeServiceAccessPoliciesResult.md)
+ [DescribeSuggestersResult](API_DescribeSuggestersResult.md)
+ [DocumentSuggesterOptions](API_DocumentSuggesterOptions.md)
+ [DomainStatus](API_DomainStatus.md)
+ [DoubleArrayOptions](API_DoubleArrayOptions.md)
+ [DoubleOptions](API_DoubleOptions.md)
+ [Ekspresi](API_Expression.md)
+ [ExpressionStatus](API_ExpressionStatus.md)
+ [IndexDocumentsResult](API_IndexDocumentsResult.md)
+ [IndexField](API_IndexField.md)
+ [IndexFieldStatus](API_IndexFieldStatus.md)
+ [IntArrayOptions](API_IntArrayOptions.md)
+ [IntOptions](API_IntOptions.md)
+ [LatLonOptions](API_LatLonOptions.md)
+ [Batas](API_Limits.md)
+ [ListDomainNamesResult](API_ListDomainNamesResult.md)
+ [LiteralArrayOptions](API_LiteralArrayOptions.md)
+ [LiteralOptions](API_LiteralOptions.md)
+ [BuildSuggestersResult](API_BuildSuggestersResult.md)
+ [OptionStatus](API_OptionStatus.md)
+ [ScalingParameters](API_ScalingParameters.md)
+ [ScalingParametersStatus](API_ScalingParametersStatus.md)
+ [ServiceEndpoint](API_ServiceEndpoint.md)
+ [Suggester](API_Suggester.md)
+ [SuggesterStatus](API_SuggesterStatus.md)
+ [TextArrayOptions](API_TextArrayOptions.md)
+ [TextOptions](API_TextOptions.md)
+ [UpdateAvailabilityOptionsResult](API_UpdateAvailabilityOptionsResult.md)
+ [UpdateScalingParametersResult](API_UpdateScalingParametersResult.md)
+ [UpdateServiceAccessPoliciesResult](API_UpdateServiceAccessPoliciesResult.md)
# AccessPoliciesStatus
## Deskripsi
Aturan akses yang dikonfigurasi untuk dokumen domain dan titik akhir pencarian, dan status saat ini dari aturan tersebut.
## Daftar Isi
**Pilihan**
Aturan akses untuk dokumen domain atau titik akhir layanan pencarian. Untuk informasi selengkapnya, lihat [Mengonfigurasi Akses untuk Domain Penelusuran](https://docs.aws.amazon.com/cloudsearch/latest/developerguide/configuring-access.html) di *Panduan CloudSearch Pengembang Amazon*. Ukuran maksimum dokumen kebijakan adalah 100 KB.
Tipe: String
Diperlukan: Ya
**Status**
Status opsi konfigurasi domain.
Tipe: [OptionStatus](API_OptionStatus.md)
Wajib: Ya
# AnalysisOptions
## Deskripsi
Sinonim, stopwords, dan opsi stemming untuk skema analisis. Termasuk kamus tokenisasi untuk bahasa Jepang.
## Daftar Isi
**AlgorithmicStemming**
Tingkat pembatalan algoritmik untuk melakukan:`none`,,`minimal`, `light` atau. `full` Tingkat yang tersedia bervariasi tergantung pada bahasa. Untuk informasi selengkapnya, lihat [Pengaturan Pemrosesan Teks Khusus Bahasa](https://docs.aws.amazon.com/cloudsearch/latest/developerguide/text-processing.html#text-processing-settings) di *Panduan CloudSearch Pengembang Amazon*
Tipe: String
Nilai yang Valid: `none | minimal | light | full`
Wajib: Tidak
**JapaneseTokenizationDictionary**
Array JSON yang berisi kumpulan istilah, token, bacaan, dan bagian pidato untuk Tokenizaiton Jepang. Kamus tokenisasi Jepang memungkinkan Anda untuk mengganti tokenisasi default untuk istilah yang dipilih. Ini hanya berlaku untuk bidang bahasa Jepang.
Tipe: String
Wajib: Tidak
**StemmingDictionary**
Objek JSON yang berisi kumpulan pasangan string: nilai yang masing-masing memetakan istilah ke batangnya. Misalnya, `{"term1": "stem1", "term2": "stem2", "term3": "stem3"}`. Kamus stemming diterapkan selain stemming algoritmik apa pun. Ini memungkinkan Anda untuk mengesampingkan hasil pembatalan algoritmik untuk memperbaiki kasus-kasus tertentu dari overstemming atau understemming. Ukuran maksimum kamus stemming adalah 500 KB.
Tipe: String
Wajib: Tidak
**Stopwords**
Sebuah array JSON istilah untuk mengabaikan selama pengindeksan dan pencarian. Misalnya, `["a", "an", "the", "of"]`. Kamus stopwords harus secara eksplisit mencantumkan setiap kata yang ingin Anda abaikan. Wildcard dan ekspresi reguler tidak didukung.
Tipe: String
Wajib: Tidak
**Sinonim**
Objek JSON yang mendefinisikan grup sinonim dan alias. Grup sinonim adalah array array, di mana setiap sub-array adalah sekelompok istilah di mana setiap istilah dalam grup dianggap sebagai sinonim dari setiap istilah lain dalam grup. Nilai alias adalah objek yang berisi kumpulan pasangan string:value di mana string menentukan istilah dan array nilai menentukan masing-masing alias untuk istilah tersebut. Alias dianggap sebagai sinonim dari istilah yang ditentukan, tetapi istilah tersebut tidak dianggap sebagai sinonim dari alias. Untuk informasi selengkapnya tentang menentukan sinonim, lihat [Sinonim](https://docs.aws.amazon.com/cloudsearch/latest/developerguide/configuring-analysis-schemes.html#synonyms) di *Panduan CloudSearch Pengembang Amazon*.
Tipe: String
Wajib: Tidak
# AnalysisScheme
## Deskripsi
Informasi konfigurasi untuk skema analisis. Setiap skema analisis memiliki nama yang unik dan menentukan bahasa teks yang akan diproses. Opsi berikut dapat dikonfigurasi untuk skema analisis:`Synonyms`,`Stopwords`,`StemmingDictionary`, `JapaneseTokenizationDictionary` dan`AlgorithmicStemming`.
## Daftar Isi
**AnalysisOptions**
Sinonim, stopwords, dan opsi stemming untuk skema analisis. Termasuk kamus tokenisasi untuk bahasa Jepang.
Tipe: [AnalysisOptions](API_AnalysisOptions.md)
Wajib: Tidak
**AnalysisSchemeLanguage**
Kode bahasa [IETF RFC 4646](http://tools.ietf.org/html/rfc4646) atau `mul` untuk beberapa bahasa.
Tipe: String
Nilai yang Valid: `ar | bg | ca | cs | da | de | el | en | es | eu | fa | fi | fr | ga | gl | he | hi | hu | hy | id | it | ja | ko | lv | mul | nl | no | pt | ro | ru | sv | th | tr | zh-Hans | zh-Hant`
Wajib: Ya
**AnalysisSchemeName**
Nama harus dimulai dengan huruf dan dapat berisi karakter berikut: a-z (huruf kecil), 0-9, dan \$1 (garis bawah).
Tipe: String
Panjang batasan: Panjang minimum 1. Panjang maksimum adalah 64.
Wajib: Ya
# AnalysisSchemeStatus
## Deskripsi
Status dan konfigurasi file`AnalysisScheme`.
## Daftar Isi
**Pilihan**
Informasi konfigurasi untuk skema analisis. Setiap skema analisis memiliki nama yang unik dan menentukan bahasa teks yang akan diproses. Opsi berikut dapat dikonfigurasi untuk skema analisis:`Synonyms`,`Stopwords`,`StemmingDictionary`, `JapaneseTokenizationDictionary` dan`AlgorithmicStemming`.
Tipe: [AnalysisScheme](API_AnalysisScheme.md)
Wajib: Ya
**Status**
Status opsi konfigurasi domain.
Tipe: [OptionStatus](API_OptionStatus.md)
Wajib: Ya
# AvailabilityOptionsStatus
## Deskripsi
Status dan konfigurasi opsi ketersediaan domain.
## Daftar Isi
**Pilihan**
Opsi ketersediaan yang dikonfigurasi untuk domain.
Jenis: Boolean
Wajib: Ya
**Status**
Status opsi konfigurasi domain.
Tipe: [OptionStatus](API_OptionStatus.md)
Wajib: Ya
# BuildSuggestersResult
## Deskripsi
Hasil `BuildSuggester` permintaan. Berisi daftar bidang yang digunakan untuk saran.
## Daftar Isi
**FieldNames**
Daftar nama bidang.
Jenis: Daftar string
Panjang batasan: Panjang minimum 1. Panjang maksimum adalah 64.
Wajib: Tidak
# CreateDomainResult
## Deskripsi
Hasil dari a`CreateDomainRequest`. Berisi status domain yang baru dibuat.
## Daftar Isi
**DomainStatus**
Status domain pencarian saat ini.
Tipe: [DomainStatus](API_DomainStatus.md)
Wajib: Tidak
# DateArrayOptions
## Deskripsi
Opsi untuk bidang yang berisi larik tanggal. Hadir jika `IndexFieldType` menentukan bidang adalah tipe`date-array`. Semua opsi diaktifkan secara default.
## Daftar Isi
**DefaultValue**
Nilai yang akan digunakan untuk bidang jika bidang tidak ditentukan untuk dokumen.
Tipe: String
Kendala panjang: Panjang minimum 0. Panjang maksimum 1024.
Wajib: Tidak
**FacetEnabled**
Apakah informasi facet dapat dikembalikan untuk bidang tersebut.
Tipe: Boolean
Wajib: Tidak
**ReturnEnabled**
Apakah isi bidang dapat dikembalikan dalam hasil pencarian.
Tipe: Boolean
Wajib: Tidak
**SearchEnabled**
Apakah isi bidang dapat dicari.
Tipe: Boolean
Wajib: Tidak
**SourceFields**
Daftar bidang sumber untuk dipetakan ke bidang.
Tipe: String
Wajib: Tidak
# DateOptions
## Deskripsi
Opsi untuk bidang tanggal. Tanggal dan waktu ditentukan dalam UTC (Coordinated Universal Time) menurut RFC3339 IETF: 00:00:00 Z. yyyy-mm-ddT Hadir jika `IndexFieldType` menentukan bidang adalah tipe`date`. Semua opsi diaktifkan secara default.
## Daftar Isi
**DefaultValue**
Nilai yang akan digunakan untuk bidang jika bidang tidak ditentukan untuk dokumen.
Tipe: String
Kendala panjang: Panjang minimum 0. Panjang maksimum 1024.
Wajib: Tidak
**FacetEnabled**
Apakah informasi facet dapat dikembalikan untuk bidang tersebut.
Tipe: Boolean
Wajib: Tidak
**ReturnEnabled**
Apakah isi bidang dapat dikembalikan dalam hasil pencarian.
Tipe: Boolean
Wajib: Tidak
**SearchEnabled**
Apakah isi bidang dapat dicari.
Tipe: Boolean
Wajib: Tidak
**SortEnabled**
Apakah bidang dapat digunakan untuk mengurutkan hasil pencarian.
Tipe: Boolean
Wajib: Tidak
**SourceField**
String yang mewakili nama bidang indeks. CloudSearch mendukung bidang indeks reguler serta bidang dinamis. Nama bidang dinamis mendefinisikan pola yang dimulai atau diakhiri dengan wildcard. Bidang dokumen apa pun yang tidak dipetakan ke bidang indeks biasa tetapi cocok dengan pola bidang dinamis dikonfigurasi dengan opsi pengindeksan bidang dinamis.
Nama bidang reguler dimulai dengan huruf dan dapat berisi karakter berikut: a-z (huruf kecil), 0-9, dan \$1 (garis bawah). Nama bidang dinamis harus dimulai atau diakhiri dengan wildcard (\$1). Wildcard juga bisa menjadi satu-satunya karakter dalam nama bidang dinamis. Beberapa wildcard, dan wildcard yang disematkan dalam string tidak didukung.
Nama `score` dicadangkan dan tidak dapat digunakan sebagai nama bidang. Untuk mereferensikan ID dokumen, Anda dapat menggunakan nama tersebut`_id`.
Tipe: String
Panjang batasan: Panjang minimum 1. Panjang maksimum adalah 64.
Wajib: Tidak
# DefineAnalysisSchemeResult
## Deskripsi
Hasil dari ` DefineAnalysisScheme ` permintaan. Berisi status skema analisis yang baru dikonfigurasi.
## Daftar Isi
**AnalysisScheme**
Status dan konfigurasi file`AnalysisScheme`.
Tipe: [AnalysisSchemeStatus](API_AnalysisSchemeStatus.md)
Wajib: Ya
# DefineExpressionResult
## Deskripsi
Hasil dari `DefineExpression` permintaan. Berisi status ekspresi yang baru dikonfigurasi.
## Daftar Isi
**Ekspresi**
Nilai dari sebuah `Expression` dan statusnya saat ini.
Tipe: [ExpressionStatus](API_ExpressionStatus.md)
Wajib: Ya
# DefineIndexFieldResult
## Deskripsi
Hasil dari ` DefineIndexField ` permintaan. Berisi status bidang indeks yang baru dikonfigurasi.
## Daftar Isi
**IndexField**
Nilai dari sebuah `IndexField` dan statusnya saat ini.
Tipe: [IndexFieldStatus](API_IndexFieldStatus.md)
Wajib: Ya
# DefineSuggesterResult
## Deskripsi
Hasil dari `DefineSuggester` permintaan. Berisi status sugester yang baru dikonfigurasi.
## Daftar Isi
**Penyarankan**
Nilai a `Suggester` dan statusnya saat ini.
Tipe: [SuggesterStatus](API_SuggesterStatus.md)
Wajib: Ya
# DeleteAnalysisSchemeResult
## Deskripsi
Hasil dari `DeleteAnalysisScheme` permintaan. Berisi status skema analisis yang dihapus.
## Daftar Isi
**AnalysisScheme**
Status skema analisis dihapus.
Tipe: [AnalysisSchemeStatus](API_AnalysisSchemeStatus.md)
Wajib: Ya
# DeleteDomainResult
## Deskripsi
Hasil dari `DeleteDomain` permintaan. Berisi status domain yang baru dihapus, atau tidak ada status jika domain telah sepenuhnya dihapus.
## Daftar Isi
**DomainStatus**
Status domain pencarian saat ini.
Tipe: [DomainStatus](API_DomainStatus.md)
Wajib: Tidak
# DeleteExpressionResult
## Deskripsi
Hasil ` DeleteExpression ` permintaan. Menentukan ekspresi yang dihapus.
## Daftar Isi
**Ekspresi**
Status ekspresi yang dihapus.
Tipe: [ExpressionStatus](API_ExpressionStatus.md)
Wajib: Ya
# DeleteIndexFieldResult
## Deskripsi
Hasil ` DeleteIndexField ` permintaan.
## Daftar Isi
**IndexField**
Status bidang indeks yang dihapus.
Tipe: [IndexFieldStatus](API_IndexFieldStatus.md)
Wajib: Ya
# DeleteSuggesterResult
## Deskripsi
Hasil dari `DeleteSuggester` permintaan. Berisi status sugester yang dihapus.
## Daftar Isi
**Penyarankan**
Status sugester dihapus.
Tipe: [SuggesterStatus](API_SuggesterStatus.md)
Wajib: Ya
# DescribeAnalysisSchemesResult
## Deskripsi
Hasil dari `DescribeAnalysisSchemes` permintaan. Berisi skema analisis yang dikonfigurasi untuk domain yang ditentukan dalam permintaan.
## Daftar Isi
**AnalysisSchemes**
Deskripsi skema analisis.
Jenis: [AnalysisSchemeStatus](API_AnalysisSchemeStatus.md) daftar
Wajib: Ya
# DescribeAvailabilityOptionsResult
## Deskripsi
Hasil dari `DescribeAvailabilityOptions` permintaan. Menunjukkan apakah opsi Multi-AZ diaktifkan atau tidak untuk domain yang ditentukan dalam permintaan.
## Daftar Isi
**AvailabilityOptions**
Opsi ketersediaan yang dikonfigurasi untuk domain. Menunjukkan apakah Multi-AZ diaktifkan untuk domain.
Tipe: [AvailabilityOptionsStatus](API_AvailabilityOptionsStatus.md)
Wajib: Tidak
# DescribeDomainsResult
## Deskripsi
Hasil dari `DescribeDomains` permintaan. Berisi status domain yang ditentukan dalam permintaan atau semua domain yang dimiliki oleh akun.
## Daftar Isi
**DomainStatusList**
Daftar yang berisi status setiap domain yang diminta.
Jenis: [DomainStatus](API_DomainStatus.md) daftar
Wajib: Ya
# DescribeExpressionsResult
## Deskripsi
Hasil dari `DescribeExpressions` permintaan. Berisi ekspresi yang dikonfigurasi untuk domain yang ditentukan dalam permintaan.
## Daftar Isi
**Ekspresi**
Ekspresi dikonfigurasi untuk domain.
Jenis: [ExpressionStatus](API_ExpressionStatus.md) daftar
Wajib: Ya
# DescribeIndexFieldsResult
## Deskripsi
Hasil dari `DescribeIndexFields` permintaan. Berisi bidang indeks yang dikonfigurasi untuk domain yang ditentukan dalam permintaan.
## Daftar Isi
**IndexFields**
Bidang indeks dikonfigurasi untuk domain.
Jenis: [IndexFieldStatus](API_IndexFieldStatus.md) daftar
Wajib: Ya
# DescribeScalingParametersResult
## Deskripsi
Hasil `DescribeScalingParameters` permintaan. Berisi parameter penskalaan yang dikonfigurasi untuk domain yang ditentukan dalam permintaan.
## Daftar Isi
**ScalingParameters**
Status dan konfigurasi parameter penskalaan domain pencarian.
Tipe: [ScalingParametersStatus](API_ScalingParametersStatus.md)
Wajib: Ya
# DescribeServiceAccessPoliciesResult
## Deskripsi
Hasil dari `DescribeServiceAccessPolicies` permintaan.
## Daftar Isi
**AccessPolicies**
Aturan akses yang dikonfigurasi untuk domain yang ditentukan dalam permintaan.
Tipe: [AccessPoliciesStatus](API_AccessPoliciesStatus.md)
Wajib: Ya
# DescribeSuggestersResult
## Deskripsi
Hasil dari `DescribeSuggesters` permintaan.
## Daftar Isi
**Penyarankan**
Para sugester dikonfigurasi untuk domain yang ditentukan dalam permintaan.
Jenis: [SuggesterStatus](API_SuggesterStatus.md) daftar
Wajib: Ya
# DocumentSuggesterOptions
## Deskripsi
Opsi untuk penelusuran penelusuran.
## Daftar Isi
**FuzzyMatching**
Tingkat ketidakjelasan diperbolehkan saat menyarankan kecocokan untuk string:`none`,, `low` atau. `high` Dengan none, string yang ditentukan diperlakukan sebagai awalan yang tepat. Dengan rendah, saran harus berbeda dari string yang ditentukan dengan tidak lebih dari satu karakter. Dengan tinggi, saran dapat berbeda hingga dua karakter. Defaultnya tidak ada.
Tipe: String
Nilai yang Valid: `none | low | high`
Wajib: Tidak
**SortExpression**
Ekspresi yang menghitung skor untuk setiap saran untuk mengontrol bagaimana mereka diurutkan. Skor dibulatkan ke bilangan bulat terdekat, dengan lantai 0 dan langit-langit 2^31-1. Skor relevansi dokumen tidak dihitung untuk saran, jadi ekspresi pengurutan tidak dapat mereferensikan nilainya. `_score` Untuk mengurutkan saran menggunakan bidang numerik atau ekspresi yang ada, cukup tentukan nama bidang atau ekspresi. Jika tidak ada ekspresi yang dikonfigurasi untuk sugester, saran diurutkan dengan kecocokan terdekat yang terdaftar terlebih dahulu.
Tipe: String
Wajib: Tidak
**SourceField**
Nama bidang indeks yang ingin Anda gunakan untuk saran.
Tipe: String
Panjang batasan: Panjang minimum 1. Panjang maksimum adalah 64.
Wajib: Ya
# DomainEndpointOptions
## Deskripsi
Apakah mengharuskan semua permintaan ke domain tiba melalui HTTPS. Kami merekomendasikan `Policy-Min-TLS-1-2-2019-07` untuk`TLSSecurityPolicy`. Untuk kompatibilitas dengan klien lama, defaultnya adalah`Policy-Min-TLS-1-0-2019-07`.
## Daftar Isi
**enforceHttps**
Mengaktifkan atau menonaktifkan persyaratan bahwa semua permintaan ke domain tiba melalui HTTPS.
Jenis: Boolean
Nilai yang Valid: `true | false`
Wajib: Tidak
**TLSSecurityKebijakan**
Versi TLS minimum yang diperlukan.
Tipe: String
Nilai yang Valid: `Policy-Min-TLS-1-2-2019-07 | Policy-Min-TLS-1-0-2019-07`
Wajib: Tidak
# DomainEndpointOptionsStatus
## Deskripsi
Konfigurasi dan status opsi endpoint domain.
## Daftar Isi
**Pilihan**
Konfigurasi saat ini.
Tipe: [DomainEndpointOptions](API_DomainEndpointOptions.md)
**Status**
Status opsi konfigurasi.
Tipe: [OptionStatus](API_OptionStatus.md)
# DomainStatus
## Deskripsi
Status domain pencarian saat ini.
## Daftar Isi
**ARN**
Nama Sumber Daya Amazon (ARN) dari domain pencarian. Lihat [Pengidentifikasi Entitas IAM](https://docs.aws.amazon.com/IAM/latest/UserGuide/index.html?Using_Identifiers.html) dalam *Menggunakan AWS Identity and Access Management* untuk informasi selengkapnya.
Tipe: String
Wajib: Tidak
**Dibuat**
Benar jika domain pencarian dibuat. Diperlukan beberapa menit untuk menginisialisasi domain saat [CreateDomain](API_CreateDomain.md) dipanggil. Domain pencarian yang baru dibuat dikembalikan [DescribeDomains](API_DescribeDomains.md) dengan nilai palsu untuk Dibuat hingga pembuatan domain selesai.
Tipe: Boolean
Wajib: Tidak
**Dihapus**
Benar jika domain pencarian telah dihapus. Sistem harus membersihkan sumber daya yang didedikasikan untuk domain pencarian ketika [DeleteDomain](API_DeleteDomain.md) dipanggil. Domain pencarian yang baru dihapus dikembalikan [DescribeDomains](API_DescribeDomains.md) dengan nilai sebenarnya IsDeleted selama beberapa menit hingga pembersihan sumber daya selesai.
Tipe: Boolean
Wajib: Tidak
**DocService**
Endpoint layanan untuk memperbarui dokumen dalam domain pencarian.
Tipe: [ServiceEndpoint](API_ServiceEndpoint.md)
Wajib: Tidak
**DomainId**
Pengidentifikasi unik yang dihasilkan secara internal untuk domain.
Tipe: String
Panjang batasan: Panjang minimum 1. Panjang maksimum adalah 64.
Wajib: Ya
**DomainName**
String yang mewakili nama domain. Nama domain unik di seluruh domain yang dimiliki oleh akun dalam wilayah AWS. Nama domain dimulai dengan huruf atau angka dan dapat berisi karakter berikut: a-z (huruf kecil), 0-9, dan - (tanda hubung).
Tipe: String
Kendala panjang: Panjang minimum 3. Panjang maksimum 28.
Wajib: Ya
**Batas**
Tipe: [Batas](API_Limits.md)
Wajib: Tidak
**Pengolahan**
Benar jika pemrosesan sedang dilakukan untuk mengaktifkan konfigurasi domain saat ini.
Tipe: Boolean
Wajib: Tidak
**RequiresIndexDocuments**
Benar jika [IndexDocuments](API_IndexDocuments.md) perlu dipanggil untuk mengaktifkan konfigurasi domain saat ini.
Jenis: Boolean
Wajib: Ya
**SearchInstanceCount**
Jumlah instance pencarian yang tersedia untuk memproses permintaan pencarian.
Tipe: Integer
Wajib: Tidak
**SearchInstanceType**
Jenis instance yang digunakan untuk memproses permintaan pencarian.
Tipe: String
Wajib: Tidak
**SearchPartitionCount**
Jumlah partisi di mana indeks pencarian tersebar.
Tipe: Integer
Wajib: Tidak
**SearchService**
Titik akhir layanan untuk meminta hasil pencarian dari domain pencarian.
Tipe: [ServiceEndpoint](API_ServiceEndpoint.md)
Wajib: Tidak
# DoubleArrayOptions
## Deskripsi
Opsi untuk bidang yang berisi larik nilai floating point 64-bit presisi ganda. Hadir jika `IndexFieldType` menentukan bidang adalah jenis`double-array`. Semua opsi diaktifkan secara default.
## Daftar Isi
**DefaultValue**
Nilai yang akan digunakan untuk bidang jika bidang tidak ditentukan untuk dokumen.
Tipe: Ganda
Wajib: Tidak
**FacetEnabled**
Apakah informasi facet dapat dikembalikan untuk bidang tersebut.
Tipe: Boolean
Wajib: Tidak
**ReturnEnabled**
Apakah isi bidang dapat dikembalikan dalam hasil pencarian.
Tipe: Boolean
Wajib: Tidak
**SearchEnabled**
Apakah isi bidang dapat dicari.
Tipe: Boolean
Wajib: Tidak
**SourceFields**
Daftar bidang sumber untuk dipetakan ke bidang.
Tipe: String
Wajib: Tidak
# DoubleOptions
## Deskripsi
Opsi untuk bidang floating point 64-bit presisi ganda. Hadir jika `IndexFieldType` menentukan bidang adalah tipe`double`. Semua opsi diaktifkan secara default.
## Daftar Isi
**DefaultValue**
Nilai yang akan digunakan untuk bidang jika bidang tidak ditentukan untuk dokumen. Ini bisa menjadi penting jika Anda menggunakan bidang dalam ekspresi dan bidang itu tidak ada di setiap dokumen.
Tipe: Ganda
Wajib: Tidak
**FacetEnabled**
Apakah informasi facet dapat dikembalikan untuk bidang tersebut.
Tipe: Boolean
Wajib: Tidak
**ReturnEnabled**
Apakah isi bidang dapat dikembalikan dalam hasil pencarian.
Tipe: Boolean
Wajib: Tidak
**SearchEnabled**
Apakah isi bidang dapat dicari.
Tipe: Boolean
Wajib: Tidak
**SortEnabled**
Apakah bidang dapat digunakan untuk mengurutkan hasil pencarian.
Tipe: Boolean
Wajib: Tidak
**SourceField**
Nama bidang sumber untuk dipetakan ke bidang.
Tipe: String
Panjang batasan: Panjang minimum 1. Panjang maksimum adalah 64.
Wajib: Tidak
# Ekspresi
## Deskripsi
Ekspresi bernama yang dapat dievaluasi pada waktu pencarian. Dapat digunakan untuk mengurutkan hasil pencarian, menentukan ekspresi lain, atau mengembalikan informasi yang dihitung dalam hasil pencarian.
## Daftar Isi
**ExpressionName**
Nama harus dimulai dengan huruf dan dapat berisi karakter berikut: a-z (huruf kecil), 0-9, dan \$1 (garis bawah).
Tipe: String
Panjang batasan: Panjang minimum 1. Panjang maksimum adalah 64.
Wajib: Ya
**ExpressionValue**
Ekspresi untuk mengevaluasi untuk penyortiran saat memproses permintaan pencarian. `Expression`Sintaks didasarkan pada JavaScript ekspresi. Untuk informasi selengkapnya, lihat [Mengonfigurasi Ekspresi](https://docs.aws.amazon.com/cloudsearch/latest/developerguide/configuring-expressions.html) di *Panduan CloudSearch Pengembang Amazon*.
Tipe: String
Panjang batasan: Panjang minimum 1. Panjang maksimum 10240.
Wajib: Ya
# ExpressionStatus
## Deskripsi
Nilai dari sebuah `Expression` dan statusnya saat ini.
## Daftar Isi
**Pilihan**
Ekspresi yang dievaluasi untuk menyortir saat memproses permintaan pencarian.
Tipe: [Ekspresi](API_Expression.md)
Wajib: Ya
**Status**
Status opsi konfigurasi domain.
Tipe: [OptionStatus](API_OptionStatus.md)
Wajib: Ya
# IndexDocumentsResult
## Deskripsi
Hasil dari `IndexDocuments` permintaan. Berisi status operasi pengindeksan, termasuk bidang yang diindeks.
## Daftar Isi
**FieldNames**
Nama-nama bidang yang saat ini sedang diindeks.
Jenis: Daftar string
Panjang batasan: Panjang minimum 1. Panjang maksimum adalah 64.
Wajib: Tidak
# IndexField
## Deskripsi
Informasi konfigurasi untuk bidang dalam indeks, termasuk nama, jenis, dan opsinya. Opsi yang didukung tergantung pada` IndexFieldType `.
## Daftar Isi
**DateArrayOptions**
Opsi untuk bidang yang berisi larik tanggal. Hadir jika `IndexFieldType` menentukan bidang adalah tipe`date-array`. Semua opsi diaktifkan secara default.
Tipe: [DateArrayOptions](API_DateArrayOptions.md)
Wajib: Tidak
**DateOptions**
Opsi untuk bidang tanggal. Tanggal dan waktu ditentukan dalam UTC (Coordinated Universal Time) menurut RFC3339 IETF: 00:00:00 Z. yyyy-mm-ddT Hadir jika `IndexFieldType` menentukan bidang adalah tipe`date`. Semua opsi diaktifkan secara default.
Tipe: [DateOptions](API_DateOptions.md)
Wajib: Tidak
**DoubleArrayOptions**
Opsi untuk bidang yang berisi larik nilai floating point 64-bit presisi ganda. Hadir jika `IndexFieldType` menentukan bidang adalah tipe`double-array`. Semua opsi diaktifkan secara default.
Tipe: [DoubleArrayOptions](API_DoubleArrayOptions.md)
Wajib: Tidak
**DoubleOptions**
Opsi untuk bidang floating point 64-bit presisi ganda. Hadir jika `IndexFieldType` menentukan bidang adalah tipe`double`. Semua opsi diaktifkan secara default.
Tipe: [DoubleOptions](API_DoubleOptions.md)
Wajib: Tidak
**IndexFieldName**
String yang mewakili nama bidang indeks. CloudSearch mendukung bidang indeks reguler serta bidang dinamis. Nama bidang dinamis mendefinisikan pola yang dimulai atau diakhiri dengan wildcard. Bidang dokumen apa pun yang tidak dipetakan ke bidang indeks biasa tetapi cocok dengan pola bidang dinamis dikonfigurasi dengan opsi pengindeksan bidang dinamis.
Nama bidang reguler dimulai dengan huruf dan dapat berisi karakter berikut: a-z (huruf kecil), 0-9, dan \$1 (garis bawah). Nama bidang dinamis harus dimulai atau diakhiri dengan wildcard (\$1). Wildcard juga bisa menjadi satu-satunya karakter dalam nama bidang dinamis. Beberapa wildcard, dan wildcard yang disematkan dalam string tidak didukung.
Nama `score` dicadangkan dan tidak dapat digunakan sebagai nama bidang. Untuk mereferensikan ID dokumen, Anda dapat menggunakan nama tersebut`_id`.
Tipe: String
Panjang batasan: Panjang minimum 1. Panjang maksimum adalah 64.
Wajib: Ya
**IndexFieldType**
Jenis bidang. Opsi yang valid untuk bidang tergantung pada jenis bidang. Untuk informasi selengkapnya tentang jenis bidang yang didukung, lihat [Mengonfigurasi Bidang Indeks](https://docs.aws.amazon.com/cloudsearch/latest/developerguide/configuring-index-fields.html) di *Panduan CloudSearch Pengembang Amazon*.
Tipe: String
Nilai yang Valid: `int | double | literal | text | date | latlon | int-array | double-array | literal-array | text-array | date-array`
Wajib: Ya
**IntArrayOptions**
Opsi untuk bidang yang berisi array bilangan bulat bertanda 64-bit. Hadir jika `IndexFieldType` menentukan bidang adalah tipe`int-array`. Semua opsi diaktifkan secara default.
Tipe: [IntArrayOptions](API_IntArrayOptions.md)
Wajib: Tidak
**IntOptions**
Opsi untuk bidang integer bertanda 64-bit. Hadir jika `IndexFieldType` menentukan bidang adalah tipe`int`. Semua opsi diaktifkan secara default.
Tipe: [IntOptions](API_IntOptions.md)
Wajib: Tidak
**LatLonOptions**
Opsi untuk bidang latlon. Bidang latlon berisi lokasi yang disimpan sebagai pasangan nilai lintang dan bujur. Hadir jika `IndexFieldType` menentukan bidang adalah tipe`latlon`. Semua opsi diaktifkan secara default.
Tipe: [LatLonOptions](API_LatLonOptions.md)
Wajib: Tidak
**LiteralArrayOptions**
Pilihan untuk bidang yang berisi array string literal. Hadir jika `IndexFieldType` menentukan bidang adalah tipe`literal-array`. Semua opsi diaktifkan secara default.
Tipe: [LiteralArrayOptions](API_LiteralArrayOptions.md)
Wajib: Tidak
**LiteralOptions**
Opsi untuk bidang literal. Hadir jika `IndexFieldType` menentukan bidang adalah tipe`literal`. Semua opsi diaktifkan secara default.
Tipe: [LiteralOptions](API_LiteralOptions.md)
Wajib: Tidak
**TextArrayOptions**
Pilihan untuk bidang yang berisi array string teks. Hadir jika `IndexFieldType` menentukan bidang adalah tipe`text-array`. `text-array`Bidang selalu dapat dicari. Semua opsi diaktifkan secara default.
Tipe: [TextArrayOptions](API_TextArrayOptions.md)
Wajib: Tidak
**TextOptions**
Opsi untuk bidang teks. Hadir jika `IndexFieldType` menentukan bidang adalah tipe`text`. `text`Bidang selalu dapat dicari. Semua opsi diaktifkan secara default.
Tipe: [TextOptions](API_TextOptions.md)
Wajib: Tidak
# IndexFieldStatus
## Deskripsi
Nilai dari sebuah `IndexField` dan statusnya saat ini.
## Daftar Isi
**Pilihan**
Informasi konfigurasi untuk bidang dalam indeks, termasuk nama, jenis, dan opsinya. Opsi yang didukung tergantung pada` IndexFieldType `.
Tipe: [IndexField](API_IndexField.md)
Wajib: Ya
**Status**
Status opsi konfigurasi domain.
Tipe: [OptionStatus](API_OptionStatus.md)
Wajib: Ya
# IntArrayOptions
## Deskripsi
Opsi untuk bidang yang berisi larik bilangan bulat bertanda 64-bit. Hadir jika `IndexFieldType` menentukan bidang adalah tipe`int-array`. Semua opsi diaktifkan secara default.
## Daftar Isi
**DefaultValue**
Nilai yang akan digunakan untuk bidang jika bidang tidak ditentukan untuk dokumen.
Tipe: Panjang
Wajib: Tidak
**FacetEnabled**
Apakah informasi facet dapat dikembalikan untuk bidang tersebut.
Tipe: Boolean
Wajib: Tidak
**ReturnEnabled**
Apakah isi bidang dapat dikembalikan dalam hasil pencarian.
Tipe: Boolean
Wajib: Tidak
**SearchEnabled**
Apakah isi bidang dapat dicari.
Tipe: Boolean
Wajib: Tidak
**SourceFields**
Daftar bidang sumber untuk dipetakan ke bidang.
Tipe: String
Wajib: Tidak
# IntOptions
## Deskripsi
Opsi untuk bidang integer bertanda 64-bit. Hadir jika `IndexFieldType` menentukan bidang adalah jenis`int`. Semua opsi diaktifkan secara default.
## Daftar Isi
**DefaultValue**
Nilai yang akan digunakan untuk bidang jika bidang tidak ditentukan untuk dokumen. Ini bisa menjadi penting jika Anda menggunakan bidang dalam ekspresi dan bidang itu tidak ada di setiap dokumen.
Tipe: Panjang
Wajib: Tidak
**FacetEnabled**
Apakah informasi facet dapat dikembalikan untuk bidang tersebut.
Tipe: Boolean
Wajib: Tidak
**ReturnEnabled**
Apakah isi bidang dapat dikembalikan dalam hasil pencarian.
Tipe: Boolean
Wajib: Tidak
**SearchEnabled**
Apakah isi bidang dapat dicari.
Tipe: Boolean
Wajib: Tidak
**SortEnabled**
Apakah bidang dapat digunakan untuk mengurutkan hasil pencarian.
Tipe: Boolean
Wajib: Tidak
**SourceField**
Nama bidang sumber untuk dipetakan ke bidang.
Tipe: String
Panjang batasan: Panjang minimum 1. Panjang maksimum adalah 64.
Wajib: Tidak
# LatLonOptions
## Deskripsi
Opsi untuk bidang latlon. Bidang latlon berisi lokasi yang disimpan sebagai pasangan nilai lintang dan bujur. Hadir jika `IndexFieldType` menentukan bidang adalah tipe`latlon`. Semua opsi diaktifkan secara default.
## Daftar Isi
**DefaultValue**
Nilai yang akan digunakan untuk bidang jika bidang tidak ditentukan untuk dokumen.
Tipe: String
Kendala panjang: Panjang minimum 0. Panjang maksimum 1024.
Wajib: Tidak
**FacetEnabled**
Apakah informasi facet dapat dikembalikan untuk bidang tersebut.
Tipe: Boolean
Wajib: Tidak
**ReturnEnabled**
Apakah isi bidang dapat dikembalikan dalam hasil pencarian.
Tipe: Boolean
Wajib: Tidak
**SearchEnabled**
Apakah isi bidang dapat dicari.
Tipe: Boolean
Wajib: Tidak
**SortEnabled**
Apakah bidang dapat digunakan untuk mengurutkan hasil pencarian.
Tipe: Boolean
Wajib: Tidak
**SourceField**
String yang mewakili nama bidang indeks. CloudSearch mendukung bidang indeks reguler serta bidang dinamis. Nama bidang dinamis mendefinisikan pola yang dimulai atau diakhiri dengan wildcard. Bidang dokumen apa pun yang tidak dipetakan ke bidang indeks biasa tetapi cocok dengan pola bidang dinamis dikonfigurasi dengan opsi pengindeksan bidang dinamis.
Nama bidang reguler dimulai dengan huruf dan dapat berisi karakter berikut: a-z (huruf kecil), 0-9, dan \$1 (garis bawah). Nama bidang dinamis harus dimulai atau diakhiri dengan wildcard (\$1). Wildcard juga bisa menjadi satu-satunya karakter dalam nama bidang dinamis. Beberapa wildcard, dan wildcard yang disematkan dalam string tidak didukung.
Nama `score` dicadangkan dan tidak dapat digunakan sebagai nama bidang. Untuk mereferensikan ID dokumen, Anda dapat menggunakan nama tersebut`_id`.
Tipe: String
Panjang batasan: Panjang minimum 1. Panjang maksimum adalah 64.
Wajib: Tidak
# Batas
## Deskripsi
Tidak ada dokumentasi tindakan yang tersedia.
## Daftar Isi
**MaximumPartitionCount**
Jenis: Integer
Wajib: Ya
**MaximumReplicationCount**
Jenis: Integer
Wajib: Ya
# ListDomainNamesResult
## Deskripsi
Hasil dari `ListDomainNames` permintaan. Berisi daftar domain yang dimiliki oleh akun.
## Daftar Isi
**DomainNames**
Nama-nama domain pencarian yang dimiliki oleh akun.
Tipe: Peta String ke String
Wajib: Tidak
# LiteralArrayOptions
## Deskripsi
Pilihan untuk bidang yang berisi array string literal. Hadir jika `IndexFieldType` menentukan bidang adalah tipe`literal-array`. Semua opsi diaktifkan secara default.
## Daftar Isi
**DefaultValue**
Nilai yang akan digunakan untuk bidang jika bidang tidak ditentukan untuk dokumen.
Tipe: String
Kendala panjang: Panjang minimum 0. Panjang maksimum 1024.
Wajib: Tidak
**FacetEnabled**
Apakah informasi facet dapat dikembalikan untuk bidang tersebut.
Tipe: Boolean
Wajib: Tidak
**ReturnEnabled**
Apakah isi bidang dapat dikembalikan dalam hasil pencarian.
Tipe: Boolean
Wajib: Tidak
**SearchEnabled**
Apakah isi bidang dapat dicari.
Tipe: Boolean
Wajib: Tidak
**SourceFields**
Daftar bidang sumber untuk dipetakan ke bidang.
Tipe: String
Wajib: Tidak
# LiteralOptions
## Deskripsi
Opsi untuk bidang literal. Hadir jika `IndexFieldType` menentukan bidang adalah tipe`literal`. Semua opsi diaktifkan secara default.
## Daftar Isi
**DefaultValue**
Nilai yang akan digunakan untuk bidang jika bidang tidak ditentukan untuk dokumen.
Tipe: String
Kendala panjang: Panjang minimum 0. Panjang maksimum 1024.
Wajib: Tidak
**FacetEnabled**
Apakah informasi facet dapat dikembalikan untuk bidang tersebut.
Tipe: Boolean
Wajib: Tidak
**ReturnEnabled**
Apakah isi bidang dapat dikembalikan dalam hasil pencarian.
Tipe: Boolean
Wajib: Tidak
**SearchEnabled**
Apakah isi bidang dapat dicari.
Tipe: Boolean
Wajib: Tidak
**SortEnabled**
Apakah bidang dapat digunakan untuk mengurutkan hasil pencarian.
Tipe: Boolean
Wajib: Tidak
**SourceField**
String yang mewakili nama bidang indeks. CloudSearch mendukung bidang indeks reguler serta bidang dinamis. Nama bidang dinamis mendefinisikan pola yang dimulai atau diakhiri dengan wildcard. Bidang dokumen apa pun yang tidak dipetakan ke bidang indeks biasa tetapi cocok dengan pola bidang dinamis dikonfigurasi dengan opsi pengindeksan bidang dinamis.
Nama bidang reguler dimulai dengan huruf dan dapat berisi karakter berikut: a-z (huruf kecil), 0-9, dan \$1 (garis bawah). Nama bidang dinamis harus dimulai atau diakhiri dengan wildcard (\$1). Wildcard juga bisa menjadi satu-satunya karakter dalam nama bidang dinamis. Beberapa wildcard, dan wildcard yang disematkan dalam string tidak didukung.
Nama `score` dicadangkan dan tidak dapat digunakan sebagai nama bidang. Untuk mereferensikan ID dokumen, Anda dapat menggunakan nama tersebut`_id`.
Tipe: String
Panjang batasan: Panjang minimum 1. Panjang maksimum adalah 64.
Wajib: Tidak
# OptionStatus
## Deskripsi
Status opsi konfigurasi domain.
## Daftar Isi
**CreationDate**
Stempel waktu untuk kapan opsi ini dibuat.
Tipe: DateTime
Wajib: Ya
**PendingDeletion**
Menunjukkan bahwa opsi akan dihapus setelah pemrosesan selesai.
Tipe: Boolean
Wajib: Tidak
**Status**
Keadaan memproses perubahan ke opsi. Kemungkinan nilai:
+ `RequiresIndexDocuments`: nilai terbaru opsi tidak akan diterapkan sampai [IndexDocuments](API_IndexDocuments.md) dipanggil dan pengindeksan selesai.
+ `Processing`: nilai terbaru opsi sedang dalam proses diaktifkan.
+ `Active`: nilai terbaru opsi sepenuhnya diterapkan.
+ `FailedToValidate`: nilai opsi tidak kompatibel dengan data domain dan tidak dapat digunakan untuk mengindeks data. Anda harus mengubah nilai opsi atau memperbarui atau menghapus dokumen yang tidak kompatibel.
Tipe: String
Nilai yang Valid: `RequiresIndexDocuments | Processing | Active | FailedToValidate`
Wajib: Ya
**UpdateDate**
Stempel waktu kapan opsi ini terakhir diperbarui.
Tipe: DateTime
Wajib: Ya
**UpdateVersion**
Sebuah integer unik yang menunjukkan kapan opsi ini terakhir diperbarui.
Tipe: Integer
Wajib: Tidak
# ScalingParameters
## Deskripsi
Jenis instance yang diinginkan dan jumlah replika yang diinginkan dari setiap partisi indeks.
## Daftar Isi
**DesiredInstanceType**
Jenis instans yang ingin Anda konfigurasikan untuk domain Anda. Misalnya, `search.medium`.
Tipe: String
Nilai yang Valid: `search.small | search.medium | search.large | search.xlarge | search.2xlarge`
Untuk domain yang lebih lama, nilai yang valid mungkin juga mencakup`search.m1.small`,`search.m1.large`,`search.m2.xlarge`,`search.m2.2xlarge`,`search.m3.medium`,, `search.m3.large``search.m3.xlarge`, dan`search.m3.2xlarge`.
Wajib: Tidak
**DesiredPartitionCount**
Jumlah partisi yang ingin Anda konfigurasi untuk domain Anda. Hanya berlaku ketika Anda memilih `search.2xlarge` sebagai jenis instance.
Tipe: Integer
Wajib: Tidak
**DesiredReplicationCount**
Jumlah replika yang ingin Anda konfigurasi untuk setiap partisi indeks.
Tipe: Integer
Wajib: Tidak
# ScalingParametersStatus
## Deskripsi
Status dan konfigurasi parameter penskalaan domain pencarian.
## Daftar Isi
**Pilihan**
Jenis instance yang diinginkan dan jumlah replika yang diinginkan dari setiap partisi indeks.
Tipe: [ScalingParameters](API_ScalingParameters.md)
Wajib: Ya
**Status**
Status opsi konfigurasi domain.
Tipe: [OptionStatus](API_OptionStatus.md)
Wajib: Ya
# ServiceEndpoint
## Deskripsi
Titik akhir di mana permintaan layanan dapat dikirimkan.
## Daftar Isi
**Titik akhir**
Titik akhir di mana permintaan layanan dapat dikirimkan. Misalnya, `search-imdb-movies-oopcnjfn6ugofer3zx5iadxxca.eu-west-1.cloudsearch.amazonaws.com` atau `doc-imdb-movies-oopcnjfn6ugofer3zx5iadxxca.eu-west-1.cloudsearch.amazonaws.com`.
Tipe: String
Wajib: Tidak
# Suggester
## Deskripsi
Informasi konfigurasi untuk penelusuran penelusuran. Setiap sugester memiliki nama unik dan menentukan bidang teks yang ingin Anda gunakan untuk saran. Opsi berikut dapat dikonfigurasi untuk sugester:`FuzzyMatching`,`SortExpression`.
## Daftar Isi
**DocumentSuggesterOptions**
Opsi untuk penelusuran penelusuran.
Tipe: [DocumentSuggesterOptions](API_DocumentSuggesterOptions.md)
Wajib: Ya
**SuggesterName**
Nama harus dimulai dengan huruf dan dapat berisi karakter berikut: a-z (huruf kecil), 0-9, dan \$1 (garis bawah).
Tipe: String
Panjang batasan: Panjang minimum 1. Panjang maksimum adalah 64.
Wajib: Ya
# SuggesterStatus
## Deskripsi
Nilai a `Suggester` dan statusnya saat ini.
## Daftar Isi
**Pilihan**
Informasi konfigurasi untuk penelusuran penelusuran. Setiap sugester memiliki nama unik dan menentukan bidang teks yang ingin Anda gunakan untuk saran. Opsi berikut dapat dikonfigurasi untuk sugester:`FuzzyMatching`,`SortExpression`.
Tipe: [Suggester](API_Suggester.md)
Wajib: Ya
**Status**
Status opsi konfigurasi domain.
Tipe: [OptionStatus](API_OptionStatus.md)
Wajib: Ya
# TextArrayOptions
## Deskripsi
Pilihan untuk bidang yang berisi array string teks. Hadir jika `IndexFieldType` menentukan bidang adalah tipe`text-array`. `text-array`Bidang selalu dapat dicari. Semua opsi diaktifkan secara default.
## Daftar Isi
**AnalysisScheme**
Nama skema analisis untuk suatu `text-array` bidang.
Tipe: String
Wajib: Tidak
**DefaultValue**
Nilai yang akan digunakan untuk bidang jika bidang tidak ditentukan untuk dokumen.
Tipe: String
Kendala panjang: Panjang minimum 0. Panjang maksimum 1024.
Wajib: Tidak
**HighlightEnabled**
Apakah sorotan dapat dikembalikan untuk lapangan.
Tipe: Boolean
Wajib: Tidak
**ReturnEnabled**
Apakah isi bidang dapat dikembalikan dalam hasil pencarian.
Tipe: Boolean
Wajib: Tidak
**SourceFields**
Daftar bidang sumber untuk dipetakan ke bidang.
Tipe: String
Wajib: Tidak
# TextOptions
## Deskripsi
Opsi untuk bidang teks. Hadir jika `IndexFieldType` menentukan bidang adalah tipe`text`. `text`Bidang selalu dapat dicari. Semua opsi diaktifkan secara default.
## Daftar Isi
**AnalysisScheme**
Nama skema analisis untuk suatu `text` bidang.
Tipe: String
Wajib: Tidak
**DefaultValue**
Nilai yang akan digunakan untuk bidang jika bidang tidak ditentukan untuk dokumen.
Tipe: String
Kendala panjang: Panjang minimum 0. Panjang maksimum 1024.
Wajib: Tidak
**HighlightEnabled**
Apakah sorotan dapat dikembalikan untuk bidang tersebut.
Tipe: Boolean
Wajib: Tidak
**ReturnEnabled**
Apakah isi bidang dapat dikembalikan dalam hasil pencarian.
Tipe: Boolean
Wajib: Tidak
**SortEnabled**
Apakah bidang dapat digunakan untuk mengurutkan hasil pencarian.
Tipe: Boolean
Wajib: Tidak
**SourceField**
String yang mewakili nama bidang indeks. CloudSearch mendukung bidang indeks reguler serta bidang dinamis. Nama bidang dinamis mendefinisikan pola yang dimulai atau diakhiri dengan wildcard. Bidang dokumen apa pun yang tidak dipetakan ke bidang indeks biasa tetapi cocok dengan pola bidang dinamis dikonfigurasi dengan opsi pengindeksan bidang dinamis.
Nama bidang reguler dimulai dengan huruf dan dapat berisi karakter berikut: a-z (huruf kecil), 0-9, dan \$1 (garis bawah). Nama bidang dinamis harus dimulai atau diakhiri dengan wildcard (\$1). Wildcard juga bisa menjadi satu-satunya karakter dalam nama bidang dinamis. Beberapa wildcard, dan wildcard yang disematkan dalam string tidak didukung.
Nama `score` dicadangkan dan tidak dapat digunakan sebagai nama bidang. Untuk mereferensikan ID dokumen, Anda dapat menggunakan nama tersebut`_id`.
Tipe: String
Panjang batasan: Panjang minimum 1. Panjang maksimum adalah 64.
Wajib: Tidak
# UpdateAvailabilityOptionsResult
## Deskripsi
Hasil dari `UpdateAvailabilityOptions` permintaan. Berisi status opsi ketersediaan domain.
## Daftar Isi
**AvailabilityOptions**
Opsi ketersediaan yang baru dikonfigurasi. Menunjukkan apakah Multi-AZ diaktifkan untuk domain.
Tipe: [AvailabilityOptionsStatus](API_AvailabilityOptionsStatus.md)
Wajib: Tidak
# UpdateScalingParametersResult
## Deskripsi
Hasil `UpdateScalingParameters` permintaan. Berisi status parameter penskalaan yang baru dikonfigurasi.
## Daftar Isi
**ScalingParameters**
Status dan konfigurasi parameter penskalaan domain pencarian.
Tipe: [ScalingParametersStatus](API_ScalingParametersStatus.md)
Wajib: Ya
# UpdateServiceAccessPoliciesResult
## Deskripsi
Hasil dari `UpdateServiceAccessPolicies` permintaan. Berisi kebijakan akses baru.
## Daftar Isi
**AccessPolicies**
Aturan akses yang dikonfigurasi untuk domain.
Tipe: [AccessPoliciesStatus](API_AccessPoliciesStatus.md)
Wajib: Ya
# Parameter Umum
Bagian ini mencantumkan parameter permintaan yang digunakan semua tindakan. Parameter spesifik tindakan apa pun tercantum dalam topik untuk tindakan tersebut.
**Tindakan**
Tindakan yang harus dilakukan.
Default: Tidak Ada
Jenis: string
Diperlukan: Ya
**AuthParams**
Parameter yang diperlukan untuk mengautentikasi permintaan Bersyarat. Berisi:
+ AWSAccessKeyID
+ SignatureVersion
+ Stempel waktu
+ Tanda tangan
Default: Tidak Ada
Diperlukan: Kondisional
**AWSAccessKeyId**
ID kunci akses yang sesuai dengan kunci akses rahasia yang Anda gunakan untuk menandatangani permintaan.
Default: Tidak Ada
Jenis: string
Diperlukan: Ya
**Kedaluwarsa**
Tanggal dan waktu ketika tanda tangan permintaan kedaluwarsa, dinyatakan dalam format YYYY-MM-:MM: DDThh SSZ, sebagaimana ditentukan dalam standar ISO 8601.
Kondisi: Permintaan harus menyertakan *Timestamp* atau *Kedaluwarsa*, tetapi tidak keduanya.
Default: Tidak Ada
Jenis: string
Wajib: Bersyarat
**SecurityToken**
Token keamanan sementara yang diperoleh melalui panggilan ke AWS Security Token Service. Untuk daftar layanan yang mendukung AWS Security Token Service, buka Using [Temporary Security Credentials to Access AWS](https://docs.aws.amazon.com/IAM/latest/UsingSTS/UsingTokens.html) in **Using Temporary Security** Credentials.
Default: Tidak Ada
Jenis: string
Wajib: Tidak
**Tanda tangan**
Tanda tangan digital yang Anda buat untuk permintaan tersebut. Untuk informasi tentang membuat tanda tangan, buka dokumentasi pengembang layanan.
Default: Tidak Ada
Jenis: string
Diperlukan: Ya
**SignatureMethod**
Algoritme hash yang Anda gunakan untuk membuat tanda tangan permintaan.
Default: Tidak Ada
Jenis: string
Nilai yang Valid: `HmacSHA256 | HmacSHA1`
Wajib: Ya
**SignatureVersion**
Versi tanda tangan yang Anda gunakan untuk menandatangani permintaan. Tetapkan ini ke nilai yang direkomendasikan untuk layanan Anda.
Default: Tidak Ada
Jenis: string
Diperlukan: Ya
**Stempel waktu**
Tanggal dan waktu ketika permintaan ditandatangani, dinyatakan dalam format YYYY-MM-:MM: DDThh SSZ, sebagaimana ditentukan dalam standar ISO 8601.
Kondisi: Permintaan harus menyertakan *Timestamp* atau *Kedaluwarsa*, tetapi tidak keduanya.
Default: Tidak Ada
Jenis: string
Wajib: Bersyarat
**Versi**
Versi API yang ditulis dalam permintaan, dinyatakan dalam format HH-BB-TTTT.
Default: Tidak Ada
Jenis: string
Diperlukan: Ya
# Kesalahan Umum
Bagian ini mencantumkan kesalahan umum yang dikembalikan semua tindakan. Setiap kesalahan khusus tindakan tercantum dalam topik untuk tindakan tersebut.
**IncompleteSignature**
Tanda tangan yang diminta tidak sesuai dengan standar AWS.
Kode Status HTTP: 400
**InternalFailure**
Pemrosesan permintaan telah gagal karena kesalahan yang tidak diketahui, pengecualian atau kegagalan.
Kode Status HTTP: 500
**InvalidAction**
Tindakan atau operasi yang diminta tidak valid. Verifikasi bahwa tindakan diketik dengan benar.
Kode Status HTTP: 400
**InvalidClientTokenId**
Sertifikat X.509 atau access key ID AWS yang disediakan tidak ada dalam catatan kami.
Kode Status HTTP: 403
**InvalidParameterCombination**
Parameter yang tidak boleh digunakan secara bersamaan digunakan secara bersamaan.
Kode Status HTTP: 400
**InvalidParameterValue**
out-of-rangeNilai atau tidak valid diberikan untuk parameter input.
Kode Status HTTP: 400
**InvalidQueryParameter**
String kueri AWS salah bentuk atau tidak mematuhi standar AWS.
Kode Status HTTP: 400
**MalformedQueryString**
String kueri berisi kesalahan sintaks.
Kode Status HTTP: 404
**MissingAction**
Permintaan tidak memiliki tindakan atau parameter yang diperlukan.
Kode Status HTTP: 400
**MissingAuthenticationToken**
Permintaan harus berisi access key ID AWS yang valid (terdaftar) atau sertifikat X.509.
Kode Status HTTP: 403
**MissingParameter**
Parameter yang diperlukan untuk tindakan tertentu tidak disediakan.
Kode Status HTTP: 400
**OptInRequired**
Access key ID AWS membutuhkan langganan untuk layanan ini.
Kode Status HTTP: 403
**RequestExpired**
Permintaan mencapai layanan lebih dari 15 menit setelah cap tanggal pada permintaan atau lebih dari 15 menit setelah tanggal kedaluwarsa permintaan (seperti untuk pra-ditandatangani URLs), atau cap tanggal pada permintaan lebih dari 15 menit di masa depan.
Kode Status HTTP: 400
**ServiceUnavailable**
Permintaan telah gagal karena kegagalan sementara server.
Kode Status HTTP: 503
**Pelambatan**
Permintaan ditolak karena throttling permintaan.
Kode Status HTTP: 400
**ValidationError**
Input gagal memenuhi batasan yang ditentukan oleh layanan AWS.
Kode Status HTTP: 400
# Referensi API Layanan Dokumen untuk Amazon CloudSearch
Anda menggunakan API layanan dokumen untuk menambah, mengganti, atau menghapus dokumen di CloudSearch domain Amazon Anda. Untuk informasi selengkapnya mengelola dokumen di domain penelusuran Anda, lihat[Mengunggah Data ke Domain Amazon CloudSearch](uploading-data.md).
Yang lain yang APIs Anda gunakan untuk berinteraksi dengan Amazon CloudSearch adalah:
+ [Referensi API Konfigurasi untuk Amazon CloudSearch](configuration-api.md)—Siapkan dan kelola domain pencarian Anda.
+ [Cari Referensi API](search-api.md)—Cari domain Anda.
# dokumen/batch
Bagian ini menjelaskan permintaan HTTP dan pesan respons untuk `documents/batch` sumber daya.
Anda membuat kumpulan dokumen untuk mendeskripsikan data yang ingin Anda unggah ke CloudSearch domain Amazon. Kumpulan dokumen adalah kumpulan operasi tambah dan hapus yang mewakili dokumen yang ingin Anda tambahkan, perbarui, atau hapus dari domain Anda. Batch dapat dijelaskan dalam JSON atau XHTML. Batch menyediakan semua informasi yang CloudSearch dibutuhkan Amazon untuk pengindeksan. Setiap item yang ingin Anda kembalikan sebagai hasil penelusuran (seperti produk) direpresentasikan sebagai dokumen—kumpulan hanyalah kumpulan permintaan tambah dan hapus untuk dokumen individual. Setiap dokumen memiliki ID unik dan satu atau beberapa bidang yang berisi data yang ingin Anda cari dan kembalikan hasilnya.
Untuk memperbarui dokumen, Anda menentukan permintaan tambah dengan ID dokumen dokumen yang ingin Anda perbarui. Untuk informasi selengkapnya, lihat [Menambahkan dan Memperbarui Dokumen di Amazon CloudSearch](preparing-data.md#adding-documents). Demikian pula, untuk menghapus dokumen, Anda mengirimkan permintaan hapus dengan ID dokumen dari dokumen yang ingin Anda hapus. Untuk informasi tentang menghapus dokumen, lihat[Menghapus Dokumen di Amazon CloudSearch](preparing-data.md#deleting-documents).
Untuk informasi selengkapnya tentang mengirimkan data untuk pengindeksan, lihat. [Mengunggah Data ke Domain Amazon CloudSearch](uploading-data.md)
## dokumen/batch JSON API
### Permintaan JSON documents/batch
Badan `documents/batch` permintaan menggunakan JSON atau XMLuntuk menentukan operasi dokumen yang ingin Anda lakukan. Representasi JSON dari batch adalah kumpulan objek yang mendefinisikan operasi tambah dan hapus individu. `type`Properti mengidentifikasi apakah objek mewakili operasi tambah atau hapus. Misalnya, batch JSON berikut menambahkan satu dokumen dan menghapus satu dokumen:
```
[
{ "type": "add",
"id": "tt0484562",
"fields": {
"title": "The Seeker: The Dark Is Rising",
"directors": ["Cunningham, David L."],
"genres": ["Adventure","Drama","Fantasy","Thriller"],
"actors": ["McShane, Ian","Eccleston, Christopher","Conroy, Frances",
"Crewson, Wendy","Ludwig, Alexander","Cosmo, James",
"Warner, Amelia","Hickey, John Benjamin","Piddock, Jim",
"Lockhart, Emma"]
}
},
{ "type": "delete",
"id": "tt0484575"
}]
```
**catatan**
Saat menentukan kumpulan dokumen di JSON, nilai untuk bidang tidak bisa. `null`
Representasi [skema JSON](http://json-schema.org/) dari batch ditunjukkan di bawah ini:
```
{
"type": "array",
"minItems": 1,
"items": {
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": ["add", "delete"],
"required": true
},
"id": {
"type": "string",
"pattern": "[a-z0-9][a-z0-9_]{0,127}",
"minLength": 1,
"maxLength": 128,
"required": true
},
"fields": {
"type": "object",
"patternProperties": {
"[a-zA-Z0-9][a-zA-Z0-9_]{0,63}": {
"type": "string",
}
}
}
}
}
}
```
#### dokumen/Properti Permintaan batch (JSON)
****
| Properti | Deskripsi | Diperlukan |
| --- | --- | --- |
| jenis | Jenis operasi, add ataudelete. | Ya |
| id | String alfanumerik. Karakter yang diizinkan adalah: A-Z (huruf besar), -a-z (huruf kecil), 0-9, \$1 (garis bawah), - (tanda hubung),/(garis miring), \$1 (tanda hash),: (titik dua). Panjang maksimal adalah 128 karakter. | Ya |
| ladang | Kumpulan satu atau lebih properti field\$1name yang menentukan bidang yang berisi dokumen. Kondisi: Diperlukan untuk menambah operasi. Harus berisi setidaknya satu properti *field\$1name*. | Bersyarat |
| field\$1name | Menentukan bidang dalam dokumen yang ditambahkan. Nama bidang harus dimulai dengan huruf dan dapat berisi karakter berikut: a-z (huruf kecil), 0-9, dan \$1 (garis bawah). Nama bidang harus minimal 3 dan tidak lebih dari 64 karakter. Skor nama dicadangkan dan tidak dapat digunakan sebagai nama bidang. Untuk menentukan beberapa nilai untuk bidang, Anda menentukan larik nilai, bukan nilai tunggal. Contoh: `"genre": ["Adventure","Drama","Fantasy","Thriller"]` Kondisi: Setidaknya satu bidang harus ditentukan dalam objek bidang. | Bersyarat |
### dokumen/Batch Response (JSON)
Badan respons mencantumkan jumlah penambahan dan penghapusan yang dilakukan dan kesalahan atau peringatan apa pun yang dihasilkan.
Representasi skema JSON dari respons API layanan dokumen ditunjukkan di bawah ini:
```
{
"type": "object",
"properties": {
"status": {
"type": "text",
"enum": ["success", "error"],
"required": true
},
"adds": {
"type": "integer",
"minimum": 0,
"required": true
},
"deletes": {
"type": "integer",
"minimum": 0,
"required": true
},
"errors": {
"type": "array",
"required": false,
"items": {
"type": "object",
"properties": {
"message": {
"type": "string",
"required": true
}
}
}
},
"warnings": {
"type": "array",
"required": false,
"items": {
"type": "object",
"properties": {
"message": {
"type": "string",
"required": true
}
}
}
}
}
}
```
#### dokumen/properti respons batch (JSON)
****
| Properti | Deskripsi |
| --- | --- |
| status | Status hasil, yaitu salah satu success atauerror. |
| menambahkan | Jumlah operasi tambah dokumen yang dilakukan. Selalu nol saat statusnyaerror. |
| menghapus | Jumlah operasi hapus dokumen yang dilakukan. Selalu nol saat statusnyaerror. Untuk informasi tentang menghapus dokumen secara permanen, lihat[Menghapus Dokumen di Amazon CloudSearch](preparing-data.md#deleting-documents). |
| kesalahan | Memberikan informasi tentang kesalahan parsing atau validasi. Ditentukan hanya jika statusnyaerror. |
| memperingati | Memberikan informasi tentang peringatan yang dihasilkan selama penguraian atau validasi. |
# dokumen/batch XMLAPI
## Permintaan XHTML documents/batch
Badan `documents/batch` permintaan menentukan operasi dokumen yang ingin Anda lakukan dalam XHTML. Contoh:
```
The Seeker: The Dark Is Rising
Cunningham, David L.
Adventure
Drama
Fantasy
Thriller
McShane, Ian
Eccleston, Christopher
Conroy, Frances
Ludwig, Alexander
Crewson, Wendy
Warner, Amelia
Cosmo, James
Hickey, John Benjamin
Piddock, Jim
Lockhart, Emma
```
### dokumen/batch Permintaan Elemen (XHTML)
****
| Elemen | Deskripsi | Diperlukan |
| --- | --- | --- |
| batch | Kumpulan operasi tambah atau hapus yang ingin Anda kirimkan ke domain pencarian Anda. Batch harus berisi setidaknya satu elemen tambah atau hapus. | Ya |
| tambahkan | Menentukan dokumen yang ingin Anda tambahkan ke domain pencarian Anda. Atribut id diperlukan dan elemen add harus berisi setidaknya satu bidang. Atribut: [\[See the AWS documentation website for more details\]](http://docs.aws.amazon.com/id_id/cloudsearch/latest/developerguide/documents-batch-xml.html) | Tidak |
| bidang | Menentukan bidang dalam dokumen yang ditambahkan. Atribut nama dan nilai bidang diperlukan. Nama bidang harus dimulai dengan huruf dan dapat berisi karakter berikut: a-z (huruf kecil), 0-9, dan \$1 (garis bawah). Skor nama dicadangkan dan tidak dapat digunakan sebagai nama bidang. Nilai bidang dapat berupa teks atau CDATA. Untuk menentukan beberapa nilai untuk bidang, Anda menyertakan beberapa elemen bidang dengan nama yang sama. Contoh: Adventure
Drama
Fantasy
Thriller
Batas: [\[See the AWS documentation website for more details\]](http://docs.aws.amazon.com/id_id/cloudsearch/latest/developerguide/documents-batch-xml.html) Kondisi: Setidaknya satu bidang harus ditentukan dalam elemen add. | Bersyarat |
| hapus | Menentukan dokumen yang ingin Anda hapus dari domain pencarian Anda. Atribut id diperlukan. Elemen hapus harus kosong. Untuk informasi tentang menghapus dokumen secara permanen, lihat[Menghapus Dokumen di Amazon CloudSearch](preparing-data.md#deleting-documents).Batas: [\[See the AWS documentation website for more details\]](http://docs.aws.amazon.com/id_id/cloudsearch/latest/developerguide/documents-batch-xml.html) | Tidak |
## dokumen/Batch Response (XHTML)
Badan respons mencantumkan jumlah penambahan dan penghapusan yang dilakukan dan kesalahan atau peringatan apa pun yang dihasilkan.
Skema RelaxNG dari respons API layanan dokumen adalah:
```
start = response
response = element response {
attribute status { "success" | "error" },
attribute adds { xsd:integer },
attribute deletes { xsd:integer },
element errors {
element error {
text
}+
}? &
element warnings {
element warning {
text
}+
}?
}
```
### dokumen/batch Response Elements (XHTML)
****
| Elemen | Deskripsi |
| --- | --- |
| result | Berisi elemen yang mencantumkan kesalahan dan peringatan yang dihasilkan saat mengurai dan memvalidasi permintaan. Atribut: [\[See the AWS documentation website for more details\]](http://docs.aws.amazon.com/id_id/cloudsearch/latest/developerguide/documents-batch-xml.html) Kendala: Jika statusnya`error`, elemen hasil berisi daftar kesalahan. Jika statusnya`success`, elemen hasil dapat berisi daftar peringatan, tetapi tidak ada kesalahan. |
| kesalahan | Berisi kumpulan elemen kesalahan yang mengidentifikasi kesalahan yang terjadi saat mengurai dan memvalidasi permintaan. |
| kesalahan | Memberikan informasi tentang kesalahan parsing atau validasi. Nilai memberikan deskripsi kesalahan. |
| peringatan | Berisi kumpulan elemen peringatan yang mengidentifikasi peringatan yang dihasilkan saat mengurai dan memvalidasi permintaan. |
| memperingati | Memberikan informasi tentang peringatan parsing atau validasi. Nilai memberikan deskripsi kesalahan. |
## dokumen/kode status batch
Permintaan layanan dokumen dapat mengembalikan tiga jenis kode status:
+ Kode status 5xx menunjukkan bahwa ada kesalahan server internal. Kami merekomendasikan untuk menangkap dan mencoba kembali semua kode kesalahan 5xx karena biasanya mewakili kondisi kesalahan sementara.
+ Kode status 4xx menunjukkan bahwa permintaan itu salah bentuk.
+ Kode status 2xx menunjukkan bahwa permintaan berhasil diproses.
****
| Kesalahan | Deskripsi | Kode Status HTTP |
| --- | --- | --- |
| Tidak Ada Tipe Konten | Header Content-Type tidak ada. | 400 |
| Tidak Ada Konten-Panjang | Header Content-Length tidak ada. | 411 |
| Jalan yang salah | Jalur URL tidak cocok dengan “/YYYY-MM-”. DD/documents/batch | 404 |
| Metode HTTP Tidak Valid | Metode HTTP bukan POST. Permintaan harus diposting ke dokumen/batch. | 405 |
| Jenis Terima Tidak Valid | Terima header menentukan jenis konten selain "application/xml'' or ''application/json”. Tanggapan dapat dikirim hanya sebagai XML/JSON. | 406 |
| Permintaan Terlalu Besar | Panjang badan permintaan lebih besar dari nilai maksimum yang diizinkan. | 413 |
| Jenis Konten Tidak Valid | Jenis konten adalah sesuatu selain "application/json" or "application/xml”. | 415 |
| Set Karakter Tidak Valid | Set karakter adalah sesuatu selain “ASCII”, “ISO-8859-1", atau “UTF-8". | 415 |
## Header Permintaan Umum
****
| Nama | Deskripsi | Diperlukan |
| --- | --- | --- |
| Content-Type | Tipe MIME standar yang menjelaskan format data objek. Untuk informasi lebih lanjut, lihat [W3C RFC 2616](http://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html#sec14.17) Bagian 14. Default: application/json Kendala: atau hanya application/json application/xml | Diperlukan |
| Content-Length | Panjang dalam byte dari badan permintaan. | Ya |
| Menerima | Tipe MIME standar yang menjelaskan format data respons. Untuk informasi lebih lanjut, lihat [W3C RFC 2616](http://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html#sec14.17) Bagian 14. Default: tipe konten permintaan Kendala: atau hanya application/json application/xml | Tidak |
## Header Respons Umum
****
| Nama | Deskripsi |
| --- | --- |
| Content-Type | Tipe MIME standar yang menjelaskan format data objek. Untuk informasi lebih lanjut, lihat [W3C RFC 2616](http://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html#sec14.17) Bagian 14. Default: nilai header Terima dalam permintaan, atau Content-Type permintaan jika header Terima hilang atau tidak menentukan salah satu application/xml atau application/json. Kendala: atau hanya application/xml application/json |
| Content-Length | Panjang byte tubuh dalam respons. |
# Cari Referensi API untuk Amazon CloudSearch
**Topics**
+ [
## Pencarian
](#search-request)
+ [
## Mengirimkan Permintaan Saran di Amazon CloudSearch
](#submitting-suggest-requests)
+ [
## Sarankan
](#suggest)
+ [
## Kesalahan Layanan Pencarian
](#search-service-errors)
Anda menggunakan API Penelusuran untuk mengirimkan permintaan pencarian atau saran ke CloudSearch domain Amazon Anda. Untuk informasi selengkapnya tentang penelusuran, lihat[Mencari Data Anda dengan Amazon CloudSearch](searching.md). Untuk informasi lebih lanjut tentang saran, lihat[Mendapatkan Saran Pelengkapan Otomatis di Amazon CloudSearch](getting-suggestions.md).
Yang lain yang APIs Anda gunakan untuk berinteraksi dengan Amazon CloudSearch adalah:
+ [API Konfigurasi](configuration-api.md) —Siapkan dan kelola domain penelusuran Anda.
+ [Document Service API](document-service-api.md) —Kirim data yang ingin Anda cari.
## Pencarian
Bagian ini menjelaskan permintaan HTTP dan pesan respons untuk sumber pencarian.
### Sintaks Pencarian
```
GET /2013-01-01/search
```
### Header Permintaan Pencarian
HOST
Titik akhir permintaan pencarian untuk domain yang Anda kueri. Anda dapat menggunakan [DescribeDomains](API_DescribeDomains.md) untuk mengambil titik akhir permintaan pencarian domain Anda.
Wajib: Ya
### Parameter Permintaan Pencarian
cursor
Mengambil nilai kursor yang dapat Anda gunakan untuk halaman melalui set hasil besar. Gunakan `size` parameter untuk mengontrol jumlah klik yang ingin Anda sertakan dalam setiap respons. Anda dapat menentukan `start` parameter `cursor` atau dalam permintaan, keduanya saling eksklusif. Untuk informasi selengkapnya, lihat [Hasil Paginating](paginating-results.md).
Untuk mendapatkan kursor pertama, tentukan `cursor=initial` dalam permintaan awal Anda. Dalam permintaan berikutnya, tentukan nilai kursor yang dikembalikan di bagian hits respons.
Misalnya, permintaan berikut menetapkan nilai kursor ke `initial` dan `size` parameter ke 100 untuk mendapatkan set hit pertama. Kursor untuk set hit berikutnya disertakan dalam respons.
```
search?q=john&cursor=initial&size=100&return=_no_fields
{
"status": {
"rid": "+/Xu5s0oHwojC6o=",
"time-ms": 15
},
"hits": {
"found": 503,
"start": 0,
"cursor": "VegKzpYYQW9JSVFFRU1UeWwwZERBd09EUTNPRGM9ZA",
"hit": [
{"id": "tt0120601"},
{"id": "tt1801552"},
...
]
}
}
```
Untuk mendapatkan set hit berikutnya, Anda menentukan nilai kursor dan jumlah klik yang akan diambil.
```
search?q=john&cursor=VegKzpYYQW9JSVFFRU1UeWwwZERBd09EUTNPRGM9ZA&size=100
```
Tipe: String
Wajib: Tidak
expr.NAME
Mendefinisikan ekspresi yang dapat digunakan untuk mengurutkan hasil. Anda juga dapat menentukan ekspresi sebagai bidang kembali. Untuk informasi selengkapnya tentang mendefinisikan dan menggunakan ekspresi, lihat[Mengkonfigurasi Ekspresi](configuring-expressions.md).
Anda dapat menentukan dan menggunakan beberapa ekspresi dalam permintaan pencarian. Misalnya, permintaan berikut membuat dua ekspresi yang digunakan untuk mengurutkan hasil dan menyertakannya dalam hasil pencarian:
```
search?q=(and (term field=genres 'Sci-Fi')(term field=genres 'Comedy'))&q.parser=structured
&expr.expression1=_score*rating
&expr.expression2=(1/rank)*year
&sort=expression1 desc,expression2 desc
&return=title,rating,rank,year,_score,expression1,expression2
```
Tipe: String
Wajib: Tidak
facet.FIELD
Menentukan bidang yang Anda ingin mendapatkan informasi facet untuk- `FIELD` adalah nama bidang. Bidang yang ditentukan harus facet diaktifkan dalam konfigurasi domain. Opsi facet ditentukan sebagai objek JSON. Jika objek JSON kosong,`facet.FIELD={}`, jumlah faset dihitung untuk semua nilai bidang, faset diurutkan berdasarkan jumlah faset, dan 10 aspek teratas dikembalikan dalam hasil.
Anda dapat menentukan tiga opsi di objek JSON:
+ `sort`menentukan bagaimana Anda ingin mengurutkan aspek dalam hasil: `bucket` atau. `count` Tentukan `bucket` untuk mengurutkan menurut abjad atau numerik berdasarkan nilai faset (dalam urutan menaik). Tentukan `count` untuk mengurutkan berdasarkan jumlah faset yang dihitung untuk setiap nilai faset (dalam urutan menurun). Untuk mengambil jumlah faset untuk nilai atau rentang nilai tertentu, gunakan `buckets` opsi alih-alih. `sort`
+ `buckets`menentukan array nilai faset atau rentang yang ingin Anda hitung. Ember dikembalikan sesuai urutan yang ditentukan dalam permintaan. Untuk menentukan rentang nilai, gunakan koma (,) untuk memisahkan batas atas dan bawah dan lampirkan rentang menggunakan tanda kurung atau tanda kurung. Braket persegi, [atau], menunjukkan bahwa ikatan termasuk dalam rentang, penjepit keriting, \$1atau\$1, tidak termasuk batas. Anda dapat menghilangkan batas atas atau bawah untuk menentukan rentang terbuka. Saat menghilangkan ikatan, Anda harus menggunakan penjepit keriting. `size`Opsi `sort` dan tidak valid jika Anda menentukan`buckets`.
+ `size`menentukan jumlah maksimum aspek untuk dimasukkan dalam hasil. Secara default, Amazon CloudSearch mengembalikan jumlah untuk 10 besar. `size`Parameter hanya valid ketika Anda menentukan `sort` opsi; itu tidak dapat digunakan bersama dengan`buckets`.
Misalnya, permintaan berikut mendapatkan jumlah faset untuk `year` bidang, mengurutkan jumlah faset berdasarkan nilai dan mengembalikan jumlah untuk tiga teratas:
```
facet.year={sort:"bucket", size:3}
```
Untuk menentukan nilai atau rentang nilai yang ingin Anda hitung jumlah faset, gunakan opsi. `buckets` Misalnya, permintaan berikut menghitung dan mengembalikan jumlah faset menurut dekade:
```
facet.year={buckets:["[1970,1979]","[1980,1989]",
"[1990,1999]","[2000,2009]",
"[2010,}"]}
```
Anda juga dapat menentukan nilai individual sebagai bucket:
```
facet.genres={buckets:["Action","Adventure","Sci-Fi"]}
```
Perhatikan bahwa nilai faset peka huruf besar—dengan data IMDb film sampel, jika Anda menentukan, `["action","adventure","sci-fi"]` bukan, semua jumlah `["Action","Adventure","Sci-Fi"]` faset adalah nol.
Tipe: String
Wajib: Tidak
format
Menentukan jenis konten respon.
Tipe: String
Nilai yang Valid: json\$1xml\$1
Default: json
Wajib: Tidak
fq
Menentukan query terstruktur yang menyaring hasil pencarian tanpa mempengaruhi bagaimana hasil dinilai dan diurutkan. Anda menggunakan `fq` bersama dengan `q` parameter untuk memfilter dokumen yang cocok dengan batasan yang ditentukan dalam parameter. `q` Menentukan filter hanya mengontrol dokumen pencocokan mana yang disertakan dalam hasil, itu tidak berpengaruh pada bagaimana mereka dinilai dan diurutkan. `fq`Parameter mendukung sintaks kueri terstruktur penuh. Untuk informasi selengkapnya tentang menggunakan filter, lihat[Memfilter Dokumen Pencocokan](filtering-results.md). Untuk informasi selengkapnya tentang kueri terstruktur, lihat[Sintaks Pencarian Terstruktur](#structured-search-syntax).
Tipe: String
Wajib: Tidak
highlight.FIELD
Mengambil sorotan untuk kecocokan di `text-array` bidang `text` atau yang ditentukan. Opsi sorotan ditentukan sebagai objek JSON. Jika objek JSON kosong, teks bidang yang dikembalikan diperlakukan sebagai HTML dan kecocokan pertama disorot dengan tag penekanan:`search-term`.
Anda dapat menentukan empat opsi di objek JSON:
+ `format`—menentukan format data di bidang teks: `text` atau. `html` Ketika data dikembalikan sebagai HTML, semua karakter non-alfanumerik dikodekan. Nilai default-nya `html`.
+ `max_phrases`—menentukan jumlah maksimum kemunculan istilah pencarian yang ingin Anda sorot. Secara default, kejadian pertama disorot.
+ `pre_tag`—menentukan string untuk ditambahkan ke kemunculan istilah pencarian. Default untuk sorotan HTML adalah``. Default untuk sorotan teks adalah`*`.
+ `post_tag`—menentukan string untuk ditambahkan ke kemunculan istilah pencarian. Default untuk sorotan HTML adalah``. Default untuk sorotan teks adalah`*`.
Contoh:`highlight.plot={}`, `highlight.plot={format:'text',max_phrases:2,pre_tag:'',post_tag:''}`
Tipe: String
Wajib: Tidak
partial
Mengontrol apakah hasil sebagian dikembalikan jika satu atau lebih partisi indeks tidak tersedia. Ketika indeks pencarian Anda dipartisi di beberapa instance penelusuran, secara default Amazon CloudSearch hanya mengembalikan hasil jika setiap partisi dapat ditanyakan. Ini berarti bahwa kegagalan satu contoh pencarian dapat mengakibatkan kesalahan 5xx (server internal). Saat Anda menentukan`partial=true`. Amazon CloudSearch mengembalikan hasil apa pun yang tersedia dan menyertakan persentase dokumen yang dicari di hasil pencarian (`percent-searched`). Hal ini memungkinkan Anda untuk lebih anggun menurunkan pengalaman pencarian pengguna Anda. Misalnya, daripada tidak menampilkan hasil, Anda dapat menampilkan sebagian hasil dan pesan yang menunjukkan bahwa hasilnya mungkin tidak lengkap karena pemadaman sistem sementara.
Jenis: Boolean
Default: Salah
Wajib: Tidak
pretty
Format output JSON sehingga lebih mudah dibaca.
Jenis: Boolean
Default: Salah
Wajib: Tidak
q
Kriteria pencarian untuk permintaan tersebut. Cara Anda menentukan kriteria pencarian tergantung pada parser kueri yang digunakan untuk permintaan dan opsi parser yang ditentukan dalam parameter. `q.options` Secara default, parser `simple` kueri digunakan untuk memproses permintaan. Untuk menggunakan`structured`,`lucene`, atau `dismax` query parser, Anda juga harus menentukan `q.parser` parameter. Untuk informasi selengkapnya tentang menentukan kriteria pencarian, lihat[Mencari Data Anda dengan Amazon CloudSearch](searching.md).
Tipe: String
Diperlukan: Ya
q.options
Konfigurasikan opsi untuk parser kueri yang ditentukan dalam `q.parser` parameter. Opsi ditentukan sebagai objek JSON, misalnya:`q.options={defaultOperator: 'or', fields: ['title^5','description']}`.
Opsi yang dapat Anda konfigurasikan bervariasi sesuai dengan parser mana yang Anda gunakan:
+ `defaultOperator`—Operator default digunakan untuk menggabungkan istilah individual dalam string pencarian. Sebagai contoh: `defaultOperator: 'or'`. Untuk `dismax` parser, Anda menentukan persentase yang mewakili persentase istilah dalam string pencarian (dibulatkan ke bawah) yang harus cocok, bukan operator default. Nilai `0%` setara dengan OR, dan nilai `100%` setara dengan AND. Persentase harus ditentukan sebagai nilai dalam kisaran 0-100 diikuti oleh simbol persen (%). Misalnya, `defaultOperator: 50%`. Nilai yang valid:`and`,`or`, persentase dalam kisaran 0%-100% (). `dismax` Default: `and` (`simple``structured`,,`lucene`) atau `100` (`dismax`). Berlaku untuk:`simple`,`structured`,`lucene`, dan`dismax`.
+ `fields`—Sebuah array bidang untuk mencari ketika tidak ada bidang yang ditentukan dalam pencarian. Jika tidak ada bidang yang ditentukan dalam pencarian dan opsi ini tidak ditentukan, semua dikonfigurasi secara statis `text` dan `text-array` bidang dicari. Anda dapat menentukan bobot untuk setiap bidang untuk mengontrol kepentingan relatif setiap bidang saat Amazon CloudSearch menghitung skor relevansi. Untuk menentukan berat bidang, tambahkan simbol tanda sisipan (`^`) dan bobot ke nama bidang. Misalnya, untuk meningkatkan pentingnya bidang di atas `title` bidang, `description` Anda dapat menentukan:`fields: ['title^5','description']`. Nilai yang valid: Nama bidang yang dikonfigurasi dan nilai numerik opsional lebih besar dari nol. Default: Semua dikonfigurasi secara statis `text` dan `text-array` bidang. Bidang dan `literal` bidang dinamis tidak dicari secara default. Berlaku untuk:`simple`,`structured`,`lucene`, dan`dismax`.
+ `operators`—Array operator atau karakter khusus yang ingin Anda nonaktifkan untuk parser kueri sederhana. Jika Anda menonaktifkan`and`,`or`, atau `not` operator, operator yang sesuai (`+`,`|`,`-`) tidak memiliki arti khusus dan dijatuhkan dari string pencarian. Demikian pula, menonaktifkan `prefix` menonaktifkan operator wildcard (`*`) dan `phrase` menonaktifkan kemampuan untuk mencari frasa dengan melampirkan frasa dalam tanda kutip ganda. Menonaktifkan prioritas menonaktifkan kemampuan untuk mengontrol urutan prioritas menggunakan tanda kurung. Menonaktifkan `near` menonaktifkan kemampuan untuk menggunakan operator \$1 untuk melakukan pencarian frase yang ceroboh. Menonaktifkan `fuzzy` operator menonaktifkan kemampuan untuk menggunakan operator \$1 untuk melakukan pencarian fuzzy. `escape`menonaktifkan kemampuan untuk menggunakan garis miring terbalik (`\`) untuk melarikan diri dari karakter khusus dalam string pencarian. Menonaktifkan spasi putih adalah opsi lanjutan yang mencegah parser melakukan tokenisasi pada spasi putih, yang dapat berguna untuk orang Vietnam. (Ini mencegah kata-kata Vietnam dipecah secara tidak benar.) Misalnya, Anda dapat menonaktifkan semua operator selain operator frasa untuk mendukung hanya kueri istilah dan frasa sederhana:`operators:['and', 'not', 'or', 'prefix']`. Nilai yang valid: `and``escape`,`fuzzy`,,`near`,`not`,`or`,`phrase`,`precedence`,`prefix`,`whitespace`. Default: Semua operator dan karakter khusus diaktifkan. Berlaku untuk:`simple`.
+ `phraseFields`—Sebuah array dari `text` atau `text-array` bidang yang ingin Anda gunakan untuk pencarian frase. Ketika istilah dalam string pencarian muncul dalam jarak dekat dalam bidang, skor bidang lebih tinggi. Anda dapat menentukan bobot untuk setiap bidang untuk meningkatkan skor itu. `phraseSlop`Opsi ini mengontrol seberapa banyak kecocokan dapat menyimpang dari string pencarian dan masih ditingkatkan. Untuk menentukan berat bidang, tambahkan simbol tanda sisipan (`^`) dan bobot ke nama bidang. Misalnya, untuk meningkatkan kecocokan frasa di `title` bidang di atas `abstract` bidang, Anda dapat menentukan: Nilai yang `phraseFields:['title^3', 'abstract']` valid: Nama `text-array` bidang `text` atau apa pun dan nilai numerik opsional lebih besar dari nol. Default: Tidak ada bidang. Jika Anda tidak menentukan bidang apa pun`phraseFields`, skor kedekatan dinonaktifkan meskipun `phraseSlop` ditentukan. Berlaku untuk:`dismax`.
+ `phraseSlop`—Nilai integer yang menentukan berapa banyak kecocokan dapat menyimpang dari frase pencarian dan masih ditingkatkan sesuai dengan bobot yang ditentukan dalam opsi. `phraseFields` Misalnya, `phraseSlop: 2`. Anda juga harus menentukan `phraseFields` untuk mengaktifkan penilaian kedekatan. Nilai valid: bilangan bulat positif. Default: 0. Berlaku untuk:`dismax`.
+ `explicitPhraseSlop`—Nilai integer yang menentukan seberapa banyak kecocokan dapat menyimpang dari frase pencarian ketika frasa diapit tanda kutip ganda dalam string pencarian. (Frasa yang melebihi jarak kedekatan ini tidak dianggap cocok.) `explicitPhraseSlop: 5`. Nilai valid: bilangan bulat positif. Default: 0. Berlaku untuk:`dismax`.
+ `tieBreaker`—Ketika sebuah istilah dalam string pencarian ditemukan di bidang dokumen, skor dihitung untuk bidang tersebut berdasarkan seberapa umum kata tersebut di bidang itu dibandingkan dengan dokumen lain. Jika istilah muncul di beberapa bidang dalam dokumen, secara default hanya bidang penilaian tertinggi yang berkontribusi pada skor keseluruhan dokumen. Anda dapat menentukan `tieBreaker` nilai untuk mengaktifkan kecocokan di bidang dengan skor lebih rendah untuk berkontribusi pada skor dokumen. Dengan begitu, jika dua dokumen memiliki skor bidang maks yang sama untuk istilah tertentu, skor untuk dokumen yang memiliki kecocokan di lebih banyak bidang akan lebih tinggi. Rumus untuk menghitung skor dengan TieBreaker adalah:
```
(max field score) + (tieBreaker) * (sum of the scores for the rest of the matching fields)
```
Misalnya, kueri berikut mencari istilah *dog* di `review` bidang`title`,`description`, dan disetel `tieBreaker` ke 0.1:
```
q=dog&q.parser=dismax&q.options={fields:['title', 'description', 'review'], tieBreaker: 0.1}
```
Jika *dog* muncul di ketiga bidang dokumen dan skor untuk setiap bidang adalah title=1, description=3, dan review=1, skor keseluruhan untuk istilah dog adalah:
```
3 + 0.1 * (1+1) = 3.2
```
Setel `tieBreaker` ke 0 untuk mengabaikan semua kecuali bidang skor tertinggi (maks murni). Setel ke 1 untuk menjumlahkan skor dari semua bidang (jumlah murni). Nilai yang valid: 0,0 hingga 1,0. Default: 0.0. Berlaku untuk:`dismax`.
Jenis: objek JSON
Default: Lihat deskripsi opsi individual.
Wajib: Tidak
q.parser
Menentukan parser query yang akan digunakan untuk memproses permintaan:`simple`,, `structured``lucene`, dan. `dismax` Jika tidak `q.parser` ditentukan, Amazon CloudSearch menggunakan parser `simple` kueri.
+ `simple`—melakukan pencarian sederhana `text` dan `text-array` bidang. Secara default, parser `simple` kueri mencari semua bidang dan dikonfigurasi `text` secara statis. `text-array` Anda dapat menentukan bidang mana yang akan dicari dengan `q.options` parameter. Jika Anda mengawali istilah pencarian dengan tanda tambah (\$1) dokumen harus berisi istilah yang akan dianggap cocok. (Ini adalah default, kecuali jika Anda mengkonfigurasi operator default dengan `q.options` parameter.) Anda dapat menggunakan operator `-` (NOT), `|` (OR), dan `*` (wildcard) untuk mengecualikan istilah tertentu, menemukan hasil yang cocok dengan salah satu istilah yang ditentukan, atau mencari awalan. Untuk mencari frasa daripada istilah individual, lampirkan frasa dalam tanda kutip ganda. Untuk informasi selengkapnya, lihat [Mencari Data Anda dengan Amazon CloudSearch](searching.md).
+ `structured`—melakukan pencarian lanjutan dengan menggabungkan beberapa ekspresi untuk menentukan kriteria pencarian. Anda juga dapat mencari dalam bidang tertentu, mencari nilai dan rentang nilai, dan menggunakan opsi lanjutan seperti peningkatan istilah,`matchall`, dan`near`. Untuk informasi selengkapnya, lihat [Membangun Kueri Senyawa](searching-compound-queries.md).
+ `lucene`—cari menggunakan sintaks parser kueri Apache Lucene. Untuk informasi selengkapnya, lihat [Apache Lucene Query](https://cwiki.apache.org/confluence/display/solr/The+Standard+Query+Parser) Parser Syntax.
+ `dismax`—search menggunakan subset sederhana dari sintaks parser kueri Apache Lucene yang ditentukan oleh parser kueri. DisMax Untuk informasi selengkapnya, lihat [Sintaks Pengurai DisMax Kueri](https://cwiki.apache.org/confluence/display/solr/The+DisMax+Query+Parser).
Tipe: String
Default: `simple`
Wajib: Tidak
return
Nilai bidang dan ekspresi untuk disertakan dalam respons, ditentukan sebagai daftar yang dipisahkan koma. Secara default, respons penelusuran mencakup semua bidang yang diaktifkan kembali (`return=_all_fields`). Untuk mengembalikan hanya dokumen IDs untuk dokumen yang cocok, tentukan`return=_no_fields`. Untuk mengambil skor relevansi yang dihitung untuk setiap dokumen, tentukan. `return=_score` Anda menentukan beberapa bidang kembali sebagai daftar dipisahkan koma. Misalnya, `return=title,_score` mengembalikan hanya judul dan skor relevansi dari setiap dokumen yang cocok.
Tipe: String
Wajib: Tidak
size
Jumlah maksimum klik pencarian untuk kembali.
Tipe: Bilangan bulat positif
Default: 10
Wajib: Tidak
sort
Daftar kolom atau ekspresi kustom yang dipisahkan koma untuk digunakan untuk mengurutkan hasil pencarian. Anda harus menentukan arah pengurutan (`asc`atau`desc`) untuk setiap bidang. Misalnya, `sort=year desc,title asc`. Anda dapat menentukan maksimal 10 bidang dan ekspresi. Untuk menggunakan bidang untuk mengurutkan hasil, itu harus diurutkan diaktifkan dalam konfigurasi domain. Bidang tipe array tidak dapat digunakan untuk menyortir. Jika tidak ada `sort` parameter yang ditentukan, hasil diurutkan berdasarkan skor relevansi defaultnya dalam urutan menurun:. `sort=_score desc` Anda juga dapat mengurutkan berdasarkan dokumen ID (`sort=_id`) dan versi (`sort=_version`).
Tipe: String
Wajib: Tidak
start
Offset dari hit pencarian pertama yang ingin Anda kembalikan. Anda dapat menentukan `cursor` parameter `start` atau dalam permintaan, keduanya saling eksklusif. Untuk informasi selengkapnya, lihat [Hasil Paginating](paginating-results.md).
Tipe: Bilangan bulat positif
Default: 0 (hit pertama)
Wajib: Tidak
#### Sintaks Pencarian Terstruktur
Anda menggunakan sintaks penelusuran CloudSearch terstruktur Amazon untuk menentukan kriteria penelusuran saat menggunakan parser `structured` kueri, dan untuk menentukan kriteria filter dengan parameter. `fq`
Saat menggunakan operator kueri terstruktur, Anda menentukan nama operator, opsi untuk operator, dan kemudian istilah yang dioperasikan,`(OPERATOR OPTIONS STRING|EXPRESSION)`. Opsi apa pun harus ditentukan sebelum string atau ekspresi. Misalnya, `(and (not field=genres 'Sci-Fi')(or (term field=title boost=2 'star')(term field=plot 'star')))`.
**penting**
Anda harus mengkodekan URL karakter khusus dalam string kueri. Misalnya, Anda harus menyandikan `=` operator dalam kueri terstruktur sebagai`%3D`:`(term+field%3Dtitle+'star'`). Amazon CloudSearch mengembalikan `InvalidQueryString` kesalahan jika karakter khusus tidak dikodekan URL. [Untuk referensi lengkap pengkodean URL, lihat Referensi Pengkodean URL HTML W3C.](http://www.w3schools.com/tags/ref_urlencode.asp)
Jika Anda tidak menentukan bidang yang ingin Anda cari saat menggunakan parser kueri terstruktur, semua `text-array` bidang `text` dan dikonfigurasi secara statis akan dicari. Bidang dan `literal` bidang dinamis *tidak* dicari secara default. Anda dapat menentukan bidang mana yang ingin Anda cari secara default dengan `q.options` parameter.
Tanda kurung mengontrol urutan evaluasi ekspresi dalam kueri majemuk. Ketika ekspresi diapit dalam tanda kurung, ekspresi itu dievaluasi terlebih dahulu, dan kemudian nilai yang dihasilkan digunakan dalam evaluasi sisa kueri. Ekspresi dapat berisi salah satu operator kueri terstruktur.
Anda juga dapat menggunakan parser kueri terstruktur untuk mencari string teks sederhana—cukup lampirkan string yang ingin Anda cari dalam tanda kutip tunggal:. `q='black swan'&q.parser="structured"`
Untuk informasi selengkapnya tentang membangun kueri majemuk dengan operator kueri terstruktur, lihat. [Membangun Kueri Senyawa](searching-compound-queries.md)
FIELD
Sintaks: `FIELD: 'STRING'|value`
Mencari bidang tertentu untuk string, nilai numerik, tanggal, atau rentang nilai numerik atau tanggal.
String harus dilampirkan dalam tanda kutip tunggal. Setiap tanda kutip tunggal atau garis miring terbalik dalam string harus lolos dengan garis miring terbalik. Untuk menentukan rentang nilai, gunakan koma (,) untuk memisahkan batas atas dan bawah dan lampirkan rentang menggunakan tanda kurung atau tanda kurung. Braket persegi, [atau], menunjukkan bahwa ikatan termasuk dalam rentang, penjepit keriting, \$1atau\$1, tidak termasuk batas. Anda dapat menghilangkan batas atas atau bawah untuk menentukan rentang terbuka. Saat menghilangkan ikatan, Anda harus menggunakan penjepit keriting.
Tanggal dan waktu ditentukan dalam UTC (Coordinated Universal Time) menurut [ RFC3339IETF](http://tools.ietf.org/html/rfc3339):. `yyyy-mm-ddTHH:mm:ss.SSSZ` Di UTC, misalnya, 17:00 23 Agustus 1970 adalah:. `1970-08-23T17:00:00Z` Perhatikan bahwa Anda juga dapat menentukan detik pecahan saat menentukan waktu di UTC. Sebagai contoh, `1967-01-31T23:20:50.650Z.`.
Contoh:
```
title:'star'
year:2000
year:[1998,2000]
year:{,2011]
release_date:['2013-01-01T00:00:00Z',}
```
and
Sintaks: `(and boost=N EXPRESSION EXPRESSION ... EXPRESSIONn)`
Termasuk dokumen hanya jika cocok dengan semua ekspresi yang ditentukan. (`AND`Operator Boolean.) Ekspresi dapat berisi salah satu operator kueri terstruktur, atau string pencarian sederhana. String pencarian harus dilampirkan dalam tanda kutip tunggal. Perhatikan bahwa untuk mencocokkan dokumen yang berisi istilah tertentu di salah satu bidang yang dicari, Anda menentukan setiap istilah sebagai ekspresi terpisah:`(and 'star' 'wars')`. Jika Anda menentukan`(and 'star wars')`, *bintang* dan *perang* harus terjadi dalam bidang yang sama untuk dianggap cocok.
Nilai boost adalah nilai numerik positif yang meningkatkan pentingnya bagian kueri penelusuran ini relatif terhadap bagian lain.
Contoh:
```
(and title:'star' actors:'Harrison Ford' year:{,2000])
```
matchall
Sintaks: `matchall`
Cocokkan setiap dokumen di domain. Secara default, mengembalikan 10 pertama. Gunakan `start` parameter `size` dan ke halaman melalui hasil.
near
Sintaks: `(near field=FIELD distance=N boost=N 'STRING') `
Mencari `text` atau `text-array` bidang untuk string multi-term yang ditentukan dan mencocokkan dokumen yang berisi istilah dalam jarak yang ditentukan satu sama lain. (Ini kadang-kadang disebut pencarian frase *ceroboh*.) Jika Anda menghilangkan `field` opsi, Amazon CloudSearch mencari semua yang dikonfigurasi secara statis `text` dan `text-array` bidang secara default. Bidang dan `literal` bidang dinamis tidak dicari secara default. Anda dapat menentukan bidang mana yang ingin Anda cari secara default dengan menentukan `q.options` `fields` opsi.
Nilai jarak harus berupa bilangan bulat positif. Misalnya, untuk menemukan semua dokumen di mana *remaja* terjadi dalam 10 kata *vampir* di `plot` lapangan, Anda menentukan nilai jarak 10:. `(near field=plot distance=10 'teenage vampire')`
Nilai boost adalah nilai numerik positif yang meningkatkan pentingnya bagian kueri penelusuran ini relatif terhadap bagian lain.
Contoh:
```
(near field=plot distance=10 'teenage vampire')
```
not
Sintaks: `(not boost=N EXPRESSION)`
Mengecualikan dokumen jika cocok dengan ekspresi yang ditentukan. (`NOT`Operator Boolean.) Ekspresi dapat berisi salah satu operator kueri terstruktur, atau string pencarian sederhana. String pencarian harus dilampirkan dalam tanda kutip tunggal.
Nilai boost adalah nilai numerik positif yang meningkatkan pentingnya bagian kueri penelusuran ini relatif terhadap bagian lain.
Contoh:
```
(not (or actors:'Harrison Ford' year:{,2010]))
```
or
Sintaks: `(or boost=N EXPRESSION1 EXPRESSION2 ... EXPRESSIONn)`
Termasuk dokumen jika cocok dengan salah satu ekspresi yang ditentukan. (`OR`Operator Boolean.) Ekspresi dapat berisi salah satu operator kueri terstruktur, atau string pencarian sederhana. String pencarian harus dilampirkan dalam tanda kutip tunggal.
Nilai boost adalah nilai numerik positif yang meningkatkan pentingnya bagian kueri penelusuran ini relatif terhadap bagian lain.
Contoh:
```
(or actors:'Alec Guinness' actors:'Harrison Ford' actors:'James Earl Jones')
```
phrase
Sintaks: `(phrase field=FIELD boost=N 'STRING')`
Mencari `text` atau `text-array` bidang untuk frasa yang ditentukan. Jika Anda menghilangkan `field` opsi, Amazon CloudSearch mencari semua yang dikonfigurasi secara statis `text` dan `text-array` bidang secara default. Bidang dan `literal` bidang dinamis tidak dicari secara default. Anda dapat menentukan bidang mana yang ingin Anda cari secara default dengan menentukan `q.options` `fields` opsi.
Gunakan `phrase` operator untuk menggabungkan pencarian frase dengan kriteria penelusuran lainnya dalam kueri terstruktur. Misalnya `q=(and (term field=title 'star') (range field=year {,2000]))` cocok dengan semua dokumen yang berisi *bintang* di bidang judul dan memiliki nilai tahun kurang dari atau sama dengan 2000.
Nilai boost adalah nilai numerik positif yang meningkatkan pentingnya bagian kueri penelusuran ini relatif terhadap bagian lain.
Contoh:
```
(phrase field=plot 'teenage girl')
```
prefix
Sintaks: `(prefix field=FIELD boost=N 'STRING')`
Mencari`text`,, `text-array``literal`, atau `literal-array` bidang untuk awalan yang ditentukan diikuti oleh nol atau lebih karakter. Jika Anda menghilangkan `field` opsi, Amazon CloudSearch mencari semua yang dikonfigurasi secara statis `text` dan `text-array` bidang secara default. Bidang dan `literal` bidang dinamis tidak dicari secara default. Anda dapat menentukan bidang mana yang ingin Anda cari secara default dengan menentukan `q.options` `fields` opsi.
Gunakan `prefix` operator untuk menggabungkan penelusuran awalan dengan kriteria penelusuran lainnya dalam kueri terstruktur. Misalnya, `q=(and (prefix field=title 'sta') (range field=year {,2000]))` mencocokkan semua dokumen yang berisi awalan *sta* di bidang judul dan memiliki nilai tahun kurang dari atau sama dengan 2000.
Nilai boost adalah nilai numerik positif yang meningkatkan pentingnya bagian kueri penelusuran ini relatif terhadap bagian lain.
Untuk menerapkan saran penelusuran, Anda harus mengonfigurasi dan meminta sugester, daripada melakukan pencarian awalan. Untuk mengetahui informasi selengkapnya, lihat [Permintaan Saran](#suggest-request).
Contoh:
```
(prefix field=title 'star')
```
range
Sintaks: `(range field=FIELD boost=N RANGE)`
Mencari bidang numerik (double, double-array, int, int-array) atau bidang tanggal (tanggal, tanggal-array) untuk nilai dalam rentang yang ditentukan. Cocokkan dokumen yang memiliki setidaknya satu nilai di bidang dalam rentang yang ditentukan. `field`Opsi harus ditentukan.
Gunakan `range` operator untuk menggabungkan pencarian rentang dengan kriteria penelusuran lainnya dalam kueri terstruktur. Misalnya `q=(and (term field=title 'star') (range field=year {,2000]))` cocok dengan semua dokumen yang berisi *bintang* di bidang judul dan memiliki nilai tahun kurang dari atau sama dengan 2000.
Untuk menentukan rentang nilai, gunakan koma (,) untuk memisahkan batas atas dan bawah dan lampirkan rentang menggunakan tanda kurung atau tanda kurung. Braket persegi, [atau], menunjukkan bahwa ikatan termasuk dalam rentang, penjepit keriting, \$1atau\$1, tidak termasuk batas. Anda dapat menghilangkan batas atas atau bawah untuk menentukan rentang terbuka. Saat menghilangkan ikatan, Anda harus menggunakan penjepit keriting.
Tanggal dan waktu ditentukan dalam UTC (Coordinated Universal Time) menurut [ RFC3339IETF](http://tools.ietf.org/html/rfc3339):. `yyyy-mm-ddTHH:mm:ss.SSSZ` Di UTC, misalnya, 17:00 23 Agustus 1970 adalah:. `1970-08-23T17:00:00Z` Perhatikan bahwa Anda juga dapat menentukan detik pecahan saat menentukan waktu di UTC. Sebagai contoh, `1967-01-31T23:20:50.650Z.`.
Nilai boost adalah nilai numerik positif yang meningkatkan pentingnya bagian kueri penelusuran ini relatif terhadap bagian lain.
Contoh:
```
(range field=year [1990,2000])
(range field=year {,2000])
(range field=year [1990,})
```
term
Sintaks: `(term field=FIELD boost=N 'STRING'|VALUE) `
Mencari bidang tertentu untuk string, nilai numerik, atau tanggal. `field`Opsi harus ditentukan saat mencari nilai. Jika Anda menghilangkan `field` opsi, Amazon CloudSearch mencari semua yang dikonfigurasi secara statis `text` dan `text-array` bidang secara default. Bidang dan `literal` bidang dinamis tidak dicari secara default. Anda dapat menentukan bidang mana yang ingin Anda cari secara default dengan menentukan `q.options` `fields` opsi.
Gunakan `term` operator untuk menggabungkan pencarian istilah dengan kriteria penelusuran lainnya dalam kueri terstruktur. Misalnya, `q=(and (term field=title 'star') (range field=year {,2000]))` cocok dengan semua dokumen yang berisi *bintang* di bidang judul dan memiliki nilai tahun kurang dari atau sama dengan 2000.
String dan tanggal harus dilampirkan dalam tanda kutip tunggal. Setiap tanda kutip tunggal atau garis miring terbalik dalam string harus lolos dengan garis miring terbalik.
Tanggal dan waktu ditentukan dalam UTC (Coordinated Universal Time) menurut [ RFC3339IETF](http://tools.ietf.org/html/rfc3339):. `yyyy-mm-ddTHH:mm:ss.SSSZ` Di UTC, misalnya, 17:00 23 Agustus 1970 adalah:. `1970-08-23T17:00:00Z` Perhatikan bahwa Anda juga dapat menentukan detik pecahan saat menentukan waktu di UTC. Sebagai contoh, `1967-01-31T23:20:50.650Z.`.
Nilai boost adalah nilai numerik positif yang meningkatkan pentingnya bagian kueri penelusuran ini relatif terhadap bagian lain.
Contoh:
```
(term field=title 'star')
(term field=year 2000)
```
#### Sintaks Pencarian Sederhana
Anda menggunakan sintaks penelusuran CloudSearch sederhana Amazon untuk menentukan kriteria penelusuran saat menggunakan parser `simple` kueri. Parser query sederhana digunakan secara default jika Anda tidak menentukan `q.parser` parameter.
Anda menggunakan parser kueri sederhana untuk mencari istilah atau frasa individual. Secara default, semua dikonfigurasi secara statis `text` dan `text-array` bidang dicari. Bidang dan `literal` bidang dinamis *tidak* dicari secara default. Anda dapat menggunakan `q.options` parameter untuk menentukan bidang mana yang ingin Anda cari, mengubah operator default yang digunakan untuk menggabungkan istilah individual dalam string pencarian, atau menonaktifkan salah satu operator parser sederhana (`and`,`escape`,`fuzzy`,`near`,`not`,`or`,`phrase`, `precedence``prefix`,`whitespace`).
Untuk informasi selengkapnya tentang menggunakan parser kueri sederhana, lihat[Mencari Teks di Amazon CloudSearch](searching-text.md).
\$1 (and)
Sintaks: `+TERM`
Membutuhkan istilah yang ditentukan. Untuk mencocokkan, dokumen harus berisi istilah yang ditentukan.
Contoh: \$1bintang
\$1 (escape)
Sintaks: `\CHAR`
Melarikan diri dari karakter khusus yang ingin Anda cari. Anda harus melarikan diri dari karakter berikut jika Anda ingin mereka menjadi bagian dari kueri: \$1 - & \$1\$1 () \$1\$1 [] ^ "\$1 \$1? :\$1 /.
Contoh: `M\*A\*S\*H`
\$1 (fuzzy)
Sintaks: `TERM~N`
Melakukan pencarian fuzzy. Tambahkan operator \$1 dan nilai ke istilah untuk menunjukkan berapa banyak istilah yang dapat berbeda dan masih dianggap cocok.
Contoh: `stor~1`
\$1 (near)
Sintaks: `"PHRASE"~N`
Melakukan pencarian frase ceroboh. Tambahkan operator \$1 dan nilai ke frasa untuk menunjukkan seberapa jauh jarak istilah tersebut dan masih dianggap cocok untuk frasa tersebut.
Contoh: `"star wars"~4`
- (not)
Sintaks: `-TERM`
Melarang istilah yang ditentukan. Untuk mencocokkan, dokumen tidak boleh mengandung istilah.
Contoh: star -wars
\$1 (or)
Sintaks: `|TERM`
Membuat istilah yang ditentukan opsional.
Contoh: star \$1wars
"..." (phrase)
Sintaks: `"PHRASE"`
Melakukan pencarian untuk seluruh frasa. Dapat dikombinasikan dengan `~` operator untuk melakukan pencarian frase ceroboh.
Contoh: “perang bintang”
(...) (precedence)
Sintaks: `(...)`
Mengontrol urutan di mana kendala kueri dievaluasi. Isi tanda kurung paling dalam dievaluasi terlebih dahulu.
Contoh: `+(war|trek)+star`
\$1 (prefix)
Sintaks: `CHARS*`
Cocokkan dokumen yang berisi istilah yang memiliki awalan yang ditentukan.
Contoh: `sta*`
### Respon Pencarian
Ketika permintaan berhasil diselesaikan, badan respons berisi hasil pencarian. Secara default, hasil pencarian dikembalikan dalam JSON. Jika `format` parameter diatur ke`xml`, hasil pencarian dikembalikan dalam XHTML.
Kecuali Anda secara eksplisit menentukan `return` parameter, ID dokumen dan semua bidang yang dapat dikembalikan disertakan untuk setiap dokumen yang cocok (hit). Respons juga menunjukkan jumlah total hit found (`found`) dan indeks dokumen pertama yang terdaftar (`start`). Secara default, respons berisi 10 klik pertama. Anda menentukan `size` parameter dalam permintaan Anda untuk mengontrol berapa banyak klik yang disertakan dalam setiap respons. Untuk halaman melalui hits, Anda dapat menggunakan `cursor` parameter `start` or. Untuk informasi selengkapnya, lihat [Hasil Paginating](paginating-results.md).
Contoh berikut menunjukkan respons JSON yang khas.
```
{
"status": {
"rid": "rtKz7rkoeAojlvk=",
"time-ms": 10
},
"hits": {
"found": 3,
"start": 0,
"hit": [
{
"id": "tt1142977",
"fields": {
"rating": "6.9",
"genres": [
"Animation",
"Comedy",
"Family",
"Horror",
"Sci-Fi"
],
"plot": "Young Victor conducts a science experiment to
bring his beloved dog Sparky back to life, only
to face unintended, sometimes monstrous,
consequences.",
"release_date": "2012-09-20T00:00:00Z",
"title": "Frankenweenie",
"rank": "1462",
"running_time_secs": "5220",
"directors": [
"Tim Burton"
],
"image_url": "http://ia.media-imdb.com/images/M/MV5BMjIx
ODY3MjEwNV5BMl5BanBnXkFtZTcwOTMzNjc4Nw@@._
V1_SX400_.jpg",
"year": "2012",
"actors": [
"Winona Ryder",
"Catherine O'Hara",
"Martin Short"
]
}
},
.
.
.
]
}
}
```
Contoh berikut menunjukkan respon XMLnya setara.
```
6.9
Animation
Comedy
Family
Horror
Sci-Fi
Young Victor conducts a science experiment to
bring his beloved dog Sparky back to life, only
to face unintended, sometimes monstrous,
consequences.
2012-09-20T00:00:00Z
Frankenweenie
1462
5220
Tim Burton
http://ia.media-imdb.com/images/M/MV5BMjI
xODY3MjEwNV5BMl5BanBnXkFtZTcwOTMzNjc4Nw@@.
_V1_SX400_.jpg
2012
Winona Ryder
Catherine O'Hara
Martin Short
.
.
.
```
Menyetel format respons hanya memengaruhi respons terhadap permintaan yang berhasil. Format respons kesalahan tergantung pada asal kesalahan. Kesalahan yang dikembalikan oleh layanan pencarian selalu dikembalikan di JSON. Kesalahan 5xx karena batas waktu server dan masalah perutean permintaan lainnya dikembalikan dalam XHTML. Ketika permintaan mengembalikan kode kesalahan, isi respons berisi informasi tentang kesalahan yang terjadi. Jika terjadi kesalahan saat badan permintaan diurai dan divalidasi, kode kesalahan diatur ke 400 dan badan respons menyertakan daftar kesalahan dan di mana mereka terjadi.
#### Cari Header Respons
Content-Type
Tipe MIME standar yang menjelaskan format data objek. Untuk informasi lebih lanjut, lihat [W3C RFC 2616](http://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html#sec14.17) Bagian 14.
Nilai yang valid: application/json atau application/xml
Default: application/json
Content-Length
Panjang byte tubuh dalam respons.
#### Cari Properti Respon (JSON)
status
Berisi id sumber daya (rid) dan waktu yang dibutuhkan untuk memproses permintaan (time-ms).
rid
ID Sumber Daya terenkripsi.
time-ms
Berapa lama waktu yang dibutuhkan untuk memproses permintaan pencarian dalam milidetik.
hits
Berisi jumlah dokumen yang cocok (`found`), indeks dokumen pertama yang disertakan dalam response (`start`), dan array (`hit`) yang mencantumkan dokumen IDs dan data untuk setiap hit.
found
Jumlah total klik yang cocok dengan permintaan pencarian setelah Amazon CloudSearch selesai memproses permintaan.
start
Indeks hit pertama kembali dalam respons ini.
hit
Array yang mencantumkan dokumen IDs dan data untuk setiap hit.
id
Pengidentifikasi unik untuk dokumen.
fields
Daftar bidang yang dikembalikan.
facets
Berisi informasi faset dan jumlah faset.
FACETFIELD
Bidang yang aspeknya dihitung.
buckets
Array dari nilai dan hitungan faset yang dihitung.
value
Nilai faset dihitung.
count
Jumlah hit yang berisi nilai faset di`FACETFIELD`.
#### Elemen Respon Pencarian (XHTML)
results
Berisi hasil pencarian. Setiap kesalahan yang terjadi saat memproses permintaan dikembalikan sebagai pesan dalam elemen info.
status
Berisi id sumber daya (`rid`) dan waktu yang dibutuhkan untuk memproses request (`time-ms`).
hits
Berisi statistik hit dan kumpulan elemen hit. Atribut yang ditemukan adalah jumlah total klik yang cocok dengan permintaan pencarian setelah Amazon CloudSearch selesai memproses hasilnya. Elemen hit yang terkandung diurutkan sesuai dengan skor relevansinya atau `sort` opsi yang ditentukan dalam permintaan pencarian.
hit
Dokumen yang cocok dengan permintaan pencarian. Atribut id adalah id unik dokumen. Berisi elemen `d` (data) untuk setiap bidang yang dikembalikan.
field
Sebuah lapangan kembali dari pukulan. Elemen hit berisi elemen `d` (data) untuk setiap bidang yang dikembalikan.
facets
Berisi elemen faset untuk setiap aspek yang diminta dalam permintaan pencarian.
facet
Berisi elemen bucket untuk setiap nilai bidang yang dihitung hitungan fasetnya. Opsi `facet.FIELD` ukuran dapat digunakan untuk menentukan berapa banyak kendala yang akan dikembalikan. Secara default, jumlah faset dikembalikan untuk 10 batasan teratas. Opsi `facet.FIELD` bucket dapat digunakan untuk secara eksplisit menentukan nilai mana yang akan dihitung.
bucket
Nilai bidang facet dan jumlah kemunculan (hitungan) dari nilai tersebut dalam hit pencarian.
## Mengirimkan Permintaan Saran di Amazon CloudSearch
Anda mengirimkan permintaan saran melalui HTTP GET ke titik akhir pencarian domain Anda di`2013-01-01/suggest`. Untuk informasi tentang mengontrol akses ke layanan saran, lihat[Mengkonfigurasi Akses untuk Amazon CloudSearch](configuring-access.md).
Anda harus menentukan versi API di semua permintaan saran dan versi tersebut harus cocok dengan versi API yang ditentukan saat domain dibuat.
Misalnya, permintaan berikut mendapat saran dari `search-movies-rr2f34ofg56xneuemujamut52i.us-east-1.cloudsearch.amazonaws.com` domain untuk string kueri `oce` menggunakan sugester yang dipanggil`title`.
```
http://search-imdb-hd6ebyouhw2lczkueyuqksnuzu.us-west-2.cloudsearch.amazonaws.com/2013-01-01/suggest -d"q=oce&suggester=suggest_title"
```
Anda dapat menggunakan metode apa pun yang ingin Anda kirim permintaan GET ke titik akhir pencarian domain Anda—Anda dapat memasukkan URL permintaan secara langsung di browser Web, menggunakan cURL untuk mengirimkan permintaan, atau membuat panggilan HTTP menggunakan pustaka HTTP favorit Anda. Anda juga dapat menggunakan Search Tester di CloudSearch konsol Amazon untuk mendapatkan saran. Untuk informasi selengkapnya, lihat [Mencari dengan Search Tester](getting-started-search.md#searching-console).
**penting**
Dokumen domain dan titik akhir pencarian tetap sama untuk masa pakai domain. Anda harus men-cache titik akhir daripada mengambilnya sebelum setiap permintaan unggahan atau pencarian. Menanyakan layanan CloudSearch konfigurasi Amazon dengan menelepon `aws cloudsearch describe-domains` atau `DescribeDomains` sebelum setiap permintaan kemungkinan akan mengakibatkan permintaan Anda dibatasi.
Secara default, Amazon CloudSearch mengembalikan respons di JSON. Anda bisa mendapatkan hasil yang diformat dalam XHTML dengan menentukan parameter,`format`. `format=xml` Menyetel format respons hanya memengaruhi respons terhadap permintaan yang berhasil. Format respons kesalahan tergantung pada asal kesalahan. Kesalahan yang dikembalikan oleh layanan pencarian selalu dikembalikan di JSON. Kesalahan 5xx karena batas waktu server dan masalah perutean permintaan lainnya dikembalikan dalam XHTML.
## Sarankan
### Permintaan Saran
#### Sarankan Sintaks di Amazon CloudSearch
```
GET /2013-01-01/suggest
```
#### Sarankan Header Permintaan di Amazon CloudSearch
HOST
Titik akhir permintaan pencarian untuk domain yang Anda kueri. Anda dapat menggunakan [DescribeDomains](API_DescribeDomains.md) untuk mengambil titik akhir permintaan pencarian domain Anda.
Wajib: Ya
#### Sarankan Parameter Permintaan di Amazon CloudSearch
q
String untuk mendapatkan saran untuk.
Tipe: String
Diperlukan: Ya
suggester
Nama sugester untuk digunakan untuk menemukan kecocokan yang disarankan.
Tipe: String
Diperlukan: Ya
size
Jumlah maksimum saran untuk dikembalikan.
Tipe: Bilangan bulat positif
Default: 10
Wajib: Tidak
format
Menentukan jenis konten respon.
Tipe: String
Nilai yang Valid: json\$1xml\$1
Default: json
Wajib: Tidak
### Sarankan Tanggapan
Ketika permintaan berhasil diselesaikan, badan respons berisi saran. Secara default, saran dikembalikan dalam JSON. Atur `format` parameter `xml` untuk mendapatkan hasil dalam XHTML.
Menyetel format respons hanya memengaruhi respons terhadap permintaan yang berhasil. Format respons kesalahan tergantung pada asal kesalahan. Kesalahan yang dikembalikan oleh layanan pencarian selalu dikembalikan di JSON. Kesalahan 5xx karena batas waktu server dan masalah perutean permintaan lainnya dikembalikan dalam XHTML. Ketika permintaan mengembalikan kode kesalahan, isi respons berisi informasi tentang kesalahan yang terjadi. Jika terjadi kesalahan saat badan permintaan diurai dan divalidasi, kode kesalahan diatur ke 400 dan badan respons menyertakan daftar kesalahan dan di mana mereka terjadi.
Contoh berikut menunjukkan respons JSON terhadap permintaan saran:
```
{
"status": {
"rid": "qOSM5s0oCwr8pVk=",
"time-ms": 2
},
"suggest": {
"query": "oce",
"found": 3,
"suggestions": [
{
"suggestion": "Ocean's Eleven",
"score": 0,
"id": "tt0054135"
},
{
"suggestion": "Ocean's Thirteen",
"score": 0,
"id": "tt0496806"
},
{
"suggestion": "Ocean's Twelve",
"score": 0,
"id": "tt0349903"
}
]
}
}
```
Contoh berikut menunjukkan respon XMLnya setara:
```