Struct aws_sdk_cloudsearch::Client

pub struct Client { /* private fields */ }

Client for Amazon CloudSearch

Client for invoking operations on Amazon CloudSearch. Each operation on Amazon CloudSearch is a method on this this struct. .send() MUST be invoked on the generated operations to dispatch the request to the service.

Constructing a Client

A Config is required to construct a client. For most use cases, the aws-config crate should be used to automatically resolve this config using aws_config::load_from_env(), since this will resolve an SdkConfig which can be shared across multiple different AWS SDK clients. This config resolution process can be customized by calling aws_config::from_env() instead, which returns a ConfigLoader that uses the builder pattern to customize the default config.

In the simplest case, creating a client looks as follows:

let config = aws_config::load_from_env().await;
let client = aws_sdk_cloudsearch::Client::new(&config);

Occasionally, SDKs may have additional service-specific that can be set on the Config that is absent from SdkConfig, or slightly different settings for a specific client may be desired. The Config struct implements From<&SdkConfig>, so setting these specific settings can be done as follows:

let sdk_config = ::aws_config::load_from_env().await;
let config = aws_sdk_cloudsearch::config::Builder::from(&sdk_config)
    .some_service_specific_setting("value")
    .build();

See the aws-config docs and Config for more information on customizing configuration.

Note: Client construction is expensive due to connection thread pool initialization, and should be done once at application start-up.

Using the Client

A client has a function for every operation that can be performed by the service. For example, the BuildSuggesters operation has a Client::build_suggesters, function which returns a builder for that operation. The fluent builder ultimately has a send() function that returns an async future that returns a result, as illustrated below:

let result = client.build_suggesters()
    .domain_name("example")
    .send()
    .await;

The underlying HTTP requests that get made by this can be modified with the customize_operation function on the fluent builder. See the customize module for more information.

Implementations

impl Client

pub fn build_suggesters(&self) -> BuildSuggestersFluentBuilder

Constructs a fluent builder for the BuildSuggesters operation.

• The fluent builder is configurable:
  • domain_name(impl Into<String>) / set_domain_name(Option<String>):
    required: true
    

    A string that represents the name of a domain. Domain names are unique across the domains owned by an account within an AWS region. Domain names start with a letter or number and can contain the following characters: a-z (lowercase), 0-9, and - (hyphen).

    
    
• On success, responds with BuildSuggestersOutput with field(s):
  • field_names(Option<Vec::<String>>):

    A list of field names.

• On failure, responds with SdkError<BuildSuggestersError>

impl Client

pub fn create_domain(&self) -> CreateDomainFluentBuilder

Constructs a fluent builder for the CreateDomain operation.

• The fluent builder is configurable:
  • domain_name(impl Into<String>) / set_domain_name(Option<String>):
    required: true
    

    A name for the domain you are creating. Allowed characters are a-z (lower-case letters), 0-9, and hyphen (-). Domain names must start with a letter or number and be at least 3 and no more than 28 characters long.

    
    
• On success, responds with CreateDomainOutput with field(s):
  • domain_status(Option<DomainStatus>):

    The current status of the search domain.

• On failure, responds with SdkError<CreateDomainError>

impl Client

pub fn define_analysis_scheme(&self) -> DefineAnalysisSchemeFluentBuilder

Constructs a fluent builder for the DefineAnalysisScheme operation.

• The fluent builder is configurable:
  • domain_name(impl Into<String>) / set_domain_name(Option<String>):
    required: true
    

    A string that represents the name of a domain. Domain names are unique across the domains owned by an account within an AWS region. Domain names start with a letter or number and can contain the following characters: a-z (lowercase), 0-9, and - (hyphen).

    
    
  • analysis_scheme(AnalysisScheme) / set_analysis_scheme(Option<AnalysisScheme>):
    required: true
    

    Configuration information for an analysis scheme. Each analysis scheme has a unique name and specifies the language of the text to be processed. The following options can be configured for an analysis scheme: Synonyms, Stopwords, StemmingDictionary, JapaneseTokenizationDictionary and AlgorithmicStemming.

    
    
