Skip to content

Type definitions#

Index > Ivsrealtime > Type definitions

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

AutoParticipantRecordingConfigurationUnionTypeDef#

# AutoParticipantRecordingConfigurationUnionTypeDef definition

AutoParticipantRecordingConfigurationUnionTypeDef = Union[
    AutoParticipantRecordingConfigurationTypeDef,  # (1)
    AutoParticipantRecordingConfigurationOutputTypeDef,  # (2)
]
  1. See AutoParticipantRecordingConfigurationTypeDef
  2. See AutoParticipantRecordingConfigurationOutputTypeDef

DestinationConfigurationUnionTypeDef#

# DestinationConfigurationUnionTypeDef definition

DestinationConfigurationUnionTypeDef = Union[
    DestinationConfigurationTypeDef,  # (1)
    DestinationConfigurationOutputTypeDef,  # (2)
]
  1. See DestinationConfigurationTypeDef
  2. See DestinationConfigurationOutputTypeDef

AutoParticipantRecordingConfigurationOutputTypeDef#

# AutoParticipantRecordingConfigurationOutputTypeDef definition

class AutoParticipantRecordingConfigurationOutputTypeDef(TypedDict):
    storageConfigurationArn: str,
    mediaTypes: NotRequired[List[ParticipantRecordingMediaTypeType]],  # (1)
  1. See ParticipantRecordingMediaTypeType

AutoParticipantRecordingConfigurationTypeDef#

# AutoParticipantRecordingConfigurationTypeDef definition

class AutoParticipantRecordingConfigurationTypeDef(TypedDict):
    storageConfigurationArn: str,
    mediaTypes: NotRequired[Sequence[ParticipantRecordingMediaTypeType]],  # (1)
  1. See ParticipantRecordingMediaTypeType

ChannelDestinationConfigurationTypeDef#

# ChannelDestinationConfigurationTypeDef definition

class ChannelDestinationConfigurationTypeDef(TypedDict):
    channelArn: str,
    encoderConfigurationArn: NotRequired[str],

DestinationSummaryTypeDef#

# DestinationSummaryTypeDef definition

class DestinationSummaryTypeDef(TypedDict):
    id: str,
    state: DestinationStateType,  # (1)
    startTime: NotRequired[datetime],
    endTime: NotRequired[datetime],
  1. See DestinationStateType

VideoTypeDef#

# VideoTypeDef definition

class VideoTypeDef(TypedDict):
    width: NotRequired[int],
    height: NotRequired[int],
    framerate: NotRequired[float],
    bitrate: NotRequired[int],

ResponseMetadataTypeDef#

# ResponseMetadataTypeDef definition

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

CreateParticipantTokenRequestRequestTypeDef#

# CreateParticipantTokenRequestRequestTypeDef definition

class CreateParticipantTokenRequestRequestTypeDef(TypedDict):
    stageArn: str,
    duration: NotRequired[int],
    userId: NotRequired[str],
    attributes: NotRequired[Mapping[str, str]],
    capabilities: NotRequired[Sequence[ParticipantTokenCapabilityType]],  # (1)
  1. See ParticipantTokenCapabilityType

ParticipantTokenTypeDef#

# ParticipantTokenTypeDef definition

class ParticipantTokenTypeDef(TypedDict):
    participantId: NotRequired[str],
    token: NotRequired[str],
    userId: NotRequired[str],
    attributes: NotRequired[Dict[str, str]],
    duration: NotRequired[int],
    capabilities: NotRequired[List[ParticipantTokenCapabilityType]],  # (1)
    expirationTime: NotRequired[datetime],
  1. See ParticipantTokenCapabilityType

ParticipantTokenConfigurationTypeDef#

# ParticipantTokenConfigurationTypeDef definition

class ParticipantTokenConfigurationTypeDef(TypedDict):
    duration: NotRequired[int],
    userId: NotRequired[str],
    attributes: NotRequired[Mapping[str, str]],
    capabilities: NotRequired[Sequence[ParticipantTokenCapabilityType]],  # (1)
  1. See ParticipantTokenCapabilityType

