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

# ElasticsearchServiceClient 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.

# Exceptions.exceptions usage example

client = boto3.client("es")

try:
    do_something(client)
except (
    client.exceptions.AccessDeniedException,
    client.exceptions.BaseException,
    client.exceptions.ClientError,
    client.exceptions.ConflictException,
    client.exceptions.DisabledOperationException,
    client.exceptions.InternalException,
    client.exceptions.InvalidPaginationTokenException,
    client.exceptions.InvalidTypeException,
    client.exceptions.LimitExceededException,
    client.exceptions.ResourceAlreadyExistsException,
    client.exceptions.ResourceNotFoundException,
    client.exceptions.ValidationException,
) as e:
    print(e)
# Exceptions.exceptions 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

# accept_inbound_cross_cluster_search_connection method definition

def accept_inbound_cross_cluster_search_connection(
    self,
    *,
    CrossClusterSearchConnectionId: str,
) -> AcceptInboundCrossClusterSearchConnectionResponseTypeDef:  # (1)
    ...
  1. See AcceptInboundCrossClusterSearchConnectionResponseTypeDef 
# accept_inbound_cross_cluster_search_connection method usage example with argument unpacking

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

# add_tags method definition

def add_tags(
    self,
    *,
    ARN: str,
    TagList: Sequence[TagTypeDef],  # (1)
) -> EmptyResponseMetadataTypeDef:  # (2)
    ...
  1. See TagTypeDef
  2. See EmptyResponseMetadataTypeDef 
# add_tags method usage example with argument unpacking

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

# associate_package method definition

def associate_package(
    self,
    *,
    PackageID: str,
    DomainName: str,
) -> AssociatePackageResponseTypeDef:  # (1)
    ...
  1. See AssociatePackageResponseTypeDef 
# associate_package method usage example with argument unpacking

kwargs: AssociatePackageRequestRequestTypeDef = {  # (1)
    "PackageID": ...,
    "DomainName": ...,
}

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

authorize_vpc_endpoint_access#

Provides access to an Amazon OpenSearch Service domain through the use of an interface VPC endpoint.

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

# authorize_vpc_endpoint_access method definition

def authorize_vpc_endpoint_access(
    self,
    *,
    DomainName: str,
    Account: str,
) -> AuthorizeVpcEndpointAccessResponseTypeDef:  # (1)
    ...
  1. See AuthorizeVpcEndpointAccessResponseTypeDef 
# authorize_vpc_endpoint_access method usage example with argument unpacking

kwargs: AuthorizeVpcEndpointAccessRequestRequestTypeDef = {  # (1)
    "DomainName": ...,
    "Account": ...,
}

parent.authorize_vpc_endpoint_access(**kwargs)
  1. See AuthorizeVpcEndpointAccessRequestRequestTypeDef

can_paginate#

Check if an operation can be paginated.

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

# can_paginate 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

# cancel_elasticsearch_service_software_update method definition

def cancel_elasticsearch_service_software_update(
    self,
    *,
    DomainName: str,
) -> CancelElasticsearchServiceSoftwareUpdateResponseTypeDef:  # (1)
    ...
  1. See CancelElasticsearchServiceSoftwareUpdateResponseTypeDef 
# cancel_elasticsearch_service_software_update method usage example with argument unpacking

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

# close 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

# create_elasticsearch_domain 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 
# create_elasticsearch_domain method usage example with argument unpacking

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

# create_outbound_cross_cluster_search_connection 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 
# create_outbound_cross_cluster_search_connection method usage example with argument unpacking

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

# create_package 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 
# create_package method usage example with argument unpacking

kwargs: CreatePackageRequestRequestTypeDef = {  # (1)
    "PackageName": ...,
    "PackageType": ...,
    "PackageSource": ...,
}

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

create_vpc_endpoint#

Creates an Amazon OpenSearch Service-managed VPC endpoint.

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

# create_vpc_endpoint method definition

def create_vpc_endpoint(
    self,
    *,
    DomainArn: str,
    VpcOptions: VPCOptionsTypeDef,  # (1)
    ClientToken: str = ...,
) -> CreateVpcEndpointResponseTypeDef:  # (2)
    ...
  1. See VPCOptionsTypeDef
  2. See CreateVpcEndpointResponseTypeDef 
# create_vpc_endpoint method usage example with argument unpacking

kwargs: CreateVpcEndpointRequestRequestTypeDef = {  # (1)
    "DomainArn": ...,
    "VpcOptions": ...,
}

parent.create_vpc_endpoint(**kwargs)
  1. See CreateVpcEndpointRequestRequestTypeDef

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

