Skip to content

OpenSearchServiceClient

Index > OpenSearchService > OpenSearchServiceClient

Auto-generated documentation for OpenSearchService type annotations stubs module mypy-boto3-opensearch.

OpenSearchServiceClient

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

Usage example
from boto3.session import Session
from mypy_boto3_opensearch.client import OpenSearchServiceClient

def get_opensearch_client() -> OpenSearchServiceClient:
    return Session().client("opensearch")

Exceptions

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

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

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_opensearch.client import Exceptions

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

Methods

accept_inbound_connection

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

Type annotations and code completion for boto3.client("opensearch").accept_inbound_connection method. boto3 documentation

Method definition
def accept_inbound_connection(
    self,
    *,
    ConnectionId: str,
) -> AcceptInboundConnectionResponseTypeDef:  # (1)
    ...
  1. See AcceptInboundConnectionResponseTypeDef
Usage example with kwargs
kwargs: AcceptInboundConnectionRequestRequestTypeDef = {  # (1)
    "ConnectionId": ...,
}

parent.accept_inbound_connection(**kwargs)
  1. See AcceptInboundConnectionRequestRequestTypeDef

add_tags

Attaches tags to an existing Amazon OpenSearch Service domain.

Type annotations and code completion for boto3.client("opensearch").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 OpenSearch Service domain.

Type annotations and code completion for boto3.client("opensearch").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

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("opensearch").authorize_vpc_endpoint_access method. boto3 documentation

Method definition
def authorize_vpc_endpoint_access(
    self,
    *,
    DomainName: str,
    Account: str,
) -> AuthorizeVpcEndpointAccessResponseTypeDef:  # (1)
    ...
  1. See AuthorizeVpcEndpointAccessResponseTypeDef
Usage example with kwargs
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("opensearch").can_paginate method. boto3 documentation

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

cancel_service_software_update

Cancels a scheduled service software update for an Amazon OpenSearch Service domain.

Type annotations and code completion for boto3.client("opensearch").cancel_service_software_update method. boto3 documentation

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

parent.cancel_service_software_update(**kwargs)
  1. See CancelServiceSoftwareUpdateRequestRequestTypeDef

close

Closes underlying endpoint connections.

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

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

create_domain

Creates an Amazon OpenSearch Service domain.

Type annotations and code completion for boto3.client("opensearch").create_domain method. boto3 documentation

Method definition
def create_domain(
    self,
    *,
    DomainName: str,
    EngineVersion: str = ...,
    ClusterConfig: ClusterConfigTypeDef = ...,  # (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)
    TagList: Sequence[TagTypeDef] = ...,  # (11)
    AutoTuneOptions: AutoTuneOptionsInputTypeDef = ...,  # (12)
) -> CreateDomainResponseTypeDef:  # (13)
    ...
  1. See ClusterConfigTypeDef
  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 TagTypeDef
  12. See AutoTuneOptionsInputTypeDef
  13. See CreateDomainResponseTypeDef
Usage example with kwargs
kwargs: CreateDomainRequestRequestTypeDef = {  # (1)
    "DomainName": ...,
}

parent.create_domain(**kwargs)
  1. See CreateDomainRequestRequestTypeDef

create_outbound_connection

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

Type annotations and code completion for boto3.client("opensearch").create_outbound_connection method. boto3 documentation

Method definition
def create_outbound_connection(
    self,
    *,
    LocalDomainInfo: DomainInformationContainerTypeDef,  # (1)
    RemoteDomainInfo: DomainInformationContainerTypeDef,  # (1)
    ConnectionAlias: str,
) -> CreateOutboundConnectionResponseTypeDef:  # (3)
    ...
  1. See DomainInformationContainerTypeDef
  2. See DomainInformationContainerTypeDef
  3. See CreateOutboundConnectionResponseTypeDef
Usage example with kwargs
kwargs: CreateOutboundConnectionRequestRequestTypeDef = {  # (1)
    "LocalDomainInfo": ...,
    "RemoteDomainInfo": ...,
    "ConnectionAlias": ...,
}

parent.create_outbound_connection(**kwargs)
  1. See CreateOutboundConnectionRequestRequestTypeDef

create_package

Creates a package for use with Amazon OpenSearch Service domains.

Type annotations and code completion for boto3.client("opensearch").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

create_vpc_endpoint

Creates an Amazon OpenSearch Service-managed VPC endpoint.

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

