Skip to content

OpenSearchServiceClient#

Index > OpenSearchService > OpenSearchServiceClient

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

OpenSearchServiceClient#

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

# OpenSearchServiceClient usage example

from boto3.session import Session
from types_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.

# Exceptions.exceptions usage example

client = boto3.client("opensearch")

try:
    do_something(client)
except (
    client.exceptions.AccessDeniedException,
    client.exceptions.BaseException,
    client.exceptions.ClientError,
    client.exceptions.ConflictException,
    client.exceptions.DependencyFailureException,
    client.exceptions.DisabledOperationException,
    client.exceptions.InternalException,
    client.exceptions.InvalidPaginationTokenException,
    client.exceptions.InvalidTypeException,
    client.exceptions.LimitExceededException,
    client.exceptions.ResourceAlreadyExistsException,
    client.exceptions.ResourceNotFoundException,
    client.exceptions.SlotNotAvailableException,
    client.exceptions.ValidationException,
) as e:
    print(e)
# Exceptions.exceptions type checking example

from types_boto3_opensearch.client import Exceptions

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

Methods#

can_paginate#

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

# can_paginate method definition

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

generate_presigned_url#

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

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

# accept_inbound_connection method definition

def accept_inbound_connection(
    self,
    *,
    ConnectionId: str,
) -> AcceptInboundConnectionResponseTypeDef:  # (1)
    ...
  1. See AcceptInboundConnectionResponseTypeDef
# accept_inbound_connection method usage example with argument unpacking

kwargs: AcceptInboundConnectionRequestTypeDef = {  # (1)
    "ConnectionId": ...,
}

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

add_data_source#

Creates a new direct-query data source to the specified domain.

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

# add_data_source method definition

def add_data_source(
    self,
    *,
    DomainName: str,
    Name: str,
    DataSourceType: DataSourceTypeTypeDef,  # (1)
    Description: str = ...,
) -> AddDataSourceResponseTypeDef:  # (2)
    ...
  1. See DataSourceTypeTypeDef
  2. See AddDataSourceResponseTypeDef
# add_data_source method usage example with argument unpacking

kwargs: AddDataSourceRequestTypeDef = {  # (1)
    "DomainName": ...,
    "Name": ...,
    "DataSourceType": ...,
}

parent.add_data_source(**kwargs)
  1. See AddDataSourceRequestTypeDef

add_direct_query_data_source#

Adds a new data source in Amazon OpenSearch Service so that you can perform direct queries on external data.

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

# add_direct_query_data_source method definition

def add_direct_query_data_source(
    self,
    *,
    DataSourceName: str,
    DataSourceType: DirectQueryDataSourceTypeTypeDef,  # (1)
    OpenSearchArns: Sequence[str],
    Description: str = ...,
    TagList: Sequence[TagTypeDef] = ...,  # (2)
) -> AddDirectQueryDataSourceResponseTypeDef:  # (3)
    ...
  1. See DirectQueryDataSourceTypeTypeDef
  2. See Sequence[TagTypeDef]
  3. See AddDirectQueryDataSourceResponseTypeDef
# add_direct_query_data_source method usage example with argument unpacking

kwargs: AddDirectQueryDataSourceRequestTypeDef = {  # (1)
    "DataSourceName": ...,
    "DataSourceType": ...,
    "OpenSearchArns": ...,
}

parent.add_direct_query_data_source(**kwargs)
  1. See AddDirectQueryDataSourceRequestTypeDef

add_tags#

Attaches tags to an existing Amazon OpenSearch Service domain, data source, or application.

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

# add_tags method definition

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

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

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

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

# associate_package method definition

def associate_package(
    self,
    *,
    PackageID: str,
    DomainName: str,
    PrerequisitePackageIDList: Sequence[str] = ...,
    AssociationConfiguration: PackageAssociationConfigurationTypeDef = ...,  # (1)
) -> AssociatePackageResponseTypeDef:  # (2)
    ...
  1. See PackageAssociationConfigurationTypeDef
  2. See AssociatePackageResponseTypeDef
# associate_package method usage example with argument unpacking

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

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

associate_packages#

Operation in the Amazon OpenSearch Service API for associating multiple packages with a domain simultaneously.

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

# associate_packages method definition

