Struct aws_sdk_opensearch::client::Client

pub struct Client { /* private fields */ }

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.

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_opensearch::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_opensearch::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 AcceptInboundConnection operation has a Client::accept_inbound_connection, 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.accept_inbound_connection()
    .connection_id("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 accept_inbound_connection(&self) -> AcceptInboundConnectionFluentBuilder

Constructs a fluent builder for the AcceptInboundConnection operation.

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

    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>

impl Client

pub fn add_data_source(&self) -> AddDataSourceFluentBuilder

Constructs a fluent builder for the AddDataSource operation.

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

    The name of the domain.

    
    
  • name(impl Into<String>) / set_name(Option<String>):
    required: true
    

    The name of the data source.

    
    
  • data_source_type(DataSourceType) / set_data_source_type(Option<DataSourceType>):
    required: true
    

    The type of data source.

    
    
  • description(impl Into<String>) / set_description(Option<String>):
    required: false
    

    A description of the data source.

    
    
• On success, responds with AddDataSourceOutput with field(s):
  • message(Option<String>):

    A message associated with the data source.

• On failure, responds with SdkError<AddDataSourceError>

impl Client

pub fn add_tags(&self) -> AddTagsFluentBuilder

Constructs a fluent builder for the AddTags operation.

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

    Amazon Resource Name (ARN) for the OpenSearch Service domain to which you want to attach resource tags.

    
    
  • tag_list(Tag) / set_tag_list(Option<Vec::<Tag>>):
    required: true
    

    List of resource tags.

    
    
• On success, responds with AddTagsOutput
• On failure, responds with SdkError<AddTagsError>

impl Client

pub fn associate_package(&self) -> AssociatePackageFluentBuilder

Constructs a fluent builder for the AssociatePackage operation.

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

    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>):
    required: true
    

    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>

impl Client

pub fn authorize_vpc_endpoint_access( &self ) -> AuthorizeVpcEndpointAccessFluentBuilder

Constructs a fluent builder for the AuthorizeVpcEndpointAccess operation.

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

    The name of the OpenSearch Service domain to provide access to.

    
    
  • account(impl Into<String>) / set_account(Option<String>):
    required: true
    

    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>

impl Client

pub fn cancel_service_software_update( &self ) -> CancelServiceSoftwareUpdateFluentBuilder

Constructs a fluent builder for the CancelServiceSoftwareUpdate operation.

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

    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>

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
    

    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>):
    required: false
    

    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>):
    required: false
    

    Container for the cluster configuration of a domain.

    
    
  • ebs_options(EbsOptions) / set_ebs_options(Option<EbsOptions>):
    required: false
    

    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>):
    required: false
    

    Identity and Access Management (IAM) policy document specifying the access policies for the new domain.

    
    
  • ip_address_type(IpAddressType) / set_ip_address_type(Option<IpAddressType>):
    required: false
    

    The type of IP addresses supported by the endpoint for the domain.

    
    
  • snapshot_options(SnapshotOptions) / set_snapshot_options(Option<SnapshotOptions>):
    required: false
    

    DEPRECATED. Container for the parameters required to configure automated snapshots of domain indexes.

    
    
  • vpc_options(VpcOptions) / set_vpc_options(Option<VpcOptions>):
    required: false
    

    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>):
    required: false
    

    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>):
    required: false
    

    Key-value pairs to enable encryption at rest.

    
    
  • node_to_node_encryption_options(NodeToNodeEncryptionOptions) / set_node_to_node_encryption_options(Option<NodeToNodeEncryptionOptions>):
    required: false
    

    Enables node-to-node encryption.

    
    
  • advanced_options(impl Into<String>, impl Into<String>) / set_advanced_options(Option<HashMap::<String, String>>):
    required: false
    

    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(LogType, LogPublishingOption) / set_log_publishing_options(Option<HashMap::<LogType, LogPublishingOption>>):
    required: false
    

    Key-value pairs to configure log publishing.

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

    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>):
    required: false
    

    Options for fine-grained access control.

    
    
  • tag_list(Tag) / set_tag_list(Option<Vec::<Tag>>):
    required: false
    

    List of tags to add to the domain upon creation.

    
    
  • auto_tune_options(AutoTuneOptionsInput) / set_auto_tune_options(Option<AutoTuneOptionsInput>):
    required: false
    

    Options for Auto-Tune.

    
    
  • off_peak_window_options(OffPeakWindowOptions) / set_off_peak_window_options(Option<OffPeakWindowOptions>):
    required: false
    

    Specifies a daily 10-hour time block during which OpenSearch Service can perform configuration changes on the domain, including service software updates and Auto-Tune enhancements that require a blue/green deployment. If no options are specified, the default start time of 10:00 P.M. local time (for the Region that the domain is created in) is used.

    
    
  • software_update_options(SoftwareUpdateOptions) / set_software_update_options(Option<SoftwareUpdateOptions>):
    required: false
    

    Software update options for the domain.

    
    
