Skip to content

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],
  1. See DestinationStateType

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],
  1. See ParticipantTokenCapabilityType

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],
  1. See ParticipantTokenCapabilityType

ParticipantTokenConfigurationTypeDef#

# ParticipantTokenConfigurationTypeDef definition

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

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],
  1. See EventErrorCodeType
  2. 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],
  1. See ParticipantStateType

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

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],
  1. See ParticipantStateType

ParticipantSummaryTypeDef#

# ParticipantSummaryTypeDef definition

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

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)
  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],

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]],
  1. See DestinationSummaryTypeDef
  2. See CompositionStateType

CreateEncoderConfigurationRequestRequestTypeDef#

# CreateEncoderConfigurationRequestRequestTypeDef definition

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

EncoderConfigurationTypeDef#

# EncoderConfigurationTypeDef definition

class EncoderConfigurationTypeDef(TypedDict):
    arn: str,
    name: NotRequired[str],
    tags: NotRequired[Dict[str, str]],
    video: NotRequired[VideoTypeDef],  # (1)
  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]],
  1. See ParticipantTokenConfigurationTypeDef

CreateStageResponseTypeDef#

# CreateStageResponseTypeDef definition

class CreateStageResponseTypeDef(TypedDict):
    participantTokens: List[ParticipantTokenTypeDef],  # (1)
    stage: StageTypeDef,  # (2)
    ResponseMetadata: ResponseMetadataTypeDef,  # (3)
  1. See ParticipantTokenTypeDef
  2. See StageTypeDef
  3. See ResponseMetadataTypeDef

GetStageResponseTypeDef#

# GetStageResponseTypeDef definition

class GetStageResponseTypeDef(TypedDict):
    stage: StageTypeDef,  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See StageTypeDef
  2. See ResponseMetadataTypeDef

UpdateStageResponseTypeDef#

# UpdateStageResponseTypeDef definition

class UpdateStageResponseTypeDef(TypedDict):
    stage: StageTypeDef,  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See StageTypeDef
  2. See ResponseMetadataTypeDef

CreateStorageConfigurationRequestRequestTypeDef#

# CreateStorageConfigurationRequestRequestTypeDef definition

class CreateStorageConfigurationRequestRequestTypeDef(TypedDict):
    s3: S3StorageConfigurationTypeDef,  # (1)
    name: NotRequired[str],
    tags: NotRequired[Mapping[str, str]],
  1. See S3StorageConfigurationTypeDef

StorageConfigurationSummaryTypeDef#

# StorageConfigurationSummaryTypeDef definition

class StorageConfigurationSummaryTypeDef(TypedDict):
    arn: str,
    name: NotRequired[str],
    s3: NotRequired[S3StorageConfigurationTypeDef],  # (1)
    tags: NotRequired[Dict[str, str]],
  1. See S3StorageConfigurationTypeDef

StorageConfigurationTypeDef#

# StorageConfigurationTypeDef definition

class StorageConfigurationTypeDef(TypedDict):
    arn: str,
    name: NotRequired[str],
    s3: NotRequired[S3StorageConfigurationTypeDef],  # (1)
    tags: NotRequired[Dict[str, str]],
  1. See S3StorageConfigurationTypeDef

DestinationDetailTypeDef#

# DestinationDetailTypeDef definition

class DestinationDetailTypeDef(TypedDict):
    s3: NotRequired[S3DetailTypeDef],  # (1)
  1. See S3DetailTypeDef

ListEncoderConfigurationsResponseTypeDef#

# ListEncoderConfigurationsResponseTypeDef definition

class ListEncoderConfigurationsResponseTypeDef(TypedDict):
    encoderConfigurations: List[EncoderConfigurationSummaryTypeDef],  # (1)
    nextToken: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See EncoderConfigurationSummaryTypeDef
  2. See ResponseMetadataTypeDef

ListParticipantEventsResponseTypeDef#

# ListParticipantEventsResponseTypeDef definition

class ListParticipantEventsResponseTypeDef(TypedDict):
    events: List[EventTypeDef],  # (1)
    nextToken: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See EventTypeDef
  2. See ResponseMetadataTypeDef

GetParticipantResponseTypeDef#

# GetParticipantResponseTypeDef definition

class GetParticipantResponseTypeDef(TypedDict):
    participant: ParticipantTypeDef,  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See ParticipantTypeDef
  2. See ResponseMetadataTypeDef

