Struct aws_sdk_opensearch::Client

source ·

pub struct Client { /* private fields */ }

Expand description

Client for Amazon OpenSearch Service

Client for invoking operations on Amazon OpenSearch Service. Each operation on Amazon OpenSearch Service 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_opensearch::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_opensearch::config::Builder::from(&shared_config)
  .retry_config(RetryConfig::disabled())
  .build();
let client = aws_sdk_opensearch::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 accept_inbound_connection(&self) -> AcceptInboundConnection

Constructs a fluent builder for the AcceptInboundConnection operation.

The fluent builder is configurable:
- connection_id(impl Into<String>) / set_connection_id(Option<String>):
 The ID of the inbound connection to accept.
On success, responds with AcceptInboundConnectionOutput with field(s):
- connection(Option<InboundConnection>):
 Information about the accepted inbound connection.
On failure, responds with SdkError<AcceptInboundConnectionError>

source

pub fn add_tags(&self) -> AddTags

Constructs a fluent builder for the AddTags operation.

The fluent builder is configurable:
- arn(impl Into<String>) / set_arn(Option<String>):
 Amazon Resource Name (ARN) for the OpenSearch Service domain to which you want to attach resource tags.
- tag_list(Vec<Tag>) / set_tag_list(Option<Vec<Tag>>):
 List of resource tags.
On success, responds with AddTagsOutput
On failure, responds with SdkError<AddTagsError>

source

pub fn associate_package(&self) -> AssociatePackage

Constructs a fluent builder for the AssociatePackage operation.

The fluent builder is configurable:
- package_id(impl Into<String>) / set_package_id(Option<String>):
 Internal ID of the package to associate with a domain. Use DescribePackages to find this value.
- domain_name(impl Into<String>) / set_domain_name(Option<String>):
 Name of the domain to associate the package with.
On success, responds with AssociatePackageOutput with field(s):
- domain_package_details(Option<DomainPackageDetails>):
 Information about a package that is associated with a domain.
On failure, responds with SdkError<AssociatePackageError>

source

pub fn authorize_vpc_endpoint_access(&self) -> AuthorizeVpcEndpointAccess

Constructs a fluent builder for the AuthorizeVpcEndpointAccess operation.

The fluent builder is configurable:
- domain_name(impl Into<String>) / set_domain_name(Option<String>):
 The name of the OpenSearch Service domain to provide access to.
- account(impl Into<String>) / set_account(Option<String>):
 The Amazon Web Services account ID to grant access to.
On success, responds with AuthorizeVpcEndpointAccessOutput with field(s):
- authorized_principal(Option<AuthorizedPrincipal>):
 Information about the Amazon Web Services account or service that was provided access to the domain.
On failure, responds with SdkError<AuthorizeVpcEndpointAccessError>

source

pub fn cancel_service_software_update(&self) -> CancelServiceSoftwareUpdate

Constructs a fluent builder for the CancelServiceSoftwareUpdate operation.

The fluent builder is configurable:
- domain_name(impl Into<String>) / set_domain_name(Option<String>):
 Name of the OpenSearch Service domain that you want to cancel the service software update on.
On success, responds with CancelServiceSoftwareUpdateOutput with field(s):
- service_software_options(Option<ServiceSoftwareOptions>):
 Container for the state of your domain relative to the latest service software.
On failure, responds with SdkError<CancelServiceSoftwareUpdateError>

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>):
 Name of the OpenSearch Service domain to create. Domain names are unique across the domains owned by an account within an Amazon Web Services Region.
- engine_version(impl Into<String>) / set_engine_version(Option<String>):
 String of format Elasticsearch_X.Y or OpenSearch_X.Y to specify the engine version for the OpenSearch Service domain. For example, OpenSearch_1.0 or Elasticsearch_7.9. For more information, see Creating and managing Amazon OpenSearch Service domains.
- cluster_config(ClusterConfig) / set_cluster_config(Option<ClusterConfig>):
 Container for the cluster configuration of a domain.
- ebs_options(EbsOptions) / set_ebs_options(Option<EbsOptions>):
 Container for the parameters required to enable EBS-based storage for an OpenSearch Service domain.
- access_policies(impl Into<String>) / set_access_policies(Option<String>):
 Identity and Access Management (IAM) policy document specifying the access policies for the new domain.
- snapshot_options(SnapshotOptions) / set_snapshot_options(Option<SnapshotOptions>):
 DEPRECATED. Container for the parameters required to configure automated snapshots of domain indexes.
- vpc_options(VpcOptions) / set_vpc_options(Option<VpcOptions>):
 Container for the values required to configure VPC access domains. If you don’t specify these values, OpenSearch Service creates the domain with a public endpoint. For more information, see Launching your Amazon OpenSearch Service domains using a VPC.
- cognito_options(CognitoOptions) / set_cognito_options(Option<CognitoOptions>):
 Key-value pairs to configure Amazon Cognito authentication. For more information, see Configuring Amazon Cognito authentication for OpenSearch Dashboards.
- encryption_at_rest_options(EncryptionAtRestOptions) / set_encryption_at_rest_options(Option<EncryptionAtRestOptions>):
 Key-value pairs to enable encryption at rest.
- node_to_node_encryption_options(NodeToNodeEncryptionOptions) / set_node_to_node_encryption_options(Option<NodeToNodeEncryptionOptions>):
 Enables node-to-node encryption.