• 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>

impl Client

pub fn create_outbound_connection( &self ) -> CreateOutboundConnectionFluentBuilder

Constructs a fluent builder for the CreateOutboundConnection operation.

• The fluent builder is configurable:
  • local_domain_info(DomainInformationContainer) / set_local_domain_info(Option<DomainInformationContainer>):
    required: true
    

    Name and Region of the source (local) domain.

    
    
  • remote_domain_info(DomainInformationContainer) / set_remote_domain_info(Option<DomainInformationContainer>):
    required: true
    

    Name and Region of the destination (remote) domain.

    
    
  • connection_alias(impl Into<String>) / set_connection_alias(Option<String>):
    required: true
    

    Name of the connection.

    
    
  • connection_mode(ConnectionMode) / set_connection_mode(Option<ConnectionMode>):
    required: false
    

    The connection mode.

    
    
  • connection_properties(ConnectionProperties) / set_connection_properties(Option<ConnectionProperties>):
    required: false
    

    The ConnectionProperties for the outbound 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.

  • connection_mode(Option<ConnectionMode>):

    The connection mode.

  • connection_properties(Option<ConnectionProperties>):

    The ConnectionProperties for the newly created connection.

• On failure, responds with SdkError<CreateOutboundConnectionError>

impl Client

pub fn create_package(&self) -> CreatePackageFluentBuilder

Constructs a fluent builder for the CreatePackage operation.

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

    Unique name for the package.

    
    
  • package_type(PackageType) / set_package_type(Option<PackageType>):
    required: true
    

    The type of package.

    
    
  • package_description(impl Into<String>) / set_package_description(Option<String>):
    required: false
    

    Description of the package.

    
    
  • package_source(PackageSource) / set_package_source(Option<PackageSource>):
    required: true
    

    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>

impl Client

pub fn create_vpc_endpoint(&self) -> CreateVpcEndpointFluentBuilder

Constructs a fluent builder for the CreateVpcEndpoint operation.

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

    The Amazon Resource Name (ARN) of the domain to create the endpoint for.

    
    
  • vpc_options(VpcOptions) / set_vpc_options(Option<VpcOptions>):
    required: true
    

    Options to specify the subnets and security groups for the endpoint.

    
    
  • client_token(impl Into<String>) / set_client_token(Option<String>):
    required: false
    

    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>

impl Client

pub fn delete_data_source(&self) -> DeleteDataSourceFluentBuilder

Constructs a fluent builder for the DeleteDataSource operation.

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

    The name of the domain.

    
    
  • name(impl Into<String>) / set_name(Option<String>):
    required: true
    

    The name of the data source.

    
    
• On success, responds with DeleteDataSourceOutput with field(s):
  • message(Option<String>):

    A message associated with the initiated request.

• On failure, responds with SdkError<DeleteDataSourceError>

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 status of the domain being deleted.

• On failure, responds with SdkError<DeleteDomainError>

impl Client

pub fn delete_inbound_connection(&self) -> DeleteInboundConnectionFluentBuilder

Constructs a fluent builder for the DeleteInboundConnection operation.

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

    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>

impl Client

pub fn delete_outbound_connection( &self ) -> DeleteOutboundConnectionFluentBuilder

Constructs a fluent builder for the DeleteOutboundConnection operation.

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

    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>

impl Client

pub fn delete_package(&self) -> DeletePackageFluentBuilder

Constructs a fluent builder for the DeletePackage operation.

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

    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>

impl Client

pub fn delete_vpc_endpoint(&self) -> DeleteVpcEndpointFluentBuilder

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>):
    required: true
    

    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>

impl Client