• On success, responds with DefineAnalysisSchemeOutput with field(s):
  • analysis_scheme(Option<AnalysisSchemeStatus>):

    The status and configuration of an AnalysisScheme.

• On failure, responds with SdkError<DefineAnalysisSchemeError>

impl Client

pub fn define_expression(&self) -> DefineExpressionFluentBuilder

Constructs a fluent builder for the DefineExpression operation.

• The fluent builder is configurable:
  • domain_name(impl Into<String>) / set_domain_name(Option<String>):
    required: true
    

    A string that represents the name of a domain. Domain names are unique across the domains owned by an account within an AWS region. Domain names start with a letter or number and can contain the following characters: a-z (lowercase), 0-9, and - (hyphen).

    
    
  • expression(Expression) / set_expression(Option<Expression>):
    required: true
    

    A named expression that can be evaluated at search time. Can be used to sort the search results, define other expressions, or return computed information in the search results.

    
    
• On success, responds with DefineExpressionOutput with field(s):
  • expression(Option<ExpressionStatus>):

    The value of an Expression and its current status.

• On failure, responds with SdkError<DefineExpressionError>

impl Client

pub fn define_index_field(&self) -> DefineIndexFieldFluentBuilder

Constructs a fluent builder for the DefineIndexField operation.

• The fluent builder is configurable:
  • domain_name(impl Into<String>) / set_domain_name(Option<String>):
    required: true
    

    A string that represents the name of a domain. Domain names are unique across the domains owned by an account within an AWS region. Domain names start with a letter or number and can contain the following characters: a-z (lowercase), 0-9, and - (hyphen).

    
    
  • index_field(IndexField) / set_index_field(Option<IndexField>):
    required: true
    

    The index field and field options you want to configure.

    
    
• On success, responds with DefineIndexFieldOutput with field(s):
  • index_field(Option<IndexFieldStatus>):

    The value of an IndexField and its current status.

• On failure, responds with SdkError<DefineIndexFieldError>

impl Client

pub fn define_suggester(&self) -> DefineSuggesterFluentBuilder

Constructs a fluent builder for the DefineSuggester operation.

• The fluent builder is configurable:
  • domain_name(impl Into<String>) / set_domain_name(Option<String>):
    required: true
    

    A string that represents the name of a domain. Domain names are unique across the domains owned by an account within an AWS region. Domain names start with a letter or number and can contain the following characters: a-z (lowercase), 0-9, and - (hyphen).

    
    
  • suggester(Suggester) / set_suggester(Option<Suggester>):
    required: true
    

    Configuration information for a search suggester. Each suggester has a unique name and specifies the text field you want to use for suggestions. The following options can be configured for a suggester: FuzzyMatching, SortExpression.

    
    
• On success, responds with DefineSuggesterOutput with field(s):
  • suggester(Option<SuggesterStatus>):

    The value of a Suggester and its current status.

• On failure, responds with SdkError<DefineSuggesterError>

impl Client

pub fn delete_analysis_scheme(&self) -> DeleteAnalysisSchemeFluentBuilder

Constructs a fluent builder for the DeleteAnalysisScheme operation.

• The fluent builder is configurable:
  • domain_name(impl Into<String>) / set_domain_name(Option<String>):
    required: true
    

    A string that represents the name of a domain. Domain names are unique across the domains owned by an account within an AWS region. Domain names start with a letter or number and can contain the following characters: a-z (lowercase), 0-9, and - (hyphen).

    
    
  • analysis_scheme_name(impl Into<String>) / set_analysis_scheme_name(Option<String>):
    required: true
    

    The name of the analysis scheme you want to delete.

    
    
• On success, responds with DeleteAnalysisSchemeOutput with field(s):
  • analysis_scheme(Option<AnalysisSchemeStatus>):

    The status of the analysis scheme being deleted.

• On failure, responds with SdkError<DeleteAnalysisSchemeError>

impl Client

pub fn delete_domain(&self) -> DeleteDomainFluentBuilder

Constructs a fluent builder for the DeleteDomain operation.

• The fluent builder is configurable:
  • domain_name(impl Into<String>) / set_domain_name(Option<String>):
    required: true
    

    The name of the domain you want to permanently delete.

    
    