Method definition
def create_vpc_endpoint(
    self,
    *,
    DomainArn: str,
    VpcOptions: VPCOptionsTypeDef,  # (1)
    ClientToken: str = ...,
) -> CreateVpcEndpointResponseTypeDef:  # (2)
    ...
  1. See VPCOptionsTypeDef
  2. See CreateVpcEndpointResponseTypeDef
Usage example with kwargs
kwargs: CreateVpcEndpointRequestRequestTypeDef = {  # (1)
    "DomainArn": ...,
    "VpcOptions": ...,
}

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

delete_domain

Deletes an Amazon OpenSearch Service domain and all of its data.

Type annotations and code completion for boto3.client("opensearch").delete_domain method. boto3 documentation

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

parent.delete_domain(**kwargs)
  1. See DeleteDomainRequestRequestTypeDef

delete_inbound_connection

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

Type annotations and code completion for boto3.client("opensearch").delete_inbound_connection method. boto3 documentation

Method definition
def delete_inbound_connection(
    self,
    *,
    ConnectionId: str,
) -> DeleteInboundConnectionResponseTypeDef:  # (1)
    ...
  1. See DeleteInboundConnectionResponseTypeDef
Usage example with kwargs
kwargs: DeleteInboundConnectionRequestRequestTypeDef = {  # (1)
    "ConnectionId": ...,
}

parent.delete_inbound_connection(**kwargs)
  1. See DeleteInboundConnectionRequestRequestTypeDef

delete_outbound_connection

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

Type annotations and code completion for boto3.client("opensearch").delete_outbound_connection method. boto3 documentation

Method definition
def delete_outbound_connection(
    self,
    *,
    ConnectionId: str,
) -> DeleteOutboundConnectionResponseTypeDef:  # (1)
    ...
  1. See DeleteOutboundConnectionResponseTypeDef
Usage example with kwargs
kwargs: DeleteOutboundConnectionRequestRequestTypeDef = {  # (1)
    "ConnectionId": ...,
}

parent.delete_outbound_connection(**kwargs)
  1. See DeleteOutboundConnectionRequestRequestTypeDef

delete_package

Deletes an Amazon OpenSearch Service package.

Type annotations and code completion for boto3.client("opensearch").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

delete_vpc_endpoint

Deletes an Amazon OpenSearch Service-managed interface VPC endpoint.

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

Method definition
def delete_vpc_endpoint(
    self,
    *,
    VpcEndpointId: str,
) -> DeleteVpcEndpointResponseTypeDef:  # (1)
    ...
  1. See DeleteVpcEndpointResponseTypeDef
Usage example with kwargs
kwargs: DeleteVpcEndpointRequestRequestTypeDef = {  # (1)
    "VpcEndpointId": ...,
}

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

describe_domain

Describes the domain configuration for the specified Amazon OpenSearch Service domain, including the domain ID, domain service endpoint, and domain ARN.

Type annotations and code completion for boto3.client("opensearch").describe_domain method. boto3 documentation

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

parent.describe_domain(**kwargs)
  1. See DescribeDomainRequestRequestTypeDef

describe_domain_auto_tunes

Returns the list of optimizations that Auto-Tune has made to an Amazon OpenSearch Service domain.

Type annotations and code completion for boto3.client("opensearch").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 an Amazon OpenSearch Service domain.

Type annotations and code completion for boto3.client("opensearch").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_domain_config

Returns the configuration of an Amazon OpenSearch Service domain.

Type annotations and code completion for boto3.client("opensearch").describe_domain_config method. boto3 documentation

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

parent.describe_domain_config(**kwargs)
  1. See DescribeDomainConfigRequestRequestTypeDef

describe_domains

Returns domain configuration information about the specified Amazon OpenSearch Service domains.

Type annotations and code completion for boto3.client("opensearch").describe_domains method. boto3 documentation

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

parent.describe_domains(**kwargs)
  1. See DescribeDomainsRequestRequestTypeDef

describe_dry_run_progress

Describes the progress of a pre-update dry run analysis on an Amazon OpenSearch Service domain.

Type annotations and code completion for boto3.client("opensearch").describe_dry_run_progress method. boto3 documentation

Method definition
def describe_dry_run_progress(
    self,
    *,
    DomainName: str,
    DryRunId: str = ...,
    LoadDryRunConfig: bool = ...,
) -> DescribeDryRunProgressResponseTypeDef:  # (1)
    ...
  1. See DescribeDryRunProgressResponseTypeDef
Usage example with kwargs
kwargs: DescribeDryRunProgressRequestRequestTypeDef = {  # (1)
    "DomainName": ...,
}