pub fn describe_domain(&self) -> DescribeDomainFluentBuilder

Constructs a fluent builder for the DescribeDomain operation.

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

    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>

impl Client

pub fn describe_domain_auto_tunes(&self) -> DescribeDomainAutoTunesFluentBuilder

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>):
    required: true
    

    Name of the domain that you want Auto-Tune details about.

    
    
  • max_results(i32) / set_max_results(Option<i32>):
    required: false
    

    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>):
    required: false
    

    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>

impl Client

pub fn describe_domain_change_progress( &self ) -> DescribeDomainChangeProgressFluentBuilder

Constructs a fluent builder for the DescribeDomainChangeProgress operation.

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

    The name of the domain to get progress information for.

    
    
  • change_id(impl Into<String>) / set_change_id(Option<String>):
    required: false
    

    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>

impl Client

pub fn describe_domain_config(&self) -> DescribeDomainConfigFluentBuilder

Constructs a fluent builder for the DescribeDomainConfig operation.

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

    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>

impl Client

pub fn describe_domain_health(&self) -> DescribeDomainHealthFluentBuilder

Constructs a fluent builder for the DescribeDomainHealth operation.

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

    The name of the domain.

    
    
• On success, responds with DescribeDomainHealthOutput with field(s):
  • domain_state(Option<DomainState>):

    The current state of the domain.

    • Processing - The domain has updates in progress.

    • Active - Requested changes have been processed and deployed to the domain.

  • availability_zone_count(Option<String>):

    The number of Availability Zones configured for the domain. If the service is unable to fetch this information, it will return NotAvailable.

  • active_availability_zone_count(Option<String>):

    The number of active Availability Zones configured for the domain. If the service is unable to fetch this information, it will return NotAvailable.

  • stand_by_availability_zone_count(Option<String>):

    The number of standby Availability Zones configured for the domain. If the service is unable to fetch this information, it will return NotAvailable.

  • data_node_count(Option<String>):

    The number of data nodes configured for the domain. If the service is unable to fetch this information, it will return NotAvailable.

  • dedicated_master(Option<bool>):

    A boolean that indicates if dedicated master nodes are activated for the domain.

  • master_eligible_node_count(Option<String>):

    The number of nodes that can be elected as a master node. If dedicated master nodes is turned on, this value is the number of dedicated master nodes configured for the domain. If the service is unable to fetch this information, it will return NotAvailable.

  • warm_node_count(Option<String>):

    The number of warm nodes configured for the domain.

  • master_node(Option<MasterNodeStatus>):

    Indicates whether the domain has an elected master node.

    • Available - The domain has an elected master node.

    • UnAvailable - The master node hasn’t yet been elected, and a quorum to elect a new master node hasn’t been reached.

  • cluster_health(Option<DomainHealth>):

    The current health status of your cluster.

    • Red - At least one primary shard is not allocated to any node.

    • Yellow - All primary shards are allocated to nodes, but some replicas aren’t.

    • Green - All primary shards and their replicas are allocated to nodes.

    • NotAvailable - Unable to retrieve cluster health.

  • total_shards(Option<String>):

    The total number of primary and replica shards for the domain.

  • total_un_assigned_shards(Option<String>):

    The total number of primary and replica shards not allocated to any of the nodes for the cluster.

  • environment_information(Option<Vec::<EnvironmentInfo>>):

    A list of EnvironmentInfo for the domain.

• On failure, responds with SdkError<DescribeDomainHealthError>

impl Client

pub fn describe_domain_nodes(&self) -> DescribeDomainNodesFluentBuilder

Constructs a fluent builder for the DescribeDomainNodes operation.

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

    The name of the domain.

    
    
• On success, responds with DescribeDomainNodesOutput with field(s):
  • domain_nodes_status_list(Option<Vec::<DomainNodesStatus>>):

    Contains nodes information list DomainNodesStatusList with details about the all nodes on the requested domain.

• On failure, responds with SdkError<DescribeDomainNodesError>

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: true
    

    Array of OpenSearch Service domain names that you want information about. You must specify at least one domain name.

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

    The status of the requested domains.

• On failure, responds with SdkError<DescribeDomainsError>

impl Client

pub fn describe_dry_run_progress(&self) -> DescribeDryRunProgressFluentBuilder

