Skip to content

Type definitions#

Index > IVS > Type definitions

Auto-generated documentation for IVS type annotations stubs module types-boto3-ivs.

RenditionConfigurationUnionTypeDef#

# RenditionConfigurationUnionTypeDef Union usage example

from types_boto3_ivs.type_defs import RenditionConfigurationUnionTypeDef


def get_value() -> RenditionConfigurationUnionTypeDef:
    return ...


# RenditionConfigurationUnionTypeDef definition

RenditionConfigurationUnionTypeDef = Union[
    RenditionConfigurationTypeDef,  # (1)
    RenditionConfigurationOutputTypeDef,  # (2)
]
  1. See RenditionConfigurationTypeDef
  2. See RenditionConfigurationOutputTypeDef

ThumbnailConfigurationUnionTypeDef#

# ThumbnailConfigurationUnionTypeDef Union usage example

from types_boto3_ivs.type_defs import ThumbnailConfigurationUnionTypeDef


def get_value() -> ThumbnailConfigurationUnionTypeDef:
    return ...


# ThumbnailConfigurationUnionTypeDef definition

ThumbnailConfigurationUnionTypeDef = Union[
    ThumbnailConfigurationTypeDef,  # (1)
    ThumbnailConfigurationOutputTypeDef,  # (2)
]
  1. See ThumbnailConfigurationTypeDef
  2. See ThumbnailConfigurationOutputTypeDef

AudioConfigurationTypeDef#

# AudioConfigurationTypeDef TypedDict usage example

from types_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],
    track: NotRequired[str],

BatchErrorTypeDef#

# BatchErrorTypeDef TypedDict usage example

from types_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],

BatchGetChannelRequestTypeDef#

# BatchGetChannelRequestTypeDef TypedDict usage example

from types_boto3_ivs.type_defs import BatchGetChannelRequestTypeDef


def get_value() -> BatchGetChannelRequestTypeDef:
    return {
        "arns": ...,
    }


# BatchGetChannelRequestTypeDef definition

class BatchGetChannelRequestTypeDef(TypedDict):
    arns: Sequence[str],

ResponseMetadataTypeDef#

# ResponseMetadataTypeDef TypedDict usage example

from types_boto3_ivs.type_defs import ResponseMetadataTypeDef


def get_value() -> ResponseMetadataTypeDef:
    return {
        "RequestId": ...,
    }


# ResponseMetadataTypeDef definition

class ResponseMetadataTypeDef(TypedDict):
    RequestId: str,
    HTTPStatusCode: int,
    HTTPHeaders: Dict[str, str],
    RetryAttempts: int,
    HostId: NotRequired[str],

BatchGetStreamKeyRequestTypeDef#

# BatchGetStreamKeyRequestTypeDef TypedDict usage example

from types_boto3_ivs.type_defs import BatchGetStreamKeyRequestTypeDef


def get_value() -> BatchGetStreamKeyRequestTypeDef:
    return {
        "arns": ...,
    }


# BatchGetStreamKeyRequestTypeDef definition

class BatchGetStreamKeyRequestTypeDef(TypedDict):
    arns: Sequence[str],

StreamKeyTypeDef#

# StreamKeyTypeDef TypedDict usage example

from types_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],

BatchStartViewerSessionRevocationErrorTypeDef#

# BatchStartViewerSessionRevocationErrorTypeDef TypedDict usage example

from types_boto3_ivs.type_defs import BatchStartViewerSessionRevocationErrorTypeDef


def get_value() -> BatchStartViewerSessionRevocationErrorTypeDef:
    return {
        "channelArn": ...,
    }


# BatchStartViewerSessionRevocationErrorTypeDef definition

class BatchStartViewerSessionRevocationErrorTypeDef(TypedDict):
    channelArn: str,
    viewerId: str,
    code: NotRequired[str],
    message: NotRequired[str],

BatchStartViewerSessionRevocationViewerSessionTypeDef#

# BatchStartViewerSessionRevocationViewerSessionTypeDef TypedDict usage example

from types_boto3_ivs.type_defs import BatchStartViewerSessionRevocationViewerSessionTypeDef


def get_value() -> BatchStartViewerSessionRevocationViewerSessionTypeDef:
    return {
        "channelArn": ...,
    }


# BatchStartViewerSessionRevocationViewerSessionTypeDef definition

class BatchStartViewerSessionRevocationViewerSessionTypeDef(TypedDict):
    channelArn: str,
    viewerId: str,
    viewerSessionVersionsLessThanOrEqualTo: NotRequired[int],

ChannelSummaryTypeDef#

# ChannelSummaryTypeDef TypedDict usage example

from types_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],
    playbackRestrictionPolicyArn: NotRequired[str],
    preset: NotRequired[TranscodePresetType],  # (2)
    recordingConfigurationArn: NotRequired[str],
    tags: NotRequired[Dict[str, str]],
    type: NotRequired[ChannelTypeType],  # (3)
  1. See ChannelLatencyModeType
  2. See TranscodePresetType
  3. See ChannelTypeType

MultitrackInputConfigurationTypeDef#

# MultitrackInputConfigurationTypeDef TypedDict usage example

from types_boto3_ivs.type_defs import MultitrackInputConfigurationTypeDef


def get_value() -> MultitrackInputConfigurationTypeDef:
    return {
        "enabled": ...,
    }


# MultitrackInputConfigurationTypeDef definition

class MultitrackInputConfigurationTypeDef(TypedDict):
    enabled: NotRequired[bool],
    maximumResolution: NotRequired[MultitrackMaximumResolutionType],  # (1)
    policy: NotRequired[MultitrackPolicyType],  # (2)
  1. See MultitrackMaximumResolutionType
  2. See MultitrackPolicyType

SrtTypeDef#

# SrtTypeDef TypedDict usage example

from types_boto3_ivs.type_defs import SrtTypeDef


def get_value() -> SrtTypeDef:
    return {
        "endpoint": ...,
    }


# SrtTypeDef definition

class SrtTypeDef(TypedDict):
    endpoint: NotRequired[str],
    passphrase: NotRequired[str],

CreatePlaybackRestrictionPolicyRequestTypeDef#

# CreatePlaybackRestrictionPolicyRequestTypeDef TypedDict usage example

from types_boto3_ivs.type_defs import CreatePlaybackRestrictionPolicyRequestTypeDef


def get_value() -> CreatePlaybackRestrictionPolicyRequestTypeDef:
    return {
        "allowedCountries": ...,
    }


# CreatePlaybackRestrictionPolicyRequestTypeDef definition

class CreatePlaybackRestrictionPolicyRequestTypeDef(TypedDict):
    allowedCountries: NotRequired[Sequence[str]],
    allowedOrigins: NotRequired[Sequence[str]],
    enableStrictOriginEnforcement: NotRequired[bool],
    name: NotRequired[str],
    tags: NotRequired[Mapping[str, str]],

PlaybackRestrictionPolicyTypeDef#

# PlaybackRestrictionPolicyTypeDef TypedDict usage example

from types_boto3_ivs.type_defs import PlaybackRestrictionPolicyTypeDef


def get_value() -> PlaybackRestrictionPolicyTypeDef:
    return {
        "allowedCountries": ...,
    }


# PlaybackRestrictionPolicyTypeDef definition

