Skip to content

ElasticsearchServiceClient

Index > ElasticsearchService > ElasticsearchServiceClient

Auto-generated documentation for ElasticsearchService type annotations stubs module mypy-boto3-es.

ElasticsearchServiceClient

Type annotations and code completion for boto3.client("es"). boto3 documentation

Usage example
from boto3.session import Session
from mypy_boto3_es.client import ElasticsearchServiceClient

def get_es_client() -> ElasticsearchServiceClient:
    return Session().client("es")

Exceptions

boto3 client exceptions are generated in runtime. This class provides code completion for boto3.client("es").exceptions structure.

Usage example
client = boto3.client("es")

try:
    do_something(client)
except (
    client.AccessDeniedException,
    client.BaseException,
    client.ClientError,
    client.ConflictException,
    client.DisabledOperationException,
    client.InternalException,
    client.InvalidPaginationTokenException,
    client.InvalidTypeException,
    client.LimitExceededException,
    client.ResourceAlreadyExistsException,
    client.ResourceNotFoundException,
    client.ValidationException,
) as e:
    print(e)
Type checking example
from mypy_boto3_es.client import Exceptions

def handle_error(exc: Exceptions.AccessDeniedException) -> None:
    ...

Methods

accept_inbound_cross_cluster_search_connection

Allows the destination domain owner to accept an inbound cross-cluster search connection request.

Type annotations and code completion for boto3.client("es").accept_inbound_cross_cluster_search_connection method. boto3 documentation

Method definition
def accept_inbound_cross_cluster_search_connection(
    self,
    *,
    CrossClusterSearchConnectionId: str,
) -> AcceptInboundCrossClusterSearchConnectionResponseTypeDef:  # (1)
    ...
  1. See AcceptInboundCrossClusterSearchConnectionResponseTypeDef
Usage example with kwargs
kwargs: AcceptInboundCrossClusterSearchConnectionRequestRequestTypeDef = {  # (1)
    "CrossClusterSearchConnectionId": ...,
}

parent.accept_inbound_cross_cluster_search_connection(**kwargs)
  1. See AcceptInboundCrossClusterSearchConnectionRequestRequestTypeDef

add_tags

Attaches tags to an existing Elasticsearch domain.

Type annotations and code completion for boto3.client("es").add_tags method. boto3 documentation

Method definition
def add_tags(
    self,
    *,
    ARN: str,
    TagList: Sequence[TagTypeDef],  # (1)
) -> EmptyResponseMetadataTypeDef:  # (2)
    ...
  1. See TagTypeDef
  2. See EmptyResponseMetadataTypeDef
Usage example with kwargs
kwargs: AddTagsRequestRequestTypeDef = {  # (1)
    "ARN": ...,
    "TagList": ...,
}

parent.add_tags(**kwargs)
  1. See AddTagsRequestRequestTypeDef

associate_package

Associates a package with an Amazon ES domain.

Type annotations and code completion for boto3.client("es").associate_package method. boto3 documentation

Method definition
def associate_package(
    self,
    *,
    PackageID: str,
    DomainName: str,
) -> AssociatePackageResponseTypeDef:  # (1)
    ...
  1. See AssociatePackageResponseTypeDef
Usage example with kwargs
kwargs: AssociatePackageRequestRequestTypeDef = {  # (1)
    "PackageID": ...,
    "DomainName": ...,
}

parent.associate_package(**kwargs)
  1. See AssociatePackageRequestRequestTypeDef

can_paginate

Check if an operation can be paginated.

Type annotations and code completion for boto3.client("es").can_paginate method. boto3 documentation

Method definition
def can_paginate(
    self,
    operation_name: str,
) -> bool:
    ...

cancel_elasticsearch_service_software_update

Cancels a scheduled service software update for an Amazon ES domain.

Type annotations and code completion for boto3.client("es").cancel_elasticsearch_service_software_update method. boto3 documentation

Method definition
def cancel_elasticsearch_service_software_update(
    self,
    *,
    DomainName: str,
) -> CancelElasticsearchServiceSoftwareUpdateResponseTypeDef:  # (1)
    ...
  1. See CancelElasticsearchServiceSoftwareUpdateResponseTypeDef
Usage example with kwargs
kwargs: CancelElasticsearchServiceSoftwareUpdateRequestRequestTypeDef = {  # (1)
    "DomainName": ...,
}

parent.cancel_elasticsearch_service_software_update(**kwargs)
  1. See CancelElasticsearchServiceSoftwareUpdateRequestRequestTypeDef

close

Closes underlying endpoint connections.

Type annotations and code completion for boto3.client("es").close method. boto3 documentation

Method definition
def close(
    self,
) -> None:
    ...

create_elasticsearch_domain

Creates a new Elasticsearch domain.

Type annotations and code completion for boto3.client("es").create_elasticsearch_domain method. boto3 documentation

