Class: Aws::CloudSearch::Client
- Inherits:
-
Seahorse::Client::Base
- Object
- Seahorse::Client::Base
- Aws::CloudSearch::Client
- Includes:
- Aws::ClientStubs
- Defined in:
- gems/aws-sdk-cloudsearch/lib/aws-sdk-cloudsearch/client.rb
Overview
An API client for CloudSearch. To construct a client, you need to configure a :region
and :credentials
.
client = Aws::CloudSearch::Client.new(
region: region_name,
credentials: credentials,
# ...
)
For details on configuring region and credentials see the developer guide.
See #initialize for a full list of supported configuration options.
Instance Attribute Summary
Attributes inherited from Seahorse::Client::Base
API Operations collapse
-
#build_suggesters(params = {}) ⇒ Types::BuildSuggestersResponse
Indexes the search suggestions.
-
#create_domain(params = {}) ⇒ Types::CreateDomainResponse
Creates a new search domain.
-
#define_analysis_scheme(params = {}) ⇒ Types::DefineAnalysisSchemeResponse
Configures an analysis scheme that can be applied to a
text
ortext-array
field to define language-specific text processing options. -
#define_expression(params = {}) ⇒ Types::DefineExpressionResponse
Configures an
Expression
for the search domain. -
#define_index_field(params = {}) ⇒ Types::DefineIndexFieldResponse
Configures an
IndexField
for the search domain. -
#define_suggester(params = {}) ⇒ Types::DefineSuggesterResponse
Configures a suggester for a domain.
-
#delete_analysis_scheme(params = {}) ⇒ Types::DeleteAnalysisSchemeResponse
Deletes an analysis scheme.
-
#delete_domain(params = {}) ⇒ Types::DeleteDomainResponse
Permanently deletes a search domain and all of its data.
-
#delete_expression(params = {}) ⇒ Types::DeleteExpressionResponse
Removes an
Expression
from the search domain. -
#delete_index_field(params = {}) ⇒ Types::DeleteIndexFieldResponse
Removes an
IndexField
from the search domain. -
#delete_suggester(params = {}) ⇒ Types::DeleteSuggesterResponse
Deletes a suggester.
-
#describe_analysis_schemes(params = {}) ⇒ Types::DescribeAnalysisSchemesResponse
Gets the analysis schemes configured for a domain.
-
#describe_availability_options(params = {}) ⇒ Types::DescribeAvailabilityOptionsResponse
Gets the availability options configured for a domain.
-
#describe_domain_endpoint_options(params = {}) ⇒ Types::DescribeDomainEndpointOptionsResponse
Returns the domain's endpoint options, specifically whether all requests to the domain must arrive over HTTPS.
-
#describe_domains(params = {}) ⇒ Types::DescribeDomainsResponse
Gets information about the search domains owned by this account.
-
#describe_expressions(params = {}) ⇒ Types::DescribeExpressionsResponse
Gets the expressions configured for the search domain.
-
#describe_index_fields(params = {}) ⇒ Types::DescribeIndexFieldsResponse
Gets information about the index fields configured for the search domain.
-
#describe_scaling_parameters(params = {}) ⇒ Types::DescribeScalingParametersResponse
Gets the scaling parameters configured for a domain.
-
#describe_service_access_policies(params = {}) ⇒ Types::DescribeServiceAccessPoliciesResponse
Gets information about the access policies that control access to the domain's document and search endpoints.
-
#describe_suggesters(params = {}) ⇒ Types::DescribeSuggestersResponse
Gets the suggesters configured for a domain.
-
#index_documents(params = {}) ⇒ Types::IndexDocumentsResponse
Tells the search domain to start indexing its documents using the latest indexing options.
-
#list_domain_names(params = {}) ⇒ Types::ListDomainNamesResponse
Lists all search domains owned by an account.
-
#update_availability_options(params = {}) ⇒ Types::UpdateAvailabilityOptionsResponse
Configures the availability options for a domain.
-
#update_domain_endpoint_options(params = {}) ⇒ Types::UpdateDomainEndpointOptionsResponse
Updates the domain's endpoint options, specifically whether all requests to the domain must arrive over HTTPS.
-
#update_scaling_parameters(params = {}) ⇒ Types::UpdateScalingParametersResponse
Configures scaling parameters for a domain.
-
#update_service_access_policies(params = {}) ⇒ Types::UpdateServiceAccessPoliciesResponse
Configures the access rules that control access to the domain's document and search endpoints.
Instance Method Summary collapse
-
#initialize(options) ⇒ Client
constructor
A new instance of Client.
Methods included from Aws::ClientStubs
#api_requests, #stub_data, #stub_responses
Methods inherited from Seahorse::Client::Base
add_plugin, api, clear_plugins, define, new, #operation_names, plugins, remove_plugin, set_api, set_plugins
Methods included from Seahorse::Client::HandlerBuilder
#handle, #handle_request, #handle_response
Constructor Details
#initialize(options) ⇒ Client
Returns a new instance of Client.
365 366 367 |
# File 'gems/aws-sdk-cloudsearch/lib/aws-sdk-cloudsearch/client.rb', line 365 def initialize(*args) super end |
Instance Method Details
#build_suggesters(params = {}) ⇒ Types::BuildSuggestersResponse
Indexes the search suggestions. For more information, see Configuring Suggesters in the Amazon CloudSearch Developer Guide.
401 402 403 404 |
# File 'gems/aws-sdk-cloudsearch/lib/aws-sdk-cloudsearch/client.rb', line 401 def build_suggesters(params = {}, = {}) req = build_request(:build_suggesters, params) req.send_request() end |
#create_domain(params = {}) ⇒ Types::CreateDomainResponse
Creates a new search domain. For more information, see Creating a Search Domain in the Amazon CloudSearch Developer Guide.
448 449 450 451 |
# File 'gems/aws-sdk-cloudsearch/lib/aws-sdk-cloudsearch/client.rb', line 448 def create_domain(params = {}, = {}) req = build_request(:create_domain, params) req.send_request() end |
#define_analysis_scheme(params = {}) ⇒ Types::DefineAnalysisSchemeResponse
Configures an analysis scheme that can be applied to a text
or
text-array
field to define language-specific text processing
options. For more information, see Configuring Analysis Schemes
in the Amazon CloudSearch Developer Guide.
513 514 515 516 |
# File 'gems/aws-sdk-cloudsearch/lib/aws-sdk-cloudsearch/client.rb', line 513 def define_analysis_scheme(params = {}, = {}) req = build_request(:define_analysis_scheme, params) req.send_request() end |
#define_expression(params = {}) ⇒ Types::DefineExpressionResponse
Configures an Expression
for the search domain. Used to create new
expressions and modify existing ones. If the expression exists, the
new configuration replaces the old one. For more information, see
Configuring Expressions in the Amazon CloudSearch Developer
Guide.
565 566 567 568 |
# File 'gems/aws-sdk-cloudsearch/lib/aws-sdk-cloudsearch/client.rb', line 565 def define_expression(params = {}, = {}) req = build_request(:define_expression, params) req.send_request() end |
#define_index_field(params = {}) ⇒ Types::DefineIndexFieldResponse
Configures an IndexField
for the search domain. Used to create new
fields and modify existing ones. You must specify the name of the
domain you are configuring and an index field configuration. The index
field configuration specifies a unique name, the index field type, and
the options you want to configure for the field. The options you can
specify depend on the IndexFieldType
. If the field exists, the new
configuration replaces the old one. For more information, see
Configuring Index Fields in the Amazon CloudSearch Developer
Guide.
763 764 765 766 |
# File 'gems/aws-sdk-cloudsearch/lib/aws-sdk-cloudsearch/client.rb', line 763 def define_index_field(params = {}, = {}) req = build_request(:define_index_field, params) req.send_request() end |
#define_suggester(params = {}) ⇒ Types::DefineSuggesterResponse
Configures a suggester for a domain. A suggester enables you to display possible matches before users finish typing their queries. When you configure a suggester, you must specify the name of the text field you want to search for possible matches and a unique name for the suggester. For more information, see Getting Search Suggestions in the Amazon CloudSearch Developer Guide.
823 824 825 826 |
# File 'gems/aws-sdk-cloudsearch/lib/aws-sdk-cloudsearch/client.rb', line 823 def define_suggester(params = {}, = {}) req = build_request(:define_suggester, params) req.send_request() end |
#delete_analysis_scheme(params = {}) ⇒ Types::DeleteAnalysisSchemeResponse
Deletes an analysis scheme. For more information, see Configuring Analysis Schemes in the Amazon CloudSearch Developer Guide.
872 873 874 875 |
# File 'gems/aws-sdk-cloudsearch/lib/aws-sdk-cloudsearch/client.rb', line 872 def delete_analysis_scheme(params = {}, = {}) req = build_request(:delete_analysis_scheme, params) req.send_request() end |
#delete_domain(params = {}) ⇒ Types::DeleteDomainResponse
Permanently deletes a search domain and all of its data. Once a domain has been deleted, it cannot be recovered. For more information, see Deleting a Search Domain in the Amazon CloudSearch Developer Guide.
918 919 920 921 |
# File 'gems/aws-sdk-cloudsearch/lib/aws-sdk-cloudsearch/client.rb', line 918 def delete_domain(params = {}, = {}) req = build_request(:delete_domain, params) req.send_request() end |
#delete_expression(params = {}) ⇒ Types::DeleteExpressionResponse
Removes an Expression
from the search domain. For more information,
see Configuring Expressions in the Amazon CloudSearch Developer
Guide.
963 964 965 966 |
# File 'gems/aws-sdk-cloudsearch/lib/aws-sdk-cloudsearch/client.rb', line 963 def delete_expression(params = {}, = {}) req = build_request(:delete_expression, params) req.send_request() end |
#delete_index_field(params = {}) ⇒ Types::DeleteIndexFieldResponse
Removes an IndexField
from the search domain. For more information,
see Configuring Index Fields in the Amazon CloudSearch Developer
Guide.
1070 1071 1072 1073 |
# File 'gems/aws-sdk-cloudsearch/lib/aws-sdk-cloudsearch/client.rb', line 1070 def delete_index_field(params = {}, = {}) req = build_request(:delete_index_field, params) req.send_request() end |
#delete_suggester(params = {}) ⇒ Types::DeleteSuggesterResponse
Deletes a suggester. For more information, see Getting Search Suggestions in the Amazon CloudSearch Developer Guide.
1116 1117 1118 1119 |
# File 'gems/aws-sdk-cloudsearch/lib/aws-sdk-cloudsearch/client.rb', line 1116 def delete_suggester(params = {}, = {}) req = build_request(:delete_suggester, params) req.send_request() end |
#describe_analysis_schemes(params = {}) ⇒ Types::DescribeAnalysisSchemesResponse
Gets the analysis schemes configured for a domain. An analysis scheme
defines language-specific text processing options for a text
field.
Can be limited to specific analysis schemes by name. By default, shows
all analysis schemes and includes any pending changes to the
configuration. Set the Deployed
option to true
to show the active
configuration and exclude pending changes. For more information, see
Configuring Analysis Schemes in the Amazon CloudSearch Developer
Guide.
1174 1175 1176 1177 |
# File 'gems/aws-sdk-cloudsearch/lib/aws-sdk-cloudsearch/client.rb', line 1174 def describe_analysis_schemes(params = {}, = {}) req = build_request(:describe_analysis_schemes, params) req.send_request() end |
#describe_availability_options(params = {}) ⇒ Types::DescribeAvailabilityOptionsResponse
Gets the availability options configured for a domain. By default,
shows the configuration with any pending changes. Set the Deployed
option to true
to show the active configuration and exclude pending
changes. For more information, see Configuring Availability
Options in the Amazon CloudSearch Developer Guide.
1218 1219 1220 1221 |
# File 'gems/aws-sdk-cloudsearch/lib/aws-sdk-cloudsearch/client.rb', line 1218 def (params = {}, = {}) req = build_request(:describe_availability_options, params) req.send_request() end |
#describe_domain_endpoint_options(params = {}) ⇒ Types::DescribeDomainEndpointOptionsResponse
Returns the domain's endpoint options, specifically whether all requests to the domain must arrive over HTTPS. For more information, see Configuring Domain Endpoint Options in the Amazon CloudSearch Developer Guide.
1263 1264 1265 1266 |
# File 'gems/aws-sdk-cloudsearch/lib/aws-sdk-cloudsearch/client.rb', line 1263 def (params = {}, = {}) req = build_request(:describe_domain_endpoint_options, params) req.send_request() end |
#describe_domains(params = {}) ⇒ Types::DescribeDomainsResponse
Gets information about the search domains owned by this account. Can
be limited to specific domains. Shows all domains by default. To get
the number of searchable documents in a domain, use the console or
submit a matchall
request to your domain's search endpoint:
q=matchall&q.parser=structured&size=0
. For more information,
see Getting Information about a Search Domain in the Amazon
CloudSearch Developer Guide.
1313 1314 1315 1316 |
# File 'gems/aws-sdk-cloudsearch/lib/aws-sdk-cloudsearch/client.rb', line 1313 def describe_domains(params = {}, = {}) req = build_request(:describe_domains, params) req.send_request() end |
#describe_expressions(params = {}) ⇒ Types::DescribeExpressionsResponse
Gets the expressions configured for the search domain. Can be limited
to specific expressions by name. By default, shows all expressions and
includes any pending changes to the configuration. Set the Deployed
option to true
to show the active configuration and exclude pending
changes. For more information, see Configuring Expressions in the
Amazon CloudSearch Developer Guide.
1365 1366 1367 1368 |
# File 'gems/aws-sdk-cloudsearch/lib/aws-sdk-cloudsearch/client.rb', line 1365 def describe_expressions(params = {}, = {}) req = build_request(:describe_expressions, params) req.send_request() end |
#describe_index_fields(params = {}) ⇒ Types::DescribeIndexFieldsResponse
Gets information about the index fields configured for the search
domain. Can be limited to specific fields by name. By default, shows
all fields and includes any pending changes to the configuration. Set
the Deployed
option to true
to show the active configuration and
exclude pending changes. For more information, see Getting Domain
Information in the Amazon CloudSearch Developer Guide.
1478 1479 1480 1481 |
# File 'gems/aws-sdk-cloudsearch/lib/aws-sdk-cloudsearch/client.rb', line 1478 def describe_index_fields(params = {}, = {}) req = build_request(:describe_index_fields, params) req.send_request() end |
#describe_scaling_parameters(params = {}) ⇒ Types::DescribeScalingParametersResponse
Gets the scaling parameters configured for a domain. A domain's scaling parameters specify the desired search instance type and replication count. For more information, see Configuring Scaling Options in the Amazon CloudSearch Developer Guide.
1521 1522 1523 1524 |
# File 'gems/aws-sdk-cloudsearch/lib/aws-sdk-cloudsearch/client.rb', line 1521 def describe_scaling_parameters(params = {}, = {}) req = build_request(:describe_scaling_parameters, params) req.send_request() end |
#describe_service_access_policies(params = {}) ⇒ Types::DescribeServiceAccessPoliciesResponse
Gets information about the access policies that control access to the
domain's document and search endpoints. By default, shows the
configuration with any pending changes. Set the Deployed
option to
true
to show the active configuration and exclude pending changes.
For more information, see Configuring Access for a Search Domain
in the Amazon CloudSearch Developer Guide.
1566 1567 1568 1569 |
# File 'gems/aws-sdk-cloudsearch/lib/aws-sdk-cloudsearch/client.rb', line 1566 def describe_service_access_policies(params = {}, = {}) req = build_request(:describe_service_access_policies, params) req.send_request() end |
#describe_suggesters(params = {}) ⇒ Types::DescribeSuggestersResponse
Gets the suggesters configured for a domain. A suggester enables you
to display possible matches before users finish typing their queries.
Can be limited to specific suggesters by name. By default, shows all
suggesters and includes any pending changes to the configuration. Set
the Deployed
option to true
to show the active configuration and
exclude pending changes. For more information, see Getting Search
Suggestions in the Amazon CloudSearch Developer Guide.
1620 1621 1622 1623 |
# File 'gems/aws-sdk-cloudsearch/lib/aws-sdk-cloudsearch/client.rb', line 1620 def describe_suggesters(params = {}, = {}) req = build_request(:describe_suggesters, params) req.send_request() end |
#index_documents(params = {}) ⇒ Types::IndexDocumentsResponse
Tells the search domain to start indexing its documents using the
latest indexing options. This operation must be invoked to activate
options whose OptionStatus is RequiresIndexDocuments
.
1652 1653 1654 1655 |
# File 'gems/aws-sdk-cloudsearch/lib/aws-sdk-cloudsearch/client.rb', line 1652 def index_documents(params = {}, = {}) req = build_request(:index_documents, params) req.send_request() end |
#list_domain_names(params = {}) ⇒ Types::ListDomainNamesResponse
Lists all search domains owned by an account.
1670 1671 1672 1673 |
# File 'gems/aws-sdk-cloudsearch/lib/aws-sdk-cloudsearch/client.rb', line 1670 def list_domain_names(params = {}, = {}) req = build_request(:list_domain_names, params) req.send_request() end |
#update_availability_options(params = {}) ⇒ Types::UpdateAvailabilityOptionsResponse
Configures the availability options for a domain. Enabling the Multi-AZ option expands an Amazon CloudSearch domain to an additional Availability Zone in the same Region to increase fault tolerance in the event of a service disruption. Changes to the Multi-AZ option can take about half an hour to become active. For more information, see Configuring Availability Options in the Amazon CloudSearch Developer Guide.
1721 1722 1723 1724 |
# File 'gems/aws-sdk-cloudsearch/lib/aws-sdk-cloudsearch/client.rb', line 1721 def (params = {}, = {}) req = build_request(:update_availability_options, params) req.send_request() end |
#update_domain_endpoint_options(params = {}) ⇒ Types::UpdateDomainEndpointOptionsResponse
Updates the domain's endpoint options, specifically whether all requests to the domain must arrive over HTTPS. For more information, see Configuring Domain Endpoint Options in the Amazon CloudSearch Developer Guide.
1770 1771 1772 1773 |
# File 'gems/aws-sdk-cloudsearch/lib/aws-sdk-cloudsearch/client.rb', line 1770 def (params = {}, = {}) req = build_request(:update_domain_endpoint_options, params) req.send_request() end |
#update_scaling_parameters(params = {}) ⇒ Types::UpdateScalingParametersResponse
Configures scaling parameters for a domain. A domain's scaling parameters specify the desired search instance type and replication count. Amazon CloudSearch will still automatically scale your domain based on the volume of data and traffic, but not below the desired instance type and replication count. If the Multi-AZ option is enabled, these values control the resources used per Availability Zone. For more information, see Configuring Scaling Options in the Amazon CloudSearch Developer Guide.
1826 1827 1828 1829 |
# File 'gems/aws-sdk-cloudsearch/lib/aws-sdk-cloudsearch/client.rb', line 1826 def update_scaling_parameters(params = {}, = {}) req = build_request(:update_scaling_parameters, params) req.send_request() end |
#update_service_access_policies(params = {}) ⇒ Types::UpdateServiceAccessPoliciesResponse
Configures the access rules that control access to the domain's document and search endpoints. For more information, see Configuring Access for an Amazon CloudSearch Domain.
1871 1872 1873 1874 |
# File 'gems/aws-sdk-cloudsearch/lib/aws-sdk-cloudsearch/client.rb', line 1871 def update_service_access_policies(params = {}, = {}) req = build_request(:update_service_access_policies, params) req.send_request() end |