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, 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/
Installation¶
Usage¶
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.
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.
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.
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.
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})