Method definition
def create_elasticsearch_domain(
    self,
    *,
    DomainName: str,
    ElasticsearchVersion: str = ...,
    ElasticsearchClusterConfig: ElasticsearchClusterConfigTypeDef = ...,  # (1)
    EBSOptions: EBSOptionsTypeDef = ...,  # (2)
    AccessPolicies: str = ...,
    SnapshotOptions: SnapshotOptionsTypeDef = ...,  # (3)
    VPCOptions: VPCOptionsTypeDef = ...,  # (4)
    CognitoOptions: CognitoOptionsTypeDef = ...,  # (5)
    EncryptionAtRestOptions: EncryptionAtRestOptionsTypeDef = ...,  # (6)
    NodeToNodeEncryptionOptions: NodeToNodeEncryptionOptionsTypeDef = ...,  # (7)
    AdvancedOptions: Mapping[str, str] = ...,
    LogPublishingOptions: Mapping[LogTypeType, LogPublishingOptionTypeDef] = ...,  # (8)
    DomainEndpointOptions: DomainEndpointOptionsTypeDef = ...,  # (9)
    AdvancedSecurityOptions: AdvancedSecurityOptionsInputTypeDef = ...,  # (10)
    AutoTuneOptions: AutoTuneOptionsInputTypeDef = ...,  # (11)
    TagList: Sequence[TagTypeDef] = ...,  # (12)
) -> CreateElasticsearchDomainResponseTypeDef:  # (13)
    ...
  1. See ElasticsearchClusterConfigTypeDef
  2. See EBSOptionsTypeDef
  3. See SnapshotOptionsTypeDef
  4. See VPCOptionsTypeDef
  5. See CognitoOptionsTypeDef
  6. See EncryptionAtRestOptionsTypeDef
  7. See NodeToNodeEncryptionOptionsTypeDef
  8. See LogTypeType LogPublishingOptionTypeDef
  9. See DomainEndpointOptionsTypeDef
  10. See AdvancedSecurityOptionsInputTypeDef
  11. See AutoTuneOptionsInputTypeDef
  12. See TagTypeDef
  13. See CreateElasticsearchDomainResponseTypeDef
Usage example with kwargs
kwargs: CreateElasticsearchDomainRequestRequestTypeDef = {  # (1)
    "DomainName": ...,
}

parent.create_elasticsearch_domain(**kwargs)
  1. See CreateElasticsearchDomainRequestRequestTypeDef

create_outbound_cross_cluster_search_connection

Creates a new cross-cluster search connection from a source domain to a destination domain.

Type annotations and code completion for boto3.client("es").create_outbound_cross_cluster_search_connection method. boto3 documentation

Method definition
def create_outbound_cross_cluster_search_connection(
    self,
    *,
    SourceDomainInfo: DomainInformationTypeDef,  # (1)
    DestinationDomainInfo: DomainInformationTypeDef,  # (1)
    ConnectionAlias: str,
) -> CreateOutboundCrossClusterSearchConnectionResponseTypeDef:  # (3)
    ...
  1. See DomainInformationTypeDef
  2. See DomainInformationTypeDef
  3. See CreateOutboundCrossClusterSearchConnectionResponseTypeDef
Usage example with kwargs
kwargs: CreateOutboundCrossClusterSearchConnectionRequestRequestTypeDef = {  # (1)
    "SourceDomainInfo": ...,
    "DestinationDomainInfo": ...,
    "ConnectionAlias": ...,
}

parent.create_outbound_cross_cluster_search_connection(**kwargs)
  1. See CreateOutboundCrossClusterSearchConnectionRequestRequestTypeDef

create_package

Create a package for use with Amazon ES domains.

Type annotations and code completion for boto3.client("es").create_package method. boto3 documentation

Method definition
def create_package(
    self,
    *,
    PackageName: str,
    PackageType: PackageTypeType,  # (1)
    PackageSource: PackageSourceTypeDef,  # (2)
    PackageDescription: str = ...,
) -> CreatePackageResponseTypeDef:  # (3)
    ...
  1. See PackageTypeType
  2. See PackageSourceTypeDef
  3. See CreatePackageResponseTypeDef
Usage example with kwargs
kwargs: CreatePackageRequestRequestTypeDef = {  # (1)
    "PackageName": ...,
    "PackageType": ...,
    "PackageSource": ...,
}

parent.create_package(**kwargs)
  1. See CreatePackageRequestRequestTypeDef

delete_elasticsearch_domain

Permanently deletes the specified Elasticsearch domain and all of its data.

Type annotations and code completion for boto3.client("es").delete_elasticsearch_domain method. boto3 documentation

Method definition
def delete_elasticsearch_domain(
    self,
    *,
    DomainName: str,
) -> DeleteElasticsearchDomainResponseTypeDef:  # (1)
    ...
  1. See DeleteElasticsearchDomainResponseTypeDef
