././@PaxHeader
0000000
0000000
0000000
00000000034
00000000000
010212
28 mtime=1740435171.0025089
mypy_boto3_ivs-1.37.0/
0000755
0001751
0000166
00000000000
14757167343
014213
00runner
docker
././@PaxHeader
0000000
0000000
0000000
00000000026
00000000000
010213
22 mtime=1740435032.0
mypy_boto3_ivs-1.37.0/LICENSE
0000644
0001751
0000166
00000002056
14757167130
015215
00runner
docker
MIT License
Copyright (c) 2025 Vlad Emelianov
Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.
././@PaxHeader
0000000
0000000
0000000
00000000033
00000000000
010211
27 mtime=1740435171.001509
mypy_boto3_ivs-1.37.0/PKG-INFO
0000644
0001751
0000166
00000035552
14757167343
015322
00runner
docker
Metadata-Version: 2.2
Name: mypy-boto3-ivs
Version: 1.37.0
Summary: Type annotations for boto3 IVS 1.37.0 service generated with mypy-boto3-builder 8.9.2
Home-page: https://github.com/youtype/mypy_boto3_builder
Author: Vlad Emelianov
Author-email: vlad.emelianov.nz@gmail.com
License: MIT License
Project-URL: Documentation, https://youtype.github.io/boto3_stubs_docs/mypy_boto3_ivs/
Project-URL: Source, https://github.com/youtype/mypy_boto3_builder
Project-URL: Tracker, https://github.com/youtype/mypy_boto3_builder/issues
Keywords: boto3 ivs boto3-stubs type-annotations mypy typeshed autocomplete
Classifier: Development Status :: 5 - Production/Stable
Classifier: Intended Audience :: Developers
Classifier: Environment :: Console
Classifier: License :: OSI Approved :: MIT License
Classifier: Natural Language :: English
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.8
Classifier: Programming Language :: Python :: 3.9
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: Programming Language :: Python :: 3 :: Only
Classifier: Programming Language :: Python :: Implementation :: CPython
Classifier: Typing :: Stubs Only
Requires-Python: >=3.8
Description-Content-Type: text/markdown
License-File: LICENSE
Requires-Dist: typing-extensions; python_version < "3.12"
Dynamic: author
Dynamic: author-email
Dynamic: classifier
Dynamic: description
Dynamic: description-content-type
Dynamic: home-page
Dynamic: keywords
Dynamic: license
Dynamic: project-url
Dynamic: requires-dist
Dynamic: requires-python
Dynamic: summary
<a id="mypy-boto3-ivs"></a>
# mypy-boto3-ivs
[](https://pypi.org/project/mypy-boto3-ivs/)
[](https://pypi.org/project/mypy-boto3-ivs/)
[](https://youtype.github.io/boto3_stubs_docs/)
[](https://pypistats.org/packages/mypy-boto3-ivs)
Type annotations for [boto3 IVS 1.37.0](https://pypi.org/project/boto3/)
compatible with [VSCode](https://code.visualstudio.com/),
[PyCharm](https://www.jetbrains.com/pycharm/),
[Emacs](https://www.gnu.org/software/emacs/),
[Sublime Text](https://www.sublimetext.com/),
[mypy](https://github.com/python/mypy),
[pyright](https://github.com/microsoft/pyright) and other tools.
Generated with
[mypy-boto3-builder 8.9.2](https://github.com/youtype/mypy_boto3_builder).
More information can be found on
[boto3-stubs](https://pypi.org/project/boto3-stubs/) page and in
[mypy-boto3-ivs docs](https://youtype.github.io/boto3_stubs_docs/mypy_boto3_ivs/).
See how it helps you find and fix potential bugs:
- [mypy-boto3-ivs](#mypy-boto3-ivs)
- [How to install](#how-to-install)
- [Generate locally (recommended)](<#generate-locally-(recommended)>)
- [VSCode extension](#vscode-extension)
- [From PyPI with pip](#from-pypi-with-pip)
- [How to uninstall](#how-to-uninstall)
- [Usage](#usage)
- [VSCode](#vscode)
- [PyCharm](#pycharm)
- [Emacs](#emacs)
- [Sublime Text](#sublime-text)
- [Other IDEs](#other-ides)
- [mypy](#mypy)
- [pyright](#pyright)
- [Pylint compatibility](#pylint-compatibility)
- [Explicit type annotations](#explicit-type-annotations)
- [Client annotations](#client-annotations)
- [Paginators annotations](#paginators-annotations)
- [Literals](#literals)
- [Type definitions](#type-definitions)
- [How it works](#how-it-works)
- [What's new](#what's-new)
- [Implemented features](#implemented-features)
- [Latest changes](#latest-changes)
- [Versioning](#versioning)
- [Thank you](#thank-you)
- [Documentation](#documentation)
- [Support and contributing](#support-and-contributing)
<a id="how-to-install"></a>
## How to install
<a id="generate-locally-(recommended)"></a>
### Generate locally (recommended)
You can generate type annotations for `boto3` package locally with
`mypy-boto3-builder`. Use
[uv](https://docs.astral.sh/uv/getting-started/installation/) for build
isolation.
1. Run mypy-boto3-builder in your package root directory:
`uvx --with 'boto3==1.37.0' mypy-boto3-builder`
2. Select `boto3-stubs` AWS SDK.
3. Add `IVS` service.
4. Use provided commands to install generated packages.
<a id="vscode-extension"></a>
### VSCode extension
[AWS Boto3](https://marketplace.visualstudio.com/items?itemName=Boto3typed.boto3-ide)
extension to your VSCode and run `AWS boto3: Quick Start` command.
Click `Modify` and select `boto3 common` and `IVS`.
<a id="from-pypi-with-pip"></a>
### From PyPI with pip
Install `boto3-stubs` for `IVS` service.
```bash
# install with boto3 type annotations
python -m pip install 'boto3-stubs[ivs]'
# Lite version does not provide session.client/resource overloads
# it is more RAM-friendly, but requires explicit type annotations
python -m pip install 'boto3-stubs-lite[ivs]'
# standalone installation
python -m pip install mypy-boto3-ivs
<a id="how-to-uninstall"></a>
## How to uninstall
```bash
python -m pip uninstall -y mypy-boto3-ivs
<a id="usage"></a>
## Usage
<a id="vscode"></a>
### VSCode
- Install
[Python extension](https://marketplace.visualstudio.com/items?itemName=ms-python.python)
- Install
[Pylance extension](https://marketplace.visualstudio.com/items?itemName=ms-python.vscode-pylance)
- Set `Pylance` as your Python Language Server
- Install `boto3-stubs[ivs]` in your environment:
```bash
python -m pip install 'boto3-stubs[ivs]'
Both type checking and code completion should now work. No explicit type
annotations required, write your `boto3` code as usual.
<a id="pycharm"></a>
### PyCharm
Due to slow PyCharm performance on `Literal` overloads (issue
> [PY-40997](https://youtrack.jetbrains.com/issue/PY-40997)), it is recommended
> to use [boto3-stubs-lite](https://pypi.org/project/boto3-stubs-lite/) until
> the issue is resolved.
If you experience slow performance and high CPU usage, try to disable
> `PyCharm` type checker and use [mypy](https://github.com/python/mypy) or
> [pyright](https://github.com/microsoft/pyright) instead.
To continue using `PyCharm` type checker, you can try to replace
> `boto3-stubs` with
> [boto3-stubs-lite](https://pypi.org/project/boto3-stubs-lite/):
```bash
pip uninstall boto3-stubs
pip install boto3-stubs-lite
Install `boto3-stubs[ivs]` in your environment:
```bash
python -m pip install 'boto3-stubs[ivs]'
Both type checking and code completion should now work.
<a id="emacs"></a>
### Emacs
- Install `boto3-stubs` with services you use in your environment:
```bash
python -m pip install 'boto3-stubs[ivs]'
- Install [use-package](https://github.com/jwiegley/use-package),
[lsp](https://github.com/emacs-lsp/lsp-mode/),
[company](https://github.com/company-mode/company-mode) and
[flycheck](https://github.com/flycheck/flycheck) packages
- Install [lsp-pyright](https://github.com/emacs-lsp/lsp-pyright) package
```elisp
(use-package lsp-pyright
:ensure t
:hook (python-mode . (lambda ()
(require 'lsp-pyright)
(lsp))) ; or lsp-deferred
:init (when (executable-find "python3")
(setq lsp-pyright-python-executable-cmd "python3"))
- Make sure emacs uses the environment where you have installed `boto3-stubs`
Type checking should now work. No explicit type annotations required, write
your `boto3` code as usual.
<a id="sublime-text"></a>
### Sublime Text
- Install `boto3-stubs[ivs]` with services you use in your environment:
```bash
python -m pip install 'boto3-stubs[ivs]'
- Install [LSP-pyright](https://github.com/sublimelsp/LSP-pyright) package
Type checking should now work. No explicit type annotations required, write
your `boto3` code as usual.
<a id="other-ides"></a>
### Other IDEs
Not tested, but as long as your IDE supports `mypy` or `pyright`, everything
should work.
<a id="mypy"></a>
### mypy
- Install `mypy`: `python -m pip install mypy`
- Install `boto3-stubs[ivs]` in your environment:
```bash
python -m pip install 'boto3-stubs[ivs]'
Type checking should now work. No explicit type annotations required, write
your `boto3` code as usual.
<a id="pyright"></a>
### pyright
- Install `pyright`: `npm i -g pyright`
- Install `boto3-stubs[ivs]` in your environment:
```bash
python -m pip install 'boto3-stubs[ivs]'
Optionally, you can install `boto3-stubs` to `typings` directory.
Type checking should now work. No explicit type annotations required, write
your `boto3` code as usual.
<a id="pylint-compatibility"></a>
### Pylint compatibility
It is totally safe to use `TYPE_CHECKING` flag in order to avoid
`mypy-boto3-ivs` dependency in production. However, there is an issue in
`pylint` that it complains about undefined variables. To fix it, set all types
to `object` in non-`TYPE_CHECKING` mode.
```python
from typing import TYPE_CHECKING
if TYPE_CHECKING:
from mypy_boto3_ec2 import EC2Client, EC2ServiceResource
from mypy_boto3_ec2.waiters import BundleTaskCompleteWaiter
from mypy_boto3_ec2.paginators import DescribeVolumesPaginator
EC2Client = object
EC2ServiceResource = object
BundleTaskCompleteWaiter = object
DescribeVolumesPaginator = object
<a id="explicit-type-annotations"></a>
## Explicit type annotations
<a id="client-annotations"></a>
### Client annotations
`IVSClient` provides annotations for `boto3.client("ivs")`.
```python
from boto3.session import Session
from mypy_boto3_ivs import IVSClient
client: IVSClient = Session().client("ivs")
# now client usage is checked by mypy and IDE should provide code completion
<a id="paginators-annotations"></a>
### Paginators annotations
`mypy_boto3_ivs.paginator` module contains type annotations for all paginators.
```python
from boto3.session import Session
from mypy_boto3_ivs import IVSClient
from mypy_boto3_ivs.paginator import (
ListChannelsPaginator,
ListPlaybackKeyPairsPaginator,
ListRecordingConfigurationsPaginator,
ListStreamKeysPaginator,
ListStreamsPaginator,
client: IVSClient = Session().client("ivs")
# Explicit type annotations are optional here
# Types should be correctly discovered by mypy and IDEs
list_channels_paginator: ListChannelsPaginator = client.get_paginator("list_channels")
list_playback_key_pairs_paginator: ListPlaybackKeyPairsPaginator = client.get_paginator(
"list_playback_key_pairs"
list_recording_configurations_paginator: ListRecordingConfigurationsPaginator = (
client.get_paginator("list_recording_configurations")
list_stream_keys_paginator: ListStreamKeysPaginator = client.get_paginator("list_stream_keys")
list_streams_paginator: ListStreamsPaginator = client.get_paginator("list_streams")
<a id="literals"></a>
### Literals
`mypy_boto3_ivs.literals` module contains literals extracted from shapes that
can be used in user code for type checking.
Full list of `IVS` Literals can be found in
[docs](https://youtype.github.io/boto3_stubs_docs/mypy_boto3_ivs/literals/).
```python
from mypy_boto3_ivs.literals import ChannelLatencyModeType
def check_value(value: ChannelLatencyModeType) -> bool: ...
<a id="type-definitions"></a>
### Type definitions
`mypy_boto3_ivs.type_defs` module contains structures and shapes assembled to
typed dictionaries and unions for additional type checking.
Full list of `IVS` TypeDefs can be found in
[docs](https://youtype.github.io/boto3_stubs_docs/mypy_boto3_ivs/type_defs/).
```python
# TypedDict usage example
from mypy_boto3_ivs.type_defs import AudioConfigurationTypeDef
def get_value() -> AudioConfigurationTypeDef:
return {
"channels": ...,
<a id="how-it-works"></a>
## How it works
Fully automated
[mypy-boto3-builder](https://github.com/youtype/mypy_boto3_builder) carefully
generates type annotations for each service, patiently waiting for `boto3`
updates. It delivers drop-in type annotations for you and makes sure that:
- All available `boto3` services are covered.
- Each public class and method of every `boto3` service gets valid type
annotations extracted from `botocore` schemas.
- Type annotations include up-to-date documentation.
- Link to documentation is provided for every method.
- Code is processed by [ruff](https://docs.astral.sh/ruff/) for readability.
<a id="what's-new"></a>
## What's new
<a id="implemented-features"></a>
### Implemented features
- Fully type annotated `boto3`, `botocore`, `aiobotocore` and `aioboto3`
libraries
- `mypy`, `pyright`, `VSCode`, `PyCharm`, `Sublime Text` and `Emacs`
compatibility
- `Client`, `ServiceResource`, `Resource`, `Waiter` `Paginator` type
annotations for each service
- Generated `TypeDefs` for each service
- Generated `Literals` for each service
- Auto discovery of types for `boto3.client` and `boto3.resource` calls
- Auto discovery of types for `session.client` and `session.resource` calls
- Auto discovery of types for `client.get_waiter` and `client.get_paginator`
calls
- Auto discovery of types for `ServiceResource` and `Resource` collections
- Auto discovery of types for `aiobotocore.Session.create_client` calls
<a id="latest-changes"></a>
### Latest changes
Builder changelog can be found in
[Releases](https://github.com/youtype/mypy_boto3_builder/releases).
<a id="versioning"></a>
## Versioning
`mypy-boto3-ivs` version is the same as related `boto3` version and follows
[Python Packaging version specifiers](https://packaging.python.org/en/latest/specifications/version-specifiers/).
<a id="thank-you"></a>
## Thank you
- [Allie Fitter](https://github.com/alliefitter) for
[boto3-type-annotations](https://pypi.org/project/boto3-type-annotations/),
this package is based on top of his work
- [black](https://github.com/psf/black) developers for an awesome formatting
tool
- [Timothy Edmund Crosley](https://github.com/timothycrosley) for
[isort](https://github.com/PyCQA/isort) and how flexible it is
- [mypy](https://github.com/python/mypy) developers for doing all dirty work
for us
- [pyright](https://github.com/microsoft/pyright) team for the new era of typed
Python
<a id="documentation"></a>
## Documentation
All services type annotations can be found in
[boto3 docs](https://youtype.github.io/boto3_stubs_docs/mypy_boto3_ivs/)
<a id="support-and-contributing"></a>
## Support and contributing
This package is auto-generated. Please reports any bugs or request new features
in [mypy-boto3-builder](https://github.com/youtype/mypy_boto3_builder/issues/)
repository.
././@PaxHeader
0000000
0000000
0000000
00000000026
00000000000
010213
22 mtime=1740435032.0
mypy_boto3_ivs-1.37.0/README.md
0000644
0001751
0000166
00000032076
14757167130
015474
00runner
docker
<a id="mypy-boto3-ivs"></a>
# mypy-boto3-ivs
[](https://pypi.org/project/mypy-boto3-ivs/)
[](https://pypi.org/project/mypy-boto3-ivs/)
[](https://youtype.github.io/boto3_stubs_docs/)
[](https://pypistats.org/packages/mypy-boto3-ivs)
Type annotations for [boto3 IVS 1.37.0](https://pypi.org/project/boto3/)
compatible with [VSCode](https://code.visualstudio.com/),
[PyCharm](https://www.jetbrains.com/pycharm/),
[Emacs](https://www.gnu.org/software/emacs/),
[Sublime Text](https://www.sublimetext.com/),
[mypy](https://github.com/python/mypy),
[pyright](https://github.com/microsoft/pyright) and other tools.
Generated with
[mypy-boto3-builder 8.9.2](https://github.com/youtype/mypy_boto3_builder).
More information can be found on
[boto3-stubs](https://pypi.org/project/boto3-stubs/) page and in
[mypy-boto3-ivs docs](https://youtype.github.io/boto3_stubs_docs/mypy_boto3_ivs/).
See how it helps you find and fix potential bugs:
- [mypy-boto3-ivs](#mypy-boto3-ivs)
- [How to install](#how-to-install)
- [Generate locally (recommended)](<#generate-locally-(recommended)>)
- [VSCode extension](#vscode-extension)
- [From PyPI with pip](#from-pypi-with-pip)
- [How to uninstall](#how-to-uninstall)
- [Usage](#usage)
- [VSCode](#vscode)
- [PyCharm](#pycharm)
- [Emacs](#emacs)
- [Sublime Text](#sublime-text)
- [Other IDEs](#other-ides)
- [mypy](#mypy)
- [pyright](#pyright)
- [Pylint compatibility](#pylint-compatibility)
- [Explicit type annotations](#explicit-type-annotations)
- [Client annotations](#client-annotations)
- [Paginators annotations](#paginators-annotations)
- [Literals](#literals)
- [Type definitions](#type-definitions)
- [How it works](#how-it-works)
- [What's new](#what's-new)
- [Implemented features](#implemented-features)
- [Latest changes](#latest-changes)
- [Versioning](#versioning)
- [Thank you](#thank-you)
- [Documentation](#documentation)
- [Support and contributing](#support-and-contributing)
<a id="how-to-install"></a>
## How to install
<a id="generate-locally-(recommended)"></a>
### Generate locally (recommended)
You can generate type annotations for `boto3` package locally with
`mypy-boto3-builder`. Use
[uv](https://docs.astral.sh/uv/getting-started/installation/) for build
isolation.
1. Run mypy-boto3-builder in your package root directory:
`uvx --with 'boto3==1.37.0' mypy-boto3-builder`
2. Select `boto3-stubs` AWS SDK.
3. Add `IVS` service.
4. Use provided commands to install generated packages.
<a id="vscode-extension"></a>
### VSCode extension
[AWS Boto3](https://marketplace.visualstudio.com/items?itemName=Boto3typed.boto3-ide)
extension to your VSCode and run `AWS boto3: Quick Start` command.
Click `Modify` and select `boto3 common` and `IVS`.
<a id="from-pypi-with-pip"></a>
### From PyPI with pip
Install `boto3-stubs` for `IVS` service.
```bash
# install with boto3 type annotations
python -m pip install 'boto3-stubs[ivs]'
# Lite version does not provide session.client/resource overloads
# it is more RAM-friendly, but requires explicit type annotations
python -m pip install 'boto3-stubs-lite[ivs]'
# standalone installation
python -m pip install mypy-boto3-ivs
<a id="how-to-uninstall"></a>
## How to uninstall
```bash
python -m pip uninstall -y mypy-boto3-ivs
<a id="usage"></a>
## Usage
<a id="vscode"></a>
### VSCode
- Install
[Python extension](https://marketplace.visualstudio.com/items?itemName=ms-python.python)
- Install
[Pylance extension](https://marketplace.visualstudio.com/items?itemName=ms-python.vscode-pylance)
- Set `Pylance` as your Python Language Server
- Install `boto3-stubs[ivs]` in your environment:
```bash
python -m pip install 'boto3-stubs[ivs]'
Both type checking and code completion should now work. No explicit type
annotations required, write your `boto3` code as usual.
<a id="pycharm"></a>
### PyCharm
Due to slow PyCharm performance on `Literal` overloads (issue
> [PY-40997](https://youtrack.jetbrains.com/issue/PY-40997)), it is recommended
> to use [boto3-stubs-lite](https://pypi.org/project/boto3-stubs-lite/) until
> the issue is resolved.
If you experience slow performance and high CPU usage, try to disable
> `PyCharm` type checker and use [mypy](https://github.com/python/mypy) or
> [pyright](https://github.com/microsoft/pyright) instead.
To continue using `PyCharm` type checker, you can try to replace
> `boto3-stubs` with
> [boto3-stubs-lite](https://pypi.org/project/boto3-stubs-lite/):
```bash
pip uninstall boto3-stubs
pip install boto3-stubs-lite
Install `boto3-stubs[ivs]` in your environment:
```bash
python -m pip install 'boto3-stubs[ivs]'
Both type checking and code completion should now work.
<a id="emacs"></a>
### Emacs
- Install `boto3-stubs` with services you use in your environment:
```bash
python -m pip install 'boto3-stubs[ivs]'
- Install [use-package](https://github.com/jwiegley/use-package),
[lsp](https://github.com/emacs-lsp/lsp-mode/),
[company](https://github.com/company-mode/company-mode) and
[flycheck](https://github.com/flycheck/flycheck) packages
- Install [lsp-pyright](https://github.com/emacs-lsp/lsp-pyright) package
```elisp
(use-package lsp-pyright
:ensure t
:hook (python-mode . (lambda ()
(require 'lsp-pyright)
(lsp))) ; or lsp-deferred
:init (when (executable-find "python3")
(setq lsp-pyright-python-executable-cmd "python3"))
- Make sure emacs uses the environment where you have installed `boto3-stubs`
Type checking should now work. No explicit type annotations required, write
your `boto3` code as usual.
<a id="sublime-text"></a>
### Sublime Text
- Install `boto3-stubs[ivs]` with services you use in your environment:
```bash
python -m pip install 'boto3-stubs[ivs]'
- Install [LSP-pyright](https://github.com/sublimelsp/LSP-pyright) package
Type checking should now work. No explicit type annotations required, write
your `boto3` code as usual.
<a id="other-ides"></a>
### Other IDEs
Not tested, but as long as your IDE supports `mypy` or `pyright`, everything
should work.
<a id="mypy"></a>
### mypy
- Install `mypy`: `python -m pip install mypy`
- Install `boto3-stubs[ivs]` in your environment:
```bash
python -m pip install 'boto3-stubs[ivs]'
Type checking should now work. No explicit type annotations required, write
your `boto3` code as usual.
<a id="pyright"></a>
### pyright
- Install `pyright`: `npm i -g pyright`
- Install `boto3-stubs[ivs]` in your environment:
```bash
python -m pip install 'boto3-stubs[ivs]'
Optionally, you can install `boto3-stubs` to `typings` directory.
Type checking should now work. No explicit type annotations required, write
your `boto3` code as usual.
<a id="pylint-compatibility"></a>
### Pylint compatibility
It is totally safe to use `TYPE_CHECKING` flag in order to avoid
`mypy-boto3-ivs` dependency in production. However, there is an issue in
`pylint` that it complains about undefined variables. To fix it, set all types
to `object` in non-`TYPE_CHECKING` mode.
```python
from typing import TYPE_CHECKING
if TYPE_CHECKING:
from mypy_boto3_ec2 import EC2Client, EC2ServiceResource
from mypy_boto3_ec2.waiters import BundleTaskCompleteWaiter
from mypy_boto3_ec2.paginators import DescribeVolumesPaginator
EC2Client = object
EC2ServiceResource = object
BundleTaskCompleteWaiter = object
DescribeVolumesPaginator = object
<a id="explicit-type-annotations"></a>
## Explicit type annotations
<a id="client-annotations"></a>
### Client annotations
`IVSClient` provides annotations for `boto3.client("ivs")`.
```python
from boto3.session import Session
from mypy_boto3_ivs import IVSClient
client: IVSClient = Session().client("ivs")
# now client usage is checked by mypy and IDE should provide code completion
<a id="paginators-annotations"></a>
### Paginators annotations
`mypy_boto3_ivs.paginator` module contains type annotations for all paginators.
```python
from boto3.session import Session
from mypy_boto3_ivs import IVSClient
from mypy_boto3_ivs.paginator import (
ListChannelsPaginator,
ListPlaybackKeyPairsPaginator,
ListRecordingConfigurationsPaginator,
ListStreamKeysPaginator,
ListStreamsPaginator,
client: IVSClient = Session().client("ivs")
# Explicit type annotations are optional here
# Types should be correctly discovered by mypy and IDEs
list_channels_paginator: ListChannelsPaginator = client.get_paginator("list_channels")
list_playback_key_pairs_paginator: ListPlaybackKeyPairsPaginator = client.get_paginator(
"list_playback_key_pairs"
list_recording_configurations_paginator: ListRecordingConfigurationsPaginator = (
client.get_paginator("list_recording_configurations")
list_stream_keys_paginator: ListStreamKeysPaginator = client.get_paginator("list_stream_keys")
list_streams_paginator: ListStreamsPaginator = client.get_paginator("list_streams")
<a id="literals"></a>
### Literals
`mypy_boto3_ivs.literals` module contains literals extracted from shapes that
can be used in user code for type checking.
Full list of `IVS` Literals can be found in
[docs](https://youtype.github.io/boto3_stubs_docs/mypy_boto3_ivs/literals/).
```python
from mypy_boto3_ivs.literals import ChannelLatencyModeType
def check_value(value: ChannelLatencyModeType) -> bool: ...
<a id="type-definitions"></a>
### Type definitions
`mypy_boto3_ivs.type_defs` module contains structures and shapes assembled to
typed dictionaries and unions for additional type checking.
Full list of `IVS` TypeDefs can be found in
[docs](https://youtype.github.io/boto3_stubs_docs/mypy_boto3_ivs/type_defs/).
```python
# TypedDict usage example
from mypy_boto3_ivs.type_defs import AudioConfigurationTypeDef
def get_value() -> AudioConfigurationTypeDef:
return {
"channels": ...,
<a id="how-it-works"></a>
## How it works
Fully automated
[mypy-boto3-builder](https://github.com/youtype/mypy_boto3_builder) carefully
generates type annotations for each service, patiently waiting for `boto3`
updates. It delivers drop-in type annotations for you and makes sure that:
- All available `boto3` services are covered.
- Each public class and method of every `boto3` service gets valid type
annotations extracted from `botocore` schemas.
- Type annotations include up-to-date documentation.
- Link to documentation is provided for every method.
- Code is processed by [ruff](https://docs.astral.sh/ruff/) for readability.
<a id="what's-new"></a>
## What's new
<a id="implemented-features"></a>
### Implemented features
- Fully type annotated `boto3`, `botocore`, `aiobotocore` and `aioboto3`
libraries
- `mypy`, `pyright`, `VSCode`, `PyCharm`, `Sublime Text` and `Emacs`
compatibility
- `Client`, `ServiceResource`, `Resource`, `Waiter` `Paginator` type
annotations for each service
- Generated `TypeDefs` for each service
- Generated `Literals` for each service
- Auto discovery of types for `boto3.client` and `boto3.resource` calls
- Auto discovery of types for `session.client` and `session.resource` calls
- Auto discovery of types for `client.get_waiter` and `client.get_paginator`
calls
- Auto discovery of types for `ServiceResource` and `Resource` collections
- Auto discovery of types for `aiobotocore.Session.create_client` calls
<a id="latest-changes"></a>
### Latest changes
Builder changelog can be found in
[Releases](https://github.com/youtype/mypy_boto3_builder/releases).
<a id="versioning"></a>
## Versioning
`mypy-boto3-ivs` version is the same as related `boto3` version and follows
[Python Packaging version specifiers](https://packaging.python.org/en/latest/specifications/version-specifiers/).
<a id="thank-you"></a>
## Thank you
- [Allie Fitter](https://github.com/alliefitter) for
[boto3-type-annotations](https://pypi.org/project/boto3-type-annotations/),
this package is based on top of his work
- [black](https://github.com/psf/black) developers for an awesome formatting
tool
- [Timothy Edmund Crosley](https://github.com/timothycrosley) for
[isort](https://github.com/PyCQA/isort) and how flexible it is
- [mypy](https://github.com/python/mypy) developers for doing all dirty work
for us
- [pyright](https://github.com/microsoft/pyright) team for the new era of typed
Python
<a id="documentation"></a>
## Documentation
All services type annotations can be found in
[boto3 docs](https://youtype.github.io/boto3_stubs_docs/mypy_boto3_ivs/)
<a id="support-and-contributing"></a>
## Support and contributing
This package is auto-generated. Please reports any bugs or request new features
in [mypy-boto3-builder](https://github.com/youtype/mypy_boto3_builder/issues/)
repository.
././@PaxHeader
0000000
0000000
0000000
00000000034
00000000000
010212
28 mtime=1740435171.0005088
mypy_boto3_ivs-1.37.0/mypy_boto3_ivs/
0000755
0001751
0000166
00000000000
14757167343
017200
00runner
docker
././@PaxHeader
0000000
0000000
0000000
00000000026
00000000000
010213
22 mtime=1740435032.0
mypy_boto3_ivs-1.37.0/mypy_boto3_ivs/__init__.py
0000644
0001751
0000166
00000002773
14757167130
021314
00runner
docker
Main interface for ivs service.
[Documentation](https://youtype.github.io/boto3_stubs_docs/mypy_boto3_ivs/)
Copyright 2025 Vlad Emelianov
Usage::
```python
from boto3.session import Session
from mypy_boto3_ivs import (
Client,
IVSClient,
ListChannelsPaginator,
ListPlaybackKeyPairsPaginator,
ListRecordingConfigurationsPaginator,
ListStreamKeysPaginator,
ListStreamsPaginator,
session = Session()
client: IVSClient = session.client("ivs")
list_channels_paginator: ListChannelsPaginator = client.get_paginator("list_channels")
list_playback_key_pairs_paginator: ListPlaybackKeyPairsPaginator = client.get_paginator("list_playback_key_pairs")
list_recording_configurations_paginator: ListRecordingConfigurationsPaginator = client.get_paginator("list_recording_configurations")
list_stream_keys_paginator: ListStreamKeysPaginator = client.get_paginator("list_stream_keys")
list_streams_paginator: ListStreamsPaginator = client.get_paginator("list_streams")
```
from .client import IVSClient
from .paginator import (
ListChannelsPaginator,
ListPlaybackKeyPairsPaginator,
ListRecordingConfigurationsPaginator,
ListStreamKeysPaginator,
ListStreamsPaginator,
Client = IVSClient
__all__ = (
"Client",
"IVSClient",
"ListChannelsPaginator",
"ListPlaybackKeyPairsPaginator",
"ListRecordingConfigurationsPaginator",
"ListStreamKeysPaginator",
"ListStreamsPaginator",
././@PaxHeader
0000000
0000000
0000000
00000000026
00000000000
010213
22 mtime=1740435032.0
mypy_boto3_ivs-1.37.0/mypy_boto3_ivs/__init__.pyi
0000644
0001751
0000166
00000002772
14757167130
021464
00runner
docker
Main interface for ivs service.
[Documentation](https://youtype.github.io/boto3_stubs_docs/mypy_boto3_ivs/)
Copyright 2025 Vlad Emelianov
Usage::
```python
from boto3.session import Session
from mypy_boto3_ivs import (
Client,
IVSClient,
ListChannelsPaginator,
ListPlaybackKeyPairsPaginator,
ListRecordingConfigurationsPaginator,
ListStreamKeysPaginator,
ListStreamsPaginator,
session = Session()
client: IVSClient = session.client("ivs")
list_channels_paginator: ListChannelsPaginator = client.get_paginator("list_channels")
list_playback_key_pairs_paginator: ListPlaybackKeyPairsPaginator = client.get_paginator("list_playback_key_pairs")
list_recording_configurations_paginator: ListRecordingConfigurationsPaginator = client.get_paginator("list_recording_configurations")
list_stream_keys_paginator: ListStreamKeysPaginator = client.get_paginator("list_stream_keys")
list_streams_paginator: ListStreamsPaginator = client.get_paginator("list_streams")
```
from .client import IVSClient
from .paginator import (
ListChannelsPaginator,
ListPlaybackKeyPairsPaginator,
ListRecordingConfigurationsPaginator,
ListStreamKeysPaginator,
ListStreamsPaginator,
Client = IVSClient
__all__ = (
"Client",
"IVSClient",
"ListChannelsPaginator",
"ListPlaybackKeyPairsPaginator",
"ListRecordingConfigurationsPaginator",
"ListStreamKeysPaginator",
"ListStreamsPaginator",
././@PaxHeader
0000000
0000000
0000000
00000000026
00000000000
010213
22 mtime=1740435032.0
mypy_boto3_ivs-1.37.0/mypy_boto3_ivs/__main__.py
0000644
0001751
0000166
00000001704
14757167130
021266
00runner
docker
Main CLI entrypoint.
Copyright 2025 Vlad Emelianov
import sys
def print_info() -> None:
"""
Print package info to stdout.
"""
sys.stdout.write(
"Type annotations for boto3 IVS 1.37.0\n"
"Version: 1.37.0\n"
"Builder version: 8.9.2\n"
"Docs: https://youtype.github.io/boto3_stubs_docs/mypy_boto3_ivs//\n"
"Boto3 docs: https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/ivs.html#ivs\n"
"Other services: https://pypi.org/project/boto3-stubs/\n"
"Changelog: https://github.com/youtype/mypy_boto3_builder/releases\n"
def print_version() -> None:
"""
Print package version to stdout.
"""
sys.stdout.write("1.37.0\n")
def main() -> None:
"""
Main CLI entrypoint.
"""
if "--version" in sys.argv:
print_version()
return
print_info()
if __name__ == "__main__":
main()
././@PaxHeader
0000000
0000000
0000000
00000000026
00000000000
010213
22 mtime=1740435032.0
mypy_boto3_ivs-1.37.0/mypy_boto3_ivs/client.py
0000644
0001751
0000166
00000064273
14757167130
021036
00runner
docker
Type annotations for ivs service Client.
[Documentation](https://youtype.github.io/boto3_stubs_docs/mypy_boto3_ivs/client/)
Copyright 2025 Vlad Emelianov
Usage::
```python
from boto3.session import Session
from mypy_boto3_ivs.client import IVSClient
session = Session()
client: IVSClient = session.client("ivs")
```
from __future__ import annotations
import sys
from typing import Any, overload
from botocore.client import BaseClient, ClientMeta
from botocore.errorfactory import BaseClientExceptions
from botocore.exceptions import ClientError as BotocoreClientError
from .paginator import (
ListChannelsPaginator,
ListPlaybackKeyPairsPaginator,
ListRecordingConfigurationsPaginator,
ListStreamKeysPaginator,
ListStreamsPaginator,
from .type_defs import (
BatchGetChannelRequestTypeDef,
BatchGetChannelResponseTypeDef,
BatchGetStreamKeyRequestTypeDef,
BatchGetStreamKeyResponseTypeDef,
BatchStartViewerSessionRevocationRequestTypeDef,
BatchStartViewerSessionRevocationResponseTypeDef,
CreateChannelRequestTypeDef,
CreateChannelResponseTypeDef,
CreatePlaybackRestrictionPolicyRequestTypeDef,
CreatePlaybackRestrictionPolicyResponseTypeDef,
CreateRecordingConfigurationRequestTypeDef,
CreateRecordingConfigurationResponseTypeDef,
CreateStreamKeyRequestTypeDef,
CreateStreamKeyResponseTypeDef,
DeleteChannelRequestTypeDef,
DeletePlaybackKeyPairRequestTypeDef,
DeletePlaybackRestrictionPolicyRequestTypeDef,
DeleteRecordingConfigurationRequestTypeDef,
DeleteStreamKeyRequestTypeDef,
EmptyResponseMetadataTypeDef,
GetChannelRequestTypeDef,
GetChannelResponseTypeDef,
GetPlaybackKeyPairRequestTypeDef,
GetPlaybackKeyPairResponseTypeDef,
GetPlaybackRestrictionPolicyRequestTypeDef,
GetPlaybackRestrictionPolicyResponseTypeDef,
GetRecordingConfigurationRequestTypeDef,
GetRecordingConfigurationResponseTypeDef,
GetStreamKeyRequestTypeDef,
GetStreamKeyResponseTypeDef,
GetStreamRequestTypeDef,
GetStreamResponseTypeDef,
GetStreamSessionRequestTypeDef,
GetStreamSessionResponseTypeDef,
ImportPlaybackKeyPairRequestTypeDef,
ImportPlaybackKeyPairResponseTypeDef,
ListChannelsRequestTypeDef,
ListChannelsResponseTypeDef,
ListPlaybackKeyPairsRequestTypeDef,
ListPlaybackKeyPairsResponseTypeDef,
ListPlaybackRestrictionPoliciesRequestTypeDef,
ListPlaybackRestrictionPoliciesResponseTypeDef,
ListRecordingConfigurationsRequestTypeDef,
ListRecordingConfigurationsResponseTypeDef,
ListStreamKeysRequestTypeDef,
ListStreamKeysResponseTypeDef,
ListStreamSessionsRequestTypeDef,
ListStreamSessionsResponseTypeDef,
ListStreamsRequestTypeDef,
ListStreamsResponseTypeDef,
ListTagsForResourceRequestTypeDef,
ListTagsForResourceResponseTypeDef,
PutMetadataRequestTypeDef,
StartViewerSessionRevocationRequestTypeDef,
StopStreamRequestTypeDef,
TagResourceRequestTypeDef,
UntagResourceRequestTypeDef,
UpdateChannelRequestTypeDef,
UpdateChannelResponseTypeDef,
UpdatePlaybackRestrictionPolicyRequestTypeDef,
UpdatePlaybackRestrictionPolicyResponseTypeDef,
if sys.version_info >= (3, 9):
from builtins import dict as Dict
from builtins import type as Type
from collections.abc import Mapping
from typing import Dict, Mapping, Type
if sys.version_info >= (3, 12):
from typing import Literal, Unpack
from typing_extensions import Literal, Unpack
__all__ = ("IVSClient",)
class Exceptions(BaseClientExceptions):
AccessDeniedException: Type[BotocoreClientError]
ChannelNotBroadcasting: Type[BotocoreClientError]
ClientError: Type[BotocoreClientError]
ConflictException: Type[BotocoreClientError]
InternalServerException: Type[BotocoreClientError]
PendingVerification: Type[BotocoreClientError]
ResourceNotFoundException: Type[BotocoreClientError]
ServiceQuotaExceededException: Type[BotocoreClientError]
StreamUnavailable: Type[BotocoreClientError]
ThrottlingException: Type[BotocoreClientError]
ValidationException: Type[BotocoreClientError]
class IVSClient(BaseClient):
"""
[Show boto3 documentation](https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/ivs.html#IVS.Client)
[Show boto3-stubs documentation](https://youtype.github.io/boto3_stubs_docs/mypy_boto3_ivs/client/)
"""
meta: ClientMeta
@property
def exceptions(self) -> Exceptions:
"""
IVSClient exceptions.
[Show boto3 documentation](https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/ivs.html#IVS.Client)
[Show boto3-stubs documentation](https://youtype.github.io/boto3_stubs_docs/mypy_boto3_ivs/client/#exceptions)
"""
def can_paginate(self, operation_name: str) -> bool:
"""
[Show boto3 documentation](https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/ivs/client/can_paginate.html)
[Show boto3-stubs documentation](https://youtype.github.io/boto3_stubs_docs/mypy_boto3_ivs/client/#can_paginate)
"""
def generate_presigned_url(
self,
ClientMethod: str,
Params: Mapping[str, Any] = ...,
ExpiresIn: int = 3600,
HttpMethod: str = ...,
) -> str:
"""
[Show boto3 documentation](https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/ivs/client/generate_presigned_url.html)
[Show boto3-stubs documentation](https://youtype.github.io/boto3_stubs_docs/mypy_boto3_ivs/client/#generate_presigned_url)
"""
def batch_get_channel(
self, **kwargs: Unpack[BatchGetChannelRequestTypeDef]
) -> BatchGetChannelResponseTypeDef:
"""
Performs <a>GetChannel</a> on multiple ARNs simultaneously.
[Show boto3 documentation](https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/ivs/client/batch_get_channel.html)
[Show boto3-stubs documentation](https://youtype.github.io/boto3_stubs_docs/mypy_boto3_ivs/client/#batch_get_channel)
"""
def batch_get_stream_key(
self, **kwargs: Unpack[BatchGetStreamKeyRequestTypeDef]
) -> BatchGetStreamKeyResponseTypeDef:
"""
Performs <a>GetStreamKey</a> on multiple ARNs simultaneously.
[Show boto3 documentation](https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/ivs/client/batch_get_stream_key.html)
[Show boto3-stubs documentation](https://youtype.github.io/boto3_stubs_docs/mypy_boto3_ivs/client/#batch_get_stream_key)
"""
def batch_start_viewer_session_revocation(
self, **kwargs: Unpack[BatchStartViewerSessionRevocationRequestTypeDef]
) -> BatchStartViewerSessionRevocationResponseTypeDef:
"""
Performs <a>StartViewerSessionRevocation</a> on multiple channel ARN and viewer
ID pairs simultaneously.
[Show boto3 documentation](https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/ivs/client/batch_start_viewer_session_revocation.html)
[Show boto3-stubs documentation](https://youtype.github.io/boto3_stubs_docs/mypy_boto3_ivs/client/#batch_start_viewer_session_revocation)
"""
def create_channel(
self, **kwargs: Unpack[CreateChannelRequestTypeDef]
) -> CreateChannelResponseTypeDef:
"""
Creates a new channel and an associated stream key to start streaming.
[Show boto3 documentation](https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/ivs/client/create_channel.html)
[Show boto3-stubs documentation](https://youtype.github.io/boto3_stubs_docs/mypy_boto3_ivs/client/#create_channel)
"""
def create_playback_restriction_policy(
self, **kwargs: Unpack[CreatePlaybackRestrictionPolicyRequestTypeDef]
) -> CreatePlaybackRestrictionPolicyResponseTypeDef:
"""
Creates a new playback restriction policy, for constraining playback by
countries and/or origins.
[Show boto3 documentation](https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/ivs/client/create_playback_restriction_policy.html)
[Show boto3-stubs documentation](https://youtype.github.io/boto3_stubs_docs/mypy_boto3_ivs/client/#create_playback_restriction_policy)
"""
def create_recording_configuration(
self, **kwargs: Unpack[CreateRecordingConfigurationRequestTypeDef]
) -> CreateRecordingConfigurationResponseTypeDef:
"""
Creates a new recording configuration, used to enable recording to Amazon S3.
[Show boto3 documentation](https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/ivs/client/create_recording_configuration.html)
[Show boto3-stubs documentation](https://youtype.github.io/boto3_stubs_docs/mypy_boto3_ivs/client/#create_recording_configuration)
"""
def create_stream_key(
self, **kwargs: Unpack[CreateStreamKeyRequestTypeDef]
) -> CreateStreamKeyResponseTypeDef:
"""
Creates a stream key, used to initiate a stream, for the specified channel ARN.
[Show boto3 documentation](https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/ivs/client/create_stream_key.html)
[Show boto3-stubs documentation](https://youtype.github.io/boto3_stubs_docs/mypy_boto3_ivs/client/#create_stream_key)
"""
def delete_channel(
self, **kwargs: Unpack[DeleteChannelRequestTypeDef]
) -> EmptyResponseMetadataTypeDef:
"""
Deletes the specified channel and its associated stream keys.
[Show boto3 documentation](https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/ivs/client/delete_channel.html)
[Show boto3-stubs documentation](https://youtype.github.io/boto3_stubs_docs/mypy_boto3_ivs/client/#delete_channel)
"""
def delete_playback_key_pair(
self, **kwargs: Unpack[DeletePlaybackKeyPairRequestTypeDef]
) -> Dict[str, Any]:
"""
Deletes a specified authorization key pair.
[Show boto3 documentation](https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/ivs/client/delete_playback_key_pair.html)
[Show boto3-stubs documentation](https://youtype.github.io/boto3_stubs_docs/mypy_boto3_ivs/client/#delete_playback_key_pair)
"""
def delete_playback_restriction_policy(
self, **kwargs: Unpack[DeletePlaybackRestrictionPolicyRequestTypeDef]
) -> EmptyResponseMetadataTypeDef:
"""
Deletes the specified playback restriction policy.
[Show boto3 documentation](https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/ivs/client/delete_playback_restriction_policy.html)
[Show boto3-stubs documentation](https://youtype.github.io/boto3_stubs_docs/mypy_boto3_ivs/client/#delete_playback_restriction_policy)
"""
def delete_recording_configuration(
self, **kwargs: Unpack[DeleteRecordingConfigurationRequestTypeDef]
) -> EmptyResponseMetadataTypeDef:
"""
Deletes the recording configuration for the specified ARN.
[Show boto3 documentation](https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/ivs/client/delete_recording_configuration.html)
[Show boto3-stubs documentation](https://youtype.github.io/boto3_stubs_docs/mypy_boto3_ivs/client/#delete_recording_configuration)
"""
def delete_stream_key(
self, **kwargs: Unpack[DeleteStreamKeyRequestTypeDef]
) -> EmptyResponseMetadataTypeDef:
"""
Deletes the stream key for the specified ARN, so it can no longer be used to
stream.
[Show boto3 documentation](https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/ivs/client/delete_stream_key.html)
[Show boto3-stubs documentation](https://youtype.github.io/boto3_stubs_docs/mypy_boto3_ivs/client/#delete_stream_key)
"""
def get_channel(self, **kwargs: Unpack[GetChannelRequestTypeDef]) -> GetChannelResponseTypeDef:
"""
Gets the channel configuration for the specified channel ARN.
[Show boto3 documentation](https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/ivs/client/get_channel.html)
[Show boto3-stubs documentation](https://youtype.github.io/boto3_stubs_docs/mypy_boto3_ivs/client/#get_channel)
"""
def get_playback_key_pair(
self, **kwargs: Unpack[GetPlaybackKeyPairRequestTypeDef]
) -> GetPlaybackKeyPairResponseTypeDef:
"""
Gets a specified playback authorization key pair and returns the
<code>arn</code> and <code>fingerprint</code>.
[Show boto3 documentation](https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/ivs/client/get_playback_key_pair.html)
[Show boto3-stubs documentation](https://youtype.github.io/boto3_stubs_docs/mypy_boto3_ivs/client/#get_playback_key_pair)
"""
def get_playback_restriction_policy(
self, **kwargs: Unpack[GetPlaybackRestrictionPolicyRequestTypeDef]
) -> GetPlaybackRestrictionPolicyResponseTypeDef:
"""
Gets the specified playback restriction policy.
[Show boto3 documentation](https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/ivs/client/get_playback_restriction_policy.html)
[Show boto3-stubs documentation](https://youtype.github.io/boto3_stubs_docs/mypy_boto3_ivs/client/#get_playback_restriction_policy)
"""
def get_recording_configuration(
self, **kwargs: Unpack[GetRecordingConfigurationRequestTypeDef]
) -> GetRecordingConfigurationResponseTypeDef:
"""
Gets the recording configuration for the specified ARN.
[Show boto3 documentation](https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/ivs/client/get_recording_configuration.html)
[Show boto3-stubs documentation](https://youtype.github.io/boto3_stubs_docs/mypy_boto3_ivs/client/#get_recording_configuration)
"""
def get_stream(self, **kwargs: Unpack[GetStreamRequestTypeDef]) -> GetStreamResponseTypeDef:
"""
Gets information about the active (live) stream on a specified channel.
[Show boto3 documentation](https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/ivs/client/get_stream.html)
[Show boto3-stubs documentation](https://youtype.github.io/boto3_stubs_docs/mypy_boto3_ivs/client/#get_stream)
"""
def get_stream_key(
self, **kwargs: Unpack[GetStreamKeyRequestTypeDef]
) -> GetStreamKeyResponseTypeDef:
"""
Gets stream-key information for a specified ARN.
[Show boto3 documentation](https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/ivs/client/get_stream_key.html)
[Show boto3-stubs documentation](https://youtype.github.io/boto3_stubs_docs/mypy_boto3_ivs/client/#get_stream_key)
"""
def get_stream_session(
self, **kwargs: Unpack[GetStreamSessionRequestTypeDef]
) -> GetStreamSessionResponseTypeDef:
"""
Gets metadata on a specified stream.
[Show boto3 documentation](https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/ivs/client/get_stream_session.html)
[Show boto3-stubs documentation](https://youtype.github.io/boto3_stubs_docs/mypy_boto3_ivs/client/#get_stream_session)
"""
def import_playback_key_pair(
self, **kwargs: Unpack[ImportPlaybackKeyPairRequestTypeDef]
) -> ImportPlaybackKeyPairResponseTypeDef:
"""
Imports the public portion of a new key pair and returns its <code>arn</code>
and <code>fingerprint</code>.
[Show boto3 documentation](https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/ivs/client/import_playback_key_pair.html)
[Show boto3-stubs documentation](https://youtype.github.io/boto3_stubs_docs/mypy_boto3_ivs/client/#import_playback_key_pair)
"""
def list_channels(
self, **kwargs: Unpack[ListChannelsRequestTypeDef]
) -> ListChannelsResponseTypeDef:
"""
Gets summary information about all channels in your account, in the Amazon Web
Services region where the API request is processed.
[Show boto3 documentation](https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/ivs/client/list_channels.html)
[Show boto3-stubs documentation](https://youtype.github.io/boto3_stubs_docs/mypy_boto3_ivs/client/#list_channels)
"""
def list_playback_key_pairs(
self, **kwargs: Unpack[ListPlaybackKeyPairsRequestTypeDef]
) -> ListPlaybackKeyPairsResponseTypeDef:
"""
Gets summary information about playback key pairs.
[Show boto3 documentation](https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/ivs/client/list_playback_key_pairs.html)
[Show boto3-stubs documentation](https://youtype.github.io/boto3_stubs_docs/mypy_boto3_ivs/client/#list_playback_key_pairs)
"""
def list_playback_restriction_policies(
self, **kwargs: Unpack[ListPlaybackRestrictionPoliciesRequestTypeDef]
) -> ListPlaybackRestrictionPoliciesResponseTypeDef:
"""
Gets summary information about playback restriction policies.
[Show boto3 documentation](https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/ivs/client/list_playback_restriction_policies.html)
[Show boto3-stubs documentation](https://youtype.github.io/boto3_stubs_docs/mypy_boto3_ivs/client/#list_playback_restriction_policies)
"""
def list_recording_configurations(
self, **kwargs: Unpack[ListRecordingConfigurationsRequestTypeDef]
) -> ListRecordingConfigurationsResponseTypeDef:
"""
Gets summary information about all recording configurations in your account, in
the Amazon Web Services region where the API request is processed.
[Show boto3 documentation](https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/ivs/client/list_recording_configurations.html)
[Show boto3-stubs documentation](https://youtype.github.io/boto3_stubs_docs/mypy_boto3_ivs/client/#list_recording_configurations)
"""
def list_stream_keys(
self, **kwargs: Unpack[ListStreamKeysRequestTypeDef]
) -> ListStreamKeysResponseTypeDef:
"""
Gets summary information about stream keys for the specified channel.
[Show boto3 documentation](https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/ivs/client/list_stream_keys.html)
[Show boto3-stubs documentation](https://youtype.github.io/boto3_stubs_docs/mypy_boto3_ivs/client/#list_stream_keys)
"""
def list_stream_sessions(
self, **kwargs: Unpack[ListStreamSessionsRequestTypeDef]
) -> ListStreamSessionsResponseTypeDef:
"""
Gets a summary of current and previous streams for a specified channel in your
account, in the AWS region where the API request is processed.
[Show boto3 documentation](https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/ivs/client/list_stream_sessions.html)
[Show boto3-stubs documentation](https://youtype.github.io/boto3_stubs_docs/mypy_boto3_ivs/client/#list_stream_sessions)
"""
def list_streams(
self, **kwargs: Unpack[ListStreamsRequestTypeDef]
) -> ListStreamsResponseTypeDef:
"""
Gets summary information about live streams in your account, in the Amazon Web
Services region where the API request is processed.
[Show boto3 documentation](https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/ivs/client/list_streams.html)
[Show boto3-stubs documentation](https://youtype.github.io/boto3_stubs_docs/mypy_boto3_ivs/client/#list_streams)
"""
def list_tags_for_resource(
self, **kwargs: Unpack[ListTagsForResourceRequestTypeDef]
) -> ListTagsForResourceResponseTypeDef:
"""
Gets information about Amazon Web Services tags for the specified ARN.
[Show boto3 documentation](https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/ivs/client/list_tags_for_resource.html)
[Show boto3-stubs documentation](https://youtype.github.io/boto3_stubs_docs/mypy_boto3_ivs/client/#list_tags_for_resource)
"""
def put_metadata(
self, **kwargs: Unpack[PutMetadataRequestTypeDef]
) -> EmptyResponseMetadataTypeDef:
"""
Inserts metadata into the active stream of the specified channel.
[Show boto3 documentation](https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/ivs/client/put_metadata.html)
[Show boto3-stubs documentation](https://youtype.github.io/boto3_stubs_docs/mypy_boto3_ivs/client/#put_metadata)
"""
def start_viewer_session_revocation(
self, **kwargs: Unpack[StartViewerSessionRevocationRequestTypeDef]
) -> Dict[str, Any]:
"""
Starts the process of revoking the viewer session associated with a specified
channel ARN and viewer ID.
[Show boto3 documentation](https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/ivs/client/start_viewer_session_revocation.html)
[Show boto3-stubs documentation](https://youtype.github.io/boto3_stubs_docs/mypy_boto3_ivs/client/#start_viewer_session_revocation)
"""
def stop_stream(self, **kwargs: Unpack[StopStreamRequestTypeDef]) -> Dict[str, Any]:
"""
Disconnects the incoming RTMPS stream for the specified channel.
[Show boto3 documentation](https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/ivs/client/stop_stream.html)
[Show boto3-stubs documentation](https://youtype.github.io/boto3_stubs_docs/mypy_boto3_ivs/client/#stop_stream)
"""
def tag_resource(self, **kwargs: Unpack[TagResourceRequestTypeDef]) -> Dict[str, Any]:
"""
Adds or updates tags for the Amazon Web Services resource with the specified
ARN.
[Show boto3 documentation](https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/ivs/client/tag_resource.html)
[Show boto3-stubs documentation](https://youtype.github.io/boto3_stubs_docs/mypy_boto3_ivs/client/#tag_resource)
"""
def untag_resource(self, **kwargs: Unpack[UntagResourceRequestTypeDef]) -> Dict[str, Any]:
"""
Removes tags from the resource with the specified ARN.
[Show boto3 documentation](https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/ivs/client/untag_resource.html)
[Show boto3-stubs documentation](https://youtype.github.io/boto3_stubs_docs/mypy_boto3_ivs/client/#untag_resource)
"""
def update_channel(
self, **kwargs: Unpack[UpdateChannelRequestTypeDef]
) -> UpdateChannelResponseTypeDef:
"""
Updates a channel's configuration.
[Show boto3 documentation](https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/ivs/client/update_channel.html)
[Show boto3-stubs documentation](https://youtype.github.io/boto3_stubs_docs/mypy_boto3_ivs/client/#update_channel)
"""
def update_playback_restriction_policy(
self, **kwargs: Unpack[UpdatePlaybackRestrictionPolicyRequestTypeDef]
) -> UpdatePlaybackRestrictionPolicyResponseTypeDef:
"""
Updates a specified playback restriction policy.
[Show boto3 documentation](https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/ivs/client/update_playback_restriction_policy.html)
[Show boto3-stubs documentation](https://youtype.github.io/boto3_stubs_docs/mypy_boto3_ivs/client/#update_playback_restriction_policy)
"""
@overload # type: ignore[override]
def get_paginator( # type: ignore[override]
self, operation_name: Literal["list_channels"]
) -> ListChannelsPaginator:
"""
Create a paginator for an operation.
[Show boto3 documentation](https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/ivs/client/get_paginator.html)
[Show boto3-stubs documentation](https://youtype.github.io/boto3_stubs_docs/mypy_boto3_ivs/client/#get_paginator)
"""
@overload # type: ignore[override]
def get_paginator( # type: ignore[override]
self, operation_name: Literal["list_playback_key_pairs"]
) -> ListPlaybackKeyPairsPaginator:
"""
Create a paginator for an operation.
[Show boto3 documentation](https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/ivs/client/get_paginator.html)
[Show boto3-stubs documentation](https://youtype.github.io/boto3_stubs_docs/mypy_boto3_ivs/client/#get_paginator)
"""
@overload # type: ignore[override]
def get_paginator( # type: ignore[override]
self, operation_name: Literal["list_recording_configurations"]
) -> ListRecordingConfigurationsPaginator:
"""
Create a paginator for an operation.
[Show boto3 documentation](https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/ivs/client/get_paginator.html)
[Show boto3-stubs documentation](https://youtype.github.io/boto3_stubs_docs/mypy_boto3_ivs/client/#get_paginator)
"""
@overload # type: ignore[override]
def get_paginator( # type: ignore[override]
self, operation_name: Literal["list_stream_keys"]
) -> ListStreamKeysPaginator:
"""
Create a paginator for an operation.
[Show boto3 documentation](https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/ivs/client/get_paginator.html)
[Show boto3-stubs documentation](https://youtype.github.io/boto3_stubs_docs/mypy_boto3_ivs/client/#get_paginator)
"""
@overload # type: ignore[override]
def get_paginator( # type: ignore[override]
self, operation_name: Literal["list_streams"]
) -> ListStreamsPaginator:
"""
Create a paginator for an operation.
[Show boto3 documentation](https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/ivs/client/get_paginator.html)
[Show boto3-stubs documentation](https://youtype.github.io/boto3_stubs_docs/mypy_boto3_ivs/client/#get_paginator)
"""
././@PaxHeader
0000000
0000000
0000000
00000000026
00000000000
010213
22 mtime=1740435032.0
mypy_boto3_ivs-1.37.0/mypy_boto3_ivs/client.pyi
0000644
0001751
0000166
00000064270
14757167130
021204
00runner
docker
Type annotations for ivs service Client.
[Documentation](https://youtype.github.io/boto3_stubs_docs/mypy_boto3_ivs/client/)
Copyright 2025 Vlad Emelianov
Usage::
```python
from boto3.session import Session
from mypy_boto3_ivs.client import IVSClient
session = Session()
client: IVSClient = session.client("ivs")
```
from __future__ import annotations
import sys
from typing import Any, overload
from botocore.client import BaseClient, ClientMeta
from botocore.errorfactory import BaseClientExceptions
from botocore.exceptions import ClientError as BotocoreClientError
from .paginator import (
ListChannelsPaginator,
ListPlaybackKeyPairsPaginator,
ListRecordingConfigurationsPaginator,
ListStreamKeysPaginator,
ListStreamsPaginator,
from .type_defs import (
BatchGetChannelRequestTypeDef,
BatchGetChannelResponseTypeDef,
BatchGetStreamKeyRequestTypeDef,
BatchGetStreamKeyResponseTypeDef,
BatchStartViewerSessionRevocationRequestTypeDef,
BatchStartViewerSessionRevocationResponseTypeDef,
CreateChannelRequestTypeDef,
CreateChannelResponseTypeDef,
CreatePlaybackRestrictionPolicyRequestTypeDef,
CreatePlaybackRestrictionPolicyResponseTypeDef,
CreateRecordingConfigurationRequestTypeDef,
CreateRecordingConfigurationResponseTypeDef,
CreateStreamKeyRequestTypeDef,
CreateStreamKeyResponseTypeDef,
DeleteChannelRequestTypeDef,
DeletePlaybackKeyPairRequestTypeDef,
DeletePlaybackRestrictionPolicyRequestTypeDef,
DeleteRecordingConfigurationRequestTypeDef,
DeleteStreamKeyRequestTypeDef,
EmptyResponseMetadataTypeDef,
GetChannelRequestTypeDef,
GetChannelResponseTypeDef,
GetPlaybackKeyPairRequestTypeDef,
GetPlaybackKeyPairResponseTypeDef,
GetPlaybackRestrictionPolicyRequestTypeDef,
GetPlaybackRestrictionPolicyResponseTypeDef,
GetRecordingConfigurationRequestTypeDef,
GetRecordingConfigurationResponseTypeDef,
GetStreamKeyRequestTypeDef,
GetStreamKeyResponseTypeDef,
GetStreamRequestTypeDef,
GetStreamResponseTypeDef,
GetStreamSessionRequestTypeDef,
GetStreamSessionResponseTypeDef,
ImportPlaybackKeyPairRequestTypeDef,
ImportPlaybackKeyPairResponseTypeDef,
ListChannelsRequestTypeDef,
ListChannelsResponseTypeDef,
ListPlaybackKeyPairsRequestTypeDef,
ListPlaybackKeyPairsResponseTypeDef,
ListPlaybackRestrictionPoliciesRequestTypeDef,
ListPlaybackRestrictionPoliciesResponseTypeDef,
ListRecordingConfigurationsRequestTypeDef,
ListRecordingConfigurationsResponseTypeDef,
ListStreamKeysRequestTypeDef,
ListStreamKeysResponseTypeDef,
ListStreamSessionsRequestTypeDef,
ListStreamSessionsResponseTypeDef,
ListStreamsRequestTypeDef,
ListStreamsResponseTypeDef,
ListTagsForResourceRequestTypeDef,
ListTagsForResourceResponseTypeDef,
PutMetadataRequestTypeDef,
StartViewerSessionRevocationRequestTypeDef,
StopStreamRequestTypeDef,
TagResourceRequestTypeDef,
UntagResourceRequestTypeDef,
UpdateChannelRequestTypeDef,
UpdateChannelResponseTypeDef,
UpdatePlaybackRestrictionPolicyRequestTypeDef,
UpdatePlaybackRestrictionPolicyResponseTypeDef,
if sys.version_info >= (3, 9):
from builtins import dict as Dict
from builtins import type as Type
from collections.abc import Mapping
from typing import Dict, Mapping, Type
if sys.version_info >= (3, 12):
from typing import Literal, Unpack
from typing_extensions import Literal, Unpack
__all__ = ("IVSClient",)
class Exceptions(BaseClientExceptions):
AccessDeniedException: Type[BotocoreClientError]
ChannelNotBroadcasting: Type[BotocoreClientError]
ClientError: Type[BotocoreClientError]
ConflictException: Type[BotocoreClientError]
InternalServerException: Type[BotocoreClientError]
PendingVerification: Type[BotocoreClientError]
ResourceNotFoundException: Type[BotocoreClientError]
ServiceQuotaExceededException: Type[BotocoreClientError]
StreamUnavailable: Type[BotocoreClientError]
ThrottlingException: Type[BotocoreClientError]
ValidationException: Type[BotocoreClientError]
class IVSClient(BaseClient):
"""
[Show boto3 documentation](https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/ivs.html#IVS.Client)
[Show boto3-stubs documentation](https://youtype.github.io/boto3_stubs_docs/mypy_boto3_ivs/client/)
"""
meta: ClientMeta
@property
def exceptions(self) -> Exceptions:
"""
IVSClient exceptions.
[Show boto3 documentation](https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/ivs.html#IVS.Client)
[Show boto3-stubs documentation](https://youtype.github.io/boto3_stubs_docs/mypy_boto3_ivs/client/#exceptions)
"""
def can_paginate(self, operation_name: str) -> bool:
"""
[Show boto3 documentation](https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/ivs/client/can_paginate.html)
[Show boto3-stubs documentation](https://youtype.github.io/boto3_stubs_docs/mypy_boto3_ivs/client/#can_paginate)
"""
def generate_presigned_url(
self,
ClientMethod: str,
Params: Mapping[str, Any] = ...,
ExpiresIn: int = 3600,
HttpMethod: str = ...,
) -> str:
"""
[Show boto3 documentation](https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/ivs/client/generate_presigned_url.html)
[Show boto3-stubs documentation](https://youtype.github.io/boto3_stubs_docs/mypy_boto3_ivs/client/#generate_presigned_url)
"""
def batch_get_channel(
self, **kwargs: Unpack[BatchGetChannelRequestTypeDef]
) -> BatchGetChannelResponseTypeDef:
"""
Performs <a>GetChannel</a> on multiple ARNs simultaneously.
[Show boto3 documentation](https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/ivs/client/batch_get_channel.html)
[Show boto3-stubs documentation](https://youtype.github.io/boto3_stubs_docs/mypy_boto3_ivs/client/#batch_get_channel)
"""
def batch_get_stream_key(
self, **kwargs: Unpack[BatchGetStreamKeyRequestTypeDef]
) -> BatchGetStreamKeyResponseTypeDef:
"""
Performs <a>GetStreamKey</a> on multiple ARNs simultaneously.
[Show boto3 documentation](https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/ivs/client/batch_get_stream_key.html)
[Show boto3-stubs documentation](https://youtype.github.io/boto3_stubs_docs/mypy_boto3_ivs/client/#batch_get_stream_key)
"""
def batch_start_viewer_session_revocation(
self, **kwargs: Unpack[BatchStartViewerSessionRevocationRequestTypeDef]
) -> BatchStartViewerSessionRevocationResponseTypeDef:
"""
Performs <a>StartViewerSessionRevocation</a> on multiple channel ARN and viewer
ID pairs simultaneously.
[Show boto3 documentation](https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/ivs/client/batch_start_viewer_session_revocation.html)
[Show boto3-stubs documentation](https://youtype.github.io/boto3_stubs_docs/mypy_boto3_ivs/client/#batch_start_viewer_session_revocation)
"""
def create_channel(
self, **kwargs: Unpack[CreateChannelRequestTypeDef]
) -> CreateChannelResponseTypeDef:
"""
Creates a new channel and an associated stream key to start streaming.
[Show boto3 documentation](https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/ivs/client/create_channel.html)
[Show boto3-stubs documentation](https://youtype.github.io/boto3_stubs_docs/mypy_boto3_ivs/client/#create_channel)
"""
def create_playback_restriction_policy(
self, **kwargs: Unpack[CreatePlaybackRestrictionPolicyRequestTypeDef]
) -> CreatePlaybackRestrictionPolicyResponseTypeDef:
"""
Creates a new playback restriction policy, for constraining playback by
countries and/or origins.
[Show boto3 documentation](https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/ivs/client/create_playback_restriction_policy.html)
[Show boto3-stubs documentation](https://youtype.github.io/boto3_stubs_docs/mypy_boto3_ivs/client/#create_playback_restriction_policy)
"""
def create_recording_configuration(
self, **kwargs: Unpack[CreateRecordingConfigurationRequestTypeDef]
) -> CreateRecordingConfigurationResponseTypeDef:
"""
Creates a new recording configuration, used to enable recording to Amazon S3.
[Show boto3 documentation](https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/ivs/client/create_recording_configuration.html)
[Show boto3-stubs documentation](https://youtype.github.io/boto3_stubs_docs/mypy_boto3_ivs/client/#create_recording_configuration)
"""
def create_stream_key(
self, **kwargs: Unpack[CreateStreamKeyRequestTypeDef]
) -> CreateStreamKeyResponseTypeDef:
"""
Creates a stream key, used to initiate a stream, for the specified channel ARN.
[Show boto3 documentation](https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/ivs/client/create_stream_key.html)
[Show boto3-stubs documentation](https://youtype.github.io/boto3_stubs_docs/mypy_boto3_ivs/client/#create_stream_key)
"""
def delete_channel(
self, **kwargs: Unpack[DeleteChannelRequestTypeDef]
) -> EmptyResponseMetadataTypeDef:
"""
Deletes the specified channel and its associated stream keys.
[Show boto3 documentation](https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/ivs/client/delete_channel.html)
[Show boto3-stubs documentation](https://youtype.github.io/boto3_stubs_docs/mypy_boto3_ivs/client/#delete_channel)
"""
def delete_playback_key_pair(
self, **kwargs: Unpack[DeletePlaybackKeyPairRequestTypeDef]
) -> Dict[str, Any]:
"""
Deletes a specified authorization key pair.
[Show boto3 documentation](https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/ivs/client/delete_playback_key_pair.html)
[Show boto3-stubs documentation](https://youtype.github.io/boto3_stubs_docs/mypy_boto3_ivs/client/#delete_playback_key_pair)
"""
def delete_playback_restriction_policy(
self, **kwargs: Unpack[DeletePlaybackRestrictionPolicyRequestTypeDef]
) -> EmptyResponseMetadataTypeDef:
"""
Deletes the specified playback restriction policy.
[Show boto3 documentation](https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/ivs/client/delete_playback_restriction_policy.html)
[Show boto3-stubs documentation](https://youtype.github.io/boto3_stubs_docs/mypy_boto3_ivs/client/#delete_playback_restriction_policy)
"""
def delete_recording_configuration(
self, **kwargs: Unpack[DeleteRecordingConfigurationRequestTypeDef]
) -> EmptyResponseMetadataTypeDef:
"""
Deletes the recording configuration for the specified ARN.
[Show boto3 documentation](https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/ivs/client/delete_recording_configuration.html)
[Show boto3-stubs documentation](https://youtype.github.io/boto3_stubs_docs/mypy_boto3_ivs/client/#delete_recording_configuration)
"""
def delete_stream_key(
self, **kwargs: Unpack[DeleteStreamKeyRequestTypeDef]
) -> EmptyResponseMetadataTypeDef:
"""
Deletes the stream key for the specified ARN, so it can no longer be used to
stream.
[Show boto3 documentation](https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/ivs/client/delete_stream_key.html)
[Show boto3-stubs documentation](https://youtype.github.io/boto3_stubs_docs/mypy_boto3_ivs/client/#delete_stream_key)
"""
def get_channel(self, **kwargs: Unpack[GetChannelRequestTypeDef]) -> GetChannelResponseTypeDef:
"""
Gets the channel configuration for the specified channel ARN.
[Show boto3 documentation](https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/ivs/client/get_channel.html)
[Show boto3-stubs documentation](https://youtype.github.io/boto3_stubs_docs/mypy_boto3_ivs/client/#get_channel)
"""
def get_playback_key_pair(
self, **kwargs: Unpack[GetPlaybackKeyPairRequestTypeDef]
) -> GetPlaybackKeyPairResponseTypeDef:
"""
Gets a specified playback authorization key pair and returns the
<code>arn</code> and <code>fingerprint</code>.
[Show boto3 documentation](https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/ivs/client/get_playback_key_pair.html)
[Show boto3-stubs documentation](https://youtype.github.io/boto3_stubs_docs/mypy_boto3_ivs/client/#get_playback_key_pair)
"""
def get_playback_restriction_policy(
self, **kwargs: Unpack[GetPlaybackRestrictionPolicyRequestTypeDef]
) -> GetPlaybackRestrictionPolicyResponseTypeDef:
"""
Gets the specified playback restriction policy.
[Show boto3 documentation](https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/ivs/client/get_playback_restriction_policy.html)
[Show boto3-stubs documentation](https://youtype.github.io/boto3_stubs_docs/mypy_boto3_ivs/client/#get_playback_restriction_policy)
"""
def get_recording_configuration(
self, **kwargs: Unpack[GetRecordingConfigurationRequestTypeDef]
) -> GetRecordingConfigurationResponseTypeDef:
"""
Gets the recording configuration for the specified ARN.
[Show boto3 documentation](https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/ivs/client/get_recording_configuration.html)
[Show boto3-stubs documentation](https://youtype.github.io/boto3_stubs_docs/mypy_boto3_ivs/client/#get_recording_configuration)
"""
def get_stream(self, **kwargs: Unpack[GetStreamRequestTypeDef]) -> GetStreamResponseTypeDef:
"""
Gets information about the active (live) stream on a specified channel.
[Show boto3 documentation](https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/ivs/client/get_stream.html)
[Show boto3-stubs documentation](https://youtype.github.io/boto3_stubs_docs/mypy_boto3_ivs/client/#get_stream)
"""
def get_stream_key(
self, **kwargs: Unpack[GetStreamKeyRequestTypeDef]
) -> GetStreamKeyResponseTypeDef:
"""
Gets stream-key information for a specified ARN.
[Show boto3 documentation](https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/ivs/client/get_stream_key.html)
[Show boto3-stubs documentation](https://youtype.github.io/boto3_stubs_docs/mypy_boto3_ivs/client/#get_stream_key)
"""
def get_stream_session(
self, **kwargs: Unpack[GetStreamSessionRequestTypeDef]
) -> GetStreamSessionResponseTypeDef:
"""
Gets metadata on a specified stream.
[Show boto3 documentation](https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/ivs/client/get_stream_session.html)
[Show boto3-stubs documentation](https://youtype.github.io/boto3_stubs_docs/mypy_boto3_ivs/client/#get_stream_session)
"""
def import_playback_key_pair(
self, **kwargs: Unpack[ImportPlaybackKeyPairRequestTypeDef]
) -> ImportPlaybackKeyPairResponseTypeDef:
"""
Imports the public portion of a new key pair and returns its <code>arn</code>
and <code>fingerprint</code>.
[Show boto3 documentation](https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/ivs/client/import_playback_key_pair.html)
[Show boto3-stubs documentation](https://youtype.github.io/boto3_stubs_docs/mypy_boto3_ivs/client/#import_playback_key_pair)
"""
def list_channels(
self, **kwargs: Unpack[ListChannelsRequestTypeDef]
) -> ListChannelsResponseTypeDef:
"""
Gets summary information about all channels in your account, in the Amazon Web
Services region where the API request is processed.
[Show boto3 documentation](https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/ivs/client/list_channels.html)
[Show boto3-stubs documentation](https://youtype.github.io/boto3_stubs_docs/mypy_boto3_ivs/client/#list_channels)
"""
def list_playback_key_pairs(
self, **kwargs: Unpack[ListPlaybackKeyPairsRequestTypeDef]
) -> ListPlaybackKeyPairsResponseTypeDef:
"""
Gets summary information about playback key pairs.
[Show boto3 documentation](https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/ivs/client/list_playback_key_pairs.html)
[Show boto3-stubs documentation](https://youtype.github.io/boto3_stubs_docs/mypy_boto3_ivs/client/#list_playback_key_pairs)
"""
def list_playback_restriction_policies(
self, **kwargs: Unpack[ListPlaybackRestrictionPoliciesRequestTypeDef]
) -> ListPlaybackRestrictionPoliciesResponseTypeDef:
"""
Gets summary information about playback restriction policies.
[Show boto3 documentation](https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/ivs/client/list_playback_restriction_policies.html)
[Show boto3-stubs documentation](https://youtype.github.io/boto3_stubs_docs/mypy_boto3_ivs/client/#list_playback_restriction_policies)
"""
def list_recording_configurations(
self, **kwargs: Unpack[ListRecordingConfigurationsRequestTypeDef]
) -> ListRecordingConfigurationsResponseTypeDef:
"""
Gets summary information about all recording configurations in your account, in
the Amazon Web Services region where the API request is processed.
[Show boto3 documentation](https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/ivs/client/list_recording_configurations.html)
[Show boto3-stubs documentation](https://youtype.github.io/boto3_stubs_docs/mypy_boto3_ivs/client/#list_recording_configurations)
"""
def list_stream_keys(
self, **kwargs: Unpack[ListStreamKeysRequestTypeDef]
) -> ListStreamKeysResponseTypeDef:
"""
Gets summary information about stream keys for the specified channel.
[Show boto3 documentation](https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/ivs/client/list_stream_keys.html)
[Show boto3-stubs documentation](https://youtype.github.io/boto3_stubs_docs/mypy_boto3_ivs/client/#list_stream_keys)
"""
def list_stream_sessions(
self, **kwargs: Unpack[ListStreamSessionsRequestTypeDef]
) -> ListStreamSessionsResponseTypeDef:
"""
Gets a summary of current and previous streams for a specified channel in your
account, in the AWS region where the API request is processed.
[Show boto3 documentation](https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/ivs/client/list_stream_sessions.html)
[Show boto3-stubs documentation](https://youtype.github.io/boto3_stubs_docs/mypy_boto3_ivs/client/#list_stream_sessions)
"""
def list_streams(
self, **kwargs: Unpack[ListStreamsRequestTypeDef]
) -> ListStreamsResponseTypeDef:
"""
Gets summary information about live streams in your account, in the Amazon Web
Services region where the API request is processed.
[Show boto3 documentation](https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/ivs/client/list_streams.html)
[Show boto3-stubs documentation](https://youtype.github.io/boto3_stubs_docs/mypy_boto3_ivs/client/#list_streams)
"""
def list_tags_for_resource(
self, **kwargs: Unpack[ListTagsForResourceRequestTypeDef]
) -> ListTagsForResourceResponseTypeDef:
"""
Gets information about Amazon Web Services tags for the specified ARN.
[Show boto3 documentation](https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/ivs/client/list_tags_for_resource.html)
[Show boto3-stubs documentation](https://youtype.github.io/boto3_stubs_docs/mypy_boto3_ivs/client/#list_tags_for_resource)
"""
def put_metadata(
self, **kwargs: Unpack[PutMetadataRequestTypeDef]
) -> EmptyResponseMetadataTypeDef:
"""
Inserts metadata into the active stream of the specified channel.
[Show boto3 documentation](https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/ivs/client/put_metadata.html)
[Show boto3-stubs documentation](https://youtype.github.io/boto3_stubs_docs/mypy_boto3_ivs/client/#put_metadata)
"""
def start_viewer_session_revocation(
self, **kwargs: Unpack[StartViewerSessionRevocationRequestTypeDef]
) -> Dict[str, Any]:
"""
Starts the process of revoking the viewer session associated with a specified
channel ARN and viewer ID.
[Show boto3 documentation](https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/ivs/client/start_viewer_session_revocation.html)
[Show boto3-stubs documentation](https://youtype.github.io/boto3_stubs_docs/mypy_boto3_ivs/client/#start_viewer_session_revocation)
"""
def stop_stream(self, **kwargs: Unpack[StopStreamRequestTypeDef]) -> Dict[str, Any]:
"""
Disconnects the incoming RTMPS stream for the specified channel.
[Show boto3 documentation](https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/ivs/client/stop_stream.html)
[Show boto3-stubs documentation](https://youtype.github.io/boto3_stubs_docs/mypy_boto3_ivs/client/#stop_stream)
"""
def tag_resource(self, **kwargs: Unpack[TagResourceRequestTypeDef]) -> Dict[str, Any]:
"""
Adds or updates tags for the Amazon Web Services resource with the specified
ARN.
[Show boto3 documentation](https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/ivs/client/tag_resource.html)
[Show boto3-stubs documentation](https://youtype.github.io/boto3_stubs_docs/mypy_boto3_ivs/client/#tag_resource)
"""
def untag_resource(self, **kwargs: Unpack[UntagResourceRequestTypeDef]) -> Dict[str, Any]:
"""
Removes tags from the resource with the specified ARN.
[Show boto3 documentation](https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/ivs/client/untag_resource.html)
[Show boto3-stubs documentation](https://youtype.github.io/boto3_stubs_docs/mypy_boto3_ivs/client/#untag_resource)
"""
def update_channel(
self, **kwargs: Unpack[UpdateChannelRequestTypeDef]
) -> UpdateChannelResponseTypeDef:
"""
Updates a channel's configuration.
[Show boto3 documentation](https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/ivs/client/update_channel.html)
[Show boto3-stubs documentation](https://youtype.github.io/boto3_stubs_docs/mypy_boto3_ivs/client/#update_channel)
"""
def update_playback_restriction_policy(
self, **kwargs: Unpack[UpdatePlaybackRestrictionPolicyRequestTypeDef]
) -> UpdatePlaybackRestrictionPolicyResponseTypeDef:
"""
Updates a specified playback restriction policy.
[Show boto3 documentation](https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/ivs/client/update_playback_restriction_policy.html)
[Show boto3-stubs documentation](https://youtype.github.io/boto3_stubs_docs/mypy_boto3_ivs/client/#update_playback_restriction_policy)
"""
@overload # type: ignore[override]
def get_paginator( # type: ignore[override]
self, operation_name: Literal["list_channels"]
) -> ListChannelsPaginator:
"""
Create a paginator for an operation.
[Show boto3 documentation](https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/ivs/client/get_paginator.html)
[Show boto3-stubs documentation](https://youtype.github.io/boto3_stubs_docs/mypy_boto3_ivs/client/#get_paginator)
"""
@overload # type: ignore[override]
def get_paginator( # type: ignore[override]
self, operation_name: Literal["list_playback_key_pairs"]
) -> ListPlaybackKeyPairsPaginator:
"""
Create a paginator for an operation.
[Show boto3 documentation](https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/ivs/client/get_paginator.html)
[Show boto3-stubs documentation](https://youtype.github.io/boto3_stubs_docs/mypy_boto3_ivs/client/#get_paginator)
"""
@overload # type: ignore[override]
def get_paginator( # type: ignore[override]
self, operation_name: Literal["list_recording_configurations"]
) -> ListRecordingConfigurationsPaginator:
"""
Create a paginator for an operation.
[Show boto3 documentation](https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/ivs/client/get_paginator.html)
[Show boto3-stubs documentation](https://youtype.github.io/boto3_stubs_docs/mypy_boto3_ivs/client/#get_paginator)
"""
@overload # type: ignore[override]
def get_paginator( # type: ignore[override]
self, operation_name: Literal["list_stream_keys"]
) -> ListStreamKeysPaginator:
"""
Create a paginator for an operation.
[Show boto3 documentation](https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/ivs/client/get_paginator.html)
[Show boto3-stubs documentation](https://youtype.github.io/boto3_stubs_docs/mypy_boto3_ivs/client/#get_paginator)
"""
@overload # type: ignore[override]
def get_paginator( # type: ignore[override]
self, operation_name: Literal["list_streams"]
) -> ListStreamsPaginator:
"""
Create a paginator for an operation.
[Show boto3 documentation](https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/ivs/client/get_paginator.html)
[Show boto3-stubs documentation](https://youtype.github.io/boto3_stubs_docs/mypy_boto3_ivs/client/#get_paginator)
"""
././@PaxHeader
0000000
0000000
0000000
00000000026
00000000000
010213
22 mtime=1740435032.0
mypy_boto3_ivs-1.37.0/mypy_boto3_ivs/literals.py
0000644
0001751
0000166
00000025333
14757167130
021371
00runner
docker
Type annotations for ivs service literal definitions.
[Documentation](https://youtype.github.io/boto3_stubs_docs/mypy_boto3_ivs/literals/)
Copyright 2025 Vlad Emelianov
Usage::
```python
from mypy_boto3_ivs.literals import ChannelLatencyModeType
data: ChannelLatencyModeType = "LOW"
```
import sys
if sys.version_info >= (3, 12):
from typing import Literal
from typing_extensions import Literal
__all__ = (
"ChannelLatencyModeType",
"ChannelTypeType",
"ContainerFormatType",
"IVSServiceName",
"ListChannelsPaginatorName",
"ListPlaybackKeyPairsPaginatorName",
"ListRecordingConfigurationsPaginatorName",
"ListStreamKeysPaginatorName",
"ListStreamsPaginatorName",
"MultitrackMaximumResolutionType",
"MultitrackPolicyType",
"PaginatorName",
"RecordingConfigurationStateType",
"RecordingModeType",
"RegionName",
"RenditionConfigurationRenditionSelectionType",
"RenditionConfigurationRenditionType",
"ResourceServiceName",
"ServiceName",
"StreamHealthType",
"StreamStateType",
"ThumbnailConfigurationResolutionType",
"ThumbnailConfigurationStorageType",
"TranscodePresetType",
ChannelLatencyModeType = Literal["LOW", "NORMAL"]
ChannelTypeType = Literal["ADVANCED_HD", "ADVANCED_SD", "BASIC", "STANDARD"]
ContainerFormatType = Literal["FRAGMENTED_MP4", "TS"]
ListChannelsPaginatorName = Literal["list_channels"]
ListPlaybackKeyPairsPaginatorName = Literal["list_playback_key_pairs"]
ListRecordingConfigurationsPaginatorName = Literal["list_recording_configurations"]
ListStreamKeysPaginatorName = Literal["list_stream_keys"]
ListStreamsPaginatorName = Literal["list_streams"]
MultitrackMaximumResolutionType = Literal["FULL_HD", "HD", "SD"]
MultitrackPolicyType = Literal["ALLOW", "REQUIRE"]
RecordingConfigurationStateType = Literal["ACTIVE", "CREATE_FAILED", "CREATING"]
RecordingModeType = Literal["DISABLED", "INTERVAL"]
RenditionConfigurationRenditionSelectionType = Literal["ALL", "CUSTOM", "NONE"]
RenditionConfigurationRenditionType = Literal["FULL_HD", "HD", "LOWEST_RESOLUTION", "SD"]
StreamHealthType = Literal["HEALTHY", "STARVING", "UNKNOWN"]
StreamStateType = Literal["LIVE", "OFFLINE"]
ThumbnailConfigurationResolutionType = Literal["FULL_HD", "HD", "LOWEST_RESOLUTION", "SD"]
ThumbnailConfigurationStorageType = Literal["LATEST", "SEQUENTIAL"]
TranscodePresetType = Literal["CONSTRAINED_BANDWIDTH_DELIVERY", "HIGHER_BANDWIDTH_DELIVERY"]
IVSServiceName = Literal["ivs"]
ServiceName = Literal[
"accessanalyzer",
"account",
"acm",
"acm-pca",
"amp",
"amplify",
"amplifybackend",
"amplifyuibuilder",
"apigateway",
"apigatewaymanagementapi",
"apigatewayv2",
"appconfig",
"appconfigdata",
"appfabric",
"appflow",
"appintegrations",
"application-autoscaling",
"application-insights",
"application-signals",
"applicationcostprofiler",
"appmesh",
"apprunner",
"appstream",
"appsync",
"apptest",
"arc-zonal-shift",
"artifact",
"athena",
"auditmanager",
"autoscaling",
"autoscaling-plans",
"b2bi",
"backup",
"backup-gateway",
"backupsearch",
"batch",
"bcm-data-exports",
"bcm-pricing-calculator",
"bedrock",
"bedrock-agent",
"bedrock-agent-runtime",
"bedrock-data-automation",
"bedrock-data-automation-runtime",
"bedrock-runtime",
"billing",
"billingconductor",
"braket",
"budgets",
"ce",
"chatbot",
"chime",
"chime-sdk-identity",
"chime-sdk-media-pipelines",
"chime-sdk-meetings",
"chime-sdk-messaging",
"chime-sdk-voice",
"cleanrooms",
"cleanroomsml",
"cloud9",
"cloudcontrol",
"clouddirectory",
"cloudformation",
"cloudfront",
"cloudfront-keyvaluestore",
"cloudhsm",
"cloudhsmv2",
"cloudsearch",
"cloudsearchdomain",
"cloudtrail",
"cloudtrail-data",
"cloudwatch",
"codeartifact",
"codebuild",
"codecatalyst",
"codecommit",
"codeconnections",
"codedeploy",
"codeguru-reviewer",
"codeguru-security",
"codeguruprofiler",
"codepipeline",
"codestar-connections",
"codestar-notifications",
"cognito-identity",
"cognito-idp",
"cognito-sync",
"comprehend",
"comprehendmedical",
"compute-optimizer",
"config",
"connect",
"connect-contact-lens",
"connectcampaigns",
"connectcampaignsv2",
"connectcases",
"connectparticipant",
"controlcatalog",
"controltower",
"cost-optimization-hub",
"cur",
"customer-profiles",
"databrew",
"dataexchange",
"datapipeline",
"datasync",
"datazone",
"dax",
"deadline",
"detective",
"devicefarm",
"devops-guru",
"directconnect",
"discovery",
"dlm",
"dms",
"docdb",
"docdb-elastic",
"drs",
"ds",
"ds-data",
"dsql",
"dynamodb",
"dynamodbstreams",
"ebs",
"ec2",
"ec2-instance-connect",
"ecr",
