OpenSearchService module
Index > OpenSearchService
Auto-generated documentation for OpenSearchService type annotations stubs module mypy-boto3-opensearch.
How to install
VSCode extension
Add AWS Boto3
extension to your VSCode and run AWS boto3: Quick Start
command.
Click Modify
and select boto3 common
and OpenSearchService
.
From PyPI with pip
Install boto3-stubs
for OpenSearchService
service.
# install with boto3 type annotations
python -m pip install 'boto3-stubs[opensearch]'
# Lite version does not provide session.client/resource overloads
# it is more RAM-friendly, but requires explicit type annotations
python -m pip install 'boto3-stubs-lite[opensearch]'
# standalone installation
python -m pip install mypy-boto3-opensearch
How to uninstall
Usage
Code samples can be found in Examples.
OpenSearchServiceClient
Type annotations and code completion for boto3.client("opensearch")
as OpenSearchServiceClient
boto3 documentation
Usage example
from boto3.session import Session
from mypy_boto3_opensearch.client import OpenSearchServiceClient
def get_client() -> OpenSearchServiceClient:
return Session().client("opensearch")
Literals
Type annotations for literals used in methods and schemas.
Usage example
from mypy_boto3_opensearch.literals import ActionSeverityType
def get_value() -> ActionSeverityType:
return "HIGH"
- ActionSeverityType
- ActionStatusType
- ActionTypeType
- AutoTuneDesiredStateType
- AutoTuneStateType
- AutoTuneTypeType
- ConnectionModeType
- DeploymentStatusType
- DescribePackagesFilterNameType
- DomainPackageStatusType
- DryRunModeType
- EngineTypeType
- InboundConnectionStatusCodeType
- LogTypeType
- OpenSearchPartitionInstanceTypeType
- OpenSearchWarmPartitionInstanceTypeType
- OptionStateType
- OutboundConnectionStatusCodeType
- OverallChangeStatusType
- PackageStatusType
- PackageTypeType
- PrincipalTypeType
- ReservedInstancePaymentOptionType
- RollbackOnDisableType
- ScheduleAtType
- ScheduledAutoTuneActionTypeType
- ScheduledAutoTuneSeverityTypeType
- ScheduledByType
- TLSSecurityPolicyType
- TimeUnitType
- UpgradeStatusType
- UpgradeStepType
- VolumeTypeType
- VpcEndpointErrorCodeType
- VpcEndpointStatusType
- OpenSearchServiceServiceName
- ServiceName
- ResourceServiceName
- RegionName
Typed dictionaries
Type annotations for typed dictionaries used in methods and schema.
Usage example
from mypy_boto3_opensearch.type_defs import AWSDomainInformationTypeDef
def get_value() -> AWSDomainInformationTypeDef:
return {
"DomainName": ...,
}
- AWSDomainInformationTypeDef
- AcceptInboundConnectionRequestRequestTypeDef
- ResponseMetadataTypeDef
- OptionStatusTypeDef
- TagTypeDef
- AdditionalLimitTypeDef
- MasterUserOptionsTypeDef
- AssociatePackageRequestRequestTypeDef
- AuthorizeVpcEndpointAccessRequestRequestTypeDef
- AuthorizedPrincipalTypeDef
- ScheduledAutoTuneDetailsTypeDef
- DurationTypeDef
- AutoTuneOptionsOutputTypeDef
- AutoTuneStatusTypeDef
- CancelServiceSoftwareUpdateRequestRequestTypeDef
- ServiceSoftwareOptionsTypeDef
- ChangeProgressDetailsTypeDef
- ChangeProgressStageTypeDef
- ColdStorageOptionsTypeDef
- ZoneAwarenessConfigTypeDef
- CognitoOptionsTypeDef
- CompatibleVersionsMapTypeDef
- ConnectionPropertiesTypeDef
- DomainEndpointOptionsTypeDef
- EBSOptionsTypeDef
- EncryptionAtRestOptionsTypeDef
- LogPublishingOptionTypeDef
- NodeToNodeEncryptionOptionsTypeDef
- SnapshotOptionsTypeDef
- SoftwareUpdateOptionsTypeDef
- VPCOptionsTypeDef
- OutboundConnectionStatusTypeDef
- PackageSourceTypeDef
- DeleteDomainRequestRequestTypeDef
- DeleteInboundConnectionRequestRequestTypeDef
- DeleteOutboundConnectionRequestRequestTypeDef
- DeletePackageRequestRequestTypeDef
- DeleteVpcEndpointRequestRequestTypeDef
- VpcEndpointSummaryTypeDef
- DescribeDomainAutoTunesRequestRequestTypeDef
- DescribeDomainChangeProgressRequestRequestTypeDef
- DescribeDomainConfigRequestRequestTypeDef
- DescribeDomainRequestRequestTypeDef
- DescribeDomainsRequestRequestTypeDef
- DescribeDryRunProgressRequestRequestTypeDef
- DryRunResultsTypeDef
- FilterTypeDef
- DescribeInstanceTypeLimitsRequestRequestTypeDef
- DescribePackagesFilterTypeDef
- DescribeReservedInstanceOfferingsRequestRequestTypeDef
- DescribeReservedInstancesRequestRequestTypeDef
- DescribeVpcEndpointsRequestRequestTypeDef
- VpcEndpointErrorTypeDef
- DissociatePackageRequestRequestTypeDef
- DomainInfoTypeDef
- ErrorDetailsTypeDef
- VPCDerivedInfoTypeDef
- ValidationFailureTypeDef
- GetCompatibleVersionsRequestRequestTypeDef
- GetPackageVersionHistoryRequestRequestTypeDef
- PackageVersionHistoryTypeDef
- GetUpgradeHistoryRequestRequestTypeDef
- GetUpgradeStatusRequestRequestTypeDef
- InboundConnectionStatusTypeDef
- InstanceCountLimitsTypeDef
- InstanceTypeDetailsTypeDef
- ListDomainNamesRequestRequestTypeDef
- ListDomainsForPackageRequestRequestTypeDef
- ListInstanceTypeDetailsRequestRequestTypeDef
- ListPackagesForDomainRequestRequestTypeDef
- ListScheduledActionsRequestRequestTypeDef
- ScheduledActionTypeDef
- ListTagsRequestRequestTypeDef
- ListVersionsRequestRequestTypeDef
- ListVpcEndpointAccessRequestRequestTypeDef
- ListVpcEndpointsForDomainRequestRequestTypeDef
- ListVpcEndpointsRequestRequestTypeDef
- WindowStartTimeTypeDef
- PurchaseReservedInstanceOfferingRequestRequestTypeDef
- RecurringChargeTypeDef
- RejectInboundConnectionRequestRequestTypeDef
- RemoveTagsRequestRequestTypeDef
- RevokeVpcEndpointAccessRequestRequestTypeDef
- SAMLIdpTypeDef
- StartServiceSoftwareUpdateRequestRequestTypeDef
- StorageTypeLimitTypeDef
- UpdateScheduledActionRequestRequestTypeDef
- UpgradeDomainRequestRequestTypeDef
- UpgradeStepItemTypeDef
- DomainInformationContainerTypeDef
- EmptyResponseMetadataTypeDef
- GetUpgradeStatusResponseTypeDef
- ListVersionsResponseTypeDef
- PurchaseReservedInstanceOfferingResponseTypeDef
- AccessPoliciesStatusTypeDef
- AdvancedOptionsStatusTypeDef
- VersionStatusTypeDef
- AddTagsRequestRequestTypeDef
- ListTagsResponseTypeDef
- AuthorizeVpcEndpointAccessResponseTypeDef
- ListVpcEndpointAccessResponseTypeDef
- AutoTuneDetailsTypeDef
- AutoTuneMaintenanceScheduleTypeDef
- CancelServiceSoftwareUpdateResponseTypeDef
- StartServiceSoftwareUpdateResponseTypeDef
- UpgradeDomainResponseTypeDef
- ChangeProgressStatusDetailsTypeDef
- ClusterConfigTypeDef
- CognitoOptionsStatusTypeDef
- GetCompatibleVersionsResponseTypeDef
- DomainEndpointOptionsStatusTypeDef
- EBSOptionsStatusTypeDef
- EncryptionAtRestOptionsStatusTypeDef
- LogPublishingOptionsStatusTypeDef
- NodeToNodeEncryptionOptionsStatusTypeDef
- SnapshotOptionsStatusTypeDef
- SoftwareUpdateOptionsStatusTypeDef
- CreateVpcEndpointRequestRequestTypeDef
- UpdateVpcEndpointRequestRequestTypeDef
- CreatePackageRequestRequestTypeDef
- UpdatePackageRequestRequestTypeDef
- DeleteVpcEndpointResponseTypeDef
- ListVpcEndpointsForDomainResponseTypeDef
- ListVpcEndpointsResponseTypeDef
- DescribeInboundConnectionsRequestRequestTypeDef
- DescribeOutboundConnectionsRequestRequestTypeDef
- DescribePackagesRequestRequestTypeDef
- ListDomainNamesResponseTypeDef
- DomainPackageDetailsTypeDef
- PackageDetailsTypeDef
- VPCDerivedInfoStatusTypeDef
- VpcEndpointTypeDef
- DryRunProgressStatusTypeDef
- GetPackageVersionHistoryResponseTypeDef
- InstanceLimitsTypeDef
- ListInstanceTypeDetailsResponseTypeDef
- ListScheduledActionsResponseTypeDef
- UpdateScheduledActionResponseTypeDef
- OffPeakWindowTypeDef
- ReservedInstanceOfferingTypeDef
- ReservedInstanceTypeDef
- SAMLOptionsInputTypeDef
- SAMLOptionsOutputTypeDef
- StorageTypeTypeDef
- UpgradeHistoryTypeDef
- CreateOutboundConnectionRequestRequestTypeDef
- CreateOutboundConnectionResponseTypeDef
- InboundConnectionTypeDef
- OutboundConnectionTypeDef
- AutoTuneTypeDef
- AutoTuneOptionsInputTypeDef
- AutoTuneOptionsTypeDef
- DescribeDomainChangeProgressResponseTypeDef
- ClusterConfigStatusTypeDef
- AssociatePackageResponseTypeDef
- DissociatePackageResponseTypeDef
- ListDomainsForPackageResponseTypeDef
- ListPackagesForDomainResponseTypeDef
- CreatePackageResponseTypeDef
- DeletePackageResponseTypeDef
- DescribePackagesResponseTypeDef
- UpdatePackageResponseTypeDef
- CreateVpcEndpointResponseTypeDef
- DescribeVpcEndpointsResponseTypeDef
- UpdateVpcEndpointResponseTypeDef
- OffPeakWindowOptionsTypeDef
- DescribeReservedInstanceOfferingsResponseTypeDef
- DescribeReservedInstancesResponseTypeDef
- AdvancedSecurityOptionsInputTypeDef
- AdvancedSecurityOptionsTypeDef
- LimitsTypeDef
- GetUpgradeHistoryResponseTypeDef
- AcceptInboundConnectionResponseTypeDef
- DeleteInboundConnectionResponseTypeDef
- DescribeInboundConnectionsResponseTypeDef
- RejectInboundConnectionResponseTypeDef
- DeleteOutboundConnectionResponseTypeDef
- DescribeOutboundConnectionsResponseTypeDef
- DescribeDomainAutoTunesResponseTypeDef
- AutoTuneOptionsStatusTypeDef
- OffPeakWindowOptionsStatusTypeDef
- CreateDomainRequestRequestTypeDef
- UpdateDomainConfigRequestRequestTypeDef
- AdvancedSecurityOptionsStatusTypeDef
- DomainStatusTypeDef
- DescribeInstanceTypeLimitsResponseTypeDef
- DomainConfigTypeDef
- CreateDomainResponseTypeDef
- DeleteDomainResponseTypeDef
- DescribeDomainResponseTypeDef
- DescribeDomainsResponseTypeDef
- DescribeDryRunProgressResponseTypeDef
- DescribeDomainConfigResponseTypeDef
- UpdateDomainConfigResponseTypeDef