parent.describe_dry_run_progress(**kwargs)
  1. See DescribeDryRunProgressRequestRequestTypeDef

describe_inbound_connections

Lists all the inbound cross-cluster search connections for a destination (remote) Amazon OpenSearch Service domain.

Type annotations and code completion for boto3.client("opensearch").describe_inbound_connections method. boto3 documentation

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

parent.describe_inbound_connections(**kwargs)
  1. See DescribeInboundConnectionsRequestRequestTypeDef

describe_instance_type_limits

Describes the instance count, storage, and master node limits for a given OpenSearch or Elasticsearch version and instance type.

Type annotations and code completion for boto3.client("opensearch").describe_instance_type_limits method. boto3 documentation

Method definition
def describe_instance_type_limits(
    self,
    *,
    InstanceType: OpenSearchPartitionInstanceTypeType,  # (1)
    EngineVersion: str,
    DomainName: str = ...,
) -> DescribeInstanceTypeLimitsResponseTypeDef:  # (2)
    ...
  1. See OpenSearchPartitionInstanceTypeType
  2. See DescribeInstanceTypeLimitsResponseTypeDef
Usage example with kwargs
kwargs: DescribeInstanceTypeLimitsRequestRequestTypeDef = {  # (1)
    "InstanceType": ...,
    "EngineVersion": ...,
}

parent.describe_instance_type_limits(**kwargs)
  1. See DescribeInstanceTypeLimitsRequestRequestTypeDef

describe_outbound_connections

Lists all the outbound cross-cluster connections for a local (source) Amazon OpenSearch Service domain.

Type annotations and code completion for boto3.client("opensearch").describe_outbound_connections method. boto3 documentation

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

parent.describe_outbound_connections(**kwargs)
  1. See DescribeOutboundConnectionsRequestRequestTypeDef

describe_packages

Describes all packages available to OpenSearch Service.

Type annotations and code completion for boto3.client("opensearch").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_instance_offerings

Describes the available Amazon OpenSearch Service Reserved Instance offerings for a given Region.

Type annotations and code completion for boto3.client("opensearch").describe_reserved_instance_offerings method. boto3 documentation

Method definition
def describe_reserved_instance_offerings(
    self,
    *,
    ReservedInstanceOfferingId: str = ...,
    MaxResults: int = ...,
    NextToken: str = ...,
) -> DescribeReservedInstanceOfferingsResponseTypeDef:  # (1)
    ...
  1. See DescribeReservedInstanceOfferingsResponseTypeDef
Usage example with kwargs
kwargs: DescribeReservedInstanceOfferingsRequestRequestTypeDef = {  # (1)
    "ReservedInstanceOfferingId": ...,
}

parent.describe_reserved_instance_offerings(**kwargs)
  1. See DescribeReservedInstanceOfferingsRequestRequestTypeDef

describe_reserved_instances

Describes the Amazon OpenSearch Service instances that you have reserved in a given Region.

Type annotations and code completion for boto3.client("opensearch").describe_reserved_instances method. boto3 documentation

Method definition
def describe_reserved_instances(
    self,
    *,
    ReservedInstanceId: str = ...,
    MaxResults: int = ...,
    NextToken: str = ...,
) -> DescribeReservedInstancesResponseTypeDef:  # (1)
    ...
  1. See DescribeReservedInstancesResponseTypeDef
Usage example with kwargs
kwargs: DescribeReservedInstancesRequestRequestTypeDef = {  # (1)
    "ReservedInstanceId": ...,
}

parent.describe_reserved_instances(**kwargs)
  1. See DescribeReservedInstancesRequestRequestTypeDef

describe_vpc_endpoints

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

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

Method definition
def describe_vpc_endpoints(
    self,
    *,
    VpcEndpointIds: Sequence[str],
) -> DescribeVpcEndpointsResponseTypeDef:  # (1)
    ...
  1. See DescribeVpcEndpointsResponseTypeDef
Usage example with kwargs
kwargs: DescribeVpcEndpointsRequestRequestTypeDef = {  # (1)
    "VpcEndpointIds": ...,
}

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

dissociate_package

Removes a package from the specified Amazon OpenSearch Service domain.

Type annotations and code completion for boto3.client("opensearch").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("opensearch").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_versions

Returns a map of OpenSearch or Elasticsearch versions and the versions you can upgrade them to.

Type annotations and code completion for boto3.client("opensearch").get_compatible_versions method. boto3 documentation

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

parent.get_compatible_versions(**kwargs)
  1. See GetCompatibleVersionsRequestRequestTypeDef