# delete_elasticsearch_domain method definition

def delete_elasticsearch_domain(
    self,
    *,
    DomainName: str,
) -> DeleteElasticsearchDomainResponseTypeDef:  # (1)
    ...
  1. See DeleteElasticsearchDomainResponseTypeDef 
# delete_elasticsearch_domain method usage example with argument unpacking

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

# delete_elasticsearch_service_role 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

# delete_inbound_cross_cluster_search_connection method definition

def delete_inbound_cross_cluster_search_connection(
    self,
    *,
    CrossClusterSearchConnectionId: str,
) -> DeleteInboundCrossClusterSearchConnectionResponseTypeDef:  # (1)
    ...
  1. See DeleteInboundCrossClusterSearchConnectionResponseTypeDef 
# delete_inbound_cross_cluster_search_connection method usage example with argument unpacking

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

# delete_outbound_cross_cluster_search_connection method definition

def delete_outbound_cross_cluster_search_connection(
    self,
    *,
    CrossClusterSearchConnectionId: str,
) -> DeleteOutboundCrossClusterSearchConnectionResponseTypeDef:  # (1)
    ...
  1. See DeleteOutboundCrossClusterSearchConnectionResponseTypeDef 
# delete_outbound_cross_cluster_search_connection method usage example with argument unpacking

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

# delete_package method definition

def delete_package(
    self,
    *,
    PackageID: str,
) -> DeletePackageResponseTypeDef:  # (1)
    ...
  1. See DeletePackageResponseTypeDef 
# delete_package method usage example with argument unpacking

kwargs: DeletePackageRequestRequestTypeDef = {  # (1)
    "PackageID": ...,
}

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

delete_vpc_endpoint#

Deletes an Amazon OpenSearch Service-managed interface VPC endpoint.

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

# delete_vpc_endpoint method definition

def delete_vpc_endpoint(
    self,
    *,
    VpcEndpointId: str,
) -> DeleteVpcEndpointResponseTypeDef:  # (1)
    ...
  1. See DeleteVpcEndpointResponseTypeDef 
# delete_vpc_endpoint method usage example with argument unpacking

kwargs: DeleteVpcEndpointRequestRequestTypeDef = {  # (1)
    "VpcEndpointId": ...,
}

parent.delete_vpc_endpoint(**kwargs)
  1. See DeleteVpcEndpointRequestRequestTypeDef

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

# describe_domain_auto_tunes method definition

def describe_domain_auto_tunes(
    self,
    *,
    DomainName: str,
    MaxResults: int = ...,
    NextToken: str = ...,
) -> DescribeDomainAutoTunesResponseTypeDef:  # (1)
    ...
  1. See DescribeDomainAutoTunesResponseTypeDef 
# describe_domain_auto_tunes method usage example with argument unpacking

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

# describe_domain_change_progress method definition

def describe_domain_change_progress(
    self,
    *,
    DomainName: str,
    ChangeId: str = ...,
) -> DescribeDomainChangeProgressResponseTypeDef:  # (1)
    ...
  1. See DescribeDomainChangeProgressResponseTypeDef 
# describe_domain_change_progress method usage example with argument unpacking

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

# describe_elasticsearch_domain method definition

def describe_elasticsearch_domain(
    self,
    *,
    DomainName: str,
) -> DescribeElasticsearchDomainResponseTypeDef:  # (1)
    ...
  1. See DescribeElasticsearchDomainResponseTypeDef 
# describe_elasticsearch_domain method usage example with argument unpacking

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

# describe_elasticsearch_domain_config method definition

def describe_elasticsearch_domain_config(
    self,
    *,
    DomainName: str,
) -> DescribeElasticsearchDomainConfigResponseTypeDef:  # (1)
    ...
  1. See DescribeElasticsearchDomainConfigResponseTypeDef 
# describe_elasticsearch_domain_config method usage example with argument unpacking

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

# describe_elasticsearch_domains method definition

def describe_elasticsearch_domains(
    self,
    *,
    DomainNames: Sequence[str],
) -> DescribeElasticsearchDomainsResponseTypeDef:  # (1)
    ...
  1. See DescribeElasticsearchDomainsResponseTypeDef 
# describe_elasticsearch_domains method usage example with argument unpacking

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

# describe_elasticsearch_instance_type_limits method definition

def describe_elasticsearch_instance_type_limits(
    self,
    *,
    InstanceType: ESPartitionInstanceTypeType,  # (1)
    ElasticsearchVersion: str,
    DomainName: str = ...,
) -> DescribeElasticsearchInstanceTypeLimitsResponseTypeDef:  # (2)
    ...
  1. See ESPartitionInstanceTypeType
  2. See DescribeElasticsearchInstanceTypeLimitsResponseTypeDef 
