Struct aws_sdk_elasticsearch::client::Client

pub struct Client { /* private fields */ }

Client for Amazon Elasticsearch Service

Client for invoking operations on Amazon Elasticsearch Service. Each operation on Amazon Elasticsearch 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_elasticsearch::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_elasticsearch::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 AcceptInboundCrossClusterSearchConnection operation has a Client::accept_inbound_cross_cluster_search_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_cross_cluster_search_connection()
    .cross_cluster_search_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_cross_cluster_search_connection( &self ) -> AcceptInboundCrossClusterSearchConnectionFluentBuilder

Constructs a fluent builder for the AcceptInboundCrossClusterSearchConnection operation.

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

    The id of the inbound connection that you want to accept.

    
    
• On success, responds with AcceptInboundCrossClusterSearchConnectionOutput with field(s):
  • cross_cluster_search_connection(Option<InboundCrossClusterSearchConnection>):

    Specifies the InboundCrossClusterSearchConnection of accepted inbound connection.

• On failure, responds with SdkError<AcceptInboundCrossClusterSearchConnectionError>

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
    

    Specify the ARN for which you want to add the tags.

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

    List of Tag that need to be added for the Elasticsearch domain.

    
    
• 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 that you want 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 that you want to associate the package with.

    
    
• On success, responds with AssociatePackageOutput with field(s):
  • domain_package_details(Option<DomainPackageDetails>):

    DomainPackageDetails

• 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 account ID to grant access to.

    
    
• On success, responds with AuthorizeVpcEndpointAccessOutput with field(s):
  • authorized_principal(Option<AuthorizedPrincipal>):

    Information about the account or service that was provided access to the domain.

• On failure, responds with SdkError<AuthorizeVpcEndpointAccessError>

impl Client

pub fn cancel_elasticsearch_service_software_update( &self ) -> CancelElasticsearchServiceSoftwareUpdateFluentBuilder

Constructs a fluent builder for the CancelElasticsearchServiceSoftwareUpdate 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 stop the latest service software update on.

    
    
• On success, responds with CancelElasticsearchServiceSoftwareUpdateOutput with field(s):
  • service_software_options(Option<ServiceSoftwareOptions>):

    The current status of the Elasticsearch service software update.

• On failure, responds with SdkError<CancelElasticsearchServiceSoftwareUpdateError>

impl Client

pub fn create_elasticsearch_domain( &self ) -> CreateElasticsearchDomainFluentBuilder

Constructs a fluent builder for the CreateElasticsearchDomain operation.

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

    The name of the Elasticsearch domain that you are creating. Domain names are unique across the domains owned by an account within an AWS region. Domain names must start with a lowercase letter and can contain the following characters: a-z (lowercase), 0-9, and - (hyphen).

    
    
  • elasticsearch_version(impl Into<String>) / set_elasticsearch_version(Option<String>):
    required: false
    

    String of format X.Y to specify version for the Elasticsearch domain eg. “1.5” or “2.3”. For more information, see Creating Elasticsearch Domains in the Amazon Elasticsearch Service Developer Guide.

    
    
  • elasticsearch_cluster_config(ElasticsearchClusterConfig) / set_elasticsearch_cluster_config(Option<ElasticsearchClusterConfig>):
    required: false
    

    Configuration options for an Elasticsearch domain. Specifies the instance type and number of instances in the domain cluster.

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

    Options to enable, disable and specify the type and size of EBS storage volumes.

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

    IAM access policy as a JSON-formatted string.

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

    Option to set time, in UTC format, of 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 VPC endpoint. For more information, see Creating a VPC in VPC Endpoints for Amazon Elasticsearch Service Domains

    
    
  • cognito_options(CognitoOptions) / set_cognito_options(Option<CognitoOptions>):
    required: false
    

    Options to specify the Cognito user and identity pools for Kibana authentication. For more information, see Amazon Cognito Authentication for Kibana.

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

    Specifies the Encryption At Rest Options.

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

    Specifies the NodeToNodeEncryptionOptions.

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

    Option to allow references to indices in an HTTP request body. Must be false when configuring access to individual sub-resources. By default, the value is true. See Configuration Advanced Options for more information.

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

    Map of LogType and LogPublishingOption, each containing options to publish a given type of Elasticsearch log.

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

    Options to specify configuration that will be applied to the domain endpoint.

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

    Specifies advanced security options.

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

    Specifies Auto-Tune options.

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

    A list of Tag added during domain creation.

    
    