def associate_packages(
    self,
    *,
    PackageList: Sequence[PackageDetailsForAssociationTypeDef],  # (1)
    DomainName: str,
) -> AssociatePackagesResponseTypeDef:  # (2)
    ...
  1. See Sequence[PackageDetailsForAssociationTypeDef]
  2. See AssociatePackagesResponseTypeDef
# associate_packages method usage example with argument unpacking

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

parent.associate_packages(**kwargs)
  1. See AssociatePackagesRequestTypeDef

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

# authorize_vpc_endpoint_access method definition

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

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

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

cancel_domain_config_change#

Cancels a pending configuration change on an Amazon OpenSearch Service domain.

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

# cancel_domain_config_change method definition

def cancel_domain_config_change(
    self,
    *,
    DomainName: str,
    DryRun: bool = ...,
) -> CancelDomainConfigChangeResponseTypeDef:  # (1)
    ...
  1. See CancelDomainConfigChangeResponseTypeDef
# cancel_domain_config_change method usage example with argument unpacking

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

parent.cancel_domain_config_change(**kwargs)
  1. See CancelDomainConfigChangeRequestTypeDef

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

# cancel_service_software_update method definition

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

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

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

create_application#

Creates an OpenSearch UI application.

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

# create_application method definition

def create_application(
    self,
    *,
    name: str,
    clientToken: str = ...,
    dataSources: Sequence[DataSourceTypeDef] = ...,  # (1)
    iamIdentityCenterOptions: IamIdentityCenterOptionsInputTypeDef = ...,  # (2)
    appConfigs: Sequence[AppConfigTypeDef] = ...,  # (3)
    tagList: Sequence[TagTypeDef] = ...,  # (4)
) -> CreateApplicationResponseTypeDef:  # (5)
    ...
  1. See Sequence[DataSourceTypeDef]
  2. See IamIdentityCenterOptionsInputTypeDef
  3. See Sequence[AppConfigTypeDef]
  4. See Sequence[TagTypeDef]
  5. See CreateApplicationResponseTypeDef
# create_application method usage example with argument unpacking

kwargs: CreateApplicationRequestTypeDef = {  # (1)
    "name": ...,
}

parent.create_application(**kwargs)
  1. See CreateApplicationRequestTypeDef

create_domain#

Creates an Amazon OpenSearch Service domain.

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

# create_domain method definition

def create_domain(
    self,
    *,
    DomainName: str,
    EngineVersion: str = ...,
    ClusterConfig: ClusterConfigUnionTypeDef = ...,  # (1)
    EBSOptions: EBSOptionsTypeDef = ...,  # (2)
    AccessPolicies: str = ...,
    IPAddressType: IPAddressTypeType = ...,  # (3)
    SnapshotOptions: SnapshotOptionsTypeDef = ...,  # (4)
    VPCOptions: VPCOptionsTypeDef = ...,  # (5)
    CognitoOptions: CognitoOptionsTypeDef = ...,  # (6)
    EncryptionAtRestOptions: EncryptionAtRestOptionsTypeDef = ...,  # (7)
    NodeToNodeEncryptionOptions: NodeToNodeEncryptionOptionsTypeDef = ...,  # (8)
    AdvancedOptions: Mapping[str, str] = ...,
    LogPublishingOptions: Mapping[LogTypeType, LogPublishingOptionTypeDef] = ...,  # (9)
    DomainEndpointOptions: DomainEndpointOptionsTypeDef = ...,  # (10)
    AdvancedSecurityOptions: AdvancedSecurityOptionsInputTypeDef = ...,  # (11)
    IdentityCenterOptions: IdentityCenterOptionsInputTypeDef = ...,  # (12)
    TagList: Sequence[TagTypeDef] = ...,  # (13)
    AutoTuneOptions: AutoTuneOptionsInputTypeDef = ...,  # (14)
    OffPeakWindowOptions: OffPeakWindowOptionsTypeDef = ...,  # (15)
    SoftwareUpdateOptions: SoftwareUpdateOptionsTypeDef = ...,  # (16)
    AIMLOptions: AIMLOptionsInputTypeDef = ...,  # (17)
) -> CreateDomainResponseTypeDef:  # (18)
    ...
  1. See ClusterConfigUnionTypeDef
  2. See EBSOptionsTypeDef
  3. See IPAddressTypeType
  4. See SnapshotOptionsTypeDef
  5. See VPCOptionsTypeDef
  6. See CognitoOptionsTypeDef
  7. See EncryptionAtRestOptionsTypeDef
  8. See NodeToNodeEncryptionOptionsTypeDef
  9. See Mapping[LogTypeType, LogPublishingOptionTypeDef]
  10. See DomainEndpointOptionsTypeDef
  11. See AdvancedSecurityOptionsInputTypeDef
  12. See IdentityCenterOptionsInputTypeDef
  13. See Sequence[TagTypeDef]
  14. See AutoTuneOptionsInputTypeDef
  15. See OffPeakWindowOptionsTypeDef
  16. See SoftwareUpdateOptionsTypeDef
  17. See AIMLOptionsInputTypeDef
  18. See CreateDomainResponseTypeDef