Usage example with kwargs
kwargs: DeleteElasticsearchDomainRequestRequestTypeDef = {  # (1)
    "DomainName": ...,
}

parent.delete_elasticsearch_domain(**kwargs)
  1. See DeleteElasticsearchDomainRequestRequestTypeDef

delete_elasticsearch_service_role

Deletes the service-linked role that Elasticsearch Service uses to manage and maintain VPC domains.

Type annotations and code completion for boto3.client("es").delete_elasticsearch_service_role method. boto3 documentation

Method definition
def delete_elasticsearch_service_role(
    self,
) -> EmptyResponseMetadataTypeDef:  # (1)
    ...
  1. See EmptyResponseMetadataTypeDef

delete_inbound_cross_cluster_search_connection

Allows the destination domain owner to delete an existing inbound cross-cluster search connection.

Type annotations and code completion for boto3.client("es").delete_inbound_cross_cluster_search_connection method. boto3 documentation

Method definition
def delete_inbound_cross_cluster_search_connection(
    self,
    *,
    CrossClusterSearchConnectionId: str,
) -> DeleteInboundCrossClusterSearchConnectionResponseTypeDef:  # (1)
    ...
  1. See DeleteInboundCrossClusterSearchConnectionResponseTypeDef
Usage example with kwargs
kwargs: DeleteInboundCrossClusterSearchConnectionRequestRequestTypeDef = {  # (1)
    "CrossClusterSearchConnectionId": ...,
}

parent.delete_inbound_cross_cluster_search_connection(**kwargs)
  1. See DeleteInboundCrossClusterSearchConnectionRequestRequestTypeDef

delete_outbound_cross_cluster_search_connection

Allows the source domain owner to delete an existing outbound cross-cluster search connection.

Type annotations and code completion for boto3.client("es").delete_outbound_cross_cluster_search_connection method. boto3 documentation

Method definition
def delete_outbound_cross_cluster_search_connection(
    self,
    *,
    CrossClusterSearchConnectionId: str,
) -> DeleteOutboundCrossClusterSearchConnectionResponseTypeDef:  # (1)
    ...
  1. See DeleteOutboundCrossClusterSearchConnectionResponseTypeDef
Usage example with kwargs
kwargs: DeleteOutboundCrossClusterSearchConnectionRequestRequestTypeDef = {  # (1)
    "CrossClusterSearchConnectionId": ...,
}

parent.delete_outbound_cross_cluster_search_connection(**kwargs)
  1. See DeleteOutboundCrossClusterSearchConnectionRequestRequestTypeDef

delete_package

Delete the package.

Type annotations and code completion for boto3.client("es").delete_package method. boto3 documentation

Method definition
def delete_package(
    self,
    *,
    PackageID: str,
) -> DeletePackageResponseTypeDef:  # (1)
    ...
  1. See DeletePackageResponseTypeDef
Usage example with kwargs
kwargs: DeletePackageRequestRequestTypeDef = {  # (1)
    "PackageID": ...,
}

parent.delete_package(**kwargs)
  1. See DeletePackageRequestRequestTypeDef

describe_domain_auto_tunes

Provides scheduled Auto-Tune action details for the Elasticsearch domain, such as Auto-Tune action type, description, severity, and scheduled date.

Type annotations and code completion for boto3.client("es").describe_domain_auto_tunes method. boto3 documentation

Method definition
def describe_domain_auto_tunes(
    self,
    *,
    DomainName: str,
    MaxResults: int = ...,
    NextToken: str = ...,
) -> DescribeDomainAutoTunesResponseTypeDef:  # (1)
    ...
  1. See DescribeDomainAutoTunesResponseTypeDef
Usage example with kwargs
kwargs: DescribeDomainAutoTunesRequestRequestTypeDef = {  # (1)
    "DomainName": ...,
}

parent.describe_domain_auto_tunes(**kwargs)
  1. See DescribeDomainAutoTunesRequestRequestTypeDef

describe_domain_change_progress

Returns information about the current blue/green deployment happening on a domain, including a change ID, status, and progress stages.

Type annotations and code completion for boto3.client("es").describe_domain_change_progress method. boto3 documentation

Method definition
def describe_domain_change_progress(
    self,
    *,
    DomainName: str,
    ChangeId: str = ...,
) -> DescribeDomainChangeProgressResponseTypeDef:  # (1)
    ...
  1. See DescribeDomainChangeProgressResponseTypeDef
Usage example with kwargs
kwargs: DescribeDomainChangeProgressRequestRequestTypeDef = {  # (1)
    "DomainName": ...,
}

parent.describe_domain_change_progress(**kwargs)
  1. See DescribeDomainChangeProgressRequestRequestTypeDef

describe_elasticsearch_domain

