CloudSearch class

You use the Amazon CloudSearch configuration service to create, configure, and manage search domains. Configuration service requests are submitted using the AWS Query protocol. AWS Query requests are HTTP or HTTPS requests submitted via HTTP GET or POST with a query parameter named Action.

Constructors

CloudSearch({required String region, AwsClientCredentials? credentials, AwsClientCredentialsProvider? credentialsProvider, Client? client, String? endpointUrl})

Properties

hashCode → int

The hash code for this object.

no setter, inherited

runtimeType → Type

A representation of the runtime type of the object.

no setter, inherited

shapes → Map<String, Shape>

final

Methods

buildSuggesters({required String domainName}) → Future<BuildSuggestersResponse>

Indexes the search suggestions. For more information, see Configuring Suggesters in the Amazon CloudSearch Developer Guide.

close() → void

Closes the internal HTTP client if none was provided at creation. If a client was passed as a constructor argument, this becomes a noop.

createDomain({required String domainName}) → Future<CreateDomainResponse>

Creates a new search domain. For more information, see Creating a Search Domain in the Amazon CloudSearch Developer Guide.

defineAnalysisScheme({required AnalysisScheme analysisScheme, required String domainName}) → Future<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.

defineExpression({required String domainName, required Expression expression}) → Future<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.

defineIndexField({required String domainName, required IndexField indexField}) → Future<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.

defineSuggester({required String domainName, required Suggester suggester}) → Future<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.

deleteAnalysisScheme({required String analysisSchemeName, required String domainName}) → Future<DeleteAnalysisSchemeResponse>

Deletes an analysis scheme. For more information, see Configuring Analysis Schemes in the Amazon CloudSearch Developer Guide.

deleteDomain({required String domainName}) → Future<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.

deleteExpression({required String domainName, required String expressionName}) → Future<DeleteExpressionResponse>

Removes an Expression from the search domain. For more information, see Configuring Expressions in the Amazon CloudSearch Developer Guide.

deleteIndexField({required String domainName, required String indexFieldName}) → Future<DeleteIndexFieldResponse>

Removes an IndexField from the search domain. For more information, see Configuring Index Fields in the Amazon CloudSearch Developer Guide.

deleteSuggester({required String domainName, required String suggesterName}) → Future<DeleteSuggesterResponse>

Deletes a suggester. For more information, see Getting Search Suggestions in the Amazon CloudSearch Developer Guide.

describeAnalysisSchemes({required String domainName, List<String>? analysisSchemeNames, bool? deployed}) → Future<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.

describeAvailabilityOptions({required String domainName, bool? deployed}) → Future<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.

describeDomainEndpointOptions({required String domainName, bool? deployed}) → Future<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.

describeDomains({List<String>? domainNames}) → Future<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.

describeExpressions({required String domainName, bool? deployed, List<String>? expressionNames}) → Future<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.

describeIndexFields({required String domainName, bool? deployed, List<String>? fieldNames}) → Future<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.

describeScalingParameters({required String domainName}) → Future<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.

describeServiceAccessPolicies({required String domainName, bool? deployed}) → Future<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.

describeSuggesters({required String domainName, bool? deployed, List<String>? suggesterNames}) → Future<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.

indexDocuments({required String domainName}) → Future<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.

listDomainNames() → Future<ListDomainNamesResponse>

Lists all search domains owned by an account.

noSuchMethod(Invocation invocation) → dynamic

Invoked when a nonexistent method or property is accessed.

inherited

toString() → String

A string representation of this object.

inherited

updateAvailabilityOptions({required String domainName, required bool multiAZ}) → Future<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.

updateDomainEndpointOptions({required DomainEndpointOptions domainEndpointOptions, required String domainName}) → Future<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.

updateScalingParameters({required String domainName, required ScalingParameters scalingParameters}) → Future<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.

updateServiceAccessPolicies({required String accessPolicies, required String domainName}) → Future<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.

Operators

operator ==(Object other) → bool

The equality operator.

inherited