# create_domain method usage example with argument unpacking

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

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

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

# create_outbound_connection method definition

def create_outbound_connection(
    self,
    *,
    LocalDomainInfo: DomainInformationContainerTypeDef,  # (1)
    RemoteDomainInfo: DomainInformationContainerTypeDef,  # (1)
    ConnectionAlias: str,
    ConnectionMode: ConnectionModeType = ...,  # (3)
    ConnectionProperties: ConnectionPropertiesTypeDef = ...,  # (4)
) -> CreateOutboundConnectionResponseTypeDef:  # (5)
    ...
  1. See DomainInformationContainerTypeDef
  2. See DomainInformationContainerTypeDef
  3. See ConnectionModeType
  4. See ConnectionPropertiesTypeDef
  5. See CreateOutboundConnectionResponseTypeDef
# create_outbound_connection method usage example with argument unpacking

kwargs: CreateOutboundConnectionRequestTypeDef = {  # (1)
    "LocalDomainInfo": ...,
    "RemoteDomainInfo": ...,
    "ConnectionAlias": ...,
}

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

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

# create_package method definition

def create_package(
    self,
    *,
    PackageName: str,
    PackageType: PackageTypeType,  # (1)
    PackageSource: PackageSourceTypeDef,  # (2)
    PackageDescription: str = ...,
    PackageConfiguration: PackageConfigurationTypeDef = ...,  # (3)
    EngineVersion: str = ...,
    PackageVendingOptions: PackageVendingOptionsTypeDef = ...,  # (4)
    PackageEncryptionOptions: PackageEncryptionOptionsTypeDef = ...,  # (5)
) -> CreatePackageResponseTypeDef:  # (6)
    ...
  1. See PackageTypeType
  2. See PackageSourceTypeDef
  3. See PackageConfigurationTypeDef
  4. See PackageVendingOptionsTypeDef
  5. See PackageEncryptionOptionsTypeDef
  6. See CreatePackageResponseTypeDef
# create_package method usage example with argument unpacking

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

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

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

# 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: CreateVpcEndpointRequestTypeDef = {  # (1)
    "DomainArn": ...,
    "VpcOptions": ...,
}

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

delete_application#

Deletes a specified OpenSearch application.

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

# delete_application method definition

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

kwargs: DeleteApplicationRequestTypeDef = {  # (1)
    "id": ...,
}

parent.delete_application(**kwargs)
  1. See DeleteApplicationRequestTypeDef

delete_data_source#

Deletes a direct-query data source.

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

# delete_data_source method definition

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

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

parent.delete_data_source(**kwargs)
  1. See DeleteDataSourceRequestTypeDef

delete_direct_query_data_source#

Deletes a previously configured direct query data source from Amazon OpenSearch Service.

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

# delete_direct_query_data_source method definition

def delete_direct_query_data_source(
    self,
    *,
    DataSourceName: str,
) -> EmptyResponseMetadataTypeDef:  # (1)
    ...
  1. See EmptyResponseMetadataTypeDef
# delete_direct_query_data_source method usage example with argument unpacking

kwargs: DeleteDirectQueryDataSourceRequestTypeDef = {  # (1)
    "DataSourceName": ...,
}

parent.delete_direct_query_data_source(**kwargs)
  1. See DeleteDirectQueryDataSourceRequestTypeDef

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

# delete_domain method definition

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

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

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

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

# delete_inbound_connection method definition

def delete_inbound_connection(
    self,
    *,
    ConnectionId: str,
) -> DeleteInboundConnectionResponseTypeDef:  # (1)
    ...
  1. See DeleteInboundConnectionResponseTypeDef