GetStageSessionResponseTypeDef#

# GetStageSessionResponseTypeDef definition

class GetStageSessionResponseTypeDef(TypedDict):
    stageSession: StageSessionTypeDef,  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See StageSessionTypeDef
  2. See ResponseMetadataTypeDef

LayoutConfigurationTypeDef#

# LayoutConfigurationTypeDef definition

class LayoutConfigurationTypeDef(TypedDict):
    grid: NotRequired[GridConfigurationTypeDef],  # (1)
  1. See GridConfigurationTypeDef

ListParticipantsResponseTypeDef#

# ListParticipantsResponseTypeDef definition

class ListParticipantsResponseTypeDef(TypedDict):
    nextToken: str,
    participants: List[ParticipantSummaryTypeDef],  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See ParticipantSummaryTypeDef
  2. See ResponseMetadataTypeDef

ListStageSessionsResponseTypeDef#

# ListStageSessionsResponseTypeDef definition

class ListStageSessionsResponseTypeDef(TypedDict):
    nextToken: str,
    stageSessions: List[StageSessionSummaryTypeDef],  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See StageSessionSummaryTypeDef
  2. See ResponseMetadataTypeDef

ListStagesResponseTypeDef#

# ListStagesResponseTypeDef definition

class ListStagesResponseTypeDef(TypedDict):
    nextToken: str,
    stages: List[StageSummaryTypeDef],  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See StageSummaryTypeDef
  2. See ResponseMetadataTypeDef

S3DestinationConfigurationTypeDef#

# S3DestinationConfigurationTypeDef definition

class S3DestinationConfigurationTypeDef(TypedDict):
    encoderConfigurationArns: List[str],
    storageConfigurationArn: str,
    recordingConfiguration: NotRequired[RecordingConfigurationTypeDef],  # (1)
  1. See RecordingConfigurationTypeDef

ListCompositionsResponseTypeDef#

# ListCompositionsResponseTypeDef definition

class ListCompositionsResponseTypeDef(TypedDict):
    compositions: List[CompositionSummaryTypeDef],  # (1)
    nextToken: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See CompositionSummaryTypeDef
  2. See ResponseMetadataTypeDef

CreateEncoderConfigurationResponseTypeDef#

# CreateEncoderConfigurationResponseTypeDef definition

class CreateEncoderConfigurationResponseTypeDef(TypedDict):
    encoderConfiguration: EncoderConfigurationTypeDef,  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See EncoderConfigurationTypeDef
  2. See ResponseMetadataTypeDef

GetEncoderConfigurationResponseTypeDef#

# GetEncoderConfigurationResponseTypeDef definition

class GetEncoderConfigurationResponseTypeDef(TypedDict):
    encoderConfiguration: EncoderConfigurationTypeDef,  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See EncoderConfigurationTypeDef
  2. See ResponseMetadataTypeDef

ListStorageConfigurationsResponseTypeDef#

# ListStorageConfigurationsResponseTypeDef definition

class ListStorageConfigurationsResponseTypeDef(TypedDict):
    nextToken: str,
    storageConfigurations: List[StorageConfigurationSummaryTypeDef],  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See StorageConfigurationSummaryTypeDef
  2. See ResponseMetadataTypeDef

CreateStorageConfigurationResponseTypeDef#

# CreateStorageConfigurationResponseTypeDef definition

class CreateStorageConfigurationResponseTypeDef(TypedDict):
    storageConfiguration: StorageConfigurationTypeDef,  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See StorageConfigurationTypeDef
  2. See ResponseMetadataTypeDef

GetStorageConfigurationResponseTypeDef#

# GetStorageConfigurationResponseTypeDef definition

class GetStorageConfigurationResponseTypeDef(TypedDict):
    storageConfiguration: StorageConfigurationTypeDef,  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See StorageConfigurationTypeDef
  2. See ResponseMetadataTypeDef

DestinationConfigurationTypeDef#

# DestinationConfigurationTypeDef definition

class DestinationConfigurationTypeDef(TypedDict):
    channel: NotRequired[ChannelDestinationConfigurationTypeDef],  # (1)
    name: NotRequired[str],
    s3: NotRequired[S3DestinationConfigurationTypeDef],  # (2)
  1. See ChannelDestinationConfigurationTypeDef
  2. See S3DestinationConfigurationTypeDef