{"library":"mypy-boto3-ivs-realtime","title":"mypy-boto3-ivs-realtime","description":"mypy-boto3-ivs-realtime provides comprehensive type annotations for the AWS IVS Realtime service within the boto3 library. Currently at version 1.42.86, it is part of the mypy-boto3-builder ecosystem, which generates and releases type stubs frequently, often in sync with new boto3 releases, ensuring up-to-date type checking for AWS services.","language":"python","status":"active","last_verified":"Thu May 14","install":{"commands":["pip install mypy-boto3-ivs-realtime boto3"],"cli":null},"imports":["from mypy_boto3_ivs_realtime.client import IVSRealTimeClient","client: IVSRealTimeClient = boto3.client('ivs-realtime')"],"auth":{"required":false,"env_vars":[]},"quickstart":{"code":"import boto3\nimport os\nfrom typing import TYPE_CHECKING\n\n# Only import type stubs when type checking\nif TYPE_CHECKING:\n    from mypy_boto3_ivs_realtime.client import IVSRealTimeClient\n    from mypy_boto3_ivs_realtime.type_defs import CreateParticipantTokenResponseTypeDef\n\n\ndef get_participant_token(channel_arn: str, user_id: str) -> dict:\n    \"\"\"Generates a participant token for an IVS Real-time channel.\"\"\"\n    # Explicitly type the client for mypy to provide full benefits\n    client: 'IVSRealTimeClient' = boto3.client(\n        'ivs-realtime',\n        aws_access_key_id=os.environ.get('AWS_ACCESS_KEY_ID', ''),\n        aws_secret_access_key=os.environ.get('AWS_SECRET_ACCESS_KEY', ''),\n        region_name=os.environ.get('AWS_REGION', 'us-east-1')\n    )\n\n    response: 'CreateParticipantTokenResponseTypeDef' = client.create_participant_token(\n        channelArn=channel_arn,\n        userId=user_id\n    )\n    return response\n\n# Example usage (will not run without AWS credentials and a valid channel ARN)\nif __name__ == \"__main__\":\n    EXAMPLE_CHANNEL_ARN = os.environ.get('IVS_REALTIME_CHANNEL_ARN', 'arn:aws:ivs:us-east-1:123456789012:channel/abcdefghijkL')\n    EXAMPLE_USER_ID = 'test-user-123'\n\n    print(f\"Attempting to get participant token for channel: {EXAMPLE_CHANNEL_ARN}, user: {EXAMPLE_USER_ID}\")\n    try:\n        # This call will fail without actual AWS credentials and a valid ARN\n        token_info = get_participant_token(EXAMPLE_CHANNEL_ARN, EXAMPLE_USER_ID)\n        print(\"Successfully received token info (type-checked):\")\n        print(token_info)\n    except Exception as e:\n        print(f\"Error generating token: {e}\")\n        print(\"Please ensure AWS credentials and a valid IVS Real-time channel ARN are set as environment variables.\")","lang":"python","description":"This quickstart demonstrates how to set up an IVS Real-time client with type annotations and generate a participant token. It uses `TYPE_CHECKING` for conditional import of stubs, ensuring they are only used during type checking. The client is explicitly typed to leverage the full capabilities of `mypy-boto3-ivs-realtime`. Replace placeholder values with actual AWS credentials and a valid IVS Real-time channel ARN.","tag":null,"tag_description":null,"last_tested":"2026-04-25","results":[{"runtime":"python:3.10-alpine","exit_code":0},{"runtime":"python:3.10-slim","exit_code":0},{"runtime":"python:3.11-alpine","exit_code":0},{"runtime":"python:3.11-slim","exit_code":0},{"runtime":"python:3.12-alpine","exit_code":0},{"runtime":"python:3.12-slim","exit_code":0},{"runtime":"python:3.13-alpine","exit_code":0},{"runtime":"python:3.13-slim","exit_code":0},{"runtime":"python:3.9-alpine","exit_code":0},{"runtime":"python:3.9-slim","exit_code":0}]},"compatibility":{"tag":null,"tag_description":null,"last_tested":"2026-05-14","installed_version":"1.43.0","pypi_latest":"1.43.0","is_stale":false,"summary":{"python_range":"3.10–3.9","success_rate":50,"avg_install_s":3.7,"avg_import_s":null,"wheel_type":"wheel"},"results":[{"runtime":"python:3.10-alpine","python_version":"3.10","os_libc":"alpine (musl)","variant":"mypy-boto3-ivs-realtime","exit_code":0,"wheel_type":"wheel","failure_reason":null,"import_side_effects":"broken","install_time_s":null,"import_time_s":null,"mem_mb":null,"disk_size":"51.2M"},{"runtime":"python:3.10-alpine","python_version":"3.10","os_libc":"alpine (musl)","variant":"mypy-boto3-ivs-realtime","exit_code":1,"wheel_type":null,"failure_reason":null,"import_side_effects":null,"install_time_s":null,"import_time_s":null,"mem_mb":null,"disk_size":null},{"runtime":"python:3.10-slim","python_version":"3.10","os_libc":"slim (glibc)","variant":"mypy-boto3-ivs-realtime","exit_code":0,"wheel_type":"wheel","failure_reason":null,"import_side_effects":"broken","install_time_s":3.9,"import_time_s":null,"mem_mb":null,"disk_size":"52M"},{"runtime":"python:3.10-slim","python_version":"3.10","os_libc":"slim (glibc)","variant":"mypy-boto3-ivs-realtime","exit_code":1,"wheel_type":null,"failure_reason":null,"import_side_effects":null,"install_time_s":null,"import_time_s":null,"mem_mb":null,"disk_size":null},{"runtime":"python:3.11-alpine","python_version":"3.11","os_libc":"alpine (musl)","variant":"mypy-boto3-ivs-realtime","exit_code":0,"wheel_type":"wheel","failure_reason":null,"import_side_effects":"broken","install_time_s":null,"import_time_s":null,"mem_mb":null,"disk_size":"54.2M"},{"runtime":"python:3.11-alpine","python_version":"3.11","os_libc":"alpine (musl)","variant":"mypy-boto3-ivs-realtime","exit_code":1,"wheel_type":null,"failure_reason":null,"import_side_effects":null,"install_time_s":null,"import_time_s":null,"mem_mb":null,"disk_size":null},{"runtime":"python:3.11-slim","python_version":"3.11","os_libc":"slim (glibc)","variant":"mypy-boto3-ivs-realtime","exit_code":0,"wheel_type":"wheel","failure_reason":null,"import_side_effects":"broken","install_time_s":4,"import_time_s":null,"mem_mb":null,"disk_size":"55M"},{"runtime":"python:3.11-slim","python_version":"3.11","os_libc":"slim (glibc)","variant":"mypy-boto3-ivs-realtime","exit_code":1,"wheel_type":null,"failure_reason":null,"import_side_effects":null,"install_time_s":null,"import_time_s":null,"mem_mb":null,"disk_size":null},{"runtime":"python:3.12-alpine","python_version":"3.12","os_libc":"alpine (musl)","variant":"mypy-boto3-ivs-realtime","exit_code":0,"wheel_type":"wheel","failure_reason":null,"import_side_effects":"broken","install_time_s":null,"import_time_s":null,"mem_mb":null,"disk_size":"45.5M"},{"runtime":"python:3.12-alpine","python_version":"3.12","os_libc":"alpine (musl)","variant":"mypy-boto3-ivs-realtime","exit_code":1,"wheel_type":null,"failure_reason":null,"import_side_effects":null,"install_time_s":null,"import_time_s":null,"mem_mb":null,"disk_size":null},{"runtime":"python:3.12-slim","python_version":"3.12","os_libc":"slim (glibc)","variant":"mypy-boto3-ivs-realtime","exit_code":0,"wheel_type":"wheel","failure_reason":null,"import_side_effects":"broken","install_time_s":3.2,"import_time_s":null,"mem_mb":null,"disk_size":"46M"},{"runtime":"python:3.12-slim","python_version":"3.12","os_libc":"slim (glibc)","variant":"mypy-boto3-ivs-realtime","exit_code":1,"wheel_type":null,"failure_reason":null,"import_side_effects":null,"install_time_s":null,"import_time_s":null,"mem_mb":null,"disk_size":null},{"runtime":"python:3.13-alpine","python_version":"3.13","os_libc":"alpine (musl)","variant":"mypy-boto3-ivs-realtime","exit_code":0,"wheel_type":"wheel","failure_reason":null,"import_side_effects":"broken","install_time_s":null,"import_time_s":null,"mem_mb":null,"disk_size":"45.2M"},{"runtime":"python:3.13-alpine","python_version":"3.13","os_libc":"alpine (musl)","variant":"mypy-boto3-ivs-realtime","exit_code":1,"wheel_type":null,"failure_reason":null,"import_side_effects":null,"install_time_s":null,"import_time_s":null,"mem_mb":null,"disk_size":null},{"runtime":"python:3.13-slim","python_version":"3.13","os_libc":"slim (glibc)","variant":"mypy-boto3-ivs-realtime","exit_code":0,"wheel_type":"wheel","failure_reason":null,"import_side_effects":"broken","install_time_s":3,"import_time_s":null,"mem_mb":null,"disk_size":"46M"},{"runtime":"python:3.13-slim","python_version":"3.13","os_libc":"slim (glibc)","variant":"mypy-boto3-ivs-realtime","exit_code":1,"wheel_type":null,"failure_reason":null,"import_side_effects":null,"install_time_s":null,"import_time_s":null,"mem_mb":null,"disk_size":null},{"runtime":"python:3.9-alpine","python_version":"3.9","os_libc":"alpine (musl)","variant":"mypy-boto3-ivs-realtime","exit_code":0,"wheel_type":"wheel","failure_reason":null,"import_side_effects":"broken","install_time_s":null,"import_time_s":null,"mem_mb":null,"disk_size":"50.6M"},{"runtime":"python:3.9-alpine","python_version":"3.9","os_libc":"alpine (musl)","variant":"mypy-boto3-ivs-realtime","exit_code":1,"wheel_type":null,"failure_reason":null,"import_side_effects":null,"install_time_s":null,"import_time_s":null,"mem_mb":null,"disk_size":null},{"runtime":"python:3.9-slim","python_version":"3.9","os_libc":"slim (glibc)","variant":"mypy-boto3-ivs-realtime","exit_code":0,"wheel_type":"wheel","failure_reason":null,"import_side_effects":"broken","install_time_s":4.4,"import_time_s":null,"mem_mb":null,"disk_size":"51M"},{"runtime":"python:3.9-slim","python_version":"3.9","os_libc":"slim (glibc)","variant":"mypy-boto3-ivs-realtime","exit_code":1,"wheel_type":null,"failure_reason":null,"import_side_effects":null,"install_time_s":null,"import_time_s":null,"mem_mb":null,"disk_size":null}]}}