• On success, responds with DeleteDomainOutput with field(s):
  • domain_status(Option<DomainStatus>):

    The current status of the search domain.

• On failure, responds with SdkError<DeleteDomainError>

impl Client

pub fn delete_expression(&self) -> DeleteExpressionFluentBuilder

Constructs a fluent builder for the DeleteExpression operation.

• The fluent builder is configurable:
  • domain_name(impl Into<String>) / set_domain_name(Option<String>):
    required: true
    

    A string that represents the name of a domain. Domain names are unique across the domains owned by an account within an AWS region. Domain names start with a letter or number and can contain the following characters: a-z (lowercase), 0-9, and - (hyphen).

    
    
  • expression_name(impl Into<String>) / set_expression_name(Option<String>):
    required: true
    

    The name of the Expression to delete.

    
    
• On success, responds with DeleteExpressionOutput with field(s):
  • expression(Option<ExpressionStatus>):

    The status of the expression being deleted.

• On failure, responds with SdkError<DeleteExpressionError>

impl Client

pub fn delete_index_field(&self) -> DeleteIndexFieldFluentBuilder

Constructs a fluent builder for the DeleteIndexField operation.

• The fluent builder is configurable:
  • domain_name(impl Into<String>) / set_domain_name(Option<String>):
    required: true
    

    A string that represents the name of a domain. Domain names are unique across the domains owned by an account within an AWS region. Domain names start with a letter or number and can contain the following characters: a-z (lowercase), 0-9, and - (hyphen).

    
    
  • index_field_name(impl Into<String>) / set_index_field_name(Option<String>):
    required: true
    

    The name of the index field your want to remove from the domain’s indexing options.

    
    
• On success, responds with DeleteIndexFieldOutput with field(s):
  • index_field(Option<IndexFieldStatus>):

    The status of the index field being deleted.

• On failure, responds with SdkError<DeleteIndexFieldError>

impl Client

pub fn delete_suggester(&self) -> DeleteSuggesterFluentBuilder

Constructs a fluent builder for the DeleteSuggester operation.

• The fluent builder is configurable:
  • domain_name(impl Into<String>) / set_domain_name(Option<String>):
    required: true
    

    A string that represents the name of a domain. Domain names are unique across the domains owned by an account within an AWS region. Domain names start with a letter or number and can contain the following characters: a-z (lowercase), 0-9, and - (hyphen).

    
    
  • suggester_name(impl Into<String>) / set_suggester_name(Option<String>):
    required: true
    

    Specifies the name of the suggester you want to delete.

    
    
• On success, responds with DeleteSuggesterOutput with field(s):
  • suggester(Option<SuggesterStatus>):

    The status of the suggester being deleted.

• On failure, responds with SdkError<DeleteSuggesterError>

impl Client

pub fn describe_analysis_schemes(&self) -> DescribeAnalysisSchemesFluentBuilder

Constructs a fluent builder for the DescribeAnalysisSchemes operation.

• The fluent builder is configurable:
  • domain_name(impl Into<String>) / set_domain_name(Option<String>):
    required: true
    

    The name of the domain you want to describe.

    
    
  • analysis_scheme_names(impl Into<String>) / set_analysis_scheme_names(Option<Vec::<String>>):
    required: false
    

    The analysis schemes you want to describe.

    
    
  • deployed(bool) / set_deployed(Option<bool>):
    required: false
    

    Whether to display the deployed configuration (true) or include any pending changes (false). Defaults to false.

    
    
• On success, responds with DescribeAnalysisSchemesOutput with field(s):
  • analysis_schemes(Vec::<AnalysisSchemeStatus>):

    The analysis scheme descriptions.

• On failure, responds with SdkError<DescribeAnalysisSchemesError>

impl Client

pub fn describe_availability_options( &self ) -> DescribeAvailabilityOptionsFluentBuilder

Constructs a fluent builder for the DescribeAvailabilityOptions operation.

• The fluent builder is configurable:
  • domain_name(impl Into<String>) / set_domain_name(Option<String>):
    required: true
    

    The name of the domain you want to describe.

    
    
  • deployed(bool) / set_deployed(Option<bool>):
    required: false
    

    Whether to display the deployed configuration (true) or include any pending changes (false). Defaults to false.

    
    