- advanced_options(HashMap<String, String>) / set_advanced_options(Option<HashMap<String, String>>):
 Key-value pairs to specify advanced configuration options. The following key-value pairs are supported:
 - “rest.action.multi.allow_explicit_index”: “true” | “false” - Note the use of a string rather than a boolean. Specifies whether explicit references to indexes are allowed inside the body of HTTP requests. If you want to configure access policies for domain sub-resources, such as specific indexes and domain APIs, you must disable this property. Default is true.
 - “indices.fielddata.cache.size”: “80” - Note the use of a string rather than a boolean. Specifies the percentage of heap space allocated to field data. Default is unbounded.
 - “indices.query.bool.max_clause_count”: “1024” - Note the use of a string rather than a boolean. Specifies the maximum number of clauses allowed in a Lucene boolean query. Default is 1,024. Queries with more than the permitted number of clauses result in a TooManyClauses error.
 - “override_main_response_version”: “true” | “false” - Note the use of a string rather than a boolean. Specifies whether the domain reports its version as 7.10 to allow Elasticsearch OSS clients and plugins to continue working with it. Default is false when creating a domain and true when upgrading a domain.
 For more information, see Advanced cluster parameters.
- log_publishing_options(HashMap<LogType, LogPublishingOption>) / set_log_publishing_options(Option<HashMap<LogType, LogPublishingOption>>):
 Key-value pairs to configure slow log publishing.
- domain_endpoint_options(DomainEndpointOptions) / set_domain_endpoint_options(Option<DomainEndpointOptions>):
 Additional options for the domain endpoint, such as whether to require HTTPS for all traffic.
- advanced_security_options(AdvancedSecurityOptionsInput) / set_advanced_security_options(Option<AdvancedSecurityOptionsInput>):
 Options for fine-grained access control.
- tag_list(Vec<Tag>) / set_tag_list(Option<Vec<Tag>>):
 List of tags to add to the domain upon creation.
- auto_tune_options(AutoTuneOptionsInput) / set_auto_tune_options(Option<AutoTuneOptionsInput>):
 Options for Auto-Tune.
On success, responds with CreateDomainOutput with field(s):
- domain_status(Option<DomainStatus>):
 The status of the newly created domain.
On failure, responds with SdkError<CreateDomainError>

source

pub fn create_outbound_connection(&self) -> CreateOutboundConnection

Constructs a fluent builder for the CreateOutboundConnection operation.

The fluent builder is configurable:
- local_domain_info(DomainInformationContainer) / set_local_domain_info(Option<DomainInformationContainer>):
 Name and Region of the source (local) domain.
- remote_domain_info(DomainInformationContainer) / set_remote_domain_info(Option<DomainInformationContainer>):
 Name and Region of the destination (remote) domain.
- connection_alias(impl Into<String>) / set_connection_alias(Option<String>):
 Name of the connection.
On success, responds with CreateOutboundConnectionOutput with field(s):
- local_domain_info(Option<DomainInformationContainer>):
 Information about the source (local) domain.
- remote_domain_info(Option<DomainInformationContainer>):
 Information about the destination (remote) domain.
- connection_alias(Option<String>):
 Name of the connection.
- connection_status(Option<OutboundConnectionStatus>):
 The status of the connection.
- connection_id(Option<String>):
 The unique identifier for the created outbound connection, which is used for subsequent operations on the connection.
On failure, responds with SdkError<CreateOutboundConnectionError>

source

pub fn create_package(&self) -> CreatePackage

Constructs a fluent builder for the CreatePackage operation.

The fluent builder is configurable:
- package_name(impl Into<String>) / set_package_name(Option<String>):
 Unique name for the package.
- package_type(PackageType) / set_package_type(Option<PackageType>):
 Type of package.
- package_description(impl Into<String>) / set_package_description(Option<String>):
 Description of the package.
- package_source(PackageSource) / set_package_source(Option<PackageSource>):
 The Amazon S3 location from which to import the package.
On success, responds with CreatePackageOutput with field(s):
- package_details(Option<PackageDetails>):
 Basic information about an OpenSearch Service package.
On failure, responds with SdkError<CreatePackageError>

source

pub fn create_vpc_endpoint(&self) -> CreateVpcEndpoint

Constructs a fluent builder for the CreateVpcEndpoint operation.

The fluent builder is configurable:
- domain_arn(impl Into<String>) / set_domain_arn(Option<String>):
 The Amazon Resource Name (ARN) of the domain to create the endpoint for.
- vpc_options(VpcOptions) / set_vpc_options(Option<VpcOptions>):
 Options to specify the subnets and security groups for the endpoint.
- client_token(impl Into<String>) / set_client_token(Option<String>):
 Unique, case-sensitive identifier to ensure idempotency of the request.
On success, responds with CreateVpcEndpointOutput with field(s):
- vpc_endpoint(Option<VpcEndpoint>):
 Information about the newly created VPC endpoint.
On failure, responds with SdkError<CreateVpcEndpointError>

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 status of the domain being deleted.
On failure, responds with SdkError<DeleteDomainError>

source

pub fn delete_inbound_connection(&self) -> DeleteInboundConnection

Constructs a fluent builder for the DeleteInboundConnection operation.

The fluent builder is configurable:
- connection_id(impl Into<String>) / set_connection_id(Option<String>):
 The ID of the inbound connection to permanently delete.
On success, responds with DeleteInboundConnectionOutput with field(s):
- connection(Option<InboundConnection>):
 The deleted inbound connection.
On failure, responds with SdkError<DeleteInboundConnectionError>

source

pub fn delete_outbound_connection(&self) -> DeleteOutboundConnection

Constructs a fluent builder for the DeleteOutboundConnection operation.

The fluent builder is configurable:
- connection_id(impl Into<String>) / set_connection_id(Option<String>):
 The ID of the outbound connection you want to permanently delete.
On success, responds with DeleteOutboundConnectionOutput with field(s):
- connection(Option<OutboundConnection>):
 The deleted inbound connection.
On failure, responds with SdkError<DeleteOutboundConnectionError>

source

pub fn delete_package(&self) -> DeletePackage

Constructs a fluent builder for the DeletePackage operation.

The fluent builder is configurable:
- package_id(impl Into<String>) / set_package_id(Option<String>):
 The internal ID of the package you want to delete. Use DescribePackages to find this value.
On success, responds with DeletePackageOutput with field(s):
- package_details(Option<PackageDetails>):
 Information about the deleted package.
On failure, responds with SdkError<DeletePackageError>

source