class PlaybackRestrictionPolicyTypeDef(TypedDict):
    allowedCountries: List[str],
    allowedOrigins: List[str],
    arn: str,
    enableStrictOriginEnforcement: NotRequired[bool],
    name: NotRequired[str],
    tags: NotRequired[Dict[str, str]],

CreateStreamKeyRequestTypeDef#

# CreateStreamKeyRequestTypeDef TypedDict usage example

from types_boto3_ivs.type_defs import CreateStreamKeyRequestTypeDef


def get_value() -> CreateStreamKeyRequestTypeDef:
    return {
        "channelArn": ...,
    }


# CreateStreamKeyRequestTypeDef definition

class CreateStreamKeyRequestTypeDef(TypedDict):
    channelArn: str,
    tags: NotRequired[Mapping[str, str]],

DeleteChannelRequestTypeDef#

# DeleteChannelRequestTypeDef TypedDict usage example

from types_boto3_ivs.type_defs import DeleteChannelRequestTypeDef


def get_value() -> DeleteChannelRequestTypeDef:
    return {
        "arn": ...,
    }


# DeleteChannelRequestTypeDef definition

class DeleteChannelRequestTypeDef(TypedDict):
    arn: str,

DeletePlaybackKeyPairRequestTypeDef#

# DeletePlaybackKeyPairRequestTypeDef TypedDict usage example

from types_boto3_ivs.type_defs import DeletePlaybackKeyPairRequestTypeDef


def get_value() -> DeletePlaybackKeyPairRequestTypeDef:
    return {
        "arn": ...,
    }


# DeletePlaybackKeyPairRequestTypeDef definition

class DeletePlaybackKeyPairRequestTypeDef(TypedDict):
    arn: str,

DeletePlaybackRestrictionPolicyRequestTypeDef#

# DeletePlaybackRestrictionPolicyRequestTypeDef TypedDict usage example

from types_boto3_ivs.type_defs import DeletePlaybackRestrictionPolicyRequestTypeDef


def get_value() -> DeletePlaybackRestrictionPolicyRequestTypeDef:
    return {
        "arn": ...,
    }


# DeletePlaybackRestrictionPolicyRequestTypeDef definition

class DeletePlaybackRestrictionPolicyRequestTypeDef(TypedDict):
    arn: str,

DeleteRecordingConfigurationRequestTypeDef#

# DeleteRecordingConfigurationRequestTypeDef TypedDict usage example

from types_boto3_ivs.type_defs import DeleteRecordingConfigurationRequestTypeDef


def get_value() -> DeleteRecordingConfigurationRequestTypeDef:
    return {
        "arn": ...,
    }


# DeleteRecordingConfigurationRequestTypeDef definition

class DeleteRecordingConfigurationRequestTypeDef(TypedDict):
    arn: str,

DeleteStreamKeyRequestTypeDef#

# DeleteStreamKeyRequestTypeDef TypedDict usage example

from types_boto3_ivs.type_defs import DeleteStreamKeyRequestTypeDef


def get_value() -> DeleteStreamKeyRequestTypeDef:
    return {
        "arn": ...,
    }


# DeleteStreamKeyRequestTypeDef definition

class DeleteStreamKeyRequestTypeDef(TypedDict):
    arn: str,

S3DestinationConfigurationTypeDef#

# S3DestinationConfigurationTypeDef TypedDict usage example

from types_boto3_ivs.type_defs import S3DestinationConfigurationTypeDef


def get_value() -> S3DestinationConfigurationTypeDef:
    return {
        "bucketName": ...,
    }


# S3DestinationConfigurationTypeDef definition

class S3DestinationConfigurationTypeDef(TypedDict):
    bucketName: str,

GetChannelRequestTypeDef#

# GetChannelRequestTypeDef TypedDict usage example

from types_boto3_ivs.type_defs import GetChannelRequestTypeDef


def get_value() -> GetChannelRequestTypeDef:
    return {
        "arn": ...,
    }


# GetChannelRequestTypeDef definition

class GetChannelRequestTypeDef(TypedDict):
    arn: str,

GetPlaybackKeyPairRequestTypeDef#

# GetPlaybackKeyPairRequestTypeDef TypedDict usage example

from types_boto3_ivs.type_defs import GetPlaybackKeyPairRequestTypeDef


def get_value() -> GetPlaybackKeyPairRequestTypeDef:
    return {
        "arn": ...,
    }


# GetPlaybackKeyPairRequestTypeDef definition

class GetPlaybackKeyPairRequestTypeDef(TypedDict):
    arn: str,

PlaybackKeyPairTypeDef#

# PlaybackKeyPairTypeDef TypedDict usage example

from types_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]],

GetPlaybackRestrictionPolicyRequestTypeDef#

# GetPlaybackRestrictionPolicyRequestTypeDef TypedDict usage example

from types_boto3_ivs.type_defs import GetPlaybackRestrictionPolicyRequestTypeDef


def get_value() -> GetPlaybackRestrictionPolicyRequestTypeDef:
    return {
        "arn": ...,
    }


# GetPlaybackRestrictionPolicyRequestTypeDef definition

class GetPlaybackRestrictionPolicyRequestTypeDef(TypedDict):
    arn: str,

GetRecordingConfigurationRequestTypeDef#

# GetRecordingConfigurationRequestTypeDef TypedDict usage example

from types_boto3_ivs.type_defs import GetRecordingConfigurationRequestTypeDef


def get_value() -> GetRecordingConfigurationRequestTypeDef:
    return {
        "arn": ...,
    }


# GetRecordingConfigurationRequestTypeDef definition

class GetRecordingConfigurationRequestTypeDef(TypedDict):
    arn: str,

GetStreamKeyRequestTypeDef#

# GetStreamKeyRequestTypeDef TypedDict usage example

from types_boto3_ivs.type_defs import GetStreamKeyRequestTypeDef


def get_value() -> GetStreamKeyRequestTypeDef:
    return {
        "arn": ...,
    }


# GetStreamKeyRequestTypeDef definition

class GetStreamKeyRequestTypeDef(TypedDict):
    arn: str,

GetStreamRequestTypeDef#

# GetStreamRequestTypeDef TypedDict usage example

from types_boto3_ivs.type_defs import GetStreamRequestTypeDef


def get_value() -> GetStreamRequestTypeDef:
    return {
        "channelArn": ...,
    }


# GetStreamRequestTypeDef definition

class GetStreamRequestTypeDef(TypedDict):
    channelArn: str,

StreamTypeDef#

# StreamTypeDef TypedDict usage example

from types_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.datetime],
    state: NotRequired[StreamStateType],  # (2)
    streamId: NotRequired[str],
    viewerCount: NotRequired[int],
  1. See StreamHealthType
  2. See StreamStateType

GetStreamSessionRequestTypeDef#

# GetStreamSessionRequestTypeDef TypedDict usage example

from types_boto3_ivs.type_defs import GetStreamSessionRequestTypeDef


def get_value() -> GetStreamSessionRequestTypeDef:
    return {
        "channelArn": ...,
    }


# GetStreamSessionRequestTypeDef definition

class GetStreamSessionRequestTypeDef(TypedDict):
    channelArn: str,
    streamId: NotRequired[str],

ImportPlaybackKeyPairRequestTypeDef#

# ImportPlaybackKeyPairRequestTypeDef TypedDict usage example

from types_boto3_ivs.type_defs import ImportPlaybackKeyPairRequestTypeDef


