Getting Started¶

Installation¶

pip install capo-kinesis-analytics-v2

Usage¶

from capo_kinesis_analytics_v2 import AsyncKinesisAnalyticsV2Client


async def main():
    async with AsyncKinesisAnalyticsV2Client() as kinesis_analytics_v2:
        # Example: call the add_application_cloud_watch_logging_option operation
        response = await kinesis_analytics_v2.add_application_cloud_watch_logging_option()
        print(response["application_arn"])

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_analytics_v2 import AsyncKinesisAnalyticsV2Client


async def main():
    async with AsyncKinesisAnalyticsV2Client() as kinesis_analytics_v2:
        # Example: paginate over list_application_operations
        async for item in kinesis_analytics_v2.iter_list_application_operations():
            print(item)

Error Handling¶

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

from capo_kinesis_analytics_v2 import AsyncKinesisAnalyticsV2Client
from capo_kinesis_analytics_v2.error import ConcurrentModificationException


async def main():
    async with AsyncKinesisAnalyticsV2Client() as kinesis_analytics_v2:
        try:
            await kinesis_analytics_v2.add_application_cloud_watch_logging_option()
        except ConcurrentModificationException 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_analytics_v2 import AsyncKinesisAnalyticsV2Client


async def main():
    async with AsyncKinesisAnalyticsV2Client() as kinesis_analytics_v2:
        # Default: 3 attempts for every operation
        response = await kinesis_analytics_v2.add_application_cloud_watch_logging_option()

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

        # Disable retries for this call
        response = await kinesis_analytics_v2.add_application_cloud_watch_logging_option(config_overrides={"retry_max_attempts": 1})