get_package_version_history

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

Type annotations and code completion for boto3.client("opensearch").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 performed on an Amazon OpenSearch Service domain.

Type annotations and code completion for boto3.client("opensearch").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

Returns the most recent status of the last upgrade or upgrade eligibility check performed on an Amazon OpenSearch Service domain.

Type annotations and code completion for boto3.client("opensearch").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 names of all Amazon OpenSearch Service domains owned by the current user in the active Region.

Type annotations and code completion for boto3.client("opensearch").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 OpenSearch Service domains associated with a given package.

Type annotations and code completion for boto3.client("opensearch").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_instance_type_details

Lists all instance types and available features for a given OpenSearch or Elasticsearch version.

Type annotations and code completion for boto3.client("opensearch").list_instance_type_details method. boto3 documentation

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

parent.list_instance_type_details(**kwargs)
  1. See ListInstanceTypeDetailsRequestRequestTypeDef

list_packages_for_domain

Lists all packages associated with an Amazon OpenSearch Service domain.

Type annotations and code completion for boto3.client("opensearch").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 resource tags for an Amazon OpenSearch Service domain.

Type annotations and code completion for boto3.client("opensearch").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

list_versions

Lists all versions of OpenSearch and Elasticsearch that Amazon OpenSearch Service supports.

Type annotations and code completion for boto3.client("opensearch").list_versions method. boto3 documentation

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

parent.list_versions(**kwargs)
  1. See ListVersionsRequestRequestTypeDef

list_vpc_endpoint_access

Retrieves information about each Amazon Web Services 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("opensearch").list_vpc_endpoint_access method. boto3 documentation

Method definition
def list_vpc_endpoint_access(
    self,
    *,
    DomainName: str,
    NextToken: str = ...,
) -> ListVpcEndpointAccessResponseTypeDef:  # (1)
    ...
  1. See ListVpcEndpointAccessResponseTypeDef
Usage example with kwargs
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 Amazon Web Services account and Region.

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

Method definition
def list_vpc_endpoints(
    self,
    *,
    NextToken: str = ...,
) -> ListVpcEndpointsResponseTypeDef:  # (1)
    ...
  1. See ListVpcEndpointsResponseTypeDef
Usage example with kwargs
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("opensearch").list_vpc_endpoints_for_domain method. boto3 documentation

Method definition
def list_vpc_endpoints_for_domain(
    self,
    *,
    DomainName: str,
    NextToken: str = ...,
) -> ListVpcEndpointsForDomainResponseTypeDef:  # (1)
    ...
  1. See ListVpcEndpointsForDomainResponseTypeDef
Usage example with kwargs
kwargs: ListVpcEndpointsForDomainRequestRequestTypeDef = {  # (1)
    "DomainName": ...,
}

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

purchase_reserved_instance_offering

Allows you to purchase Amazon OpenSearch Service Reserved Instances.

Type annotations and code completion for boto3.client("opensearch").purchase_reserved_instance_offering method. boto3 documentation

Method definition
def purchase_reserved_instance_offering(
    self,
    *,
    ReservedInstanceOfferingId: str,
    ReservationName: str,
    InstanceCount: int = ...,
) -> PurchaseReservedInstanceOfferingResponseTypeDef:  # (1)
    ...
  1. See PurchaseReservedInstanceOfferingResponseTypeDef
Usage example with kwargs
kwargs: PurchaseReservedInstanceOfferingRequestRequestTypeDef = {  # (1)
    "ReservedInstanceOfferingId": ...,
    "ReservationName": ...,
}

parent.purchase_reserved_instance_offering(**kwargs)
  1. See PurchaseReservedInstanceOfferingRequestRequestTypeDef

reject_inbound_connection

Allows the remote Amazon OpenSearch Service domain owner to reject an inbound cross-cluster connection request.

Type annotations and code completion for boto3.client("opensearch").reject_inbound_connection method. boto3 documentation

Method definition
def reject_inbound_connection(
    self,
    *,
    ConnectionId: str,
) -> RejectInboundConnectionResponseTypeDef:  # (1)
    ...
  1. See RejectInboundConnectionResponseTypeDef
Usage example with kwargs
kwargs: RejectInboundConnectionRequestRequestTypeDef = {  # (1)
    "ConnectionId": ...,
}

parent.reject_inbound_connection(**kwargs)
  1. See RejectInboundConnectionRequestRequestTypeDef

remove_tags

Removes the specified set of tags from an Amazon OpenSearch Service domain.

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