pub fn delete_vpc_endpoint(&self) -> DeleteVpcEndpoint

Constructs a fluent builder for the DeleteVpcEndpoint operation.

The fluent builder is configurable:
- vpc_endpoint_id(impl Into<String>) / set_vpc_endpoint_id(Option<String>):
 The unique identifier of the endpoint.
On success, responds with DeleteVpcEndpointOutput with field(s):
- vpc_endpoint_summary(Option<VpcEndpointSummary>):
 Information about the deleted endpoint, including its current status (DELETING or DELETE_FAILED).
On failure, responds with SdkError<DeleteVpcEndpointError>

source

pub fn describe_domain(&self) -> DescribeDomain

Constructs a fluent builder for the DescribeDomain operation.

The fluent builder is configurable:
- domain_name(impl Into<String>) / set_domain_name(Option<String>):
 The name of the domain that you want information about.
On success, responds with DescribeDomainOutput with field(s):
- domain_status(Option<DomainStatus>):
 List that contains the status of each specified OpenSearch Service domain.
On failure, responds with SdkError<DescribeDomainError>

source

pub fn describe_domain_auto_tunes(&self) -> DescribeDomainAutoTunes

Constructs a fluent builder for the DescribeDomainAutoTunes operation. This operation supports pagination; See into_paginator().

The fluent builder is configurable:
- domain_name(impl Into<String>) / set_domain_name(Option<String>):
 Name of the domain that you want Auto-Tune details about.
- max_results(i32) / set_max_results(i32):
 An optional parameter that specifies the maximum number of results to return. You can use nextToken to get the next page of results.
- next_token(impl Into<String>) / set_next_token(Option<String>):
 If your initial DescribeDomainAutoTunes operation returns a nextToken, you can include the returned nextToken in subsequent DescribeDomainAutoTunes operations, which returns results in the next page.
On success, responds with DescribeDomainAutoTunesOutput with field(s):
- auto_tunes(Option<Vec<AutoTune>>):
 The list of setting adjustments that Auto-Tune has made to the domain.
- next_token(Option<String>):
 When nextToken is returned, there are more results available. The value of nextToken is a unique pagination token for each page. Make the call again using the returned token to retrieve the next page.
On failure, responds with SdkError<DescribeDomainAutoTunesError>

source

pub fn describe_domain_change_progress(&self) -> DescribeDomainChangeProgress

Constructs a fluent builder for the DescribeDomainChangeProgress operation.

The fluent builder is configurable:
- domain_name(impl Into<String>) / set_domain_name(Option<String>):
 The name of the domain to get progress information for.
- change_id(impl Into<String>) / set_change_id(Option<String>):
 The specific change ID for which you want to get progress information. If omitted, the request returns information about the most recent configuration change.
On success, responds with DescribeDomainChangeProgressOutput with field(s):
- change_progress_status(Option<ChangeProgressStatusDetails>):
 Container for information about the stages of a configuration change happening on a domain.
On failure, responds with SdkError<DescribeDomainChangeProgressError>

source

pub fn describe_domain_config(&self) -> DescribeDomainConfig

Constructs a fluent builder for the DescribeDomainConfig operation.

The fluent builder is configurable:
- domain_name(impl Into<String>) / set_domain_name(Option<String>):
 Name of the OpenSearch Service domain configuration that you want to describe.
On success, responds with DescribeDomainConfigOutput with field(s):
- domain_config(Option<DomainConfig>):
 Container for the configuration of the OpenSearch Service domain.
On failure, responds with SdkError<DescribeDomainConfigError>

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>>):
 Array of OpenSearch Service domain names that you want information about. If you don’t specify any domains, OpenSearch Service returns information about all domains owned by the account.
On success, responds with DescribeDomainsOutput with field(s):
- domain_status_list(Option<Vec<DomainStatus>>):
 The status of the requested domains.
On failure, responds with SdkError<DescribeDomainsError>

source

pub fn describe_dry_run_progress(&self) -> DescribeDryRunProgress

Constructs a fluent builder for the DescribeDryRunProgress operation.

The fluent builder is configurable:
- domain_name(impl Into<String>) / set_domain_name(Option<String>):
 The name of the domain.
- dry_run_id(impl Into<String>) / set_dry_run_id(Option<String>):
 The unique identifier of the dry run.
- load_dry_run_config(bool) / set_load_dry_run_config(Option<bool>):
 Whether to include the configuration of the dry run in the response. The configuration specifies the updates that you’re planning to make on the domain.
On success, responds with DescribeDryRunProgressOutput with field(s):
- dry_run_progress_status(Option<DryRunProgressStatus>):
 The current status of the dry run, including any validation errors.
- dry_run_config(Option<DomainStatus>):
 Details about the changes you’re planning to make on the domain.
- dry_run_results(Option<DryRunResults>):
 The results of the dry run.
On failure, responds with SdkError<DescribeDryRunProgressError>

source

pub fn describe_inbound_connections(&self) -> DescribeInboundConnections

Constructs a fluent builder for the DescribeInboundConnections operation. This operation supports pagination; See into_paginator().

The fluent builder is configurable:
- filters(Vec<Filter>) / set_filters(Option<Vec<Filter>>):
 A list of filters used to match properties for inbound cross-cluster connections.
- max_results(i32) / set_max_results(i32):
 An optional parameter that specifies the maximum number of results to return. You can use nextToken to get the next page of results.
- next_token(impl Into<String>) / set_next_token(Option<String>):
 If your initial DescribeInboundConnections operation returns a nextToken, you can include the returned nextToken in subsequent DescribeInboundConnections operations, which returns results in the next page.
On success, responds with DescribeInboundConnectionsOutput with field(s):
- connections(Option<Vec<InboundConnection>>):
 List of inbound connections.
- next_token(Option<String>):
 When nextToken is returned, there are more results available. The value of nextToken is a unique pagination token for each page. Make the call again using the returned token to retrieve the next page.
On failure, responds with SdkError<DescribeInboundConnectionsError>

source