• On success, responds with CreateElasticsearchDomainOutput with field(s):
  • domain_status(Option<ElasticsearchDomainStatus>):

    The status of the newly created Elasticsearch domain.

• On failure, responds with SdkError<CreateElasticsearchDomainError>

impl Client

pub fn create_outbound_cross_cluster_search_connection( &self ) -> CreateOutboundCrossClusterSearchConnectionFluentBuilder

Constructs a fluent builder for the CreateOutboundCrossClusterSearchConnection operation.

• The fluent builder is configurable:
  • source_domain_info(DomainInformation) / set_source_domain_info(Option<DomainInformation>):
    required: true
    

    Specifies the DomainInformation for the source Elasticsearch domain.

    
    
  • destination_domain_info(DomainInformation) / set_destination_domain_info(Option<DomainInformation>):
    required: true
    

    Specifies the DomainInformation for the destination Elasticsearch domain.

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

    Specifies the connection alias that will be used by the customer for this connection.

    
    
• On success, responds with CreateOutboundCrossClusterSearchConnectionOutput with field(s):
  • source_domain_info(Option<DomainInformation>):

    Specifies the DomainInformation for the source Elasticsearch domain.

  • destination_domain_info(Option<DomainInformation>):

    Specifies the DomainInformation for the destination Elasticsearch domain.

  • connection_alias(Option<String>):

    Specifies the connection alias provided during the create connection request.

  • connection_status(Option<OutboundCrossClusterSearchConnectionStatus>):

    Specifies the OutboundCrossClusterSearchConnectionStatus for the newly created connection.

  • cross_cluster_search_connection_id(Option<String>):

    Unique id for the created outbound connection, which is used for subsequent operations on connection.

• On failure, responds with SdkError<CreateOutboundCrossClusterSearchConnectionError>

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 identifier for the package.

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

    Type of package. Currently supports only TXT-DICTIONARY.

    
    
  • 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 customer S3 location PackageSource for importing the package.

    
    
• On success, responds with CreatePackageOutput with field(s):
  • package_details(Option<PackageDetails>):

    Information about the package PackageDetails.

• 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 grant access to.

    
    
  • 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_elasticsearch_domain( &self ) -> DeleteElasticsearchDomainFluentBuilder

Constructs a fluent builder for the DeleteElasticsearchDomain operation.

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

    The name of the Elasticsearch domain that you want to permanently delete.

    
    
• On success, responds with DeleteElasticsearchDomainOutput with field(s):
  • domain_status(Option<ElasticsearchDomainStatus>):

    The status of the Elasticsearch domain being deleted.

• On failure, responds with SdkError<DeleteElasticsearchDomainError>

impl Client

pub fn delete_elasticsearch_service_role( &self ) -> DeleteElasticsearchServiceRoleFluentBuilder

Constructs a fluent builder for the DeleteElasticsearchServiceRole operation.

• The fluent builder takes no input, just send it.
• On success, responds with DeleteElasticsearchServiceRoleOutput
• On failure, responds with SdkError<DeleteElasticsearchServiceRoleError>

impl Client

pub fn delete_inbound_cross_cluster_search_connection( &self ) -> DeleteInboundCrossClusterSearchConnectionFluentBuilder

Constructs a fluent builder for the DeleteInboundCrossClusterSearchConnection operation.

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

    The id of the inbound connection that you want to permanently delete.

    
    
