Type Annotations for boto3 Kinesis Video Archived Media

1.42.3 · active · verified Sat Apr 11

This library provides precise type hints for `boto3`'s `KinesisVideoArchivedMedia` client, enabling static analysis tools like MyPy. It's an integral part of the `mypy-boto3` ecosystem, which generates stubs for all AWS services. The package is frequently updated, typically aligning with `boto3` and `botocore` releases, with the current version being `1.42.3`.

Warnings

breaking Python 3.8 support was removed from `mypy-boto3` packages (including this one) starting from version 8.12.0. This package now requires Python 3.9 or newer.
Fix: Upgrade your Python environment to 3.9 or higher. For Python 3.8, use an older `mypy-boto3` builder version, but it's recommended to upgrade Python.
breaking TypeDef naming conventions changed in version 8.9.0. Some TypeDefs for method arguments might have shorter names (e.g., `*RequestRequestTypeDef` -> `*RequestTypeDef`) or have `Extra` postfixes moved. This could break explicit type annotations in existing code.
Fix: Update explicit TypeDef imports and usages in your codebase to match the new naming conventions. Refer to the `mypy-boto3` documentation or generated stubs for the exact names.
gotcha You must install the `boto3` runtime library separately. `mypy-boto3-kinesis-video-archived-media` only provides type stubs (.pyi files) for `boto3`, not the actual runtime implementation.
Fix: Ensure `boto3` is installed in your environment alongside the `mypy-boto3` stub package (e.g., `pip install boto3 mypy-boto3-kinesis-video-archived-media`).
gotcha A version mismatch between `mypy-boto3-*` stub packages and your installed `boto3`/`botocore` runtime can lead to incorrect type hints or MyPy errors. Stubs are generated for specific `boto3` versions.
Fix: Always install `boto3` and its corresponding `mypy-boto3` stub package at compatible versions. It's often best to update both simultaneously. The stub package's version number usually corresponds to the `boto3` version it types.
gotcha The service name passed to `boto3.client()` (e.g., `"kinesis-video-archived-media"`) must exactly match the service stub package's internal naming convention for correct type application. Misspellings or using an old service name will result in untyped clients.
Fix: Double-check the service string against the `boto3` documentation and the `mypy-boto3` package name (e.g., `mypy_boto3_kinesis_video_archived_media` for `"kinesis-video-archived-media"`).

Install

pip install mypy-boto3-kinesis-video-archived-media boto3 Install library and boto3

Imports

KinesisVideoArchivedMediaClient
```
from mypy_boto3_kinesis_video_archived_media import KinesisVideoArchivedMediaClient
```
The direct `boto3` import does not provide static type hints; `mypy-boto3` provides the typed client.
GetHLSStreamingSessionURLRequestRequestTypeDef
```
from mypy_boto3_kinesis_video_archived_media.type_defs import GetHLSStreamingSessionURLRequestRequestTypeDef
```
Type definitions for service requests and responses are found in the `type_defs` submodule.

Quickstart

This quickstart demonstrates how to instantiate a `boto3` client and leverage `mypy-boto3-kinesis-video-archived-media` to provide static type hints for it. The type annotations are applied at type-checking time, while the runtime behavior remains identical to standard `boto3`.

import boto3
from mypy_boto3_kinesis_video_archived_media import KinesisVideoArchivedMediaClient

# Instantiate the boto3 client normally.
# Mypy-boto3 provides the static type annotations at type-checking time.
client: KinesisVideoArchivedMediaClient = boto3.client(
    "kinesis-video-archived-media",
    region_name="us-east-1" # Ensure AWS credentials are configured (e.g., via env vars or ~/.aws/credentials)
)

# Now 'client' is statically typed as KinesisVideoArchivedMediaClient.
# MyPy will validate method calls and arguments, providing autocompletion and error checking.
# Example (uncomment to run, requires valid AWS credentials and Kinesis Video Stream):
# from mypy_boto3_kinesis_video_archived_media.type_defs import GetHLSStreamingSessionURLRequestRequestTypeDef
# request: GetHLSStreamingSessionURLRequestRequestTypeDef = {
#     "StreamName": "your-stream-name",
#     "PlaybackMode": "LIVE"
# }
# response = client.get_hls_streaming_session_url(**request)
# print(f"HLS Session URL: {response['HLSStreamingSessionURL']}")

print(f"Successfully created a typed Kinesis Video Archived Media client: {type(client)}")
print("MyPy will now provide type-checking for 'client' methods and arguments.")

view raw JSON →