mypy-boto3-osis Type Annotations

1.42.3 · active · verified Sat Apr 11

Type annotations for the `boto3` OpenSearch Ingestion (OSIS) service (version 1.42.3), generated with `mypy-boto3-builder`. These stubs provide type hints for IDEs and static analyzers like Mypy and Pyright, enhancing the development experience for AWS SDK users by offering autocompletion and early error detection. The library maintains an active release cadence, typically syncing with `boto3` versions.

Warnings

breaking Starting with `mypy-boto3-builder` version 8.12.0, Python 3.8 is no longer supported for any generated `mypy-boto3-*` packages. Users must upgrade to Python 3.9 or newer.
Fix: Upgrade your Python environment to version 3.9 or higher.
breaking In `mypy-boto3-builder` version 8.9.0, there were breaking changes to TypeDef naming conventions. Specifically, TypeDefs for packed method arguments use shorter names (e.g., `CreateDistributionRequestRequestTypeDef` -> `CreateDistributionRequestTypeDef`), and conflicting `Extra` postfixes were moved (e.g., `CreateDistributionExtraRequestTypeDef` -> `CreateDistributionRequestExtraTypeDef`). While the specific names may vary per service, this change affects type hints for service-specific request/response structures.
Fix: Review your code for explicit TypeDef imports and adjust names according to the new conventions or rely on IDE autocompletion for correct names.
gotcha This package (`mypy-boto3-osis`) provides only type stubs. For the code to run, the actual `boto3` library must be installed separately. The stubs enhance the development experience but do not provide runtime functionality.
Fix: Ensure `boto3` is installed in your environment: `pip install boto3`.
gotcha As of `mypy-boto3-builder` 8.12.0, all packages migrated to PEP 561 compliance. This is generally an improvement for type checker discovery but might require tools like `mypy` or IDEs to be updated to their latest versions to correctly find and utilize the stubs, especially in complex project setups.
Fix: Ensure your type checkers (e.g., mypy, pyright) and IDEs are updated to their latest versions. If issues persist, verify `sys.path` and `mypy` configuration.
gotcha While many IDEs (like PyCharm) and `mypy` can often infer types automatically, explicit type annotations for `boto3.client()`, `session.client()`, `client.get_waiter()`, and `client.get_paginator()` calls are highly recommended, especially for VSCode users, to ensure full autocompletion and accurate type hints.
Fix: Always explicitly annotate the return type of `boto3.client()` and similar calls, e.g., `client: OSISClient = boto3.client("osis")`.

Install

pip install mypy-boto3-osis Standalone installation
pip install 'boto3-stubs[osis]' Install via boto3-stubs extras

Imports

OSISClient

from mypy_boto3_osis.client import OSISClient

ListPipelinesResponseTypeDef
```
from mypy_boto3_osis.type_defs import ListPipelinesResponseTypeDef
```
Type definitions for service responses and requests are located in `type_defs`.
OSISServiceName
```
from mypy_boto3_osis.literals import OSISServiceName
```
Literals for service names and other string-based enums improve type checking for arguments.

Quickstart

This quickstart demonstrates how to initialize a type-hinted `boto3` OpenSearch Ingestion client and call `list_pipelines`. The `OSISClient` and `ListPipelinesResponseTypeDef` provide static type checking and autocompletion for method calls and response structures.

import boto3
from mypy_boto3_osis.client import OSISClient
from mypy_boto3_osis.type_defs import ListPipelinesResponseTypeDef

# A boto3 session, typically configured via environment variables or AWS CLI
# For quickstart, we assume default configuration or minimal environment setup.
# Ensure AWS_ACCESS_KEY_ID, AWS_SECRET_ACCESS_KEY, AWS_REGION are set in env if not using default profile.

def get_osis_pipelines() -> ListPipelinesResponseTypeDef:
    # Initialize the boto3 client with type annotations
    client: OSISClient = boto3.client("osis")
    
    # Use a type-hinted client
    response: ListPipelinesResponseTypeDef = client.list_pipelines()
    
    print(f"Found {len(response.get('Pipelines', []))} OSIS pipelines.")
    for pipeline in response.get('Pipelines', []):
        print(f"  - {pipeline.get('PipelineName')}")
        
    return response

if __name__ == "__main__":
    try:
        get_osis_pipelines()
    except Exception as e:
        print(f"An error occurred: {e}")
        print("Ensure 'boto3' is installed and AWS credentials/region are configured.")

view raw JSON →