# describe_elasticsearch_instance_type_limits method usage example with argument unpacking

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

# describe_inbound_cross_cluster_search_connections 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 
# describe_inbound_cross_cluster_search_connections method usage example with argument unpacking

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

# describe_outbound_cross_cluster_search_connections 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 
# describe_outbound_cross_cluster_search_connections method usage example with argument unpacking

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

# describe_packages method definition

def describe_packages(
    self,
    *,
    Filters: Sequence[DescribePackagesFilterTypeDef] = ...,  # (1)
    MaxResults: int = ...,
    NextToken: str = ...,
) -> DescribePackagesResponseTypeDef:  # (2)
    ...
  1. See DescribePackagesFilterTypeDef
  2. See DescribePackagesResponseTypeDef 
# describe_packages method usage example with argument unpacking

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

# describe_reserved_elasticsearch_instance_offerings method definition

def describe_reserved_elasticsearch_instance_offerings(
    self,
    *,
    ReservedElasticsearchInstanceOfferingId: str = ...,
    MaxResults: int = ...,
    NextToken: str = ...,
) -> DescribeReservedElasticsearchInstanceOfferingsResponseTypeDef:  # (1)
    ...
  1. See DescribeReservedElasticsearchInstanceOfferingsResponseTypeDef 
# describe_reserved_elasticsearch_instance_offerings method usage example with argument unpacking

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

# describe_reserved_elasticsearch_instances method definition

def describe_reserved_elasticsearch_instances(
    self,
    *,
    ReservedElasticsearchInstanceId: str = ...,
    MaxResults: int = ...,
    NextToken: str = ...,
) -> DescribeReservedElasticsearchInstancesResponseTypeDef:  # (1)
    ...
  1. See DescribeReservedElasticsearchInstancesResponseTypeDef 
# describe_reserved_elasticsearch_instances method usage example with argument unpacking

kwargs: DescribeReservedElasticsearchInstancesRequestRequestTypeDef = {  # (1)
    "ReservedElasticsearchInstanceId": ...,
}

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

describe_vpc_endpoints#

Describes one or more Amazon OpenSearch Service-managed VPC endpoints.

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

# describe_vpc_endpoints method definition

def describe_vpc_endpoints(
    self,
    *,
    VpcEndpointIds: Sequence[str],
) -> DescribeVpcEndpointsResponseTypeDef:  # (1)
    ...
  1. See DescribeVpcEndpointsResponseTypeDef 
# describe_vpc_endpoints method usage example with argument unpacking

kwargs: DescribeVpcEndpointsRequestRequestTypeDef = {  # (1)
    "VpcEndpointIds": ...,
}

parent.describe_vpc_endpoints(**kwargs)
  1. See DescribeVpcEndpointsRequestRequestTypeDef

dissociate_package#

Dissociates a package from the Amazon ES domain.

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

# dissociate_package method definition

def dissociate_package(
    self,
    *,
    PackageID: str,
    DomainName: str,
) -> DissociatePackageResponseTypeDef:  # (1)
    ...
  1. See DissociatePackageResponseTypeDef 
# dissociate_package method usage example with argument unpacking

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

# generate_presigned_url 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

# get_compatible_elasticsearch_versions method definition

def get_compatible_elasticsearch_versions(
    self,
    *,
    DomainName: str = ...,
) -> GetCompatibleElasticsearchVersionsResponseTypeDef:  # (1)
    ...
  1. See GetCompatibleElasticsearchVersionsResponseTypeDef 
# get_compatible_elasticsearch_versions method usage example with argument unpacking

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

# get_package_version_history method definition

def get_package_version_history(
    self,
    *,
    PackageID: str,
    MaxResults: int = ...,
    NextToken: str = ...,
) -> GetPackageVersionHistoryResponseTypeDef:  # (1)
    ...
  1. See GetPackageVersionHistoryResponseTypeDef 
# get_package_version_history method usage example with argument unpacking

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

# get_upgrade_history method definition

def get_upgrade_history(
    self,
    *,
    DomainName: str,
    MaxResults: int = ...,
    NextToken: str = ...,
) -> GetUpgradeHistoryResponseTypeDef:  # (1)
    ...
  1. See GetUpgradeHistoryResponseTypeDef 
# get_upgrade_history method usage example with argument unpacking

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

# get_upgrade_status method definition

def get_upgrade_status(
    self,
    *,
    DomainName: str,
) -> GetUpgradeStatusResponseTypeDef:  # (1)
    ...
  1. See GetUpgradeStatusResponseTypeDef 