• On success, responds with DescribeAvailabilityOptionsOutput with field(s):
  • availability_options(Option<AvailabilityOptionsStatus>):

    The availability options configured for the domain. Indicates whether Multi-AZ is enabled for the domain.

• On failure, responds with SdkError<DescribeAvailabilityOptionsError>

impl Client

pub fn describe_domain_endpoint_options( &self ) -> DescribeDomainEndpointOptionsFluentBuilder

Constructs a fluent builder for the DescribeDomainEndpointOptions operation.

• The fluent builder is configurable:
  • domain_name(impl Into<String>) / set_domain_name(Option<String>):
    required: true
    

    A string that represents the name of a domain.

    
    
  • deployed(bool) / set_deployed(Option<bool>):
    required: false
    

    Whether to retrieve the latest configuration (which might be in a Processing state) or the current, active configuration. Defaults to false.

    
    
• On success, responds with DescribeDomainEndpointOptionsOutput with field(s):
  • domain_endpoint_options(Option<DomainEndpointOptionsStatus>):

    The status and configuration of a search domain’s endpoint options.

• On failure, responds with SdkError<DescribeDomainEndpointOptionsError>

impl Client

pub fn describe_domains(&self) -> DescribeDomainsFluentBuilder

Constructs a fluent builder for the DescribeDomains operation.

• The fluent builder is configurable:
  • domain_names(impl Into<String>) / set_domain_names(Option<Vec::<String>>):
    required: false
    

    The names of the domains you want to include in the response.

    
    
• On success, responds with DescribeDomainsOutput with field(s):
  • domain_status_list(Vec::<DomainStatus>):

    A list that contains the status of each requested domain.

• On failure, responds with SdkError<DescribeDomainsError>

impl Client

pub fn describe_expressions(&self) -> DescribeExpressionsFluentBuilder

Constructs a fluent builder for the DescribeExpressions operation.

• The fluent builder is configurable:
  • domain_name(impl Into<String>) / set_domain_name(Option<String>):
    required: true
    

    The name of the domain you want to describe.

    
    
  • expression_names(impl Into<String>) / set_expression_names(Option<Vec::<String>>):
    required: false
    

    Limits the DescribeExpressions response to the specified expressions. If not specified, all expressions are shown.

    
    
  • deployed(bool) / set_deployed(Option<bool>):
    required: false
    

    Whether to display the deployed configuration (true) or include any pending changes (false). Defaults to false.

    
    
• On success, responds with DescribeExpressionsOutput with field(s):
  • expressions(Vec::<ExpressionStatus>):

    The expressions configured for the domain.

• On failure, responds with SdkError<DescribeExpressionsError>

impl Client

pub fn describe_index_fields(&self) -> DescribeIndexFieldsFluentBuilder

Constructs a fluent builder for the DescribeIndexFields operation.

• The fluent builder is configurable:
  • domain_name(impl Into<String>) / set_domain_name(Option<String>):
    required: true
    

    The name of the domain you want to describe.

    
    
  • field_names(impl Into<String>) / set_field_names(Option<Vec::<String>>):
    required: false
    

    A list of the index fields you want to describe. If not specified, information is returned for all configured index fields.

    
    
  • deployed(bool) / set_deployed(Option<bool>):
    required: false
    

    Whether to display the deployed configuration (true) or include any pending changes (false). Defaults to false.

    
    
• On success, responds with DescribeIndexFieldsOutput with field(s):
  • index_fields(Vec::<IndexFieldStatus>):

    The index fields configured for the domain.

• On failure, responds with SdkError<DescribeIndexFieldsError>

impl Client

pub fn describe_scaling_parameters( &self ) -> DescribeScalingParametersFluentBuilder

Constructs a fluent builder for the DescribeScalingParameters operation.

• The fluent builder is configurable:
  • domain_name(impl Into<String>) / set_domain_name(Option<String>):
    required: true
    

    A string that represents the name of a domain. Domain names are unique across the domains owned by an account within an AWS region. Domain names start with a letter or number and can contain the following characters: a-z (lowercase), 0-9, and - (hyphen).

    
    