def get_value() -> ImportPlaybackKeyPairRequestTypeDef:
    return {
        "publicKeyMaterial": ...,
    }


# ImportPlaybackKeyPairRequestTypeDef definition

class ImportPlaybackKeyPairRequestTypeDef(TypedDict):
    publicKeyMaterial: str,
    name: NotRequired[str],
    tags: NotRequired[Mapping[str, str]],

VideoConfigurationTypeDef#

# VideoConfigurationTypeDef TypedDict usage example

from types_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],
    level: NotRequired[str],
    profile: NotRequired[str],
    targetBitrate: NotRequired[int],
    targetFramerate: NotRequired[int],
    track: NotRequired[str],
    videoHeight: NotRequired[int],
    videoWidth: NotRequired[int],

PaginatorConfigTypeDef#

# PaginatorConfigTypeDef TypedDict usage example

from types_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],

ListChannelsRequestTypeDef#

# ListChannelsRequestTypeDef TypedDict usage example

from types_boto3_ivs.type_defs import ListChannelsRequestTypeDef


def get_value() -> ListChannelsRequestTypeDef:
    return {
        "filterByName": ...,
    }


# ListChannelsRequestTypeDef definition

class ListChannelsRequestTypeDef(TypedDict):
    filterByName: NotRequired[str],
    filterByPlaybackRestrictionPolicyArn: NotRequired[str],
    filterByRecordingConfigurationArn: NotRequired[str],
    maxResults: NotRequired[int],
    nextToken: NotRequired[str],

ListPlaybackKeyPairsRequestTypeDef#

# ListPlaybackKeyPairsRequestTypeDef TypedDict usage example

from types_boto3_ivs.type_defs import ListPlaybackKeyPairsRequestTypeDef


def get_value() -> ListPlaybackKeyPairsRequestTypeDef:
    return {
        "maxResults": ...,
    }


# ListPlaybackKeyPairsRequestTypeDef definition

class ListPlaybackKeyPairsRequestTypeDef(TypedDict):
    maxResults: NotRequired[int],
    nextToken: NotRequired[str],

PlaybackKeyPairSummaryTypeDef#

# PlaybackKeyPairSummaryTypeDef TypedDict usage example

from types_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]],

ListPlaybackRestrictionPoliciesRequestTypeDef#

# ListPlaybackRestrictionPoliciesRequestTypeDef TypedDict usage example

from types_boto3_ivs.type_defs import ListPlaybackRestrictionPoliciesRequestTypeDef


def get_value() -> ListPlaybackRestrictionPoliciesRequestTypeDef:
    return {
        "maxResults": ...,
    }


# ListPlaybackRestrictionPoliciesRequestTypeDef definition

class ListPlaybackRestrictionPoliciesRequestTypeDef(TypedDict):
    maxResults: NotRequired[int],
    nextToken: NotRequired[str],

PlaybackRestrictionPolicySummaryTypeDef#

# PlaybackRestrictionPolicySummaryTypeDef TypedDict usage example

from types_boto3_ivs.type_defs import PlaybackRestrictionPolicySummaryTypeDef


def get_value() -> PlaybackRestrictionPolicySummaryTypeDef:
    return {
        "allowedCountries": ...,
    }


# PlaybackRestrictionPolicySummaryTypeDef definition

class PlaybackRestrictionPolicySummaryTypeDef(TypedDict):
    allowedCountries: List[str],
    allowedOrigins: List[str],
    arn: str,
    enableStrictOriginEnforcement: NotRequired[bool],
    name: NotRequired[str],
    tags: NotRequired[Dict[str, str]],

ListRecordingConfigurationsRequestTypeDef#

# ListRecordingConfigurationsRequestTypeDef TypedDict usage example

from types_boto3_ivs.type_defs import ListRecordingConfigurationsRequestTypeDef


def get_value() -> ListRecordingConfigurationsRequestTypeDef:
    return {
        "maxResults": ...,
    }


# ListRecordingConfigurationsRequestTypeDef definition

class ListRecordingConfigurationsRequestTypeDef(TypedDict):
    maxResults: NotRequired[int],
    nextToken: NotRequired[str],

ListStreamKeysRequestTypeDef#

# ListStreamKeysRequestTypeDef TypedDict usage example

from types_boto3_ivs.type_defs import ListStreamKeysRequestTypeDef


def get_value() -> ListStreamKeysRequestTypeDef:
    return {
        "channelArn": ...,
    }


# ListStreamKeysRequestTypeDef definition

class ListStreamKeysRequestTypeDef(TypedDict):
    channelArn: str,
    maxResults: NotRequired[int],
    nextToken: NotRequired[str],

StreamKeySummaryTypeDef#

# StreamKeySummaryTypeDef TypedDict usage example

from types_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]],

ListStreamSessionsRequestTypeDef#

# ListStreamSessionsRequestTypeDef TypedDict usage example

from types_boto3_ivs.type_defs import ListStreamSessionsRequestTypeDef


def get_value() -> ListStreamSessionsRequestTypeDef:
    return {
        "channelArn": ...,
    }


# ListStreamSessionsRequestTypeDef definition

class ListStreamSessionsRequestTypeDef(TypedDict):
    channelArn: str,
    maxResults: NotRequired[int],
    nextToken: NotRequired[str],

StreamSessionSummaryTypeDef#

# StreamSessionSummaryTypeDef TypedDict usage example

from types_boto3_ivs.type_defs import StreamSessionSummaryTypeDef


def get_value() -> StreamSessionSummaryTypeDef:
    return {
        "endTime": ...,
    }


# StreamSessionSummaryTypeDef definition

class StreamSessionSummaryTypeDef(TypedDict):
    endTime: NotRequired[datetime.datetime],
    hasErrorEvent: NotRequired[bool],
    startTime: NotRequired[datetime.datetime],
    streamId: NotRequired[str],

StreamFiltersTypeDef#

# StreamFiltersTypeDef TypedDict usage example

from types_boto3_ivs.type_defs import StreamFiltersTypeDef


def get_value() -> StreamFiltersTypeDef:
    return {
        "health": ...,
    }


# StreamFiltersTypeDef definition

class StreamFiltersTypeDef(TypedDict):
    health: NotRequired[StreamHealthType],  # (1)
  1. See StreamHealthType

StreamSummaryTypeDef#

# StreamSummaryTypeDef TypedDict usage example

from types_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.datetime],
    state: NotRequired[StreamStateType],  # (2)
    streamId: NotRequired[str],
    viewerCount: NotRequired[int],
  1. See StreamHealthType
  2. See StreamStateType

ListTagsForResourceRequestTypeDef#

# ListTagsForResourceRequestTypeDef TypedDict usage example

from types_boto3_ivs.type_defs import ListTagsForResourceRequestTypeDef


def get_value() -> ListTagsForResourceRequestTypeDef:
    return {
        "resourceArn": ...,
    }


# ListTagsForResourceRequestTypeDef definition

class ListTagsForResourceRequestTypeDef(TypedDict):
    resourceArn: str,

PutMetadataRequestTypeDef#

# PutMetadataRequestTypeDef TypedDict usage example

from types_boto3_ivs.type_defs import PutMetadataRequestTypeDef


def get_value() -> PutMetadataRequestTypeDef:
    return {
        "channelArn": ...,
    }


