Struct aws_sdk_elasticsearch::client::Client

pub struct Client<C = DynConnector, M = DefaultMiddleware, R = Standard> { /* 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.

Examples

Constructing a client and invoking an operation

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

Constructing a client with custom configuration

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

Implementations

impl<C, M, R> Client<C, M, R>

pub fn with_config(client: Client<C, M, R>, conf: Config) -> Self

Creates a client with the given service configuration.

pub fn conf(&self) -> &Config

Returns the client’s configuration.

impl<C, M, R> Client<C, M, R> where
    C: SmithyConnector,
    M: SmithyMiddleware<C>,
    R: NewRequestPolicy, 

pub fn accept_inbound_cross_cluster_search_connection(
    &self
) -> AcceptInboundCrossClusterSearchConnection<C, M, R>

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

    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>

pub fn add_tags(&self) -> AddTags<C, M, R>

Constructs a fluent builder for the AddTags operation.

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

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

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

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

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

pub fn associate_package(&self) -> AssociatePackage<C, M, R>

Constructs a fluent builder for the AssociatePackage operation.

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

    Internal ID of the package that you want to associate with a domain. Use DescribePackages to find this value.

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

    Name of the domain 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>

pub fn cancel_elasticsearch_service_software_update(
    &self
) -> CancelElasticsearchServiceSoftwareUpdate<C, M, R>

Constructs a fluent builder for the CancelElasticsearchServiceSoftwareUpdate operation.

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

    The name of the domain that you want to 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>

pub fn create_elasticsearch_domain(&self) -> CreateElasticsearchDomain<C, M, R>

Constructs a fluent builder for the CreateElasticsearchDomain operation.

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

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

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

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

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

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

    IAM access policy as a JSON-formatted string.

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

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

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

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

    Specifies the Encryption At Rest Options.

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

    Specifies the NodeToNodeEncryptionOptions.

  • advanced_options(HashMap<String, String>) / set_advanced_options(Option<HashMap<String, String>>):

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

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

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

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

    Specifies advanced security options.

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

    Specifies Auto-Tune options.

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

    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>

pub fn create_outbound_cross_cluster_search_connection(
    &self
) -> CreateOutboundCrossClusterSearchConnection<C, M, R>

Constructs a fluent builder for the CreateOutboundCrossClusterSearchConnection operation.

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

    Specifies the DomainInformation for the source Elasticsearch domain.

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

    Specifies the DomainInformation for the destination Elasticsearch domain.

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

    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>

pub fn create_package(&self) -> CreatePackage<C, M, R>

Constructs a fluent builder for the CreatePackage operation.

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

    Unique identifier for the package.

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

    Type of package. Currently supports only TXT-DICTIONARY.

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

    Description of the package.

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

    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>

pub fn delete_elasticsearch_domain(&self) -> DeleteElasticsearchDomain<C, M, R>

Constructs a fluent builder for the DeleteElasticsearchDomain operation.

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

    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>

pub fn delete_elasticsearch_service_role(
    &self
) -> DeleteElasticsearchServiceRole<C, M, R>

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>

pub fn delete_inbound_cross_cluster_search_connection(
    &self
) -> DeleteInboundCrossClusterSearchConnection<C, M, R>

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

    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>

pub fn delete_outbound_cross_cluster_search_connection(
    &self
) -> DeleteOutboundCrossClusterSearchConnection<C, M, R>

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

    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>

pub fn delete_package(&self) -> DeletePackage<C, M, R>

Constructs a fluent builder for the DeletePackage operation.

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

    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>

pub fn describe_domain_auto_tunes(&self) -> DescribeDomainAutoTunes<C, M, R>

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

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

  • max_results(i32) / set_max_results(i32):

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

    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>

pub fn describe_elasticsearch_domain(
    &self
) -> DescribeElasticsearchDomain<C, M, R>

Constructs a fluent builder for the DescribeElasticsearchDomain operation.

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

    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>

pub fn describe_elasticsearch_domain_config(
    &self
) -> DescribeElasticsearchDomainConfig<C, M, R>

Constructs a fluent builder for the DescribeElasticsearchDomainConfig operation.

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

    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>

pub fn describe_elasticsearch_domains(
    &self
) -> DescribeElasticsearchDomains<C, M, R>

Constructs a fluent builder for the DescribeElasticsearchDomains operation.

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

    The Elasticsearch domains for which you want information.

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

    The status of the domains requested in the DescribeElasticsearchDomains request.

• On failure, responds with SdkError<DescribeElasticsearchDomainsError>

pub fn describe_elasticsearch_instance_type_limits(
    &self
) -> DescribeElasticsearchInstanceTypeLimits<C, M, R>

Constructs a fluent builder for the DescribeElasticsearchInstanceTypeLimits operation.

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

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

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

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

    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>

pub fn describe_inbound_cross_cluster_search_connections(
    &self
) -> DescribeInboundCrossClusterSearchConnections<C, M, R>

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

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

    A list of filters used to match properties for inbound cross-cluster 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(i32):

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

    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>

pub fn describe_outbound_cross_cluster_search_connections(
    &self
) -> DescribeOutboundCrossClusterSearchConnections<C, M, R>

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

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

    A list of filters used to match properties for 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(i32):

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

    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>

pub fn describe_packages(&self) -> DescribePackages<C, M, R>

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

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

    Only returns packages that match the DescribePackagesFilterList values.

  • max_results(i32) / set_max_results(i32):

    Limits results to a maximum number of packages.

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

    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>

pub fn describe_reserved_elasticsearch_instance_offerings(
    &self
) -> DescribeReservedElasticsearchInstanceOfferings<C, M, R>

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

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

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

    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>

pub fn describe_reserved_elasticsearch_instances(
    &self
) -> DescribeReservedElasticsearchInstances<C, M, R>

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

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

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

    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>

pub fn dissociate_package(&self) -> DissociatePackage<C, M, R>

Constructs a fluent builder for the DissociatePackage operation.

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

    Internal ID of the package that you want to associate with a domain. Use DescribePackages to find this value.

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

    Name of the domain 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>

pub fn get_compatible_elasticsearch_versions(
    &self
) -> GetCompatibleElasticsearchVersions<C, M, R>

Constructs a fluent builder for the GetCompatibleElasticsearchVersions operation.

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

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

pub fn get_package_version_history(&self) -> GetPackageVersionHistory<C, M, R>

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

    Returns an audit history of versions of the package.

  • max_results(i32) / set_max_results(i32):

    Limits results to a maximum number of versions.

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

    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>

pub fn get_upgrade_history(&self) -> GetUpgradeHistory<C, M, R>

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

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

    The name of an 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(i32):

    Set this value to limit the number of results returned.

  • next_token(impl Into<String>) / set_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 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>

pub fn get_upgrade_status(&self) -> GetUpgradeStatus<C, M, R>

Constructs a fluent builder for the GetUpgradeStatus operation.

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

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

pub fn list_domain_names(&self) -> ListDomainNames<C, M, R>

Constructs a fluent builder for the ListDomainNames operation.

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

    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>

pub fn list_domains_for_package(&self) -> ListDomainsForPackage<C, M, R>

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

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

    The package for which to list domains.

  • max_results(i32) / set_max_results(i32):

    Limits results to a maximum number of domains.

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

    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>

pub fn list_elasticsearch_instance_types(
    &self
) -> ListElasticsearchInstanceTypes<C, M, R>

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

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

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

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

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

    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>

pub fn list_elasticsearch_versions(&self) -> ListElasticsearchVersions<C, M, R>

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

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

    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>

pub fn list_packages_for_domain(&self) -> ListPackagesForDomain<C, M, R>

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

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

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

  • max_results(i32) / set_max_results(i32):

    Limits results to a maximum number of packages.

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

    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>

pub fn list_tags(&self) -> ListTags<C, M, R>

Constructs a fluent builder for the ListTags operation.

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

    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>

pub fn purchase_reserved_elasticsearch_instance_offering(
    &self
) -> PurchaseReservedElasticsearchInstanceOffering<C, M, R>

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

    The ID of the reserved Elasticsearch instance offering to purchase.

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

    A customer-specified identifier to track this reservation.

  • instance_count(i32) / set_instance_count(i32):

    The number of 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>

pub fn reject_inbound_cross_cluster_search_connection(
    &self
) -> RejectInboundCrossClusterSearchConnection<C, M, R>

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

    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>

pub fn remove_tags(&self) -> RemoveTags<C, M, R>

Constructs a fluent builder for the RemoveTags operation.

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

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

  • tag_keys(Vec<String>) / set_tag_keys(Option<Vec<String>>):

    Specifies the TagKey list which you want to remove from the Elasticsearch domain.

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

pub fn start_elasticsearch_service_software_update(
    &self
) -> StartElasticsearchServiceSoftwareUpdate<C, M, R>

Constructs a fluent builder for the StartElasticsearchServiceSoftwareUpdate operation.

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

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

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

    The current status of the Elasticsearch service software update.

• On failure, responds with SdkError<StartElasticsearchServiceSoftwareUpdateError>

pub fn update_elasticsearch_domain_config(
    &self
) -> UpdateElasticsearchDomainConfig<C, M, R>

Constructs a fluent builder for the UpdateElasticsearchDomainConfig operation.

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

    The name of the Elasticsearch domain that you are updating.

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

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

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

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

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

    Option to set the time, in UTC format, for the daily automated snapshot. Default value is 0 hours.

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

    Options to specify the subnets and security groups for 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>):

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

  • advanced_options(HashMap<String, String>) / set_advanced_options(Option<HashMap<String, String>>):

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

    IAM access policy as a JSON-formatted string.

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

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

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

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

    Specifies advanced security options.

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

    Specifies the NodeToNodeEncryptionOptions.

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

    Specifies the Encryption At Rest Options.

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

    Specifies Auto-Tune options.

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

    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>

pub fn update_package(&self) -> UpdatePackage<C, M, R>

Constructs a fluent builder for the UpdatePackage operation.

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

    Unique identifier for the package.

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

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

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

    New description of the package.

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

    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>

pub fn upgrade_elasticsearch_domain(
    &self
) -> UpgradeElasticsearchDomain<C, M, R>

Constructs a fluent builder for the UpgradeElasticsearchDomain operation.

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

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

  • perform_check_only(bool) / set_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.

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

• On failure, responds with SdkError<UpgradeElasticsearchDomainError>

impl<C> Client<C, DefaultMiddleware, Standard>

pub fn from_conf_conn(conf: Config, conn: C) -> Self

Creates a client with the given service config and connector override.

impl Client<DynConnector, DefaultMiddleware, Standard>

pub fn new(config: &Config) -> Self

Creates a new client from a shared config.

pub fn from_conf(conf: Config) -> Self

Creates a new client from the service Config.

Trait Implementations

impl<C, M, R> Clone for Client<C, M, R>

fn clone(&self) -> Self

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<C: Debug, M: Debug, R: Debug> Debug for Client<C, M, R>

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

Formats the value using the given formatter.

impl<C, M, R> From<Client<C, M, R>> for Client<C, M, R>

fn from(client: Client<C, M, R>) -> Self

Performs the conversion.