• On success, responds with DeleteInboundCrossClusterSearchConnectionOutput with field(s):
  • cross_cluster_search_connection(Option<InboundCrossClusterSearchConnection>):

    Specifies the InboundCrossClusterSearchConnection of deleted inbound connection.

• On failure, responds with SdkError<DeleteInboundCrossClusterSearchConnectionError>

impl Client

pub fn delete_outbound_cross_cluster_search_connection( &self ) -> DeleteOutboundCrossClusterSearchConnectionFluentBuilder

Constructs a fluent builder for the DeleteOutboundCrossClusterSearchConnection operation.

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

    The id of the outbound connection that you want to permanently delete.

    
    
• On success, responds with DeleteOutboundCrossClusterSearchConnectionOutput with field(s):
  • cross_cluster_search_connection(Option<OutboundCrossClusterSearchConnection>):

    Specifies the OutboundCrossClusterSearchConnection of deleted outbound connection.

• On failure, responds with SdkError<DeleteOutboundCrossClusterSearchConnectionError>

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
    

    Internal ID of the package that you want to delete. Use DescribePackages to find this value.

    
    
• On success, responds with DeletePackageOutput with field(s):
  • package_details(Option<PackageDetails>):

    PackageDetails

• 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 to be deleted.

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

    Specifies the domain name for which you want Auto-Tune action details.

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

    Set this value to limit the number of results returned. If not specified, defaults to 100.

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

    NextToken is sent in case the earlier API call results contain the NextToken. It is used for pagination.

    
    
• On success, responds with DescribeDomainAutoTunesOutput with field(s):
  • auto_tunes(Option<Vec::<AutoTune>>):

    Specifies the list of setting adjustments that Auto-Tune has made to the domain. See the Developer Guide for more information.

  • next_token(Option<String>):

    Specifies an identifier to allow retrieval of paginated results.

• 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 domain you want to get the progress information about.

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

    The specific change ID for which you want to get progress information. This is an optional parameter. If omitted, the service returns information about the most recent configuration change.

    
    
• On success, responds with DescribeDomainChangeProgressOutput with field(s):
  • change_progress_status(Option<ChangeProgressStatusDetails>):

    Progress information for the configuration change that is requested in the DescribeDomainChangeProgress request.

• On failure, responds with SdkError<DescribeDomainChangeProgressError>

impl Client

pub fn describe_elasticsearch_domain( &self ) -> DescribeElasticsearchDomainFluentBuilder

Constructs a fluent builder for the DescribeElasticsearchDomain operation.

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

    The name of the Elasticsearch domain for which you want information.

    
    
• On success, responds with DescribeElasticsearchDomainOutput with field(s):
  • domain_status(Option<ElasticsearchDomainStatus>):

    The current status of the Elasticsearch domain.

• On failure, responds with SdkError<DescribeElasticsearchDomainError>

impl Client

pub fn describe_elasticsearch_domain_config( &self ) -> DescribeElasticsearchDomainConfigFluentBuilder

Constructs a fluent builder for the DescribeElasticsearchDomainConfig operation.

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

    The Elasticsearch domain that you want to get information about.

    
    
• On success, responds with DescribeElasticsearchDomainConfigOutput with field(s):
  • domain_config(Option<ElasticsearchDomainConfig>):

    The configuration information of the domain requested in the DescribeElasticsearchDomainConfig request.

• On failure, responds with SdkError<DescribeElasticsearchDomainConfigError>

impl Client

pub fn describe_elasticsearch_domains( &self ) -> DescribeElasticsearchDomainsFluentBuilder

Constructs a fluent builder for the DescribeElasticsearchDomains operation.

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

    The Elasticsearch domains for which you want information.

    
    
• On success, responds with DescribeElasticsearchDomainsOutput with field(s):
  • domain_status_list(Vec::<ElasticsearchDomainStatus>):

    The status of the domains requested in the DescribeElasticsearchDomains request.