# PutMetadataRequestTypeDef definition

class PutMetadataRequestTypeDef(TypedDict):
    channelArn: str,
    metadata: str,

RenditionConfigurationOutputTypeDef#

# RenditionConfigurationOutputTypeDef TypedDict usage example

from types_boto3_ivs.type_defs import RenditionConfigurationOutputTypeDef


def get_value() -> RenditionConfigurationOutputTypeDef:
    return {
        "renditionSelection": ...,
    }


# RenditionConfigurationOutputTypeDef definition

class RenditionConfigurationOutputTypeDef(TypedDict):
    renditionSelection: NotRequired[RenditionConfigurationRenditionSelectionType],  # (1)
    renditions: NotRequired[List[RenditionConfigurationRenditionType]],  # (2)
  1. See RenditionConfigurationRenditionSelectionType
  2. See List[RenditionConfigurationRenditionType]

ThumbnailConfigurationOutputTypeDef#

# ThumbnailConfigurationOutputTypeDef TypedDict usage example

from types_boto3_ivs.type_defs import ThumbnailConfigurationOutputTypeDef


def get_value() -> ThumbnailConfigurationOutputTypeDef:
    return {
        "recordingMode": ...,
    }


# ThumbnailConfigurationOutputTypeDef definition

class ThumbnailConfigurationOutputTypeDef(TypedDict):
    recordingMode: NotRequired[RecordingModeType],  # (1)
    resolution: NotRequired[ThumbnailConfigurationResolutionType],  # (2)
    storage: NotRequired[List[ThumbnailConfigurationStorageType]],  # (3)
    targetIntervalSeconds: NotRequired[int],
  1. See RecordingModeType
  2. See ThumbnailConfigurationResolutionType
  3. See List[ThumbnailConfigurationStorageType]

RenditionConfigurationTypeDef#

# RenditionConfigurationTypeDef TypedDict usage example

from types_boto3_ivs.type_defs import RenditionConfigurationTypeDef


def get_value() -> RenditionConfigurationTypeDef:
    return {
        "renditionSelection": ...,
    }


# RenditionConfigurationTypeDef definition

class RenditionConfigurationTypeDef(TypedDict):
    renditionSelection: NotRequired[RenditionConfigurationRenditionSelectionType],  # (1)
    renditions: NotRequired[Sequence[RenditionConfigurationRenditionType]],  # (2)
  1. See RenditionConfigurationRenditionSelectionType
  2. See Sequence[RenditionConfigurationRenditionType]

StartViewerSessionRevocationRequestTypeDef#

# StartViewerSessionRevocationRequestTypeDef TypedDict usage example

from types_boto3_ivs.type_defs import StartViewerSessionRevocationRequestTypeDef


def get_value() -> StartViewerSessionRevocationRequestTypeDef:
    return {
        "channelArn": ...,
    }


# StartViewerSessionRevocationRequestTypeDef definition

class StartViewerSessionRevocationRequestTypeDef(TypedDict):
    channelArn: str,
    viewerId: str,
    viewerSessionVersionsLessThanOrEqualTo: NotRequired[int],

StopStreamRequestTypeDef#

# StopStreamRequestTypeDef TypedDict usage example

from types_boto3_ivs.type_defs import StopStreamRequestTypeDef


def get_value() -> StopStreamRequestTypeDef:
    return {
        "channelArn": ...,
    }


# StopStreamRequestTypeDef definition

class StopStreamRequestTypeDef(TypedDict):
    channelArn: str,

StreamEventTypeDef#

# StreamEventTypeDef TypedDict usage example

from types_boto3_ivs.type_defs import StreamEventTypeDef


def get_value() -> StreamEventTypeDef:
    return {
        "code": ...,
    }


# StreamEventTypeDef definition

class StreamEventTypeDef(TypedDict):
    code: NotRequired[str],
    eventTime: NotRequired[datetime.datetime],
    name: NotRequired[str],
    type: NotRequired[str],

TagResourceRequestTypeDef#

# TagResourceRequestTypeDef TypedDict usage example

from types_boto3_ivs.type_defs import TagResourceRequestTypeDef


def get_value() -> TagResourceRequestTypeDef:
    return {
        "resourceArn": ...,
    }


# TagResourceRequestTypeDef definition

class TagResourceRequestTypeDef(TypedDict):
    resourceArn: str,
    tags: Mapping[str, str],

ThumbnailConfigurationTypeDef#

# ThumbnailConfigurationTypeDef TypedDict usage example

from types_boto3_ivs.type_defs import ThumbnailConfigurationTypeDef


def get_value() -> ThumbnailConfigurationTypeDef:
    return {
        "recordingMode": ...,
    }


# ThumbnailConfigurationTypeDef definition

class ThumbnailConfigurationTypeDef(TypedDict):
    recordingMode: NotRequired[RecordingModeType],  # (1)
    resolution: NotRequired[ThumbnailConfigurationResolutionType],  # (2)
    storage: NotRequired[Sequence[ThumbnailConfigurationStorageType]],  # (3)
    targetIntervalSeconds: NotRequired[int],
  1. See RecordingModeType
  2. See ThumbnailConfigurationResolutionType
  3. See Sequence[ThumbnailConfigurationStorageType]

UntagResourceRequestTypeDef#

# UntagResourceRequestTypeDef TypedDict usage example

from types_boto3_ivs.type_defs import UntagResourceRequestTypeDef


def get_value() -> UntagResourceRequestTypeDef:
    return {
        "resourceArn": ...,
    }


# UntagResourceRequestTypeDef definition

class UntagResourceRequestTypeDef(TypedDict):
    resourceArn: str,
    tagKeys: Sequence[str],

UpdatePlaybackRestrictionPolicyRequestTypeDef#

# UpdatePlaybackRestrictionPolicyRequestTypeDef TypedDict usage example

from types_boto3_ivs.type_defs import UpdatePlaybackRestrictionPolicyRequestTypeDef


def get_value() -> UpdatePlaybackRestrictionPolicyRequestTypeDef:
    return {
        "arn": ...,
    }


# UpdatePlaybackRestrictionPolicyRequestTypeDef definition

class UpdatePlaybackRestrictionPolicyRequestTypeDef(TypedDict):
    arn: str,
    allowedCountries: NotRequired[Sequence[str]],
    allowedOrigins: NotRequired[Sequence[str]],
    enableStrictOriginEnforcement: NotRequired[bool],
    name: NotRequired[str],

EmptyResponseMetadataTypeDef#

# EmptyResponseMetadataTypeDef TypedDict usage example

from types_boto3_ivs.type_defs import EmptyResponseMetadataTypeDef


def get_value() -> EmptyResponseMetadataTypeDef:
    return {
        "ResponseMetadata": ...,
    }


# EmptyResponseMetadataTypeDef definition

class EmptyResponseMetadataTypeDef(TypedDict):
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
  1. See ResponseMetadataTypeDef

ListTagsForResourceResponseTypeDef#

# ListTagsForResourceResponseTypeDef TypedDict usage example

from types_boto3_ivs.type_defs import ListTagsForResourceResponseTypeDef


def get_value() -> ListTagsForResourceResponseTypeDef:
    return {
        "tags": ...,
    }


# ListTagsForResourceResponseTypeDef definition

class ListTagsForResourceResponseTypeDef(TypedDict):
    tags: Dict[str, str],
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
  1. See ResponseMetadataTypeDef