Returns domain configuration information about the specified Elasticsearch domain, including the domain ID, domain endpoint, and domain ARN.

Type annotations and code completion for boto3.client("es").describe_elasticsearch_domain method. boto3 documentation

Method definition
def describe_elasticsearch_domain(
    self,
    *,
    DomainName: str,
) -> DescribeElasticsearchDomainResponseTypeDef:  # (1)
    ...
  1. See DescribeElasticsearchDomainResponseTypeDef
Usage example with kwargs
kwargs: DescribeElasticsearchDomainRequestRequestTypeDef = {  # (1)
    "DomainName": ...,
}

parent.describe_elasticsearch_domain(**kwargs)
  1. See DescribeElasticsearchDomainRequestRequestTypeDef

describe_elasticsearch_domain_config

Provides cluster configuration information about the specified Elasticsearch domain, such as the state, creation date, update version, and update date for cluster options.

Type annotations and code completion for boto3.client("es").describe_elasticsearch_domain_config method. boto3 documentation

Method definition
def describe_elasticsearch_domain_config(
    self,
    *,
    DomainName: str,
) -> DescribeElasticsearchDomainConfigResponseTypeDef:  # (1)
    ...
  1. See DescribeElasticsearchDomainConfigResponseTypeDef
Usage example with kwargs
kwargs: DescribeElasticsearchDomainConfigRequestRequestTypeDef = {  # (1)
    "DomainName": ...,
}

parent.describe_elasticsearch_domain_config(**kwargs)
  1. See DescribeElasticsearchDomainConfigRequestRequestTypeDef

describe_elasticsearch_domains

Returns domain configuration information about the specified Elasticsearch domains, including the domain ID, domain endpoint, and domain ARN.

Type annotations and code completion for boto3.client("es").describe_elasticsearch_domains method. boto3 documentation

Method definition
def describe_elasticsearch_domains(
    self,
    *,
    DomainNames: Sequence[str],
) -> DescribeElasticsearchDomainsResponseTypeDef:  # (1)
    ...
  1. See DescribeElasticsearchDomainsResponseTypeDef
Usage example with kwargs
kwargs: DescribeElasticsearchDomainsRequestRequestTypeDef = {  # (1)
    "DomainNames": ...,
}

parent.describe_elasticsearch_domains(**kwargs)
  1. See DescribeElasticsearchDomainsRequestRequestTypeDef

describe_elasticsearch_instance_type_limits

Describe Elasticsearch Limits for a given InstanceType and ElasticsearchVersion.

Type annotations and code completion for boto3.client("es").describe_elasticsearch_instance_type_limits method. boto3 documentation

Method definition
def describe_elasticsearch_instance_type_limits(
    self,
    *,
    InstanceType: ESPartitionInstanceTypeType,  # (1)
    ElasticsearchVersion: str,
    DomainName: str = ...,
) -> DescribeElasticsearchInstanceTypeLimitsResponseTypeDef:  # (2)
    ...
  1. See ESPartitionInstanceTypeType
  2. See DescribeElasticsearchInstanceTypeLimitsResponseTypeDef
Usage example with kwargs
kwargs: DescribeElasticsearchInstanceTypeLimitsRequestRequestTypeDef = {  # (1)
    "InstanceType": ...,
    "ElasticsearchVersion": ...,
}

parent.describe_elasticsearch_instance_type_limits(**kwargs)
  1. See DescribeElasticsearchInstanceTypeLimitsRequestRequestTypeDef

describe_inbound_cross_cluster_search_connections

Lists all the inbound cross-cluster search connections for a destination domain.

Type annotations and code completion for boto3.client("es").describe_inbound_cross_cluster_search_connections method. boto3 documentation

Method definition
def describe_inbound_cross_cluster_search_connections(
    self,
    *,
    Filters: Sequence[FilterTypeDef] = ...,  # (1)
    MaxResults: int = ...,
    NextToken: str = ...,
) -> DescribeInboundCrossClusterSearchConnectionsResponseTypeDef:  # (2)
    ...
  1. See FilterTypeDef
  2. See DescribeInboundCrossClusterSearchConnectionsResponseTypeDef
Usage example with kwargs
kwargs: DescribeInboundCrossClusterSearchConnectionsRequestRequestTypeDef = {  # (1)
    "Filters": ...,
}

parent.describe_inbound_cross_cluster_search_connections(**kwargs)
  1. See DescribeInboundCrossClusterSearchConnectionsRequestRequestTypeDef

describe_outbound_cross_cluster_search_connections

Lists all the outbound cross-cluster search connections for a source domain.

Type annotations and code completion for boto3.client("es").describe_outbound_cross_cluster_search_connections method. boto3 documentation

