OpenSearchIngestion module#
Index > OpenSearchIngestion
Auto-generated documentation for OpenSearchIngestion type annotations stubs module mypy-boto3-osis.
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 OpenSearchIngestion
.
From PyPI with pip#
Install boto3-stubs
for OpenSearchIngestion
service.
# install with boto3 type annotations
python -m pip install 'boto3-stubs[osis]'
# 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[osis]'
# standalone installation
python -m pip install mypy-boto3-osis
How to uninstall#
python -m pip uninstall -y mypy-boto3-osis
Usage#
Code samples can be found in Examples.
OpenSearchIngestionClient#
Type annotations and code completion for boto3.client("osis")
as OpenSearchIngestionClient
boto3 documentation
# OpenSearchIngestionClient usage example
from boto3.session import Session
from mypy_boto3_osis.client import OpenSearchIngestionClient
def get_client() -> OpenSearchIngestionClient:
return Session().client("osis")
Literals#
Type annotations for literals used in methods and schema.
# ChangeProgressStageStatusesType usage example
from mypy_boto3_osis.literals import ChangeProgressStageStatusesType
def get_value() -> ChangeProgressStageStatusesType:
return "COMPLETED"
- ChangeProgressStageStatusesType
- ChangeProgressStatusesType
- PipelineStatusType
- VpcEndpointManagementType
- VpcEndpointServiceNameType
- OpenSearchIngestionServiceName
- ServiceName
- ResourceServiceName
- RegionName
Type definitions#
Type annotations for type definitions used in methods and schema.
- BufferOptionsTypeDef
- ChangeProgressStageTypeDef
- CloudWatchLogDestinationTypeDef
- EncryptionAtRestOptionsTypeDef
- TagTypeDef
- ResponseMetadataTypeDef
- DeletePipelineRequestRequestTypeDef
- GetPipelineBlueprintRequestRequestTypeDef
- PipelineBlueprintTypeDef
- GetPipelineChangeProgressRequestRequestTypeDef
- GetPipelineRequestRequestTypeDef
- PipelineBlueprintSummaryTypeDef
- ListPipelinesRequestRequestTypeDef
- ListTagsForResourceRequestRequestTypeDef
- PipelineDestinationTypeDef
- PipelineStatusReasonTypeDef
- ServiceVpcEndpointTypeDef
- StartPipelineRequestRequestTypeDef
- StopPipelineRequestRequestTypeDef
- UntagResourceRequestRequestTypeDef
- ValidatePipelineRequestRequestTypeDef
- ValidationMessageTypeDef
- VpcAttachmentOptionsTypeDef
- ChangeProgressStatusTypeDef
- LogPublishingOptionsTypeDef
- TagResourceRequestRequestTypeDef
- ListTagsForResourceResponseTypeDef
- GetPipelineBlueprintResponseTypeDef
- ListPipelineBlueprintsResponseTypeDef
- PipelineSummaryTypeDef
- ValidatePipelineResponseTypeDef
- VpcOptionsOutputTypeDef
- VpcOptionsTypeDef
- GetPipelineChangeProgressResponseTypeDef
- UpdatePipelineRequestRequestTypeDef
- ListPipelinesResponseTypeDef
- VpcEndpointTypeDef
- CreatePipelineRequestRequestTypeDef
- VpcOptionsUnionTypeDef
- PipelineTypeDef
- CreatePipelineResponseTypeDef
- GetPipelineResponseTypeDef
- StartPipelineResponseTypeDef
- StopPipelineResponseTypeDef
- UpdatePipelineResponseTypeDef