# delete_inbound_connection method usage example with argument unpacking

kwargs: DeleteInboundConnectionRequestTypeDef = {  # (1)
    "ConnectionId": ...,
}

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

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

# delete_outbound_connection method definition

def delete_outbound_connection(
    self,
    *,
    ConnectionId: str,
) -> DeleteOutboundConnectionResponseTypeDef:  # (1)
    ...
  1. See DeleteOutboundConnectionResponseTypeDef
# delete_outbound_connection method usage example with argument unpacking

kwargs: DeleteOutboundConnectionRequestTypeDef = {  # (1)
    "ConnectionId": ...,
}

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

delete_package#

Deletes an Amazon OpenSearch Service package.

Type annotations and code completion for boto3.client("opensearch").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: DeletePackageRequestTypeDef = {  # (1)
    "PackageID": ...,
}

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

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

# 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: DeleteVpcEndpointRequestTypeDef = {  # (1)
    "VpcEndpointId": ...,
}

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

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

# describe_domain method definition

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

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

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

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

# 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: DescribeDomainAutoTunesRequestTypeDef = {  # (1)
    "DomainName": ...,
}

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

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

# 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: DescribeDomainChangeProgressRequestTypeDef = {  # (1)
    "DomainName": ...,
}

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

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

# describe_domain_config method definition

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

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

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

describe_domain_health#

Returns information about domain and node health, the standby Availability Zone, number of nodes per Availability Zone, and shard count per node.

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

# describe_domain_health method definition

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

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

parent.describe_domain_health(**kwargs)
  1. See DescribeDomainHealthRequestTypeDef

describe_domain_nodes#

Returns information about domain and nodes, including data nodes, master nodes, ultrawarm nodes, Availability Zone(s), standby nodes, node configurations, and node states.

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

# describe_domain_nodes method definition

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

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

parent.describe_domain_nodes(**kwargs)
  1. See DescribeDomainNodesRequestTypeDef

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

# describe_domains method definition

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

kwargs: DescribeDomainsRequestTypeDef = {  # (1)
    "DomainNames": ...,
}

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

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

# describe_dry_run_progress method definition

def describe_dry_run_progress(
    self,
    *,
    DomainName: str,
    DryRunId: str = ...,
    LoadDryRunConfig: bool = ...,
) -> DescribeDryRunProgressResponseTypeDef:  # (1)
    ...
  1. See DescribeDryRunProgressResponseTypeDef
# describe_dry_run_progress method usage example with argument unpacking

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

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

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

# describe_inbound_connections method definition

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

kwargs: DescribeInboundConnectionsRequestTypeDef = {  # (1)
    "Filters": ...,
}

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

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

# describe_instance_type_limits method definition

def describe_instance_type_limits(
    self,
    *,
    InstanceType: OpenSearchPartitionInstanceTypeType,  # (1)
    EngineVersion: str,
    DomainName: str = ...,
) -> DescribeInstanceTypeLimitsResponseTypeDef:  # (2)
    ...
  1. See OpenSearchPartitionInstanceTypeType
  2. See DescribeInstanceTypeLimitsResponseTypeDef
# describe_instance_type_limits method usage example with argument unpacking

kwargs: DescribeInstanceTypeLimitsRequestTypeDef = {  # (1)
    "InstanceType": ...,
    "EngineVersion": ...,
}

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

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

# describe_outbound_connections method definition

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

kwargs: DescribeOutboundConnectionsRequestTypeDef = {  # (1)
    "Filters": ...,
}

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

describe_packages#

Describes all packages available to OpenSearch Service.

Type annotations and code completion for boto3.client("opensearch").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 Sequence[DescribePackagesFilterTypeDef]
  2. See DescribePackagesResponseTypeDef
# describe_packages method usage example with argument unpacking

kwargs: DescribePackagesRequestTypeDef = {  # (1)
    "Filters": ...,
}

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

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

# describe_reserved_instance_offerings method definition

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

kwargs: DescribeReservedInstanceOfferingsRequestTypeDef = {  # (1)
    "ReservedInstanceOfferingId": ...,
}

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

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

# describe_reserved_instances method definition

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

kwargs: DescribeReservedInstancesRequestTypeDef = {  # (1)
    "ReservedInstanceId": ...,
}

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

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