• On failure, responds with SdkError<DescribeElasticsearchDomainsError>

impl Client

pub fn describe_elasticsearch_instance_type_limits( &self ) -> DescribeElasticsearchInstanceTypeLimitsFluentBuilder

Constructs a fluent builder for the DescribeElasticsearchInstanceTypeLimits operation.

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

    DomainName represents the name of the Domain that we are trying to modify. This should be present only if we are querying for Elasticsearch Limits for existing domain.

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

    The instance type for an Elasticsearch cluster for which Elasticsearch Limits are needed.

    
    
  • elasticsearch_version(impl Into<String>) / set_elasticsearch_version(Option<String>):
    required: true
    

    Version of Elasticsearch for which Limits are needed.

    
    
• On success, responds with DescribeElasticsearchInstanceTypeLimitsOutput with field(s):
  • limits_by_role(Option<HashMap::<String, Limits>>):

    Map of Role of the Instance and Limits that are applicable. Role performed by given Instance in Elasticsearch can be one of the following:

    • data: If the given InstanceType is used as data node
    • master: If the given InstanceType is used as master node
    • ultra_warm: If the given InstanceType is used as warm node

• On failure, responds with SdkError<DescribeElasticsearchInstanceTypeLimitsError>

impl Client

pub fn describe_inbound_cross_cluster_search_connections( &self ) -> DescribeInboundCrossClusterSearchConnectionsFluentBuilder

Constructs a fluent builder for the DescribeInboundCrossClusterSearchConnections 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 search connection. Available Filter names for this operation are:

    • cross-cluster-search-connection-id
    • source-domain-info.domain-name
    • source-domain-info.owner-id
    • source-domain-info.region
    • destination-domain-info.domain-name
    
    
  • max_results(i32) / set_max_results(Option<i32>):
    required: false
    

    Set this value to limit the number of results returned. If not specified, defaults to 100.

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

    NextToken is sent in case the earlier API call results contain the NextToken. It is used for pagination.

    
    
• On success, responds with DescribeInboundCrossClusterSearchConnectionsOutput with field(s):
  • cross_cluster_search_connections(Option<Vec::<InboundCrossClusterSearchConnection>>):

    Consists of list of InboundCrossClusterSearchConnection matching the specified filter criteria.

  • next_token(Option<String>):

    If more results are available and NextToken is present, make the next request to the same API with the received NextToken to paginate the remaining results.

• On failure, responds with SdkError<DescribeInboundCrossClusterSearchConnectionsError>

impl Client

pub fn describe_outbound_cross_cluster_search_connections( &self ) -> DescribeOutboundCrossClusterSearchConnectionsFluentBuilder

Constructs a fluent builder for the DescribeOutboundCrossClusterSearchConnections 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 outbound cross-cluster search connection. Available Filter names for this operation are:

    • cross-cluster-search-connection-id
    • destination-domain-info.domain-name
    • destination-domain-info.owner-id
    • destination-domain-info.region
    • source-domain-info.domain-name
    
    
  • max_results(i32) / set_max_results(Option<i32>):
    required: false
    

    Set this value to limit the number of results returned. If not specified, defaults to 100.

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

    NextToken is sent in case the earlier API call results contain the NextToken. It is used for pagination.

    
    
• On success, responds with DescribeOutboundCrossClusterSearchConnectionsOutput with field(s):
  • cross_cluster_search_connections(Option<Vec::<OutboundCrossClusterSearchConnection>>):

    Consists of list of OutboundCrossClusterSearchConnection matching the specified filter criteria.

  • next_token(Option<String>):

    If more results are available and NextToken is present, make the next request to the same API with the received NextToken to paginate the remaining results.

• On failure, responds with SdkError<DescribeOutboundCrossClusterSearchConnectionsError>

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
    

    Limits results to a maximum number of packages.

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

    Used for pagination. Only necessary if a previous API call includes a non-null NextToken value. If provided, returns results for the next page.

    
    
