Type definitions#
Auto-generated documentation for IVS type annotations stubs module mypy-boto3-ivs.
AudioConfigurationTypeDef#
# AudioConfigurationTypeDef definition
class AudioConfigurationTypeDef(TypedDict):
channels: NotRequired[int],
codec: NotRequired[str],
sampleRate: NotRequired[int],
targetBitrate: NotRequired[int],
BatchErrorTypeDef#
# BatchErrorTypeDef definition
class BatchErrorTypeDef(TypedDict):
arn: NotRequired[str],
code: NotRequired[str],
message: NotRequired[str],
BatchGetChannelRequestRequestTypeDef#
# BatchGetChannelRequestRequestTypeDef definition
class BatchGetChannelRequestRequestTypeDef(TypedDict):
arns: Sequence[str],
ChannelTypeDef#
# 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],
preset: NotRequired[TranscodePresetType], # (2)
recordingConfigurationArn: NotRequired[str],
tags: NotRequired[Dict[str, str]],
type: NotRequired[ChannelTypeType], # (3)
- See ChannelLatencyModeType
- See TranscodePresetType
- See ChannelTypeType
ResponseMetadataTypeDef#
# ResponseMetadataTypeDef definition
class ResponseMetadataTypeDef(TypedDict):
RequestId: str,
HostId: str,
HTTPStatusCode: int,
HTTPHeaders: Dict[str, str],
RetryAttempts: int,
BatchGetStreamKeyRequestRequestTypeDef#
# BatchGetStreamKeyRequestRequestTypeDef definition
class BatchGetStreamKeyRequestRequestTypeDef(TypedDict):
arns: Sequence[str],
StreamKeyTypeDef#
# StreamKeyTypeDef definition
class StreamKeyTypeDef(TypedDict):
arn: NotRequired[str],
channelArn: NotRequired[str],
tags: NotRequired[Dict[str, str]],
value: NotRequired[str],
BatchStartViewerSessionRevocationErrorTypeDef#
# BatchStartViewerSessionRevocationErrorTypeDef definition
class BatchStartViewerSessionRevocationErrorTypeDef(TypedDict):
channelArn: str,
viewerId: str,
code: NotRequired[str],
message: NotRequired[str],
BatchStartViewerSessionRevocationViewerSessionTypeDef#
# BatchStartViewerSessionRevocationViewerSessionTypeDef definition
class BatchStartViewerSessionRevocationViewerSessionTypeDef(TypedDict):
channelArn: str,
viewerId: str,
viewerSessionVersionsLessThanOrEqualTo: NotRequired[int],
ChannelSummaryTypeDef#
# ChannelSummaryTypeDef definition
class ChannelSummaryTypeDef(TypedDict):
arn: NotRequired[str],
authorized: NotRequired[bool],
insecureIngest: NotRequired[bool],
latencyMode: NotRequired[ChannelLatencyModeType], # (1)
name: NotRequired[str],
preset: NotRequired[TranscodePresetType], # (2)
recordingConfigurationArn: NotRequired[str],
tags: NotRequired[Dict[str, str]],
type: NotRequired[ChannelTypeType], # (3)
- See ChannelLatencyModeType
- See TranscodePresetType
- See ChannelTypeType
CreateChannelRequestRequestTypeDef#
# CreateChannelRequestRequestTypeDef definition
class CreateChannelRequestRequestTypeDef(TypedDict):
authorized: NotRequired[bool],
insecureIngest: NotRequired[bool],
latencyMode: NotRequired[ChannelLatencyModeType], # (1)
name: NotRequired[str],
preset: NotRequired[TranscodePresetType], # (2)
recordingConfigurationArn: NotRequired[str],
tags: NotRequired[Mapping[str, str]],
type: NotRequired[ChannelTypeType], # (3)
- See ChannelLatencyModeType
- See TranscodePresetType
- See ChannelTypeType
RenditionConfigurationTypeDef#
# RenditionConfigurationTypeDef definition
class RenditionConfigurationTypeDef(TypedDict):
renditionSelection: NotRequired[RenditionConfigurationRenditionSelectionType], # (1)
renditions: NotRequired[Sequence[RenditionConfigurationRenditionType]], # (2)
ThumbnailConfigurationTypeDef#
# ThumbnailConfigurationTypeDef definition
class ThumbnailConfigurationTypeDef(TypedDict):
recordingMode: NotRequired[RecordingModeType], # (1)
resolution: NotRequired[ThumbnailConfigurationResolutionType], # (2)
storage: NotRequired[Sequence[ThumbnailConfigurationStorageType]], # (3)
targetIntervalSeconds: NotRequired[int],
- See RecordingModeType
- See ThumbnailConfigurationResolutionType
- See ThumbnailConfigurationStorageType
CreateStreamKeyRequestRequestTypeDef#
# CreateStreamKeyRequestRequestTypeDef definition
class CreateStreamKeyRequestRequestTypeDef(TypedDict):
channelArn: str,
tags: NotRequired[Mapping[str, str]],
DeleteChannelRequestRequestTypeDef#
# DeleteChannelRequestRequestTypeDef definition
class DeleteChannelRequestRequestTypeDef(TypedDict):
arn: str,
DeletePlaybackKeyPairRequestRequestTypeDef#
# DeletePlaybackKeyPairRequestRequestTypeDef definition
class DeletePlaybackKeyPairRequestRequestTypeDef(TypedDict):
arn: str,
DeleteRecordingConfigurationRequestRequestTypeDef#
# DeleteRecordingConfigurationRequestRequestTypeDef definition
class DeleteRecordingConfigurationRequestRequestTypeDef(TypedDict):
arn: str,
DeleteStreamKeyRequestRequestTypeDef#
# DeleteStreamKeyRequestRequestTypeDef definition
class DeleteStreamKeyRequestRequestTypeDef(TypedDict):
arn: str,
S3DestinationConfigurationTypeDef#
# S3DestinationConfigurationTypeDef definition
class S3DestinationConfigurationTypeDef(TypedDict):
bucketName: str,
GetChannelRequestRequestTypeDef#
# GetChannelRequestRequestTypeDef definition
class GetChannelRequestRequestTypeDef(TypedDict):
arn: str,
GetPlaybackKeyPairRequestRequestTypeDef#
# GetPlaybackKeyPairRequestRequestTypeDef definition
class GetPlaybackKeyPairRequestRequestTypeDef(TypedDict):
arn: str,
PlaybackKeyPairTypeDef#
# PlaybackKeyPairTypeDef definition
class PlaybackKeyPairTypeDef(TypedDict):
arn: NotRequired[str],
fingerprint: NotRequired[str],
name: NotRequired[str],
tags: NotRequired[Dict[str, str]],
GetRecordingConfigurationRequestRequestTypeDef#
# GetRecordingConfigurationRequestRequestTypeDef definition
class GetRecordingConfigurationRequestRequestTypeDef(TypedDict):
arn: str,
GetStreamKeyRequestRequestTypeDef#
# GetStreamKeyRequestRequestTypeDef definition
class GetStreamKeyRequestRequestTypeDef(TypedDict):
arn: str,
GetStreamRequestRequestTypeDef#
# GetStreamRequestRequestTypeDef definition
class GetStreamRequestRequestTypeDef(TypedDict):
channelArn: str,
StreamTypeDef#
# 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 definition
class GetStreamSessionRequestRequestTypeDef(TypedDict):
channelArn: str,
streamId: NotRequired[str],
ImportPlaybackKeyPairRequestRequestTypeDef#
# ImportPlaybackKeyPairRequestRequestTypeDef definition
class ImportPlaybackKeyPairRequestRequestTypeDef(TypedDict):
publicKeyMaterial: str,
name: NotRequired[str],
tags: NotRequired[Mapping[str, str]],
VideoConfigurationTypeDef#
# 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],
PaginatorConfigTypeDef#
# PaginatorConfigTypeDef definition
class PaginatorConfigTypeDef(TypedDict):
MaxItems: NotRequired[int],
PageSize: NotRequired[int],
StartingToken: NotRequired[str],
ListChannelsRequestRequestTypeDef#
# ListChannelsRequestRequestTypeDef definition
class ListChannelsRequestRequestTypeDef(TypedDict):
filterByName: NotRequired[str],
filterByRecordingConfigurationArn: NotRequired[str],
maxResults: NotRequired[int],
nextToken: NotRequired[str],
ListPlaybackKeyPairsRequestRequestTypeDef#
# ListPlaybackKeyPairsRequestRequestTypeDef definition
class ListPlaybackKeyPairsRequestRequestTypeDef(TypedDict):
maxResults: NotRequired[int],
nextToken: NotRequired[str],
PlaybackKeyPairSummaryTypeDef#
# PlaybackKeyPairSummaryTypeDef definition
class PlaybackKeyPairSummaryTypeDef(TypedDict):
arn: NotRequired[str],
name: NotRequired[str],
tags: NotRequired[Dict[str, str]],
ListRecordingConfigurationsRequestRequestTypeDef#
# ListRecordingConfigurationsRequestRequestTypeDef definition
class ListRecordingConfigurationsRequestRequestTypeDef(TypedDict):
maxResults: NotRequired[int],
nextToken: NotRequired[str],
ListStreamKeysRequestRequestTypeDef#
# ListStreamKeysRequestRequestTypeDef definition
class ListStreamKeysRequestRequestTypeDef(TypedDict):
channelArn: str,
maxResults: NotRequired[int],
nextToken: NotRequired[str],
StreamKeySummaryTypeDef#
# StreamKeySummaryTypeDef definition
class StreamKeySummaryTypeDef(TypedDict):
arn: NotRequired[str],
channelArn: NotRequired[str],
tags: NotRequired[Dict[str, str]],
ListStreamSessionsRequestRequestTypeDef#
# ListStreamSessionsRequestRequestTypeDef definition
class ListStreamSessionsRequestRequestTypeDef(TypedDict):
channelArn: str,
maxResults: NotRequired[int],
nextToken: NotRequired[str],
StreamSessionSummaryTypeDef#
# StreamSessionSummaryTypeDef definition
class StreamSessionSummaryTypeDef(TypedDict):
endTime: NotRequired[datetime],
hasErrorEvent: NotRequired[bool],
startTime: NotRequired[datetime],
streamId: NotRequired[str],
StreamFiltersTypeDef#
# StreamFiltersTypeDef definition
class StreamFiltersTypeDef(TypedDict):
health: NotRequired[StreamHealthType], # (1)
- See StreamHealthType
StreamSummaryTypeDef#
# 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 definition
class ListTagsForResourceRequestRequestTypeDef(TypedDict):
resourceArn: str,
PutMetadataRequestRequestTypeDef#
# PutMetadataRequestRequestTypeDef definition
class PutMetadataRequestRequestTypeDef(TypedDict):
channelArn: str,
metadata: str,
StartViewerSessionRevocationRequestRequestTypeDef#
# StartViewerSessionRevocationRequestRequestTypeDef definition
class StartViewerSessionRevocationRequestRequestTypeDef(TypedDict):
channelArn: str,
viewerId: str,
viewerSessionVersionsLessThanOrEqualTo: NotRequired[int],
StopStreamRequestRequestTypeDef#
# StopStreamRequestRequestTypeDef definition
class StopStreamRequestRequestTypeDef(TypedDict):
channelArn: str,
StreamEventTypeDef#
# StreamEventTypeDef definition
class StreamEventTypeDef(TypedDict):
eventTime: NotRequired[datetime],
name: NotRequired[str],
type: NotRequired[str],
TagResourceRequestRequestTypeDef#
# TagResourceRequestRequestTypeDef definition
class TagResourceRequestRequestTypeDef(TypedDict):
resourceArn: str,
tags: Mapping[str, str],
UntagResourceRequestRequestTypeDef#
# UntagResourceRequestRequestTypeDef definition
class UntagResourceRequestRequestTypeDef(TypedDict):
resourceArn: str,
tagKeys: Sequence[str],
UpdateChannelRequestRequestTypeDef#
# UpdateChannelRequestRequestTypeDef definition
class UpdateChannelRequestRequestTypeDef(TypedDict):
arn: str,
authorized: NotRequired[bool],
insecureIngest: NotRequired[bool],
latencyMode: NotRequired[ChannelLatencyModeType], # (1)
name: NotRequired[str],
preset: NotRequired[TranscodePresetType], # (2)
recordingConfigurationArn: NotRequired[str],
type: NotRequired[ChannelTypeType], # (3)
- See ChannelLatencyModeType
- See TranscodePresetType
- See ChannelTypeType
BatchGetChannelResponseTypeDef#
# BatchGetChannelResponseTypeDef definition
class BatchGetChannelResponseTypeDef(TypedDict):
channels: List[ChannelTypeDef], # (1)
errors: List[BatchErrorTypeDef], # (2)
ResponseMetadata: ResponseMetadataTypeDef, # (3)
- See ChannelTypeDef
- See BatchErrorTypeDef
- See ResponseMetadataTypeDef
EmptyResponseMetadataTypeDef#
# EmptyResponseMetadataTypeDef definition
class EmptyResponseMetadataTypeDef(TypedDict):
ResponseMetadata: ResponseMetadataTypeDef, # (1)
GetChannelResponseTypeDef#
# GetChannelResponseTypeDef definition
class GetChannelResponseTypeDef(TypedDict):
channel: ChannelTypeDef, # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
ListTagsForResourceResponseTypeDef#
# ListTagsForResourceResponseTypeDef definition
class ListTagsForResourceResponseTypeDef(TypedDict):
tags: Dict[str, str],
ResponseMetadata: ResponseMetadataTypeDef, # (1)
UpdateChannelResponseTypeDef#
# UpdateChannelResponseTypeDef definition
class UpdateChannelResponseTypeDef(TypedDict):
channel: ChannelTypeDef, # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
BatchGetStreamKeyResponseTypeDef#
# BatchGetStreamKeyResponseTypeDef definition
class BatchGetStreamKeyResponseTypeDef(TypedDict):
errors: List[BatchErrorTypeDef], # (1)
streamKeys: List[StreamKeyTypeDef], # (2)
ResponseMetadata: ResponseMetadataTypeDef, # (3)
- See BatchErrorTypeDef
- See StreamKeyTypeDef
- See ResponseMetadataTypeDef
CreateChannelResponseTypeDef#
# CreateChannelResponseTypeDef definition
class CreateChannelResponseTypeDef(TypedDict):
channel: ChannelTypeDef, # (1)
streamKey: StreamKeyTypeDef, # (2)
ResponseMetadata: ResponseMetadataTypeDef, # (3)
- See ChannelTypeDef
- See StreamKeyTypeDef
- See ResponseMetadataTypeDef
CreateStreamKeyResponseTypeDef#
# CreateStreamKeyResponseTypeDef definition
class CreateStreamKeyResponseTypeDef(TypedDict):
streamKey: StreamKeyTypeDef, # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
GetStreamKeyResponseTypeDef#
# GetStreamKeyResponseTypeDef definition
class GetStreamKeyResponseTypeDef(TypedDict):
streamKey: StreamKeyTypeDef, # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
BatchStartViewerSessionRevocationResponseTypeDef#
# BatchStartViewerSessionRevocationResponseTypeDef definition
class BatchStartViewerSessionRevocationResponseTypeDef(TypedDict):
errors: List[BatchStartViewerSessionRevocationErrorTypeDef], # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
BatchStartViewerSessionRevocationRequestRequestTypeDef#
# BatchStartViewerSessionRevocationRequestRequestTypeDef definition
class BatchStartViewerSessionRevocationRequestRequestTypeDef(TypedDict):
viewerSessions: Sequence[BatchStartViewerSessionRevocationViewerSessionTypeDef], # (1)
ListChannelsResponseTypeDef#
# ListChannelsResponseTypeDef definition
class ListChannelsResponseTypeDef(TypedDict):
channels: List[ChannelSummaryTypeDef], # (1)
nextToken: str,
ResponseMetadata: ResponseMetadataTypeDef, # (2)
DestinationConfigurationTypeDef#
# DestinationConfigurationTypeDef definition
class DestinationConfigurationTypeDef(TypedDict):
s3: NotRequired[S3DestinationConfigurationTypeDef], # (1)
GetPlaybackKeyPairResponseTypeDef#
# GetPlaybackKeyPairResponseTypeDef definition
class GetPlaybackKeyPairResponseTypeDef(TypedDict):
keyPair: PlaybackKeyPairTypeDef, # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
ImportPlaybackKeyPairResponseTypeDef#
# ImportPlaybackKeyPairResponseTypeDef definition
class ImportPlaybackKeyPairResponseTypeDef(TypedDict):
keyPair: PlaybackKeyPairTypeDef, # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
GetStreamResponseTypeDef#
# GetStreamResponseTypeDef definition
class GetStreamResponseTypeDef(TypedDict):
stream: StreamTypeDef, # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
- See StreamTypeDef
- See ResponseMetadataTypeDef
IngestConfigurationTypeDef#
# IngestConfigurationTypeDef definition
class IngestConfigurationTypeDef(TypedDict):
audio: NotRequired[AudioConfigurationTypeDef], # (1)
video: NotRequired[VideoConfigurationTypeDef], # (2)
ListChannelsRequestListChannelsPaginateTypeDef#
# ListChannelsRequestListChannelsPaginateTypeDef definition
class ListChannelsRequestListChannelsPaginateTypeDef(TypedDict):
filterByName: NotRequired[str],
filterByRecordingConfigurationArn: NotRequired[str],
PaginationConfig: NotRequired[PaginatorConfigTypeDef], # (1)
ListPlaybackKeyPairsRequestListPlaybackKeyPairsPaginateTypeDef#
# ListPlaybackKeyPairsRequestListPlaybackKeyPairsPaginateTypeDef definition
class ListPlaybackKeyPairsRequestListPlaybackKeyPairsPaginateTypeDef(TypedDict):
PaginationConfig: NotRequired[PaginatorConfigTypeDef], # (1)
ListRecordingConfigurationsRequestListRecordingConfigurationsPaginateTypeDef#
# ListRecordingConfigurationsRequestListRecordingConfigurationsPaginateTypeDef definition
class ListRecordingConfigurationsRequestListRecordingConfigurationsPaginateTypeDef(TypedDict):
PaginationConfig: NotRequired[PaginatorConfigTypeDef], # (1)
ListStreamKeysRequestListStreamKeysPaginateTypeDef#
# ListStreamKeysRequestListStreamKeysPaginateTypeDef definition
class ListStreamKeysRequestListStreamKeysPaginateTypeDef(TypedDict):
channelArn: str,
PaginationConfig: NotRequired[PaginatorConfigTypeDef], # (1)
ListPlaybackKeyPairsResponseTypeDef#
# ListPlaybackKeyPairsResponseTypeDef definition
class ListPlaybackKeyPairsResponseTypeDef(TypedDict):
keyPairs: List[PlaybackKeyPairSummaryTypeDef], # (1)
nextToken: str,
ResponseMetadata: ResponseMetadataTypeDef, # (2)
ListStreamKeysResponseTypeDef#
# ListStreamKeysResponseTypeDef definition
class ListStreamKeysResponseTypeDef(TypedDict):
nextToken: str,
streamKeys: List[StreamKeySummaryTypeDef], # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
ListStreamSessionsResponseTypeDef#
# ListStreamSessionsResponseTypeDef definition
class ListStreamSessionsResponseTypeDef(TypedDict):
nextToken: str,
streamSessions: List[StreamSessionSummaryTypeDef], # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
ListStreamsRequestListStreamsPaginateTypeDef#
# ListStreamsRequestListStreamsPaginateTypeDef definition
class ListStreamsRequestListStreamsPaginateTypeDef(TypedDict):
filterBy: NotRequired[StreamFiltersTypeDef], # (1)
PaginationConfig: NotRequired[PaginatorConfigTypeDef], # (2)
ListStreamsRequestRequestTypeDef#
# ListStreamsRequestRequestTypeDef definition
class ListStreamsRequestRequestTypeDef(TypedDict):
filterBy: NotRequired[StreamFiltersTypeDef], # (1)
maxResults: NotRequired[int],
nextToken: NotRequired[str],