Metadata-Version: 2.4
Name: capo-kinesis-video-archived-media
Version: 0.9.0
Summary: Python SDK for AWS Kinesis Video Archived Media.
Project-URL: Homepage, https://capo-sdk.dev/
Project-URL: Documentation, https://capo-sdk.dev/services/kinesis-video-archived-media/
Project-URL: Repository, https://github.com/kap-sh/capo/tree/main/services/kinesis-video-archived-media
Project-URL: Changelog, https://github.com/kap-sh/capo/blob/main/services/kinesis-video-archived-media/CHANGELOG.md
Classifier: Development Status :: 4 - Beta
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Classifier: Programming Language :: Python :: 3.13
Classifier: Programming Language :: Python :: 3.14
Classifier: Topic :: Software Development :: Code Generators
Classifier: Typing :: Typed
Requires-Python: >=3.10
Description-Content-Type: text/markdown
License-File: LICENSE
Requires-Dist: zapros>=0.21.0
Provides-Extra: anyio
Requires-Dist: anyio>=3.0; extra == "anyio"
Provides-Extra: sso
Requires-Dist: capo-sso>=0.2.0; extra == "sso"
Requires-Dist: capo-sso-oidc>=0.2.0; extra == "sso"
Requires-Dist: capo-sts>=0.3.0; extra == "sso"
Dynamic: license-file

# capo-kinesis-video-archived-media: typed, async Python SDK for AWS Kinesis Video Archived Media

`capo-kinesis-video-archived-media` is a typed Python SDK for AWS Kinesis Video Archived Media. It has an async client, `AsyncKinesisVideoArchivedMediaClient`, for asyncio and trio, and a sync client, `KinesisVideoArchivedMediaClient`, with the same methods. Requests and responses are typed with TypedDicts, so your editor and type checker know every field.

It is part of [capo](https://capo-sdk.dev/), a community-driven alternative to boto3 and aioboto3, built on its own HTTP stack instead of botocore and generated from the official AWS Smithy models. Documentation: [https://capo-sdk.dev/services/kinesis-video-archived-media/](https://capo-sdk.dev/services/kinesis-video-archived-media/)

## Installation

```
pip install capo-kinesis-video-archived-media
```

## Usage

```python
from capo_kinesis_video_archived_media import AsyncKinesisVideoArchivedMediaClient


async def main():
    async with AsyncKinesisVideoArchivedMediaClient() as kinesis_video_archived_media:
        # Example: call the get_clip operation
        response = await kinesis_video_archived_media.get_clip()
        print(response["content_type"])
```

## Pagination

Some operations in this SDK support pagination. If the operation supports pagination it will have an `iter_` prefixed method that returns an async iterator.

```python
from capo_kinesis_video_archived_media import AsyncKinesisVideoArchivedMediaClient


async def main():
    async with AsyncKinesisVideoArchivedMediaClient() as kinesis_video_archived_media:
        # Example: paginate over get_images
        async for item in kinesis_video_archived_media.iter_get_images():
            print(item)
```

## Streaming Response

Some operations return a streaming response body. Use the operation as an async context manager and iterate over the response field to read chunks.

```python
from capo_kinesis_video_archived_media import AsyncKinesisVideoArchivedMediaClient


async def main():
    async with AsyncKinesisVideoArchivedMediaClient() as kinesis_video_archived_media:
        # Example: call get_clip and read the streaming response
        async with kinesis_video_archived_media.get_clip() as response:
            async for chunk in response["payload"]:
                print(chunk)
```

## Error Handling

The SDK raises exceptions for errors returned by the API. Catch them to handle failures gracefully.

```python
from capo_kinesis_video_archived_media import AsyncKinesisVideoArchivedMediaClient
from capo_kinesis_video_archived_media.error import ClientLimitExceededException


async def main():
    async with AsyncKinesisVideoArchivedMediaClient() as kinesis_video_archived_media:
        try:
            await kinesis_video_archived_media.get_clip()
        except ClientLimitExceededException as e:
            print(f"Error: {e}")
            print(e.data)  # additional error data
```

## Retrying

The SDK retries failed operations automatically. Retry behaviour follows the Smithy specification: errors are retried based on their `is_retryable` and `is_throttling_error` attributes. Throttling errors use a longer base delay. Network-level failures (connection errors and timeouts) are also retried. Non-retryable errors, such as client errors without the `@retryable` trait, are raised immediately without further attempts.

The number of attempts defaults to 3 and can be changed at the client level via `retry_max_attempts`, or per call via `config_overrides`.

```python
from capo_kinesis_video_archived_media import AsyncKinesisVideoArchivedMediaClient


async def main():
    async with AsyncKinesisVideoArchivedMediaClient() as kinesis_video_archived_media:
        # Default: 3 attempts for every operation
        response = await kinesis_video_archived_media.get_clip()

        # Override per operation
        response = await kinesis_video_archived_media.get_clip(config_overrides={"retry_max_attempts": 5})

        # Disable retries for this call
        response = await kinesis_video_archived_media.get_clip(config_overrides={"retry_max_attempts": 1})
```