S3StorageConfigurationTypeDef#

# S3StorageConfigurationTypeDef definition

class S3StorageConfigurationTypeDef(TypedDict):
    bucketName: str,

DeleteEncoderConfigurationRequestRequestTypeDef#

# DeleteEncoderConfigurationRequestRequestTypeDef definition

class DeleteEncoderConfigurationRequestRequestTypeDef(TypedDict):
    arn: str,

DeleteStageRequestRequestTypeDef#

# DeleteStageRequestRequestTypeDef definition

class DeleteStageRequestRequestTypeDef(TypedDict):
    arn: str,

DeleteStorageConfigurationRequestRequestTypeDef#

# DeleteStorageConfigurationRequestRequestTypeDef definition

class DeleteStorageConfigurationRequestRequestTypeDef(TypedDict):
    arn: str,

S3DetailTypeDef#

# S3DetailTypeDef definition

class S3DetailTypeDef(TypedDict):
    recordingPrefix: str,

DisconnectParticipantRequestRequestTypeDef#

# DisconnectParticipantRequestRequestTypeDef definition

class DisconnectParticipantRequestRequestTypeDef(TypedDict):
    stageArn: str,
    participantId: str,
    reason: NotRequired[str],

EncoderConfigurationSummaryTypeDef#

# EncoderConfigurationSummaryTypeDef definition

class EncoderConfigurationSummaryTypeDef(TypedDict):
    arn: str,
    name: NotRequired[str],
    tags: NotRequired[Dict[str, str]],

EventTypeDef#

# EventTypeDef definition

class EventTypeDef(TypedDict):
    name: NotRequired[EventNameType],  # (1)
    participantId: NotRequired[str],
    eventTime: NotRequired[datetime],
    remoteParticipantId: NotRequired[str],
    errorCode: NotRequired[EventErrorCodeType],  # (2)
  1. See EventNameType
  2. See EventErrorCodeType

GetCompositionRequestRequestTypeDef#

# GetCompositionRequestRequestTypeDef definition

class GetCompositionRequestRequestTypeDef(TypedDict):
    arn: str,

GetEncoderConfigurationRequestRequestTypeDef#

# GetEncoderConfigurationRequestRequestTypeDef definition

class GetEncoderConfigurationRequestRequestTypeDef(TypedDict):
    arn: str,

GetParticipantRequestRequestTypeDef#

# GetParticipantRequestRequestTypeDef definition

class GetParticipantRequestRequestTypeDef(TypedDict):
    stageArn: str,
    sessionId: str,
    participantId: str,

ParticipantTypeDef#

# ParticipantTypeDef definition

class ParticipantTypeDef(TypedDict):
    participantId: NotRequired[str],
    userId: NotRequired[str],
    state: NotRequired[ParticipantStateType],  # (1)
    firstJoinTime: NotRequired[datetime],
    attributes: NotRequired[Dict[str, str]],
    published: NotRequired[bool],
    ispName: NotRequired[str],
    osName: NotRequired[str],
    osVersion: NotRequired[str],
    browserName: NotRequired[str],
    browserVersion: NotRequired[str],
    sdkVersion: NotRequired[str],
    recordingS3BucketName: NotRequired[str],
    recordingS3Prefix: NotRequired[str],
    recordingState: NotRequired[ParticipantRecordingStateType],  # (2)
  1. See ParticipantStateType
  2. See ParticipantRecordingStateType

GetStageRequestRequestTypeDef#

# GetStageRequestRequestTypeDef definition

class GetStageRequestRequestTypeDef(TypedDict):
    arn: str,

GetStageSessionRequestRequestTypeDef#

# GetStageSessionRequestRequestTypeDef definition

class GetStageSessionRequestRequestTypeDef(TypedDict):
    stageArn: str,
    sessionId: str,

StageSessionTypeDef#

# StageSessionTypeDef definition

class StageSessionTypeDef(TypedDict):
    sessionId: NotRequired[str],
    startTime: NotRequired[datetime],
    endTime: NotRequired[datetime],

GetStorageConfigurationRequestRequestTypeDef#