# 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: DescribeVpcEndpointsRequestTypeDef = {  # (1)
    "VpcEndpointIds": ...,
}

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

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

# 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: DissociatePackageRequestTypeDef = {  # (1)
    "PackageID": ...,
    "DomainName": ...,
}

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

dissociate_packages#

Dissociates multiple packages from a domain simulatneously.

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

# dissociate_packages method definition

def dissociate_packages(
    self,
    *,
    PackageList: Sequence[str],
    DomainName: str,
) -> DissociatePackagesResponseTypeDef:  # (1)
    ...
  1. See DissociatePackagesResponseTypeDef
# dissociate_packages method usage example with argument unpacking

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

parent.dissociate_packages(**kwargs)
  1. See DissociatePackagesRequestTypeDef

get_application#

Retrieves the configuration and status of an existing OpenSearch application.

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

# get_application method definition

def get_application(
    self,
    *,
    id: str,
) -> GetApplicationResponseTypeDef:  # (1)
    ...
  1. See GetApplicationResponseTypeDef
# get_application method usage example with argument unpacking

kwargs: GetApplicationRequestTypeDef = {  # (1)
    "id": ...,
}

parent.get_application(**kwargs)
  1. See GetApplicationRequestTypeDef

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

# get_compatible_versions method definition

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

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

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

get_data_source#

Retrieves information about a direct query data source.

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

# get_data_source method definition

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

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

parent.get_data_source(**kwargs)
  1. See GetDataSourceRequestTypeDef

get_direct_query_data_source#

Returns detailed configuration information for a specific direct query data source in Amazon OpenSearch Service.

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

# get_direct_query_data_source method definition

def get_direct_query_data_source(
    self,
    *,
    DataSourceName: str,
) -> GetDirectQueryDataSourceResponseTypeDef:  # (1)
    ...
  1. See GetDirectQueryDataSourceResponseTypeDef
# get_direct_query_data_source method usage example with argument unpacking

kwargs: GetDirectQueryDataSourceRequestTypeDef = {  # (1)
    "DataSourceName": ...,
}

parent.get_direct_query_data_source(**kwargs)
  1. See GetDirectQueryDataSourceRequestTypeDef

get_domain_maintenance_status#

The status of the maintenance action.

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

# get_domain_maintenance_status method definition

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

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

parent.get_domain_maintenance_status(**kwargs)
  1. See GetDomainMaintenanceStatusRequestTypeDef

get_package_version_history#

Returns a list of Amazon OpenSearch Service package versions, along with their creation time, commit message, and plugin properties (if the package is a zip plugin package).

Type annotations and code completion for boto3.client("opensearch").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: GetPackageVersionHistoryRequestTypeDef = {  # (1)
    "PackageID": ...,
}

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

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

# 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: GetUpgradeHistoryRequestTypeDef = {  # (1)
    "DomainName": ...,
}

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

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

# 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: GetUpgradeStatusRequestTypeDef = {  # (1)
    "DomainName": ...,
}

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

list_applications#

Lists all OpenSearch applications under your account.

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

# list_applications method definition

def list_applications(
    self,
    *,
    nextToken: str = ...,
    statuses: Sequence[ApplicationStatusType] = ...,  # (1)
    maxResults: int = ...,
) -> ListApplicationsResponseTypeDef:  # (2)
    ...
  1. See Sequence[ApplicationStatusType]
  2. See ListApplicationsResponseTypeDef
# list_applications method usage example with argument unpacking

kwargs: ListApplicationsRequestTypeDef = {  # (1)
    "nextToken": ...,
}

parent.list_applications(**kwargs)
  1. See ListApplicationsRequestTypeDef

list_data_sources#

Lists direct-query data sources for a specific domain.

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

# list_data_sources method definition

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

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

parent.list_data_sources(**kwargs)
  1. See ListDataSourcesRequestTypeDef

list_direct_query_data_sources#

Lists an inventory of all the direct query data sources that you have configured within Amazon OpenSearch Service.

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

# list_direct_query_data_sources method definition

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

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

parent.list_direct_query_data_sources(**kwargs)
  1. See ListDirectQueryDataSourcesRequestTypeDef

list_domain_maintenances#

A list of maintenance actions for the domain.

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

# list_domain_maintenances method definition

