Struct aws_sdk_cloudsearch::Client

source ·

pub struct Client { /* private fields */ }

Expand description

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.

Examples

Constructing a client and invoking an operation

    // create a shared configuration. This can be used & shared between multiple service clients.
    let shared_config = aws_config::load_from_env().await;
    let client = aws_sdk_cloudsearch::Client::new(&shared_config);
    // invoke an operation
    /* let rsp = client
        .<operation_name>().
        .<param>("some value")
        .send().await; */

Constructing a client with custom configuration

use aws_config::retry::RetryConfig;
let shared_config = aws_config::load_from_env().await;
let config = aws_sdk_cloudsearch::config::Builder::from(&shared_config)
  .retry_config(RetryConfig::disabled())
  .build();
let client = aws_sdk_cloudsearch::Client::from_conf(config);

Implementations§

source §

impl Client

source

pub fn with_config(
client: Client<DynConnector, DynMiddleware<DynConnector>>,
conf: Config
) -> Self

Creates a client with the given service configuration.

source

pub fn conf(&self) -> &Config

Returns the client’s configuration.

source §

impl Client

source

pub fn build_suggesters(&self) -> BuildSuggesters

Constructs a fluent builder for the BuildSuggesters operation.

The fluent builder is configurable:
- domain_name(impl Into<String>) / set_domain_name(Option<String>):
 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>

source

pub fn create_domain(&self) -> CreateDomain

Constructs a fluent builder for the CreateDomain operation.

The fluent builder is configurable:
- domain_name(impl Into<String>) / set_domain_name(Option<String>):
 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>

source

pub fn define_analysis_scheme(&self) -> DefineAnalysisScheme

Constructs a fluent builder for the DefineAnalysisScheme operation.

The fluent builder is configurable:
- domain_name(impl Into<String>) / set_domain_name(Option<String>):
 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>):
 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>

source

pub fn define_expression(&self) -> DefineExpression

Constructs a fluent builder for the DefineExpression operation.

The fluent builder is configurable:
- domain_name(impl Into<String>) / set_domain_name(Option<String>):
 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>):
 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>

source

pub fn define_index_field(&self) -> DefineIndexField

Constructs a fluent builder for the DefineIndexField operation.

The fluent builder is configurable:
- domain_name(impl Into<String>) / set_domain_name(Option<String>):
 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>):
 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>

source

pub fn define_suggester(&self) -> DefineSuggester

Constructs a fluent builder for the DefineSuggester operation.

The fluent builder is configurable:
- domain_name(impl Into<String>) / set_domain_name(Option<String>):
 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>):
 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>

source

pub fn delete_analysis_scheme(&self) -> DeleteAnalysisScheme

Constructs a fluent builder for the DeleteAnalysisScheme operation.

The fluent builder is configurable:
- domain_name(impl Into<String>) / set_domain_name(Option<String>):
 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>):
 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>

source

pub fn delete_domain(&self) -> DeleteDomain

Constructs a fluent builder for the DeleteDomain operation.

The fluent builder is configurable:
- domain_name(impl Into<String>) / set_domain_name(Option<String>):
 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>

source

pub fn delete_expression(&self) -> DeleteExpression

Constructs a fluent builder for the DeleteExpression operation.

The fluent builder is configurable:
- domain_name(impl Into<String>) / set_domain_name(Option<String>):
 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>):
 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>

source

pub fn delete_index_field(&self) -> DeleteIndexField

Constructs a fluent builder for the DeleteIndexField operation.

The fluent builder is configurable:
- domain_name(impl Into<String>) / set_domain_name(Option<String>):
 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>):
 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>

source

pub fn delete_suggester(&self) -> DeleteSuggester

Constructs a fluent builder for the DeleteSuggester operation.

The fluent builder is configurable:
- domain_name(impl Into<String>) / set_domain_name(Option<String>):
 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>):
 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>

source

pub fn describe_analysis_schemes(&self) -> DescribeAnalysisSchemes

Constructs a fluent builder for the DescribeAnalysisSchemes operation.

The fluent builder is configurable:
- domain_name(impl Into<String>) / set_domain_name(Option<String>):
 The name of the domain you want to describe.
- analysis_scheme_names(Vec<String>) / set_analysis_scheme_names(Option<Vec<String>>):
 The analysis schemes you want to describe.
- deployed(bool) / set_deployed(Option<bool>):
 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(Option<Vec<AnalysisSchemeStatus>>):
 The analysis scheme descriptions.
On failure, responds with SdkError<DescribeAnalysisSchemesError>

source

pub fn describe_availability_options(&self) -> DescribeAvailabilityOptions

Constructs a fluent builder for the DescribeAvailabilityOptions operation.

The fluent builder is configurable:
- domain_name(impl Into<String>) / set_domain_name(Option<String>):
 The name of the domain you want to describe.
- deployed(bool) / set_deployed(Option<bool>):
 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>

source

pub fn describe_domain_endpoint_options(&self) -> DescribeDomainEndpointOptions

