Skip to content

Type definitions#

Index > IVS > Type definitions

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

RenditionConfigurationUnionTypeDef#

# RenditionConfigurationUnionTypeDef definition

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

ThumbnailConfigurationUnionTypeDef#

# ThumbnailConfigurationUnionTypeDef definition

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

AudioConfigurationTypeDef#

# AudioConfigurationTypeDef definition

class AudioConfigurationTypeDef(TypedDict):
    codec: NotRequired[str],
    targetBitrate: NotRequired[int],
    sampleRate: NotRequired[int],
    channels: 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],

ResponseMetadataTypeDef#

# ResponseMetadataTypeDef definition

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

BatchGetStreamKeyRequestRequestTypeDef#

# BatchGetStreamKeyRequestRequestTypeDef definition

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

StreamKeyTypeDef#

# StreamKeyTypeDef definition

class StreamKeyTypeDef(TypedDict):
    arn: NotRequired[str],
    value: NotRequired[str],
    channelArn: NotRequired[str],
    tags: NotRequired[Dict[str, 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],
    name: NotRequired[str],
    latencyMode: NotRequired[ChannelLatencyModeType],  # (1)
    authorized: NotRequired[bool],
    recordingConfigurationArn: NotRequired[str],
    tags: NotRequired[Dict[str, str]],
    insecureIngest: NotRequired[bool],
    type: NotRequired[ChannelTypeType],  # (2)
    preset: NotRequired[TranscodePresetType],  # (3)
    playbackRestrictionPolicyArn: NotRequired[str],
  1. See ChannelLatencyModeType
  2. See ChannelTypeType
  3. See