def list_domain_maintenances(
    self,
    *,
    DomainName: str,
    Action: MaintenanceTypeType = ...,  # (1)
    Status: MaintenanceStatusType = ...,  # (2)
    MaxResults: int = ...,
    NextToken: str = ...,
) -> ListDomainMaintenancesResponseTypeDef:  # (3)
    ...
  1. See MaintenanceTypeType
  2. See MaintenanceStatusType
  3. See ListDomainMaintenancesResponseTypeDef
# list_domain_maintenances method usage example with argument unpacking

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

parent.list_domain_maintenances(**kwargs)
  1. See ListDomainMaintenancesRequestTypeDef

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

# 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: ListDomainNamesRequestTypeDef = {  # (1)
    "EngineType": ...,
}

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

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

# 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: ListDomainsForPackageRequestTypeDef = {  # (1)
    "PackageID": ...,
}

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

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

# list_instance_type_details method definition

def list_instance_type_details(
    self,
    *,
    EngineVersion: str,
    DomainName: str = ...,
    MaxResults: int = ...,
    NextToken: str = ...,
    RetrieveAZs: bool = ...,
    InstanceType: str = ...,
) -> ListInstanceTypeDetailsResponseTypeDef:  # (1)
    ...
  1. See ListInstanceTypeDetailsResponseTypeDef
# list_instance_type_details method usage example with argument unpacking

kwargs: ListInstanceTypeDetailsRequestTypeDef = {  # (1)
    "EngineVersion": ...,
}

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

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

# 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: ListPackagesForDomainRequestTypeDef = {  # (1)
    "DomainName": ...,
}

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

list_scheduled_actions#

Retrieves a list of configuration changes that are scheduled for a domain.

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

# list_scheduled_actions method definition

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

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

parent.list_scheduled_actions(**kwargs)
  1. See ListScheduledActionsRequestTypeDef

list_tags#

Returns all resource tags for an Amazon OpenSearch Service domain, data source, or application.

Type annotations and code completion for boto3.client("opensearch").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: ListTagsRequestTypeDef = {  # (1)
    "ARN": ...,
}

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

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

# list_versions method definition

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

kwargs: ListVersionsRequestTypeDef = {  # (1)
    "MaxResults": ...,
}

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

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

# 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: ListVpcEndpointAccessRequestTypeDef = {  # (1)
    "DomainName": ...,
}

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

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

# 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: ListVpcEndpointsRequestTypeDef = {  # (1)
    "NextToken": ...,
}

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

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

# 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: ListVpcEndpointsForDomainRequestTypeDef = {  # (1)
    "DomainName": ...,
}

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

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

# purchase_reserved_instance_offering method definition

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

kwargs: PurchaseReservedInstanceOfferingRequestTypeDef = {  # (1)
    "ReservedInstanceOfferingId": ...,
    "ReservationName": ...,
}

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

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

# reject_inbound_connection method definition

def reject_inbound_connection(
    self,
    *,
    ConnectionId: str,
) -> RejectInboundConnectionResponseTypeDef:  # (1)
    ...
  1. See RejectInboundConnectionResponseTypeDef
# reject_inbound_connection method usage example with argument unpacking

kwargs: RejectInboundConnectionRequestTypeDef = {  # (1)
    "ConnectionId": ...,
}

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

remove_tags#

Removes the specified set of tags from an Amazon OpenSearch Service domain, data source, or application.

Type annotations and code completion for boto3.client("opensearch").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: RemoveTagsRequestTypeDef = {  # (1)
    "ARN": ...,
    "TagKeys": ...,
}

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

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

# revoke_vpc_endpoint_access method definition

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

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

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

start_domain_maintenance#

Starts the node maintenance process on the data node.

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

# start_domain_maintenance method definition

def start_domain_maintenance(
    self,
    *,
    DomainName: str,
    Action: MaintenanceTypeType,  # (1)
    NodeId: str = ...,
) -> StartDomainMaintenanceResponseTypeDef:  # (2)
    ...
  1. See MaintenanceTypeType
  2. See StartDomainMaintenanceResponseTypeDef
# start_domain_maintenance method usage example with argument unpacking

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

parent.start_domain_maintenance(**kwargs)
  1. See StartDomainMaintenanceRequestTypeDef

start_service_software_update#

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

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

