aws-sdk-cloudsearch 1.0.0.rc1 → 1.0.0.rc2
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/lib/aws-sdk-cloudsearch.rb +2 -2
- data/lib/aws-sdk-cloudsearch/client.rb +1530 -1377
- data/lib/aws-sdk-cloudsearch/client_api.rb +775 -1023
- data/lib/aws-sdk-cloudsearch/errors.rb +4 -13
- data/lib/aws-sdk-cloudsearch/resource.rb +12 -14
- data/lib/aws-sdk-cloudsearch/types.rb +2436 -2246
- metadata +2 -2
checksums.yaml
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
---
|
|
2
2
|
SHA1:
|
|
3
|
-
metadata.gz:
|
|
4
|
-
data.tar.gz:
|
|
3
|
+
metadata.gz: 6a8206bac921a6f1ab6db877e631b62008ae943b
|
|
4
|
+
data.tar.gz: e8428058eec2144c8b2a52dfa9a7241f4fff1290
|
|
5
5
|
SHA512:
|
|
6
|
-
metadata.gz:
|
|
7
|
-
data.tar.gz:
|
|
6
|
+
metadata.gz: de1873a055518a394068d6b8c7b477d8cd06b165ed3fa1745c1fd3287fecc448ad8312694e85c90ff11aea82019f9704b9fce7d07727167643972309b595bbfc
|
|
7
|
+
data.tar.gz: 53e83a9399f4c2fd8f0ada96bf12839f3a943e24258147ec04f7f4755df9ccb29f992e0935266cab5047db251131c56e6063630ff7cf9c9a1ea9e66c1a75293a
|
data/lib/aws-sdk-cloudsearch.rb
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
# WARNING ABOUT GENERATED CODE
|
|
2
2
|
#
|
|
3
|
-
# This file is generated. See the contributing for
|
|
3
|
+
# This file is generated. See the contributing guide for more information:
|
|
4
4
|
# https://github.com/aws/aws-sdk-ruby/blob/master/CONTRIBUTING.md
|
|
5
5
|
#
|
|
6
6
|
# WARNING ABOUT GENERATED CODE
|
|
@@ -42,6 +42,6 @@ require_relative 'aws-sdk-cloudsearch/customizations'
|
|
|
42
42
|
# @service
|
|
43
43
|
module Aws::CloudSearch
|
|
44
44
|
|
|
45
|
-
GEM_VERSION = '1.0.0.
|
|
45
|
+
GEM_VERSION = '1.0.0.rc2'
|
|
46
46
|
|
|
47
47
|
end
|
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
# WARNING ABOUT GENERATED CODE
|
|
2
2
|
#
|
|
3
|
-
# This file is generated. See the contributing for
|
|
3
|
+
# This file is generated. See the contributing guide for more information:
|
|
4
4
|
# https://github.com/aws/aws-sdk-ruby/blob/master/CONTRIBUTING.md
|
|
5
5
|
#
|
|
6
6
|
# WARNING ABOUT GENERATED CODE
|
|
@@ -18,1424 +18,1577 @@ require 'aws-sdk-core/plugins/regional_endpoint.rb'
|
|
|
18
18
|
require 'aws-sdk-core/plugins/response_paging.rb'
|
|
19
19
|
require 'aws-sdk-core/plugins/stub_responses.rb'
|
|
20
20
|
require 'aws-sdk-core/plugins/idempotency_token.rb'
|
|
21
|
+
require 'aws-sdk-core/plugins/jsonvalue_converter.rb'
|
|
21
22
|
require 'aws-sdk-core/plugins/signature_v4.rb'
|
|
22
23
|
require 'aws-sdk-core/plugins/protocols/query.rb'
|
|
23
24
|
|
|
24
25
|
Aws::Plugins::GlobalConfiguration.add_identifier(:cloudsearch)
|
|
25
26
|
|
|
26
|
-
module Aws
|
|
27
|
-
|
|
28
|
-
class Client < Seahorse::Client::Base
|
|
27
|
+
module Aws::CloudSearch
|
|
28
|
+
class Client < Seahorse::Client::Base
|
|
29
29
|
|
|
30
|
-
|
|
30
|
+
include Aws::ClientStubs
|
|
31
31
|
|
|
32
|
-
|
|
32
|
+
@identifier = :cloudsearch
|
|
33
33
|
|
|
34
|
-
|
|
34
|
+
set_api(ClientApi::API)
|
|
35
35
|
|
|
36
|
-
|
|
37
|
-
|
|
38
|
-
|
|
39
|
-
|
|
40
|
-
|
|
41
|
-
|
|
42
|
-
|
|
43
|
-
|
|
44
|
-
|
|
45
|
-
|
|
46
|
-
|
|
47
|
-
|
|
48
|
-
|
|
49
|
-
|
|
50
|
-
|
|
36
|
+
add_plugin(Seahorse::Client::Plugins::ContentLength)
|
|
37
|
+
add_plugin(Aws::Plugins::CredentialsConfiguration)
|
|
38
|
+
add_plugin(Aws::Plugins::Logging)
|
|
39
|
+
add_plugin(Aws::Plugins::ParamConverter)
|
|
40
|
+
add_plugin(Aws::Plugins::ParamValidator)
|
|
41
|
+
add_plugin(Aws::Plugins::UserAgent)
|
|
42
|
+
add_plugin(Aws::Plugins::HelpfulSocketErrors)
|
|
43
|
+
add_plugin(Aws::Plugins::RetryErrors)
|
|
44
|
+
add_plugin(Aws::Plugins::GlobalConfiguration)
|
|
45
|
+
add_plugin(Aws::Plugins::RegionalEndpoint)
|
|
46
|
+
add_plugin(Aws::Plugins::ResponsePaging)
|
|
47
|
+
add_plugin(Aws::Plugins::StubResponses)
|
|
48
|
+
add_plugin(Aws::Plugins::IdempotencyToken)
|
|
49
|
+
add_plugin(Aws::Plugins::JsonvalueConverter)
|
|
50
|
+
add_plugin(Aws::Plugins::SignatureV4)
|
|
51
|
+
add_plugin(Aws::Plugins::Protocols::Query)
|
|
51
52
|
|
|
52
|
-
|
|
53
|
-
|
|
54
|
-
|
|
55
|
-
|
|
56
|
-
|
|
57
|
-
|
|
58
|
-
|
|
59
|
-
|
|
60
|
-
|
|
61
|
-
|
|
62
|
-
|
|
63
|
-
|
|
64
|
-
|
|
65
|
-
|
|
66
|
-
|
|
67
|
-
|
|
68
|
-
|
|
69
|
-
|
|
70
|
-
|
|
71
|
-
|
|
72
|
-
|
|
73
|
-
|
|
74
|
-
|
|
75
|
-
|
|
76
|
-
|
|
77
|
-
|
|
78
|
-
|
|
79
|
-
|
|
80
|
-
|
|
81
|
-
|
|
82
|
-
|
|
83
|
-
|
|
84
|
-
|
|
85
|
-
|
|
86
|
-
|
|
87
|
-
|
|
88
|
-
|
|
89
|
-
|
|
90
|
-
|
|
91
|
-
|
|
92
|
-
|
|
93
|
-
|
|
94
|
-
|
|
95
|
-
|
|
96
|
-
|
|
97
|
-
|
|
98
|
-
|
|
99
|
-
|
|
100
|
-
|
|
101
|
-
|
|
102
|
-
|
|
103
|
-
|
|
104
|
-
|
|
105
|
-
|
|
106
|
-
|
|
107
|
-
|
|
108
|
-
|
|
109
|
-
|
|
110
|
-
|
|
111
|
-
|
|
112
|
-
|
|
113
|
-
|
|
114
|
-
|
|
115
|
-
|
|
116
|
-
|
|
117
|
-
|
|
118
|
-
|
|
119
|
-
|
|
120
|
-
|
|
121
|
-
|
|
122
|
-
|
|
123
|
-
|
|
124
|
-
|
|
125
|
-
|
|
126
|
-
|
|
127
|
-
|
|
128
|
-
|
|
129
|
-
|
|
130
|
-
|
|
131
|
-
|
|
53
|
+
# @option options [required, Aws::CredentialProvider] :credentials
|
|
54
|
+
# Your AWS credentials. This can be an instance of any one of the
|
|
55
|
+
# following classes:
|
|
56
|
+
#
|
|
57
|
+
# * `Aws::Credentials` - Used for configuring static, non-refreshing
|
|
58
|
+
# credentials.
|
|
59
|
+
#
|
|
60
|
+
# * `Aws::InstanceProfileCredentials` - Used for loading credentials
|
|
61
|
+
# from an EC2 IMDS on an EC2 instance.
|
|
62
|
+
#
|
|
63
|
+
# * `Aws::SharedCredentials` - Used for loading credentials from a
|
|
64
|
+
# shared file, such as `~/.aws/config`.
|
|
65
|
+
#
|
|
66
|
+
# * `Aws::AssumeRoleCredentials` - Used when you need to assume a role.
|
|
67
|
+
#
|
|
68
|
+
# When `:credentials` are not configured directly, the following
|
|
69
|
+
# locations will be searched for credentials:
|
|
70
|
+
#
|
|
71
|
+
# * `Aws.config[:credentials]`
|
|
72
|
+
# * The `:access_key_id`, `:secret_access_key`, and `:session_token` options.
|
|
73
|
+
# * ENV['AWS_ACCESS_KEY_ID'], ENV['AWS_SECRET_ACCESS_KEY']
|
|
74
|
+
# * `~/.aws/credentials`
|
|
75
|
+
# * `~/.aws/config`
|
|
76
|
+
# * EC2 IMDS instance profile - When used by default, the timeouts are
|
|
77
|
+
# very aggressive. Construct and pass an instance of
|
|
78
|
+
# `Aws::InstanceProfileCredentails` to enable retries and extended
|
|
79
|
+
# timeouts.
|
|
80
|
+
#
|
|
81
|
+
# @option options [required, String] :region
|
|
82
|
+
# The AWS region to connect to. The configured `:region` is
|
|
83
|
+
# used to determine the service `:endpoint`. When not passed,
|
|
84
|
+
# a default `:region` is search for in the following locations:
|
|
85
|
+
#
|
|
86
|
+
# * `Aws.config[:region]`
|
|
87
|
+
# * `ENV['AWS_REGION']`
|
|
88
|
+
# * `ENV['AMAZON_REGION']`
|
|
89
|
+
# * `ENV['AWS_DEFAULT_REGION']`
|
|
90
|
+
# * `~/.aws/credentials`
|
|
91
|
+
# * `~/.aws/config`
|
|
92
|
+
#
|
|
93
|
+
# @option options [String] :access_key_id
|
|
94
|
+
#
|
|
95
|
+
# @option options [Boolean] :convert_params (true)
|
|
96
|
+
# When `true`, an attempt is made to coerce request parameters into
|
|
97
|
+
# the required types.
|
|
98
|
+
#
|
|
99
|
+
# @option options [String] :endpoint
|
|
100
|
+
# The client endpoint is normally constructed from the `:region`
|
|
101
|
+
# option. You should only configure an `:endpoint` when connecting
|
|
102
|
+
# to test endpoints. This should be avalid HTTP(S) URI.
|
|
103
|
+
#
|
|
104
|
+
# @option options [Aws::Log::Formatter] :log_formatter (Aws::Log::Formatter.default)
|
|
105
|
+
# The log formatter.
|
|
106
|
+
#
|
|
107
|
+
# @option options [Symbol] :log_level (:info)
|
|
108
|
+
# The log level to send messages to the `:logger` at.
|
|
109
|
+
#
|
|
110
|
+
# @option options [Logger] :logger
|
|
111
|
+
# The Logger instance to send log messages to. If this option
|
|
112
|
+
# is not set, logging will be disabled.
|
|
113
|
+
#
|
|
114
|
+
# @option options [String] :profile ("default")
|
|
115
|
+
# Used when loading credentials from the shared credentials file
|
|
116
|
+
# at HOME/.aws/credentials. When not specified, 'default' is used.
|
|
117
|
+
#
|
|
118
|
+
# @option options [Integer] :retry_limit (3)
|
|
119
|
+
# The maximum number of times to retry failed requests. Only
|
|
120
|
+
# ~ 500 level server errors and certain ~ 400 level client errors
|
|
121
|
+
# are retried. Generally, these are throttling errors, data
|
|
122
|
+
# checksum errors, networking errors, timeout errors and auth
|
|
123
|
+
# errors from expired credentials.
|
|
124
|
+
#
|
|
125
|
+
# @option options [String] :secret_access_key
|
|
126
|
+
#
|
|
127
|
+
# @option options [String] :session_token
|
|
128
|
+
#
|
|
129
|
+
# @option options [Boolean] :stub_responses (false)
|
|
130
|
+
# Causes the client to return stubbed responses. By default
|
|
131
|
+
# fake responses are generated and returned. You can specify
|
|
132
|
+
# the response data to return or errors to raise by calling
|
|
133
|
+
# {ClientStubs#stub_responses}. See {ClientStubs} for more information.
|
|
134
|
+
#
|
|
135
|
+
# ** Please note ** When response stubbing is enabled, no HTTP
|
|
136
|
+
# requests are made, and retries are disabled.
|
|
137
|
+
#
|
|
138
|
+
# @option options [Boolean] :validate_params (true)
|
|
139
|
+
# When `true`, request parameters are validated before
|
|
140
|
+
# sending the request.
|
|
141
|
+
#
|
|
142
|
+
def initialize(*args)
|
|
143
|
+
super
|
|
144
|
+
end
|
|
132
145
|
|
|
133
|
-
|
|
134
|
-
# Suggesters][1] in the *Amazon CloudSearch Developer Guide*.
|
|
135
|
-
#
|
|
136
|
-
#
|
|
137
|
-
#
|
|
138
|
-
# [1]: http://docs.aws.amazon.com/cloudsearch/latest/developerguide/getting-suggestions.html#configuring-suggesters
|
|
139
|
-
# @option params [required, String] :domain_name
|
|
140
|
-
# A string that represents the name of a domain. Domain names are unique
|
|
141
|
-
# across the domains owned by an account within an AWS region. Domain
|
|
142
|
-
# names start with a letter or number and can contain the following
|
|
143
|
-
# characters: a-z (lowercase), 0-9, and - (hyphen).
|
|
144
|
-
# @return [Types::BuildSuggestersResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
|
145
|
-
#
|
|
146
|
-
# * {Types::BuildSuggestersResponse#field_names #FieldNames} => Array<String>
|
|
147
|
-
#
|
|
148
|
-
# @example Request syntax with placeholder values
|
|
149
|
-
# resp = client.build_suggesters({
|
|
150
|
-
# domain_name: "DomainName", # required
|
|
151
|
-
# })
|
|
152
|
-
#
|
|
153
|
-
# @example Response structure
|
|
154
|
-
# resp.field_names #=> Array
|
|
155
|
-
# resp.field_names[0] #=> String
|
|
156
|
-
# @overload build_suggesters(params = {})
|
|
157
|
-
# @param [Hash] params ({})
|
|
158
|
-
def build_suggesters(params = {}, options = {})
|
|
159
|
-
req = build_request(:build_suggesters, params)
|
|
160
|
-
req.send_request(options)
|
|
161
|
-
end
|
|
146
|
+
# @!group API Operations
|
|
162
147
|
|
|
163
|
-
|
|
164
|
-
|
|
165
|
-
|
|
166
|
-
|
|
167
|
-
|
|
168
|
-
|
|
169
|
-
|
|
170
|
-
|
|
171
|
-
|
|
172
|
-
|
|
173
|
-
|
|
174
|
-
|
|
175
|
-
|
|
176
|
-
|
|
177
|
-
|
|
178
|
-
|
|
179
|
-
|
|
180
|
-
|
|
181
|
-
|
|
182
|
-
|
|
183
|
-
|
|
184
|
-
|
|
185
|
-
|
|
186
|
-
|
|
187
|
-
|
|
188
|
-
|
|
189
|
-
|
|
190
|
-
|
|
191
|
-
|
|
192
|
-
|
|
193
|
-
|
|
194
|
-
|
|
195
|
-
|
|
196
|
-
|
|
197
|
-
# resp.domain_status.limits.maximum_partition_count #=> Integer
|
|
198
|
-
# @overload create_domain(params = {})
|
|
199
|
-
# @param [Hash] params ({})
|
|
200
|
-
def create_domain(params = {}, options = {})
|
|
201
|
-
req = build_request(:create_domain, params)
|
|
202
|
-
req.send_request(options)
|
|
203
|
-
end
|
|
148
|
+
# Indexes the search suggestions. For more information, see [Configuring
|
|
149
|
+
# Suggesters][1] in the *Amazon CloudSearch Developer Guide*.
|
|
150
|
+
#
|
|
151
|
+
#
|
|
152
|
+
#
|
|
153
|
+
# [1]: http://docs.aws.amazon.com/cloudsearch/latest/developerguide/getting-suggestions.html#configuring-suggesters
|
|
154
|
+
#
|
|
155
|
+
# @option params [required, String] :domain_name
|
|
156
|
+
# A string that represents the name of a domain. Domain names are unique
|
|
157
|
+
# across the domains owned by an account within an AWS region. Domain
|
|
158
|
+
# names start with a letter or number and can contain the following
|
|
159
|
+
# characters: a-z (lowercase), 0-9, and - (hyphen).
|
|
160
|
+
#
|
|
161
|
+
# @return [Types::BuildSuggestersResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
|
162
|
+
#
|
|
163
|
+
# * {Types::BuildSuggestersResponse#field_names #field_names} => Array<String>
|
|
164
|
+
#
|
|
165
|
+
# @example Request syntax with placeholder values
|
|
166
|
+
#
|
|
167
|
+
# resp = client.build_suggesters({
|
|
168
|
+
# domain_name: "DomainName", # required
|
|
169
|
+
# })
|
|
170
|
+
#
|
|
171
|
+
# @example Response structure
|
|
172
|
+
#
|
|
173
|
+
# resp.field_names #=> Array
|
|
174
|
+
# resp.field_names[0] #=> String
|
|
175
|
+
#
|
|
176
|
+
# @overload build_suggesters(params = {})
|
|
177
|
+
# @param [Hash] params ({})
|
|
178
|
+
def build_suggesters(params = {}, options = {})
|
|
179
|
+
req = build_request(:build_suggesters, params)
|
|
180
|
+
req.send_request(options)
|
|
181
|
+
end
|
|
204
182
|
|
|
205
|
-
|
|
206
|
-
|
|
207
|
-
|
|
208
|
-
|
|
209
|
-
|
|
210
|
-
|
|
211
|
-
|
|
212
|
-
|
|
213
|
-
|
|
214
|
-
|
|
215
|
-
|
|
216
|
-
|
|
217
|
-
|
|
218
|
-
|
|
219
|
-
|
|
220
|
-
|
|
221
|
-
|
|
222
|
-
|
|
223
|
-
|
|
224
|
-
|
|
225
|
-
|
|
226
|
-
|
|
227
|
-
|
|
228
|
-
|
|
229
|
-
|
|
230
|
-
|
|
231
|
-
|
|
232
|
-
|
|
233
|
-
|
|
234
|
-
|
|
235
|
-
|
|
236
|
-
|
|
237
|
-
|
|
238
|
-
|
|
239
|
-
|
|
240
|
-
|
|
241
|
-
|
|
242
|
-
|
|
243
|
-
|
|
244
|
-
|
|
245
|
-
|
|
246
|
-
|
|
247
|
-
|
|
248
|
-
|
|
249
|
-
|
|
250
|
-
|
|
251
|
-
# resp.analysis_scheme.options.analysis_options.algorithmic_stemming #=> String, one of "none", "minimal", "light", "full"
|
|
252
|
-
# resp.analysis_scheme.status.creation_date #=> Time
|
|
253
|
-
# resp.analysis_scheme.status.update_date #=> Time
|
|
254
|
-
# resp.analysis_scheme.status.update_version #=> Integer
|
|
255
|
-
# resp.analysis_scheme.status.state #=> String, one of "RequiresIndexDocuments", "Processing", "Active", "FailedToValidate"
|
|
256
|
-
# resp.analysis_scheme.status.pending_deletion #=> Boolean
|
|
257
|
-
# @overload define_analysis_scheme(params = {})
|
|
258
|
-
# @param [Hash] params ({})
|
|
259
|
-
def define_analysis_scheme(params = {}, options = {})
|
|
260
|
-
req = build_request(:define_analysis_scheme, params)
|
|
261
|
-
req.send_request(options)
|
|
262
|
-
end
|
|
183
|
+
# Creates a new search domain. For more information, see [Creating a
|
|
184
|
+
# Search Domain][1] in the *Amazon CloudSearch Developer Guide*.
|
|
185
|
+
#
|
|
186
|
+
#
|
|
187
|
+
#
|
|
188
|
+
# [1]: http://docs.aws.amazon.com/cloudsearch/latest/developerguide/creating-domains.html
|
|
189
|
+
#
|
|
190
|
+
# @option params [required, String] :domain_name
|
|
191
|
+
# A name for the domain you are creating. Allowed characters are a-z
|
|
192
|
+
# (lower-case letters), 0-9, and hyphen (-). Domain names must start
|
|
193
|
+
# with a letter or number and be at least 3 and no more than 28
|
|
194
|
+
# characters long.
|
|
195
|
+
#
|
|
196
|
+
# @return [Types::CreateDomainResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
|
197
|
+
#
|
|
198
|
+
# * {Types::CreateDomainResponse#domain_status #domain_status} => Types::DomainStatus
|
|
199
|
+
#
|
|
200
|
+
# @example Request syntax with placeholder values
|
|
201
|
+
#
|
|
202
|
+
# resp = client.create_domain({
|
|
203
|
+
# domain_name: "DomainName", # required
|
|
204
|
+
# })
|
|
205
|
+
#
|
|
206
|
+
# @example Response structure
|
|
207
|
+
#
|
|
208
|
+
# resp.domain_status.domain_id #=> String
|
|
209
|
+
# resp.domain_status.domain_name #=> String
|
|
210
|
+
# resp.domain_status.arn #=> String
|
|
211
|
+
# resp.domain_status.created #=> Boolean
|
|
212
|
+
# resp.domain_status.deleted #=> Boolean
|
|
213
|
+
# resp.domain_status.doc_service.endpoint #=> String
|
|
214
|
+
# resp.domain_status.search_service.endpoint #=> String
|
|
215
|
+
# resp.domain_status.requires_index_documents #=> Boolean
|
|
216
|
+
# resp.domain_status.processing #=> Boolean
|
|
217
|
+
# resp.domain_status.search_instance_type #=> String
|
|
218
|
+
# resp.domain_status.search_partition_count #=> Integer
|
|
219
|
+
# resp.domain_status.search_instance_count #=> Integer
|
|
220
|
+
# resp.domain_status.limits.maximum_replication_count #=> Integer
|
|
221
|
+
# resp.domain_status.limits.maximum_partition_count #=> Integer
|
|
222
|
+
#
|
|
223
|
+
# @overload create_domain(params = {})
|
|
224
|
+
# @param [Hash] params ({})
|
|
225
|
+
def create_domain(params = {}, options = {})
|
|
226
|
+
req = build_request(:create_domain, params)
|
|
227
|
+
req.send_request(options)
|
|
228
|
+
end
|
|
263
229
|
|
|
264
|
-
|
|
265
|
-
|
|
266
|
-
|
|
267
|
-
|
|
268
|
-
|
|
269
|
-
|
|
270
|
-
|
|
271
|
-
|
|
272
|
-
|
|
273
|
-
|
|
274
|
-
|
|
275
|
-
|
|
276
|
-
|
|
277
|
-
|
|
278
|
-
|
|
279
|
-
|
|
280
|
-
|
|
281
|
-
|
|
282
|
-
|
|
283
|
-
|
|
284
|
-
|
|
285
|
-
|
|
286
|
-
|
|
287
|
-
|
|
288
|
-
|
|
289
|
-
|
|
290
|
-
|
|
291
|
-
|
|
292
|
-
|
|
293
|
-
|
|
294
|
-
|
|
295
|
-
|
|
296
|
-
|
|
297
|
-
|
|
298
|
-
|
|
299
|
-
|
|
300
|
-
|
|
301
|
-
|
|
302
|
-
|
|
303
|
-
|
|
304
|
-
|
|
305
|
-
|
|
306
|
-
|
|
307
|
-
|
|
308
|
-
|
|
230
|
+
# Configures an analysis scheme that can be applied to a `text` or
|
|
231
|
+
# `text-array` field to define language-specific text processing
|
|
232
|
+
# options. For more information, see [Configuring Analysis Schemes][1]
|
|
233
|
+
# in the *Amazon CloudSearch Developer Guide*.
|
|
234
|
+
#
|
|
235
|
+
#
|
|
236
|
+
#
|
|
237
|
+
# [1]: http://docs.aws.amazon.com/cloudsearch/latest/developerguide/configuring-analysis-schemes.html
|
|
238
|
+
#
|
|
239
|
+
# @option params [required, String] :domain_name
|
|
240
|
+
# A string that represents the name of a domain. Domain names are unique
|
|
241
|
+
# across the domains owned by an account within an AWS region. Domain
|
|
242
|
+
# names start with a letter or number and can contain the following
|
|
243
|
+
# characters: a-z (lowercase), 0-9, and - (hyphen).
|
|
244
|
+
#
|
|
245
|
+
# @option params [required, Types::AnalysisScheme] :analysis_scheme
|
|
246
|
+
# Configuration information for an analysis scheme. Each analysis scheme
|
|
247
|
+
# has a unique name and specifies the language of the text to be
|
|
248
|
+
# processed. The following options can be configured for an analysis
|
|
249
|
+
# scheme: `Synonyms`, `Stopwords`, `StemmingDictionary`,
|
|
250
|
+
# `JapaneseTokenizationDictionary` and `AlgorithmicStemming`.
|
|
251
|
+
#
|
|
252
|
+
# @return [Types::DefineAnalysisSchemeResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
|
253
|
+
#
|
|
254
|
+
# * {Types::DefineAnalysisSchemeResponse#analysis_scheme #analysis_scheme} => Types::AnalysisSchemeStatus
|
|
255
|
+
#
|
|
256
|
+
# @example Request syntax with placeholder values
|
|
257
|
+
#
|
|
258
|
+
# resp = client.define_analysis_scheme({
|
|
259
|
+
# domain_name: "DomainName", # required
|
|
260
|
+
# analysis_scheme: { # required
|
|
261
|
+
# analysis_scheme_name: "StandardName", # required
|
|
262
|
+
# analysis_scheme_language: "ar", # required, accepts 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
|
|
263
|
+
# analysis_options: {
|
|
264
|
+
# synonyms: "String",
|
|
265
|
+
# stopwords: "String",
|
|
266
|
+
# stemming_dictionary: "String",
|
|
267
|
+
# japanese_tokenization_dictionary: "String",
|
|
268
|
+
# algorithmic_stemming: "none", # accepts none, minimal, light, full
|
|
269
|
+
# },
|
|
270
|
+
# },
|
|
271
|
+
# })
|
|
272
|
+
#
|
|
273
|
+
# @example Response structure
|
|
274
|
+
#
|
|
275
|
+
# resp.analysis_scheme.options.analysis_scheme_name #=> String
|
|
276
|
+
# resp.analysis_scheme.options.analysis_scheme_language #=> String, one of "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"
|
|
277
|
+
# resp.analysis_scheme.options.analysis_options.synonyms #=> String
|
|
278
|
+
# resp.analysis_scheme.options.analysis_options.stopwords #=> String
|
|
279
|
+
# resp.analysis_scheme.options.analysis_options.stemming_dictionary #=> String
|
|
280
|
+
# resp.analysis_scheme.options.analysis_options.japanese_tokenization_dictionary #=> String
|
|
281
|
+
# resp.analysis_scheme.options.analysis_options.algorithmic_stemming #=> String, one of "none", "minimal", "light", "full"
|
|
282
|
+
# resp.analysis_scheme.status.creation_date #=> Time
|
|
283
|
+
# resp.analysis_scheme.status.update_date #=> Time
|
|
284
|
+
# resp.analysis_scheme.status.update_version #=> Integer
|
|
285
|
+
# resp.analysis_scheme.status.state #=> String, one of "RequiresIndexDocuments", "Processing", "Active", "FailedToValidate"
|
|
286
|
+
# resp.analysis_scheme.status.pending_deletion #=> Boolean
|
|
287
|
+
#
|
|
288
|
+
# @overload define_analysis_scheme(params = {})
|
|
289
|
+
# @param [Hash] params ({})
|
|
290
|
+
def define_analysis_scheme(params = {}, options = {})
|
|
291
|
+
req = build_request(:define_analysis_scheme, params)
|
|
292
|
+
req.send_request(options)
|
|
293
|
+
end
|
|
309
294
|
|
|
310
|
-
|
|
311
|
-
|
|
312
|
-
|
|
313
|
-
|
|
314
|
-
|
|
315
|
-
|
|
316
|
-
|
|
317
|
-
|
|
318
|
-
|
|
319
|
-
|
|
320
|
-
|
|
321
|
-
|
|
322
|
-
|
|
323
|
-
|
|
324
|
-
|
|
325
|
-
|
|
326
|
-
|
|
327
|
-
|
|
328
|
-
|
|
329
|
-
|
|
330
|
-
|
|
331
|
-
|
|
332
|
-
|
|
333
|
-
|
|
334
|
-
|
|
335
|
-
|
|
336
|
-
|
|
337
|
-
|
|
338
|
-
|
|
339
|
-
|
|
340
|
-
|
|
341
|
-
|
|
342
|
-
|
|
343
|
-
|
|
344
|
-
|
|
345
|
-
|
|
346
|
-
|
|
347
|
-
|
|
348
|
-
|
|
349
|
-
|
|
350
|
-
|
|
351
|
-
|
|
352
|
-
|
|
353
|
-
|
|
354
|
-
|
|
355
|
-
|
|
356
|
-
|
|
357
|
-
|
|
358
|
-
|
|
359
|
-
|
|
360
|
-
|
|
361
|
-
# return_enabled: false,
|
|
362
|
-
# sort_enabled: false,
|
|
363
|
-
# },
|
|
364
|
-
# text_options: {
|
|
365
|
-
# default_value: "FieldValue",
|
|
366
|
-
# source_field: "FieldName",
|
|
367
|
-
# return_enabled: false,
|
|
368
|
-
# sort_enabled: false,
|
|
369
|
-
# highlight_enabled: false,
|
|
370
|
-
# analysis_scheme: "Word",
|
|
371
|
-
# },
|
|
372
|
-
# date_options: {
|
|
373
|
-
# default_value: "FieldValue",
|
|
374
|
-
# source_field: "FieldName",
|
|
375
|
-
# facet_enabled: false,
|
|
376
|
-
# search_enabled: false,
|
|
377
|
-
# return_enabled: false,
|
|
378
|
-
# sort_enabled: false,
|
|
379
|
-
# },
|
|
380
|
-
# lat_lon_options: {
|
|
381
|
-
# default_value: "FieldValue",
|
|
382
|
-
# source_field: "FieldName",
|
|
383
|
-
# facet_enabled: false,
|
|
384
|
-
# search_enabled: false,
|
|
385
|
-
# return_enabled: false,
|
|
386
|
-
# sort_enabled: false,
|
|
387
|
-
# },
|
|
388
|
-
# int_array_options: {
|
|
389
|
-
# default_value: 1,
|
|
390
|
-
# source_fields: "FieldNameCommaList",
|
|
391
|
-
# facet_enabled: false,
|
|
392
|
-
# search_enabled: false,
|
|
393
|
-
# return_enabled: false,
|
|
394
|
-
# },
|
|
395
|
-
# double_array_options: {
|
|
396
|
-
# default_value: 1.0,
|
|
397
|
-
# source_fields: "FieldNameCommaList",
|
|
398
|
-
# facet_enabled: false,
|
|
399
|
-
# search_enabled: false,
|
|
400
|
-
# return_enabled: false,
|
|
401
|
-
# },
|
|
402
|
-
# literal_array_options: {
|
|
403
|
-
# default_value: "FieldValue",
|
|
404
|
-
# source_fields: "FieldNameCommaList",
|
|
405
|
-
# facet_enabled: false,
|
|
406
|
-
# search_enabled: false,
|
|
407
|
-
# return_enabled: false,
|
|
408
|
-
# },
|
|
409
|
-
# text_array_options: {
|
|
410
|
-
# default_value: "FieldValue",
|
|
411
|
-
# source_fields: "FieldNameCommaList",
|
|
412
|
-
# return_enabled: false,
|
|
413
|
-
# highlight_enabled: false,
|
|
414
|
-
# analysis_scheme: "Word",
|
|
415
|
-
# },
|
|
416
|
-
# date_array_options: {
|
|
417
|
-
# default_value: "FieldValue",
|
|
418
|
-
# source_fields: "FieldNameCommaList",
|
|
419
|
-
# facet_enabled: false,
|
|
420
|
-
# search_enabled: false,
|
|
421
|
-
# return_enabled: false,
|
|
422
|
-
# },
|
|
423
|
-
# },
|
|
424
|
-
# })
|
|
425
|
-
#
|
|
426
|
-
# @example Response structure
|
|
427
|
-
# resp.index_field.options.index_field_name #=> String
|
|
428
|
-
# resp.index_field.options.index_field_type #=> String, one of "int", "double", "literal", "text", "date", "latlon", "int-array", "double-array", "literal-array", "text-array", "date-array"
|
|
429
|
-
# resp.index_field.options.int_options.default_value #=> Integer
|
|
430
|
-
# resp.index_field.options.int_options.source_field #=> String
|
|
431
|
-
# resp.index_field.options.int_options.facet_enabled #=> Boolean
|
|
432
|
-
# resp.index_field.options.int_options.search_enabled #=> Boolean
|
|
433
|
-
# resp.index_field.options.int_options.return_enabled #=> Boolean
|
|
434
|
-
# resp.index_field.options.int_options.sort_enabled #=> Boolean
|
|
435
|
-
# resp.index_field.options.double_options.default_value #=> Float
|
|
436
|
-
# resp.index_field.options.double_options.source_field #=> String
|
|
437
|
-
# resp.index_field.options.double_options.facet_enabled #=> Boolean
|
|
438
|
-
# resp.index_field.options.double_options.search_enabled #=> Boolean
|
|
439
|
-
# resp.index_field.options.double_options.return_enabled #=> Boolean
|
|
440
|
-
# resp.index_field.options.double_options.sort_enabled #=> Boolean
|
|
441
|
-
# resp.index_field.options.literal_options.default_value #=> String
|
|
442
|
-
# resp.index_field.options.literal_options.source_field #=> String
|
|
443
|
-
# resp.index_field.options.literal_options.facet_enabled #=> Boolean
|
|
444
|
-
# resp.index_field.options.literal_options.search_enabled #=> Boolean
|
|
445
|
-
# resp.index_field.options.literal_options.return_enabled #=> Boolean
|
|
446
|
-
# resp.index_field.options.literal_options.sort_enabled #=> Boolean
|
|
447
|
-
# resp.index_field.options.text_options.default_value #=> String
|
|
448
|
-
# resp.index_field.options.text_options.source_field #=> String
|
|
449
|
-
# resp.index_field.options.text_options.return_enabled #=> Boolean
|
|
450
|
-
# resp.index_field.options.text_options.sort_enabled #=> Boolean
|
|
451
|
-
# resp.index_field.options.text_options.highlight_enabled #=> Boolean
|
|
452
|
-
# resp.index_field.options.text_options.analysis_scheme #=> String
|
|
453
|
-
# resp.index_field.options.date_options.default_value #=> String
|
|
454
|
-
# resp.index_field.options.date_options.source_field #=> String
|
|
455
|
-
# resp.index_field.options.date_options.facet_enabled #=> Boolean
|
|
456
|
-
# resp.index_field.options.date_options.search_enabled #=> Boolean
|
|
457
|
-
# resp.index_field.options.date_options.return_enabled #=> Boolean
|
|
458
|
-
# resp.index_field.options.date_options.sort_enabled #=> Boolean
|
|
459
|
-
# resp.index_field.options.lat_lon_options.default_value #=> String
|
|
460
|
-
# resp.index_field.options.lat_lon_options.source_field #=> String
|
|
461
|
-
# resp.index_field.options.lat_lon_options.facet_enabled #=> Boolean
|
|
462
|
-
# resp.index_field.options.lat_lon_options.search_enabled #=> Boolean
|
|
463
|
-
# resp.index_field.options.lat_lon_options.return_enabled #=> Boolean
|
|
464
|
-
# resp.index_field.options.lat_lon_options.sort_enabled #=> Boolean
|
|
465
|
-
# resp.index_field.options.int_array_options.default_value #=> Integer
|
|
466
|
-
# resp.index_field.options.int_array_options.source_fields #=> String
|
|
467
|
-
# resp.index_field.options.int_array_options.facet_enabled #=> Boolean
|
|
468
|
-
# resp.index_field.options.int_array_options.search_enabled #=> Boolean
|
|
469
|
-
# resp.index_field.options.int_array_options.return_enabled #=> Boolean
|
|
470
|
-
# resp.index_field.options.double_array_options.default_value #=> Float
|
|
471
|
-
# resp.index_field.options.double_array_options.source_fields #=> String
|
|
472
|
-
# resp.index_field.options.double_array_options.facet_enabled #=> Boolean
|
|
473
|
-
# resp.index_field.options.double_array_options.search_enabled #=> Boolean
|
|
474
|
-
# resp.index_field.options.double_array_options.return_enabled #=> Boolean
|
|
475
|
-
# resp.index_field.options.literal_array_options.default_value #=> String
|
|
476
|
-
# resp.index_field.options.literal_array_options.source_fields #=> String
|
|
477
|
-
# resp.index_field.options.literal_array_options.facet_enabled #=> Boolean
|
|
478
|
-
# resp.index_field.options.literal_array_options.search_enabled #=> Boolean
|
|
479
|
-
# resp.index_field.options.literal_array_options.return_enabled #=> Boolean
|
|
480
|
-
# resp.index_field.options.text_array_options.default_value #=> String
|
|
481
|
-
# resp.index_field.options.text_array_options.source_fields #=> String
|
|
482
|
-
# resp.index_field.options.text_array_options.return_enabled #=> Boolean
|
|
483
|
-
# resp.index_field.options.text_array_options.highlight_enabled #=> Boolean
|
|
484
|
-
# resp.index_field.options.text_array_options.analysis_scheme #=> String
|
|
485
|
-
# resp.index_field.options.date_array_options.default_value #=> String
|
|
486
|
-
# resp.index_field.options.date_array_options.source_fields #=> String
|
|
487
|
-
# resp.index_field.options.date_array_options.facet_enabled #=> Boolean
|
|
488
|
-
# resp.index_field.options.date_array_options.search_enabled #=> Boolean
|
|
489
|
-
# resp.index_field.options.date_array_options.return_enabled #=> Boolean
|
|
490
|
-
# resp.index_field.status.creation_date #=> Time
|
|
491
|
-
# resp.index_field.status.update_date #=> Time
|
|
492
|
-
# resp.index_field.status.update_version #=> Integer
|
|
493
|
-
# resp.index_field.status.state #=> String, one of "RequiresIndexDocuments", "Processing", "Active", "FailedToValidate"
|
|
494
|
-
# resp.index_field.status.pending_deletion #=> Boolean
|
|
495
|
-
# @overload define_index_field(params = {})
|
|
496
|
-
# @param [Hash] params ({})
|
|
497
|
-
def define_index_field(params = {}, options = {})
|
|
498
|
-
req = build_request(:define_index_field, params)
|
|
499
|
-
req.send_request(options)
|
|
500
|
-
end
|
|
295
|
+
# Configures an `Expression` for the search domain. Used to create new
|
|
296
|
+
# expressions and modify existing ones. If the expression exists, the
|
|
297
|
+
# new configuration replaces the old one. For more information, see
|
|
298
|
+
# [Configuring Expressions][1] in the *Amazon CloudSearch Developer
|
|
299
|
+
# Guide*.
|
|
300
|
+
#
|
|
301
|
+
#
|
|
302
|
+
#
|
|
303
|
+
# [1]: http://docs.aws.amazon.com/cloudsearch/latest/developerguide/configuring-expressions.html
|
|
304
|
+
#
|
|
305
|
+
# @option params [required, String] :domain_name
|
|
306
|
+
# A string that represents the name of a domain. Domain names are unique
|
|
307
|
+
# across the domains owned by an account within an AWS region. Domain
|
|
308
|
+
# names start with a letter or number and can contain the following
|
|
309
|
+
# characters: a-z (lowercase), 0-9, and - (hyphen).
|
|
310
|
+
#
|
|
311
|
+
# @option params [required, Types::Expression] :expression
|
|
312
|
+
# A named expression that can be evaluated at search time. Can be used
|
|
313
|
+
# to sort the search results, define other expressions, or return
|
|
314
|
+
# computed information in the search results.
|
|
315
|
+
#
|
|
316
|
+
# @return [Types::DefineExpressionResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
|
317
|
+
#
|
|
318
|
+
# * {Types::DefineExpressionResponse#expression #expression} => Types::ExpressionStatus
|
|
319
|
+
#
|
|
320
|
+
# @example Request syntax with placeholder values
|
|
321
|
+
#
|
|
322
|
+
# resp = client.define_expression({
|
|
323
|
+
# domain_name: "DomainName", # required
|
|
324
|
+
# expression: { # required
|
|
325
|
+
# expression_name: "StandardName", # required
|
|
326
|
+
# expression_value: "ExpressionValue", # required
|
|
327
|
+
# },
|
|
328
|
+
# })
|
|
329
|
+
#
|
|
330
|
+
# @example Response structure
|
|
331
|
+
#
|
|
332
|
+
# resp.expression.options.expression_name #=> String
|
|
333
|
+
# resp.expression.options.expression_value #=> String
|
|
334
|
+
# resp.expression.status.creation_date #=> Time
|
|
335
|
+
# resp.expression.status.update_date #=> Time
|
|
336
|
+
# resp.expression.status.update_version #=> Integer
|
|
337
|
+
# resp.expression.status.state #=> String, one of "RequiresIndexDocuments", "Processing", "Active", "FailedToValidate"
|
|
338
|
+
# resp.expression.status.pending_deletion #=> Boolean
|
|
339
|
+
#
|
|
340
|
+
# @overload define_expression(params = {})
|
|
341
|
+
# @param [Hash] params ({})
|
|
342
|
+
def define_expression(params = {}, options = {})
|
|
343
|
+
req = build_request(:define_expression, params)
|
|
344
|
+
req.send_request(options)
|
|
345
|
+
end
|
|
501
346
|
|
|
502
|
-
|
|
503
|
-
|
|
504
|
-
|
|
505
|
-
|
|
506
|
-
|
|
507
|
-
|
|
508
|
-
|
|
509
|
-
|
|
510
|
-
|
|
511
|
-
|
|
512
|
-
|
|
513
|
-
|
|
514
|
-
|
|
515
|
-
|
|
516
|
-
|
|
517
|
-
|
|
518
|
-
|
|
519
|
-
|
|
520
|
-
|
|
521
|
-
|
|
522
|
-
|
|
523
|
-
|
|
524
|
-
|
|
525
|
-
|
|
526
|
-
|
|
527
|
-
|
|
528
|
-
|
|
529
|
-
|
|
530
|
-
|
|
531
|
-
|
|
532
|
-
|
|
533
|
-
|
|
534
|
-
|
|
535
|
-
|
|
536
|
-
|
|
537
|
-
|
|
538
|
-
|
|
539
|
-
|
|
540
|
-
|
|
541
|
-
|
|
542
|
-
|
|
543
|
-
|
|
544
|
-
|
|
545
|
-
|
|
546
|
-
|
|
547
|
-
|
|
548
|
-
|
|
549
|
-
|
|
550
|
-
|
|
551
|
-
|
|
552
|
-
|
|
553
|
-
|
|
554
|
-
|
|
347
|
+
# Configures an `IndexField` for the search domain. Used to create new
|
|
348
|
+
# fields and modify existing ones. You must specify the name of the
|
|
349
|
+
# domain you are configuring and an index field configuration. The index
|
|
350
|
+
# field configuration specifies a unique name, the index field type, and
|
|
351
|
+
# the options you want to configure for the field. The options you can
|
|
352
|
+
# specify depend on the `IndexFieldType`. If the field exists, the new
|
|
353
|
+
# configuration replaces the old one. For more information, see
|
|
354
|
+
# [Configuring Index Fields][1] in the *Amazon CloudSearch Developer
|
|
355
|
+
# Guide*.
|
|
356
|
+
#
|
|
357
|
+
#
|
|
358
|
+
#
|
|
359
|
+
# [1]: http://docs.aws.amazon.com/cloudsearch/latest/developerguide/configuring-index-fields.html
|
|
360
|
+
#
|
|
361
|
+
# @option params [required, String] :domain_name
|
|
362
|
+
# A string that represents the name of a domain. Domain names are unique
|
|
363
|
+
# across the domains owned by an account within an AWS region. Domain
|
|
364
|
+
# names start with a letter or number and can contain the following
|
|
365
|
+
# characters: a-z (lowercase), 0-9, and - (hyphen).
|
|
366
|
+
#
|
|
367
|
+
# @option params [required, Types::IndexField] :index_field
|
|
368
|
+
# The index field and field options you want to configure.
|
|
369
|
+
#
|
|
370
|
+
# @return [Types::DefineIndexFieldResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
|
371
|
+
#
|
|
372
|
+
# * {Types::DefineIndexFieldResponse#index_field #index_field} => Types::IndexFieldStatus
|
|
373
|
+
#
|
|
374
|
+
# @example Request syntax with placeholder values
|
|
375
|
+
#
|
|
376
|
+
# resp = client.define_index_field({
|
|
377
|
+
# domain_name: "DomainName", # required
|
|
378
|
+
# index_field: { # required
|
|
379
|
+
# index_field_name: "DynamicFieldName", # required
|
|
380
|
+
# index_field_type: "int", # required, accepts int, double, literal, text, date, latlon, int-array, double-array, literal-array, text-array, date-array
|
|
381
|
+
# int_options: {
|
|
382
|
+
# default_value: 1,
|
|
383
|
+
# source_field: "FieldName",
|
|
384
|
+
# facet_enabled: false,
|
|
385
|
+
# search_enabled: false,
|
|
386
|
+
# return_enabled: false,
|
|
387
|
+
# sort_enabled: false,
|
|
388
|
+
# },
|
|
389
|
+
# double_options: {
|
|
390
|
+
# default_value: 1.0,
|
|
391
|
+
# source_field: "FieldName",
|
|
392
|
+
# facet_enabled: false,
|
|
393
|
+
# search_enabled: false,
|
|
394
|
+
# return_enabled: false,
|
|
395
|
+
# sort_enabled: false,
|
|
396
|
+
# },
|
|
397
|
+
# literal_options: {
|
|
398
|
+
# default_value: "FieldValue",
|
|
399
|
+
# source_field: "FieldName",
|
|
400
|
+
# facet_enabled: false,
|
|
401
|
+
# search_enabled: false,
|
|
402
|
+
# return_enabled: false,
|
|
403
|
+
# sort_enabled: false,
|
|
404
|
+
# },
|
|
405
|
+
# text_options: {
|
|
406
|
+
# default_value: "FieldValue",
|
|
407
|
+
# source_field: "FieldName",
|
|
408
|
+
# return_enabled: false,
|
|
409
|
+
# sort_enabled: false,
|
|
410
|
+
# highlight_enabled: false,
|
|
411
|
+
# analysis_scheme: "Word",
|
|
412
|
+
# },
|
|
413
|
+
# date_options: {
|
|
414
|
+
# default_value: "FieldValue",
|
|
415
|
+
# source_field: "FieldName",
|
|
416
|
+
# facet_enabled: false,
|
|
417
|
+
# search_enabled: false,
|
|
418
|
+
# return_enabled: false,
|
|
419
|
+
# sort_enabled: false,
|
|
420
|
+
# },
|
|
421
|
+
# lat_lon_options: {
|
|
422
|
+
# default_value: "FieldValue",
|
|
423
|
+
# source_field: "FieldName",
|
|
424
|
+
# facet_enabled: false,
|
|
425
|
+
# search_enabled: false,
|
|
426
|
+
# return_enabled: false,
|
|
427
|
+
# sort_enabled: false,
|
|
428
|
+
# },
|
|
429
|
+
# int_array_options: {
|
|
430
|
+
# default_value: 1,
|
|
431
|
+
# source_fields: "FieldNameCommaList",
|
|
432
|
+
# facet_enabled: false,
|
|
433
|
+
# search_enabled: false,
|
|
434
|
+
# return_enabled: false,
|
|
435
|
+
# },
|
|
436
|
+
# double_array_options: {
|
|
437
|
+
# default_value: 1.0,
|
|
438
|
+
# source_fields: "FieldNameCommaList",
|
|
439
|
+
# facet_enabled: false,
|
|
440
|
+
# search_enabled: false,
|
|
441
|
+
# return_enabled: false,
|
|
442
|
+
# },
|
|
443
|
+
# literal_array_options: {
|
|
444
|
+
# default_value: "FieldValue",
|
|
445
|
+
# source_fields: "FieldNameCommaList",
|
|
446
|
+
# facet_enabled: false,
|
|
447
|
+
# search_enabled: false,
|
|
448
|
+
# return_enabled: false,
|
|
449
|
+
# },
|
|
450
|
+
# text_array_options: {
|
|
451
|
+
# default_value: "FieldValue",
|
|
452
|
+
# source_fields: "FieldNameCommaList",
|
|
453
|
+
# return_enabled: false,
|
|
454
|
+
# highlight_enabled: false,
|
|
455
|
+
# analysis_scheme: "Word",
|
|
456
|
+
# },
|
|
457
|
+
# date_array_options: {
|
|
458
|
+
# default_value: "FieldValue",
|
|
459
|
+
# source_fields: "FieldNameCommaList",
|
|
460
|
+
# facet_enabled: false,
|
|
461
|
+
# search_enabled: false,
|
|
462
|
+
# return_enabled: false,
|
|
463
|
+
# },
|
|
464
|
+
# },
|
|
465
|
+
# })
|
|
466
|
+
#
|
|
467
|
+
# @example Response structure
|
|
468
|
+
#
|
|
469
|
+
# resp.index_field.options.index_field_name #=> String
|
|
470
|
+
# resp.index_field.options.index_field_type #=> String, one of "int", "double", "literal", "text", "date", "latlon", "int-array", "double-array", "literal-array", "text-array", "date-array"
|
|
471
|
+
# resp.index_field.options.int_options.default_value #=> Integer
|
|
472
|
+
# resp.index_field.options.int_options.source_field #=> String
|
|
473
|
+
# resp.index_field.options.int_options.facet_enabled #=> Boolean
|
|
474
|
+
# resp.index_field.options.int_options.search_enabled #=> Boolean
|
|
475
|
+
# resp.index_field.options.int_options.return_enabled #=> Boolean
|
|
476
|
+
# resp.index_field.options.int_options.sort_enabled #=> Boolean
|
|
477
|
+
# resp.index_field.options.double_options.default_value #=> Float
|
|
478
|
+
# resp.index_field.options.double_options.source_field #=> String
|
|
479
|
+
# resp.index_field.options.double_options.facet_enabled #=> Boolean
|
|
480
|
+
# resp.index_field.options.double_options.search_enabled #=> Boolean
|
|
481
|
+
# resp.index_field.options.double_options.return_enabled #=> Boolean
|
|
482
|
+
# resp.index_field.options.double_options.sort_enabled #=> Boolean
|
|
483
|
+
# resp.index_field.options.literal_options.default_value #=> String
|
|
484
|
+
# resp.index_field.options.literal_options.source_field #=> String
|
|
485
|
+
# resp.index_field.options.literal_options.facet_enabled #=> Boolean
|
|
486
|
+
# resp.index_field.options.literal_options.search_enabled #=> Boolean
|
|
487
|
+
# resp.index_field.options.literal_options.return_enabled #=> Boolean
|
|
488
|
+
# resp.index_field.options.literal_options.sort_enabled #=> Boolean
|
|
489
|
+
# resp.index_field.options.text_options.default_value #=> String
|
|
490
|
+
# resp.index_field.options.text_options.source_field #=> String
|
|
491
|
+
# resp.index_field.options.text_options.return_enabled #=> Boolean
|
|
492
|
+
# resp.index_field.options.text_options.sort_enabled #=> Boolean
|
|
493
|
+
# resp.index_field.options.text_options.highlight_enabled #=> Boolean
|
|
494
|
+
# resp.index_field.options.text_options.analysis_scheme #=> String
|
|
495
|
+
# resp.index_field.options.date_options.default_value #=> String
|
|
496
|
+
# resp.index_field.options.date_options.source_field #=> String
|
|
497
|
+
# resp.index_field.options.date_options.facet_enabled #=> Boolean
|
|
498
|
+
# resp.index_field.options.date_options.search_enabled #=> Boolean
|
|
499
|
+
# resp.index_field.options.date_options.return_enabled #=> Boolean
|
|
500
|
+
# resp.index_field.options.date_options.sort_enabled #=> Boolean
|
|
501
|
+
# resp.index_field.options.lat_lon_options.default_value #=> String
|
|
502
|
+
# resp.index_field.options.lat_lon_options.source_field #=> String
|
|
503
|
+
# resp.index_field.options.lat_lon_options.facet_enabled #=> Boolean
|
|
504
|
+
# resp.index_field.options.lat_lon_options.search_enabled #=> Boolean
|
|
505
|
+
# resp.index_field.options.lat_lon_options.return_enabled #=> Boolean
|
|
506
|
+
# resp.index_field.options.lat_lon_options.sort_enabled #=> Boolean
|
|
507
|
+
# resp.index_field.options.int_array_options.default_value #=> Integer
|
|
508
|
+
# resp.index_field.options.int_array_options.source_fields #=> String
|
|
509
|
+
# resp.index_field.options.int_array_options.facet_enabled #=> Boolean
|
|
510
|
+
# resp.index_field.options.int_array_options.search_enabled #=> Boolean
|
|
511
|
+
# resp.index_field.options.int_array_options.return_enabled #=> Boolean
|
|
512
|
+
# resp.index_field.options.double_array_options.default_value #=> Float
|
|
513
|
+
# resp.index_field.options.double_array_options.source_fields #=> String
|
|
514
|
+
# resp.index_field.options.double_array_options.facet_enabled #=> Boolean
|
|
515
|
+
# resp.index_field.options.double_array_options.search_enabled #=> Boolean
|
|
516
|
+
# resp.index_field.options.double_array_options.return_enabled #=> Boolean
|
|
517
|
+
# resp.index_field.options.literal_array_options.default_value #=> String
|
|
518
|
+
# resp.index_field.options.literal_array_options.source_fields #=> String
|
|
519
|
+
# resp.index_field.options.literal_array_options.facet_enabled #=> Boolean
|
|
520
|
+
# resp.index_field.options.literal_array_options.search_enabled #=> Boolean
|
|
521
|
+
# resp.index_field.options.literal_array_options.return_enabled #=> Boolean
|
|
522
|
+
# resp.index_field.options.text_array_options.default_value #=> String
|
|
523
|
+
# resp.index_field.options.text_array_options.source_fields #=> String
|
|
524
|
+
# resp.index_field.options.text_array_options.return_enabled #=> Boolean
|
|
525
|
+
# resp.index_field.options.text_array_options.highlight_enabled #=> Boolean
|
|
526
|
+
# resp.index_field.options.text_array_options.analysis_scheme #=> String
|
|
527
|
+
# resp.index_field.options.date_array_options.default_value #=> String
|
|
528
|
+
# resp.index_field.options.date_array_options.source_fields #=> String
|
|
529
|
+
# resp.index_field.options.date_array_options.facet_enabled #=> Boolean
|
|
530
|
+
# resp.index_field.options.date_array_options.search_enabled #=> Boolean
|
|
531
|
+
# resp.index_field.options.date_array_options.return_enabled #=> Boolean
|
|
532
|
+
# resp.index_field.status.creation_date #=> Time
|
|
533
|
+
# resp.index_field.status.update_date #=> Time
|
|
534
|
+
# resp.index_field.status.update_version #=> Integer
|
|
535
|
+
# resp.index_field.status.state #=> String, one of "RequiresIndexDocuments", "Processing", "Active", "FailedToValidate"
|
|
536
|
+
# resp.index_field.status.pending_deletion #=> Boolean
|
|
537
|
+
#
|
|
538
|
+
# @overload define_index_field(params = {})
|
|
539
|
+
# @param [Hash] params ({})
|
|
540
|
+
def define_index_field(params = {}, options = {})
|
|
541
|
+
req = build_request(:define_index_field, params)
|
|
542
|
+
req.send_request(options)
|
|
543
|
+
end
|
|
555
544
|
|
|
556
|
-
|
|
557
|
-
|
|
558
|
-
|
|
559
|
-
|
|
560
|
-
|
|
561
|
-
|
|
562
|
-
|
|
563
|
-
|
|
564
|
-
|
|
565
|
-
|
|
566
|
-
|
|
567
|
-
|
|
568
|
-
|
|
569
|
-
|
|
570
|
-
|
|
571
|
-
|
|
572
|
-
|
|
573
|
-
|
|
574
|
-
|
|
575
|
-
|
|
576
|
-
|
|
577
|
-
|
|
578
|
-
|
|
579
|
-
|
|
580
|
-
|
|
581
|
-
|
|
582
|
-
|
|
583
|
-
|
|
584
|
-
|
|
585
|
-
|
|
586
|
-
|
|
587
|
-
|
|
588
|
-
|
|
589
|
-
|
|
590
|
-
|
|
591
|
-
|
|
592
|
-
|
|
593
|
-
|
|
594
|
-
|
|
595
|
-
|
|
596
|
-
|
|
597
|
-
|
|
545
|
+
# Configures a suggester for a domain. A suggester enables you to
|
|
546
|
+
# display possible matches before users finish typing their queries.
|
|
547
|
+
# When you configure a suggester, you must specify the name of the text
|
|
548
|
+
# field you want to search for possible matches and a unique name for
|
|
549
|
+
# the suggester. For more information, see [Getting Search
|
|
550
|
+
# Suggestions][1] in the *Amazon CloudSearch Developer Guide*.
|
|
551
|
+
#
|
|
552
|
+
#
|
|
553
|
+
#
|
|
554
|
+
# [1]: http://docs.aws.amazon.com/cloudsearch/latest/developerguide/getting-suggestions.html
|
|
555
|
+
#
|
|
556
|
+
# @option params [required, String] :domain_name
|
|
557
|
+
# A string that represents the name of a domain. Domain names are unique
|
|
558
|
+
# across the domains owned by an account within an AWS region. Domain
|
|
559
|
+
# names start with a letter or number and can contain the following
|
|
560
|
+
# characters: a-z (lowercase), 0-9, and - (hyphen).
|
|
561
|
+
#
|
|
562
|
+
# @option params [required, Types::Suggester] :suggester
|
|
563
|
+
# Configuration information for a search suggester. Each suggester has a
|
|
564
|
+
# unique name and specifies the text field you want to use for
|
|
565
|
+
# suggestions. The following options can be configured for a suggester:
|
|
566
|
+
# `FuzzyMatching`, `SortExpression`.
|
|
567
|
+
#
|
|
568
|
+
# @return [Types::DefineSuggesterResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
|
569
|
+
#
|
|
570
|
+
# * {Types::DefineSuggesterResponse#suggester #suggester} => Types::SuggesterStatus
|
|
571
|
+
#
|
|
572
|
+
# @example Request syntax with placeholder values
|
|
573
|
+
#
|
|
574
|
+
# resp = client.define_suggester({
|
|
575
|
+
# domain_name: "DomainName", # required
|
|
576
|
+
# suggester: { # required
|
|
577
|
+
# suggester_name: "StandardName", # required
|
|
578
|
+
# document_suggester_options: { # required
|
|
579
|
+
# source_field: "FieldName", # required
|
|
580
|
+
# fuzzy_matching: "none", # accepts none, low, high
|
|
581
|
+
# sort_expression: "String",
|
|
582
|
+
# },
|
|
583
|
+
# },
|
|
584
|
+
# })
|
|
585
|
+
#
|
|
586
|
+
# @example Response structure
|
|
587
|
+
#
|
|
588
|
+
# resp.suggester.options.suggester_name #=> String
|
|
589
|
+
# resp.suggester.options.document_suggester_options.source_field #=> String
|
|
590
|
+
# resp.suggester.options.document_suggester_options.fuzzy_matching #=> String, one of "none", "low", "high"
|
|
591
|
+
# resp.suggester.options.document_suggester_options.sort_expression #=> String
|
|
592
|
+
# resp.suggester.status.creation_date #=> Time
|
|
593
|
+
# resp.suggester.status.update_date #=> Time
|
|
594
|
+
# resp.suggester.status.update_version #=> Integer
|
|
595
|
+
# resp.suggester.status.state #=> String, one of "RequiresIndexDocuments", "Processing", "Active", "FailedToValidate"
|
|
596
|
+
# resp.suggester.status.pending_deletion #=> Boolean
|
|
597
|
+
#
|
|
598
|
+
# @overload define_suggester(params = {})
|
|
599
|
+
# @param [Hash] params ({})
|
|
600
|
+
def define_suggester(params = {}, options = {})
|
|
601
|
+
req = build_request(:define_suggester, params)
|
|
602
|
+
req.send_request(options)
|
|
603
|
+
end
|
|
598
604
|
|
|
599
|
-
|
|
600
|
-
|
|
601
|
-
|
|
602
|
-
|
|
603
|
-
|
|
604
|
-
|
|
605
|
-
|
|
606
|
-
|
|
607
|
-
|
|
608
|
-
|
|
609
|
-
|
|
610
|
-
|
|
611
|
-
|
|
612
|
-
|
|
613
|
-
|
|
614
|
-
|
|
615
|
-
|
|
616
|
-
|
|
617
|
-
|
|
618
|
-
|
|
619
|
-
|
|
620
|
-
|
|
621
|
-
|
|
622
|
-
|
|
623
|
-
|
|
624
|
-
|
|
625
|
-
|
|
626
|
-
|
|
627
|
-
|
|
628
|
-
|
|
629
|
-
|
|
630
|
-
|
|
631
|
-
|
|
632
|
-
|
|
633
|
-
|
|
634
|
-
|
|
635
|
-
|
|
636
|
-
|
|
637
|
-
|
|
638
|
-
|
|
605
|
+
# Deletes an analysis scheme. For more information, see [Configuring
|
|
606
|
+
# Analysis Schemes][1] in the *Amazon CloudSearch Developer Guide*.
|
|
607
|
+
#
|
|
608
|
+
#
|
|
609
|
+
#
|
|
610
|
+
# [1]: http://docs.aws.amazon.com/cloudsearch/latest/developerguide/configuring-analysis-schemes.html
|
|
611
|
+
#
|
|
612
|
+
# @option params [required, String] :domain_name
|
|
613
|
+
# A string that represents the name of a domain. Domain names are unique
|
|
614
|
+
# across the domains owned by an account within an AWS region. Domain
|
|
615
|
+
# names start with a letter or number and can contain the following
|
|
616
|
+
# characters: a-z (lowercase), 0-9, and - (hyphen).
|
|
617
|
+
#
|
|
618
|
+
# @option params [required, String] :analysis_scheme_name
|
|
619
|
+
# The name of the analysis scheme you want to delete.
|
|
620
|
+
#
|
|
621
|
+
# @return [Types::DeleteAnalysisSchemeResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
|
622
|
+
#
|
|
623
|
+
# * {Types::DeleteAnalysisSchemeResponse#analysis_scheme #analysis_scheme} => Types::AnalysisSchemeStatus
|
|
624
|
+
#
|
|
625
|
+
# @example Request syntax with placeholder values
|
|
626
|
+
#
|
|
627
|
+
# resp = client.delete_analysis_scheme({
|
|
628
|
+
# domain_name: "DomainName", # required
|
|
629
|
+
# analysis_scheme_name: "StandardName", # required
|
|
630
|
+
# })
|
|
631
|
+
#
|
|
632
|
+
# @example Response structure
|
|
633
|
+
#
|
|
634
|
+
# resp.analysis_scheme.options.analysis_scheme_name #=> String
|
|
635
|
+
# resp.analysis_scheme.options.analysis_scheme_language #=> String, one of "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"
|
|
636
|
+
# resp.analysis_scheme.options.analysis_options.synonyms #=> String
|
|
637
|
+
# resp.analysis_scheme.options.analysis_options.stopwords #=> String
|
|
638
|
+
# resp.analysis_scheme.options.analysis_options.stemming_dictionary #=> String
|
|
639
|
+
# resp.analysis_scheme.options.analysis_options.japanese_tokenization_dictionary #=> String
|
|
640
|
+
# resp.analysis_scheme.options.analysis_options.algorithmic_stemming #=> String, one of "none", "minimal", "light", "full"
|
|
641
|
+
# resp.analysis_scheme.status.creation_date #=> Time
|
|
642
|
+
# resp.analysis_scheme.status.update_date #=> Time
|
|
643
|
+
# resp.analysis_scheme.status.update_version #=> Integer
|
|
644
|
+
# resp.analysis_scheme.status.state #=> String, one of "RequiresIndexDocuments", "Processing", "Active", "FailedToValidate"
|
|
645
|
+
# resp.analysis_scheme.status.pending_deletion #=> Boolean
|
|
646
|
+
#
|
|
647
|
+
# @overload delete_analysis_scheme(params = {})
|
|
648
|
+
# @param [Hash] params ({})
|
|
649
|
+
def delete_analysis_scheme(params = {}, options = {})
|
|
650
|
+
req = build_request(:delete_analysis_scheme, params)
|
|
651
|
+
req.send_request(options)
|
|
652
|
+
end
|
|
639
653
|
|
|
640
|
-
|
|
641
|
-
|
|
642
|
-
|
|
643
|
-
|
|
644
|
-
|
|
645
|
-
|
|
646
|
-
|
|
647
|
-
|
|
648
|
-
|
|
649
|
-
|
|
650
|
-
|
|
651
|
-
|
|
652
|
-
|
|
653
|
-
|
|
654
|
-
|
|
655
|
-
|
|
656
|
-
|
|
657
|
-
|
|
658
|
-
|
|
659
|
-
|
|
660
|
-
|
|
661
|
-
|
|
662
|
-
|
|
663
|
-
|
|
664
|
-
|
|
665
|
-
|
|
666
|
-
|
|
667
|
-
|
|
668
|
-
|
|
669
|
-
|
|
670
|
-
|
|
671
|
-
|
|
672
|
-
|
|
673
|
-
|
|
674
|
-
|
|
675
|
-
|
|
676
|
-
|
|
677
|
-
|
|
654
|
+
# Permanently deletes a search domain and all of its data. Once a domain
|
|
655
|
+
# has been deleted, it cannot be recovered. For more information, see
|
|
656
|
+
# [Deleting a Search Domain][1] in the *Amazon CloudSearch Developer
|
|
657
|
+
# Guide*.
|
|
658
|
+
#
|
|
659
|
+
#
|
|
660
|
+
#
|
|
661
|
+
# [1]: http://docs.aws.amazon.com/cloudsearch/latest/developerguide/deleting-domains.html
|
|
662
|
+
#
|
|
663
|
+
# @option params [required, String] :domain_name
|
|
664
|
+
# The name of the domain you want to permanently delete.
|
|
665
|
+
#
|
|
666
|
+
# @return [Types::DeleteDomainResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
|
667
|
+
#
|
|
668
|
+
# * {Types::DeleteDomainResponse#domain_status #domain_status} => Types::DomainStatus
|
|
669
|
+
#
|
|
670
|
+
# @example Request syntax with placeholder values
|
|
671
|
+
#
|
|
672
|
+
# resp = client.delete_domain({
|
|
673
|
+
# domain_name: "DomainName", # required
|
|
674
|
+
# })
|
|
675
|
+
#
|
|
676
|
+
# @example Response structure
|
|
677
|
+
#
|
|
678
|
+
# resp.domain_status.domain_id #=> String
|
|
679
|
+
# resp.domain_status.domain_name #=> String
|
|
680
|
+
# resp.domain_status.arn #=> String
|
|
681
|
+
# resp.domain_status.created #=> Boolean
|
|
682
|
+
# resp.domain_status.deleted #=> Boolean
|
|
683
|
+
# resp.domain_status.doc_service.endpoint #=> String
|
|
684
|
+
# resp.domain_status.search_service.endpoint #=> String
|
|
685
|
+
# resp.domain_status.requires_index_documents #=> Boolean
|
|
686
|
+
# resp.domain_status.processing #=> Boolean
|
|
687
|
+
# resp.domain_status.search_instance_type #=> String
|
|
688
|
+
# resp.domain_status.search_partition_count #=> Integer
|
|
689
|
+
# resp.domain_status.search_instance_count #=> Integer
|
|
690
|
+
# resp.domain_status.limits.maximum_replication_count #=> Integer
|
|
691
|
+
# resp.domain_status.limits.maximum_partition_count #=> Integer
|
|
692
|
+
#
|
|
693
|
+
# @overload delete_domain(params = {})
|
|
694
|
+
# @param [Hash] params ({})
|
|
695
|
+
def delete_domain(params = {}, options = {})
|
|
696
|
+
req = build_request(:delete_domain, params)
|
|
697
|
+
req.send_request(options)
|
|
698
|
+
end
|
|
678
699
|
|
|
679
|
-
|
|
680
|
-
|
|
681
|
-
|
|
682
|
-
|
|
683
|
-
|
|
684
|
-
|
|
685
|
-
|
|
686
|
-
|
|
687
|
-
|
|
688
|
-
|
|
689
|
-
|
|
690
|
-
|
|
691
|
-
|
|
692
|
-
|
|
693
|
-
|
|
694
|
-
|
|
695
|
-
|
|
696
|
-
|
|
697
|
-
|
|
698
|
-
|
|
699
|
-
|
|
700
|
-
|
|
701
|
-
|
|
702
|
-
|
|
703
|
-
|
|
704
|
-
|
|
705
|
-
|
|
706
|
-
|
|
707
|
-
|
|
708
|
-
|
|
709
|
-
|
|
710
|
-
|
|
711
|
-
|
|
712
|
-
|
|
713
|
-
|
|
714
|
-
|
|
715
|
-
|
|
716
|
-
|
|
717
|
-
|
|
718
|
-
|
|
719
|
-
|
|
720
|
-
|
|
721
|
-
|
|
722
|
-
|
|
723
|
-
# resp.index_field.options.literal_options.return_enabled #=> Boolean
|
|
724
|
-
# resp.index_field.options.literal_options.sort_enabled #=> Boolean
|
|
725
|
-
# resp.index_field.options.text_options.default_value #=> String
|
|
726
|
-
# resp.index_field.options.text_options.source_field #=> String
|
|
727
|
-
# resp.index_field.options.text_options.return_enabled #=> Boolean
|
|
728
|
-
# resp.index_field.options.text_options.sort_enabled #=> Boolean
|
|
729
|
-
# resp.index_field.options.text_options.highlight_enabled #=> Boolean
|
|
730
|
-
# resp.index_field.options.text_options.analysis_scheme #=> String
|
|
731
|
-
# resp.index_field.options.date_options.default_value #=> String
|
|
732
|
-
# resp.index_field.options.date_options.source_field #=> String
|
|
733
|
-
# resp.index_field.options.date_options.facet_enabled #=> Boolean
|
|
734
|
-
# resp.index_field.options.date_options.search_enabled #=> Boolean
|
|
735
|
-
# resp.index_field.options.date_options.return_enabled #=> Boolean
|
|
736
|
-
# resp.index_field.options.date_options.sort_enabled #=> Boolean
|
|
737
|
-
# resp.index_field.options.lat_lon_options.default_value #=> String
|
|
738
|
-
# resp.index_field.options.lat_lon_options.source_field #=> String
|
|
739
|
-
# resp.index_field.options.lat_lon_options.facet_enabled #=> Boolean
|
|
740
|
-
# resp.index_field.options.lat_lon_options.search_enabled #=> Boolean
|
|
741
|
-
# resp.index_field.options.lat_lon_options.return_enabled #=> Boolean
|
|
742
|
-
# resp.index_field.options.lat_lon_options.sort_enabled #=> Boolean
|
|
743
|
-
# resp.index_field.options.int_array_options.default_value #=> Integer
|
|
744
|
-
# resp.index_field.options.int_array_options.source_fields #=> String
|
|
745
|
-
# resp.index_field.options.int_array_options.facet_enabled #=> Boolean
|
|
746
|
-
# resp.index_field.options.int_array_options.search_enabled #=> Boolean
|
|
747
|
-
# resp.index_field.options.int_array_options.return_enabled #=> Boolean
|
|
748
|
-
# resp.index_field.options.double_array_options.default_value #=> Float
|
|
749
|
-
# resp.index_field.options.double_array_options.source_fields #=> String
|
|
750
|
-
# resp.index_field.options.double_array_options.facet_enabled #=> Boolean
|
|
751
|
-
# resp.index_field.options.double_array_options.search_enabled #=> Boolean
|
|
752
|
-
# resp.index_field.options.double_array_options.return_enabled #=> Boolean
|
|
753
|
-
# resp.index_field.options.literal_array_options.default_value #=> String
|
|
754
|
-
# resp.index_field.options.literal_array_options.source_fields #=> String
|
|
755
|
-
# resp.index_field.options.literal_array_options.facet_enabled #=> Boolean
|
|
756
|
-
# resp.index_field.options.literal_array_options.search_enabled #=> Boolean
|
|
757
|
-
# resp.index_field.options.literal_array_options.return_enabled #=> Boolean
|
|
758
|
-
# resp.index_field.options.text_array_options.default_value #=> String
|
|
759
|
-
# resp.index_field.options.text_array_options.source_fields #=> String
|
|
760
|
-
# resp.index_field.options.text_array_options.return_enabled #=> Boolean
|
|
761
|
-
# resp.index_field.options.text_array_options.highlight_enabled #=> Boolean
|
|
762
|
-
# resp.index_field.options.text_array_options.analysis_scheme #=> String
|
|
763
|
-
# resp.index_field.options.date_array_options.default_value #=> String
|
|
764
|
-
# resp.index_field.options.date_array_options.source_fields #=> String
|
|
765
|
-
# resp.index_field.options.date_array_options.facet_enabled #=> Boolean
|
|
766
|
-
# resp.index_field.options.date_array_options.search_enabled #=> Boolean
|
|
767
|
-
# resp.index_field.options.date_array_options.return_enabled #=> Boolean
|
|
768
|
-
# resp.index_field.status.creation_date #=> Time
|
|
769
|
-
# resp.index_field.status.update_date #=> Time
|
|
770
|
-
# resp.index_field.status.update_version #=> Integer
|
|
771
|
-
# resp.index_field.status.state #=> String, one of "RequiresIndexDocuments", "Processing", "Active", "FailedToValidate"
|
|
772
|
-
# resp.index_field.status.pending_deletion #=> Boolean
|
|
773
|
-
# @overload delete_index_field(params = {})
|
|
774
|
-
# @param [Hash] params ({})
|
|
775
|
-
def delete_index_field(params = {}, options = {})
|
|
776
|
-
req = build_request(:delete_index_field, params)
|
|
777
|
-
req.send_request(options)
|
|
778
|
-
end
|
|
700
|
+
# Removes an `Expression` from the search domain. For more information,
|
|
701
|
+
# see [Configuring Expressions][1] in the *Amazon CloudSearch Developer
|
|
702
|
+
# Guide*.
|
|
703
|
+
#
|
|
704
|
+
#
|
|
705
|
+
#
|
|
706
|
+
# [1]: http://docs.aws.amazon.com/cloudsearch/latest/developerguide/configuring-expressions.html
|
|
707
|
+
#
|
|
708
|
+
# @option params [required, String] :domain_name
|
|
709
|
+
# A string that represents the name of a domain. Domain names are unique
|
|
710
|
+
# across the domains owned by an account within an AWS region. Domain
|
|
711
|
+
# names start with a letter or number and can contain the following
|
|
712
|
+
# characters: a-z (lowercase), 0-9, and - (hyphen).
|
|
713
|
+
#
|
|
714
|
+
# @option params [required, String] :expression_name
|
|
715
|
+
# The name of the `Expression` to delete.
|
|
716
|
+
#
|
|
717
|
+
# @return [Types::DeleteExpressionResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
|
718
|
+
#
|
|
719
|
+
# * {Types::DeleteExpressionResponse#expression #expression} => Types::ExpressionStatus
|
|
720
|
+
#
|
|
721
|
+
# @example Request syntax with placeholder values
|
|
722
|
+
#
|
|
723
|
+
# resp = client.delete_expression({
|
|
724
|
+
# domain_name: "DomainName", # required
|
|
725
|
+
# expression_name: "StandardName", # required
|
|
726
|
+
# })
|
|
727
|
+
#
|
|
728
|
+
# @example Response structure
|
|
729
|
+
#
|
|
730
|
+
# resp.expression.options.expression_name #=> String
|
|
731
|
+
# resp.expression.options.expression_value #=> String
|
|
732
|
+
# resp.expression.status.creation_date #=> Time
|
|
733
|
+
# resp.expression.status.update_date #=> Time
|
|
734
|
+
# resp.expression.status.update_version #=> Integer
|
|
735
|
+
# resp.expression.status.state #=> String, one of "RequiresIndexDocuments", "Processing", "Active", "FailedToValidate"
|
|
736
|
+
# resp.expression.status.pending_deletion #=> Boolean
|
|
737
|
+
#
|
|
738
|
+
# @overload delete_expression(params = {})
|
|
739
|
+
# @param [Hash] params ({})
|
|
740
|
+
def delete_expression(params = {}, options = {})
|
|
741
|
+
req = build_request(:delete_expression, params)
|
|
742
|
+
req.send_request(options)
|
|
743
|
+
end
|
|
779
744
|
|
|
780
|
-
|
|
781
|
-
|
|
782
|
-
|
|
783
|
-
|
|
784
|
-
|
|
785
|
-
|
|
786
|
-
|
|
787
|
-
|
|
788
|
-
|
|
789
|
-
|
|
790
|
-
|
|
791
|
-
|
|
792
|
-
|
|
793
|
-
|
|
794
|
-
|
|
795
|
-
|
|
796
|
-
|
|
797
|
-
|
|
798
|
-
|
|
799
|
-
|
|
800
|
-
|
|
801
|
-
|
|
802
|
-
|
|
803
|
-
|
|
804
|
-
|
|
805
|
-
|
|
806
|
-
|
|
807
|
-
|
|
808
|
-
|
|
809
|
-
|
|
810
|
-
|
|
811
|
-
|
|
812
|
-
|
|
813
|
-
|
|
814
|
-
|
|
815
|
-
|
|
816
|
-
|
|
817
|
-
|
|
818
|
-
|
|
745
|
+
# Removes an `IndexField` from the search domain. For more information,
|
|
746
|
+
# see [Configuring Index Fields][1] in the *Amazon CloudSearch Developer
|
|
747
|
+
# Guide*.
|
|
748
|
+
#
|
|
749
|
+
#
|
|
750
|
+
#
|
|
751
|
+
# [1]: http://docs.aws.amazon.com/cloudsearch/latest/developerguide/configuring-index-fields.html
|
|
752
|
+
#
|
|
753
|
+
# @option params [required, String] :domain_name
|
|
754
|
+
# A string that represents the name of a domain. Domain names are unique
|
|
755
|
+
# across the domains owned by an account within an AWS region. Domain
|
|
756
|
+
# names start with a letter or number and can contain the following
|
|
757
|
+
# characters: a-z (lowercase), 0-9, and - (hyphen).
|
|
758
|
+
#
|
|
759
|
+
# @option params [required, String] :index_field_name
|
|
760
|
+
# The name of the index field your want to remove from the domain's
|
|
761
|
+
# indexing options.
|
|
762
|
+
#
|
|
763
|
+
# @return [Types::DeleteIndexFieldResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
|
764
|
+
#
|
|
765
|
+
# * {Types::DeleteIndexFieldResponse#index_field #index_field} => Types::IndexFieldStatus
|
|
766
|
+
#
|
|
767
|
+
# @example Request syntax with placeholder values
|
|
768
|
+
#
|
|
769
|
+
# resp = client.delete_index_field({
|
|
770
|
+
# domain_name: "DomainName", # required
|
|
771
|
+
# index_field_name: "DynamicFieldName", # required
|
|
772
|
+
# })
|
|
773
|
+
#
|
|
774
|
+
# @example Response structure
|
|
775
|
+
#
|
|
776
|
+
# resp.index_field.options.index_field_name #=> String
|
|
777
|
+
# resp.index_field.options.index_field_type #=> String, one of "int", "double", "literal", "text", "date", "latlon", "int-array", "double-array", "literal-array", "text-array", "date-array"
|
|
778
|
+
# resp.index_field.options.int_options.default_value #=> Integer
|
|
779
|
+
# resp.index_field.options.int_options.source_field #=> String
|
|
780
|
+
# resp.index_field.options.int_options.facet_enabled #=> Boolean
|
|
781
|
+
# resp.index_field.options.int_options.search_enabled #=> Boolean
|
|
782
|
+
# resp.index_field.options.int_options.return_enabled #=> Boolean
|
|
783
|
+
# resp.index_field.options.int_options.sort_enabled #=> Boolean
|
|
784
|
+
# resp.index_field.options.double_options.default_value #=> Float
|
|
785
|
+
# resp.index_field.options.double_options.source_field #=> String
|
|
786
|
+
# resp.index_field.options.double_options.facet_enabled #=> Boolean
|
|
787
|
+
# resp.index_field.options.double_options.search_enabled #=> Boolean
|
|
788
|
+
# resp.index_field.options.double_options.return_enabled #=> Boolean
|
|
789
|
+
# resp.index_field.options.double_options.sort_enabled #=> Boolean
|
|
790
|
+
# resp.index_field.options.literal_options.default_value #=> String
|
|
791
|
+
# resp.index_field.options.literal_options.source_field #=> String
|
|
792
|
+
# resp.index_field.options.literal_options.facet_enabled #=> Boolean
|
|
793
|
+
# resp.index_field.options.literal_options.search_enabled #=> Boolean
|
|
794
|
+
# resp.index_field.options.literal_options.return_enabled #=> Boolean
|
|
795
|
+
# resp.index_field.options.literal_options.sort_enabled #=> Boolean
|
|
796
|
+
# resp.index_field.options.text_options.default_value #=> String
|
|
797
|
+
# resp.index_field.options.text_options.source_field #=> String
|
|
798
|
+
# resp.index_field.options.text_options.return_enabled #=> Boolean
|
|
799
|
+
# resp.index_field.options.text_options.sort_enabled #=> Boolean
|
|
800
|
+
# resp.index_field.options.text_options.highlight_enabled #=> Boolean
|
|
801
|
+
# resp.index_field.options.text_options.analysis_scheme #=> String
|
|
802
|
+
# resp.index_field.options.date_options.default_value #=> String
|
|
803
|
+
# resp.index_field.options.date_options.source_field #=> String
|
|
804
|
+
# resp.index_field.options.date_options.facet_enabled #=> Boolean
|
|
805
|
+
# resp.index_field.options.date_options.search_enabled #=> Boolean
|
|
806
|
+
# resp.index_field.options.date_options.return_enabled #=> Boolean
|
|
807
|
+
# resp.index_field.options.date_options.sort_enabled #=> Boolean
|
|
808
|
+
# resp.index_field.options.lat_lon_options.default_value #=> String
|
|
809
|
+
# resp.index_field.options.lat_lon_options.source_field #=> String
|
|
810
|
+
# resp.index_field.options.lat_lon_options.facet_enabled #=> Boolean
|
|
811
|
+
# resp.index_field.options.lat_lon_options.search_enabled #=> Boolean
|
|
812
|
+
# resp.index_field.options.lat_lon_options.return_enabled #=> Boolean
|
|
813
|
+
# resp.index_field.options.lat_lon_options.sort_enabled #=> Boolean
|
|
814
|
+
# resp.index_field.options.int_array_options.default_value #=> Integer
|
|
815
|
+
# resp.index_field.options.int_array_options.source_fields #=> String
|
|
816
|
+
# resp.index_field.options.int_array_options.facet_enabled #=> Boolean
|
|
817
|
+
# resp.index_field.options.int_array_options.search_enabled #=> Boolean
|
|
818
|
+
# resp.index_field.options.int_array_options.return_enabled #=> Boolean
|
|
819
|
+
# resp.index_field.options.double_array_options.default_value #=> Float
|
|
820
|
+
# resp.index_field.options.double_array_options.source_fields #=> String
|
|
821
|
+
# resp.index_field.options.double_array_options.facet_enabled #=> Boolean
|
|
822
|
+
# resp.index_field.options.double_array_options.search_enabled #=> Boolean
|
|
823
|
+
# resp.index_field.options.double_array_options.return_enabled #=> Boolean
|
|
824
|
+
# resp.index_field.options.literal_array_options.default_value #=> String
|
|
825
|
+
# resp.index_field.options.literal_array_options.source_fields #=> String
|
|
826
|
+
# resp.index_field.options.literal_array_options.facet_enabled #=> Boolean
|
|
827
|
+
# resp.index_field.options.literal_array_options.search_enabled #=> Boolean
|
|
828
|
+
# resp.index_field.options.literal_array_options.return_enabled #=> Boolean
|
|
829
|
+
# resp.index_field.options.text_array_options.default_value #=> String
|
|
830
|
+
# resp.index_field.options.text_array_options.source_fields #=> String
|
|
831
|
+
# resp.index_field.options.text_array_options.return_enabled #=> Boolean
|
|
832
|
+
# resp.index_field.options.text_array_options.highlight_enabled #=> Boolean
|
|
833
|
+
# resp.index_field.options.text_array_options.analysis_scheme #=> String
|
|
834
|
+
# resp.index_field.options.date_array_options.default_value #=> String
|
|
835
|
+
# resp.index_field.options.date_array_options.source_fields #=> String
|
|
836
|
+
# resp.index_field.options.date_array_options.facet_enabled #=> Boolean
|
|
837
|
+
# resp.index_field.options.date_array_options.search_enabled #=> Boolean
|
|
838
|
+
# resp.index_field.options.date_array_options.return_enabled #=> Boolean
|
|
839
|
+
# resp.index_field.status.creation_date #=> Time
|
|
840
|
+
# resp.index_field.status.update_date #=> Time
|
|
841
|
+
# resp.index_field.status.update_version #=> Integer
|
|
842
|
+
# resp.index_field.status.state #=> String, one of "RequiresIndexDocuments", "Processing", "Active", "FailedToValidate"
|
|
843
|
+
# resp.index_field.status.pending_deletion #=> Boolean
|
|
844
|
+
#
|
|
845
|
+
# @overload delete_index_field(params = {})
|
|
846
|
+
# @param [Hash] params ({})
|
|
847
|
+
def delete_index_field(params = {}, options = {})
|
|
848
|
+
req = build_request(:delete_index_field, params)
|
|
849
|
+
req.send_request(options)
|
|
850
|
+
end
|
|
819
851
|
|
|
820
|
-
|
|
821
|
-
|
|
822
|
-
|
|
823
|
-
|
|
824
|
-
|
|
825
|
-
|
|
826
|
-
|
|
827
|
-
|
|
828
|
-
|
|
829
|
-
|
|
830
|
-
|
|
831
|
-
|
|
832
|
-
|
|
833
|
-
|
|
834
|
-
|
|
835
|
-
|
|
836
|
-
|
|
837
|
-
|
|
838
|
-
|
|
839
|
-
|
|
840
|
-
|
|
841
|
-
|
|
842
|
-
|
|
843
|
-
|
|
844
|
-
|
|
845
|
-
|
|
846
|
-
|
|
847
|
-
|
|
848
|
-
|
|
849
|
-
|
|
850
|
-
|
|
851
|
-
|
|
852
|
-
|
|
853
|
-
|
|
854
|
-
|
|
855
|
-
|
|
856
|
-
|
|
857
|
-
|
|
858
|
-
|
|
859
|
-
|
|
860
|
-
|
|
861
|
-
|
|
862
|
-
|
|
863
|
-
|
|
864
|
-
|
|
865
|
-
# @param [Hash] params ({})
|
|
866
|
-
def describe_analysis_schemes(params = {}, options = {})
|
|
867
|
-
req = build_request(:describe_analysis_schemes, params)
|
|
868
|
-
req.send_request(options)
|
|
869
|
-
end
|
|
852
|
+
# Deletes a suggester. For more information, see [Getting Search
|
|
853
|
+
# Suggestions][1] in the *Amazon CloudSearch Developer Guide*.
|
|
854
|
+
#
|
|
855
|
+
#
|
|
856
|
+
#
|
|
857
|
+
# [1]: http://docs.aws.amazon.com/cloudsearch/latest/developerguide/getting-suggestions.html
|
|
858
|
+
#
|
|
859
|
+
# @option params [required, String] :domain_name
|
|
860
|
+
# A string that represents the name of a domain. Domain names are unique
|
|
861
|
+
# across the domains owned by an account within an AWS region. Domain
|
|
862
|
+
# names start with a letter or number and can contain the following
|
|
863
|
+
# characters: a-z (lowercase), 0-9, and - (hyphen).
|
|
864
|
+
#
|
|
865
|
+
# @option params [required, String] :suggester_name
|
|
866
|
+
# Specifies the name of the suggester you want to delete.
|
|
867
|
+
#
|
|
868
|
+
# @return [Types::DeleteSuggesterResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
|
869
|
+
#
|
|
870
|
+
# * {Types::DeleteSuggesterResponse#suggester #suggester} => Types::SuggesterStatus
|
|
871
|
+
#
|
|
872
|
+
# @example Request syntax with placeholder values
|
|
873
|
+
#
|
|
874
|
+
# resp = client.delete_suggester({
|
|
875
|
+
# domain_name: "DomainName", # required
|
|
876
|
+
# suggester_name: "StandardName", # required
|
|
877
|
+
# })
|
|
878
|
+
#
|
|
879
|
+
# @example Response structure
|
|
880
|
+
#
|
|
881
|
+
# resp.suggester.options.suggester_name #=> String
|
|
882
|
+
# resp.suggester.options.document_suggester_options.source_field #=> String
|
|
883
|
+
# resp.suggester.options.document_suggester_options.fuzzy_matching #=> String, one of "none", "low", "high"
|
|
884
|
+
# resp.suggester.options.document_suggester_options.sort_expression #=> String
|
|
885
|
+
# resp.suggester.status.creation_date #=> Time
|
|
886
|
+
# resp.suggester.status.update_date #=> Time
|
|
887
|
+
# resp.suggester.status.update_version #=> Integer
|
|
888
|
+
# resp.suggester.status.state #=> String, one of "RequiresIndexDocuments", "Processing", "Active", "FailedToValidate"
|
|
889
|
+
# resp.suggester.status.pending_deletion #=> Boolean
|
|
890
|
+
#
|
|
891
|
+
# @overload delete_suggester(params = {})
|
|
892
|
+
# @param [Hash] params ({})
|
|
893
|
+
def delete_suggester(params = {}, options = {})
|
|
894
|
+
req = build_request(:delete_suggester, params)
|
|
895
|
+
req.send_request(options)
|
|
896
|
+
end
|
|
870
897
|
|
|
871
|
-
|
|
872
|
-
|
|
873
|
-
|
|
874
|
-
|
|
875
|
-
|
|
876
|
-
|
|
877
|
-
|
|
878
|
-
|
|
879
|
-
|
|
880
|
-
|
|
881
|
-
|
|
882
|
-
|
|
883
|
-
|
|
884
|
-
|
|
885
|
-
|
|
886
|
-
|
|
887
|
-
|
|
888
|
-
|
|
889
|
-
|
|
890
|
-
|
|
891
|
-
|
|
892
|
-
|
|
893
|
-
|
|
894
|
-
|
|
895
|
-
|
|
896
|
-
|
|
897
|
-
|
|
898
|
-
|
|
899
|
-
|
|
900
|
-
|
|
901
|
-
|
|
902
|
-
|
|
903
|
-
|
|
904
|
-
|
|
905
|
-
|
|
906
|
-
|
|
907
|
-
|
|
898
|
+
# Gets the analysis schemes configured for a domain. An analysis scheme
|
|
899
|
+
# defines language-specific text processing options for a `text` field.
|
|
900
|
+
# Can be limited to specific analysis schemes by name. By default, shows
|
|
901
|
+
# all analysis schemes and includes any pending changes to the
|
|
902
|
+
# configuration. Set the `Deployed` option to `true` to show the active
|
|
903
|
+
# configuration and exclude pending changes. For more information, see
|
|
904
|
+
# [Configuring Analysis Schemes][1] in the *Amazon CloudSearch Developer
|
|
905
|
+
# Guide*.
|
|
906
|
+
#
|
|
907
|
+
#
|
|
908
|
+
#
|
|
909
|
+
# [1]: http://docs.aws.amazon.com/cloudsearch/latest/developerguide/configuring-analysis-schemes.html
|
|
910
|
+
#
|
|
911
|
+
# @option params [required, String] :domain_name
|
|
912
|
+
# The name of the domain you want to describe.
|
|
913
|
+
#
|
|
914
|
+
# @option params [Array<String>] :analysis_scheme_names
|
|
915
|
+
# The analysis schemes you want to describe.
|
|
916
|
+
#
|
|
917
|
+
# @option params [Boolean] :deployed
|
|
918
|
+
# Whether to display the deployed configuration (`true`) or include any
|
|
919
|
+
# pending changes (`false`). Defaults to `false`.
|
|
920
|
+
#
|
|
921
|
+
# @return [Types::DescribeAnalysisSchemesResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
|
922
|
+
#
|
|
923
|
+
# * {Types::DescribeAnalysisSchemesResponse#analysis_schemes #analysis_schemes} => Array<Types::AnalysisSchemeStatus>
|
|
924
|
+
#
|
|
925
|
+
# @example Request syntax with placeholder values
|
|
926
|
+
#
|
|
927
|
+
# resp = client.describe_analysis_schemes({
|
|
928
|
+
# domain_name: "DomainName", # required
|
|
929
|
+
# analysis_scheme_names: ["StandardName"],
|
|
930
|
+
# deployed: false,
|
|
931
|
+
# })
|
|
932
|
+
#
|
|
933
|
+
# @example Response structure
|
|
934
|
+
#
|
|
935
|
+
# resp.analysis_schemes #=> Array
|
|
936
|
+
# resp.analysis_schemes[0].options.analysis_scheme_name #=> String
|
|
937
|
+
# resp.analysis_schemes[0].options.analysis_scheme_language #=> String, one of "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"
|
|
938
|
+
# resp.analysis_schemes[0].options.analysis_options.synonyms #=> String
|
|
939
|
+
# resp.analysis_schemes[0].options.analysis_options.stopwords #=> String
|
|
940
|
+
# resp.analysis_schemes[0].options.analysis_options.stemming_dictionary #=> String
|
|
941
|
+
# resp.analysis_schemes[0].options.analysis_options.japanese_tokenization_dictionary #=> String
|
|
942
|
+
# resp.analysis_schemes[0].options.analysis_options.algorithmic_stemming #=> String, one of "none", "minimal", "light", "full"
|
|
943
|
+
# resp.analysis_schemes[0].status.creation_date #=> Time
|
|
944
|
+
# resp.analysis_schemes[0].status.update_date #=> Time
|
|
945
|
+
# resp.analysis_schemes[0].status.update_version #=> Integer
|
|
946
|
+
# resp.analysis_schemes[0].status.state #=> String, one of "RequiresIndexDocuments", "Processing", "Active", "FailedToValidate"
|
|
947
|
+
# resp.analysis_schemes[0].status.pending_deletion #=> Boolean
|
|
948
|
+
#
|
|
949
|
+
# @overload describe_analysis_schemes(params = {})
|
|
950
|
+
# @param [Hash] params ({})
|
|
951
|
+
def describe_analysis_schemes(params = {}, options = {})
|
|
952
|
+
req = build_request(:describe_analysis_schemes, params)
|
|
953
|
+
req.send_request(options)
|
|
954
|
+
end
|
|
908
955
|
|
|
909
|
-
|
|
910
|
-
|
|
911
|
-
|
|
912
|
-
|
|
913
|
-
|
|
914
|
-
|
|
915
|
-
|
|
916
|
-
|
|
917
|
-
|
|
918
|
-
|
|
919
|
-
|
|
920
|
-
|
|
921
|
-
|
|
922
|
-
|
|
923
|
-
|
|
924
|
-
|
|
925
|
-
|
|
926
|
-
|
|
927
|
-
|
|
928
|
-
|
|
929
|
-
|
|
930
|
-
|
|
931
|
-
|
|
932
|
-
|
|
933
|
-
|
|
934
|
-
|
|
935
|
-
|
|
936
|
-
|
|
937
|
-
|
|
938
|
-
|
|
939
|
-
|
|
940
|
-
|
|
941
|
-
|
|
942
|
-
|
|
943
|
-
|
|
944
|
-
|
|
945
|
-
|
|
946
|
-
|
|
947
|
-
|
|
948
|
-
|
|
949
|
-
|
|
950
|
-
|
|
951
|
-
|
|
952
|
-
end
|
|
956
|
+
# Gets the availability options configured for a domain. By default,
|
|
957
|
+
# shows the configuration with any pending changes. Set the `Deployed`
|
|
958
|
+
# option to `true` to show the active configuration and exclude pending
|
|
959
|
+
# changes. For more information, see [Configuring Availability
|
|
960
|
+
# Options][1] in the *Amazon CloudSearch Developer Guide*.
|
|
961
|
+
#
|
|
962
|
+
#
|
|
963
|
+
#
|
|
964
|
+
# [1]: http://docs.aws.amazon.com/cloudsearch/latest/developerguide/configuring-availability-options.html
|
|
965
|
+
#
|
|
966
|
+
# @option params [required, String] :domain_name
|
|
967
|
+
# The name of the domain you want to describe.
|
|
968
|
+
#
|
|
969
|
+
# @option params [Boolean] :deployed
|
|
970
|
+
# Whether to display the deployed configuration (`true`) or include any
|
|
971
|
+
# pending changes (`false`). Defaults to `false`.
|
|
972
|
+
#
|
|
973
|
+
# @return [Types::DescribeAvailabilityOptionsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
|
974
|
+
#
|
|
975
|
+
# * {Types::DescribeAvailabilityOptionsResponse#availability_options #availability_options} => Types::AvailabilityOptionsStatus
|
|
976
|
+
#
|
|
977
|
+
# @example Request syntax with placeholder values
|
|
978
|
+
#
|
|
979
|
+
# resp = client.describe_availability_options({
|
|
980
|
+
# domain_name: "DomainName", # required
|
|
981
|
+
# deployed: false,
|
|
982
|
+
# })
|
|
983
|
+
#
|
|
984
|
+
# @example Response structure
|
|
985
|
+
#
|
|
986
|
+
# resp.availability_options.options #=> Boolean
|
|
987
|
+
# resp.availability_options.status.creation_date #=> Time
|
|
988
|
+
# resp.availability_options.status.update_date #=> Time
|
|
989
|
+
# resp.availability_options.status.update_version #=> Integer
|
|
990
|
+
# resp.availability_options.status.state #=> String, one of "RequiresIndexDocuments", "Processing", "Active", "FailedToValidate"
|
|
991
|
+
# resp.availability_options.status.pending_deletion #=> Boolean
|
|
992
|
+
#
|
|
993
|
+
# @overload describe_availability_options(params = {})
|
|
994
|
+
# @param [Hash] params ({})
|
|
995
|
+
def describe_availability_options(params = {}, options = {})
|
|
996
|
+
req = build_request(:describe_availability_options, params)
|
|
997
|
+
req.send_request(options)
|
|
998
|
+
end
|
|
953
999
|
|
|
954
|
-
|
|
955
|
-
|
|
956
|
-
|
|
957
|
-
|
|
958
|
-
|
|
959
|
-
|
|
960
|
-
|
|
961
|
-
|
|
962
|
-
|
|
963
|
-
|
|
964
|
-
|
|
965
|
-
|
|
966
|
-
|
|
967
|
-
|
|
968
|
-
|
|
969
|
-
|
|
970
|
-
|
|
971
|
-
|
|
972
|
-
|
|
973
|
-
|
|
974
|
-
|
|
975
|
-
|
|
976
|
-
|
|
977
|
-
|
|
978
|
-
|
|
979
|
-
|
|
980
|
-
|
|
981
|
-
|
|
982
|
-
|
|
983
|
-
|
|
984
|
-
|
|
985
|
-
|
|
986
|
-
|
|
987
|
-
|
|
988
|
-
|
|
989
|
-
|
|
990
|
-
|
|
991
|
-
|
|
992
|
-
|
|
993
|
-
|
|
994
|
-
|
|
995
|
-
|
|
996
|
-
|
|
997
|
-
|
|
1000
|
+
# Gets information about the search domains owned by this account. Can
|
|
1001
|
+
# be limited to specific domains. Shows all domains by default. To get
|
|
1002
|
+
# the number of searchable documents in a domain, use the console or
|
|
1003
|
+
# submit a `matchall` request to your domain's search endpoint:
|
|
1004
|
+
# `q=matchall&q.parser=structured&size=0`. For more information,
|
|
1005
|
+
# see [Getting Information about a Search Domain][1] in the *Amazon
|
|
1006
|
+
# CloudSearch Developer Guide*.
|
|
1007
|
+
#
|
|
1008
|
+
#
|
|
1009
|
+
#
|
|
1010
|
+
# [1]: http://docs.aws.amazon.com/cloudsearch/latest/developerguide/getting-domain-info.html
|
|
1011
|
+
#
|
|
1012
|
+
# @option params [Array<String>] :domain_names
|
|
1013
|
+
# The names of the domains you want to include in the response.
|
|
1014
|
+
#
|
|
1015
|
+
# @return [Types::DescribeDomainsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
|
1016
|
+
#
|
|
1017
|
+
# * {Types::DescribeDomainsResponse#domain_status_list #domain_status_list} => Array<Types::DomainStatus>
|
|
1018
|
+
#
|
|
1019
|
+
# @example Request syntax with placeholder values
|
|
1020
|
+
#
|
|
1021
|
+
# resp = client.describe_domains({
|
|
1022
|
+
# domain_names: ["DomainName"],
|
|
1023
|
+
# })
|
|
1024
|
+
#
|
|
1025
|
+
# @example Response structure
|
|
1026
|
+
#
|
|
1027
|
+
# resp.domain_status_list #=> Array
|
|
1028
|
+
# resp.domain_status_list[0].domain_id #=> String
|
|
1029
|
+
# resp.domain_status_list[0].domain_name #=> String
|
|
1030
|
+
# resp.domain_status_list[0].arn #=> String
|
|
1031
|
+
# resp.domain_status_list[0].created #=> Boolean
|
|
1032
|
+
# resp.domain_status_list[0].deleted #=> Boolean
|
|
1033
|
+
# resp.domain_status_list[0].doc_service.endpoint #=> String
|
|
1034
|
+
# resp.domain_status_list[0].search_service.endpoint #=> String
|
|
1035
|
+
# resp.domain_status_list[0].requires_index_documents #=> Boolean
|
|
1036
|
+
# resp.domain_status_list[0].processing #=> Boolean
|
|
1037
|
+
# resp.domain_status_list[0].search_instance_type #=> String
|
|
1038
|
+
# resp.domain_status_list[0].search_partition_count #=> Integer
|
|
1039
|
+
# resp.domain_status_list[0].search_instance_count #=> Integer
|
|
1040
|
+
# resp.domain_status_list[0].limits.maximum_replication_count #=> Integer
|
|
1041
|
+
# resp.domain_status_list[0].limits.maximum_partition_count #=> Integer
|
|
1042
|
+
#
|
|
1043
|
+
# @overload describe_domains(params = {})
|
|
1044
|
+
# @param [Hash] params ({})
|
|
1045
|
+
def describe_domains(params = {}, options = {})
|
|
1046
|
+
req = build_request(:describe_domains, params)
|
|
1047
|
+
req.send_request(options)
|
|
1048
|
+
end
|
|
998
1049
|
|
|
999
|
-
|
|
1000
|
-
|
|
1001
|
-
|
|
1002
|
-
|
|
1003
|
-
|
|
1004
|
-
|
|
1005
|
-
|
|
1006
|
-
|
|
1007
|
-
|
|
1008
|
-
|
|
1009
|
-
|
|
1010
|
-
|
|
1011
|
-
|
|
1012
|
-
|
|
1013
|
-
|
|
1014
|
-
|
|
1015
|
-
|
|
1016
|
-
|
|
1017
|
-
|
|
1018
|
-
|
|
1019
|
-
|
|
1020
|
-
|
|
1021
|
-
|
|
1022
|
-
|
|
1023
|
-
|
|
1024
|
-
|
|
1025
|
-
|
|
1026
|
-
|
|
1027
|
-
|
|
1028
|
-
|
|
1029
|
-
|
|
1030
|
-
|
|
1031
|
-
|
|
1032
|
-
|
|
1033
|
-
|
|
1034
|
-
|
|
1035
|
-
|
|
1036
|
-
|
|
1037
|
-
|
|
1038
|
-
|
|
1039
|
-
|
|
1040
|
-
|
|
1041
|
-
|
|
1042
|
-
|
|
1043
|
-
|
|
1044
|
-
|
|
1045
|
-
|
|
1046
|
-
|
|
1047
|
-
|
|
1048
|
-
|
|
1049
|
-
|
|
1050
|
-
# resp.index_fields[0].options.text_options.default_value #=> String
|
|
1051
|
-
# resp.index_fields[0].options.text_options.source_field #=> String
|
|
1052
|
-
# resp.index_fields[0].options.text_options.return_enabled #=> Boolean
|
|
1053
|
-
# resp.index_fields[0].options.text_options.sort_enabled #=> Boolean
|
|
1054
|
-
# resp.index_fields[0].options.text_options.highlight_enabled #=> Boolean
|
|
1055
|
-
# resp.index_fields[0].options.text_options.analysis_scheme #=> String
|
|
1056
|
-
# resp.index_fields[0].options.date_options.default_value #=> String
|
|
1057
|
-
# resp.index_fields[0].options.date_options.source_field #=> String
|
|
1058
|
-
# resp.index_fields[0].options.date_options.facet_enabled #=> Boolean
|
|
1059
|
-
# resp.index_fields[0].options.date_options.search_enabled #=> Boolean
|
|
1060
|
-
# resp.index_fields[0].options.date_options.return_enabled #=> Boolean
|
|
1061
|
-
# resp.index_fields[0].options.date_options.sort_enabled #=> Boolean
|
|
1062
|
-
# resp.index_fields[0].options.lat_lon_options.default_value #=> String
|
|
1063
|
-
# resp.index_fields[0].options.lat_lon_options.source_field #=> String
|
|
1064
|
-
# resp.index_fields[0].options.lat_lon_options.facet_enabled #=> Boolean
|
|
1065
|
-
# resp.index_fields[0].options.lat_lon_options.search_enabled #=> Boolean
|
|
1066
|
-
# resp.index_fields[0].options.lat_lon_options.return_enabled #=> Boolean
|
|
1067
|
-
# resp.index_fields[0].options.lat_lon_options.sort_enabled #=> Boolean
|
|
1068
|
-
# resp.index_fields[0].options.int_array_options.default_value #=> Integer
|
|
1069
|
-
# resp.index_fields[0].options.int_array_options.source_fields #=> String
|
|
1070
|
-
# resp.index_fields[0].options.int_array_options.facet_enabled #=> Boolean
|
|
1071
|
-
# resp.index_fields[0].options.int_array_options.search_enabled #=> Boolean
|
|
1072
|
-
# resp.index_fields[0].options.int_array_options.return_enabled #=> Boolean
|
|
1073
|
-
# resp.index_fields[0].options.double_array_options.default_value #=> Float
|
|
1074
|
-
# resp.index_fields[0].options.double_array_options.source_fields #=> String
|
|
1075
|
-
# resp.index_fields[0].options.double_array_options.facet_enabled #=> Boolean
|
|
1076
|
-
# resp.index_fields[0].options.double_array_options.search_enabled #=> Boolean
|
|
1077
|
-
# resp.index_fields[0].options.double_array_options.return_enabled #=> Boolean
|
|
1078
|
-
# resp.index_fields[0].options.literal_array_options.default_value #=> String
|
|
1079
|
-
# resp.index_fields[0].options.literal_array_options.source_fields #=> String
|
|
1080
|
-
# resp.index_fields[0].options.literal_array_options.facet_enabled #=> Boolean
|
|
1081
|
-
# resp.index_fields[0].options.literal_array_options.search_enabled #=> Boolean
|
|
1082
|
-
# resp.index_fields[0].options.literal_array_options.return_enabled #=> Boolean
|
|
1083
|
-
# resp.index_fields[0].options.text_array_options.default_value #=> String
|
|
1084
|
-
# resp.index_fields[0].options.text_array_options.source_fields #=> String
|
|
1085
|
-
# resp.index_fields[0].options.text_array_options.return_enabled #=> Boolean
|
|
1086
|
-
# resp.index_fields[0].options.text_array_options.highlight_enabled #=> Boolean
|
|
1087
|
-
# resp.index_fields[0].options.text_array_options.analysis_scheme #=> String
|
|
1088
|
-
# resp.index_fields[0].options.date_array_options.default_value #=> String
|
|
1089
|
-
# resp.index_fields[0].options.date_array_options.source_fields #=> String
|
|
1090
|
-
# resp.index_fields[0].options.date_array_options.facet_enabled #=> Boolean
|
|
1091
|
-
# resp.index_fields[0].options.date_array_options.search_enabled #=> Boolean
|
|
1092
|
-
# resp.index_fields[0].options.date_array_options.return_enabled #=> Boolean
|
|
1093
|
-
# resp.index_fields[0].status.creation_date #=> Time
|
|
1094
|
-
# resp.index_fields[0].status.update_date #=> Time
|
|
1095
|
-
# resp.index_fields[0].status.update_version #=> Integer
|
|
1096
|
-
# resp.index_fields[0].status.state #=> String, one of "RequiresIndexDocuments", "Processing", "Active", "FailedToValidate"
|
|
1097
|
-
# resp.index_fields[0].status.pending_deletion #=> Boolean
|
|
1098
|
-
# @overload describe_index_fields(params = {})
|
|
1099
|
-
# @param [Hash] params ({})
|
|
1100
|
-
def describe_index_fields(params = {}, options = {})
|
|
1101
|
-
req = build_request(:describe_index_fields, params)
|
|
1102
|
-
req.send_request(options)
|
|
1103
|
-
end
|
|
1050
|
+
# Gets the expressions configured for the search domain. Can be limited
|
|
1051
|
+
# to specific expressions by name. By default, shows all expressions and
|
|
1052
|
+
# includes any pending changes to the configuration. Set the `Deployed`
|
|
1053
|
+
# option to `true` to show the active configuration and exclude pending
|
|
1054
|
+
# changes. For more information, see [Configuring Expressions][1] in the
|
|
1055
|
+
# *Amazon CloudSearch Developer Guide*.
|
|
1056
|
+
#
|
|
1057
|
+
#
|
|
1058
|
+
#
|
|
1059
|
+
# [1]: http://docs.aws.amazon.com/cloudsearch/latest/developerguide/configuring-expressions.html
|
|
1060
|
+
#
|
|
1061
|
+
# @option params [required, String] :domain_name
|
|
1062
|
+
# The name of the domain you want to describe.
|
|
1063
|
+
#
|
|
1064
|
+
# @option params [Array<String>] :expression_names
|
|
1065
|
+
# Limits the `DescribeExpressions` response to the specified
|
|
1066
|
+
# expressions. If not specified, all expressions are shown.
|
|
1067
|
+
#
|
|
1068
|
+
# @option params [Boolean] :deployed
|
|
1069
|
+
# Whether to display the deployed configuration (`true`) or include any
|
|
1070
|
+
# pending changes (`false`). Defaults to `false`.
|
|
1071
|
+
#
|
|
1072
|
+
# @return [Types::DescribeExpressionsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
|
1073
|
+
#
|
|
1074
|
+
# * {Types::DescribeExpressionsResponse#expressions #expressions} => Array<Types::ExpressionStatus>
|
|
1075
|
+
#
|
|
1076
|
+
# @example Request syntax with placeholder values
|
|
1077
|
+
#
|
|
1078
|
+
# resp = client.describe_expressions({
|
|
1079
|
+
# domain_name: "DomainName", # required
|
|
1080
|
+
# expression_names: ["StandardName"],
|
|
1081
|
+
# deployed: false,
|
|
1082
|
+
# })
|
|
1083
|
+
#
|
|
1084
|
+
# @example Response structure
|
|
1085
|
+
#
|
|
1086
|
+
# resp.expressions #=> Array
|
|
1087
|
+
# resp.expressions[0].options.expression_name #=> String
|
|
1088
|
+
# resp.expressions[0].options.expression_value #=> String
|
|
1089
|
+
# resp.expressions[0].status.creation_date #=> Time
|
|
1090
|
+
# resp.expressions[0].status.update_date #=> Time
|
|
1091
|
+
# resp.expressions[0].status.update_version #=> Integer
|
|
1092
|
+
# resp.expressions[0].status.state #=> String, one of "RequiresIndexDocuments", "Processing", "Active", "FailedToValidate"
|
|
1093
|
+
# resp.expressions[0].status.pending_deletion #=> Boolean
|
|
1094
|
+
#
|
|
1095
|
+
# @overload describe_expressions(params = {})
|
|
1096
|
+
# @param [Hash] params ({})
|
|
1097
|
+
def describe_expressions(params = {}, options = {})
|
|
1098
|
+
req = build_request(:describe_expressions, params)
|
|
1099
|
+
req.send_request(options)
|
|
1100
|
+
end
|
|
1104
1101
|
|
|
1105
|
-
|
|
1106
|
-
|
|
1107
|
-
|
|
1108
|
-
|
|
1109
|
-
|
|
1110
|
-
|
|
1111
|
-
|
|
1112
|
-
|
|
1113
|
-
|
|
1114
|
-
|
|
1115
|
-
|
|
1116
|
-
|
|
1117
|
-
|
|
1118
|
-
|
|
1119
|
-
|
|
1120
|
-
|
|
1121
|
-
|
|
1122
|
-
|
|
1123
|
-
|
|
1124
|
-
|
|
1125
|
-
|
|
1126
|
-
|
|
1127
|
-
|
|
1128
|
-
|
|
1129
|
-
|
|
1130
|
-
|
|
1131
|
-
|
|
1132
|
-
|
|
1133
|
-
|
|
1134
|
-
|
|
1135
|
-
|
|
1136
|
-
|
|
1137
|
-
|
|
1138
|
-
|
|
1139
|
-
|
|
1140
|
-
|
|
1141
|
-
|
|
1102
|
+
# Gets information about the index fields configured for the search
|
|
1103
|
+
# domain. Can be limited to specific fields by name. By default, shows
|
|
1104
|
+
# all fields and includes any pending changes to the configuration. Set
|
|
1105
|
+
# the `Deployed` option to `true` to show the active configuration and
|
|
1106
|
+
# exclude pending changes. For more information, see [Getting Domain
|
|
1107
|
+
# Information][1] in the *Amazon CloudSearch Developer Guide*.
|
|
1108
|
+
#
|
|
1109
|
+
#
|
|
1110
|
+
#
|
|
1111
|
+
# [1]: http://docs.aws.amazon.com/cloudsearch/latest/developerguide/getting-domain-info.html
|
|
1112
|
+
#
|
|
1113
|
+
# @option params [required, String] :domain_name
|
|
1114
|
+
# The name of the domain you want to describe.
|
|
1115
|
+
#
|
|
1116
|
+
# @option params [Array<String>] :field_names
|
|
1117
|
+
# A list of the index fields you want to describe. If not specified,
|
|
1118
|
+
# information is returned for all configured index fields.
|
|
1119
|
+
#
|
|
1120
|
+
# @option params [Boolean] :deployed
|
|
1121
|
+
# Whether to display the deployed configuration (`true`) or include any
|
|
1122
|
+
# pending changes (`false`). Defaults to `false`.
|
|
1123
|
+
#
|
|
1124
|
+
# @return [Types::DescribeIndexFieldsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
|
1125
|
+
#
|
|
1126
|
+
# * {Types::DescribeIndexFieldsResponse#index_fields #index_fields} => Array<Types::IndexFieldStatus>
|
|
1127
|
+
#
|
|
1128
|
+
# @example Request syntax with placeholder values
|
|
1129
|
+
#
|
|
1130
|
+
# resp = client.describe_index_fields({
|
|
1131
|
+
# domain_name: "DomainName", # required
|
|
1132
|
+
# field_names: ["DynamicFieldName"],
|
|
1133
|
+
# deployed: false,
|
|
1134
|
+
# })
|
|
1135
|
+
#
|
|
1136
|
+
# @example Response structure
|
|
1137
|
+
#
|
|
1138
|
+
# resp.index_fields #=> Array
|
|
1139
|
+
# resp.index_fields[0].options.index_field_name #=> String
|
|
1140
|
+
# resp.index_fields[0].options.index_field_type #=> String, one of "int", "double", "literal", "text", "date", "latlon", "int-array", "double-array", "literal-array", "text-array", "date-array"
|
|
1141
|
+
# resp.index_fields[0].options.int_options.default_value #=> Integer
|
|
1142
|
+
# resp.index_fields[0].options.int_options.source_field #=> String
|
|
1143
|
+
# resp.index_fields[0].options.int_options.facet_enabled #=> Boolean
|
|
1144
|
+
# resp.index_fields[0].options.int_options.search_enabled #=> Boolean
|
|
1145
|
+
# resp.index_fields[0].options.int_options.return_enabled #=> Boolean
|
|
1146
|
+
# resp.index_fields[0].options.int_options.sort_enabled #=> Boolean
|
|
1147
|
+
# resp.index_fields[0].options.double_options.default_value #=> Float
|
|
1148
|
+
# resp.index_fields[0].options.double_options.source_field #=> String
|
|
1149
|
+
# resp.index_fields[0].options.double_options.facet_enabled #=> Boolean
|
|
1150
|
+
# resp.index_fields[0].options.double_options.search_enabled #=> Boolean
|
|
1151
|
+
# resp.index_fields[0].options.double_options.return_enabled #=> Boolean
|
|
1152
|
+
# resp.index_fields[0].options.double_options.sort_enabled #=> Boolean
|
|
1153
|
+
# resp.index_fields[0].options.literal_options.default_value #=> String
|
|
1154
|
+
# resp.index_fields[0].options.literal_options.source_field #=> String
|
|
1155
|
+
# resp.index_fields[0].options.literal_options.facet_enabled #=> Boolean
|
|
1156
|
+
# resp.index_fields[0].options.literal_options.search_enabled #=> Boolean
|
|
1157
|
+
# resp.index_fields[0].options.literal_options.return_enabled #=> Boolean
|
|
1158
|
+
# resp.index_fields[0].options.literal_options.sort_enabled #=> Boolean
|
|
1159
|
+
# resp.index_fields[0].options.text_options.default_value #=> String
|
|
1160
|
+
# resp.index_fields[0].options.text_options.source_field #=> String
|
|
1161
|
+
# resp.index_fields[0].options.text_options.return_enabled #=> Boolean
|
|
1162
|
+
# resp.index_fields[0].options.text_options.sort_enabled #=> Boolean
|
|
1163
|
+
# resp.index_fields[0].options.text_options.highlight_enabled #=> Boolean
|
|
1164
|
+
# resp.index_fields[0].options.text_options.analysis_scheme #=> String
|
|
1165
|
+
# resp.index_fields[0].options.date_options.default_value #=> String
|
|
1166
|
+
# resp.index_fields[0].options.date_options.source_field #=> String
|
|
1167
|
+
# resp.index_fields[0].options.date_options.facet_enabled #=> Boolean
|
|
1168
|
+
# resp.index_fields[0].options.date_options.search_enabled #=> Boolean
|
|
1169
|
+
# resp.index_fields[0].options.date_options.return_enabled #=> Boolean
|
|
1170
|
+
# resp.index_fields[0].options.date_options.sort_enabled #=> Boolean
|
|
1171
|
+
# resp.index_fields[0].options.lat_lon_options.default_value #=> String
|
|
1172
|
+
# resp.index_fields[0].options.lat_lon_options.source_field #=> String
|
|
1173
|
+
# resp.index_fields[0].options.lat_lon_options.facet_enabled #=> Boolean
|
|
1174
|
+
# resp.index_fields[0].options.lat_lon_options.search_enabled #=> Boolean
|
|
1175
|
+
# resp.index_fields[0].options.lat_lon_options.return_enabled #=> Boolean
|
|
1176
|
+
# resp.index_fields[0].options.lat_lon_options.sort_enabled #=> Boolean
|
|
1177
|
+
# resp.index_fields[0].options.int_array_options.default_value #=> Integer
|
|
1178
|
+
# resp.index_fields[0].options.int_array_options.source_fields #=> String
|
|
1179
|
+
# resp.index_fields[0].options.int_array_options.facet_enabled #=> Boolean
|
|
1180
|
+
# resp.index_fields[0].options.int_array_options.search_enabled #=> Boolean
|
|
1181
|
+
# resp.index_fields[0].options.int_array_options.return_enabled #=> Boolean
|
|
1182
|
+
# resp.index_fields[0].options.double_array_options.default_value #=> Float
|
|
1183
|
+
# resp.index_fields[0].options.double_array_options.source_fields #=> String
|
|
1184
|
+
# resp.index_fields[0].options.double_array_options.facet_enabled #=> Boolean
|
|
1185
|
+
# resp.index_fields[0].options.double_array_options.search_enabled #=> Boolean
|
|
1186
|
+
# resp.index_fields[0].options.double_array_options.return_enabled #=> Boolean
|
|
1187
|
+
# resp.index_fields[0].options.literal_array_options.default_value #=> String
|
|
1188
|
+
# resp.index_fields[0].options.literal_array_options.source_fields #=> String
|
|
1189
|
+
# resp.index_fields[0].options.literal_array_options.facet_enabled #=> Boolean
|
|
1190
|
+
# resp.index_fields[0].options.literal_array_options.search_enabled #=> Boolean
|
|
1191
|
+
# resp.index_fields[0].options.literal_array_options.return_enabled #=> Boolean
|
|
1192
|
+
# resp.index_fields[0].options.text_array_options.default_value #=> String
|
|
1193
|
+
# resp.index_fields[0].options.text_array_options.source_fields #=> String
|
|
1194
|
+
# resp.index_fields[0].options.text_array_options.return_enabled #=> Boolean
|
|
1195
|
+
# resp.index_fields[0].options.text_array_options.highlight_enabled #=> Boolean
|
|
1196
|
+
# resp.index_fields[0].options.text_array_options.analysis_scheme #=> String
|
|
1197
|
+
# resp.index_fields[0].options.date_array_options.default_value #=> String
|
|
1198
|
+
# resp.index_fields[0].options.date_array_options.source_fields #=> String
|
|
1199
|
+
# resp.index_fields[0].options.date_array_options.facet_enabled #=> Boolean
|
|
1200
|
+
# resp.index_fields[0].options.date_array_options.search_enabled #=> Boolean
|
|
1201
|
+
# resp.index_fields[0].options.date_array_options.return_enabled #=> Boolean
|
|
1202
|
+
# resp.index_fields[0].status.creation_date #=> Time
|
|
1203
|
+
# resp.index_fields[0].status.update_date #=> Time
|
|
1204
|
+
# resp.index_fields[0].status.update_version #=> Integer
|
|
1205
|
+
# resp.index_fields[0].status.state #=> String, one of "RequiresIndexDocuments", "Processing", "Active", "FailedToValidate"
|
|
1206
|
+
# resp.index_fields[0].status.pending_deletion #=> Boolean
|
|
1207
|
+
#
|
|
1208
|
+
# @overload describe_index_fields(params = {})
|
|
1209
|
+
# @param [Hash] params ({})
|
|
1210
|
+
def describe_index_fields(params = {}, options = {})
|
|
1211
|
+
req = build_request(:describe_index_fields, params)
|
|
1212
|
+
req.send_request(options)
|
|
1213
|
+
end
|
|
1142
1214
|
|
|
1143
|
-
|
|
1144
|
-
|
|
1145
|
-
|
|
1146
|
-
|
|
1147
|
-
|
|
1148
|
-
|
|
1149
|
-
|
|
1150
|
-
|
|
1151
|
-
|
|
1152
|
-
|
|
1153
|
-
|
|
1154
|
-
|
|
1155
|
-
|
|
1156
|
-
|
|
1157
|
-
|
|
1158
|
-
|
|
1159
|
-
|
|
1160
|
-
|
|
1161
|
-
|
|
1162
|
-
|
|
1163
|
-
|
|
1164
|
-
|
|
1165
|
-
|
|
1166
|
-
|
|
1167
|
-
|
|
1168
|
-
|
|
1169
|
-
|
|
1170
|
-
|
|
1171
|
-
|
|
1172
|
-
|
|
1173
|
-
|
|
1174
|
-
|
|
1175
|
-
|
|
1176
|
-
|
|
1177
|
-
|
|
1178
|
-
|
|
1179
|
-
|
|
1180
|
-
|
|
1215
|
+
# Gets the scaling parameters configured for a domain. A domain's
|
|
1216
|
+
# scaling parameters specify the desired search instance type and
|
|
1217
|
+
# replication count. For more information, see [Configuring Scaling
|
|
1218
|
+
# Options][1] in the *Amazon CloudSearch Developer Guide*.
|
|
1219
|
+
#
|
|
1220
|
+
#
|
|
1221
|
+
#
|
|
1222
|
+
# [1]: http://docs.aws.amazon.com/cloudsearch/latest/developerguide/configuring-scaling-options.html
|
|
1223
|
+
#
|
|
1224
|
+
# @option params [required, String] :domain_name
|
|
1225
|
+
# A string that represents the name of a domain. Domain names are unique
|
|
1226
|
+
# across the domains owned by an account within an AWS region. Domain
|
|
1227
|
+
# names start with a letter or number and can contain the following
|
|
1228
|
+
# characters: a-z (lowercase), 0-9, and - (hyphen).
|
|
1229
|
+
#
|
|
1230
|
+
# @return [Types::DescribeScalingParametersResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
|
1231
|
+
#
|
|
1232
|
+
# * {Types::DescribeScalingParametersResponse#scaling_parameters #scaling_parameters} => Types::ScalingParametersStatus
|
|
1233
|
+
#
|
|
1234
|
+
# @example Request syntax with placeholder values
|
|
1235
|
+
#
|
|
1236
|
+
# resp = client.describe_scaling_parameters({
|
|
1237
|
+
# domain_name: "DomainName", # required
|
|
1238
|
+
# })
|
|
1239
|
+
#
|
|
1240
|
+
# @example Response structure
|
|
1241
|
+
#
|
|
1242
|
+
# resp.scaling_parameters.options.desired_instance_type #=> String, one of "search.m1.small", "search.m1.large", "search.m2.xlarge", "search.m2.2xlarge", "search.m3.medium", "search.m3.large", "search.m3.xlarge", "search.m3.2xlarge"
|
|
1243
|
+
# resp.scaling_parameters.options.desired_replication_count #=> Integer
|
|
1244
|
+
# resp.scaling_parameters.options.desired_partition_count #=> Integer
|
|
1245
|
+
# resp.scaling_parameters.status.creation_date #=> Time
|
|
1246
|
+
# resp.scaling_parameters.status.update_date #=> Time
|
|
1247
|
+
# resp.scaling_parameters.status.update_version #=> Integer
|
|
1248
|
+
# resp.scaling_parameters.status.state #=> String, one of "RequiresIndexDocuments", "Processing", "Active", "FailedToValidate"
|
|
1249
|
+
# resp.scaling_parameters.status.pending_deletion #=> Boolean
|
|
1250
|
+
#
|
|
1251
|
+
# @overload describe_scaling_parameters(params = {})
|
|
1252
|
+
# @param [Hash] params ({})
|
|
1253
|
+
def describe_scaling_parameters(params = {}, options = {})
|
|
1254
|
+
req = build_request(:describe_scaling_parameters, params)
|
|
1255
|
+
req.send_request(options)
|
|
1256
|
+
end
|
|
1181
1257
|
|
|
1182
|
-
|
|
1183
|
-
|
|
1184
|
-
|
|
1185
|
-
|
|
1186
|
-
|
|
1187
|
-
|
|
1188
|
-
|
|
1189
|
-
|
|
1190
|
-
|
|
1191
|
-
|
|
1192
|
-
|
|
1193
|
-
|
|
1194
|
-
|
|
1195
|
-
|
|
1196
|
-
|
|
1197
|
-
|
|
1198
|
-
|
|
1199
|
-
|
|
1200
|
-
|
|
1201
|
-
|
|
1202
|
-
|
|
1203
|
-
|
|
1204
|
-
|
|
1205
|
-
|
|
1206
|
-
|
|
1207
|
-
|
|
1208
|
-
|
|
1209
|
-
|
|
1210
|
-
|
|
1211
|
-
|
|
1212
|
-
|
|
1213
|
-
|
|
1214
|
-
|
|
1215
|
-
|
|
1216
|
-
|
|
1217
|
-
|
|
1218
|
-
|
|
1219
|
-
|
|
1220
|
-
|
|
1221
|
-
|
|
1222
|
-
|
|
1223
|
-
|
|
1224
|
-
|
|
1225
|
-
|
|
1226
|
-
req.send_request(options)
|
|
1227
|
-
end
|
|
1258
|
+
# Gets information about the access policies that control access to the
|
|
1259
|
+
# domain's document and search endpoints. By default, shows the
|
|
1260
|
+
# configuration with any pending changes. Set the `Deployed` option to
|
|
1261
|
+
# `true` to show the active configuration and exclude pending changes.
|
|
1262
|
+
# For more information, see [Configuring Access for a Search Domain][1]
|
|
1263
|
+
# in the *Amazon CloudSearch Developer Guide*.
|
|
1264
|
+
#
|
|
1265
|
+
#
|
|
1266
|
+
#
|
|
1267
|
+
# [1]: http://docs.aws.amazon.com/cloudsearch/latest/developerguide/configuring-access.html
|
|
1268
|
+
#
|
|
1269
|
+
# @option params [required, String] :domain_name
|
|
1270
|
+
# The name of the domain you want to describe.
|
|
1271
|
+
#
|
|
1272
|
+
# @option params [Boolean] :deployed
|
|
1273
|
+
# Whether to display the deployed configuration (`true`) or include any
|
|
1274
|
+
# pending changes (`false`). Defaults to `false`.
|
|
1275
|
+
#
|
|
1276
|
+
# @return [Types::DescribeServiceAccessPoliciesResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
|
1277
|
+
#
|
|
1278
|
+
# * {Types::DescribeServiceAccessPoliciesResponse#access_policies #access_policies} => Types::AccessPoliciesStatus
|
|
1279
|
+
#
|
|
1280
|
+
# @example Request syntax with placeholder values
|
|
1281
|
+
#
|
|
1282
|
+
# resp = client.describe_service_access_policies({
|
|
1283
|
+
# domain_name: "DomainName", # required
|
|
1284
|
+
# deployed: false,
|
|
1285
|
+
# })
|
|
1286
|
+
#
|
|
1287
|
+
# @example Response structure
|
|
1288
|
+
#
|
|
1289
|
+
# resp.access_policies.options #=> String
|
|
1290
|
+
# resp.access_policies.status.creation_date #=> Time
|
|
1291
|
+
# resp.access_policies.status.update_date #=> Time
|
|
1292
|
+
# resp.access_policies.status.update_version #=> Integer
|
|
1293
|
+
# resp.access_policies.status.state #=> String, one of "RequiresIndexDocuments", "Processing", "Active", "FailedToValidate"
|
|
1294
|
+
# resp.access_policies.status.pending_deletion #=> Boolean
|
|
1295
|
+
#
|
|
1296
|
+
# @overload describe_service_access_policies(params = {})
|
|
1297
|
+
# @param [Hash] params ({})
|
|
1298
|
+
def describe_service_access_policies(params = {}, options = {})
|
|
1299
|
+
req = build_request(:describe_service_access_policies, params)
|
|
1300
|
+
req.send_request(options)
|
|
1301
|
+
end
|
|
1228
1302
|
|
|
1229
|
-
|
|
1230
|
-
|
|
1231
|
-
|
|
1232
|
-
|
|
1233
|
-
|
|
1234
|
-
|
|
1235
|
-
|
|
1236
|
-
|
|
1237
|
-
|
|
1238
|
-
|
|
1239
|
-
|
|
1240
|
-
|
|
1241
|
-
|
|
1242
|
-
|
|
1243
|
-
|
|
1244
|
-
|
|
1245
|
-
|
|
1246
|
-
|
|
1247
|
-
|
|
1248
|
-
|
|
1249
|
-
|
|
1250
|
-
|
|
1251
|
-
|
|
1252
|
-
|
|
1253
|
-
|
|
1254
|
-
|
|
1303
|
+
# Gets the suggesters configured for a domain. A suggester enables you
|
|
1304
|
+
# to display possible matches before users finish typing their queries.
|
|
1305
|
+
# Can be limited to specific suggesters by name. By default, shows all
|
|
1306
|
+
# suggesters and includes any pending changes to the configuration. Set
|
|
1307
|
+
# the `Deployed` option to `true` to show the active configuration and
|
|
1308
|
+
# exclude pending changes. For more information, see [Getting Search
|
|
1309
|
+
# Suggestions][1] in the *Amazon CloudSearch Developer Guide*.
|
|
1310
|
+
#
|
|
1311
|
+
#
|
|
1312
|
+
#
|
|
1313
|
+
# [1]: http://docs.aws.amazon.com/cloudsearch/latest/developerguide/getting-suggestions.html
|
|
1314
|
+
#
|
|
1315
|
+
# @option params [required, String] :domain_name
|
|
1316
|
+
# The name of the domain you want to describe.
|
|
1317
|
+
#
|
|
1318
|
+
# @option params [Array<String>] :suggester_names
|
|
1319
|
+
# The suggesters you want to describe.
|
|
1320
|
+
#
|
|
1321
|
+
# @option params [Boolean] :deployed
|
|
1322
|
+
# Whether to display the deployed configuration (`true`) or include any
|
|
1323
|
+
# pending changes (`false`). Defaults to `false`.
|
|
1324
|
+
#
|
|
1325
|
+
# @return [Types::DescribeSuggestersResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
|
1326
|
+
#
|
|
1327
|
+
# * {Types::DescribeSuggestersResponse#suggesters #suggesters} => Array<Types::SuggesterStatus>
|
|
1328
|
+
#
|
|
1329
|
+
# @example Request syntax with placeholder values
|
|
1330
|
+
#
|
|
1331
|
+
# resp = client.describe_suggesters({
|
|
1332
|
+
# domain_name: "DomainName", # required
|
|
1333
|
+
# suggester_names: ["StandardName"],
|
|
1334
|
+
# deployed: false,
|
|
1335
|
+
# })
|
|
1336
|
+
#
|
|
1337
|
+
# @example Response structure
|
|
1338
|
+
#
|
|
1339
|
+
# resp.suggesters #=> Array
|
|
1340
|
+
# resp.suggesters[0].options.suggester_name #=> String
|
|
1341
|
+
# resp.suggesters[0].options.document_suggester_options.source_field #=> String
|
|
1342
|
+
# resp.suggesters[0].options.document_suggester_options.fuzzy_matching #=> String, one of "none", "low", "high"
|
|
1343
|
+
# resp.suggesters[0].options.document_suggester_options.sort_expression #=> String
|
|
1344
|
+
# resp.suggesters[0].status.creation_date #=> Time
|
|
1345
|
+
# resp.suggesters[0].status.update_date #=> Time
|
|
1346
|
+
# resp.suggesters[0].status.update_version #=> Integer
|
|
1347
|
+
# resp.suggesters[0].status.state #=> String, one of "RequiresIndexDocuments", "Processing", "Active", "FailedToValidate"
|
|
1348
|
+
# resp.suggesters[0].status.pending_deletion #=> Boolean
|
|
1349
|
+
#
|
|
1350
|
+
# @overload describe_suggesters(params = {})
|
|
1351
|
+
# @param [Hash] params ({})
|
|
1352
|
+
def describe_suggesters(params = {}, options = {})
|
|
1353
|
+
req = build_request(:describe_suggesters, params)
|
|
1354
|
+
req.send_request(options)
|
|
1355
|
+
end
|
|
1255
1356
|
|
|
1256
|
-
|
|
1257
|
-
|
|
1258
|
-
|
|
1259
|
-
|
|
1260
|
-
|
|
1261
|
-
|
|
1262
|
-
|
|
1263
|
-
|
|
1264
|
-
|
|
1265
|
-
|
|
1266
|
-
|
|
1267
|
-
|
|
1268
|
-
|
|
1269
|
-
|
|
1357
|
+
# Tells the search domain to start indexing its documents using the
|
|
1358
|
+
# latest indexing options. This operation must be invoked to activate
|
|
1359
|
+
# options whose OptionStatus is `RequiresIndexDocuments`.
|
|
1360
|
+
#
|
|
1361
|
+
# @option params [required, String] :domain_name
|
|
1362
|
+
# A string that represents the name of a domain. Domain names are unique
|
|
1363
|
+
# across the domains owned by an account within an AWS region. Domain
|
|
1364
|
+
# names start with a letter or number and can contain the following
|
|
1365
|
+
# characters: a-z (lowercase), 0-9, and - (hyphen).
|
|
1366
|
+
#
|
|
1367
|
+
# @return [Types::IndexDocumentsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
|
1368
|
+
#
|
|
1369
|
+
# * {Types::IndexDocumentsResponse#field_names #field_names} => Array<String>
|
|
1370
|
+
#
|
|
1371
|
+
# @example Request syntax with placeholder values
|
|
1372
|
+
#
|
|
1373
|
+
# resp = client.index_documents({
|
|
1374
|
+
# domain_name: "DomainName", # required
|
|
1375
|
+
# })
|
|
1376
|
+
#
|
|
1377
|
+
# @example Response structure
|
|
1378
|
+
#
|
|
1379
|
+
# resp.field_names #=> Array
|
|
1380
|
+
# resp.field_names[0] #=> String
|
|
1381
|
+
#
|
|
1382
|
+
# @overload index_documents(params = {})
|
|
1383
|
+
# @param [Hash] params ({})
|
|
1384
|
+
def index_documents(params = {}, options = {})
|
|
1385
|
+
req = build_request(:index_documents, params)
|
|
1386
|
+
req.send_request(options)
|
|
1387
|
+
end
|
|
1270
1388
|
|
|
1271
|
-
|
|
1272
|
-
|
|
1273
|
-
|
|
1274
|
-
|
|
1275
|
-
|
|
1276
|
-
|
|
1277
|
-
|
|
1278
|
-
|
|
1279
|
-
|
|
1280
|
-
|
|
1281
|
-
|
|
1282
|
-
|
|
1283
|
-
|
|
1284
|
-
|
|
1285
|
-
|
|
1286
|
-
|
|
1287
|
-
|
|
1288
|
-
# You expand an existing search domain to a second Availability Zone by
|
|
1289
|
-
# setting the Multi-AZ option to true. Similarly, you can turn off the
|
|
1290
|
-
# Multi-AZ option to downgrade the domain to a single Availability Zone
|
|
1291
|
-
# by setting the Multi-AZ option to `false`.
|
|
1292
|
-
# @return [Types::UpdateAvailabilityOptionsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
|
1293
|
-
#
|
|
1294
|
-
# * {Types::UpdateAvailabilityOptionsResponse#availability_options #AvailabilityOptions} => Types::AvailabilityOptionsStatus
|
|
1295
|
-
#
|
|
1296
|
-
# @example Request syntax with placeholder values
|
|
1297
|
-
# resp = client.update_availability_options({
|
|
1298
|
-
# domain_name: "DomainName", # required
|
|
1299
|
-
# multi_az: false, # required
|
|
1300
|
-
# })
|
|
1301
|
-
#
|
|
1302
|
-
# @example Response structure
|
|
1303
|
-
# resp.availability_options.options #=> Boolean
|
|
1304
|
-
# resp.availability_options.status.creation_date #=> Time
|
|
1305
|
-
# resp.availability_options.status.update_date #=> Time
|
|
1306
|
-
# resp.availability_options.status.update_version #=> Integer
|
|
1307
|
-
# resp.availability_options.status.state #=> String, one of "RequiresIndexDocuments", "Processing", "Active", "FailedToValidate"
|
|
1308
|
-
# resp.availability_options.status.pending_deletion #=> Boolean
|
|
1309
|
-
# @overload update_availability_options(params = {})
|
|
1310
|
-
# @param [Hash] params ({})
|
|
1311
|
-
def update_availability_options(params = {}, options = {})
|
|
1312
|
-
req = build_request(:update_availability_options, params)
|
|
1313
|
-
req.send_request(options)
|
|
1314
|
-
end
|
|
1389
|
+
# Lists all search domains owned by an account.
|
|
1390
|
+
#
|
|
1391
|
+
# @return [Types::ListDomainNamesResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
|
1392
|
+
#
|
|
1393
|
+
# * {Types::ListDomainNamesResponse#domain_names #domain_names} => Hash<String,String>
|
|
1394
|
+
#
|
|
1395
|
+
# @example Response structure
|
|
1396
|
+
#
|
|
1397
|
+
# resp.domain_names #=> Hash
|
|
1398
|
+
# resp.domain_names["DomainName"] #=> String
|
|
1399
|
+
#
|
|
1400
|
+
# @overload list_domain_names(params = {})
|
|
1401
|
+
# @param [Hash] params ({})
|
|
1402
|
+
def list_domain_names(params = {}, options = {})
|
|
1403
|
+
req = build_request(:list_domain_names, params)
|
|
1404
|
+
req.send_request(options)
|
|
1405
|
+
end
|
|
1315
1406
|
|
|
1316
|
-
|
|
1317
|
-
|
|
1318
|
-
|
|
1319
|
-
|
|
1320
|
-
|
|
1321
|
-
|
|
1322
|
-
|
|
1323
|
-
|
|
1324
|
-
|
|
1325
|
-
|
|
1326
|
-
|
|
1327
|
-
|
|
1328
|
-
|
|
1329
|
-
|
|
1330
|
-
|
|
1331
|
-
|
|
1332
|
-
|
|
1333
|
-
|
|
1334
|
-
|
|
1335
|
-
|
|
1336
|
-
|
|
1337
|
-
|
|
1338
|
-
|
|
1339
|
-
|
|
1340
|
-
|
|
1341
|
-
|
|
1342
|
-
|
|
1343
|
-
|
|
1344
|
-
|
|
1345
|
-
|
|
1346
|
-
|
|
1347
|
-
|
|
1348
|
-
|
|
1349
|
-
|
|
1350
|
-
|
|
1351
|
-
|
|
1352
|
-
|
|
1353
|
-
|
|
1354
|
-
|
|
1355
|
-
|
|
1356
|
-
|
|
1357
|
-
|
|
1358
|
-
|
|
1359
|
-
|
|
1360
|
-
|
|
1361
|
-
|
|
1362
|
-
|
|
1363
|
-
|
|
1364
|
-
|
|
1407
|
+
# Configures the availability options for a domain. Enabling the
|
|
1408
|
+
# Multi-AZ option expands an Amazon CloudSearch domain to an additional
|
|
1409
|
+
# Availability Zone in the same Region to increase fault tolerance in
|
|
1410
|
+
# the event of a service disruption. Changes to the Multi-AZ option can
|
|
1411
|
+
# take about half an hour to become active. For more information, see
|
|
1412
|
+
# [Configuring Availability Options][1] in the *Amazon CloudSearch
|
|
1413
|
+
# Developer Guide*.
|
|
1414
|
+
#
|
|
1415
|
+
#
|
|
1416
|
+
#
|
|
1417
|
+
# [1]: http://docs.aws.amazon.com/cloudsearch/latest/developerguide/configuring-availability-options.html
|
|
1418
|
+
#
|
|
1419
|
+
# @option params [required, String] :domain_name
|
|
1420
|
+
# A string that represents the name of a domain. Domain names are unique
|
|
1421
|
+
# across the domains owned by an account within an AWS region. Domain
|
|
1422
|
+
# names start with a letter or number and can contain the following
|
|
1423
|
+
# characters: a-z (lowercase), 0-9, and - (hyphen).
|
|
1424
|
+
#
|
|
1425
|
+
# @option params [required, Boolean] :multi_az
|
|
1426
|
+
# You expand an existing search domain to a second Availability Zone by
|
|
1427
|
+
# setting the Multi-AZ option to true. Similarly, you can turn off the
|
|
1428
|
+
# Multi-AZ option to downgrade the domain to a single Availability Zone
|
|
1429
|
+
# by setting the Multi-AZ option to `false`.
|
|
1430
|
+
#
|
|
1431
|
+
# @return [Types::UpdateAvailabilityOptionsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
|
1432
|
+
#
|
|
1433
|
+
# * {Types::UpdateAvailabilityOptionsResponse#availability_options #availability_options} => Types::AvailabilityOptionsStatus
|
|
1434
|
+
#
|
|
1435
|
+
# @example Request syntax with placeholder values
|
|
1436
|
+
#
|
|
1437
|
+
# resp = client.update_availability_options({
|
|
1438
|
+
# domain_name: "DomainName", # required
|
|
1439
|
+
# multi_az: false, # required
|
|
1440
|
+
# })
|
|
1441
|
+
#
|
|
1442
|
+
# @example Response structure
|
|
1443
|
+
#
|
|
1444
|
+
# resp.availability_options.options #=> Boolean
|
|
1445
|
+
# resp.availability_options.status.creation_date #=> Time
|
|
1446
|
+
# resp.availability_options.status.update_date #=> Time
|
|
1447
|
+
# resp.availability_options.status.update_version #=> Integer
|
|
1448
|
+
# resp.availability_options.status.state #=> String, one of "RequiresIndexDocuments", "Processing", "Active", "FailedToValidate"
|
|
1449
|
+
# resp.availability_options.status.pending_deletion #=> Boolean
|
|
1450
|
+
#
|
|
1451
|
+
# @overload update_availability_options(params = {})
|
|
1452
|
+
# @param [Hash] params ({})
|
|
1453
|
+
def update_availability_options(params = {}, options = {})
|
|
1454
|
+
req = build_request(:update_availability_options, params)
|
|
1455
|
+
req.send_request(options)
|
|
1456
|
+
end
|
|
1365
1457
|
|
|
1366
|
-
|
|
1367
|
-
|
|
1368
|
-
|
|
1369
|
-
|
|
1370
|
-
|
|
1371
|
-
|
|
1372
|
-
|
|
1373
|
-
|
|
1374
|
-
|
|
1375
|
-
|
|
1376
|
-
|
|
1377
|
-
|
|
1378
|
-
|
|
1379
|
-
|
|
1380
|
-
|
|
1381
|
-
|
|
1382
|
-
|
|
1383
|
-
|
|
1384
|
-
|
|
1385
|
-
|
|
1386
|
-
|
|
1387
|
-
|
|
1388
|
-
|
|
1389
|
-
|
|
1390
|
-
|
|
1391
|
-
|
|
1392
|
-
|
|
1393
|
-
|
|
1394
|
-
|
|
1395
|
-
|
|
1396
|
-
|
|
1397
|
-
|
|
1398
|
-
|
|
1399
|
-
|
|
1400
|
-
|
|
1401
|
-
|
|
1402
|
-
|
|
1403
|
-
|
|
1458
|
+
# Configures scaling parameters for a domain. A domain's scaling
|
|
1459
|
+
# parameters specify the desired search instance type and replication
|
|
1460
|
+
# count. Amazon CloudSearch will still automatically scale your domain
|
|
1461
|
+
# based on the volume of data and traffic, but not below the desired
|
|
1462
|
+
# instance type and replication count. If the Multi-AZ option is
|
|
1463
|
+
# enabled, these values control the resources used per Availability
|
|
1464
|
+
# Zone. For more information, see [Configuring Scaling Options][1] in
|
|
1465
|
+
# the *Amazon CloudSearch Developer Guide*.
|
|
1466
|
+
#
|
|
1467
|
+
#
|
|
1468
|
+
#
|
|
1469
|
+
# [1]: http://docs.aws.amazon.com/cloudsearch/latest/developerguide/configuring-scaling-options.html
|
|
1470
|
+
#
|
|
1471
|
+
# @option params [required, String] :domain_name
|
|
1472
|
+
# A string that represents the name of a domain. Domain names are unique
|
|
1473
|
+
# across the domains owned by an account within an AWS region. Domain
|
|
1474
|
+
# names start with a letter or number and can contain the following
|
|
1475
|
+
# characters: a-z (lowercase), 0-9, and - (hyphen).
|
|
1476
|
+
#
|
|
1477
|
+
# @option params [required, Types::ScalingParameters] :scaling_parameters
|
|
1478
|
+
# The desired instance type and desired number of replicas of each index
|
|
1479
|
+
# partition.
|
|
1480
|
+
#
|
|
1481
|
+
# @return [Types::UpdateScalingParametersResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
|
1482
|
+
#
|
|
1483
|
+
# * {Types::UpdateScalingParametersResponse#scaling_parameters #scaling_parameters} => Types::ScalingParametersStatus
|
|
1484
|
+
#
|
|
1485
|
+
# @example Request syntax with placeholder values
|
|
1486
|
+
#
|
|
1487
|
+
# resp = client.update_scaling_parameters({
|
|
1488
|
+
# domain_name: "DomainName", # required
|
|
1489
|
+
# scaling_parameters: { # required
|
|
1490
|
+
# desired_instance_type: "search.m1.small", # accepts search.m1.small, search.m1.large, search.m2.xlarge, search.m2.2xlarge, search.m3.medium, search.m3.large, search.m3.xlarge, search.m3.2xlarge
|
|
1491
|
+
# desired_replication_count: 1,
|
|
1492
|
+
# desired_partition_count: 1,
|
|
1493
|
+
# },
|
|
1494
|
+
# })
|
|
1495
|
+
#
|
|
1496
|
+
# @example Response structure
|
|
1497
|
+
#
|
|
1498
|
+
# resp.scaling_parameters.options.desired_instance_type #=> String, one of "search.m1.small", "search.m1.large", "search.m2.xlarge", "search.m2.2xlarge", "search.m3.medium", "search.m3.large", "search.m3.xlarge", "search.m3.2xlarge"
|
|
1499
|
+
# resp.scaling_parameters.options.desired_replication_count #=> Integer
|
|
1500
|
+
# resp.scaling_parameters.options.desired_partition_count #=> Integer
|
|
1501
|
+
# resp.scaling_parameters.status.creation_date #=> Time
|
|
1502
|
+
# resp.scaling_parameters.status.update_date #=> Time
|
|
1503
|
+
# resp.scaling_parameters.status.update_version #=> Integer
|
|
1504
|
+
# resp.scaling_parameters.status.state #=> String, one of "RequiresIndexDocuments", "Processing", "Active", "FailedToValidate"
|
|
1505
|
+
# resp.scaling_parameters.status.pending_deletion #=> Boolean
|
|
1506
|
+
#
|
|
1507
|
+
# @overload update_scaling_parameters(params = {})
|
|
1508
|
+
# @param [Hash] params ({})
|
|
1509
|
+
def update_scaling_parameters(params = {}, options = {})
|
|
1510
|
+
req = build_request(:update_scaling_parameters, params)
|
|
1511
|
+
req.send_request(options)
|
|
1512
|
+
end
|
|
1404
1513
|
|
|
1405
|
-
|
|
1514
|
+
# Configures the access rules that control access to the domain's
|
|
1515
|
+
# document and search endpoints. For more information, see [ Configuring
|
|
1516
|
+
# Access for an Amazon CloudSearch Domain][1].
|
|
1517
|
+
#
|
|
1518
|
+
#
|
|
1519
|
+
#
|
|
1520
|
+
# [1]: http://docs.aws.amazon.com/cloudsearch/latest/developerguide/configuring-access.html
|
|
1521
|
+
#
|
|
1522
|
+
# @option params [required, String] :domain_name
|
|
1523
|
+
# A string that represents the name of a domain. Domain names are unique
|
|
1524
|
+
# across the domains owned by an account within an AWS region. Domain
|
|
1525
|
+
# names start with a letter or number and can contain the following
|
|
1526
|
+
# characters: a-z (lowercase), 0-9, and - (hyphen).
|
|
1527
|
+
#
|
|
1528
|
+
# @option params [required, String] :access_policies
|
|
1529
|
+
# The access rules you want to configure. These rules replace any
|
|
1530
|
+
# existing rules.
|
|
1531
|
+
#
|
|
1532
|
+
# @return [Types::UpdateServiceAccessPoliciesResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
|
1533
|
+
#
|
|
1534
|
+
# * {Types::UpdateServiceAccessPoliciesResponse#access_policies #access_policies} => Types::AccessPoliciesStatus
|
|
1535
|
+
#
|
|
1536
|
+
# @example Request syntax with placeholder values
|
|
1537
|
+
#
|
|
1538
|
+
# resp = client.update_service_access_policies({
|
|
1539
|
+
# domain_name: "DomainName", # required
|
|
1540
|
+
# access_policies: "PolicyDocument", # required
|
|
1541
|
+
# })
|
|
1542
|
+
#
|
|
1543
|
+
# @example Response structure
|
|
1544
|
+
#
|
|
1545
|
+
# resp.access_policies.options #=> String
|
|
1546
|
+
# resp.access_policies.status.creation_date #=> Time
|
|
1547
|
+
# resp.access_policies.status.update_date #=> Time
|
|
1548
|
+
# resp.access_policies.status.update_version #=> Integer
|
|
1549
|
+
# resp.access_policies.status.state #=> String, one of "RequiresIndexDocuments", "Processing", "Active", "FailedToValidate"
|
|
1550
|
+
# resp.access_policies.status.pending_deletion #=> Boolean
|
|
1551
|
+
#
|
|
1552
|
+
# @overload update_service_access_policies(params = {})
|
|
1553
|
+
# @param [Hash] params ({})
|
|
1554
|
+
def update_service_access_policies(params = {}, options = {})
|
|
1555
|
+
req = build_request(:update_service_access_policies, params)
|
|
1556
|
+
req.send_request(options)
|
|
1557
|
+
end
|
|
1406
1558
|
|
|
1407
|
-
|
|
1408
|
-
# @api private
|
|
1409
|
-
def build_request(operation_name, params = {})
|
|
1410
|
-
handlers = @handlers.for(operation_name)
|
|
1411
|
-
context = Seahorse::Client::RequestContext.new(
|
|
1412
|
-
operation_name: operation_name,
|
|
1413
|
-
operation: config.api.operation(operation_name),
|
|
1414
|
-
client: self,
|
|
1415
|
-
params: params,
|
|
1416
|
-
config: config)
|
|
1417
|
-
context[:gem_name] = 'aws-sdk-cloudsearch'
|
|
1418
|
-
context[:gem_version] = '1.0.0.rc1'
|
|
1419
|
-
Seahorse::Client::Request.new(handlers, context)
|
|
1420
|
-
end
|
|
1559
|
+
# @!endgroup
|
|
1421
1560
|
|
|
1422
|
-
|
|
1423
|
-
|
|
1424
|
-
|
|
1425
|
-
|
|
1426
|
-
|
|
1561
|
+
# @param params ({})
|
|
1562
|
+
# @api private
|
|
1563
|
+
def build_request(operation_name, params = {})
|
|
1564
|
+
handlers = @handlers.for(operation_name)
|
|
1565
|
+
context = Seahorse::Client::RequestContext.new(
|
|
1566
|
+
operation_name: operation_name,
|
|
1567
|
+
operation: config.api.operation(operation_name),
|
|
1568
|
+
client: self,
|
|
1569
|
+
params: params,
|
|
1570
|
+
config: config)
|
|
1571
|
+
context[:gem_name] = 'aws-sdk-cloudsearch'
|
|
1572
|
+
context[:gem_version] = '1.0.0.rc2'
|
|
1573
|
+
Seahorse::Client::Request.new(handlers, context)
|
|
1574
|
+
end
|
|
1427
1575
|
|
|
1428
|
-
|
|
1576
|
+
# @api private
|
|
1577
|
+
# @deprecated
|
|
1578
|
+
def waiter_names
|
|
1579
|
+
[]
|
|
1580
|
+
end
|
|
1429
1581
|
|
|
1430
|
-
|
|
1431
|
-
attr_reader :identifier
|
|
1582
|
+
class << self
|
|
1432
1583
|
|
|
1433
|
-
|
|
1434
|
-
|
|
1435
|
-
Errors
|
|
1436
|
-
end
|
|
1584
|
+
# @api private
|
|
1585
|
+
attr_reader :identifier
|
|
1437
1586
|
|
|
1587
|
+
# @api private
|
|
1588
|
+
def errors_module
|
|
1589
|
+
Errors
|
|
1438
1590
|
end
|
|
1591
|
+
|
|
1439
1592
|
end
|
|
1440
1593
|
end
|
|
1441
1594
|
end
|