Constructs a fluent builder for the DescribeDryRunProgress operation.

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

    The name of the domain.

    
    
  • dry_run_id(impl Into<String>) / set_dry_run_id(Option<String>):
    required: false
    

    The unique identifier of the dry run.

    
    
  • load_dry_run_config(bool) / set_load_dry_run_config(Option<bool>):
    required: false
    

    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>

impl Client

pub fn describe_inbound_connections( &self ) -> DescribeInboundConnectionsFluentBuilder

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

• The fluent builder is configurable:
  • filters(Filter) / set_filters(Option<Vec::<Filter>>):
    required: false
    

    A list of filters used to match properties for inbound cross-cluster connections.

    
    
  • max_results(i32) / set_max_results(Option<i32>):
    required: false
    

    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>):
    required: false
    

    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>

impl Client

pub fn describe_instance_type_limits( &self ) -> DescribeInstanceTypeLimitsFluentBuilder

Constructs a fluent builder for the DescribeInstanceTypeLimits operation.

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

    The name of the domain. Only specify if you need the limits for an existing domain.

    
    
  • instance_type(OpenSearchPartitionInstanceType) / set_instance_type(Option<OpenSearchPartitionInstanceType>):
    required: true
    

    The OpenSearch Service instance type for which you need limit information.

    
    
  • engine_version(impl Into<String>) / set_engine_version(Option<String>):
    required: true
    

    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>

impl Client

pub fn describe_outbound_connections( &self ) -> DescribeOutboundConnectionsFluentBuilder

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

• The fluent builder is configurable:
  • filters(Filter) / set_filters(Option<Vec::<Filter>>):
    required: false
    

    List of filter names and values that you can use for requests.

    
    
  • max_results(i32) / set_max_results(Option<i32>):
    required: false
    

    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>):
    required: false
    

    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>

impl Client

pub fn describe_packages(&self) -> DescribePackagesFluentBuilder

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

• The fluent builder is configurable:
  • filters(DescribePackagesFilter) / set_filters(Option<Vec::<DescribePackagesFilter>>):
    required: false
    

    Only returns packages that match the DescribePackagesFilterList values.

    
    
  • max_results(i32) / set_max_results(Option<i32>):
    required: false
    

    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>):
    required: false
    

    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>

impl Client

pub fn describe_reserved_instance_offerings( &self ) -> DescribeReservedInstanceOfferingsFluentBuilder

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>):
    required: false
    

    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(Option<i32>):
    required: false
    

    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>):
    required: false
    

    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>

impl Client

pub fn describe_reserved_instances( &self ) -> DescribeReservedInstancesFluentBuilder

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>):
    required: false
    

    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(Option<i32>):
    required: false
    

    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>):
    required: false
    

    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>

impl Client

pub fn describe_vpc_endpoints(&self) -> DescribeVpcEndpointsFluentBuilder

Constructs a fluent builder for the DescribeVpcEndpoints operation.

• The fluent builder is configurable:
  • vpc_endpoint_ids(impl Into<String>) / set_vpc_endpoint_ids(Option<Vec::<String>>):
    required: true
    

    The unique identifiers of the endpoints to get information about.

    
    
• On success, responds with DescribeVpcEndpointsOutput with field(s):
  • vpc_endpoints(Vec::<VpcEndpoint>):

    Information about each requested VPC endpoint.

  • vpc_endpoint_errors(Vec::<VpcEndpointError>):

    Any errors associated with the request.

• On failure, responds with SdkError<DescribeVpcEndpointsError>

impl Client

pub fn dissociate_package(&self) -> DissociatePackageFluentBuilder

Constructs a fluent builder for the DissociatePackage operation.

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

    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>):
    required: true
    

    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>

impl Client

pub fn get_compatible_versions(&self) -> GetCompatibleVersionsFluentBuilder

Constructs a fluent builder for the GetCompatibleVersions operation.

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

    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>

impl Client

pub fn get_data_source(&self) -> GetDataSourceFluentBuilder

Constructs a fluent builder for the GetDataSource operation.

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

    The name of the domain.

    
    
  • name(impl Into<String>) / set_name(Option<String>):
    required: true
    

    The name of the data source.

    
    
• On success, responds with GetDataSourceOutput with field(s):
  • data_source_type(Option<DataSourceType>):

    The type of data source.

  • name(Option<String>):

    The name of the data source.

  • description(Option<String>):

    A description of the data source.