Method definition
def describe_outbound_cross_cluster_search_connections(
    self,
    *,
    Filters: Sequence[FilterTypeDef] = ...,  # (1)
    MaxResults: int = ...,
    NextToken: str = ...,
) -> DescribeOutboundCrossClusterSearchConnectionsResponseTypeDef:  # (2)
    ...
  1. See FilterTypeDef
  2. See DescribeOutboundCrossClusterSearchConnectionsResponseTypeDef
Usage example with kwargs
kwargs: DescribeOutboundCrossClusterSearchConnectionsRequestRequestTypeDef = {  # (1)
    "Filters": ...,
}

parent.describe_outbound_cross_cluster_search_connections(**kwargs)
  1. See DescribeOutboundCrossClusterSearchConnectionsRequestRequestTypeDef

describe_packages

Describes all packages available to Amazon ES.

Type annotations and code completion for boto3.client("es").describe_packages method. boto3 documentation

Method definition
def describe_packages(
    self,
    *,
    Filters: Sequence[DescribePackagesFilterTypeDef] = ...,  # (1)
    MaxResults: int = ...,
    NextToken: str = ...,
) -> DescribePackagesResponseTypeDef:  # (2)
    ...
  1. See DescribePackagesFilterTypeDef
  2. See DescribePackagesResponseTypeDef
Usage example with kwargs
kwargs: DescribePackagesRequestRequestTypeDef = {  # (1)
    "Filters": ...,
}

parent.describe_packages(**kwargs)
  1. See DescribePackagesRequestRequestTypeDef

describe_reserved_elasticsearch_instance_offerings

Lists available reserved Elasticsearch instance offerings.

Type annotations and code completion for boto3.client("es").describe_reserved_elasticsearch_instance_offerings method. boto3 documentation

Method definition
def describe_reserved_elasticsearch_instance_offerings(
    self,
    *,
    ReservedElasticsearchInstanceOfferingId: str = ...,
    MaxResults: int = ...,
    NextToken: str = ...,
) -> DescribeReservedElasticsearchInstanceOfferingsResponseTypeDef:  # (1)
    ...
  1. See DescribeReservedElasticsearchInstanceOfferingsResponseTypeDef
Usage example with kwargs
kwargs: DescribeReservedElasticsearchInstanceOfferingsRequestRequestTypeDef = {  # (1)
    "ReservedElasticsearchInstanceOfferingId": ...,
}

parent.describe_reserved_elasticsearch_instance_offerings(**kwargs)
  1. See DescribeReservedElasticsearchInstanceOfferingsRequestRequestTypeDef

describe_reserved_elasticsearch_instances

Returns information about reserved Elasticsearch instances for this account.

Type annotations and code completion for boto3.client("es").describe_reserved_elasticsearch_instances method. boto3 documentation

Method definition
def describe_reserved_elasticsearch_instances(
    self,
    *,
    ReservedElasticsearchInstanceId: str = ...,
    MaxResults: int = ...,
    NextToken: str = ...,
) -> DescribeReservedElasticsearchInstancesResponseTypeDef:  # (1)
    ...
  1. See DescribeReservedElasticsearchInstancesResponseTypeDef
Usage example with kwargs
kwargs: DescribeReservedElasticsearchInstancesRequestRequestTypeDef = {  # (1)
    "ReservedElasticsearchInstanceId": ...,
}

parent.describe_reserved_elasticsearch_instances(**kwargs)
  1. See DescribeReservedElasticsearchInstancesRequestRequestTypeDef

dissociate_package

Dissociates a package from the Amazon ES domain.

Type annotations and code completion for boto3.client("es").dissociate_package method. boto3 documentation

Method definition
def dissociate_package(
    self,
    *,
    PackageID: str,
    DomainName: str,
) -> DissociatePackageResponseTypeDef:  # (1)
    ...
  1. See DissociatePackageResponseTypeDef
Usage example with kwargs
kwargs: DissociatePackageRequestRequestTypeDef = {  # (1)
    "PackageID": ...,
    "DomainName": ...,
}

parent.dissociate_package(**kwargs)
  1. See DissociatePackageRequestRequestTypeDef

generate_presigned_url

Generate a presigned url given a client, its method, and arguments.

Type annotations and code completion for boto3.client("es").generate_presigned_url method. boto3 documentation

Method definition
def generate_presigned_url(
    self,
    ClientMethod: str,
    Params: Mapping[str, Any] = ...,
    ExpiresIn: int = 3600,
    HttpMethod: str = ...,
) -> str:
    ...

get_compatible_elasticsearch_versions

Returns a list of upgrade compatible Elastisearch versions.

Type annotations and code completion for boto3.client("es").get_compatible_elasticsearch_versions method. boto3 documentation

Method definition
def get_compatible_elasticsearch_versions(
    self,
    *,
    DomainName: str = ...,
) -> GetCompatibleElasticsearchVersionsResponseTypeDef:  # (1)
    ...
  1. See GetCompatibleElasticsearchVersionsResponseTypeDef