pub fn describe_instance_type_limits(&self) -> DescribeInstanceTypeLimits

Constructs a fluent builder for the DescribeInstanceTypeLimits operation.

The fluent builder is configurable:
- domain_name(impl Into<String>) / set_domain_name(Option<String>):
 The name of the domain. Only specify if you need the limits for an existing domain.
- instance_type(OpenSearchPartitionInstanceType) / set_instance_type(Option<OpenSearchPartitionInstanceType>):
 The OpenSearch Service instance type for which you need limit information.
- engine_version(impl Into<String>) / set_engine_version(Option<String>):
 Version of OpenSearch or Elasticsearch, in the format Elasticsearch_X.Y or OpenSearch_X.Y. Defaults to the latest version of OpenSearch.
On success, responds with DescribeInstanceTypeLimitsOutput with field(s):
- limits_by_role(Option<HashMap<String, Limits>>):
 Map that contains all applicable instance type limits.data refers to data nodes.master refers to dedicated master nodes.
On failure, responds with SdkError<DescribeInstanceTypeLimitsError>

source

pub fn describe_outbound_connections(&self) -> DescribeOutboundConnections

Constructs a fluent builder for the DescribeOutboundConnections operation. This operation supports pagination; See into_paginator().

The fluent builder is configurable:
- filters(Vec<Filter>) / set_filters(Option<Vec<Filter>>):
 List of filter names and values that you can use for requests.
- max_results(i32) / set_max_results(i32):
 An optional parameter that specifies the maximum number of results to return. You can use nextToken to get the next page of results.
- next_token(impl Into<String>) / set_next_token(Option<String>):
 If your initial DescribeOutboundConnections operation returns a nextToken, you can include the returned nextToken in subsequent DescribeOutboundConnections operations, which returns results in the next page.
On success, responds with DescribeOutboundConnectionsOutput with field(s):
- connections(Option<Vec<OutboundConnection>>):
 List of outbound connections that match the filter criteria.
- next_token(Option<String>):
 When nextToken is returned, there are more results available. The value of nextToken is a unique pagination token for each page. Make the call again using the returned token to retrieve the next page.
On failure, responds with SdkError<DescribeOutboundConnectionsError>

source

pub fn describe_packages(&self) -> DescribePackages

Constructs a fluent builder for the DescribePackages operation. This operation supports pagination; See into_paginator().

The fluent builder is configurable:
- filters(Vec<DescribePackagesFilter>) / set_filters(Option<Vec<DescribePackagesFilter>>):
 Only returns packages that match the DescribePackagesFilterList values.
- max_results(i32) / set_max_results(i32):
 An optional parameter that specifies the maximum number of results to return. You can use nextToken to get the next page of results.
- next_token(impl Into<String>) / set_next_token(Option<String>):
 If your initial DescribePackageFilters operation returns a nextToken, you can include the returned nextToken in subsequent DescribePackageFilters operations, which returns results in the next page.
On success, responds with DescribePackagesOutput with field(s):
- package_details_list(Option<Vec<PackageDetails>>):
 Basic information about a package.
- next_token(Option<String>):
 When nextToken is returned, there are more results available. The value of nextToken is a unique pagination token for each page. Make the call again using the returned token to retrieve the next page.
On failure, responds with SdkError<DescribePackagesError>

source

pub fn describe_reserved_instance_offerings(
&self
) -> DescribeReservedInstanceOfferings

Constructs a fluent builder for the DescribeReservedInstanceOfferings operation. This operation supports pagination; See into_paginator().

The fluent builder is configurable:
- reserved_instance_offering_id(impl Into<String>) / set_reserved_instance_offering_id(Option<String>):
 The Reserved Instance identifier filter value. Use this parameter to show only the available instance types that match the specified reservation identifier.
- max_results(i32) / set_max_results(i32):
 An optional parameter that specifies the maximum number of results to return. You can use nextToken to get the next page of results.
- next_token(impl Into<String>) / set_next_token(Option<String>):
 If your initial DescribeReservedInstanceOfferings operation returns a nextToken, you can include the returned nextToken in subsequent DescribeReservedInstanceOfferings operations, which returns results in the next page.
On success, responds with DescribeReservedInstanceOfferingsOutput with field(s):
- next_token(Option<String>):
 When nextToken is returned, there are more results available. The value of nextToken is a unique pagination token for each page. Make the call again using the returned token to retrieve the next page.
- reserved_instance_offerings(Option<Vec<ReservedInstanceOffering>>):
 List of Reserved Instance offerings.
On failure, responds with SdkError<DescribeReservedInstanceOfferingsError>

source

pub fn describe_reserved_instances(&self) -> DescribeReservedInstances

Constructs a fluent builder for the DescribeReservedInstances operation. This operation supports pagination; See into_paginator().

The fluent builder is configurable:
- reserved_instance_id(impl Into<String>) / set_reserved_instance_id(Option<String>):
 The reserved instance identifier filter value. Use this parameter to show only the reservation that matches the specified reserved OpenSearch instance ID.
- max_results(i32) / set_max_results(i32):
 An optional parameter that specifies the maximum number of results to return. You can use nextToken to get the next page of results.
- next_token(impl Into<String>) / set_next_token(Option<String>):
 If your initial DescribeReservedInstances operation returns a nextToken, you can include the returned nextToken in subsequent DescribeReservedInstances operations, which returns results in the next page.
On success, responds with DescribeReservedInstancesOutput with field(s):
- next_token(Option<String>):
 When nextToken is returned, there are more results available. The value of nextToken is a unique pagination token for each page. Make the call again using the returned token to retrieve the next page.
- reserved_instances(Option<Vec<ReservedInstance>>):
 List of Reserved Instances in the current Region.
On failure, responds with SdkError<DescribeReservedInstancesError>

source

pub fn describe_vpc_endpoints(&self) -> DescribeVpcEndpoints

Constructs a fluent builder for the DescribeVpcEndpoints operation.