• On failure, responds with SdkError<GetDataSourceError>

impl Client

pub fn get_domain_maintenance_status( &self ) -> GetDomainMaintenanceStatusFluentBuilder

Constructs a fluent builder for the GetDomainMaintenanceStatus operation.

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

    The name of the domain.

    
    
  • maintenance_id(impl Into<String>) / set_maintenance_id(Option<String>):
    required: true
    

    The request ID of the maintenance action.

    
    
• On success, responds with GetDomainMaintenanceStatusOutput with field(s):
  • status(Option<MaintenanceStatus>):

    The status of the maintenance action.

  • status_message(Option<String>):

    The status message of the maintenance action.

  • node_id(Option<String>):

    The node ID of the maintenance action.

  • action(Option<MaintenanceType>):

    The action name.

  • created_at(Option<DateTime>):

    The time at which the action was created.

  • updated_at(Option<DateTime>):

    The time at which the action was updated.

• On failure, responds with SdkError<GetDomainMaintenanceStatusError>

impl Client

pub fn get_package_version_history( &self ) -> GetPackageVersionHistoryFluentBuilder

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>):
    required: true
    

    The unique identifier of the package.

    
    
  • max_results(i32) / set_max_results(Option<i32>):
    required: false
    

    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>):
    required: false
    

    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>

impl Client

pub fn get_upgrade_history(&self) -> GetUpgradeHistoryFluentBuilder

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>):
    required: true
    

    The name of an existing domain.

    
    
  • max_results(i32) / set_max_results(Option<i32>):
    required: false
    

    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>):
    required: false
    

    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>

impl Client

pub fn get_upgrade_status(&self) -> GetUpgradeStatusFluentBuilder

Constructs a fluent builder for the GetUpgradeStatus operation.

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

    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>

impl Client

pub fn list_data_sources(&self) -> ListDataSourcesFluentBuilder

Constructs a fluent builder for the ListDataSources operation.

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

    The name of the domain.

    
    
• On success, responds with ListDataSourcesOutput with field(s):
  • data_sources(Option<Vec::<DataSourceDetails>>):

    A list of the data sources.

• On failure, responds with SdkError<ListDataSourcesError>

impl Client

pub fn list_domain_maintenances(&self) -> ListDomainMaintenancesFluentBuilder

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

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

    The name of the domain.

    
    
  • action(MaintenanceType) / set_action(Option<MaintenanceType>):
    required: false
    

    The name of the action.

    
    
  • status(MaintenanceStatus) / set_status(Option<MaintenanceStatus>):
    required: false
    

    The status of the action.

    
    
  • max_results(i32) / set_max_results(Option<i32>):
    required: false
    

    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>):
    required: false
    

    If your initial ListDomainMaintenances operation returns a nextToken, include the returned nextToken in subsequent ListDomainMaintenances operations, which returns results in the next page.

    
    
• On success, responds with ListDomainMaintenancesOutput with field(s):
  • domain_maintenances(Option<Vec::<DomainMaintenanceDetails>>):

    A list of the submitted maintenance actions.

  • 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<ListDomainMaintenancesError>

impl Client

pub fn list_domain_names(&self) -> ListDomainNamesFluentBuilder

Constructs a fluent builder for the ListDomainNames operation.

• The fluent builder is configurable:
  • engine_type(EngineType) / set_engine_type(Option<EngineType>):
    required: false
    

    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>

impl Client

pub fn list_domains_for_package(&self) -> ListDomainsForPackageFluentBuilder

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>):
    required: true
    

    The unique identifier of the package for which to list associated domains.

    
    
  • max_results(i32) / set_max_results(Option<i32>):
    required: false
    

    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>):
    required: false
    

    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>

impl Client

pub fn list_instance_type_details(&self) -> ListInstanceTypeDetailsFluentBuilder

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>):
    required: true
    

    The 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>):
    required: false
    

    The name of the domain.

    
    
  • max_results(i32) / set_max_results(Option<i32>):
    required: false
    

    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>):
    required: false
    

    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.

    
    
  • retrieve_azs(bool) / set_retrieve_azs(Option<bool>):
    required: false
    

    An optional parameter that specifies the Availability Zones for the domain.

    
    
  • instance_type(impl Into<String>) / set_instance_type(Option<String>):
    required: false
    

    An optional parameter that lists information for a given instance type.

    
    