Usage example with kwargs
kwargs: GetCompatibleElasticsearchVersionsRequestRequestTypeDef = {  # (1)
    "DomainName": ...,
}

parent.get_compatible_elasticsearch_versions(**kwargs)
  1. See GetCompatibleElasticsearchVersionsRequestRequestTypeDef

get_package_version_history

Returns a list of versions of the package, along with their creation time and commit message.

Type annotations and code completion for boto3.client("es").get_package_version_history method. boto3 documentation

Method definition
def get_package_version_history(
    self,
    *,
    PackageID: str,
    MaxResults: int = ...,
    NextToken: str = ...,
) -> GetPackageVersionHistoryResponseTypeDef:  # (1)
    ...
  1. See GetPackageVersionHistoryResponseTypeDef
Usage example with kwargs
kwargs: GetPackageVersionHistoryRequestRequestTypeDef = {  # (1)
    "PackageID": ...,
}

parent.get_package_version_history(**kwargs)
  1. See GetPackageVersionHistoryRequestRequestTypeDef

get_upgrade_history

Retrieves the complete history of the last 10 upgrades that were performed on the domain.

Type annotations and code completion for boto3.client("es").get_upgrade_history method. boto3 documentation

Method definition
def get_upgrade_history(
    self,
    *,
    DomainName: str,
    MaxResults: int = ...,
    NextToken: str = ...,
) -> GetUpgradeHistoryResponseTypeDef:  # (1)
    ...
  1. See GetUpgradeHistoryResponseTypeDef
Usage example with kwargs
kwargs: GetUpgradeHistoryRequestRequestTypeDef = {  # (1)
    "DomainName": ...,
}

parent.get_upgrade_history(**kwargs)
  1. See GetUpgradeHistoryRequestRequestTypeDef

get_upgrade_status

Retrieves the latest status of the last upgrade or upgrade eligibility check that was performed on the domain.

Type annotations and code completion for boto3.client("es").get_upgrade_status method. boto3 documentation

Method definition
def get_upgrade_status(
    self,
    *,
    DomainName: str,
) -> GetUpgradeStatusResponseTypeDef:  # (1)
    ...
  1. See GetUpgradeStatusResponseTypeDef
Usage example with kwargs
kwargs: GetUpgradeStatusRequestRequestTypeDef = {  # (1)
    "DomainName": ...,
}

parent.get_upgrade_status(**kwargs)
  1. See GetUpgradeStatusRequestRequestTypeDef

list_domain_names

Returns the name of all Elasticsearch domains owned by the current user's account.

Type annotations and code completion for boto3.client("es").list_domain_names method. boto3 documentation

Method definition
def list_domain_names(
    self,
    *,
    EngineType: EngineTypeType = ...,  # (1)
) -> ListDomainNamesResponseTypeDef:  # (2)
    ...
  1. See EngineTypeType
  2. See ListDomainNamesResponseTypeDef
Usage example with kwargs
kwargs: ListDomainNamesRequestRequestTypeDef = {  # (1)
    "EngineType": ...,
}

parent.list_domain_names(**kwargs)
  1. See ListDomainNamesRequestRequestTypeDef

list_domains_for_package

Lists all Amazon ES domains associated with the package.

Type annotations and code completion for boto3.client("es").list_domains_for_package method. boto3 documentation

Method definition
def list_domains_for_package(
    self,
    *,
    PackageID: str,
    MaxResults: int = ...,
    NextToken: str = ...,
) -> ListDomainsForPackageResponseTypeDef:  # (1)
    ...
  1. See ListDomainsForPackageResponseTypeDef
Usage example with kwargs
kwargs: ListDomainsForPackageRequestRequestTypeDef = {  # (1)
    "PackageID": ...,
}

parent.list_domains_for_package(**kwargs)
  1. See ListDomainsForPackageRequestRequestTypeDef

list_elasticsearch_instance_types

List all Elasticsearch instance types that are supported for given ElasticsearchVersion See also: AWS API Documentation.

Type annotations and code completion for boto3.client("es").list_elasticsearch_instance_types method. boto3 documentation

Method definition
def list_elasticsearch_instance_types(
    self,
    *,
    ElasticsearchVersion: str,
    DomainName: str = ...,
    MaxResults: int = ...,
    NextToken: str = ...,
) -> ListElasticsearchInstanceTypesResponseTypeDef:  # (1)
    ...
  1. See ListElasticsearchInstanceTypesResponseTypeDef
Usage example with kwargs
kwargs: ListElasticsearchInstanceTypesRequestRequestTypeDef = {  # (1)
    "ElasticsearchVersion": ...,
}

parent.list_elasticsearch_instance_types(**kwargs)
  1. See ListElasticsearchInstanceTypesRequestRequestTypeDef

list_elasticsearch_versions

List all supported Elasticsearch versions See also: AWS API Documentation.