BatchGetStreamKeyResponseTypeDef#

# BatchGetStreamKeyResponseTypeDef TypedDict usage example

from types_boto3_ivs.type_defs import BatchGetStreamKeyResponseTypeDef


def get_value() -> BatchGetStreamKeyResponseTypeDef:
    return {
        "errors": ...,
    }


# BatchGetStreamKeyResponseTypeDef definition

class BatchGetStreamKeyResponseTypeDef(TypedDict):
    errors: List[BatchErrorTypeDef],  # (1)
    streamKeys: List[StreamKeyTypeDef],  # (2)
    ResponseMetadata: ResponseMetadataTypeDef,  # (3)
  1. See List[BatchErrorTypeDef]
  2. See List[StreamKeyTypeDef]
  3. See ResponseMetadataTypeDef

CreateStreamKeyResponseTypeDef#

# CreateStreamKeyResponseTypeDef TypedDict usage example

from types_boto3_ivs.type_defs import CreateStreamKeyResponseTypeDef


def get_value() -> CreateStreamKeyResponseTypeDef:
    return {
        "streamKey": ...,
    }


# CreateStreamKeyResponseTypeDef definition

class CreateStreamKeyResponseTypeDef(TypedDict):
    streamKey: StreamKeyTypeDef,  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See StreamKeyTypeDef
  2. See ResponseMetadataTypeDef

GetStreamKeyResponseTypeDef#

# GetStreamKeyResponseTypeDef TypedDict usage example

from types_boto3_ivs.type_defs import GetStreamKeyResponseTypeDef


def get_value() -> GetStreamKeyResponseTypeDef:
    return {
        "streamKey": ...,
    }


# GetStreamKeyResponseTypeDef definition

class GetStreamKeyResponseTypeDef(TypedDict):
    streamKey: StreamKeyTypeDef,  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See StreamKeyTypeDef
  2. See ResponseMetadataTypeDef

BatchStartViewerSessionRevocationResponseTypeDef#

# BatchStartViewerSessionRevocationResponseTypeDef TypedDict usage example

from types_boto3_ivs.type_defs import BatchStartViewerSessionRevocationResponseTypeDef


def get_value() -> BatchStartViewerSessionRevocationResponseTypeDef:
    return {
        "errors": ...,
    }


# BatchStartViewerSessionRevocationResponseTypeDef definition

class BatchStartViewerSessionRevocationResponseTypeDef(TypedDict):
    errors: List[BatchStartViewerSessionRevocationErrorTypeDef],  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See List[BatchStartViewerSessionRevocationErrorTypeDef]
  2. See ResponseMetadataTypeDef

BatchStartViewerSessionRevocationRequestTypeDef#

# BatchStartViewerSessionRevocationRequestTypeDef TypedDict usage example

from types_boto3_ivs.type_defs import BatchStartViewerSessionRevocationRequestTypeDef


def get_value() -> BatchStartViewerSessionRevocationRequestTypeDef:
    return {
        "viewerSessions": ...,
    }


# BatchStartViewerSessionRevocationRequestTypeDef definition

class BatchStartViewerSessionRevocationRequestTypeDef(TypedDict):
    viewerSessions: Sequence[BatchStartViewerSessionRevocationViewerSessionTypeDef],  # (1)
  1. See Sequence[BatchStartViewerSessionRevocationViewerSessionTypeDef]

ListChannelsResponseTypeDef#

# ListChannelsResponseTypeDef TypedDict usage example

from types_boto3_ivs.type_defs import ListChannelsResponseTypeDef


def get_value() -> ListChannelsResponseTypeDef:
    return {
        "channels": ...,
    }


# ListChannelsResponseTypeDef definition

class ListChannelsResponseTypeDef(TypedDict):
    channels: List[ChannelSummaryTypeDef],  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
    nextToken: NotRequired[str],
  1. See List[ChannelSummaryTypeDef]
  2. See ResponseMetadataTypeDef

CreateChannelRequestTypeDef#

# CreateChannelRequestTypeDef TypedDict usage example

from types_boto3_ivs.type_defs import CreateChannelRequestTypeDef


def get_value() -> CreateChannelRequestTypeDef:
    return {
        "authorized": ...,
    }


# CreateChannelRequestTypeDef definition

class CreateChannelRequestTypeDef(TypedDict):
    authorized: NotRequired[bool],
    containerFormat: NotRequired[ContainerFormatType],  # (1)
    insecureIngest: NotRequired[bool],
    latencyMode: NotRequired[ChannelLatencyModeType],  # (2)
    multitrackInputConfiguration: NotRequired[MultitrackInputConfigurationTypeDef],  # (3)
    name: NotRequired[str],
    playbackRestrictionPolicyArn: NotRequired[str],
    preset: NotRequired[TranscodePresetType],  # (4)
    recordingConfigurationArn: NotRequired[str],
    tags: NotRequired[Mapping[str, str]],
    type: NotRequired[ChannelTypeType],  # (5)
  1. See ContainerFormatType
  2. See ChannelLatencyModeType
  3. See MultitrackInputConfigurationTypeDef
  4. See TranscodePresetType
  5. See ChannelTypeType

UpdateChannelRequestTypeDef#

# UpdateChannelRequestTypeDef TypedDict usage example

from types_boto3_ivs.type_defs import UpdateChannelRequestTypeDef


def get_value() -> UpdateChannelRequestTypeDef:
    return {
        "arn": ...,
    }


# UpdateChannelRequestTypeDef definition

class UpdateChannelRequestTypeDef(TypedDict):
    arn: str,
    authorized: NotRequired[bool],
    containerFormat: NotRequired[ContainerFormatType],  # (1)
    insecureIngest: NotRequired[bool],
    latencyMode: NotRequired[ChannelLatencyModeType],  # (2)
    multitrackInputConfiguration: NotRequired[MultitrackInputConfigurationTypeDef],  # (3)
    name: NotRequired[str],
    playbackRestrictionPolicyArn: NotRequired[str],
    preset: NotRequired[TranscodePresetType],  # (4)
    recordingConfigurationArn: NotRequired[str],
    type: NotRequired[ChannelTypeType],  # (5)
  1. See ContainerFormatType
  2. See ChannelLatencyModeType
  3. See MultitrackInputConfigurationTypeDef
  4. See TranscodePresetType
  5. See ChannelTypeType

ChannelTypeDef#

# ChannelTypeDef TypedDict usage example

from types_boto3_ivs.type_defs import ChannelTypeDef


def get_value() -> ChannelTypeDef:
    return {
        "arn": ...,
    }


# ChannelTypeDef definition

class ChannelTypeDef(TypedDict):
    arn: NotRequired[str],
    authorized: NotRequired[bool],
    containerFormat: NotRequired[ContainerFormatType],  # (1)
    ingestEndpoint: NotRequired[str],
    insecureIngest: NotRequired[bool],
    latencyMode: NotRequired[ChannelLatencyModeType],  # (2)
    multitrackInputConfiguration: NotRequired[MultitrackInputConfigurationTypeDef],  # (3)
    name: NotRequired[str],
    playbackRestrictionPolicyArn: NotRequired[str],
    playbackUrl: NotRequired[str],
    preset: NotRequired[TranscodePresetType],  # (4)
    recordingConfigurationArn: NotRequired[str],
    srt: NotRequired[SrtTypeDef],  # (5)
    tags: NotRequired[Dict[str, str]],
    type: NotRequired[ChannelTypeType],  # (6)
  1. See ContainerFormatType
  2. See ChannelLatencyModeType
  3. See MultitrackInputConfigurationTypeDef
  4. See TranscodePresetType
  5. See SrtTypeDef
  6. See ChannelTypeType