• 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>

impl Client

pub fn list_packages_for_domain(&self) -> ListPackagesForDomainFluentBuilder

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>):
    required: true
    

    The name of the domain for which you want to list associated packages.

    
    
  • max_results(i32) / set_max_results(Option<i32>):
    required: false
    

    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>):
    required: false
    

    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>

impl Client

pub fn list_scheduled_actions(&self) -> ListScheduledActionsFluentBuilder

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

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

    The name of the domain.

    
    
  • max_results(i32) / set_max_results(Option<i32>):
    required: false
    

    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>):
    required: false
    

    If your initial ListScheduledActions operation returns a nextToken, you can include the returned nextToken in subsequent ListScheduledActions operations, which returns results in the next page.

    
    
• On success, responds with ListScheduledActionsOutput with field(s):
  • scheduled_actions(Option<Vec::<ScheduledAction>>):

    A list of actions that are scheduled for 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<ListScheduledActionsError>

impl Client

pub fn list_tags(&self) -> ListTagsFluentBuilder

Constructs a fluent builder for the ListTags operation.

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

    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>

impl Client

pub fn list_versions(&self) -> ListVersionsFluentBuilder

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(Option<i32>):
    required: false
    

    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>):
    required: false
    

    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>

impl Client

pub fn list_vpc_endpoint_access(&self) -> ListVpcEndpointAccessFluentBuilder

