OpenSearchServiceServerless module#
Index > OpenSearchServiceServerless
Auto-generated documentation for OpenSearchServiceServerless type annotations stubs module types-boto3-opensearchserverless.
How to install#
Generate locally (recommended)#
You can generate type annotations for boto3
package locally with mypy-boto3-builder
.
Use uv for build isolation.
- Run mypy-boto3-builder in your package root directory:
uvx --with 'boto3==1.36.26' mypy-boto3-builder
- Select
boto3
AWS SDK. - Add
OpenSearchServiceServerless
service. - Use provided commands to install generated packages.
VSCode extension#
Add AWS Boto3
extension to your VSCode and run AWS boto3: Quick Start
command.
Click Modify
and select boto3 common
and OpenSearchServiceServerless
.
From PyPI with pip#
Install types-boto3
for OpenSearchServiceServerless
service.
# install with boto3 type annotations
python -m pip install 'types-boto3[opensearchserverless]'
# Lite version does not provide session.client/resource overloads
# it is more RAM-friendly, but requires explicit type annotations
python -m pip install 'types-boto3-lite[opensearchserverless]'
# standalone installation
python -m pip install types-boto3-opensearchserverless
How to uninstall#
python -m pip uninstall -y types-boto3-opensearchserverless
Usage#
Code samples can be found in Examples.
OpenSearchServiceServerlessClient#
Type annotations and code completion for boto3.client("opensearchserverless")
as OpenSearchServiceServerlessClient
boto3 documentation
# OpenSearchServiceServerlessClient usage example
from boto3.session import Session
from types_boto3_opensearchserverless.client import OpenSearchServiceServerlessClient
def get_client() -> OpenSearchServiceServerlessClient:
return Session().client("opensearchserverless")
Literals#
Type annotations for literals used in methods and schema.
# AccessPolicyTypeType usage example
from types_boto3_opensearchserverless.literals import AccessPolicyTypeType
def get_value() -> AccessPolicyTypeType:
return "data"
- AccessPolicyTypeType
- CollectionStatusType
- CollectionTypeType
- IamIdentityCenterGroupAttributeType
- IamIdentityCenterUserAttributeType
- LifecyclePolicyTypeType
- ResourceTypeType
- SecurityConfigTypeType
- SecurityPolicyTypeType
- StandbyReplicasType
- VpcEndpointStatusType
- OpenSearchServiceServerlessServiceName
- ServiceName
- ResourceServiceName
- RegionName
Type definitions#
Type annotations for type definitions used in methods and schema.
- AccessPolicyDetailTypeDef
- AccessPolicyStatsTypeDef
- AccessPolicySummaryTypeDef
- CapacityLimitsTypeDef
- BatchGetCollectionRequestTypeDef
- CollectionDetailTypeDef
- CollectionErrorDetailTypeDef
- ResponseMetadataTypeDef
- LifecyclePolicyResourceIdentifierTypeDef
- EffectiveLifecyclePolicyDetailTypeDef
- EffectiveLifecyclePolicyErrorDetailTypeDef
- LifecyclePolicyIdentifierTypeDef
- LifecyclePolicyDetailTypeDef
- LifecyclePolicyErrorDetailTypeDef
- BatchGetVpcEndpointRequestTypeDef
- VpcEndpointDetailTypeDef
- VpcEndpointErrorDetailTypeDef
- CollectionFiltersTypeDef
- CollectionSummaryTypeDef
- CreateAccessPolicyRequestTypeDef
- CreateCollectionDetailTypeDef
- TagTypeDef
- CreateIamIdentityCenterConfigOptionsTypeDef
- CreateLifecyclePolicyRequestTypeDef
- SamlConfigOptionsTypeDef
- CreateSecurityPolicyRequestTypeDef
- SecurityPolicyDetailTypeDef
- CreateVpcEndpointDetailTypeDef
- CreateVpcEndpointRequestTypeDef
- DeleteAccessPolicyRequestTypeDef
- DeleteCollectionDetailTypeDef
- DeleteCollectionRequestTypeDef
- DeleteLifecyclePolicyRequestTypeDef
- DeleteSecurityConfigRequestTypeDef
- DeleteSecurityPolicyRequestTypeDef
- DeleteVpcEndpointDetailTypeDef
- DeleteVpcEndpointRequestTypeDef
- GetAccessPolicyRequestTypeDef
- LifecyclePolicyStatsTypeDef
- SecurityConfigStatsTypeDef
- SecurityPolicyStatsTypeDef
- GetSecurityConfigRequestTypeDef
- GetSecurityPolicyRequestTypeDef
- IamIdentityCenterConfigOptionsTypeDef
- LifecyclePolicySummaryTypeDef
- ListAccessPoliciesRequestTypeDef
- ListLifecyclePoliciesRequestTypeDef
- ListSecurityConfigsRequestTypeDef
- SecurityConfigSummaryTypeDef
- ListSecurityPoliciesRequestTypeDef
- SecurityPolicySummaryTypeDef
- ListTagsForResourceRequestTypeDef
- VpcEndpointFiltersTypeDef
- VpcEndpointSummaryTypeDef
- UntagResourceRequestTypeDef
- UpdateAccessPolicyRequestTypeDef
- UpdateCollectionDetailTypeDef
- UpdateCollectionRequestTypeDef
- UpdateIamIdentityCenterConfigOptionsTypeDef
- UpdateLifecyclePolicyRequestTypeDef
- UpdateSecurityPolicyRequestTypeDef
- UpdateVpcEndpointDetailTypeDef
- UpdateVpcEndpointRequestTypeDef
- AccountSettingsDetailTypeDef
- UpdateAccountSettingsRequestTypeDef
- BatchGetCollectionResponseTypeDef
- CreateAccessPolicyResponseTypeDef
- GetAccessPolicyResponseTypeDef
- ListAccessPoliciesResponseTypeDef
- UpdateAccessPolicyResponseTypeDef
- BatchGetEffectiveLifecyclePolicyRequestTypeDef
- BatchGetEffectiveLifecyclePolicyResponseTypeDef
- BatchGetLifecyclePolicyRequestTypeDef
- CreateLifecyclePolicyResponseTypeDef
- UpdateLifecyclePolicyResponseTypeDef
- BatchGetLifecyclePolicyResponseTypeDef
- BatchGetVpcEndpointResponseTypeDef
- ListCollectionsRequestTypeDef
- ListCollectionsResponseTypeDef
- CreateCollectionResponseTypeDef
- CreateCollectionRequestTypeDef
- ListTagsForResourceResponseTypeDef
- TagResourceRequestTypeDef
- CreateSecurityConfigRequestTypeDef
- CreateSecurityPolicyResponseTypeDef
- GetSecurityPolicyResponseTypeDef
- UpdateSecurityPolicyResponseTypeDef
- CreateVpcEndpointResponseTypeDef
- DeleteCollectionResponseTypeDef
- DeleteVpcEndpointResponseTypeDef
- GetPoliciesStatsResponseTypeDef
- SecurityConfigDetailTypeDef
- ListLifecyclePoliciesResponseTypeDef
- ListSecurityConfigsResponseTypeDef
- ListSecurityPoliciesResponseTypeDef
- ListVpcEndpointsRequestTypeDef
- ListVpcEndpointsResponseTypeDef
- UpdateCollectionResponseTypeDef
- UpdateSecurityConfigRequestTypeDef
- UpdateVpcEndpointResponseTypeDef
- GetAccountSettingsResponseTypeDef
- UpdateAccountSettingsResponseTypeDef
- CreateSecurityConfigResponseTypeDef
- GetSecurityConfigResponseTypeDef
- UpdateSecurityConfigResponseTypeDef