• On success, responds with DescribePackagesOutput with field(s):
  • package_details_list(Option<Vec::<PackageDetails>>):

    List of PackageDetails objects.

  • next_token(Option<String>): (undocumented)
• On failure, responds with SdkError<DescribePackagesError>

impl Client

pub fn describe_reserved_elasticsearch_instance_offerings( &self ) -> DescribeReservedElasticsearchInstanceOfferingsFluentBuilder

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

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

    The offering identifier filter value. Use this parameter to show only the available offering that matches the specified reservation identifier.

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

    Set this value to limit the number of results returned. If not specified, defaults to 100.

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

    NextToken should be sent in case if earlier API call produced result containing NextToken. It is used for pagination.

    
    
• On success, responds with DescribeReservedElasticsearchInstanceOfferingsOutput with field(s):
  • next_token(Option<String>):

    Provides an identifier to allow retrieval of paginated results.

  • reserved_elasticsearch_instance_offerings(Option<Vec::<ReservedElasticsearchInstanceOffering>>):

    List of reserved Elasticsearch instance offerings

• On failure, responds with SdkError<DescribeReservedElasticsearchInstanceOfferingsError>

impl Client

pub fn describe_reserved_elasticsearch_instances( &self ) -> DescribeReservedElasticsearchInstancesFluentBuilder

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

• The fluent builder is configurable:
  • reserved_elasticsearch_instance_id(impl Into<String>) / set_reserved_elasticsearch_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 Elasticsearch instance ID.

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

    Set this value to limit the number of results returned. If not specified, defaults to 100.

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

    NextToken should be sent in case if earlier API call produced result containing NextToken. It is used for pagination.

    
    
• On success, responds with DescribeReservedElasticsearchInstancesOutput with field(s):
  • next_token(Option<String>):

    Provides an identifier to allow retrieval of paginated results.

  • reserved_elasticsearch_instances(Option<Vec::<ReservedElasticsearchInstance>>):

    List of reserved Elasticsearch instances.

• On failure, responds with SdkError<DescribeReservedElasticsearchInstancesError>

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 that you want 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 that you want to associate the package with.

    
    
• On success, responds with DissociatePackageOutput with field(s):
  • domain_package_details(Option<DomainPackageDetails>):

    DomainPackageDetails

• On failure, responds with SdkError<DissociatePackageError>

impl Client

pub fn get_compatible_elasticsearch_versions( &self ) -> GetCompatibleElasticsearchVersionsFluentBuilder

Constructs a fluent builder for the GetCompatibleElasticsearchVersions operation.

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

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

    
    
• On success, responds with GetCompatibleElasticsearchVersionsOutput with field(s):
  • compatible_elasticsearch_versions(Option<Vec::<CompatibleVersionsMap>>):

    A map of compatible Elasticsearch versions returned as part of the GetCompatibleElasticsearchVersions operation.

• On failure, responds with SdkError<GetCompatibleElasticsearchVersionsError>

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
    

    Returns an audit history of versions of the package.

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

    Limits results to a maximum number of versions.

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

    Used for pagination. Only necessary if a previous API call includes a non-null NextToken value. If provided, returns results for the next page.

    
    
• On success, responds with GetPackageVersionHistoryOutput with field(s):
  • package_id(Option<String>): (undocumented)
  • package_version_history_list(Option<Vec::<PackageVersionHistory>>):

    List of PackageVersionHistory objects.

  • next_token(Option<String>): (undocumented)
• 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 Elasticsearch domain. Domain names are unique across the domains owned by an account within an AWS region. Domain names start with a letter or number and can contain the following characters: a-z (lowercase), 0-9, and - (hyphen).

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

    Set this value to limit the number of results returned.

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

    Paginated APIs accepts NextToken input to returns next page results and provides a NextToken output in the response which can be used by the client to retrieve more results.

    
    