Constructs a fluent builder for the ListVpcEndpointAccess operation.

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

    The name of the OpenSearch Service domain to retrieve access information for.

    
    
  • next_token(impl Into<String>) / set_next_token(Option<String>):
    required: false
    

    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(Vec::<AuthorizedPrincipal>):

    A list of IAM principals that can currently access the domain.

  • next_token(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>

impl Client

pub fn list_vpc_endpoints(&self) -> ListVpcEndpointsFluentBuilder

Constructs a fluent builder for the ListVpcEndpoints operation.

• The fluent builder is configurable:
  • next_token(impl Into<String>) / set_next_token(Option<String>):
    required: false
    

    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(Vec::<VpcEndpointSummary>):

    Information about each endpoint.

  • next_token(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>

impl Client

pub fn list_vpc_endpoints_for_domain( &self ) -> ListVpcEndpointsForDomainFluentBuilder

Constructs a fluent builder for the ListVpcEndpointsForDomain operation.

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

    The name of the domain to list associated VPC endpoints for.

    
    
  • next_token(impl Into<String>) / set_next_token(Option<String>):
    required: false
    

    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(Vec::<VpcEndpointSummary>):

    Information about each endpoint associated with the domain.

  • next_token(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>

impl Client

pub fn purchase_reserved_instance_offering( &self ) -> PurchaseReservedInstanceOfferingFluentBuilder

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>):
    required: true
    

    The ID of the Reserved Instance offering to purchase.

    
    
  • reservation_name(impl Into<String>) / set_reservation_name(Option<String>):
    required: true
    

    A customer-specified identifier to track this reservation.

    
    
  • instance_count(i32) / set_instance_count(Option<i32>):
    required: false
    

    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>

impl Client

pub fn reject_inbound_connection(&self) -> RejectInboundConnectionFluentBuilder

Constructs a fluent builder for the RejectInboundConnection operation.

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

    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>

impl Client

pub fn remove_tags(&self) -> RemoveTagsFluentBuilder

Constructs a fluent builder for the RemoveTags operation.

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

    The Amazon Resource Name (ARN) of the domain from which you want to delete the specified tags.

    
    
  • tag_keys(impl Into<String>) / set_tag_keys(Option<Vec::<String>>):
    required: true
    

    The list of tag keys to remove from the domain.

    
    
• On success, responds with RemoveTagsOutput
• On failure, responds with SdkError<RemoveTagsError>

impl Client

pub fn revoke_vpc_endpoint_access(&self) -> RevokeVpcEndpointAccessFluentBuilder

Constructs a fluent builder for the RevokeVpcEndpointAccess operation.

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

    The name of the OpenSearch Service domain.

    
    
  • account(impl Into<String>) / set_account(Option<String>):
    required: true
    

    The account ID to revoke access from.

    
    
• On success, responds with RevokeVpcEndpointAccessOutput
• On failure, responds with SdkError<RevokeVpcEndpointAccessError>

impl Client

pub fn start_domain_maintenance(&self) -> StartDomainMaintenanceFluentBuilder

Constructs a fluent builder for the StartDomainMaintenance operation.

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

    The name of the domain.

    
    
  • action(MaintenanceType) / set_action(Option<MaintenanceType>):
    required: true
    

    The name of the action.

    
    
  • node_id(impl Into<String>) / set_node_id(Option<String>):
    required: false
    

    The ID of the data node.

    
    
• On success, responds with StartDomainMaintenanceOutput with field(s):
  • maintenance_id(Option<String>):

    The request ID of requested action.

• On failure, responds with SdkError<StartDomainMaintenanceError>

impl Client

pub fn start_service_software_update( &self ) -> StartServiceSoftwareUpdateFluentBuilder

Constructs a fluent builder for the StartServiceSoftwareUpdate operation.

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

    The name of the domain that you want to update to the latest service software.

    
    
  • schedule_at(ScheduleAt) / set_schedule_at(Option<ScheduleAt>):
    required: false
    

    When to start the service software update.

    • NOW - Immediately schedules the update to happen in the current hour if there’s capacity available.

    • TIMESTAMP - Lets you specify a custom date and time to apply the update. If you specify this value, you must also provide a value for DesiredStartTime.

    • OFF_PEAK_WINDOW - Marks the update to be picked up during an upcoming off-peak window. There’s no guarantee that the update will happen during the next immediate window. Depending on capacity, it might happen in subsequent days.

    Default: NOW if you don’t specify a value for DesiredStartTime, and TIMESTAMP if you do.

    
    
  • desired_start_time(i64) / set_desired_start_time(Option<i64>):
    required: false
    

    The Epoch timestamp when you want the service software update to start. You only need to specify this parameter if you set ScheduleAt to TIMESTAMP.

    
    
• 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>

impl Client

pub fn update_data_source(&self) -> UpdateDataSourceFluentBuilder

Constructs a fluent builder for the UpdateDataSource operation.

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

    The name of the domain.

    
    
  • name(impl Into<String>) / set_name(Option<String>):
    required: true
    

    The name of the data source.

    
    
  • data_source_type(DataSourceType) / set_data_source_type(Option<DataSourceType>):
    required: true
    

    The type of data source.

    
    
  • description(impl Into<String>) / set_description(Option<String>):
    required: false
    

    A description of the data source.

    
    
• On success, responds with UpdateDataSourceOutput with field(s):
  • message(Option<String>):

    A message associated with the data source.

• On failure, responds with SdkError<UpdateDataSourceError>

impl Client

pub fn update_domain_config(&self) -> UpdateDomainConfigFluentBuilder

Constructs a fluent builder for the UpdateDomainConfig operation.

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

    The name of the domain that you’re updating.

    
    
  • cluster_config(ClusterConfig) / set_cluster_config(Option<ClusterConfig>):
    required: false
    

    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>):
    required: false
    

    The type and size of the EBS volume to attach to instances in the domain.

    
    
  • snapshot_options(SnapshotOptions) / set_snapshot_options(Option<SnapshotOptions>):
    required: false
    

    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>):
    required: false
    

    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>):
    required: false
    

    Key-value pairs to configure Amazon Cognito authentication for OpenSearch Dashboards.

    
    
  • advanced_options(impl Into<String>, impl Into<String>) / set_advanced_options(Option<HashMap::<String, String>>):
    required: false
    

    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.

    For more information, see Advanced cluster parameters.

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

    Identity and Access Management (IAM) access policy as a JSON-formatted string.

    
    
  • ip_address_type(IpAddressType) / set_ip_address_type(Option<IpAddressType>):
    required: false
    

    The type of IP addresses supported by the endpoint for the domain.

    
    
  • log_publishing_options(LogType, LogPublishingOption) / set_log_publishing_options(Option<HashMap::<LogType, LogPublishingOption>>):
    required: false
    

    Options to publish OpenSearch logs to Amazon CloudWatch Logs.

    
    
  • encryption_at_rest_options(EncryptionAtRestOptions) / set_encryption_at_rest_options(Option<EncryptionAtRestOptions>):
    required: false
    

    Encryption at rest options for the domain.

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

    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>):
    required: false
    

    Node-to-node encryption options for the domain.

    
    
  • advanced_security_options(AdvancedSecurityOptionsInput) / set_advanced_security_options(Option<AdvancedSecurityOptionsInput>):
    required: false
    

    Options for fine-grained access control.

    
    
  • auto_tune_options(AutoTuneOptions) / set_auto_tune_options(Option<AutoTuneOptions>):
    required: false
    

    Options for Auto-Tune.

    
    
  • dry_run(bool) / set_dry_run(Option<bool>):
    required: false
    

    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>):
    required: false
    

    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.

    
    
  • off_peak_window_options(OffPeakWindowOptions) / set_off_peak_window_options(Option<OffPeakWindowOptions>):
    required: false
    

    Off-peak window options for the domain.

    
    
  • software_update_options(SoftwareUpdateOptions) / set_software_update_options(Option<SoftwareUpdateOptions>):
    required: false
    

    Service software update options for the domain.

    
    
