Skip to content

OpenSearchIngestion module#

Index > OpenSearchIngestion

Auto-generated documentation for OpenSearchIngestion type annotations stubs module types-aiobotocore-osis.

How to install#

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

  1. Run mypy-boto3-builder in your package root directory: uvx --with 'aiobotocore==2.25.0' mypy-boto3-builder
  2. Select aiobotocore AWS SDK.
  3. Add OpenSearchIngestion service.
  4. Use provided commands to install generated packages.

From PyPI with pip#

Install types-aiobotocore for OpenSearchIngestion service.

# install with aiobotocore type annotations
python -m pip install 'types-aiobotocore[osis]'

# Lite version does not provide session.client/resource overloads
# it is more RAM-friendly, but requires explicit type annotations
python -m pip install 'types-aiobotocore-lite[osis]'

# standalone installation
python -m pip install types-aiobotocore-osis

How to uninstall#

python -m pip uninstall -y types-aiobotocore-osis

Usage#

Code samples can be found in Examples.

OpenSearchIngestionClient#

Type annotations and code completion for session.create_client("osis") as OpenSearchIngestionClient boto3 documentation

# OpenSearchIngestionClient usage example

from aiobotocore.session import get_session

from types_aiobotocore_osis.client import OpenSearchIngestionClient


session = get_session()
async with session.create_client("osis") as client:
    client: OpenSearchIngestionClient

Paginators#

Type annotations and code completion for paginators from session.create_client("osis").get_paginator("...").

# ListPipelineEndpointConnectionsPaginator usage example

from types_aiobotocore_osis.paginator import ListPipelineEndpointConnectionsPaginator

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

Literals#

Type annotations for literals used in methods and schema.

# ChangeProgressStageStatusesType usage example

from types_aiobotocore_osis.literals import ChangeProgressStageStatusesType

def get_value() -> ChangeProgressStageStatusesType:
    return "COMPLETED"

Type definitions#

Type annotations for type definitions used in methods and schema.