Constructs a fluent builder for the DescribeDomainEndpointOptions operation.

The fluent builder is configurable:
- domain_name(impl Into<String>) / set_domain_name(Option<String>):
 A string that represents the name of a domain.
- deployed(bool) / set_deployed(Option<bool>):
 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>

source

pub fn describe_domains(&self) -> DescribeDomains

Constructs a fluent builder for the DescribeDomains operation.

The fluent builder is configurable:
- domain_names(Vec<String>) / set_domain_names(Option<Vec<String>>):
 The names of the domains you want to include in the response.
On success, responds with DescribeDomainsOutput with field(s):
- domain_status_list(Option<Vec<DomainStatus>>):
 A list that contains the status of each requested domain.
On failure, responds with SdkError<DescribeDomainsError>

source

pub fn describe_expressions(&self) -> DescribeExpressions

Constructs a fluent builder for the DescribeExpressions operation.

The fluent builder is configurable:
- domain_name(impl Into<String>) / set_domain_name(Option<String>):
 The name of the domain you want to describe.
- expression_names(Vec<String>) / set_expression_names(Option<Vec<String>>):
 Limits the DescribeExpressions response to the specified expressions. If not specified, all expressions are shown.
- deployed(bool) / set_deployed(Option<bool>):
 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(Option<Vec<ExpressionStatus>>):
 The expressions configured for the domain.
On failure, responds with SdkError<DescribeExpressionsError>

source

pub fn describe_index_fields(&self) -> DescribeIndexFields

Constructs a fluent builder for the DescribeIndexFields operation.

The fluent builder is configurable:
- domain_name(impl Into<String>) / set_domain_name(Option<String>):
 The name of the domain you want to describe.
- field_names(Vec<String>) / set_field_names(Option<Vec<String>>):
 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>):
 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(Option<Vec<IndexFieldStatus>>):
 The index fields configured for the domain.
On failure, responds with SdkError<DescribeIndexFieldsError>

source

pub fn describe_scaling_parameters(&self) -> DescribeScalingParameters

Constructs a fluent builder for the DescribeScalingParameters operation.

The fluent builder is configurable:
- domain_name(impl Into<String>) / set_domain_name(Option<String>):
 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>

source

pub fn describe_service_access_policies(&self) -> DescribeServiceAccessPolicies

Constructs a fluent builder for the DescribeServiceAccessPolicies operation.

The fluent builder is configurable:
- domain_name(impl Into<String>) / set_domain_name(Option<String>):
 The name of the domain you want to describe.
- deployed(bool) / set_deployed(Option<bool>):
 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>

source

pub fn describe_suggesters(&self) -> DescribeSuggesters

Constructs a fluent builder for the DescribeSuggesters operation.

The fluent builder is configurable:
- domain_name(impl Into<String>) / set_domain_name(Option<String>):
 The name of the domain you want to describe.
- suggester_names(Vec<String>) / set_suggester_names(Option<Vec<String>>):
 The suggesters you want to describe.
- deployed(bool) / set_deployed(Option<bool>):
 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(Option<Vec<SuggesterStatus>>):
 The suggesters configured for the domain specified in the request.
On failure, responds with SdkError<DescribeSuggestersError>

source

pub fn index_documents(&self) -> IndexDocuments

Constructs a fluent builder for the IndexDocuments operation.

The fluent builder is configurable:
- domain_name(impl Into<String>) / set_domain_name(Option<String>):
 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>

source

pub fn list_domain_names(&self) -> ListDomainNames

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>

source

pub fn update_availability_options(&self) -> UpdateAvailabilityOptions

Constructs a fluent builder for the UpdateAvailabilityOptions operation.

The fluent builder is configurable:
- domain_name(impl Into<String>) / set_domain_name(Option<String>):
 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>):
 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>

source

pub fn update_domain_endpoint_options(&self) -> UpdateDomainEndpointOptions

Constructs a fluent builder for the UpdateDomainEndpointOptions operation.

The fluent builder is configurable:
- domain_name(impl Into<String>) / set_domain_name(Option<String>):
 A string that represents the name of a domain.
- domain_endpoint_options(DomainEndpointOptions) / set_domain_endpoint_options(Option<DomainEndpointOptions>):
 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>

source

pub fn update_scaling_parameters(&self) -> UpdateScalingParameters

Constructs a fluent builder for the UpdateScalingParameters operation.

The fluent builder is configurable:
- domain_name(impl Into<String>) / set_domain_name(Option<String>):
 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>):
 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>

source

pub fn update_service_access_policies(&self) -> UpdateServiceAccessPolicies

Constructs a fluent builder for the UpdateServiceAccessPolicies operation.

The fluent builder is configurable:
- domain_name(impl Into<String>) / set_domain_name(Option<String>):
 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>):
 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>

source §

impl Client

source

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.

source

pub fn from_conf(conf: Config) -> Self

Creates a new client from the service Config.

Panics

This method will panic if the conf 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 conf is missing an HTTP connector. If you experience this panic, set the http_connector on the Config passed into this function to fix it.