• 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>

impl Client

pub fn update_package(&self) -> UpdatePackageFluentBuilder

Constructs a fluent builder for the UpdatePackage operation.

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

    The unique identifier for the package.

    
    
  • package_source(PackageSource) / set_package_source(Option<PackageSource>):
    required: true
    

    Amazon S3 bucket and key for the package.

    
    
  • package_description(impl Into<String>) / set_package_description(Option<String>):
    required: false
    

    A new description of the package.

    
    
  • commit_message(impl Into<String>) / set_commit_message(Option<String>):
    required: false
    

    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>

impl Client

pub fn update_scheduled_action(&self) -> UpdateScheduledActionFluentBuilder

Constructs a fluent builder for the UpdateScheduledAction operation.

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

    The name of the domain to reschedule an action for.

    
    
  • action_id(impl Into<String>) / set_action_id(Option<String>):
    required: true
    

    The unique identifier of the action to reschedule. To retrieve this ID, send a ListScheduledActions request.

    
    
  • action_type(ActionType) / set_action_type(Option<ActionType>):
    required: true
    

    The type of action to reschedule. Can be one of SERVICE_SOFTWARE_UPDATE, JVM_HEAP_SIZE_TUNING, or JVM_YOUNG_GEN_TUNING. To retrieve this value, send a ListScheduledActions request.

    
    
  • schedule_at(ScheduleAt) / set_schedule_at(Option<ScheduleAt>):
    required: true
    

    When to schedule the action.

    • NOW - Immediately schedules the update to happen in the current hour if there’s capacity available.

    • TIMESTAMP - Lets you specify a custom date and time to apply the update. If you specify this value, you must also provide a value for DesiredStartTime.

    • OFF_PEAK_WINDOW - Marks the action to be picked up during an upcoming off-peak window. There’s no guarantee that the change will be implemented during the next immediate window. Depending on capacity, it might happen in subsequent days.

    
    
  • desired_start_time(i64) / set_desired_start_time(Option<i64>):
    required: false
    

    The time to implement the change, in Coordinated Universal Time (UTC). Only specify this parameter if you set ScheduleAt to TIMESTAMP.

    
    
• On success, responds with UpdateScheduledActionOutput with field(s):
  • scheduled_action(Option<ScheduledAction>):

    Information about the rescheduled action.

• On failure, responds with SdkError<UpdateScheduledActionError>

impl Client

pub fn update_vpc_endpoint(&self) -> UpdateVpcEndpointFluentBuilder

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>):
    required: true
    

    The unique identifier of the endpoint.

    
    
  • vpc_options(VpcOptions) / set_vpc_options(Option<VpcOptions>):
    required: true
    

    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>

impl Client

pub fn upgrade_domain(&self) -> UpgradeDomainFluentBuilder

Constructs a fluent builder for the UpgradeDomain operation.

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

    Name of the OpenSearch Service domain that you want to upgrade.

    
    
  • target_version(impl Into<String>) / set_target_version(Option<String>):
    required: true
    

    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>):
    required: false
    

    When true, indicates that an upgrade eligibility check needs to be performed. Does not actually perform the upgrade.

    
    
  • advanced_options(impl Into<String>, impl Into<String>) / set_advanced_options(Option<HashMap::<String, String>>):
    required: false
    

    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>

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.