IVS module
Index > IVS
Auto-generated documentation for IVS type annotations stubs module mypy-boto3-ivs.
How to install
VSCode extension
Add AWS Boto3
extension to your VSCode and run AWS boto3: Quick Start
command.
Click Modify
and select boto3 common
and IVS
.
From PyPI with pip
Install boto3-stubs
for IVS
service.
# 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
How to uninstall
Usage
Code samples can be found in Examples.
IVSClient
Type annotations and code completion for boto3.client("ivs")
as IVSClient
boto3 documentation
Usage example
from boto3.session import Session
from mypy_boto3_ivs.client import IVSClient
def get_client() -> IVSClient:
return Session().client("ivs")
Paginators
Type annotations and code completion for paginators
from boto3.client("ivs").get_paginator("...")
.
Usage example
from boto3.session import Session
from mypy_boto3_ivs.paginator import ListChannelsPaginator
def get_list_channels_paginator() -> ListChannelsPaginator:
return Session().client("ivs").get_paginator("list_channels"))
- ListChannelsPaginator
- ListPlaybackKeyPairsPaginator
- ListRecordingConfigurationsPaginator
- ListStreamKeysPaginator
- ListStreamsPaginator
Literals
Type annotations for literals used in methods and schemas.
Usage example
from mypy_boto3_ivs.literals import ChannelLatencyModeType
def get_value() -> ChannelLatencyModeType:
return "LOW"
- ChannelLatencyModeType
- ChannelTypeType
- ListChannelsPaginatorName
- ListPlaybackKeyPairsPaginatorName
- ListRecordingConfigurationsPaginatorName
- ListStreamKeysPaginatorName
- ListStreamsPaginatorName
- RecordingConfigurationStateType
- RecordingModeType
- StreamHealthType
- StreamStateType
- IVSServiceName
- ServiceName
- ResourceServiceName
- PaginatorName
- RegionName
Typed dictionaries
Type annotations for typed dictionaries used in methods and schema.
Usage example
from mypy_boto3_ivs.type_defs import AudioConfigurationTypeDef
def get_value() -> AudioConfigurationTypeDef:
return {
"channels": ...,
}
- AudioConfigurationTypeDef
- BatchErrorTypeDef
- BatchGetChannelRequestRequestTypeDef
- ChannelTypeDef
- ResponseMetadataTypeDef
- BatchGetStreamKeyRequestRequestTypeDef
- StreamKeyTypeDef
- ChannelSummaryTypeDef
- CreateChannelRequestRequestTypeDef
- ThumbnailConfigurationTypeDef
- CreateStreamKeyRequestRequestTypeDef
- DeleteChannelRequestRequestTypeDef
- DeletePlaybackKeyPairRequestRequestTypeDef
- DeleteRecordingConfigurationRequestRequestTypeDef
- DeleteStreamKeyRequestRequestTypeDef
- S3DestinationConfigurationTypeDef
- GetChannelRequestRequestTypeDef
- GetPlaybackKeyPairRequestRequestTypeDef
- PlaybackKeyPairTypeDef
- GetRecordingConfigurationRequestRequestTypeDef
- GetStreamKeyRequestRequestTypeDef
- GetStreamRequestRequestTypeDef
- StreamTypeDef
- GetStreamSessionRequestRequestTypeDef
- ImportPlaybackKeyPairRequestRequestTypeDef
- VideoConfigurationTypeDef
- PaginatorConfigTypeDef
- ListChannelsRequestRequestTypeDef
- ListPlaybackKeyPairsRequestRequestTypeDef
- PlaybackKeyPairSummaryTypeDef
- ListRecordingConfigurationsRequestRequestTypeDef
- ListStreamKeysRequestRequestTypeDef
- StreamKeySummaryTypeDef
- ListStreamSessionsRequestRequestTypeDef
- StreamSessionSummaryTypeDef
- StreamFiltersTypeDef
- StreamSummaryTypeDef
- ListTagsForResourceRequestRequestTypeDef
- PutMetadataRequestRequestTypeDef
- StopStreamRequestRequestTypeDef
- StreamEventTypeDef
- TagResourceRequestRequestTypeDef
- UntagResourceRequestRequestTypeDef
- UpdateChannelRequestRequestTypeDef
- BatchGetChannelResponseTypeDef
- EmptyResponseMetadataTypeDef
- GetChannelResponseTypeDef
- ListTagsForResourceResponseTypeDef
- UpdateChannelResponseTypeDef
- BatchGetStreamKeyResponseTypeDef
- CreateChannelResponseTypeDef
- CreateStreamKeyResponseTypeDef
- GetStreamKeyResponseTypeDef
- ListChannelsResponseTypeDef
- DestinationConfigurationTypeDef
- GetPlaybackKeyPairResponseTypeDef
- ImportPlaybackKeyPairResponseTypeDef
- GetStreamResponseTypeDef
- IngestConfigurationTypeDef
- ListChannelsRequestListChannelsPaginateTypeDef
- ListPlaybackKeyPairsRequestListPlaybackKeyPairsPaginateTypeDef
- ListRecordingConfigurationsRequestListRecordingConfigurationsPaginateTypeDef
- ListStreamKeysRequestListStreamKeysPaginateTypeDef
- ListPlaybackKeyPairsResponseTypeDef
- ListStreamKeysResponseTypeDef
- ListStreamSessionsResponseTypeDef
- ListStreamsRequestListStreamsPaginateTypeDef
- ListStreamsRequestRequestTypeDef
- ListStreamsResponseTypeDef
- CreateRecordingConfigurationRequestRequestTypeDef
- RecordingConfigurationSummaryTypeDef
- RecordingConfigurationTypeDef
- ListRecordingConfigurationsResponseTypeDef
- CreateRecordingConfigurationResponseTypeDef
- GetRecordingConfigurationResponseTypeDef
- StreamSessionTypeDef
- GetStreamSessionResponseTypeDef