CreatePlaybackRestrictionPolicyResponseTypeDef#

# CreatePlaybackRestrictionPolicyResponseTypeDef TypedDict usage example

from types_boto3_ivs.type_defs import CreatePlaybackRestrictionPolicyResponseTypeDef


def get_value() -> CreatePlaybackRestrictionPolicyResponseTypeDef:
    return {
        "playbackRestrictionPolicy": ...,
    }


# CreatePlaybackRestrictionPolicyResponseTypeDef definition

class CreatePlaybackRestrictionPolicyResponseTypeDef(TypedDict):
    playbackRestrictionPolicy: PlaybackRestrictionPolicyTypeDef,  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See PlaybackRestrictionPolicyTypeDef
  2. See ResponseMetadataTypeDef

GetPlaybackRestrictionPolicyResponseTypeDef#

# GetPlaybackRestrictionPolicyResponseTypeDef TypedDict usage example

from types_boto3_ivs.type_defs import GetPlaybackRestrictionPolicyResponseTypeDef


def get_value() -> GetPlaybackRestrictionPolicyResponseTypeDef:
    return {
        "playbackRestrictionPolicy": ...,
    }


# GetPlaybackRestrictionPolicyResponseTypeDef definition

class GetPlaybackRestrictionPolicyResponseTypeDef(TypedDict):
    playbackRestrictionPolicy: PlaybackRestrictionPolicyTypeDef,  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See PlaybackRestrictionPolicyTypeDef
  2. See ResponseMetadataTypeDef

UpdatePlaybackRestrictionPolicyResponseTypeDef#

# UpdatePlaybackRestrictionPolicyResponseTypeDef TypedDict usage example

from types_boto3_ivs.type_defs import UpdatePlaybackRestrictionPolicyResponseTypeDef


def get_value() -> UpdatePlaybackRestrictionPolicyResponseTypeDef:
    return {
        "playbackRestrictionPolicy": ...,
    }


# UpdatePlaybackRestrictionPolicyResponseTypeDef definition

class UpdatePlaybackRestrictionPolicyResponseTypeDef(TypedDict):
    playbackRestrictionPolicy: PlaybackRestrictionPolicyTypeDef,  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See PlaybackRestrictionPolicyTypeDef
  2. See ResponseMetadataTypeDef

DestinationConfigurationTypeDef#

# DestinationConfigurationTypeDef TypedDict usage example

from types_boto3_ivs.type_defs import DestinationConfigurationTypeDef


def get_value() -> DestinationConfigurationTypeDef:
    return {
        "s3": ...,
    }


# DestinationConfigurationTypeDef definition

class DestinationConfigurationTypeDef(TypedDict):
    s3: NotRequired[S3DestinationConfigurationTypeDef],  # (1)
  1. See S3DestinationConfigurationTypeDef

GetPlaybackKeyPairResponseTypeDef#

# GetPlaybackKeyPairResponseTypeDef TypedDict usage example

from types_boto3_ivs.type_defs import GetPlaybackKeyPairResponseTypeDef


def get_value() -> GetPlaybackKeyPairResponseTypeDef:
    return {
        "keyPair": ...,
    }


# GetPlaybackKeyPairResponseTypeDef definition

class GetPlaybackKeyPairResponseTypeDef(TypedDict):
    keyPair: PlaybackKeyPairTypeDef,  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See PlaybackKeyPairTypeDef
  2. See ResponseMetadataTypeDef

ImportPlaybackKeyPairResponseTypeDef#

# ImportPlaybackKeyPairResponseTypeDef TypedDict usage example

from types_boto3_ivs.type_defs import ImportPlaybackKeyPairResponseTypeDef


def get_value() -> ImportPlaybackKeyPairResponseTypeDef:
    return {
        "keyPair": ...,
    }


# ImportPlaybackKeyPairResponseTypeDef definition

class ImportPlaybackKeyPairResponseTypeDef(TypedDict):
    keyPair: PlaybackKeyPairTypeDef,  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See PlaybackKeyPairTypeDef
  2. See ResponseMetadataTypeDef

GetStreamResponseTypeDef#

# GetStreamResponseTypeDef TypedDict usage example

from types_boto3_ivs.type_defs import GetStreamResponseTypeDef


def get_value() -> GetStreamResponseTypeDef:
    return {
        "stream": ...,
    }


# GetStreamResponseTypeDef definition

class GetStreamResponseTypeDef(TypedDict):
    stream: StreamTypeDef,  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See StreamTypeDef
  2. See ResponseMetadataTypeDef

IngestConfigurationTypeDef#

# IngestConfigurationTypeDef TypedDict usage example

from types_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)
  1. See AudioConfigurationTypeDef
  2. See VideoConfigurationTypeDef

IngestConfigurationsTypeDef#

# IngestConfigurationsTypeDef TypedDict usage example

from types_boto3_ivs.type_defs import IngestConfigurationsTypeDef


def get_value() -> IngestConfigurationsTypeDef:
    return {
        "audioConfigurations": ...,
    }


# IngestConfigurationsTypeDef definition

class IngestConfigurationsTypeDef(TypedDict):
    audioConfigurations: List[AudioConfigurationTypeDef],  # (1)
    videoConfigurations: List[VideoConfigurationTypeDef],  # (2)
  1. See List[AudioConfigurationTypeDef]
  2. See List[VideoConfigurationTypeDef]

ListChannelsRequestPaginateTypeDef#

# ListChannelsRequestPaginateTypeDef TypedDict usage example

from types_boto3_ivs.type_defs import ListChannelsRequestPaginateTypeDef


def get_value() -> ListChannelsRequestPaginateTypeDef:
    return {
        "filterByName": ...,
    }


# ListChannelsRequestPaginateTypeDef definition

class ListChannelsRequestPaginateTypeDef(TypedDict):
    filterByName: NotRequired[str],
    filterByPlaybackRestrictionPolicyArn: NotRequired[str],
    filterByRecordingConfigurationArn: NotRequired[str],
    PaginationConfig: NotRequired[PaginatorConfigTypeDef],  # (1)
  1. See PaginatorConfigTypeDef

ListPlaybackKeyPairsRequestPaginateTypeDef#

# ListPlaybackKeyPairsRequestPaginateTypeDef TypedDict usage example

from types_boto3_ivs.type_defs import ListPlaybackKeyPairsRequestPaginateTypeDef


def get_value() -> ListPlaybackKeyPairsRequestPaginateTypeDef:
    return {
        "PaginationConfig": ...,
    }


# ListPlaybackKeyPairsRequestPaginateTypeDef definition

class ListPlaybackKeyPairsRequestPaginateTypeDef(TypedDict):
    PaginationConfig: NotRequired[PaginatorConfigTypeDef],  # (1)
  1. See PaginatorConfigTypeDef

ListRecordingConfigurationsRequestPaginateTypeDef#

# ListRecordingConfigurationsRequestPaginateTypeDef TypedDict usage example