Type annotations and code completion for boto3.client("es").list_elasticsearch_versions method. boto3 documentation

Method definition
def list_elasticsearch_versions(
    self,
    *,
    MaxResults: int = ...,
    NextToken: str = ...,
) -> ListElasticsearchVersionsResponseTypeDef:  # (1)
    ...
  1. See ListElasticsearchVersionsResponseTypeDef
Usage example with kwargs
kwargs: ListElasticsearchVersionsRequestRequestTypeDef = {  # (1)
    "MaxResults": ...,
}

parent.list_elasticsearch_versions(**kwargs)
  1. See ListElasticsearchVersionsRequestRequestTypeDef

list_packages_for_domain

Lists all packages associated with the Amazon ES domain.

Type annotations and code completion for boto3.client("es").list_packages_for_domain method. boto3 documentation

Method definition
def list_packages_for_domain(
    self,
    *,
    DomainName: str,
    MaxResults: int = ...,
    NextToken: str = ...,
) -> ListPackagesForDomainResponseTypeDef:  # (1)
    ...
  1. See ListPackagesForDomainResponseTypeDef
Usage example with kwargs
kwargs: ListPackagesForDomainRequestRequestTypeDef = {  # (1)
    "DomainName": ...,
}

parent.list_packages_for_domain(**kwargs)
  1. See ListPackagesForDomainRequestRequestTypeDef

list_tags

Returns all tags for the given Elasticsearch domain.

Type annotations and code completion for boto3.client("es").list_tags method. boto3 documentation

Method definition
def list_tags(
    self,
    *,
    ARN: str,
) -> ListTagsResponseTypeDef:  # (1)
    ...
  1. See ListTagsResponseTypeDef
Usage example with kwargs
kwargs: ListTagsRequestRequestTypeDef = {  # (1)
    "ARN": ...,
}

parent.list_tags(**kwargs)
  1. See ListTagsRequestRequestTypeDef

purchase_reserved_elasticsearch_instance_offering

Allows you to purchase reserved Elasticsearch instances.

Type annotations and code completion for boto3.client("es").purchase_reserved_elasticsearch_instance_offering method. boto3 documentation

Method definition
def purchase_reserved_elasticsearch_instance_offering(
    self,
    *,
    ReservedElasticsearchInstanceOfferingId: str,
    ReservationName: str,
    InstanceCount: int = ...,
) -> PurchaseReservedElasticsearchInstanceOfferingResponseTypeDef:  # (1)
    ...
  1. See PurchaseReservedElasticsearchInstanceOfferingResponseTypeDef
Usage example with kwargs
kwargs: PurchaseReservedElasticsearchInstanceOfferingRequestRequestTypeDef = {  # (1)
    "ReservedElasticsearchInstanceOfferingId": ...,
    "ReservationName": ...,
}

parent.purchase_reserved_elasticsearch_instance_offering(**kwargs)
  1. See PurchaseReservedElasticsearchInstanceOfferingRequestRequestTypeDef

reject_inbound_cross_cluster_search_connection

Allows the destination domain owner to reject an inbound cross-cluster search connection request.

Type annotations and code completion for boto3.client("es").reject_inbound_cross_cluster_search_connection method. boto3 documentation

Method definition
def reject_inbound_cross_cluster_search_connection(
    self,
    *,
    CrossClusterSearchConnectionId: str,
) -> RejectInboundCrossClusterSearchConnectionResponseTypeDef:  # (1)
    ...
  1. See RejectInboundCrossClusterSearchConnectionResponseTypeDef
Usage example with kwargs
kwargs: RejectInboundCrossClusterSearchConnectionRequestRequestTypeDef = {  # (1)
    "CrossClusterSearchConnectionId": ...,
}

parent.reject_inbound_cross_cluster_search_connection(**kwargs)
  1. See RejectInboundCrossClusterSearchConnectionRequestRequestTypeDef

remove_tags

Removes the specified set of tags from the specified Elasticsearch domain.

Type annotations and code completion for boto3.client("es").remove_tags method. boto3 documentation

Method definition
def remove_tags(
    self,
    *,
    ARN: str,
    TagKeys: Sequence[str],
) -> EmptyResponseMetadataTypeDef:  # (1)
    ...
  1. See EmptyResponseMetadataTypeDef
Usage example with kwargs
kwargs: RemoveTagsRequestRequestTypeDef = {  # (1)
    "ARN": ...,
    "TagKeys": ...,
}

parent.remove_tags(**kwargs)
  1. See RemoveTagsRequestRequestTypeDef

start_elasticsearch_service_software_update

Schedules a service software update for an Amazon ES domain.

Type annotations and code completion for boto3.client("es").start_elasticsearch_service_software_update method. boto3 documentation