# get_upgrade_status method usage example with argument unpacking

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

# list_domain_names method definition

def list_domain_names(
    self,
    *,
    EngineType: EngineTypeType = ...,  # (1)
) -> ListDomainNamesResponseTypeDef:  # (2)
    ...
  1. See EngineTypeType
  2. See ListDomainNamesResponseTypeDef 
# list_domain_names method usage example with argument unpacking

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

# list_domains_for_package method definition

def list_domains_for_package(
    self,
    *,
    PackageID: str,
    MaxResults: int = ...,
    NextToken: str = ...,
) -> ListDomainsForPackageResponseTypeDef:  # (1)
    ...
  1. See ListDomainsForPackageResponseTypeDef 
# list_domains_for_package method usage example with argument unpacking

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

# list_elasticsearch_instance_types method definition

def list_elasticsearch_instance_types(
    self,
    *,
    ElasticsearchVersion: str,
    DomainName: str = ...,
    MaxResults: int = ...,
    NextToken: str = ...,
) -> ListElasticsearchInstanceTypesResponseTypeDef:  # (1)
    ...
  1. See ListElasticsearchInstanceTypesResponseTypeDef 
# list_elasticsearch_instance_types method usage example with argument unpacking

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

# list_elasticsearch_versions method definition

def list_elasticsearch_versions(
    self,
    *,
    MaxResults: int = ...,
    NextToken: str = ...,
) -> ListElasticsearchVersionsResponseTypeDef:  # (1)
    ...
  1. See ListElasticsearchVersionsResponseTypeDef 
# list_elasticsearch_versions method usage example with argument unpacking

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

# list_packages_for_domain method definition

def list_packages_for_domain(
    self,
    *,
    DomainName: str,
    MaxResults: int = ...,
    NextToken: str = ...,
) -> ListPackagesForDomainResponseTypeDef:  # (1)
    ...
  1. See ListPackagesForDomainResponseTypeDef 
# list_packages_for_domain method usage example with argument unpacking

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

# list_tags method definition

def list_tags(
    self,
    *,
    ARN: str,
) -> ListTagsResponseTypeDef:  # (1)
    ...
  1. See ListTagsResponseTypeDef 
# list_tags method usage example with argument unpacking

kwargs: ListTagsRequestRequestTypeDef = {  # (1)
    "ARN": ...,
}

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

list_vpc_endpoint_access#

Retrieves information about each principal that is allowed to access a given Amazon OpenSearch Service domain through the use of an interface VPC endpoint.

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

# list_vpc_endpoint_access method definition

def list_vpc_endpoint_access(
    self,
    *,
    DomainName: str,
    NextToken: str = ...,
) -> ListVpcEndpointAccessResponseTypeDef:  # (1)
    ...
  1. See ListVpcEndpointAccessResponseTypeDef 
# list_vpc_endpoint_access method usage example with argument unpacking

kwargs: ListVpcEndpointAccessRequestRequestTypeDef = {  # (1)
    "DomainName": ...,
}

parent.list_vpc_endpoint_access(**kwargs)
  1. See ListVpcEndpointAccessRequestRequestTypeDef

list_vpc_endpoints#

Retrieves all Amazon OpenSearch Service-managed VPC endpoints in the current account and Region.

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

# list_vpc_endpoints method definition

def list_vpc_endpoints(
    self,
    *,
    NextToken: str = ...,
) -> ListVpcEndpointsResponseTypeDef:  # (1)
    ...
  1. See ListVpcEndpointsResponseTypeDef 
# list_vpc_endpoints method usage example with argument unpacking

kwargs: ListVpcEndpointsRequestRequestTypeDef = {  # (1)
    "NextToken": ...,
}

parent.list_vpc_endpoints(**kwargs)
  1. See ListVpcEndpointsRequestRequestTypeDef

list_vpc_endpoints_for_domain#

Retrieves all Amazon OpenSearch Service-managed VPC endpoints associated with a particular domain.

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

# list_vpc_endpoints_for_domain method definition

def list_vpc_endpoints_for_domain(
    self,
    *,
    DomainName: str,
    NextToken: str = ...,
) -> ListVpcEndpointsForDomainResponseTypeDef:  # (1)
    ...
  1. See ListVpcEndpointsForDomainResponseTypeDef 
# list_vpc_endpoints_for_domain method usage example with argument unpacking

kwargs: ListVpcEndpointsForDomainRequestRequestTypeDef = {  # (1)
    "DomainName": ...,
}