from types_boto3_ivs.type_defs import ListRecordingConfigurationsRequestPaginateTypeDef


def get_value() -> ListRecordingConfigurationsRequestPaginateTypeDef:
    return {
        "PaginationConfig": ...,
    }


# ListRecordingConfigurationsRequestPaginateTypeDef definition

class ListRecordingConfigurationsRequestPaginateTypeDef(TypedDict):
    PaginationConfig: NotRequired[PaginatorConfigTypeDef],  # (1)
  1. See PaginatorConfigTypeDef

ListStreamKeysRequestPaginateTypeDef#

# ListStreamKeysRequestPaginateTypeDef TypedDict usage example

from types_boto3_ivs.type_defs import ListStreamKeysRequestPaginateTypeDef


def get_value() -> ListStreamKeysRequestPaginateTypeDef:
    return {
        "channelArn": ...,
    }


# ListStreamKeysRequestPaginateTypeDef definition

class ListStreamKeysRequestPaginateTypeDef(TypedDict):
    channelArn: str,
    PaginationConfig: NotRequired[PaginatorConfigTypeDef],  # (1)
  1. See PaginatorConfigTypeDef

ListPlaybackKeyPairsResponseTypeDef#

# ListPlaybackKeyPairsResponseTypeDef TypedDict usage example

from types_boto3_ivs.type_defs import ListPlaybackKeyPairsResponseTypeDef


def get_value() -> ListPlaybackKeyPairsResponseTypeDef:
    return {
        "keyPairs": ...,
    }


# ListPlaybackKeyPairsResponseTypeDef definition

class ListPlaybackKeyPairsResponseTypeDef(TypedDict):
    keyPairs: List[PlaybackKeyPairSummaryTypeDef],  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
    nextToken: NotRequired[str],
  1. See List[PlaybackKeyPairSummaryTypeDef]
  2. See ResponseMetadataTypeDef

ListPlaybackRestrictionPoliciesResponseTypeDef#

# ListPlaybackRestrictionPoliciesResponseTypeDef TypedDict usage example

from types_boto3_ivs.type_defs import ListPlaybackRestrictionPoliciesResponseTypeDef


def get_value() -> ListPlaybackRestrictionPoliciesResponseTypeDef:
    return {
        "nextToken": ...,
    }


# ListPlaybackRestrictionPoliciesResponseTypeDef definition

class ListPlaybackRestrictionPoliciesResponseTypeDef(TypedDict):
    playbackRestrictionPolicies: List[PlaybackRestrictionPolicySummaryTypeDef],  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
    nextToken: NotRequired[str],
  1. See List[PlaybackRestrictionPolicySummaryTypeDef]
  2. See ResponseMetadataTypeDef

ListStreamKeysResponseTypeDef#

# ListStreamKeysResponseTypeDef TypedDict usage example

from types_boto3_ivs.type_defs import ListStreamKeysResponseTypeDef


def get_value() -> ListStreamKeysResponseTypeDef:
    return {
        "nextToken": ...,
    }


# ListStreamKeysResponseTypeDef definition

class ListStreamKeysResponseTypeDef(TypedDict):
    streamKeys: List[StreamKeySummaryTypeDef],  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
    nextToken: NotRequired[str],
  1. See List[StreamKeySummaryTypeDef]
  2. See ResponseMetadataTypeDef

ListStreamSessionsResponseTypeDef#

# ListStreamSessionsResponseTypeDef TypedDict usage example

from types_boto3_ivs.type_defs import ListStreamSessionsResponseTypeDef


def get_value() -> ListStreamSessionsResponseTypeDef:
    return {
        "nextToken": ...,
    }


# ListStreamSessionsResponseTypeDef definition

class ListStreamSessionsResponseTypeDef(TypedDict):
    streamSessions: List[StreamSessionSummaryTypeDef],  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
    nextToken: NotRequired[str],
  1. See List[StreamSessionSummaryTypeDef]
  2. See ResponseMetadataTypeDef

ListStreamsRequestPaginateTypeDef#

# ListStreamsRequestPaginateTypeDef TypedDict usage example

from types_boto3_ivs.type_defs import ListStreamsRequestPaginateTypeDef


def get_value() -> ListStreamsRequestPaginateTypeDef:
    return {
        "filterBy": ...,
    }


# ListStreamsRequestPaginateTypeDef definition

class ListStreamsRequestPaginateTypeDef(TypedDict):
    filterBy: NotRequired[StreamFiltersTypeDef],  # (1)
    PaginationConfig: NotRequired[PaginatorConfigTypeDef],  # (2)
  1. See StreamFiltersTypeDef
  2. See PaginatorConfigTypeDef

ListStreamsRequestTypeDef#

# ListStreamsRequestTypeDef TypedDict usage example

from types_boto3_ivs.type_defs import ListStreamsRequestTypeDef


def get_value() -> ListStreamsRequestTypeDef:
    return {
        "filterBy": ...,
    }


# ListStreamsRequestTypeDef definition

class ListStreamsRequestTypeDef(TypedDict):
    filterBy: NotRequired[StreamFiltersTypeDef],  # (1)
    maxResults: NotRequired[int],
    nextToken: NotRequired[str],
  1. See StreamFiltersTypeDef

ListStreamsResponseTypeDef#

# ListStreamsResponseTypeDef TypedDict usage example

from types_boto3_ivs.type_defs import ListStreamsResponseTypeDef


def get_value() -> ListStreamsResponseTypeDef:
    return {
        "nextToken": ...,
    }


# ListStreamsResponseTypeDef definition

class ListStreamsResponseTypeDef(TypedDict):
    streams: List[StreamSummaryTypeDef],  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
    nextToken: NotRequired[str],
  1. See List[StreamSummaryTypeDef]
  2. See ResponseMetadataTypeDef

BatchGetChannelResponseTypeDef#

# BatchGetChannelResponseTypeDef TypedDict usage example

from types_boto3_ivs.type_defs import BatchGetChannelResponseTypeDef


def get_value() -> BatchGetChannelResponseTypeDef:
    return {
        "channels": ...,
    }


# BatchGetChannelResponseTypeDef definition

class BatchGetChannelResponseTypeDef(TypedDict):
    channels: List[ChannelTypeDef],  # (1)
    errors: List[BatchErrorTypeDef],  # (2)
    ResponseMetadata: ResponseMetadataTypeDef,  # (3)
  1. See List[ChannelTypeDef]
  2. See List[BatchErrorTypeDef]
  3. See ResponseMetadataTypeDef

CreateChannelResponseTypeDef#

# CreateChannelResponseTypeDef TypedDict usage example

from types_boto3_ivs.type_defs import CreateChannelResponseTypeDef


def get_value() -> CreateChannelResponseTypeDef:
    return {
        "channel": ...,
    }


# CreateChannelResponseTypeDef definition

class CreateChannelResponseTypeDef(TypedDict):
    channel: ChannelTypeDef,  # (1)
    streamKey: StreamKeyTypeDef,  # (2)
    ResponseMetadata: ResponseMetadataTypeDef,  # (3)
  1. See ChannelTypeDef
  2. See StreamKeyTypeDef
  3. See ResponseMetadataTypeDef

GetChannelResponseTypeDef#

# GetChannelResponseTypeDef TypedDict usage example

from types_boto3_ivs.type_defs import GetChannelResponseTypeDef


