Typed dictionaries#
Auto-generated documentation for IVS type annotations stubs module mypy-boto3-ivs.
AudioConfigurationTypeDef#
# AudioConfigurationTypeDef usage example
from mypy_boto3_ivs.type_defs import AudioConfigurationTypeDef
def get_value() -> AudioConfigurationTypeDef:
return {
"channels": ...,
}
# AudioConfigurationTypeDef definition
class AudioConfigurationTypeDef(TypedDict):
channels: NotRequired[int],
codec: NotRequired[str],
sampleRate: NotRequired[int],
targetBitrate: NotRequired[int],
BatchErrorTypeDef#
# BatchErrorTypeDef usage example
from mypy_boto3_ivs.type_defs import BatchErrorTypeDef
def get_value() -> BatchErrorTypeDef:
return {
"arn": ...,
}
# BatchErrorTypeDef definition
class BatchErrorTypeDef(TypedDict):
arn: NotRequired[str],
code: NotRequired[str],
message: NotRequired[str],
BatchGetChannelRequestRequestTypeDef#
# BatchGetChannelRequestRequestTypeDef usage example
from mypy_boto3_ivs.type_defs import BatchGetChannelRequestRequestTypeDef
def get_value() -> BatchGetChannelRequestRequestTypeDef:
return {
"arns": ...,
}
# BatchGetChannelRequestRequestTypeDef definition
class BatchGetChannelRequestRequestTypeDef(TypedDict):
arns: Sequence[str],
ChannelTypeDef#
# ChannelTypeDef usage example
from mypy_boto3_ivs.type_defs import ChannelTypeDef
def get_value() -> ChannelTypeDef:
return {
"arn": ...,
}
# ChannelTypeDef definition
class ChannelTypeDef(TypedDict):
arn: NotRequired[str],
authorized: NotRequired[bool],
ingestEndpoint: NotRequired[str],
insecureIngest: NotRequired[bool],
latencyMode: NotRequired[ChannelLatencyModeType], # (1)
name: NotRequired[str],
playbackUrl: NotRequired[str],
recordingConfigurationArn: NotRequired[str],
tags: NotRequired[Dict[str, str]],
type: NotRequired[ChannelTypeType], # (2)
BatchGetStreamKeyRequestRequestTypeDef#
# BatchGetStreamKeyRequestRequestTypeDef usage example
from mypy_boto3_ivs.type_defs import BatchGetStreamKeyRequestRequestTypeDef
def get_value() -> BatchGetStreamKeyRequestRequestTypeDef:
return {
"arns": ...,
}
# BatchGetStreamKeyRequestRequestTypeDef definition
class BatchGetStreamKeyRequestRequestTypeDef(TypedDict):
arns: Sequence[str],
StreamKeyTypeDef#
# StreamKeyTypeDef usage example
from mypy_boto3_ivs.type_defs import StreamKeyTypeDef
def get_value() -> StreamKeyTypeDef:
return {
"arn": ...,
}
# StreamKeyTypeDef definition
class StreamKeyTypeDef(TypedDict):
arn: NotRequired[str],
channelArn: NotRequired[str],
tags: NotRequired[Dict[str, str]],
value: NotRequired[str],
ChannelSummaryTypeDef#
# ChannelSummaryTypeDef usage example
from mypy_boto3_ivs.type_defs import ChannelSummaryTypeDef
def get_value() -> ChannelSummaryTypeDef:
return {
"arn": ...,
}
# ChannelSummaryTypeDef definition
class ChannelSummaryTypeDef(TypedDict):
arn: NotRequired[str],
authorized: NotRequired[bool],
insecureIngest: NotRequired[bool],
latencyMode: NotRequired[ChannelLatencyModeType], # (1)
name: NotRequired[str],
recordingConfigurationArn: NotRequired[str],
tags: NotRequired[Dict[str, str]],
CreateChannelRequestRequestTypeDef#
# CreateChannelRequestRequestTypeDef usage example
from mypy_boto3_ivs.type_defs import CreateChannelRequestRequestTypeDef
def get_value() -> CreateChannelRequestRequestTypeDef:
return {
"authorized": ...,
}
# CreateChannelRequestRequestTypeDef definition
class CreateChannelRequestRequestTypeDef(TypedDict):
authorized: NotRequired[bool],
insecureIngest: NotRequired[bool],
latencyMode: NotRequired[ChannelLatencyModeType], # (1)
name: NotRequired[str],
recordingConfigurationArn: NotRequired[str],
tags: NotRequired[Mapping[str, str]],
type: NotRequired[ChannelTypeType], # (2)
ThumbnailConfigurationTypeDef#
# ThumbnailConfigurationTypeDef usage example
from mypy_boto3_ivs.type_defs import ThumbnailConfigurationTypeDef
def get_value() -> ThumbnailConfigurationTypeDef:
return {
"recordingMode": ...,
}
# ThumbnailConfigurationTypeDef definition
class ThumbnailConfigurationTypeDef(TypedDict):
recordingMode: NotRequired[RecordingModeType], # (1)
targetIntervalSeconds: NotRequired[int],
CreateStreamKeyRequestRequestTypeDef#
# CreateStreamKeyRequestRequestTypeDef usage example
from mypy_boto3_ivs.type_defs import CreateStreamKeyRequestRequestTypeDef
def get_value() -> CreateStreamKeyRequestRequestTypeDef:
return {
"channelArn": ...,
}
# CreateStreamKeyRequestRequestTypeDef definition
class CreateStreamKeyRequestRequestTypeDef(TypedDict):
channelArn: str,
tags: NotRequired[Mapping[str, str]],
DeleteChannelRequestRequestTypeDef#
# DeleteChannelRequestRequestTypeDef usage example
from mypy_boto3_ivs.type_defs import DeleteChannelRequestRequestTypeDef
def get_value() -> DeleteChannelRequestRequestTypeDef:
return {
"arn": ...,
}
# DeleteChannelRequestRequestTypeDef definition
class DeleteChannelRequestRequestTypeDef(TypedDict):
arn: str,
DeletePlaybackKeyPairRequestRequestTypeDef#
# DeletePlaybackKeyPairRequestRequestTypeDef usage example
from mypy_boto3_ivs.type_defs import DeletePlaybackKeyPairRequestRequestTypeDef
def get_value() -> DeletePlaybackKeyPairRequestRequestTypeDef:
return {
"arn": ...,
}
# DeletePlaybackKeyPairRequestRequestTypeDef definition
class DeletePlaybackKeyPairRequestRequestTypeDef(TypedDict):
arn: str,
DeleteRecordingConfigurationRequestRequestTypeDef#
# DeleteRecordingConfigurationRequestRequestTypeDef usage example
from mypy_boto3_ivs.type_defs import DeleteRecordingConfigurationRequestRequestTypeDef
def get_value() -> DeleteRecordingConfigurationRequestRequestTypeDef:
return {
"arn": ...,
}
# DeleteRecordingConfigurationRequestRequestTypeDef definition
class DeleteRecordingConfigurationRequestRequestTypeDef(TypedDict):
arn: str,
DeleteStreamKeyRequestRequestTypeDef#
# DeleteStreamKeyRequestRequestTypeDef usage example
from mypy_boto3_ivs.type_defs import DeleteStreamKeyRequestRequestTypeDef
def get_value() -> DeleteStreamKeyRequestRequestTypeDef:
return {
"arn": ...,
}
# DeleteStreamKeyRequestRequestTypeDef definition
class DeleteStreamKeyRequestRequestTypeDef(TypedDict):
arn: str,
S3DestinationConfigurationTypeDef#
# S3DestinationConfigurationTypeDef usage example
from mypy_boto3_ivs.type_defs import S3DestinationConfigurationTypeDef
def get_value() -> S3DestinationConfigurationTypeDef:
return {
"bucketName": ...,
}
# S3DestinationConfigurationTypeDef definition
class S3DestinationConfigurationTypeDef(TypedDict):
bucketName: str,
EmptyResponseMetadataTypeDef#
# EmptyResponseMetadataTypeDef usage example
from mypy_boto3_ivs.type_defs import EmptyResponseMetadataTypeDef
def get_value() -> EmptyResponseMetadataTypeDef:
return {
"ResponseMetadata": ...,
}
# EmptyResponseMetadataTypeDef definition
class EmptyResponseMetadataTypeDef(TypedDict):
ResponseMetadata: ResponseMetadataTypeDef, # (1)
GetChannelRequestRequestTypeDef#
# GetChannelRequestRequestTypeDef usage example
from mypy_boto3_ivs.type_defs import GetChannelRequestRequestTypeDef
def get_value() -> GetChannelRequestRequestTypeDef:
return {
"arn": ...,
}
# GetChannelRequestRequestTypeDef definition
class GetChannelRequestRequestTypeDef(TypedDict):
arn: str,
GetPlaybackKeyPairRequestRequestTypeDef#
# GetPlaybackKeyPairRequestRequestTypeDef usage example
from mypy_boto3_ivs.type_defs import GetPlaybackKeyPairRequestRequestTypeDef
def get_value() -> GetPlaybackKeyPairRequestRequestTypeDef:
return {
"arn": ...,
}
# GetPlaybackKeyPairRequestRequestTypeDef definition
class GetPlaybackKeyPairRequestRequestTypeDef(TypedDict):
arn: str,
PlaybackKeyPairTypeDef#
# PlaybackKeyPairTypeDef usage example
from mypy_boto3_ivs.type_defs import PlaybackKeyPairTypeDef
def get_value() -> PlaybackKeyPairTypeDef:
return {
"arn": ...,
}
# PlaybackKeyPairTypeDef definition
class PlaybackKeyPairTypeDef(TypedDict):
arn: NotRequired[str],
fingerprint: NotRequired[str],
name: NotRequired[str],
tags: NotRequired[Dict[str, str]],
GetRecordingConfigurationRequestRequestTypeDef#
# GetRecordingConfigurationRequestRequestTypeDef usage example
from mypy_boto3_ivs.type_defs import GetRecordingConfigurationRequestRequestTypeDef
def get_value() -> GetRecordingConfigurationRequestRequestTypeDef:
return {
"arn": ...,
}
# GetRecordingConfigurationRequestRequestTypeDef definition
class GetRecordingConfigurationRequestRequestTypeDef(TypedDict):
arn: str,
GetStreamKeyRequestRequestTypeDef#
# GetStreamKeyRequestRequestTypeDef usage example
from mypy_boto3_ivs.type_defs import GetStreamKeyRequestRequestTypeDef
def get_value() -> GetStreamKeyRequestRequestTypeDef:
return {
"arn": ...,
}
# GetStreamKeyRequestRequestTypeDef definition
class GetStreamKeyRequestRequestTypeDef(TypedDict):
arn: str,
GetStreamRequestRequestTypeDef#
# GetStreamRequestRequestTypeDef usage example
from mypy_boto3_ivs.type_defs import GetStreamRequestRequestTypeDef
def get_value() -> GetStreamRequestRequestTypeDef:
return {
"channelArn": ...,
}
# GetStreamRequestRequestTypeDef definition
class GetStreamRequestRequestTypeDef(TypedDict):
channelArn: str,
StreamTypeDef#
# StreamTypeDef usage example
from mypy_boto3_ivs.type_defs import StreamTypeDef
def get_value() -> StreamTypeDef:
return {
"channelArn": ...,
}
# StreamTypeDef definition
class StreamTypeDef(TypedDict):
channelArn: NotRequired[str],
health: NotRequired[StreamHealthType], # (1)
playbackUrl: NotRequired[str],
startTime: NotRequired[datetime],
state: NotRequired[StreamStateType], # (2)
streamId: NotRequired[str],
viewerCount: NotRequired[int],
- See StreamHealthType
- See StreamStateType
GetStreamSessionRequestRequestTypeDef#
# GetStreamSessionRequestRequestTypeDef usage example
from mypy_boto3_ivs.type_defs import GetStreamSessionRequestRequestTypeDef
def get_value() -> GetStreamSessionRequestRequestTypeDef:
return {
"channelArn": ...,
}
# GetStreamSessionRequestRequestTypeDef definition
class GetStreamSessionRequestRequestTypeDef(TypedDict):
channelArn: str,
streamId: NotRequired[str],
ImportPlaybackKeyPairRequestRequestTypeDef#
# ImportPlaybackKeyPairRequestRequestTypeDef usage example
from mypy_boto3_ivs.type_defs import ImportPlaybackKeyPairRequestRequestTypeDef
def get_value() -> ImportPlaybackKeyPairRequestRequestTypeDef:
return {
"publicKeyMaterial": ...,
}
# ImportPlaybackKeyPairRequestRequestTypeDef definition
class ImportPlaybackKeyPairRequestRequestTypeDef(TypedDict):
publicKeyMaterial: str,
name: NotRequired[str],
tags: NotRequired[Mapping[str, str]],
VideoConfigurationTypeDef#
# VideoConfigurationTypeDef usage example
from mypy_boto3_ivs.type_defs import VideoConfigurationTypeDef
def get_value() -> VideoConfigurationTypeDef:
return {
"avcLevel": ...,
}
# VideoConfigurationTypeDef definition
class VideoConfigurationTypeDef(TypedDict):
avcLevel: NotRequired[str],
avcProfile: NotRequired[str],
codec: NotRequired[str],
encoder: NotRequired[str],
targetBitrate: NotRequired[int],
targetFramerate: NotRequired[int],
videoHeight: NotRequired[int],
videoWidth: NotRequired[int],
ListChannelsRequestListChannelsPaginateTypeDef#
# ListChannelsRequestListChannelsPaginateTypeDef usage example
from mypy_boto3_ivs.type_defs import ListChannelsRequestListChannelsPaginateTypeDef
def get_value() -> ListChannelsRequestListChannelsPaginateTypeDef:
return {
"filterByName": ...,
}
# ListChannelsRequestListChannelsPaginateTypeDef definition
class ListChannelsRequestListChannelsPaginateTypeDef(TypedDict):
filterByName: NotRequired[str],
filterByRecordingConfigurationArn: NotRequired[str],
PaginationConfig: NotRequired[PaginatorConfigTypeDef], # (1)
ListChannelsRequestRequestTypeDef#
# ListChannelsRequestRequestTypeDef usage example
from mypy_boto3_ivs.type_defs import ListChannelsRequestRequestTypeDef
def get_value() -> ListChannelsRequestRequestTypeDef:
return {
"filterByName": ...,
}
# ListChannelsRequestRequestTypeDef definition
class ListChannelsRequestRequestTypeDef(TypedDict):
filterByName: NotRequired[str],
filterByRecordingConfigurationArn: NotRequired[str],
maxResults: NotRequired[int],
nextToken: NotRequired[str],
ListPlaybackKeyPairsRequestListPlaybackKeyPairsPaginateTypeDef#
# ListPlaybackKeyPairsRequestListPlaybackKeyPairsPaginateTypeDef usage example
from mypy_boto3_ivs.type_defs import ListPlaybackKeyPairsRequestListPlaybackKeyPairsPaginateTypeDef
def get_value() -> ListPlaybackKeyPairsRequestListPlaybackKeyPairsPaginateTypeDef:
return {
"PaginationConfig": ...,
}
# ListPlaybackKeyPairsRequestListPlaybackKeyPairsPaginateTypeDef definition
class ListPlaybackKeyPairsRequestListPlaybackKeyPairsPaginateTypeDef(TypedDict):
PaginationConfig: NotRequired[PaginatorConfigTypeDef], # (1)
ListPlaybackKeyPairsRequestRequestTypeDef#
# ListPlaybackKeyPairsRequestRequestTypeDef usage example
from mypy_boto3_ivs.type_defs import ListPlaybackKeyPairsRequestRequestTypeDef
def get_value() -> ListPlaybackKeyPairsRequestRequestTypeDef:
return {
"maxResults": ...,
}
# ListPlaybackKeyPairsRequestRequestTypeDef definition
class ListPlaybackKeyPairsRequestRequestTypeDef(TypedDict):
maxResults: NotRequired[int],
nextToken: NotRequired[str],
PlaybackKeyPairSummaryTypeDef#
# PlaybackKeyPairSummaryTypeDef usage example
from mypy_boto3_ivs.type_defs import PlaybackKeyPairSummaryTypeDef
def get_value() -> PlaybackKeyPairSummaryTypeDef:
return {
"arn": ...,
}
# PlaybackKeyPairSummaryTypeDef definition
class PlaybackKeyPairSummaryTypeDef(TypedDict):
arn: NotRequired[str],
name: NotRequired[str],
tags: NotRequired[Dict[str, str]],
ListRecordingConfigurationsRequestListRecordingConfigurationsPaginateTypeDef#
# ListRecordingConfigurationsRequestListRecordingConfigurationsPaginateTypeDef usage example
from mypy_boto3_ivs.type_defs import ListRecordingConfigurationsRequestListRecordingConfigurationsPaginateTypeDef
def get_value() -> ListRecordingConfigurationsRequestListRecordingConfigurationsPaginateTypeDef:
return {
"PaginationConfig": ...,
}
# ListRecordingConfigurationsRequestListRecordingConfigurationsPaginateTypeDef definition
class ListRecordingConfigurationsRequestListRecordingConfigurationsPaginateTypeDef(TypedDict):
PaginationConfig: NotRequired[PaginatorConfigTypeDef], # (1)
ListRecordingConfigurationsRequestRequestTypeDef#
# ListRecordingConfigurationsRequestRequestTypeDef usage example
from mypy_boto3_ivs.type_defs import ListRecordingConfigurationsRequestRequestTypeDef
def get_value() -> ListRecordingConfigurationsRequestRequestTypeDef:
return {
"maxResults": ...,
}
# ListRecordingConfigurationsRequestRequestTypeDef definition
class ListRecordingConfigurationsRequestRequestTypeDef(TypedDict):
maxResults: NotRequired[int],
nextToken: NotRequired[str],
ListStreamKeysRequestListStreamKeysPaginateTypeDef#
# ListStreamKeysRequestListStreamKeysPaginateTypeDef usage example
from mypy_boto3_ivs.type_defs import ListStreamKeysRequestListStreamKeysPaginateTypeDef
def get_value() -> ListStreamKeysRequestListStreamKeysPaginateTypeDef:
return {
"channelArn": ...,
}
# ListStreamKeysRequestListStreamKeysPaginateTypeDef definition
class ListStreamKeysRequestListStreamKeysPaginateTypeDef(TypedDict):
channelArn: str,
PaginationConfig: NotRequired[PaginatorConfigTypeDef], # (1)
ListStreamKeysRequestRequestTypeDef#
# ListStreamKeysRequestRequestTypeDef usage example
from mypy_boto3_ivs.type_defs import ListStreamKeysRequestRequestTypeDef
def get_value() -> ListStreamKeysRequestRequestTypeDef:
return {
"channelArn": ...,
}
# ListStreamKeysRequestRequestTypeDef definition
class ListStreamKeysRequestRequestTypeDef(TypedDict):
channelArn: str,
maxResults: NotRequired[int],
nextToken: NotRequired[str],
StreamKeySummaryTypeDef#
# StreamKeySummaryTypeDef usage example
from mypy_boto3_ivs.type_defs import StreamKeySummaryTypeDef
def get_value() -> StreamKeySummaryTypeDef:
return {
"arn": ...,
}
# StreamKeySummaryTypeDef definition
class StreamKeySummaryTypeDef(TypedDict):
arn: NotRequired[str],
channelArn: NotRequired[str],
tags: NotRequired[Dict[str, str]],
ListStreamSessionsRequestRequestTypeDef#
# ListStreamSessionsRequestRequestTypeDef usage example
from mypy_boto3_ivs.type_defs import ListStreamSessionsRequestRequestTypeDef
def get_value() -> ListStreamSessionsRequestRequestTypeDef:
return {
"channelArn": ...,
}
# ListStreamSessionsRequestRequestTypeDef definition
class ListStreamSessionsRequestRequestTypeDef(TypedDict):
channelArn: str,
maxResults: NotRequired[int],
nextToken: NotRequired[str],
StreamSessionSummaryTypeDef#
# StreamSessionSummaryTypeDef usage example
from mypy_boto3_ivs.type_defs import StreamSessionSummaryTypeDef
def get_value() -> StreamSessionSummaryTypeDef:
return {
"endTime": ...,
}
# StreamSessionSummaryTypeDef definition
class StreamSessionSummaryTypeDef(TypedDict):
endTime: NotRequired[datetime],
hasErrorEvent: NotRequired[bool],
startTime: NotRequired[datetime],
streamId: NotRequired[str],
StreamFiltersTypeDef#
# StreamFiltersTypeDef usage example
from mypy_boto3_ivs.type_defs import StreamFiltersTypeDef
def get_value() -> StreamFiltersTypeDef:
return {
"health": ...,
}
# StreamFiltersTypeDef definition
class StreamFiltersTypeDef(TypedDict):
health: NotRequired[StreamHealthType], # (1)
- See StreamHealthType
StreamSummaryTypeDef#
# StreamSummaryTypeDef usage example
from mypy_boto3_ivs.type_defs import StreamSummaryTypeDef
def get_value() -> StreamSummaryTypeDef:
return {
"channelArn": ...,
}
# StreamSummaryTypeDef definition
class StreamSummaryTypeDef(TypedDict):
channelArn: NotRequired[str],
health: NotRequired[StreamHealthType], # (1)
startTime: NotRequired[datetime],
state: NotRequired[StreamStateType], # (2)
streamId: NotRequired[str],
viewerCount: NotRequired[int],
- See StreamHealthType
- See StreamStateType
ListTagsForResourceRequestRequestTypeDef#
# ListTagsForResourceRequestRequestTypeDef usage example
from mypy_boto3_ivs.type_defs import ListTagsForResourceRequestRequestTypeDef
def get_value() -> ListTagsForResourceRequestRequestTypeDef:
return {
"resourceArn": ...,
}
# ListTagsForResourceRequestRequestTypeDef definition
class ListTagsForResourceRequestRequestTypeDef(TypedDict):
resourceArn: str,
ListTagsForResourceResponseTypeDef#
# ListTagsForResourceResponseTypeDef usage example
from mypy_boto3_ivs.type_defs import ListTagsForResourceResponseTypeDef
def get_value() -> ListTagsForResourceResponseTypeDef:
return {
"tags": ...,
"ResponseMetadata": ...,
}
# ListTagsForResourceResponseTypeDef definition
class ListTagsForResourceResponseTypeDef(TypedDict):
tags: Dict[str, str],
ResponseMetadata: ResponseMetadataTypeDef, # (1)
PaginatorConfigTypeDef#
# PaginatorConfigTypeDef usage example
from mypy_boto3_ivs.type_defs import PaginatorConfigTypeDef
def get_value() -> PaginatorConfigTypeDef:
return {
"MaxItems": ...,
}
# PaginatorConfigTypeDef definition
class PaginatorConfigTypeDef(TypedDict):
MaxItems: NotRequired[int],
PageSize: NotRequired[int],
StartingToken: NotRequired[str],
PutMetadataRequestRequestTypeDef#
# PutMetadataRequestRequestTypeDef usage example
from mypy_boto3_ivs.type_defs import PutMetadataRequestRequestTypeDef
def get_value() -> PutMetadataRequestRequestTypeDef:
return {
"channelArn": ...,
"metadata": ...,
}
# PutMetadataRequestRequestTypeDef definition
class PutMetadataRequestRequestTypeDef(TypedDict):
channelArn: str,
metadata: str,
ResponseMetadataTypeDef#
# ResponseMetadataTypeDef usage example
from mypy_boto3_ivs.type_defs import ResponseMetadataTypeDef
def get_value() -> ResponseMetadataTypeDef:
return {
"RequestId": ...,
"HostId": ...,
"HTTPStatusCode": ...,
"HTTPHeaders": ...,
"RetryAttempts": ...,
}
# ResponseMetadataTypeDef definition
class ResponseMetadataTypeDef(TypedDict):
RequestId: str,
HostId: str,
HTTPStatusCode: int,
HTTPHeaders: Dict[str, str],
RetryAttempts: int,
StopStreamRequestRequestTypeDef#
# StopStreamRequestRequestTypeDef usage example
from mypy_boto3_ivs.type_defs import StopStreamRequestRequestTypeDef
def get_value() -> StopStreamRequestRequestTypeDef:
return {
"channelArn": ...,
}
# StopStreamRequestRequestTypeDef definition
class StopStreamRequestRequestTypeDef(TypedDict):
channelArn: str,
StreamEventTypeDef#
# StreamEventTypeDef usage example
from mypy_boto3_ivs.type_defs import StreamEventTypeDef
def get_value() -> StreamEventTypeDef:
return {
"eventTime": ...,
}
# StreamEventTypeDef definition
class StreamEventTypeDef(TypedDict):
eventTime: NotRequired[datetime],
name: NotRequired[str],
type: NotRequired[str],
TagResourceRequestRequestTypeDef#
# TagResourceRequestRequestTypeDef usage example
from mypy_boto3_ivs.type_defs import TagResourceRequestRequestTypeDef
def get_value() -> TagResourceRequestRequestTypeDef:
return {
"resourceArn": ...,
"tags": ...,
}
# TagResourceRequestRequestTypeDef definition
class TagResourceRequestRequestTypeDef(TypedDict):
resourceArn: str,
tags: Mapping[str, str],
UntagResourceRequestRequestTypeDef#
# UntagResourceRequestRequestTypeDef usage example
from mypy_boto3_ivs.type_defs import UntagResourceRequestRequestTypeDef
def get_value() -> UntagResourceRequestRequestTypeDef:
return {
"resourceArn": ...,
"tagKeys": ...,
}
# UntagResourceRequestRequestTypeDef definition
class UntagResourceRequestRequestTypeDef(TypedDict):
resourceArn: str,
tagKeys: Sequence[str],
UpdateChannelRequestRequestTypeDef#
# UpdateChannelRequestRequestTypeDef usage example
from mypy_boto3_ivs.type_defs import UpdateChannelRequestRequestTypeDef
def get_value() -> UpdateChannelRequestRequestTypeDef:
return {
"arn": ...,
}
# UpdateChannelRequestRequestTypeDef definition
class UpdateChannelRequestRequestTypeDef(TypedDict):
arn: str,
authorized: NotRequired[bool],
insecureIngest: NotRequired[bool],
latencyMode: NotRequired[ChannelLatencyModeType], # (1)
name: NotRequired[str],
recordingConfigurationArn: NotRequired[str],
type: NotRequired[ChannelTypeType], # (2)
BatchGetChannelResponseTypeDef#
# BatchGetChannelResponseTypeDef usage example
from mypy_boto3_ivs.type_defs import BatchGetChannelResponseTypeDef
def get_value() -> BatchGetChannelResponseTypeDef:
return {
"channels": ...,
"errors": ...,
"ResponseMetadata": ...,
}
# BatchGetChannelResponseTypeDef definition
class BatchGetChannelResponseTypeDef(TypedDict):
channels: List[ChannelTypeDef], # (1)
errors: List[BatchErrorTypeDef], # (2)
ResponseMetadata: ResponseMetadataTypeDef, # (3)
- See ChannelTypeDef
- See BatchErrorTypeDef
- See ResponseMetadataTypeDef
GetChannelResponseTypeDef#
# GetChannelResponseTypeDef usage example
from mypy_boto3_ivs.type_defs import GetChannelResponseTypeDef
def get_value() -> GetChannelResponseTypeDef:
return {
"channel": ...,
"ResponseMetadata": ...,
}
# GetChannelResponseTypeDef definition
class GetChannelResponseTypeDef(TypedDict):
channel: ChannelTypeDef, # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
UpdateChannelResponseTypeDef#
# UpdateChannelResponseTypeDef usage example
from mypy_boto3_ivs.type_defs import UpdateChannelResponseTypeDef
def get_value() -> UpdateChannelResponseTypeDef:
return {
"channel": ...,
"ResponseMetadata": ...,
}
# UpdateChannelResponseTypeDef definition
class UpdateChannelResponseTypeDef(TypedDict):
channel: ChannelTypeDef, # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
BatchGetStreamKeyResponseTypeDef#
# BatchGetStreamKeyResponseTypeDef usage example
from mypy_boto3_ivs.type_defs import BatchGetStreamKeyResponseTypeDef
def get_value() -> BatchGetStreamKeyResponseTypeDef:
return {
"errors": ...,
"streamKeys": ...,
"ResponseMetadata": ...,
}
# BatchGetStreamKeyResponseTypeDef definition
class BatchGetStreamKeyResponseTypeDef(TypedDict):
errors: List[BatchErrorTypeDef], # (1)
streamKeys: List[StreamKeyTypeDef], # (2)
ResponseMetadata: ResponseMetadataTypeDef, # (3)
- See BatchErrorTypeDef
- See StreamKeyTypeDef
- See ResponseMetadataTypeDef
CreateChannelResponseTypeDef#
# CreateChannelResponseTypeDef usage example
from mypy_boto3_ivs.type_defs import CreateChannelResponseTypeDef
def get_value() -> CreateChannelResponseTypeDef:
return {
"channel": ...,
"streamKey": ...,
"ResponseMetadata": ...,
}
# CreateChannelResponseTypeDef definition
class CreateChannelResponseTypeDef(TypedDict):
channel: ChannelTypeDef, # (1)
streamKey: StreamKeyTypeDef, # (2)
ResponseMetadata: ResponseMetadataTypeDef, # (3)
- See ChannelTypeDef
- See StreamKeyTypeDef
- See ResponseMetadataTypeDef
CreateStreamKeyResponseTypeDef#
# CreateStreamKeyResponseTypeDef usage example
from mypy_boto3_ivs.type_defs import CreateStreamKeyResponseTypeDef
def get_value() -> CreateStreamKeyResponseTypeDef:
return {
"streamKey": ...,
"ResponseMetadata": ...,
}
# CreateStreamKeyResponseTypeDef definition
class CreateStreamKeyResponseTypeDef(TypedDict):
streamKey: StreamKeyTypeDef, # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
GetStreamKeyResponseTypeDef#
# GetStreamKeyResponseTypeDef usage example
from mypy_boto3_ivs.type_defs import GetStreamKeyResponseTypeDef
def get_value() -> GetStreamKeyResponseTypeDef:
return {
"streamKey": ...,
"ResponseMetadata": ...,
}
# GetStreamKeyResponseTypeDef definition
class GetStreamKeyResponseTypeDef(TypedDict):
streamKey: StreamKeyTypeDef, # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
ListChannelsResponseTypeDef#
# ListChannelsResponseTypeDef usage example
from mypy_boto3_ivs.type_defs import ListChannelsResponseTypeDef
def get_value() -> ListChannelsResponseTypeDef:
return {
"channels": ...,
"nextToken": ...,
"ResponseMetadata": ...,
}
# ListChannelsResponseTypeDef definition
class ListChannelsResponseTypeDef(TypedDict):
channels: List[ChannelSummaryTypeDef], # (1)
nextToken: str,
ResponseMetadata: ResponseMetadataTypeDef, # (2)
DestinationConfigurationTypeDef#
# DestinationConfigurationTypeDef usage example
from mypy_boto3_ivs.type_defs import DestinationConfigurationTypeDef
def get_value() -> DestinationConfigurationTypeDef:
return {
"s3": ...,
}
# DestinationConfigurationTypeDef definition
class DestinationConfigurationTypeDef(TypedDict):
s3: NotRequired[S3DestinationConfigurationTypeDef], # (1)
GetPlaybackKeyPairResponseTypeDef#
# GetPlaybackKeyPairResponseTypeDef usage example
from mypy_boto3_ivs.type_defs import GetPlaybackKeyPairResponseTypeDef
def get_value() -> GetPlaybackKeyPairResponseTypeDef:
return {
"keyPair": ...,
"ResponseMetadata": ...,
}
# GetPlaybackKeyPairResponseTypeDef definition
class GetPlaybackKeyPairResponseTypeDef(TypedDict):
keyPair: PlaybackKeyPairTypeDef, # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
ImportPlaybackKeyPairResponseTypeDef#
# ImportPlaybackKeyPairResponseTypeDef usage example
from mypy_boto3_ivs.type_defs import ImportPlaybackKeyPairResponseTypeDef
def get_value() -> ImportPlaybackKeyPairResponseTypeDef:
return {
"keyPair": ...,
"ResponseMetadata": ...,
}
# ImportPlaybackKeyPairResponseTypeDef definition
class ImportPlaybackKeyPairResponseTypeDef(TypedDict):
keyPair: PlaybackKeyPairTypeDef, # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
GetStreamResponseTypeDef#
# GetStreamResponseTypeDef usage example
from mypy_boto3_ivs.type_defs import GetStreamResponseTypeDef
def get_value() -> GetStreamResponseTypeDef:
return {
"stream": ...,
"ResponseMetadata": ...,
}
# GetStreamResponseTypeDef definition
class GetStreamResponseTypeDef(TypedDict):
stream: StreamTypeDef, # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
- See StreamTypeDef
- See ResponseMetadataTypeDef
IngestConfigurationTypeDef#
# IngestConfigurationTypeDef usage example
from mypy_boto3_ivs.type_defs import IngestConfigurationTypeDef
def get_value() -> IngestConfigurationTypeDef:
return {
"audio": ...,
}
# IngestConfigurationTypeDef definition
class IngestConfigurationTypeDef(TypedDict):
audio: NotRequired[AudioConfigurationTypeDef], # (1)
video: NotRequired[VideoConfigurationTypeDef], # (2)
ListPlaybackKeyPairsResponseTypeDef#
# ListPlaybackKeyPairsResponseTypeDef usage example
from mypy_boto3_ivs.type_defs import ListPlaybackKeyPairsResponseTypeDef
def get_value() -> ListPlaybackKeyPairsResponseTypeDef:
return {
"keyPairs": ...,
"nextToken": ...,
"ResponseMetadata": ...,
}
# ListPlaybackKeyPairsResponseTypeDef definition
class ListPlaybackKeyPairsResponseTypeDef(TypedDict):
keyPairs: List[PlaybackKeyPairSummaryTypeDef], # (1)
nextToken: str,
ResponseMetadata: ResponseMetadataTypeDef, # (2)
ListStreamKeysResponseTypeDef#
# ListStreamKeysResponseTypeDef usage example
from mypy_boto3_ivs.type_defs import ListStreamKeysResponseTypeDef
def get_value() -> ListStreamKeysResponseTypeDef:
return {
"nextToken": ...,
"streamKeys": ...,
"ResponseMetadata": ...,
}
# ListStreamKeysResponseTypeDef definition
class ListStreamKeysResponseTypeDef(TypedDict):
nextToken: str,
streamKeys: List[StreamKeySummaryTypeDef], # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
ListStreamSessionsResponseTypeDef#
# ListStreamSessionsResponseTypeDef usage example
from mypy_boto3_ivs.type_defs import ListStreamSessionsResponseTypeDef
def get_value() -> ListStreamSessionsResponseTypeDef:
return {
"nextToken": ...,
"streamSessions": ...,
"ResponseMetadata": ...,
}
# ListStreamSessionsResponseTypeDef definition
class ListStreamSessionsResponseTypeDef(TypedDict):
nextToken: str,
streamSessions: List[StreamSessionSummaryTypeDef], # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
ListStreamsRequestListStreamsPaginateTypeDef#
# ListStreamsRequestListStreamsPaginateTypeDef usage example
from mypy_boto3_ivs.type_defs import ListStreamsRequestListStreamsPaginateTypeDef
def get_value() -> ListStreamsRequestListStreamsPaginateTypeDef:
return {
"filterBy": ...,
}
# ListStreamsRequestListStreamsPaginateTypeDef definition
class ListStreamsRequestListStreamsPaginateTypeDef(TypedDict):
filterBy: NotRequired[StreamFiltersTypeDef], # (1)
PaginationConfig: NotRequired[PaginatorConfigTypeDef], # (2)
ListStreamsRequestRequestTypeDef#
# ListStreamsRequestRequestTypeDef usage example
from mypy_boto3_ivs.type_defs import ListStreamsRequestRequestTypeDef
def get_value() -> ListStreamsRequestRequestTypeDef:
return {
"filterBy": ...,
}
# ListStreamsRequestRequestTypeDef definition
class ListStreamsRequestRequestTypeDef(TypedDict):
filterBy: NotRequired[StreamFiltersTypeDef], # (1)
maxResults: NotRequired[int],
nextToken: NotRequired[str],
ListStreamsResponseTypeDef#
# ListStreamsResponseTypeDef usage example
from mypy_boto3_ivs.type_defs import ListStreamsResponseTypeDef
def get_value() -> ListStreamsResponseTypeDef:
return {
"nextToken": ...,
"streams": ...,
"ResponseMetadata": ...,
}
# ListStreamsResponseTypeDef definition
class ListStreamsResponseTypeDef(TypedDict):
nextToken: str,
streams: List[StreamSummaryTypeDef], # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
CreateRecordingConfigurationRequestRequestTypeDef#
# CreateRecordingConfigurationRequestRequestTypeDef usage example
from mypy_boto3_ivs.type_defs import CreateRecordingConfigurationRequestRequestTypeDef
def get_value() -> CreateRecordingConfigurationRequestRequestTypeDef:
return {
"destinationConfiguration": ...,
}
# CreateRecordingConfigurationRequestRequestTypeDef definition
class CreateRecordingConfigurationRequestRequestTypeDef(TypedDict):
destinationConfiguration: DestinationConfigurationTypeDef, # (1)
name: NotRequired[str],
recordingReconnectWindowSeconds: NotRequired[int],
tags: NotRequired[Mapping[str, str]],
thumbnailConfiguration: NotRequired[ThumbnailConfigurationTypeDef], # (2)
RecordingConfigurationSummaryTypeDef#
# RecordingConfigurationSummaryTypeDef usage example
from mypy_boto3_ivs.type_defs import RecordingConfigurationSummaryTypeDef
def get_value() -> RecordingConfigurationSummaryTypeDef:
return {
"arn": ...,
"destinationConfiguration": ...,
"state": ...,
}
# RecordingConfigurationSummaryTypeDef definition
class RecordingConfigurationSummaryTypeDef(TypedDict):
arn: str,
destinationConfiguration: DestinationConfigurationTypeDef, # (1)
state: RecordingConfigurationStateType, # (2)
name: NotRequired[str],
tags: NotRequired[Dict[str, str]],
RecordingConfigurationTypeDef#
# RecordingConfigurationTypeDef usage example
from mypy_boto3_ivs.type_defs import RecordingConfigurationTypeDef
def get_value() -> RecordingConfigurationTypeDef:
return {
"arn": ...,
"destinationConfiguration": ...,
"state": ...,
}
# RecordingConfigurationTypeDef definition
class RecordingConfigurationTypeDef(TypedDict):
arn: str,
destinationConfiguration: DestinationConfigurationTypeDef, # (1)
state: RecordingConfigurationStateType, # (2)
name: NotRequired[str],
recordingReconnectWindowSeconds: NotRequired[int],
tags: NotRequired[Dict[str, str]],
thumbnailConfiguration: NotRequired[ThumbnailConfigurationTypeDef], # (3)
- See DestinationConfigurationTypeDef
- See RecordingConfigurationStateType
- See ThumbnailConfigurationTypeDef
ListRecordingConfigurationsResponseTypeDef#
# ListRecordingConfigurationsResponseTypeDef usage example
from mypy_boto3_ivs.type_defs import ListRecordingConfigurationsResponseTypeDef
def get_value() -> ListRecordingConfigurationsResponseTypeDef:
return {
"nextToken": ...,
"recordingConfigurations": ...,
"ResponseMetadata": ...,
}
# ListRecordingConfigurationsResponseTypeDef definition
class ListRecordingConfigurationsResponseTypeDef(TypedDict):
nextToken: str,
recordingConfigurations: List[RecordingConfigurationSummaryTypeDef], # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
CreateRecordingConfigurationResponseTypeDef#
# CreateRecordingConfigurationResponseTypeDef usage example
from mypy_boto3_ivs.type_defs import CreateRecordingConfigurationResponseTypeDef
def get_value() -> CreateRecordingConfigurationResponseTypeDef:
return {
"recordingConfiguration": ...,
"ResponseMetadata": ...,
}
# CreateRecordingConfigurationResponseTypeDef definition
class CreateRecordingConfigurationResponseTypeDef(TypedDict):
recordingConfiguration: RecordingConfigurationTypeDef, # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
GetRecordingConfigurationResponseTypeDef#
# GetRecordingConfigurationResponseTypeDef usage example
from mypy_boto3_ivs.type_defs import GetRecordingConfigurationResponseTypeDef
def get_value() -> GetRecordingConfigurationResponseTypeDef:
return {
"recordingConfiguration": ...,
"ResponseMetadata": ...,
}
# GetRecordingConfigurationResponseTypeDef definition
class GetRecordingConfigurationResponseTypeDef(TypedDict):
recordingConfiguration: RecordingConfigurationTypeDef, # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
StreamSessionTypeDef#
# StreamSessionTypeDef usage example
from mypy_boto3_ivs.type_defs import StreamSessionTypeDef
def get_value() -> StreamSessionTypeDef:
return {
"channel": ...,
}
# StreamSessionTypeDef definition
class StreamSessionTypeDef(TypedDict):
channel: NotRequired[ChannelTypeDef], # (1)
endTime: NotRequired[datetime],
ingestConfiguration: NotRequired[IngestConfigurationTypeDef], # (2)
recordingConfiguration: NotRequired[RecordingConfigurationTypeDef], # (3)
startTime: NotRequired[datetime],
streamId: NotRequired[str],
truncatedEvents: NotRequired[List[StreamEventTypeDef]], # (4)
- See ChannelTypeDef
- See IngestConfigurationTypeDef
- See RecordingConfigurationTypeDef
- See StreamEventTypeDef
GetStreamSessionResponseTypeDef#
# GetStreamSessionResponseTypeDef usage example
from mypy_boto3_ivs.type_defs import GetStreamSessionResponseTypeDef
def get_value() -> GetStreamSessionResponseTypeDef:
return {
"streamSession": ...,
"ResponseMetadata": ...,
}
# GetStreamSessionResponseTypeDef definition
class GetStreamSessionResponseTypeDef(TypedDict):
streamSession: StreamSessionTypeDef, # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)