# GetStorageConfigurationRequestRequestTypeDef definition

class GetStorageConfigurationRequestRequestTypeDef(TypedDict):
    arn: str,

GridConfigurationTypeDef#

# GridConfigurationTypeDef definition

class GridConfigurationTypeDef(TypedDict):
    featuredParticipantAttribute: NotRequired[str],
    omitStoppedVideo: NotRequired[bool],
    videoAspectRatio: NotRequired[VideoAspectRatioType],  # (1)
    videoFillMode: NotRequired[VideoFillModeType],  # (2)
    gridGap: NotRequired[int],
  1. See VideoAspectRatioType
  2. See VideoFillModeType

PipConfigurationTypeDef#

# PipConfigurationTypeDef definition

class PipConfigurationTypeDef(TypedDict):
    featuredParticipantAttribute: NotRequired[str],
    omitStoppedVideo: NotRequired[bool],
    videoFillMode: NotRequired[VideoFillModeType],  # (1)
    gridGap: NotRequired[int],
    pipParticipantAttribute: NotRequired[str],
    pipBehavior: NotRequired[PipBehaviorType],  # (2)
    pipOffset: NotRequired[int],
    pipPosition: NotRequired[PipPositionType],  # (3)
    pipWidth: NotRequired[int],
    pipHeight: NotRequired[int],
  1. See VideoFillModeType
  2. See PipBehaviorType
  3. See PipPositionType

ListCompositionsRequestRequestTypeDef#

# ListCompositionsRequestRequestTypeDef definition

class ListCompositionsRequestRequestTypeDef(TypedDict):
    filterByStageArn: NotRequired[str],
    filterByEncoderConfigurationArn: NotRequired[str],
    nextToken: NotRequired[str],
    maxResults: NotRequired[int],

ListEncoderConfigurationsRequestRequestTypeDef#

# ListEncoderConfigurationsRequestRequestTypeDef definition

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

ListParticipantEventsRequestRequestTypeDef#

# ListParticipantEventsRequestRequestTypeDef definition

class ListParticipantEventsRequestRequestTypeDef(TypedDict):
    stageArn: str,
    sessionId: str,
    participantId: str,
    nextToken: NotRequired[str],
    maxResults: NotRequired[int],

ListParticipantsRequestRequestTypeDef#

# ListParticipantsRequestRequestTypeDef definition

class ListParticipantsRequestRequestTypeDef(TypedDict):
    stageArn: str,
    sessionId: str,
    filterByUserId: NotRequired[str],
    filterByPublished: NotRequired[bool],
    filterByState: NotRequired[ParticipantStateType],  # (1)
    nextToken: NotRequired[str],
    maxResults: NotRequired[int],
    filterByRecordingState: NotRequired[ParticipantRecordingFilterByRecordingStateType],  # (2)
  1. See ParticipantStateType
  2. See ParticipantRecordingFilterByRecordingStateType

ParticipantSummaryTypeDef#

# ParticipantSummaryTypeDef definition

class ParticipantSummaryTypeDef(TypedDict):
    participantId: NotRequired[str],
    userId: NotRequired[str],
    state: NotRequired[ParticipantStateType],  # (1)
    firstJoinTime: NotRequired[datetime],
    published: NotRequired[bool],
    recordingState: NotRequired[ParticipantRecordingStateType],  # (2)
  1. See ParticipantStateType
  2. See ParticipantRecordingStateType

ListStageSessionsRequestRequestTypeDef#

# ListStageSessionsRequestRequestTypeDef definition

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

StageSessionSummaryTypeDef#

# StageSessionSummaryTypeDef definition

class StageSessionSummaryTypeDef(TypedDict):
    sessionId: NotRequired[str],
    startTime: NotRequired[datetime],
    endTime: NotRequired[datetime],

ListStagesRequestRequestTypeDef#

# ListStagesRequestRequestTypeDef definition

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

StageSummaryTypeDef#

# StageSummaryTypeDef definition

class StageSummaryTypeDef(TypedDict):
    arn: str,
    name: NotRequired[str],
    activeSessionId: NotRequired[str],
    tags: NotRequired[Dict[str, str]],