• On success, responds with DescribeScalingParametersOutput with field(s):
  • scaling_parameters(Option<ScalingParametersStatus>):

    The status and configuration of a search domain’s scaling parameters.

• On failure, responds with SdkError<DescribeScalingParametersError>

impl Client

pub fn describe_service_access_policies( &self ) -> DescribeServiceAccessPoliciesFluentBuilder

Constructs a fluent builder for the DescribeServiceAccessPolicies operation.

• The fluent builder is configurable:
  • domain_name(impl Into<String>) / set_domain_name(Option<String>):
    required: true
    

    The name of the domain you want to describe.

    
    
  • deployed(bool) / set_deployed(Option<bool>):
    required: false
    

    Whether to display the deployed configuration (true) or include any pending changes (false). Defaults to false.

    
    
• On success, responds with DescribeServiceAccessPoliciesOutput with field(s):
  • access_policies(Option<AccessPoliciesStatus>):

    The access rules configured for the domain specified in the request.

• On failure, responds with SdkError<DescribeServiceAccessPoliciesError>

impl Client

pub fn describe_suggesters(&self) -> DescribeSuggestersFluentBuilder

Constructs a fluent builder for the DescribeSuggesters operation.

• The fluent builder is configurable:
  • domain_name(impl Into<String>) / set_domain_name(Option<String>):
    required: true
    

    The name of the domain you want to describe.

    
    
  • suggester_names(impl Into<String>) / set_suggester_names(Option<Vec::<String>>):
    required: false
    

    The suggesters you want to describe.

    
    
  • deployed(bool) / set_deployed(Option<bool>):
    required: false
    

    Whether to display the deployed configuration (true) or include any pending changes (false). Defaults to false.

    
    
• On success, responds with DescribeSuggestersOutput with field(s):
  • suggesters(Vec::<SuggesterStatus>):

    The suggesters configured for the domain specified in the request.

• On failure, responds with SdkError<DescribeSuggestersError>

impl Client

pub fn index_documents(&self) -> IndexDocumentsFluentBuilder

Constructs a fluent builder for the IndexDocuments operation.

• The fluent builder is configurable:
  • domain_name(impl Into<String>) / set_domain_name(Option<String>):
    required: true
    

    A string that represents the name of a domain. Domain names are unique across the domains owned by an account within an AWS region. Domain names start with a letter or number and can contain the following characters: a-z (lowercase), 0-9, and - (hyphen).

    
    
• On success, responds with IndexDocumentsOutput with field(s):
  • field_names(Option<Vec::<String>>):

    The names of the fields that are currently being indexed.

• On failure, responds with SdkError<IndexDocumentsError>

impl Client

pub fn list_domain_names(&self) -> ListDomainNamesFluentBuilder

Constructs a fluent builder for the ListDomainNames operation.

• The fluent builder takes no input, just send it.
• On success, responds with ListDomainNamesOutput with field(s):
  • domain_names(Option<HashMap::<String, String>>):

    The names of the search domains owned by an account.

• On failure, responds with SdkError<ListDomainNamesError>

impl Client

pub fn update_availability_options( &self ) -> UpdateAvailabilityOptionsFluentBuilder

Constructs a fluent builder for the UpdateAvailabilityOptions operation.

• The fluent builder is configurable:
  • domain_name(impl Into<String>) / set_domain_name(Option<String>):
    required: true
    

    A string that represents the name of a domain. Domain names are unique across the domains owned by an account within an AWS region. Domain names start with a letter or number and can contain the following characters: a-z (lowercase), 0-9, and - (hyphen).

    
    
  • multi_az(bool) / set_multi_az(Option<bool>):
    required: true
    

    You expand an existing search domain to a second Availability Zone by setting the Multi-AZ option to true. Similarly, you can turn off the Multi-AZ option to downgrade the domain to a single Availability Zone by setting the Multi-AZ option to false.

    
    
• On success, responds with UpdateAvailabilityOptionsOutput with field(s):
  • availability_options(Option<AvailabilityOptionsStatus>):

    The newly-configured availability options. Indicates whether Multi-AZ is enabled for the domain.