• On success, responds with GetUpgradeHistoryOutput with field(s):
  • upgrade_histories(Option<Vec::<UpgradeHistory>>):

    A list of UpgradeHistory objects corresponding to each Upgrade or Upgrade Eligibility Check performed on a domain returned as part of GetUpgradeHistoryResponse object.

  • next_token(Option<String>):

    Pagination token that needs to be supplied to the next call to get the next page of results

• 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 name of an Elasticsearch domain. Domain names are unique across the domains owned by an account within an AWS region. Domain names start with a letter or number and can contain the following characters: a-z (lowercase), 0-9, and - (hyphen).

    
    
• On success, responds with GetUpgradeStatusOutput with field(s):
  • upgrade_step(Option<UpgradeStep>):

    Represents one of 3 steps that an Upgrade or Upgrade Eligibility Check does through:

    • PreUpgradeCheck
    • Snapshot
    • Upgrade

  • step_status(Option<UpgradeStatus>):

    One of 4 statuses that a step can go through returned as part of the GetUpgradeStatusResponse object. The status can take one of the following values:

    • In Progress
    • Succeeded
    • Succeeded with Issues
    • Failed

  • upgrade_name(Option<String>):

    A string that describes the update briefly

• On failure, responds with SdkError<GetUpgradeStatusError>

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
    

    Optional parameter to filter the output by domain engine type. Acceptable values are ‘Elasticsearch’ and ‘OpenSearch’.

    
    
• On success, responds with ListDomainNamesOutput with field(s):
  • domain_names(Option<Vec::<DomainInfo>>):

    List of domain names and 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 package for which to list domains.

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

    Limits results to a maximum number of domains.

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

    Used for pagination. Only necessary if a previous API call includes a non-null NextToken value. If provided, returns results for the next page.

    
    
• On success, responds with ListDomainsForPackageOutput with field(s):
  • domain_package_details_list(Option<Vec::<DomainPackageDetails>>):

    List of DomainPackageDetails objects.

  • next_token(Option<String>): (undocumented)
• On failure, responds with SdkError<ListDomainsForPackageError>

impl Client

pub fn list_elasticsearch_instance_types( &self ) -> ListElasticsearchInstanceTypesFluentBuilder

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

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

    Version of Elasticsearch for which list of supported elasticsearch instance types are needed.

    
    
  • domain_name(impl Into<String>) / set_domain_name(Option<String>):
    required: false
    

    DomainName represents the name of the Domain that we are trying to modify. This should be present only if we are querying for list of available Elasticsearch instance types when modifying existing domain.

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

    Set this value to limit the number of results returned. Value provided must be greater than 30 else it wont be honored.

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

    NextToken should be sent in case if earlier API call produced result containing NextToken. It is used for pagination.

    
    
• On success, responds with ListElasticsearchInstanceTypesOutput with field(s):
  • elasticsearch_instance_types(Option<Vec::<EsPartitionInstanceType>>):

    List of instance types supported by Amazon Elasticsearch service for given ElasticsearchVersion

  • next_token(Option<String>):

    In case if there are more results available NextToken would be present, make further request to the same API with received NextToken to paginate remaining results.

• On failure, responds with SdkError<ListElasticsearchInstanceTypesError>

impl Client

pub fn list_elasticsearch_versions( &self ) -> ListElasticsearchVersionsFluentBuilder

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

• The fluent builder is configurable:
  • max_results(i32) / set_max_results(Option<i32>):
    required: false
    

    Set this value to limit the number of results returned. Value provided must be greater than 10 else it wont be honored.

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

    Paginated APIs accepts NextToken input to returns next page results and provides a NextToken output in the response which can be used by the client to retrieve more results.

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

    List of supported elastic search versions.

  • next_token(Option<String>):

    Paginated APIs accepts NextToken input to returns next page results and provides a NextToken output in the response which can be used by the client to retrieve more results.

• On failure, responds with SdkError<ListElasticsearchVersionsError>

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
    

    Limits results to a maximum number of packages.

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

    Used for pagination. Only necessary if a previous API call includes a non-null NextToken value. If provided, returns results for the next page.

    
    
