Skip to content

OpenSearchIngestion module#

Index > OpenSearchIngestion

Auto-generated documentation for OpenSearchIngestion type annotations stubs module mypy-boto3-osis.

How to install#

You can generate type annotations for boto3 package locally with mypy-boto3-builder. Use uv for build isolation.

  1. Run mypy-boto3-builder in your package root directory: uvx --with 'boto3==1.40.54' mypy-boto3-builder
  2. Select boto3-stubs AWS SDK.
  3. Add OpenSearchIngestion service.
  4. 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 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")

Paginators#

Type annotations and code completion for paginators from boto3.client("osis").get_paginator("...").

# ListPipelineEndpointConnectionsPaginator usage example

from boto3.session import Session

from mypy_boto3_osis.paginator import ListPipelineEndpointConnectionsPaginator

def get_list_pipeline_endpoint_connections_paginator() -> ListPipelineEndpointConnectionsPaginator:
    return Session().client("osis").get_paginator("list_pipeline_endpoint_connections"))

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"

Type definitions#

Type annotations for type definitions used in methods and schema.