The fluent builder is configurable:
- vpc_endpoint_ids(Vec<String>) / set_vpc_endpoint_ids(Option<Vec<String>>):
 The unique identifiers of the endpoints to get information about.
On success, responds with DescribeVpcEndpointsOutput with field(s):
- vpc_endpoints(Option<Vec<VpcEndpoint>>):
 Information about each requested VPC endpoint.
- vpc_endpoint_errors(Option<Vec<VpcEndpointError>>):
 Any errors associated with the request.
On failure, responds with SdkError<DescribeVpcEndpointsError>

source

pub fn dissociate_package(&self) -> DissociatePackage

Constructs a fluent builder for the DissociatePackage operation.

The fluent builder is configurable:
- package_id(impl Into<String>) / set_package_id(Option<String>):
 Internal ID of the package to dissociate from the domain. Use ListPackagesForDomain to find this value.
- domain_name(impl Into<String>) / set_domain_name(Option<String>):
 Name of the domain to dissociate the package from.
On success, responds with DissociatePackageOutput with field(s):
- domain_package_details(Option<DomainPackageDetails>):
 Information about a package that has been dissociated from the domain.
On failure, responds with SdkError<DissociatePackageError>

source

pub fn get_compatible_versions(&self) -> GetCompatibleVersions

Constructs a fluent builder for the GetCompatibleVersions operation.

The fluent builder is configurable:
- domain_name(impl Into<String>) / set_domain_name(Option<String>):
 The name of an existing domain. Provide this parameter to limit the results to a single domain.
On success, responds with GetCompatibleVersionsOutput with field(s):
- compatible_versions(Option<Vec<CompatibleVersionsMap>>):
 A map of OpenSearch or Elasticsearch versions and the versions you can upgrade them to.
On failure, responds with SdkError<GetCompatibleVersionsError>

source

pub fn get_package_version_history(&self) -> GetPackageVersionHistory

Constructs a fluent builder for the GetPackageVersionHistory operation. This operation supports pagination; See into_paginator().

The fluent builder is configurable:
- package_id(impl Into<String>) / set_package_id(Option<String>):
 The unique identifier of the package.
- max_results(i32) / set_max_results(i32):
 An optional parameter that specifies the maximum number of results to return. You can use nextToken to get the next page of results.
- next_token(impl Into<String>) / set_next_token(Option<String>):
 If your initial GetPackageVersionHistory operation returns a nextToken, you can include the returned nextToken in subsequent GetPackageVersionHistory operations, which returns results in the next page.
On success, responds with GetPackageVersionHistoryOutput with field(s):
- package_id(Option<String>):
 The unique identifier of the package.
- package_version_history_list(Option<Vec<PackageVersionHistory>>):
 A list of package versions, along with their creation time and commit message.
- next_token(Option<String>):
 When nextToken is returned, there are more results available. The value of nextToken is a unique pagination token for each page. Make the call again using the returned token to retrieve the next page.
On failure, responds with SdkError<GetPackageVersionHistoryError>

source

pub fn get_upgrade_history(&self) -> GetUpgradeHistory

Constructs a fluent builder for the GetUpgradeHistory operation. This operation supports pagination; See into_paginator().

The fluent builder is configurable:
- domain_name(impl Into<String>) / set_domain_name(Option<String>):
 The name of an existing domain.
- max_results(i32) / set_max_results(i32):
 An optional parameter that specifies the maximum number of results to return. You can use nextToken to get the next page of results.
- next_token(impl Into<String>) / set_next_token(Option<String>):
 If your initial GetUpgradeHistory operation returns a nextToken, you can include the returned nextToken in subsequent GetUpgradeHistory operations, which returns results in the next page.
On success, responds with GetUpgradeHistoryOutput with field(s):
- upgrade_histories(Option<Vec<UpgradeHistory>>):
 A list of objects corresponding to each upgrade or upgrade eligibility check performed on a domain.
- next_token(Option<String>):
 When nextToken is returned, there are more results available. The value of nextToken is a unique pagination token for each page. Make the call again using the returned token to retrieve the next page.
On failure, responds with SdkError<GetUpgradeHistoryError>

source

pub fn get_upgrade_status(&self) -> GetUpgradeStatus

Constructs a fluent builder for the GetUpgradeStatus operation.

The fluent builder is configurable:
- domain_name(impl Into<String>) / set_domain_name(Option<String>):
 The domain of the domain to get upgrade status information for.
On success, responds with GetUpgradeStatusOutput with field(s):
- upgrade_step(Option<UpgradeStep>):
 One of three steps that an upgrade or upgrade eligibility check goes through.
- step_status(Option<UpgradeStatus>):
 The status of the current step that an upgrade is on.
- upgrade_name(Option<String>):
 A string that describes the update.
On failure, responds with SdkError<GetUpgradeStatusError>

source

pub fn list_domain_names(&self) -> ListDomainNames

Constructs a fluent builder for the ListDomainNames operation.

The fluent builder is configurable:
- engine_type(EngineType) / set_engine_type(Option<EngineType>):
 Filters the output by domain engine type.
On success, responds with ListDomainNamesOutput with field(s):
- domain_names(Option<Vec<DomainInfo>>):
 The names of all OpenSearch Service domains owned by the current user and their respective engine types.
On failure, responds with SdkError<ListDomainNamesError>

source

pub fn list_domains_for_package(&self) -> ListDomainsForPackage

Constructs a fluent builder for the ListDomainsForPackage operation. This operation supports pagination; See into_paginator().

The fluent builder is configurable:
- package_id(impl Into<String>) / set_package_id(Option<String>):
 The unique identifier of the package for which to list associated domains.
- max_results(i32) / set_max_results(i32):
 An optional parameter that specifies the maximum number of results to return. You can use nextToken to get the next page of results.
- next_token(impl Into<String>) / set_next_token(Option<String>):
 If your initial ListDomainsForPackage operation returns a nextToken, you can include the returned nextToken in subsequent ListDomainsForPackage operations, which returns results in the next page.