parent.list_vpc_endpoints_for_domain(**kwargs)
  1. See ListVpcEndpointsForDomainRequestRequestTypeDef

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

# purchase_reserved_elasticsearch_instance_offering method definition

def purchase_reserved_elasticsearch_instance_offering(
    self,
    *,
    ReservedElasticsearchInstanceOfferingId: str,
    ReservationName: str,
    InstanceCount: int = ...,
) -> PurchaseReservedElasticsearchInstanceOfferingResponseTypeDef:  # (1)
    ...
  1. See PurchaseReservedElasticsearchInstanceOfferingResponseTypeDef 
# purchase_reserved_elasticsearch_instance_offering method usage example with argument unpacking

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

# reject_inbound_cross_cluster_search_connection method definition

def reject_inbound_cross_cluster_search_connection(
    self,
    *,
    CrossClusterSearchConnectionId: str,
) -> RejectInboundCrossClusterSearchConnectionResponseTypeDef:  # (1)
    ...
  1. See RejectInboundCrossClusterSearchConnectionResponseTypeDef 
# reject_inbound_cross_cluster_search_connection method usage example with argument unpacking

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

# remove_tags method definition

def remove_tags(
    self,
    *,
    ARN: str,
    TagKeys: Sequence[str],
) -> EmptyResponseMetadataTypeDef:  # (1)
    ...
  1. See EmptyResponseMetadataTypeDef 
# remove_tags method usage example with argument unpacking

kwargs: RemoveTagsRequestRequestTypeDef = {  # (1)
    "ARN": ...,
    "TagKeys": ...,
}

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

revoke_vpc_endpoint_access#

Revokes access to an Amazon OpenSearch Service domain that was provided through an interface VPC endpoint.

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

# revoke_vpc_endpoint_access method definition

def revoke_vpc_endpoint_access(
    self,
    *,
    DomainName: str,
    Account: str,
) -> Dict[str, Any]:
    ...
# revoke_vpc_endpoint_access method usage example with argument unpacking

kwargs: RevokeVpcEndpointAccessRequestRequestTypeDef = {  # (1)
    "DomainName": ...,
    "Account": ...,
}

parent.revoke_vpc_endpoint_access(**kwargs)
  1. See RevokeVpcEndpointAccessRequestRequestTypeDef

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

# start_elasticsearch_service_software_update method definition

def start_elasticsearch_service_software_update(
    self,
    *,
    DomainName: str,
) -> StartElasticsearchServiceSoftwareUpdateResponseTypeDef:  # (1)
    ...
  1. See StartElasticsearchServiceSoftwareUpdateResponseTypeDef 
# start_elasticsearch_service_software_update method usage example with argument unpacking

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

# update_elasticsearch_domain_config 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 
# update_elasticsearch_domain_config method usage example with argument unpacking

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

# update_package method definition

def update_package(
    self,
    *,
    PackageID: str,
    PackageSource: PackageSourceTypeDef,  # (1)
    PackageDescription: str = ...,
    CommitMessage: str = ...,
) -> UpdatePackageResponseTypeDef:  # (2)
    ...
  1. See PackageSourceTypeDef
  2. See UpdatePackageResponseTypeDef 
# update_package method usage example with argument unpacking

kwargs: UpdatePackageRequestRequestTypeDef = {  # (1)
    "PackageID": ...,
    "PackageSource": ...,
}

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

update_vpc_endpoint#

Modifies an Amazon OpenSearch Service-managed interface VPC endpoint.

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

# update_vpc_endpoint method definition

def update_vpc_endpoint(
    self,
    *,
    VpcEndpointId: str,
    VpcOptions: VPCOptionsTypeDef,  # (1)
) -> UpdateVpcEndpointResponseTypeDef:  # (2)
    ...
  1. See VPCOptionsTypeDef
  2. See UpdateVpcEndpointResponseTypeDef 
# update_vpc_endpoint method usage example with argument unpacking

kwargs: UpdateVpcEndpointRequestRequestTypeDef = {  # (1)
    "VpcEndpointId": ...,
    "VpcOptions": ...,
}

parent.update_vpc_endpoint(**kwargs)
  1. See UpdateVpcEndpointRequestRequestTypeDef

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

# upgrade_elasticsearch_domain method definition

def upgrade_elasticsearch_domain(
    self,
    *,
    DomainName: str,
    TargetVersion: str,
    PerformCheckOnly: bool = ...,
) -> UpgradeElasticsearchDomainResponseTypeDef:  # (1)
    ...
  1. See UpgradeElasticsearchDomainResponseTypeDef 
# upgrade_elasticsearch_domain method usage example with argument unpacking

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.