# start_service_software_update method definition

def start_service_software_update(
    self,
    *,
    DomainName: str,
    ScheduleAt: ScheduleAtType = ...,  # (1)
    DesiredStartTime: int = ...,
) -> StartServiceSoftwareUpdateResponseTypeDef:  # (2)
    ...
  1. See ScheduleAtType
  2. See StartServiceSoftwareUpdateResponseTypeDef
# start_service_software_update method usage example with argument unpacking

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

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

update_application#

Updates the configuration and settings of an existing OpenSearch application.

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

# update_application method definition

def update_application(
    self,
    *,
    id: str,
    dataSources: Sequence[DataSourceTypeDef] = ...,  # (1)
    appConfigs: Sequence[AppConfigTypeDef] = ...,  # (2)
) -> UpdateApplicationResponseTypeDef:  # (3)
    ...
  1. See Sequence[DataSourceTypeDef]
  2. See Sequence[AppConfigTypeDef]
  3. See UpdateApplicationResponseTypeDef
# update_application method usage example with argument unpacking

kwargs: UpdateApplicationRequestTypeDef = {  # (1)
    "id": ...,
}

parent.update_application(**kwargs)
  1. See UpdateApplicationRequestTypeDef

update_data_source#

Updates a direct-query data source.

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

# update_data_source method definition

def update_data_source(
    self,
    *,
    DomainName: str,
    Name: str,
    DataSourceType: DataSourceTypeTypeDef,  # (1)
    Description: str = ...,
    Status: DataSourceStatusType = ...,  # (2)
) -> UpdateDataSourceResponseTypeDef:  # (3)
    ...
  1. See DataSourceTypeTypeDef
  2. See DataSourceStatusType
  3. See UpdateDataSourceResponseTypeDef
# update_data_source method usage example with argument unpacking

kwargs: UpdateDataSourceRequestTypeDef = {  # (1)
    "DomainName": ...,
    "Name": ...,
    "DataSourceType": ...,
}

parent.update_data_source(**kwargs)
  1. See UpdateDataSourceRequestTypeDef

update_direct_query_data_source#

Updates the configuration or properties of an existing direct query data source in Amazon OpenSearch Service.

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

# update_direct_query_data_source method definition

def update_direct_query_data_source(
    self,
    *,
    DataSourceName: str,
    DataSourceType: DirectQueryDataSourceTypeTypeDef,  # (1)
    OpenSearchArns: Sequence[str],
    Description: str = ...,
) -> UpdateDirectQueryDataSourceResponseTypeDef:  # (2)
    ...
  1. See DirectQueryDataSourceTypeTypeDef
  2. See UpdateDirectQueryDataSourceResponseTypeDef
# update_direct_query_data_source method usage example with argument unpacking

kwargs: UpdateDirectQueryDataSourceRequestTypeDef = {  # (1)
    "DataSourceName": ...,
    "DataSourceType": ...,
    "OpenSearchArns": ...,
}

parent.update_direct_query_data_source(**kwargs)
  1. See UpdateDirectQueryDataSourceRequestTypeDef

update_domain_config#

Modifies the cluster configuration of the specified Amazon OpenSearch Service domain.

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

# update_domain_config method definition