On success, responds with ListDomainsForPackageOutput with field(s):
- domain_package_details_list(Option<Vec<DomainPackageDetails>>):
 Information about all domains associated with a package.
- next_token(Option<String>):
 When nextToken is returned, there are more results available. The value of nextToken is a unique pagination token for each page. Make the call again using the returned token to retrieve the next page.
On failure, responds with SdkError<ListDomainsForPackageError>

source

pub fn list_instance_type_details(&self) -> ListInstanceTypeDetails

Constructs a fluent builder for the ListInstanceTypeDetails operation. This operation supports pagination; See into_paginator().

The fluent builder is configurable:
- engine_version(impl Into<String>) / set_engine_version(Option<String>):
 Version of OpenSearch or Elasticsearch, in the format Elasticsearch_X.Y or OpenSearch_X.Y. Defaults to the latest version of OpenSearch.
- domain_name(impl Into<String>) / set_domain_name(Option<String>):
 Name of the domain to list instance type details for.
- max_results(i32) / set_max_results(i32):
 An optional parameter that specifies the maximum number of results to return. You can use nextToken to get the next page of results.
- next_token(impl Into<String>) / set_next_token(Option<String>):
 If your initial ListInstanceTypeDetails operation returns a nextToken, you can include the returned nextToken in subsequent ListInstanceTypeDetails operations, which returns results in the next page.
On success, responds with ListInstanceTypeDetailsOutput with field(s):
- instance_type_details(Option<Vec<InstanceTypeDetails>>):
 Lists all supported instance types and features for the given OpenSearch or Elasticsearch version.
- next_token(Option<String>):
 When nextToken is returned, there are more results available. The value of nextToken is a unique pagination token for each page. Make the call again using the returned token to retrieve the next page.
On failure, responds with SdkError<ListInstanceTypeDetailsError>

source

pub fn list_packages_for_domain(&self) -> ListPackagesForDomain

Constructs a fluent builder for the ListPackagesForDomain operation. This operation supports pagination; See into_paginator().

The fluent builder is configurable:
- domain_name(impl Into<String>) / set_domain_name(Option<String>):
 The name of the domain for which you want to list associated packages.
- max_results(i32) / set_max_results(i32):
 An optional parameter that specifies the maximum number of results to return. You can use nextToken to get the next page of results.
- next_token(impl Into<String>) / set_next_token(Option<String>):
 If your initial ListPackagesForDomain operation returns a nextToken, you can include the returned nextToken in subsequent ListPackagesForDomain operations, which returns results in the next page.
On success, responds with ListPackagesForDomainOutput with field(s):
- domain_package_details_list(Option<Vec<DomainPackageDetails>>):
 List of all packages associated with a domain.
- next_token(Option<String>):
 When nextToken is returned, there are more results available. The value of nextToken is a unique pagination token for each page. Make the call again using the returned token to retrieve the next page.
On failure, responds with SdkError<ListPackagesForDomainError>

Constructs a fluent builder for the ListTags operation.

The fluent builder is configurable:
- arn(impl Into<String>) / set_arn(Option<String>):
 Amazon Resource Name (ARN) for the domain to view tags for.
On success, responds with ListTagsOutput with field(s):
- tag_list(Option<Vec<Tag>>):
 List of resource tags associated with the specified domain.
On failure, responds with SdkError<ListTagsError>

source

pub fn list_versions(&self) -> ListVersions

Constructs a fluent builder for the ListVersions operation. This operation supports pagination; See into_paginator().

The fluent builder is configurable:
- max_results(i32) / set_max_results(i32):
 An optional parameter that specifies the maximum number of results to return. You can use nextToken to get the next page of results.
- next_token(impl Into<String>) / set_next_token(Option<String>):
 If your initial ListVersions operation returns a nextToken, you can include the returned nextToken in subsequent ListVersions operations, which returns results in the next page.
On success, responds with ListVersionsOutput with field(s):
- versions(Option<Vec<String>>):
 A list of all versions of OpenSearch and Elasticsearch that Amazon OpenSearch Service supports.
- next_token(Option<String>):
 When nextToken is returned, there are more results available. The value of nextToken is a unique pagination token for each page. Make the call again using the returned token to retrieve the next page.
On failure, responds with SdkError<ListVersionsError>

source

pub fn list_vpc_endpoint_access(&self) -> ListVpcEndpointAccess

Constructs a fluent builder for the ListVpcEndpointAccess operation.

The fluent builder is configurable:
- domain_name(impl Into<String>) / set_domain_name(Option<String>):
 The name of the OpenSearch Service domain to retrieve access information for.
- next_token(impl Into<String>) / set_next_token(Option<String>):
 If your initial ListVpcEndpointAccess operation returns a nextToken, you can include the returned nextToken in subsequent ListVpcEndpointAccess operations, which returns results in the next page.
On success, responds with ListVpcEndpointAccessOutput with field(s):
- authorized_principal_list(Option<Vec<AuthorizedPrincipal>>):
 A list of IAM principals that can currently access the domain.
- next_token(Option<String>):
 When nextToken is returned, there are more results available. The value of nextToken is a unique pagination token for each page. Make the call again using the returned token to retrieve the next page.
On failure, responds with SdkError<ListVpcEndpointAccessError>

source

pub fn list_vpc_endpoints(&self) -> ListVpcEndpoints

Constructs a fluent builder for the ListVpcEndpoints operation.

The fluent builder is configurable:
- next_token(impl Into<String>) / set_next_token(Option<String>):
 If your initial ListVpcEndpoints operation returns a nextToken, you can include the returned nextToken in subsequent ListVpcEndpoints operations, which returns results in the next page.
On success, responds with ListVpcEndpointsOutput with field(s):
- vpc_endpoint_summary_list(Option<Vec<VpcEndpointSummary>>):
 Information about each endpoint.
- next_token(Option<String>):
 When nextToken is returned, there are more results available. The value of nextToken is a unique pagination token for each page. Make the call again using the returned token to retrieve the next page.