Method definition
def start_elasticsearch_service_software_update(
    self,
    *,
    DomainName: str,
) -> StartElasticsearchServiceSoftwareUpdateResponseTypeDef:  # (1)
    ...
  1. See StartElasticsearchServiceSoftwareUpdateResponseTypeDef
Usage example with kwargs
kwargs: StartElasticsearchServiceSoftwareUpdateRequestRequestTypeDef = {  # (1)
    "DomainName": ...,
}

parent.start_elasticsearch_service_software_update(**kwargs)
  1. See StartElasticsearchServiceSoftwareUpdateRequestRequestTypeDef

update_elasticsearch_domain_config

Modifies the cluster configuration of the specified Elasticsearch domain, setting as setting the instance type and the number of instances.

Type annotations and code completion for boto3.client("es").update_elasticsearch_domain_config method. boto3 documentation

Method definition
def update_elasticsearch_domain_config(
    self,
    *,
    DomainName: str,
    ElasticsearchClusterConfig: ElasticsearchClusterConfigTypeDef = ...,  # (1)
    EBSOptions: EBSOptionsTypeDef = ...,  # (2)
    SnapshotOptions: SnapshotOptionsTypeDef = ...,  # (3)
    VPCOptions: VPCOptionsTypeDef = ...,  # (4)
    CognitoOptions: CognitoOptionsTypeDef = ...,  # (5)
    AdvancedOptions: Mapping[str, str] = ...,
    AccessPolicies: str = ...,
    LogPublishingOptions: Mapping[LogTypeType, LogPublishingOptionTypeDef] = ...,  # (6)
    DomainEndpointOptions: DomainEndpointOptionsTypeDef = ...,  # (7)
    AdvancedSecurityOptions: AdvancedSecurityOptionsInputTypeDef = ...,  # (8)
    NodeToNodeEncryptionOptions: NodeToNodeEncryptionOptionsTypeDef = ...,  # (9)
    EncryptionAtRestOptions: EncryptionAtRestOptionsTypeDef = ...,  # (10)
    AutoTuneOptions: AutoTuneOptionsTypeDef = ...,  # (11)
    DryRun: bool = ...,
) -> UpdateElasticsearchDomainConfigResponseTypeDef:  # (12)
    ...
  1. See ElasticsearchClusterConfigTypeDef
  2. See EBSOptionsTypeDef
  3. See SnapshotOptionsTypeDef
  4. See VPCOptionsTypeDef
  5. See CognitoOptionsTypeDef
  6. See LogTypeType LogPublishingOptionTypeDef
  7. See DomainEndpointOptionsTypeDef
  8. See AdvancedSecurityOptionsInputTypeDef
  9. See NodeToNodeEncryptionOptionsTypeDef
  10. See EncryptionAtRestOptionsTypeDef
  11. See AutoTuneOptionsTypeDef
  12. See UpdateElasticsearchDomainConfigResponseTypeDef
Usage example with kwargs
kwargs: UpdateElasticsearchDomainConfigRequestRequestTypeDef = {  # (1)
    "DomainName": ...,
}

parent.update_elasticsearch_domain_config(**kwargs)
  1. See UpdateElasticsearchDomainConfigRequestRequestTypeDef

update_package

Updates a package for use with Amazon ES domains.

Type annotations and code completion for boto3.client("es").update_package method. boto3 documentation

Method definition
def update_package(
    self,
    *,
    PackageID: str,
    PackageSource: PackageSourceTypeDef,  # (1)
    PackageDescription: str = ...,
    CommitMessage: str = ...,
) -> UpdatePackageResponseTypeDef:  # (2)
    ...
  1. See PackageSourceTypeDef
  2. See UpdatePackageResponseTypeDef
Usage example with kwargs
kwargs: UpdatePackageRequestRequestTypeDef = {  # (1)
    "PackageID": ...,
    "PackageSource": ...,
}

parent.update_package(**kwargs)
  1. See UpdatePackageRequestRequestTypeDef

upgrade_elasticsearch_domain

Allows you to either upgrade your domain or perform an Upgrade eligibility check to a compatible Elasticsearch version.

Type annotations and code completion for boto3.client("es").upgrade_elasticsearch_domain method. boto3 documentation

Method definition
def upgrade_elasticsearch_domain(
    self,
    *,
    DomainName: str,
    TargetVersion: str,
    PerformCheckOnly: bool = ...,
) -> UpgradeElasticsearchDomainResponseTypeDef:  # (1)
    ...
  1. See UpgradeElasticsearchDomainResponseTypeDef
Usage example with kwargs
kwargs: UpgradeElasticsearchDomainRequestRequestTypeDef = {  # (1)
    "DomainName": ...,
    "TargetVersion": ...,
}

parent.upgrade_elasticsearch_domain(**kwargs)
  1. See UpgradeElasticsearchDomainRequestRequestTypeDef

get_paginator

Type annotations and code completion for boto3.client("es").get_paginator method with overloads.