ListStorageConfigurationsRequestRequestTypeDef#

# ListStorageConfigurationsRequestRequestTypeDef definition

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

ListTagsForResourceRequestRequestTypeDef#

# ListTagsForResourceRequestRequestTypeDef definition

class ListTagsForResourceRequestRequestTypeDef(TypedDict):
    resourceArn: str,

RecordingConfigurationTypeDef#

# RecordingConfigurationTypeDef definition

class RecordingConfigurationTypeDef(TypedDict):
    format: NotRequired[RecordingConfigurationFormatType],  # (1)
  1. See RecordingConfigurationFormatType

StopCompositionRequestRequestTypeDef#

# StopCompositionRequestRequestTypeDef definition

class StopCompositionRequestRequestTypeDef(TypedDict):
    arn: str,

TagResourceRequestRequestTypeDef#

# TagResourceRequestRequestTypeDef definition

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

UntagResourceRequestRequestTypeDef#

# UntagResourceRequestRequestTypeDef definition

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

StageTypeDef#

# StageTypeDef definition

class StageTypeDef(TypedDict):
    arn: str,
    name: NotRequired[str],
    activeSessionId: NotRequired[str],
    tags: NotRequired[Dict[str, str]],
    autoParticipantRecordingConfiguration: NotRequired[AutoParticipantRecordingConfigurationOutputTypeDef],  # (1)
  1. See AutoParticipantRecordingConfigurationOutputTypeDef

UpdateStageRequestRequestTypeDef#

# UpdateStageRequestRequestTypeDef definition

class UpdateStageRequestRequestTypeDef(TypedDict):
    arn: str,
    name: NotRequired[str],
    autoParticipantRecordingConfiguration: NotRequired[AutoParticipantRecordingConfigurationTypeDef],  # (1)
  1. See AutoParticipantRecordingConfigurationTypeDef

CompositionSummaryTypeDef#

# CompositionSummaryTypeDef definition

class CompositionSummaryTypeDef(TypedDict):
    arn: str,
    stageArn: str,
    destinations: List[DestinationSummaryTypeDef],  # (1)
    state: CompositionStateType,  # (2)
    tags: NotRequired[Dict[str, str]],
    startTime: NotRequired[datetime],
    endTime: NotRequired[datetime],
  1. See DestinationSummaryTypeDef
  2. See CompositionStateType

CreateEncoderConfigurationRequestRequestTypeDef#

# CreateEncoderConfigurationRequestRequestTypeDef definition

class CreateEncoderConfigurationRequestRequestTypeDef(TypedDict):
    name: NotRequired[str],
    video: NotRequired[VideoTypeDef],  # (1)
    tags: NotRequired[Mapping[str, str]],
  1. See VideoTypeDef

EncoderConfigurationTypeDef#

# EncoderConfigurationTypeDef definition

class EncoderConfigurationTypeDef(TypedDict):
    arn: str,
    name: NotRequired[str],
    video: NotRequired[VideoTypeDef],  # (1)
    tags: NotRequired[Dict[str, str]],
  1. See VideoTypeDef

ListTagsForResourceResponseTypeDef#

# ListTagsForResourceResponseTypeDef definition

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

CreateParticipantTokenResponseTypeDef#

# CreateParticipantTokenResponseTypeDef definition

class CreateParticipantTokenResponseTypeDef(TypedDict):
    participantToken: ParticipantTokenTypeDef,  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See ParticipantTokenTypeDef
  2. See ResponseMetadataTypeDef

CreateStageRequestRequestTypeDef#

# CreateStageRequestRequestTypeDef definition

class CreateStageRequestRequestTypeDef(TypedDict):
    name: NotRequired[str],
    participantTokenConfigurations: NotRequired[Sequence[ParticipantTokenConfigurationTypeDef]],  # (1)
    tags: NotRequired[Mapping[str, str]],
    autoParticipantRecordingConfiguration: NotRequired[AutoParticipantRecordingConfigurationTypeDef],  # (2)
  1. See ParticipantTokenConfigurationTypeDef
  2. See