On failure, responds with SdkError<ListVpcEndpointsError>

source

pub fn list_vpc_endpoints_for_domain(&self) -> ListVpcEndpointsForDomain

Constructs a fluent builder for the ListVpcEndpointsForDomain operation.

The fluent builder is configurable:
- domain_name(impl Into<String>) / set_domain_name(Option<String>):
 The name of the domain to list associated VPC endpoints for.
- next_token(impl Into<String>) / set_next_token(Option<String>):
 If your initial ListEndpointsForDomain operation returns a nextToken, you can include the returned nextToken in subsequent ListEndpointsForDomain operations, which returns results in the next page.
On success, responds with ListVpcEndpointsForDomainOutput with field(s):
- vpc_endpoint_summary_list(Option<Vec<VpcEndpointSummary>>):
 Information about each endpoint associated with the domain.
- next_token(Option<String>):
 When nextToken is returned, there are more results available. The value of nextToken is a unique pagination token for each page. Make the call again using the returned token to retrieve the next page.
On failure, responds with SdkError<ListVpcEndpointsForDomainError>

source

pub fn purchase_reserved_instance_offering(
&self
) -> PurchaseReservedInstanceOffering

Constructs a fluent builder for the PurchaseReservedInstanceOffering operation.

The fluent builder is configurable:
- reserved_instance_offering_id(impl Into<String>) / set_reserved_instance_offering_id(Option<String>):
 The ID of the Reserved Instance offering to purchase.
- reservation_name(impl Into<String>) / set_reservation_name(Option<String>):
 A customer-specified identifier to track this reservation.
- instance_count(i32) / set_instance_count(i32):
 The number of OpenSearch instances to reserve.
On success, responds with PurchaseReservedInstanceOfferingOutput with field(s):
- reserved_instance_id(Option<String>):
 The ID of the Reserved Instance offering that was purchased.
- reservation_name(Option<String>):
 The customer-specified identifier used to track this reservation.
On failure, responds with SdkError<PurchaseReservedInstanceOfferingError>

source

pub fn reject_inbound_connection(&self) -> RejectInboundConnection

Constructs a fluent builder for the RejectInboundConnection operation.

The fluent builder is configurable:
- connection_id(impl Into<String>) / set_connection_id(Option<String>):
 The unique identifier of the inbound connection to reject.
On success, responds with RejectInboundConnectionOutput with field(s):
- connection(Option<InboundConnection>):
 Contains details about the rejected inbound connection.
On failure, responds with SdkError<RejectInboundConnectionError>

source

pub fn remove_tags(&self) -> RemoveTags

Constructs a fluent builder for the RemoveTags operation.

The fluent builder is configurable:
- arn(impl Into<String>) / set_arn(Option<String>):
 The Amazon Resource Name (ARN) of the domain from which you want to delete the specified tags.
- tag_keys(Vec<String>) / set_tag_keys(Option<Vec<String>>):
 The list of tag keys to remove from the domain.
On success, responds with RemoveTagsOutput
On failure, responds with SdkError<RemoveTagsError>

source

pub fn revoke_vpc_endpoint_access(&self) -> RevokeVpcEndpointAccess

Constructs a fluent builder for the RevokeVpcEndpointAccess operation.

The fluent builder is configurable:
- domain_name(impl Into<String>) / set_domain_name(Option<String>):
 The name of the OpenSearch Service domain.
- account(impl Into<String>) / set_account(Option<String>):
 The account ID to revoke access from.
On success, responds with RevokeVpcEndpointAccessOutput
On failure, responds with SdkError<RevokeVpcEndpointAccessError>

source

pub fn start_service_software_update(&self) -> StartServiceSoftwareUpdate

Constructs a fluent builder for the StartServiceSoftwareUpdate operation.

The fluent builder is configurable:
- domain_name(impl Into<String>) / set_domain_name(Option<String>):
 The name of the domain that you want to update to the latest service software.
On success, responds with StartServiceSoftwareUpdateOutput with field(s):
- service_software_options(Option<ServiceSoftwareOptions>):
 The current status of the OpenSearch Service software update.
On failure, responds with SdkError<StartServiceSoftwareUpdateError>

source

pub fn update_domain_config(&self) -> UpdateDomainConfig

Constructs a fluent builder for the UpdateDomainConfig operation.

The fluent builder is configurable:
- domain_name(impl Into<String>) / set_domain_name(Option<String>):
 The name of the domain that you’re updating.
- cluster_config(ClusterConfig) / set_cluster_config(Option<ClusterConfig>):
 Changes that you want to make to the cluster configuration, such as the instance type and number of EC2 instances.
- ebs_options(EbsOptions) / set_ebs_options(Option<EbsOptions>):
 The type and size of the EBS volume to attach to instances in the domain.
- snapshot_options(SnapshotOptions) / set_snapshot_options(Option<SnapshotOptions>):
 Option to set the time, in UTC format, for the daily automated snapshot. Default value is 0 hours.
- vpc_options(VpcOptions) / set_vpc_options(Option<VpcOptions>):
 Options to specify the subnets and security groups for a VPC endpoint. For more information, see Launching your Amazon OpenSearch Service domains using a VPC.
- cognito_options(CognitoOptions) / set_cognito_options(Option<CognitoOptions>):
 Key-value pairs to configure Amazon Cognito authentication for OpenSearch Dashboards.
- advanced_options(HashMap<String, String>) / set_advanced_options(Option<HashMap<String, String>>):
 Key-value pairs to specify advanced configuration options. The following key-value pairs are supported:
 - “rest.action.multi.allow_explicit_index”: “true” | “false” - Note the use of a string rather than a boolean. Specifies whether explicit references to indexes are allowed inside the body of HTTP requests. If you want to configure access policies for domain sub-resources, such as specific indexes and domain APIs, you must disable this property. Default is true.
 - “indices.fielddata.cache.size”: “80” - Note the use of a string rather than a boolean. Specifies the percentage of heap space allocated to field data. Default is unbounded.
 - “indices.query.bool.max_clause_count”: “1024” - Note the use of a string rather than a boolean. Specifies the maximum number of clauses allowed in a Lucene boolean query. Default is 1,024. Queries with more than the permitted number of clauses result in a TooManyClauses error.
 - “override_main_response_version”: “true” | “false” - Note the use of a string rather than a boolean. Specifies whether the domain reports its version as 7.10 to allow Elasticsearch OSS clients and plugins to continue working with it. Default is false when creating a domain and true when upgrading a domain.
 For more information, see Advanced cluster parameters.
