Type definitions#
Index > ivsrealtime > Type definitions
Auto-generated documentation for ivsrealtime type annotations stubs module mypy-boto3-ivs-realtime.
ChannelDestinationConfigurationTypeDef#
# ChannelDestinationConfigurationTypeDef definition
class ChannelDestinationConfigurationTypeDef(TypedDict):
channelArn: str,
encoderConfigurationArn: NotRequired[str],
DestinationSummaryTypeDef#
# DestinationSummaryTypeDef definition
class DestinationSummaryTypeDef(TypedDict):
id: str,
state: DestinationStateType, # (1)
endTime: NotRequired[datetime],
startTime: NotRequired[datetime],
VideoTypeDef#
# VideoTypeDef definition
class VideoTypeDef(TypedDict):
bitrate: NotRequired[int],
framerate: NotRequired[float],
height: NotRequired[int],
width: 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,
attributes: NotRequired[Mapping[str, str]],
capabilities: NotRequired[Sequence[ParticipantTokenCapabilityType]], # (1)
duration: NotRequired[int],
userId: NotRequired[str],
ParticipantTokenTypeDef#
# ParticipantTokenTypeDef definition
class ParticipantTokenTypeDef(TypedDict):
attributes: NotRequired[Dict[str, str]],
capabilities: NotRequired[List[ParticipantTokenCapabilityType]], # (1)
duration: NotRequired[int],
expirationTime: NotRequired[datetime],
participantId: NotRequired[str],
token: NotRequired[str],
userId: NotRequired[str],
ParticipantTokenConfigurationTypeDef#
# ParticipantTokenConfigurationTypeDef definition
class ParticipantTokenConfigurationTypeDef(TypedDict):
attributes: NotRequired[Mapping[str, str]],
capabilities: NotRequired[Sequence[ParticipantTokenCapabilityType]], # (1)
duration: NotRequired[int],
userId: NotRequired[str],
StageTypeDef#
# StageTypeDef definition
class StageTypeDef(TypedDict):
arn: str,
activeSessionId: NotRequired[str],
name: NotRequired[str],
tags: NotRequired[Dict[str, str]],
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):
participantId: str,
stageArn: 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):
errorCode: NotRequired[EventErrorCodeType], # (1)
eventTime: NotRequired[datetime],
name: NotRequired[EventNameType], # (2)
participantId: NotRequired[str],
remoteParticipantId: NotRequired[str],
- See EventErrorCodeType
- See EventNameType
GetCompositionRequestRequestTypeDef#
# GetCompositionRequestRequestTypeDef definition
class GetCompositionRequestRequestTypeDef(TypedDict):
arn: str,
GetEncoderConfigurationRequestRequestTypeDef#
# GetEncoderConfigurationRequestRequestTypeDef definition
class GetEncoderConfigurationRequestRequestTypeDef(TypedDict):
arn: str,
GetParticipantRequestRequestTypeDef#
# GetParticipantRequestRequestTypeDef definition
class GetParticipantRequestRequestTypeDef(TypedDict):
participantId: str,
sessionId: str,
stageArn: str,
ParticipantTypeDef#
# ParticipantTypeDef definition
class ParticipantTypeDef(TypedDict):
attributes: NotRequired[Dict[str, str]],
browserName: NotRequired[str],
browserVersion: NotRequired[str],
firstJoinTime: NotRequired[datetime],
ispName: NotRequired[str],
osName: NotRequired[str],
osVersion: NotRequired[str],
participantId: NotRequired[str],
published: NotRequired[bool],
sdkVersion: NotRequired[str],
state: NotRequired[ParticipantStateType], # (1)
userId: NotRequired[str],
GetStageRequestRequestTypeDef#
# GetStageRequestRequestTypeDef definition
class GetStageRequestRequestTypeDef(TypedDict):
arn: str,
GetStageSessionRequestRequestTypeDef#
# GetStageSessionRequestRequestTypeDef definition
class GetStageSessionRequestRequestTypeDef(TypedDict):
sessionId: str,
stageArn: str,
StageSessionTypeDef#
# StageSessionTypeDef definition
class StageSessionTypeDef(TypedDict):
endTime: NotRequired[datetime],
sessionId: NotRequired[str],
startTime: NotRequired[datetime],
GetStorageConfigurationRequestRequestTypeDef#
# GetStorageConfigurationRequestRequestTypeDef definition
class GetStorageConfigurationRequestRequestTypeDef(TypedDict):
arn: str,
GridConfigurationTypeDef#
# GridConfigurationTypeDef definition
class GridConfigurationTypeDef(TypedDict):
featuredParticipantAttribute: NotRequired[str],
gridGap: NotRequired[int],
omitStoppedVideo: NotRequired[bool],
videoAspectRatio: NotRequired[VideoAspectRatioType], # (1)
videoFillMode: NotRequired[VideoFillModeType], # (2)
PipConfigurationTypeDef#
# PipConfigurationTypeDef definition
class PipConfigurationTypeDef(TypedDict):
featuredParticipantAttribute: NotRequired[str],
gridGap: NotRequired[int],
omitStoppedVideo: NotRequired[bool],
pipBehavior: NotRequired[PipBehaviorType], # (1)
pipHeight: NotRequired[int],
pipOffset: NotRequired[int],
pipParticipantAttribute: NotRequired[str],
pipPosition: NotRequired[PipPositionType], # (2)
pipWidth: NotRequired[int],
videoFillMode: NotRequired[VideoFillModeType], # (3)
- See PipBehaviorType
- See PipPositionType
- See VideoFillModeType
ListCompositionsRequestRequestTypeDef#
# ListCompositionsRequestRequestTypeDef definition
class ListCompositionsRequestRequestTypeDef(TypedDict):
filterByEncoderConfigurationArn: NotRequired[str],
filterByStageArn: NotRequired[str],
maxResults: NotRequired[int],
nextToken: NotRequired[str],
ListEncoderConfigurationsRequestRequestTypeDef#
# ListEncoderConfigurationsRequestRequestTypeDef definition
class ListEncoderConfigurationsRequestRequestTypeDef(TypedDict):
maxResults: NotRequired[int],
nextToken: NotRequired[str],
ListParticipantEventsRequestRequestTypeDef#
# ListParticipantEventsRequestRequestTypeDef definition
class ListParticipantEventsRequestRequestTypeDef(TypedDict):
participantId: str,
sessionId: str,
stageArn: str,
maxResults: NotRequired[int],
nextToken: NotRequired[str],
ListParticipantsRequestRequestTypeDef#
# ListParticipantsRequestRequestTypeDef definition
class ListParticipantsRequestRequestTypeDef(TypedDict):
sessionId: str,
stageArn: str,
filterByPublished: NotRequired[bool],
filterByState: NotRequired[ParticipantStateType], # (1)
filterByUserId: NotRequired[str],
maxResults: NotRequired[int],
nextToken: NotRequired[str],
ParticipantSummaryTypeDef#
# ParticipantSummaryTypeDef definition
class ParticipantSummaryTypeDef(TypedDict):
firstJoinTime: NotRequired[datetime],
participantId: NotRequired[str],
published: NotRequired[bool],
state: NotRequired[ParticipantStateType], # (1)
userId: NotRequired[str],
ListStageSessionsRequestRequestTypeDef#
# ListStageSessionsRequestRequestTypeDef definition
class ListStageSessionsRequestRequestTypeDef(TypedDict):
stageArn: str,
maxResults: NotRequired[int],
nextToken: NotRequired[str],
StageSessionSummaryTypeDef#
# StageSessionSummaryTypeDef definition
class StageSessionSummaryTypeDef(TypedDict):
endTime: NotRequired[datetime],
sessionId: NotRequired[str],
startTime: NotRequired[datetime],
ListStagesRequestRequestTypeDef#
# ListStagesRequestRequestTypeDef definition
class ListStagesRequestRequestTypeDef(TypedDict):
maxResults: NotRequired[int],
nextToken: NotRequired[str],
StageSummaryTypeDef#
# StageSummaryTypeDef definition
class StageSummaryTypeDef(TypedDict):
arn: str,
activeSessionId: NotRequired[str],
name: NotRequired[str],
tags: NotRequired[Dict[str, str]],
ListStorageConfigurationsRequestRequestTypeDef#
# ListStorageConfigurationsRequestRequestTypeDef definition
class ListStorageConfigurationsRequestRequestTypeDef(TypedDict):
maxResults: NotRequired[int],
nextToken: NotRequired[str],
ListTagsForResourceRequestRequestTypeDef#
# ListTagsForResourceRequestRequestTypeDef definition
class ListTagsForResourceRequestRequestTypeDef(TypedDict):
resourceArn: str,
RecordingConfigurationTypeDef#
# RecordingConfigurationTypeDef definition
class RecordingConfigurationTypeDef(TypedDict):
format: NotRequired[RecordingConfigurationFormatType], # (1)
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],
UpdateStageRequestRequestTypeDef#
# UpdateStageRequestRequestTypeDef definition
class UpdateStageRequestRequestTypeDef(TypedDict):
arn: str,
name: NotRequired[str],
CompositionSummaryTypeDef#
# CompositionSummaryTypeDef definition
class CompositionSummaryTypeDef(TypedDict):
arn: str,
destinations: List[DestinationSummaryTypeDef], # (1)
stageArn: str,
state: CompositionStateType, # (2)
endTime: NotRequired[datetime],
startTime: NotRequired[datetime],
tags: NotRequired[Dict[str, str]],
CreateEncoderConfigurationRequestRequestTypeDef#
# CreateEncoderConfigurationRequestRequestTypeDef definition
class CreateEncoderConfigurationRequestRequestTypeDef(TypedDict):
name: NotRequired[str],
tags: NotRequired[Mapping[str, str]],
video: NotRequired[VideoTypeDef], # (1)
- See VideoTypeDef
EncoderConfigurationTypeDef#
# EncoderConfigurationTypeDef definition
class EncoderConfigurationTypeDef(TypedDict):
arn: str,
name: NotRequired[str],
tags: NotRequired[Dict[str, str]],
video: NotRequired[VideoTypeDef], # (1)
- See VideoTypeDef
ListTagsForResourceResponseTypeDef#
# ListTagsForResourceResponseTypeDef definition
class ListTagsForResourceResponseTypeDef(TypedDict):
tags: Dict[str, str],
ResponseMetadata: ResponseMetadataTypeDef, # (1)
CreateParticipantTokenResponseTypeDef#
# CreateParticipantTokenResponseTypeDef definition
class CreateParticipantTokenResponseTypeDef(TypedDict):
participantToken: ParticipantTokenTypeDef, # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
CreateStageRequestRequestTypeDef#
# CreateStageRequestRequestTypeDef definition
class CreateStageRequestRequestTypeDef(TypedDict):
name: NotRequired[str],
participantTokenConfigurations: NotRequired[Sequence[ParticipantTokenConfigurationTypeDef]], # (1)
tags: NotRequired[Mapping[str, str]],
CreateStageResponseTypeDef#
# CreateStageResponseTypeDef definition
class CreateStageResponseTypeDef(TypedDict):
participantTokens: List[ParticipantTokenTypeDef], # (1)
stage: StageTypeDef, # (2)
ResponseMetadata: ResponseMetadataTypeDef, # (3)
GetStageResponseTypeDef#
# GetStageResponseTypeDef definition
class GetStageResponseTypeDef(TypedDict):
stage: StageTypeDef, # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
- See StageTypeDef
- See ResponseMetadataTypeDef
UpdateStageResponseTypeDef#
# UpdateStageResponseTypeDef definition
class UpdateStageResponseTypeDef(TypedDict):
stage: StageTypeDef, # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
- See StageTypeDef
- See ResponseMetadataTypeDef
CreateStorageConfigurationRequestRequestTypeDef#
# CreateStorageConfigurationRequestRequestTypeDef definition
class CreateStorageConfigurationRequestRequestTypeDef(TypedDict):
s3: S3StorageConfigurationTypeDef, # (1)
name: NotRequired[str],
tags: NotRequired[Mapping[str, str]],
StorageConfigurationSummaryTypeDef#
# StorageConfigurationSummaryTypeDef definition
class StorageConfigurationSummaryTypeDef(TypedDict):
arn: str,
name: NotRequired[str],
s3: NotRequired[S3StorageConfigurationTypeDef], # (1)
tags: NotRequired[Dict[str, str]],
StorageConfigurationTypeDef#
# StorageConfigurationTypeDef definition
class StorageConfigurationTypeDef(TypedDict):
arn: str,
name: NotRequired[str],
s3: NotRequired[S3StorageConfigurationTypeDef], # (1)
tags: NotRequired[Dict[str, str]],
DestinationDetailTypeDef#
# DestinationDetailTypeDef definition
class DestinationDetailTypeDef(TypedDict):
s3: NotRequired[S3DetailTypeDef], # (1)
- See S3DetailTypeDef
ListEncoderConfigurationsResponseTypeDef#
# ListEncoderConfigurationsResponseTypeDef definition
class ListEncoderConfigurationsResponseTypeDef(TypedDict):
encoderConfigurations: List[EncoderConfigurationSummaryTypeDef], # (1)
nextToken: str,
ResponseMetadata: ResponseMetadataTypeDef, # (2)
ListParticipantEventsResponseTypeDef#
# ListParticipantEventsResponseTypeDef definition
class ListParticipantEventsResponseTypeDef(TypedDict):
events: List[EventTypeDef], # (1)
nextToken: str,
ResponseMetadata: ResponseMetadataTypeDef, # (2)
- See EventTypeDef
- See ResponseMetadataTypeDef
GetParticipantResponseTypeDef#
# GetParticipantResponseTypeDef definition
class GetParticipantResponseTypeDef(TypedDict):
participant: ParticipantTypeDef, # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
GetStageSessionResponseTypeDef#
# GetStageSessionResponseTypeDef definition
class GetStageSessionResponseTypeDef(TypedDict):
stageSession: StageSessionTypeDef, # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
LayoutConfigurationTypeDef#
# LayoutConfigurationTypeDef definition
class LayoutConfigurationTypeDef(TypedDict):
grid: NotRequired[GridConfigurationTypeDef], # (1)
pip: NotRequired[PipConfigurationTypeDef], # (2)
ListParticipantsResponseTypeDef#
# ListParticipantsResponseTypeDef definition
class ListParticipantsResponseTypeDef(TypedDict):
nextToken: str,
participants: List[ParticipantSummaryTypeDef], # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
ListStageSessionsResponseTypeDef#
# ListStageSessionsResponseTypeDef definition
class ListStageSessionsResponseTypeDef(TypedDict):
nextToken: str,
stageSessions: List[StageSessionSummaryTypeDef], # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
ListStagesResponseTypeDef#
# ListStagesResponseTypeDef definition
class ListStagesResponseTypeDef(TypedDict):
nextToken: str,
stages: List[StageSummaryTypeDef], # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
S3DestinationConfigurationTypeDef#
# S3DestinationConfigurationTypeDef definition
class S3DestinationConfigurationTypeDef(TypedDict):
encoderConfigurationArns: List[str],
storageConfigurationArn: str,
recordingConfiguration: NotRequired[RecordingConfigurationTypeDef], # (1)
ListCompositionsResponseTypeDef#
# ListCompositionsResponseTypeDef definition
class ListCompositionsResponseTypeDef(TypedDict):
compositions: List[CompositionSummaryTypeDef], # (1)
nextToken: str,
ResponseMetadata: ResponseMetadataTypeDef, # (2)
CreateEncoderConfigurationResponseTypeDef#
# CreateEncoderConfigurationResponseTypeDef definition
class CreateEncoderConfigurationResponseTypeDef(TypedDict):
encoderConfiguration: EncoderConfigurationTypeDef, # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
GetEncoderConfigurationResponseTypeDef#
# GetEncoderConfigurationResponseTypeDef definition
class GetEncoderConfigurationResponseTypeDef(TypedDict):
encoderConfiguration: EncoderConfigurationTypeDef, # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
ListStorageConfigurationsResponseTypeDef#
# ListStorageConfigurationsResponseTypeDef definition
class ListStorageConfigurationsResponseTypeDef(TypedDict):
nextToken: str,
storageConfigurations: List[StorageConfigurationSummaryTypeDef], # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
CreateStorageConfigurationResponseTypeDef#
# CreateStorageConfigurationResponseTypeDef definition
class CreateStorageConfigurationResponseTypeDef(TypedDict):
storageConfiguration: StorageConfigurationTypeDef, # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
GetStorageConfigurationResponseTypeDef#
# GetStorageConfigurationResponseTypeDef definition
class GetStorageConfigurationResponseTypeDef(TypedDict):
storageConfiguration: StorageConfigurationTypeDef, # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
DestinationConfigurationTypeDef#
# DestinationConfigurationTypeDef definition
class DestinationConfigurationTypeDef(TypedDict):
channel: NotRequired[ChannelDestinationConfigurationTypeDef], # (1)
name: NotRequired[str],
s3: NotRequired[S3DestinationConfigurationTypeDef], # (2)
DestinationTypeDef#
# DestinationTypeDef definition
class DestinationTypeDef(TypedDict):
configuration: DestinationConfigurationTypeDef, # (1)
id: str,
state: DestinationStateType, # (3)
detail: NotRequired[DestinationDetailTypeDef], # (2)
endTime: NotRequired[datetime],
startTime: NotRequired[datetime],
StartCompositionRequestRequestTypeDef#
# StartCompositionRequestRequestTypeDef definition
class StartCompositionRequestRequestTypeDef(TypedDict):
destinations: Sequence[DestinationConfigurationTypeDef], # (1)
stageArn: str,
idempotencyToken: NotRequired[str],
layout: NotRequired[LayoutConfigurationTypeDef], # (2)
tags: NotRequired[Mapping[str, str]],
CompositionTypeDef#
# CompositionTypeDef definition
class CompositionTypeDef(TypedDict):
arn: str,
destinations: List[DestinationTypeDef], # (1)
layout: LayoutConfigurationTypeDef, # (2)
stageArn: str,
state: CompositionStateType, # (3)
endTime: NotRequired[datetime],
startTime: NotRequired[datetime],
tags: NotRequired[Dict[str, str]],
GetCompositionResponseTypeDef#
# GetCompositionResponseTypeDef definition
class GetCompositionResponseTypeDef(TypedDict):
composition: CompositionTypeDef, # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
StartCompositionResponseTypeDef#
# StartCompositionResponseTypeDef definition
class StartCompositionResponseTypeDef(TypedDict):
composition: CompositionTypeDef, # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)