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