Skip to content

OpenSearchServiceClient

Index > OpenSearchService > OpenSearchServiceClient

Auto-generated documentation for OpenSearchService type annotations stubs module types-aiobotocore-opensearch.

OpenSearchServiceClient

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

Usage example
from aioboto3.session import Session
from types_aiobotocore_opensearch.client import OpenSearchServiceClient

session = Session()
async with session.client("opensearch") as client:
    client: OpenSearchServiceClient

Exceptions

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

Usage example
async with session.client("opensearch") as client:
    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 types_aiobotocore_opensearch.client import Exceptions

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

Methods

accept_inbound_connection

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

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

Method definition
await 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 domain.

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

Method definition
await 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 session.client("opensearch").associate_package method. boto3 documentation

Method definition
await 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 session.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 session.client("opensearch").cancel_service_software_update method. boto3 documentation

Method definition
await 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 session.client("opensearch").close method. boto3 documentation

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

create_domain

Creates a new Amazon OpenSearch Service domain.

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

Method definition
await 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 connection from a local OpenSearch domain to a remote OpenSearch domain.

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

Method definition
await 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

Create a package for use with Amazon OpenSearch Service domains.

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

Method definition
await 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_domain

Permanently deletes the specified domain and all of its data.

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

Method definition
await 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 remote domain owner to delete an existing inbound cross-cluster connection.

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

Method definition
await 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 local domain owner to delete an existing outbound cross-cluster connection.

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

Method definition
await 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 the package.

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

Method definition
await 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

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

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

Method definition
await 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

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

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

Method definition
await 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 session.client("opensearch").describe_domain_change_progress method. boto3 documentation

Method definition
await 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

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

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

Method definition
await 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 domains, including the domain ID, domain endpoint, and domain ARN.

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

Method definition
await 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_inbound_connections

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

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

Method definition
await 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

Describe the limits for a given instance type and OpenSearch or Elasticsearch version.

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

Method definition
await 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 domain.

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

Method definition
await 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 Amazon OpenSearch Service domains.

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

Method definition
await 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

Lists available reserved OpenSearch instance offerings.

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

Method definition
await 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

Returns information about reserved OpenSearch instances for this account.

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

Method definition
await 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

dissociate_package

Dissociates a package from the Amazon OpenSearch Service domain.

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

Method definition
await 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 session.client("opensearch").generate_presigned_url method. boto3 documentation

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

get_compatible_versions

Returns a list of upgrade-compatible versions of OpenSearch/Elasticsearch.

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

Method definition
await 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 package versions, along with their creation time and commit message.

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

Method definition
await 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 the domain.

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

Method definition
await 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 performed on the domain.

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

Method definition
await 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 domains owned by the current user's account.

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

Method definition
await 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 the package.

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

Method definition
await 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

See also: AWS API Documentation.

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

Method definition
await 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 the Amazon OpenSearch Service domain.

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

Method definition
await 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 domain.

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

Method definition
await 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

List all supported versions of OpenSearch and Elasticsearch.

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

Method definition
await 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

purchase_reserved_instance_offering

Allows you to purchase reserved OpenSearch instances.

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

Method definition
await 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 domain owner to reject an inbound cross-cluster connection request.

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

Method definition
await 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 the given domain.

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

Method definition
await 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_service_software_update

Schedules a service software update for an Amazon OpenSearch Service domain.

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

Method definition
await def start_service_software_update(
    self,
    *,
    DomainName: str,
) -> StartServiceSoftwareUpdateResponseTypeDef:  # (1)
    ...
  1. See StartServiceSoftwareUpdateResponseTypeDef
Usage example with kwargs
kwargs: StartServiceSoftwareUpdateRequestRequestTypeDef = {  # (1)
    "DomainName": ...,
}

parent.start_service_software_update(**kwargs)
  1. See StartServiceSoftwareUpdateRequestRequestTypeDef

update_domain_config

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

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

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

parent.update_domain_config(**kwargs)
  1. See UpdateDomainConfigRequestRequestTypeDef

update_package

Updates a package for use with Amazon OpenSearch Service domains.

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

Method definition
await 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_domain

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

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

Method definition
await def upgrade_domain(
    self,
    *,
    DomainName: str,
    TargetVersion: str,
    PerformCheckOnly: bool = ...,
    AdvancedOptions: Mapping[str, str] = ...,
) -> UpgradeDomainResponseTypeDef:  # (1)
    ...
  1. See UpgradeDomainResponseTypeDef
Usage example with kwargs
kwargs: UpgradeDomainRequestRequestTypeDef = {  # (1)
    "DomainName": ...,
    "TargetVersion": ...,
}

parent.upgrade_domain(**kwargs)
  1. See UpgradeDomainRequestRequestTypeDef

__aenter__

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

Method definition
await def __aenter__(
    self,
) -> OpenSearchServiceClient:
    ...

__aexit__

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

Method definition
await def __aexit__(
    self,
    exc_type: Any,
    exc_val: Any,
    exc_tb: Any,
) -> Any:
    ...