def update_domain_config(
    self,
    *,
    DomainName: str,
    ClusterConfig: ClusterConfigUnionTypeDef = ...,  # (1)
    EBSOptions: EBSOptionsTypeDef = ...,  # (2)
    SnapshotOptions: SnapshotOptionsTypeDef = ...,  # (3)
    VPCOptions: VPCOptionsTypeDef = ...,  # (4)
    CognitoOptions: CognitoOptionsTypeDef = ...,  # (5)
    AdvancedOptions: Mapping[str, str] = ...,
    AccessPolicies: str = ...,
    IPAddressType: IPAddressTypeType = ...,  # (6)
    LogPublishingOptions: Mapping[LogTypeType, LogPublishingOptionTypeDef] = ...,  # (7)
    EncryptionAtRestOptions: EncryptionAtRestOptionsTypeDef = ...,  # (8)
    DomainEndpointOptions: DomainEndpointOptionsTypeDef = ...,  # (9)
    NodeToNodeEncryptionOptions: NodeToNodeEncryptionOptionsTypeDef = ...,  # (10)
    AdvancedSecurityOptions: AdvancedSecurityOptionsInputTypeDef = ...,  # (11)
    IdentityCenterOptions: IdentityCenterOptionsInputTypeDef = ...,  # (12)
    AutoTuneOptions: AutoTuneOptionsUnionTypeDef = ...,  # (13)
    DryRun: bool = ...,
    DryRunMode: DryRunModeType = ...,  # (14)
    OffPeakWindowOptions: OffPeakWindowOptionsTypeDef = ...,  # (15)
    SoftwareUpdateOptions: SoftwareUpdateOptionsTypeDef = ...,  # (16)
    AIMLOptions: AIMLOptionsInputTypeDef = ...,  # (17)
) -> UpdateDomainConfigResponseTypeDef:  # (18)
    ...
  1. See ClusterConfigUnionTypeDef
  2. See EBSOptionsTypeDef
  3. See SnapshotOptionsTypeDef
  4. See VPCOptionsTypeDef
  5. See CognitoOptionsTypeDef
  6. See IPAddressTypeType
  7. See Mapping[LogTypeType, LogPublishingOptionTypeDef]
  8. See EncryptionAtRestOptionsTypeDef
  9. See DomainEndpointOptionsTypeDef
  10. See NodeToNodeEncryptionOptionsTypeDef
  11. See AdvancedSecurityOptionsInputTypeDef
  12. See IdentityCenterOptionsInputTypeDef
  13. See AutoTuneOptionsUnionTypeDef
  14. See DryRunModeType
  15. See OffPeakWindowOptionsTypeDef
  16. See SoftwareUpdateOptionsTypeDef
  17. See AIMLOptionsInputTypeDef
  18. See UpdateDomainConfigResponseTypeDef
# update_domain_config method usage example with argument unpacking

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

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

update_package#

Updates a package for use with Amazon OpenSearch Service domains.

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

# update_package method definition

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

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

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

update_package_scope#

Updates the scope of a package.

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

# update_package_scope method definition

def update_package_scope(
    self,
    *,
    PackageID: str,
    Operation: PackageScopeOperationEnumType,  # (1)
    PackageUserList: Sequence[str],
) -> UpdatePackageScopeResponseTypeDef:  # (2)
    ...
  1. See PackageScopeOperationEnumType
  2. See UpdatePackageScopeResponseTypeDef
# update_package_scope method usage example with argument unpacking

kwargs: UpdatePackageScopeRequestTypeDef = {  # (1)
    "PackageID": ...,
    "Operation": ...,
    "PackageUserList": ...,
}

parent.update_package_scope(**kwargs)
  1. See UpdatePackageScopeRequestTypeDef

update_scheduled_action#

Reschedules a planned domain configuration change for a later time.

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

# update_scheduled_action method definition

def update_scheduled_action(
    self,
    *,
    DomainName: str,
    ActionID: str,
    ActionType: ActionTypeType,  # (1)
    ScheduleAt: ScheduleAtType,  # (2)
    DesiredStartTime: int = ...,
) -> UpdateScheduledActionResponseTypeDef:  # (3)
    ...
  1. See ActionTypeType
  2. See ScheduleAtType
  3. See UpdateScheduledActionResponseTypeDef
# update_scheduled_action method usage example with argument unpacking

kwargs: UpdateScheduledActionRequestTypeDef = {  # (1)
    "DomainName": ...,
    "ActionID": ...,
    "ActionType": ...,
    "ScheduleAt": ...,
}

parent.update_scheduled_action(**kwargs)
  1. See UpdateScheduledActionRequestTypeDef

update_vpc_endpoint#

Modifies an Amazon OpenSearch Service-managed interface VPC endpoint.

Type annotations and code completion for boto3.client("opensearch").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: UpdateVpcEndpointRequestTypeDef = {  # (1)
    "VpcEndpointId": ...,
    "VpcOptions": ...,
}

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

upgrade_domain#

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

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

# upgrade_domain method definition

def upgrade_domain(
    self,
    *,
    DomainName: str,
    TargetVersion: str,
    PerformCheckOnly: bool = ...,
    AdvancedOptions: Mapping[str, str] = ...,
) -> UpgradeDomainResponseTypeDef:  # (1)
    ...
  1. See UpgradeDomainResponseTypeDef
# upgrade_domain method usage example with argument unpacking

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

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

get_paginator#

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