- access_policies(impl Into<String>) / set_access_policies(Option<String>):
 Identity and Access Management (IAM) access policy as a JSON-formatted string.
- log_publishing_options(HashMap<LogType, LogPublishingOption>) / set_log_publishing_options(Option<HashMap<LogType, LogPublishingOption>>):
 Options to publish OpenSearch lots to Amazon CloudWatch Logs.
- encryption_at_rest_options(EncryptionAtRestOptions) / set_encryption_at_rest_options(Option<EncryptionAtRestOptions>):
 Encryption at rest options for the domain.
- domain_endpoint_options(DomainEndpointOptions) / set_domain_endpoint_options(Option<DomainEndpointOptions>):
 Additional options for the domain endpoint, such as whether to require HTTPS for all traffic.
- node_to_node_encryption_options(NodeToNodeEncryptionOptions) / set_node_to_node_encryption_options(Option<NodeToNodeEncryptionOptions>):
 Node-To-Node Encryption options for the domain.
- advanced_security_options(AdvancedSecurityOptionsInput) / set_advanced_security_options(Option<AdvancedSecurityOptionsInput>):
 Options for fine-grained access control.
- auto_tune_options(AutoTuneOptions) / set_auto_tune_options(Option<AutoTuneOptions>):
 Options for Auto-Tune.
- dry_run(bool) / set_dry_run(Option<bool>):
 This flag, when set to True, specifies whether the UpdateDomain request should return the results of a dry run analysis without actually applying the change. A dry run determines what type of deployment the update will cause.
- dry_run_mode(DryRunMode) / set_dry_run_mode(Option<DryRunMode>):
 The type of dry run to perform.
 - Basic only returns the type of deployment (blue/green or dynamic) that the update will cause.
 - Verbose runs an additional check to validate the changes you’re making. For more information, see Validating a domain update.
On success, responds with UpdateDomainConfigOutput with field(s):
- domain_config(Option<DomainConfig>):
 The status of the updated domain.
- dry_run_results(Option<DryRunResults>):
 Results of the dry run performed in the update domain request.
- dry_run_progress_status(Option<DryRunProgressStatus>):
 The status of the dry run being performed on the domain, if any.
On failure, responds with SdkError<UpdateDomainConfigError>

source

pub fn update_package(&self) -> UpdatePackage

Constructs a fluent builder for the UpdatePackage operation.

The fluent builder is configurable:
- package_id(impl Into<String>) / set_package_id(Option<String>):
 The unique identifier for the package.
- package_source(PackageSource) / set_package_source(Option<PackageSource>):
 Amazon S3 bucket and key for the package.
- package_description(impl Into<String>) / set_package_description(Option<String>):
 A new description of the package.
- commit_message(impl Into<String>) / set_commit_message(Option<String>):
 Commit message for the updated file, which is shown as part of GetPackageVersionHistoryResponse.
On success, responds with UpdatePackageOutput with field(s):
- package_details(Option<PackageDetails>):
 Information about a package.
On failure, responds with SdkError<UpdatePackageError>

source

pub fn update_vpc_endpoint(&self) -> UpdateVpcEndpoint

Constructs a fluent builder for the UpdateVpcEndpoint operation.

The fluent builder is configurable:
- vpc_endpoint_id(impl Into<String>) / set_vpc_endpoint_id(Option<String>):
 The unique identifier of the endpoint.
- vpc_options(VpcOptions) / set_vpc_options(Option<VpcOptions>):
 The security groups and/or subnets to add, remove, or modify.
On success, responds with UpdateVpcEndpointOutput with field(s):
- vpc_endpoint(Option<VpcEndpoint>):
 The endpoint to be updated.
On failure, responds with SdkError<UpdateVpcEndpointError>

source

pub fn upgrade_domain(&self) -> UpgradeDomain

Constructs a fluent builder for the UpgradeDomain operation.

The fluent builder is configurable:
- domain_name(impl Into<String>) / set_domain_name(Option<String>):
 Name of the OpenSearch Service domain that you want to upgrade.
- target_version(impl Into<String>) / set_target_version(Option<String>):
 OpenSearch or Elasticsearch version to which you want to upgrade, in the format Opensearch_X.Y or Elasticsearch_X.Y.
- perform_check_only(bool) / set_perform_check_only(Option<bool>):
 When true, indicates that an upgrade eligibility check needs to be performed. Does not actually perform the upgrade.
- advanced_options(HashMap<String, String>) / set_advanced_options(Option<HashMap<String, String>>):
 Only supports the override_main_response_version parameter and not other advanced options. You can only include this option when upgrading to an OpenSearch version. Specifies whether the domain reports its version as 7.10 so that it continues to work with Elasticsearch OSS clients and plugins.
On success, responds with UpgradeDomainOutput with field(s):
- upgrade_id(Option<String>):
 The unique identifier of the domain upgrade.
- domain_name(Option<String>):
 The name of the domain that was upgraded.
- target_version(Option<String>):
 OpenSearch or Elasticsearch version that the domain was upgraded to.
- perform_check_only(Option<bool>):
 When true, indicates that an upgrade eligibility check was performed.
- advanced_options(Option<HashMap<String, String>>):
 The advanced options configuration for the domain.
- change_progress_details(Option<ChangeProgressDetails>):
 Container for information about a configuration change happening on a domain.
On failure, responds with SdkError<UpgradeDomainError>

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.