def get_value() -> GetChannelResponseTypeDef:
    return {
        "channel": ...,
    }


# GetChannelResponseTypeDef definition

class GetChannelResponseTypeDef(TypedDict):
    channel: ChannelTypeDef,  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See ChannelTypeDef
  2. See ResponseMetadataTypeDef

UpdateChannelResponseTypeDef#

# UpdateChannelResponseTypeDef TypedDict usage example

from types_boto3_ivs.type_defs import UpdateChannelResponseTypeDef


def get_value() -> UpdateChannelResponseTypeDef:
    return {
        "channel": ...,
    }


# UpdateChannelResponseTypeDef definition

class UpdateChannelResponseTypeDef(TypedDict):
    channel: ChannelTypeDef,  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See ChannelTypeDef
  2. See ResponseMetadataTypeDef

RecordingConfigurationSummaryTypeDef#

# RecordingConfigurationSummaryTypeDef TypedDict usage example

from types_boto3_ivs.type_defs import RecordingConfigurationSummaryTypeDef


def get_value() -> RecordingConfigurationSummaryTypeDef:
    return {
        "arn": ...,
    }


# RecordingConfigurationSummaryTypeDef definition

class RecordingConfigurationSummaryTypeDef(TypedDict):
    arn: str,
    destinationConfiguration: DestinationConfigurationTypeDef,  # (1)
    state: RecordingConfigurationStateType,  # (2)
    name: NotRequired[str],
    tags: NotRequired[Dict[str, str]],
  1. See DestinationConfigurationTypeDef
  2. See RecordingConfigurationStateType

RecordingConfigurationTypeDef#

# RecordingConfigurationTypeDef TypedDict usage example

from types_boto3_ivs.type_defs import RecordingConfigurationTypeDef


def get_value() -> RecordingConfigurationTypeDef:
    return {
        "arn": ...,
    }


# RecordingConfigurationTypeDef definition

class RecordingConfigurationTypeDef(TypedDict):
    arn: str,
    destinationConfiguration: DestinationConfigurationTypeDef,  # (1)
    state: RecordingConfigurationStateType,  # (3)
    name: NotRequired[str],
    recordingReconnectWindowSeconds: NotRequired[int],
    renditionConfiguration: NotRequired[RenditionConfigurationOutputTypeDef],  # (2)
    tags: NotRequired[Dict[str, str]],
    thumbnailConfiguration: NotRequired[ThumbnailConfigurationOutputTypeDef],  # (4)
  1. See DestinationConfigurationTypeDef
  2. See RenditionConfigurationOutputTypeDef
  3. See RecordingConfigurationStateType
  4. See ThumbnailConfigurationOutputTypeDef

CreateRecordingConfigurationRequestTypeDef#

# CreateRecordingConfigurationRequestTypeDef TypedDict usage example

from types_boto3_ivs.type_defs import CreateRecordingConfigurationRequestTypeDef


def get_value() -> CreateRecordingConfigurationRequestTypeDef:
    return {
        "destinationConfiguration": ...,
    }


# CreateRecordingConfigurationRequestTypeDef definition

class CreateRecordingConfigurationRequestTypeDef(TypedDict):
    destinationConfiguration: DestinationConfigurationTypeDef,  # (1)
    name: NotRequired[str],
    recordingReconnectWindowSeconds: NotRequired[int],
    renditionConfiguration: NotRequired[RenditionConfigurationUnionTypeDef],  # (2)
    tags: NotRequired[Mapping[str, str]],
    thumbnailConfiguration: NotRequired[ThumbnailConfigurationUnionTypeDef],  # (3)
  1. See DestinationConfigurationTypeDef
  2. See RenditionConfigurationUnionTypeDef
  3. See ThumbnailConfigurationUnionTypeDef

ListRecordingConfigurationsResponseTypeDef#

# ListRecordingConfigurationsResponseTypeDef TypedDict usage example

from types_boto3_ivs.type_defs import ListRecordingConfigurationsResponseTypeDef


def get_value() -> ListRecordingConfigurationsResponseTypeDef:
    return {
        "nextToken": ...,
    }


# ListRecordingConfigurationsResponseTypeDef definition

class ListRecordingConfigurationsResponseTypeDef(TypedDict):
    recordingConfigurations: List[RecordingConfigurationSummaryTypeDef],  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
    nextToken: NotRequired[str],
  1. See List[RecordingConfigurationSummaryTypeDef]
  2. See ResponseMetadataTypeDef

CreateRecordingConfigurationResponseTypeDef#

# CreateRecordingConfigurationResponseTypeDef TypedDict usage example

from types_boto3_ivs.type_defs import CreateRecordingConfigurationResponseTypeDef


def get_value() -> CreateRecordingConfigurationResponseTypeDef:
    return {
        "recordingConfiguration": ...,
    }


# CreateRecordingConfigurationResponseTypeDef definition

class CreateRecordingConfigurationResponseTypeDef(TypedDict):
    recordingConfiguration: RecordingConfigurationTypeDef,  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See RecordingConfigurationTypeDef
  2. See ResponseMetadataTypeDef

GetRecordingConfigurationResponseTypeDef#

# GetRecordingConfigurationResponseTypeDef TypedDict usage example

from types_boto3_ivs.type_defs import GetRecordingConfigurationResponseTypeDef


def get_value() -> GetRecordingConfigurationResponseTypeDef:
    return {
        "recordingConfiguration": ...,
    }


# GetRecordingConfigurationResponseTypeDef definition

class GetRecordingConfigurationResponseTypeDef(TypedDict):
    recordingConfiguration: RecordingConfigurationTypeDef,  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See RecordingConfigurationTypeDef
  2. See ResponseMetadataTypeDef

StreamSessionTypeDef#

# StreamSessionTypeDef TypedDict usage example

from types_boto3_ivs.type_defs import StreamSessionTypeDef


def get_value() -> StreamSessionTypeDef:
    return {
        "channel": ...,
    }


# StreamSessionTypeDef definition

class StreamSessionTypeDef(TypedDict):
    channel: NotRequired[ChannelTypeDef],  # (1)
    endTime: NotRequired[datetime.datetime],
    ingestConfiguration: NotRequired[IngestConfigurationTypeDef],  # (2)
    ingestConfigurations: NotRequired[IngestConfigurationsTypeDef],  # (3)
    recordingConfiguration: NotRequired[RecordingConfigurationTypeDef],  # (4)
    startTime: NotRequired[datetime.datetime],
    streamId: NotRequired[str],
    truncatedEvents: NotRequired[List[StreamEventTypeDef]],  # (5)
  1. See ChannelTypeDef
  2. See IngestConfigurationTypeDef
  3. See IngestConfigurationsTypeDef
  4. See RecordingConfigurationTypeDef
  5. See List[StreamEventTypeDef]

GetStreamSessionResponseTypeDef#

# GetStreamSessionResponseTypeDef TypedDict usage example

from types_boto3_ivs.type_defs import GetStreamSessionResponseTypeDef


def get_value() -> GetStreamSessionResponseTypeDef:
    return {
        "streamSession": ...,
    }


# GetStreamSessionResponseTypeDef definition

class GetStreamSessionResponseTypeDef(TypedDict):
    streamSession: StreamSessionTypeDef,  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See StreamSessionTypeDef
  2. See ResponseMetadataTypeDef