• On success, responds with ListPackagesForDomainOutput with field(s):
  • domain_package_details_list(Option<Vec::<DomainPackageDetails>>):

    List of DomainPackageDetails objects.

  • next_token(Option<String>):

    Pagination token that needs to be supplied to the next call to get the next page of results.

• On failure, responds with SdkError<ListPackagesForDomainError>

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
    

    Specify the ARN for the Elasticsearch domain to which the tags are attached that you want to view.

    
    
• On success, responds with ListTagsOutput with field(s):
  • tag_list(Option<Vec::<Tag>>):

    List of Tag for the requested Elasticsearch domain.

• On failure, responds with SdkError<ListTagsError>

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
    

    Provides an identifier to allow retrieval of paginated results.

    
    
• On success, responds with ListVpcEndpointAccessOutput with field(s):
  • authorized_principal_list(Vec::<AuthorizedPrincipal>):

    List of AuthorizedPrincipal describing the details of the permissions to manage VPC endpoints against the specified domain.

  • next_token(String):

    Provides an identifier to allow retrieval of paginated results.

• 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
    

    Identifier to allow retrieval of paginated results.

    
    
• On success, responds with ListVpcEndpointsOutput with field(s):
  • vpc_endpoint_summary_list(Vec::<VpcEndpointSummary>):

    Information about each endpoint.

  • next_token(String):

    Provides an identifier to allow retrieval of paginated results.

• 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
    

    Name of the ElasticSearch domain whose VPC endpoints are to be listed.

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

    Provides an identifier to allow retrieval of paginated results.

    
    
• On success, responds with ListVpcEndpointsForDomainOutput with field(s):
  • vpc_endpoint_summary_list(Vec::<VpcEndpointSummary>):

    Provides list of VpcEndpointSummary summarizing details of the VPC endpoints.

  • next_token(String):

    Information about each endpoint associated with the domain.

• On failure, responds with SdkError<ListVpcEndpointsForDomainError>

impl Client

pub fn purchase_reserved_elasticsearch_instance_offering( &self ) -> PurchaseReservedElasticsearchInstanceOfferingFluentBuilder

Constructs a fluent builder for the PurchaseReservedElasticsearchInstanceOffering operation.

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

    The ID of the reserved Elasticsearch 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 Elasticsearch instances to reserve.

    
    
• On success, responds with PurchaseReservedElasticsearchInstanceOfferingOutput with field(s):
  • reserved_elasticsearch_instance_id(Option<String>):

    Details of the reserved Elasticsearch instance which was purchased.

  • reservation_name(Option<String>):

    The customer-specified identifier used to track this reservation.

• On failure, responds with SdkError<PurchaseReservedElasticsearchInstanceOfferingError>

impl Client

pub fn reject_inbound_cross_cluster_search_connection( &self ) -> RejectInboundCrossClusterSearchConnectionFluentBuilder

Constructs a fluent builder for the RejectInboundCrossClusterSearchConnection operation.

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

    The id of the inbound connection that you want to reject.

    
    
• On success, responds with RejectInboundCrossClusterSearchConnectionOutput with field(s):
  • cross_cluster_search_connection(Option<InboundCrossClusterSearchConnection>):

    Specifies the InboundCrossClusterSearchConnection of rejected inbound connection.

• On failure, responds with SdkError<RejectInboundCrossClusterSearchConnectionError>

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
    

    Specifies the ARN for the Elasticsearch domain from which you want to delete the specified tags.

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

    Specifies the TagKey list which you want to remove from the Elasticsearch 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_elasticsearch_service_software_update( &self ) -> StartElasticsearchServiceSoftwareUpdateFluentBuilder

Constructs a fluent builder for the StartElasticsearchServiceSoftwareUpdate 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.

    
    
