commonMain.aws.sdk.kotlin.services.cloudsearch.CloudSearchClient.kt Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of cloudsearch-jvm Show documentation
Show all versions of cloudsearch-jvm Show documentation
The AWS SDK for Kotlin client for CloudSearch
// Code generated by smithy-kotlin-codegen. DO NOT EDIT!
package aws.sdk.kotlin.services.cloudsearch
import aws.sdk.kotlin.runtime.auth.credentials.DefaultChainCredentialsProvider
import aws.sdk.kotlin.runtime.auth.credentials.internal.manage
import aws.sdk.kotlin.runtime.client.AwsSdkClientConfig
import aws.sdk.kotlin.runtime.config.AbstractAwsSdkClientFactory
import aws.sdk.kotlin.runtime.config.endpoints.resolveEndpointUrl
import aws.sdk.kotlin.runtime.config.profile.AwsProfile
import aws.sdk.kotlin.runtime.config.profile.AwsSharedConfig
import aws.sdk.kotlin.runtime.http.retries.AwsRetryPolicy
import aws.sdk.kotlin.services.cloudsearch.auth.CloudSearchAuthSchemeProvider
import aws.sdk.kotlin.services.cloudsearch.auth.DefaultCloudSearchAuthSchemeProvider
import aws.sdk.kotlin.services.cloudsearch.endpoints.CloudSearchEndpointParameters
import aws.sdk.kotlin.services.cloudsearch.endpoints.CloudSearchEndpointProvider
import aws.sdk.kotlin.services.cloudsearch.endpoints.DefaultCloudSearchEndpointProvider
import aws.sdk.kotlin.services.cloudsearch.model.BuildSuggestersRequest
import aws.sdk.kotlin.services.cloudsearch.model.BuildSuggestersResponse
import aws.sdk.kotlin.services.cloudsearch.model.CreateDomainRequest
import aws.sdk.kotlin.services.cloudsearch.model.CreateDomainResponse
import aws.sdk.kotlin.services.cloudsearch.model.DefineAnalysisSchemeRequest
import aws.sdk.kotlin.services.cloudsearch.model.DefineAnalysisSchemeResponse
import aws.sdk.kotlin.services.cloudsearch.model.DefineExpressionRequest
import aws.sdk.kotlin.services.cloudsearch.model.DefineExpressionResponse
import aws.sdk.kotlin.services.cloudsearch.model.DefineIndexFieldRequest
import aws.sdk.kotlin.services.cloudsearch.model.DefineIndexFieldResponse
import aws.sdk.kotlin.services.cloudsearch.model.DefineSuggesterRequest
import aws.sdk.kotlin.services.cloudsearch.model.DefineSuggesterResponse
import aws.sdk.kotlin.services.cloudsearch.model.DeleteAnalysisSchemeRequest
import aws.sdk.kotlin.services.cloudsearch.model.DeleteAnalysisSchemeResponse
import aws.sdk.kotlin.services.cloudsearch.model.DeleteDomainRequest
import aws.sdk.kotlin.services.cloudsearch.model.DeleteDomainResponse
import aws.sdk.kotlin.services.cloudsearch.model.DeleteExpressionRequest
import aws.sdk.kotlin.services.cloudsearch.model.DeleteExpressionResponse
import aws.sdk.kotlin.services.cloudsearch.model.DeleteIndexFieldRequest
import aws.sdk.kotlin.services.cloudsearch.model.DeleteIndexFieldResponse
import aws.sdk.kotlin.services.cloudsearch.model.DeleteSuggesterRequest
import aws.sdk.kotlin.services.cloudsearch.model.DeleteSuggesterResponse
import aws.sdk.kotlin.services.cloudsearch.model.DescribeAnalysisSchemesRequest
import aws.sdk.kotlin.services.cloudsearch.model.DescribeAnalysisSchemesResponse
import aws.sdk.kotlin.services.cloudsearch.model.DescribeAvailabilityOptionsRequest
import aws.sdk.kotlin.services.cloudsearch.model.DescribeAvailabilityOptionsResponse
import aws.sdk.kotlin.services.cloudsearch.model.DescribeDomainEndpointOptionsRequest
import aws.sdk.kotlin.services.cloudsearch.model.DescribeDomainEndpointOptionsResponse
import aws.sdk.kotlin.services.cloudsearch.model.DescribeDomainsRequest
import aws.sdk.kotlin.services.cloudsearch.model.DescribeDomainsResponse
import aws.sdk.kotlin.services.cloudsearch.model.DescribeExpressionsRequest
import aws.sdk.kotlin.services.cloudsearch.model.DescribeExpressionsResponse
import aws.sdk.kotlin.services.cloudsearch.model.DescribeIndexFieldsRequest
import aws.sdk.kotlin.services.cloudsearch.model.DescribeIndexFieldsResponse
import aws.sdk.kotlin.services.cloudsearch.model.DescribeScalingParametersRequest
import aws.sdk.kotlin.services.cloudsearch.model.DescribeScalingParametersResponse
import aws.sdk.kotlin.services.cloudsearch.model.DescribeServiceAccessPoliciesRequest
import aws.sdk.kotlin.services.cloudsearch.model.DescribeServiceAccessPoliciesResponse
import aws.sdk.kotlin.services.cloudsearch.model.DescribeSuggestersRequest
import aws.sdk.kotlin.services.cloudsearch.model.DescribeSuggestersResponse
import aws.sdk.kotlin.services.cloudsearch.model.IndexDocumentsRequest
import aws.sdk.kotlin.services.cloudsearch.model.IndexDocumentsResponse
import aws.sdk.kotlin.services.cloudsearch.model.ListDomainNamesRequest
import aws.sdk.kotlin.services.cloudsearch.model.ListDomainNamesResponse
import aws.sdk.kotlin.services.cloudsearch.model.UpdateAvailabilityOptionsRequest
import aws.sdk.kotlin.services.cloudsearch.model.UpdateAvailabilityOptionsResponse
import aws.sdk.kotlin.services.cloudsearch.model.UpdateDomainEndpointOptionsRequest
import aws.sdk.kotlin.services.cloudsearch.model.UpdateDomainEndpointOptionsResponse
import aws.sdk.kotlin.services.cloudsearch.model.UpdateScalingParametersRequest
import aws.sdk.kotlin.services.cloudsearch.model.UpdateScalingParametersResponse
import aws.sdk.kotlin.services.cloudsearch.model.UpdateServiceAccessPoliciesRequest
import aws.sdk.kotlin.services.cloudsearch.model.UpdateServiceAccessPoliciesResponse
import aws.smithy.kotlin.runtime.auth.awscredentials.CredentialsProvider
import aws.smithy.kotlin.runtime.auth.awscredentials.CredentialsProviderConfig
import aws.smithy.kotlin.runtime.awsprotocol.ClockSkewInterceptor
import aws.smithy.kotlin.runtime.client.AbstractSdkClientBuilder
import aws.smithy.kotlin.runtime.client.LogMode
import aws.smithy.kotlin.runtime.client.RetryClientConfig
import aws.smithy.kotlin.runtime.client.RetryStrategyClientConfig
import aws.smithy.kotlin.runtime.client.RetryStrategyClientConfigImpl
import aws.smithy.kotlin.runtime.client.SdkClient
import aws.smithy.kotlin.runtime.client.SdkClientConfig
import aws.smithy.kotlin.runtime.client.SdkClientFactory
import aws.smithy.kotlin.runtime.http.auth.AuthScheme
import aws.smithy.kotlin.runtime.http.auth.HttpAuthConfig
import aws.smithy.kotlin.runtime.http.config.HttpClientConfig
import aws.smithy.kotlin.runtime.http.config.HttpEngineConfig
import aws.smithy.kotlin.runtime.http.engine.HttpClientEngine
import aws.smithy.kotlin.runtime.http.engine.HttpEngineConfigImpl
import aws.smithy.kotlin.runtime.http.interceptors.HttpInterceptor
import aws.smithy.kotlin.runtime.net.url.Url
import aws.smithy.kotlin.runtime.retries.RetryStrategy
import aws.smithy.kotlin.runtime.retries.policy.RetryPolicy
import aws.smithy.kotlin.runtime.telemetry.Global
import aws.smithy.kotlin.runtime.telemetry.TelemetryConfig
import aws.smithy.kotlin.runtime.telemetry.TelemetryProvider
import aws.smithy.kotlin.runtime.util.LazyAsyncValue
import kotlin.collections.List
import kotlin.jvm.JvmStatic
public const val ServiceId: String = "CloudSearch"
public const val SdkVersion: String = "1.1.24"
public const val ServiceApiVersion: String = "2013-01-01"
/**
* # Amazon CloudSearch Configuration Service
* 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.
*
* The endpoint for configuration service requests is region-specific: cloudsearch.*region*.amazonaws.com. For example, cloudsearch.us-east-1.amazonaws.com. For a current list of supported regions and endpoints, see [Regions and Endpoints](http://docs.aws.amazon.com/general/latest/gr/rande.html#cloudsearch_region).
*/
public interface CloudSearchClient : SdkClient {
/**
* CloudSearchClient's configuration
*/
public override val config: Config
public companion object : AbstractAwsSdkClientFactory() {
@JvmStatic
override fun builder(): Builder = Builder()
override suspend fun finalizeConfig(builder: Builder, sharedConfig: LazyAsyncValue, activeProfile: LazyAsyncValue) {
builder.config.endpointUrl = builder.config.endpointUrl ?: resolveEndpointUrl(
sharedConfig,
"CloudSearch",
"CLOUDSEARCH",
"cloudsearch",
)
builder.config.interceptors.add(0, ClockSkewInterceptor())
}
}
public class Builder internal constructor(): AbstractSdkClientBuilder() {
override val config: Config.Builder = Config.Builder()
override fun newClient(config: Config): CloudSearchClient = DefaultCloudSearchClient(config)
}
public class Config private constructor(builder: Builder) : AwsSdkClientConfig, CredentialsProviderConfig, HttpAuthConfig, HttpClientConfig, HttpEngineConfig by builder.buildHttpEngineConfig(), RetryClientConfig, RetryStrategyClientConfig by builder.buildRetryStrategyClientConfig(), SdkClientConfig, TelemetryConfig {
override val clientName: String = builder.clientName
override val region: String? = builder.region
override val authSchemes: kotlin.collections.List = builder.authSchemes
override val credentialsProvider: CredentialsProvider = builder.credentialsProvider ?: DefaultChainCredentialsProvider(httpClient = httpClient, region = region).manage()
public val endpointProvider: CloudSearchEndpointProvider = builder.endpointProvider ?: DefaultCloudSearchEndpointProvider()
public val endpointUrl: Url? = builder.endpointUrl
override val interceptors: kotlin.collections.List = builder.interceptors
override val logMode: LogMode = builder.logMode ?: LogMode.Default
override val retryPolicy: RetryPolicy = builder.retryPolicy ?: AwsRetryPolicy.Default
override val telemetryProvider: TelemetryProvider = builder.telemetryProvider ?: TelemetryProvider.Global
override val useDualStack: Boolean = builder.useDualStack ?: false
override val useFips: Boolean = builder.useFips ?: false
override val applicationId: String? = builder.applicationId
public val authSchemeProvider: CloudSearchAuthSchemeProvider = builder.authSchemeProvider ?: DefaultCloudSearchAuthSchemeProvider()
public companion object {
public inline operator fun invoke(block: Builder.() -> kotlin.Unit): Config = Builder().apply(block).build()
}
public fun toBuilder(): Builder = Builder().apply {
clientName = [email protected]
region = [email protected]
authSchemes = [email protected]
credentialsProvider = [email protected]
endpointProvider = [email protected]
endpointUrl = [email protected]
httpClient = [email protected]
interceptors = [email protected]()
logMode = [email protected]
retryPolicy = [email protected]
retryStrategy = [email protected]
telemetryProvider = [email protected]
useDualStack = [email protected]
useFips = [email protected]
applicationId = [email protected]
authSchemeProvider = [email protected]
}
public class Builder : AwsSdkClientConfig.Builder, CredentialsProviderConfig.Builder, HttpAuthConfig.Builder, HttpClientConfig.Builder, HttpEngineConfig.Builder by HttpEngineConfigImpl.BuilderImpl(), RetryClientConfig.Builder, RetryStrategyClientConfig.Builder by RetryStrategyClientConfigImpl.BuilderImpl(), SdkClientConfig.Builder, TelemetryConfig.Builder {
/**
* A reader-friendly name for the client.
*/
override var clientName: String = "CloudSearch"
/**
* The AWS region (e.g. `us-west-2`) to make requests to. See about AWS
* [global infrastructure](https://aws.amazon.com/about-aws/global-infrastructure/regions_az/) for more
* information
*/
override var region: String? = null
/**
* Register new or override default [AuthScheme]s configured for this client. By default, the set
* of auth schemes configured comes from the service model. An auth scheme configured explicitly takes
* precedence over the defaults and can be used to customize identity resolution and signing for specific
* authentication schemes.
*/
override var authSchemes: kotlin.collections.List = emptyList()
/**
* The AWS credentials provider to use for authenticating requests. If not provided a
* [aws.sdk.kotlin.runtime.auth.credentials.DefaultChainCredentialsProvider] instance will be used.
* NOTE: The caller is responsible for managing the lifetime of the provider when set. The SDK
* client will not close it when the client is closed.
*/
override var credentialsProvider: CredentialsProvider? = null
/**
* The endpoint provider used to determine where to make service requests. **This is an advanced config
* option.**
*
* Endpoint resolution occurs as part of the workflow for every request made via the service client.
*
* The inputs to endpoint resolution are defined on a per-service basis (see [EndpointParameters]).
*/
public var endpointProvider: CloudSearchEndpointProvider? = null
/**
* A custom endpoint to route requests to. The endpoint set here is passed to the configured
* [endpointProvider], which may inspect and modify it as needed.
*
* Setting a custom endpointUrl should generally be preferred to overriding the [endpointProvider] and is
* the recommended way to route requests to development or preview instances of a service.
*
* **This is an advanced config option.**
*/
public var endpointUrl: Url? = null
/**
* Add an [aws.smithy.kotlin.runtime.client.Interceptor] that will have access to read and modify
* the request and response objects as they are processed by the SDK.
* Interceptors added using this method are executed in the order they are configured and are always
* later than any added automatically by the SDK.
*/
override var interceptors: kotlin.collections.MutableList = kotlin.collections.mutableListOf()
/**
* Configure events that will be logged. By default clients will not output
* raw requests or responses. Use this setting to opt-in to additional debug logging.
*
* This can be used to configure logging of requests, responses, retries, etc of SDK clients.
*
* **NOTE**: Logging of raw requests or responses may leak sensitive information! It may also have
* performance considerations when dumping the request/response body. This is primarily a tool for
* debug purposes.
*/
override var logMode: LogMode? = null
/**
* The policy to use for evaluating operation results and determining whether/how to retry.
*/
override var retryPolicy: RetryPolicy? = null
/**
* The telemetry provider used to instrument the SDK operations with. By default, the global telemetry
* provider will be used.
*/
override var telemetryProvider: TelemetryProvider? = null
/**
* Flag to toggle whether to use dual-stack endpoints when making requests.
* See [https://docs.aws.amazon.com/sdkref/latest/guide/feature-endpoints.html] for more information.
* ` Disabled by default.
*/
override var useDualStack: Boolean? = null
/**
* Flag to toggle whether to use [FIPS](https://aws.amazon.com/compliance/fips/) endpoints when making requests.
* ` Disabled by default.
*/
override var useFips: Boolean? = null
/**
* An optional application specific identifier.
* When set it will be appended to the User-Agent header of every request in the form of: `app/{applicationId}`.
* When not explicitly set, the value will be loaded from the following locations:
*
* - JVM System Property: `aws.userAgentAppId`
* - Environment variable: `AWS_SDK_UA_APP_ID`
* - Shared configuration profile attribute: `sdk_ua_app_id`
*
* See [shared configuration settings](https://docs.aws.amazon.com/sdkref/latest/guide/settings-reference.html)
* reference for more information on environment variables and shared config settings.
*/
override var applicationId: String? = null
/**
* Configure the provider used to resolve the authentication scheme to use for a particular operation.
*/
public var authSchemeProvider: CloudSearchAuthSchemeProvider? = null
override fun build(): Config = Config(this)
}
}
/**
* Indexes the search suggestions. For more information, see [Configuring Suggesters](http://docs.aws.amazon.com/cloudsearch/latest/developerguide/getting-suggestions.html#configuring-suggesters) in the *Amazon CloudSearch Developer Guide*.
*/
public suspend fun buildSuggesters(input: BuildSuggestersRequest): BuildSuggestersResponse
/**
* Creates a new search domain. For more information, see [Creating a Search Domain](http://docs.aws.amazon.com/cloudsearch/latest/developerguide/creating-domains.html) in the *Amazon CloudSearch Developer Guide*.
*/
public suspend fun createDomain(input: CreateDomainRequest): CreateDomainResponse
/**
* 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](http://docs.aws.amazon.com/cloudsearch/latest/developerguide/configuring-analysis-schemes.html) in the *Amazon CloudSearch Developer Guide*.
*/
public suspend fun defineAnalysisScheme(input: DefineAnalysisSchemeRequest): DefineAnalysisSchemeResponse
/**
* 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](http://docs.aws.amazon.com/cloudsearch/latest/developerguide/configuring-expressions.html) in the *Amazon CloudSearch Developer Guide*.
*/
public suspend fun defineExpression(input: DefineExpressionRequest): DefineExpressionResponse
/**
* 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](http://docs.aws.amazon.com/cloudsearch/latest/developerguide/configuring-index-fields.html) in the *Amazon CloudSearch Developer Guide*.
*/
public suspend fun defineIndexField(input: DefineIndexFieldRequest): DefineIndexFieldResponse
/**
* 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](http://docs.aws.amazon.com/cloudsearch/latest/developerguide/getting-suggestions.html) in the *Amazon CloudSearch Developer Guide*.
*/
public suspend fun defineSuggester(input: DefineSuggesterRequest): DefineSuggesterResponse
/**
* Deletes an analysis scheme. For more information, see [Configuring Analysis Schemes](http://docs.aws.amazon.com/cloudsearch/latest/developerguide/configuring-analysis-schemes.html) in the *Amazon CloudSearch Developer Guide*.
*/
public suspend fun deleteAnalysisScheme(input: DeleteAnalysisSchemeRequest): DeleteAnalysisSchemeResponse
/**
* 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](http://docs.aws.amazon.com/cloudsearch/latest/developerguide/deleting-domains.html) in the *Amazon CloudSearch Developer Guide*.
*/
public suspend fun deleteDomain(input: DeleteDomainRequest): DeleteDomainResponse
/**
* Removes an `Expression` from the search domain. For more information, see [Configuring Expressions](http://docs.aws.amazon.com/cloudsearch/latest/developerguide/configuring-expressions.html) in the *Amazon CloudSearch Developer Guide*.
*/
public suspend fun deleteExpression(input: DeleteExpressionRequest): DeleteExpressionResponse
/**
* Removes an `IndexField` from the search domain. For more information, see [Configuring Index Fields](http://docs.aws.amazon.com/cloudsearch/latest/developerguide/configuring-index-fields.html) in the *Amazon CloudSearch Developer Guide*.
*/
public suspend fun deleteIndexField(input: DeleteIndexFieldRequest): DeleteIndexFieldResponse
/**
* Deletes a suggester. For more information, see [Getting Search Suggestions](http://docs.aws.amazon.com/cloudsearch/latest/developerguide/getting-suggestions.html) in the *Amazon CloudSearch Developer Guide*.
*/
public suspend fun deleteSuggester(input: DeleteSuggesterRequest): DeleteSuggesterResponse
/**
* 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](http://docs.aws.amazon.com/cloudsearch/latest/developerguide/configuring-analysis-schemes.html) in the *Amazon CloudSearch Developer Guide*.
*/
public suspend fun describeAnalysisSchemes(input: DescribeAnalysisSchemesRequest): DescribeAnalysisSchemesResponse
/**
* 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](http://docs.aws.amazon.com/cloudsearch/latest/developerguide/configuring-availability-options.html) in the *Amazon CloudSearch Developer Guide*.
*/
public suspend fun describeAvailabilityOptions(input: DescribeAvailabilityOptionsRequest): DescribeAvailabilityOptionsResponse
/**
* 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](http://docs.aws.amazon.com/cloudsearch/latest/developerguide/configuring-domain-endpoint-options.html) in the *Amazon CloudSearch Developer Guide*.
*/
public suspend fun describeDomainEndpointOptions(input: DescribeDomainEndpointOptionsRequest): DescribeDomainEndpointOptionsResponse
/**
* 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](http://docs.aws.amazon.com/cloudsearch/latest/developerguide/getting-domain-info.html) in the *Amazon CloudSearch Developer Guide*.
*/
public suspend fun describeDomains(input: DescribeDomainsRequest = DescribeDomainsRequest { }): DescribeDomainsResponse
/**
* 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](http://docs.aws.amazon.com/cloudsearch/latest/developerguide/configuring-expressions.html) in the *Amazon CloudSearch Developer Guide*.
*/
public suspend fun describeExpressions(input: DescribeExpressionsRequest): DescribeExpressionsResponse
/**
* 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](http://docs.aws.amazon.com/cloudsearch/latest/developerguide/getting-domain-info.html) in the *Amazon CloudSearch Developer Guide*.
*/
public suspend fun describeIndexFields(input: DescribeIndexFieldsRequest): DescribeIndexFieldsResponse
/**
* 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](http://docs.aws.amazon.com/cloudsearch/latest/developerguide/configuring-scaling-options.html) in the *Amazon CloudSearch Developer Guide*.
*/
public suspend fun describeScalingParameters(input: DescribeScalingParametersRequest): DescribeScalingParametersResponse
/**
* 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](http://docs.aws.amazon.com/cloudsearch/latest/developerguide/configuring-access.html) in the *Amazon CloudSearch Developer Guide*.
*/
public suspend fun describeServiceAccessPolicies(input: DescribeServiceAccessPoliciesRequest): DescribeServiceAccessPoliciesResponse
/**
* 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](http://docs.aws.amazon.com/cloudsearch/latest/developerguide/getting-suggestions.html) in the *Amazon CloudSearch Developer Guide*.
*/
public suspend fun describeSuggesters(input: DescribeSuggestersRequest): DescribeSuggestersResponse
/**
* 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`.
*/
public suspend fun indexDocuments(input: IndexDocumentsRequest): IndexDocumentsResponse
/**
* Lists all search domains owned by an account.
*/
public suspend fun listDomainNames(input: ListDomainNamesRequest = ListDomainNamesRequest { }): ListDomainNamesResponse
/**
* 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](http://docs.aws.amazon.com/cloudsearch/latest/developerguide/configuring-availability-options.html) in the *Amazon CloudSearch Developer Guide*.
*/
public suspend fun updateAvailabilityOptions(input: UpdateAvailabilityOptionsRequest): UpdateAvailabilityOptionsResponse
/**
* 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](http://docs.aws.amazon.com/cloudsearch/latest/developerguide/configuring-domain-endpoint-options.html) in the *Amazon CloudSearch Developer Guide*.
*/
public suspend fun updateDomainEndpointOptions(input: UpdateDomainEndpointOptionsRequest): UpdateDomainEndpointOptionsResponse
/**
* 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](http://docs.aws.amazon.com/cloudsearch/latest/developerguide/configuring-scaling-options.html) in the *Amazon CloudSearch Developer Guide*.
*/
public suspend fun updateScalingParameters(input: UpdateScalingParametersRequest): UpdateScalingParametersResponse
/**
* 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](http://docs.aws.amazon.com/cloudsearch/latest/developerguide/configuring-access.html).
*/
public suspend fun updateServiceAccessPolicies(input: UpdateServiceAccessPoliciesRequest): UpdateServiceAccessPoliciesResponse
}
/**
* Create a copy of the client with one or more configuration values overridden.
* This method allows the caller to perform scoped config overrides for one or more client operations.
*
* Any resources created on your behalf will be shared between clients, and will only be closed when ALL clients using them are closed.
* If you provide a resource (e.g. [HttpClientEngine]) to the SDK, you are responsible for managing the lifetime of that resource.
*/
public fun CloudSearchClient.withConfig(block: CloudSearchClient.Config.Builder.() -> Unit): CloudSearchClient {
val newConfig = config.toBuilder().apply(block).build()
return DefaultCloudSearchClient(newConfig)
}
/**
* Indexes the search suggestions. For more information, see [Configuring Suggesters](http://docs.aws.amazon.com/cloudsearch/latest/developerguide/getting-suggestions.html#configuring-suggesters) in the *Amazon CloudSearch Developer Guide*.
*/
public suspend inline fun CloudSearchClient.buildSuggesters(crossinline block: BuildSuggestersRequest.Builder.() -> Unit): BuildSuggestersResponse = buildSuggesters(BuildSuggestersRequest.Builder().apply(block).build())
/**
* Creates a new search domain. For more information, see [Creating a Search Domain](http://docs.aws.amazon.com/cloudsearch/latest/developerguide/creating-domains.html) in the *Amazon CloudSearch Developer Guide*.
*/
public suspend inline fun CloudSearchClient.createDomain(crossinline block: CreateDomainRequest.Builder.() -> Unit): CreateDomainResponse = createDomain(CreateDomainRequest.Builder().apply(block).build())
/**
* 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](http://docs.aws.amazon.com/cloudsearch/latest/developerguide/configuring-analysis-schemes.html) in the *Amazon CloudSearch Developer Guide*.
*/
public suspend inline fun CloudSearchClient.defineAnalysisScheme(crossinline block: DefineAnalysisSchemeRequest.Builder.() -> Unit): DefineAnalysisSchemeResponse = defineAnalysisScheme(DefineAnalysisSchemeRequest.Builder().apply(block).build())
/**
* 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](http://docs.aws.amazon.com/cloudsearch/latest/developerguide/configuring-expressions.html) in the *Amazon CloudSearch Developer Guide*.
*/
public suspend inline fun CloudSearchClient.defineExpression(crossinline block: DefineExpressionRequest.Builder.() -> Unit): DefineExpressionResponse = defineExpression(DefineExpressionRequest.Builder().apply(block).build())
/**
* 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](http://docs.aws.amazon.com/cloudsearch/latest/developerguide/configuring-index-fields.html) in the *Amazon CloudSearch Developer Guide*.
*/
public suspend inline fun CloudSearchClient.defineIndexField(crossinline block: DefineIndexFieldRequest.Builder.() -> Unit): DefineIndexFieldResponse = defineIndexField(DefineIndexFieldRequest.Builder().apply(block).build())
/**
* 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](http://docs.aws.amazon.com/cloudsearch/latest/developerguide/getting-suggestions.html) in the *Amazon CloudSearch Developer Guide*.
*/
public suspend inline fun CloudSearchClient.defineSuggester(crossinline block: DefineSuggesterRequest.Builder.() -> Unit): DefineSuggesterResponse = defineSuggester(DefineSuggesterRequest.Builder().apply(block).build())
/**
* Deletes an analysis scheme. For more information, see [Configuring Analysis Schemes](http://docs.aws.amazon.com/cloudsearch/latest/developerguide/configuring-analysis-schemes.html) in the *Amazon CloudSearch Developer Guide*.
*/
public suspend inline fun CloudSearchClient.deleteAnalysisScheme(crossinline block: DeleteAnalysisSchemeRequest.Builder.() -> Unit): DeleteAnalysisSchemeResponse = deleteAnalysisScheme(DeleteAnalysisSchemeRequest.Builder().apply(block).build())
/**
* 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](http://docs.aws.amazon.com/cloudsearch/latest/developerguide/deleting-domains.html) in the *Amazon CloudSearch Developer Guide*.
*/
public suspend inline fun CloudSearchClient.deleteDomain(crossinline block: DeleteDomainRequest.Builder.() -> Unit): DeleteDomainResponse = deleteDomain(DeleteDomainRequest.Builder().apply(block).build())
/**
* Removes an `Expression` from the search domain. For more information, see [Configuring Expressions](http://docs.aws.amazon.com/cloudsearch/latest/developerguide/configuring-expressions.html) in the *Amazon CloudSearch Developer Guide*.
*/
public suspend inline fun CloudSearchClient.deleteExpression(crossinline block: DeleteExpressionRequest.Builder.() -> Unit): DeleteExpressionResponse = deleteExpression(DeleteExpressionRequest.Builder().apply(block).build())
/**
* Removes an `IndexField` from the search domain. For more information, see [Configuring Index Fields](http://docs.aws.amazon.com/cloudsearch/latest/developerguide/configuring-index-fields.html) in the *Amazon CloudSearch Developer Guide*.
*/
public suspend inline fun CloudSearchClient.deleteIndexField(crossinline block: DeleteIndexFieldRequest.Builder.() -> Unit): DeleteIndexFieldResponse = deleteIndexField(DeleteIndexFieldRequest.Builder().apply(block).build())
/**
* Deletes a suggester. For more information, see [Getting Search Suggestions](http://docs.aws.amazon.com/cloudsearch/latest/developerguide/getting-suggestions.html) in the *Amazon CloudSearch Developer Guide*.
*/
public suspend inline fun CloudSearchClient.deleteSuggester(crossinline block: DeleteSuggesterRequest.Builder.() -> Unit): DeleteSuggesterResponse = deleteSuggester(DeleteSuggesterRequest.Builder().apply(block).build())
/**
* 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](http://docs.aws.amazon.com/cloudsearch/latest/developerguide/configuring-analysis-schemes.html) in the *Amazon CloudSearch Developer Guide*.
*/
public suspend inline fun CloudSearchClient.describeAnalysisSchemes(crossinline block: DescribeAnalysisSchemesRequest.Builder.() -> Unit): DescribeAnalysisSchemesResponse = describeAnalysisSchemes(DescribeAnalysisSchemesRequest.Builder().apply(block).build())
/**
* 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](http://docs.aws.amazon.com/cloudsearch/latest/developerguide/configuring-availability-options.html) in the *Amazon CloudSearch Developer Guide*.
*/
public suspend inline fun CloudSearchClient.describeAvailabilityOptions(crossinline block: DescribeAvailabilityOptionsRequest.Builder.() -> Unit): DescribeAvailabilityOptionsResponse = describeAvailabilityOptions(DescribeAvailabilityOptionsRequest.Builder().apply(block).build())
/**
* 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](http://docs.aws.amazon.com/cloudsearch/latest/developerguide/configuring-domain-endpoint-options.html) in the *Amazon CloudSearch Developer Guide*.
*/
public suspend inline fun CloudSearchClient.describeDomainEndpointOptions(crossinline block: DescribeDomainEndpointOptionsRequest.Builder.() -> Unit): DescribeDomainEndpointOptionsResponse = describeDomainEndpointOptions(DescribeDomainEndpointOptionsRequest.Builder().apply(block).build())
/**
* 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](http://docs.aws.amazon.com/cloudsearch/latest/developerguide/getting-domain-info.html) in the *Amazon CloudSearch Developer Guide*.
*/
public suspend inline fun CloudSearchClient.describeDomains(crossinline block: DescribeDomainsRequest.Builder.() -> Unit): DescribeDomainsResponse = describeDomains(DescribeDomainsRequest.Builder().apply(block).build())
/**
* 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](http://docs.aws.amazon.com/cloudsearch/latest/developerguide/configuring-expressions.html) in the *Amazon CloudSearch Developer Guide*.
*/
public suspend inline fun CloudSearchClient.describeExpressions(crossinline block: DescribeExpressionsRequest.Builder.() -> Unit): DescribeExpressionsResponse = describeExpressions(DescribeExpressionsRequest.Builder().apply(block).build())
/**
* 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](http://docs.aws.amazon.com/cloudsearch/latest/developerguide/getting-domain-info.html) in the *Amazon CloudSearch Developer Guide*.
*/
public suspend inline fun CloudSearchClient.describeIndexFields(crossinline block: DescribeIndexFieldsRequest.Builder.() -> Unit): DescribeIndexFieldsResponse = describeIndexFields(DescribeIndexFieldsRequest.Builder().apply(block).build())
/**
* 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](http://docs.aws.amazon.com/cloudsearch/latest/developerguide/configuring-scaling-options.html) in the *Amazon CloudSearch Developer Guide*.
*/
public suspend inline fun CloudSearchClient.describeScalingParameters(crossinline block: DescribeScalingParametersRequest.Builder.() -> Unit): DescribeScalingParametersResponse = describeScalingParameters(DescribeScalingParametersRequest.Builder().apply(block).build())
/**
* 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](http://docs.aws.amazon.com/cloudsearch/latest/developerguide/configuring-access.html) in the *Amazon CloudSearch Developer Guide*.
*/
public suspend inline fun CloudSearchClient.describeServiceAccessPolicies(crossinline block: DescribeServiceAccessPoliciesRequest.Builder.() -> Unit): DescribeServiceAccessPoliciesResponse = describeServiceAccessPolicies(DescribeServiceAccessPoliciesRequest.Builder().apply(block).build())
/**
* 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](http://docs.aws.amazon.com/cloudsearch/latest/developerguide/getting-suggestions.html) in the *Amazon CloudSearch Developer Guide*.
*/
public suspend inline fun CloudSearchClient.describeSuggesters(crossinline block: DescribeSuggestersRequest.Builder.() -> Unit): DescribeSuggestersResponse = describeSuggesters(DescribeSuggestersRequest.Builder().apply(block).build())
/**
* 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`.
*/
public suspend inline fun CloudSearchClient.indexDocuments(crossinline block: IndexDocumentsRequest.Builder.() -> Unit): IndexDocumentsResponse = indexDocuments(IndexDocumentsRequest.Builder().apply(block).build())
/**
* Lists all search domains owned by an account.
*/
public suspend inline fun CloudSearchClient.listDomainNames(crossinline block: ListDomainNamesRequest.Builder.() -> Unit): ListDomainNamesResponse = listDomainNames(ListDomainNamesRequest.Builder().apply(block).build())
/**
* 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](http://docs.aws.amazon.com/cloudsearch/latest/developerguide/configuring-availability-options.html) in the *Amazon CloudSearch Developer Guide*.
*/
public suspend inline fun CloudSearchClient.updateAvailabilityOptions(crossinline block: UpdateAvailabilityOptionsRequest.Builder.() -> Unit): UpdateAvailabilityOptionsResponse = updateAvailabilityOptions(UpdateAvailabilityOptionsRequest.Builder().apply(block).build())
/**
* 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](http://docs.aws.amazon.com/cloudsearch/latest/developerguide/configuring-domain-endpoint-options.html) in the *Amazon CloudSearch Developer Guide*.
*/
public suspend inline fun CloudSearchClient.updateDomainEndpointOptions(crossinline block: UpdateDomainEndpointOptionsRequest.Builder.() -> Unit): UpdateDomainEndpointOptionsResponse = updateDomainEndpointOptions(UpdateDomainEndpointOptionsRequest.Builder().apply(block).build())
/**
* 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](http://docs.aws.amazon.com/cloudsearch/latest/developerguide/configuring-scaling-options.html) in the *Amazon CloudSearch Developer Guide*.
*/
public suspend inline fun CloudSearchClient.updateScalingParameters(crossinline block: UpdateScalingParametersRequest.Builder.() -> Unit): UpdateScalingParametersResponse = updateScalingParameters(UpdateScalingParametersRequest.Builder().apply(block).build())
/**
* 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](http://docs.aws.amazon.com/cloudsearch/latest/developerguide/configuring-access.html).
*/
public suspend inline fun CloudSearchClient.updateServiceAccessPolicies(crossinline block: UpdateServiceAccessPoliciesRequest.Builder.() -> Unit): UpdateServiceAccessPoliciesResponse = updateServiceAccessPolicies(UpdateServiceAccessPoliciesRequest.Builder().apply(block).build())
© 2015 - 2025 Weber Informatics LLC | Privacy Policy