• On failure, responds with SdkError<UpdateAvailabilityOptionsError>

impl Client

pub fn update_domain_endpoint_options( &self ) -> UpdateDomainEndpointOptionsFluentBuilder

Constructs a fluent builder for the UpdateDomainEndpointOptions operation.

• The fluent builder is configurable:
  • domain_name(impl Into<String>) / set_domain_name(Option<String>):
    required: true
    

    A string that represents the name of a domain.

    
    
  • domain_endpoint_options(DomainEndpointOptions) / set_domain_endpoint_options(Option<DomainEndpointOptions>):
    required: true
    

    Whether to require that all requests to the domain arrive over HTTPS. We recommend Policy-Min-TLS-1-2-2019-07 for TLSSecurityPolicy. For compatibility with older clients, the default is Policy-Min-TLS-1-0-2019-07.

    
    
• On success, responds with UpdateDomainEndpointOptionsOutput with field(s):
  • domain_endpoint_options(Option<DomainEndpointOptionsStatus>):

    The newly-configured domain endpoint options.

• On failure, responds with SdkError<UpdateDomainEndpointOptionsError>

impl Client

pub fn update_scaling_parameters(&self) -> UpdateScalingParametersFluentBuilder

Constructs a fluent builder for the UpdateScalingParameters operation.

• The fluent builder is configurable:
  • domain_name(impl Into<String>) / set_domain_name(Option<String>):
    required: true
    

    A string that represents the name of a domain. Domain names are unique across the domains owned by an account within an AWS region. Domain names start with a letter or number and can contain the following characters: a-z (lowercase), 0-9, and - (hyphen).

    
    
  • scaling_parameters(ScalingParameters) / set_scaling_parameters(Option<ScalingParameters>):
    required: true
    

    The desired instance type and desired number of replicas of each index partition.

    
    
• On success, responds with UpdateScalingParametersOutput with field(s):
  • scaling_parameters(Option<ScalingParametersStatus>):

    The status and configuration of a search domain’s scaling parameters.

• On failure, responds with SdkError<UpdateScalingParametersError>

impl Client

pub fn update_service_access_policies( &self ) -> UpdateServiceAccessPoliciesFluentBuilder

Constructs a fluent builder for the UpdateServiceAccessPolicies operation.

• The fluent builder is configurable:
  • domain_name(impl Into<String>) / set_domain_name(Option<String>):
    required: true
    

    A string that represents the name of a domain. Domain names are unique across the domains owned by an account within an AWS region. Domain names start with a letter or number and can contain the following characters: a-z (lowercase), 0-9, and - (hyphen).

    
    
  • access_policies(impl Into<String>) / set_access_policies(Option<String>):
    required: true
    

    The access rules you want to configure. These rules replace any existing rules.

    
    
• On success, responds with UpdateServiceAccessPoliciesOutput with field(s):
  • access_policies(Option<AccessPoliciesStatus>):

    The access rules configured for the domain.

• On failure, responds with SdkError<UpdateServiceAccessPoliciesError>

impl Client

pub fn from_conf(conf: Config) -> Self

Creates a new client from the service Config.

Panics

This method will panic in the following cases:

• Retries or timeouts are enabled without a sleep_impl configured.
• Identity caching is enabled without a sleep_impl and time_source configured.
• No behavior_version is provided.

The panic message for each of these will have instructions on how to resolve them.

pub fn config(&self) -> &Config

Returns the client’s configuration.

impl Client

pub fn new(sdk_config: &SdkConfig) -> Self

Creates a new client from an SDK Config.

Panics

• This method will panic if the sdk_config is missing an async sleep implementation. If you experience this panic, set the sleep_impl on the Config passed into this function to fix it.
• This method will panic if the sdk_config is missing an HTTP connector. If you experience this panic, set the http_connector on the Config passed into this function to fix it.
• This method will panic if no BehaviorVersion is provided. If you experience this panic, set behavior_version on the Config or enable the behavior-version-latest Cargo feature.

Trait Implementations

impl Clone for Client

fn clone(&self) -> Client

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for Client

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.