• On success, responds with StartElasticsearchServiceSoftwareUpdateOutput with field(s):
  • service_software_options(Option<ServiceSoftwareOptions>):

    The current status of the Elasticsearch service software update.

• On failure, responds with SdkError<StartElasticsearchServiceSoftwareUpdateError>

impl Client

pub fn update_elasticsearch_domain_config( &self ) -> UpdateElasticsearchDomainConfigFluentBuilder

Constructs a fluent builder for the UpdateElasticsearchDomainConfig operation.

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

    The name of the Elasticsearch domain that you are updating.

    
    
  • elasticsearch_cluster_config(ElasticsearchClusterConfig) / set_elasticsearch_cluster_config(Option<ElasticsearchClusterConfig>):
    required: false
    

    The type and number of instances to instantiate for the domain cluster.

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

    Specify the type and size of the EBS volume that you want to use.

    
    
  • 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 VPC endpoint. For more information, see Creating a VPC in VPC Endpoints for Amazon Elasticsearch Service Domains

    
    
  • cognito_options(CognitoOptions) / set_cognito_options(Option<CognitoOptions>):
    required: false
    

    Options to specify the Cognito user and identity pools for Kibana authentication. For more information, see Amazon Cognito Authentication for Kibana.

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

    Modifies the advanced option to allow references to indices in an HTTP request body. Must be false when configuring access to individual sub-resources. By default, the value is true. See Configuration Advanced Options for more information.

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

    IAM access policy as a JSON-formatted string.

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

    Map of LogType and LogPublishingOption, each containing options to publish a given type of Elasticsearch log.

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

    Options to specify configuration that will be applied to the domain endpoint.

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

    Specifies advanced security options.

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

    Specifies the NodeToNodeEncryptionOptions.

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

    Specifies the Encryption At Rest Options.

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

    Specifies Auto-Tune options.

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

    This flag, when set to True, specifies whether the UpdateElasticsearchDomain request should return the results of validation checks without actually applying the change. This flag, when set to True, specifies the deployment mechanism through which the update shall be applied on the domain. This will not actually perform the Update.

    
    
• On success, responds with UpdateElasticsearchDomainConfigOutput with field(s):
  • domain_config(Option<ElasticsearchDomainConfig>):

    The status of the updated Elasticsearch domain.

  • dry_run_results(Option<DryRunResults>):

    Contains result of DryRun.

• On failure, responds with SdkError<UpdateElasticsearchDomainConfigError>

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
    

    Unique identifier for the package.

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

    The S3 location for importing the package specified as S3BucketName and S3Key

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

    New description of the package.

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

    An info message for the new version which will be shown as part of GetPackageVersionHistoryResponse.

    
    
• On success, responds with UpdatePackageOutput with field(s):
  • package_details(Option<PackageDetails>):

    Information about the package PackageDetails.

• On failure, responds with SdkError<UpdatePackageError>

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
    

    Unique identifier of the VPC endpoint to be updated.

    
    
  • 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_elasticsearch_domain( &self ) -> UpgradeElasticsearchDomainFluentBuilder

Constructs a fluent builder for the UpgradeElasticsearchDomain operation.

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

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

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

    The version of Elasticsearch that you intend to upgrade the domain to.

    
    
  • perform_check_only(bool) / set_perform_check_only(Option<bool>):
    required: false
    

    This flag, when set to True, indicates that an Upgrade Eligibility Check needs to be performed. This will not actually perform the Upgrade.

    
    
• On success, responds with UpgradeElasticsearchDomainOutput with field(s):
  • domain_name(Option<String>):

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

  • target_version(Option<String>):

    The version of Elasticsearch that you intend to upgrade the domain to.

  • perform_check_only(Option<bool>):

    This flag, when set to True, indicates that an Upgrade Eligibility Check needs to be performed. This will not actually perform the Upgrade.

  • change_progress_details(Option<ChangeProgressDetails>):

    Specifies change details of the domain configuration change.

• On failure, responds with SdkError<UpgradeElasticsearchDomainError>

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.