Type definitions#
Index > ivsrealtime > Type definitions
Auto-generated documentation for ivsrealtime type annotations stubs module mypy-boto3-ivs-realtime.
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],
ResponseMetadataTypeDef#
# ResponseMetadataTypeDef definition
class ResponseMetadataTypeDef(TypedDict):
RequestId: str,
HostId: str,
HTTPStatusCode: int,
HTTPHeaders: Dict[str, str],
RetryAttempts: int,
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]],
DeleteStageRequestRequestTypeDef#
# DeleteStageRequestRequestTypeDef definition
class DeleteStageRequestRequestTypeDef(TypedDict):
arn: str,
DisconnectParticipantRequestRequestTypeDef#
# DisconnectParticipantRequestRequestTypeDef definition
class DisconnectParticipantRequestRequestTypeDef(TypedDict):
participantId: str,
stageArn: str,
reason: NotRequired[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
GetParticipantRequestRequestTypeDef#
# GetParticipantRequestRequestTypeDef definition
class GetParticipantRequestRequestTypeDef(TypedDict):
participantId: str,
sessionId: str,
stageArn: str,
ParticipantTypeDef#
# ParticipantTypeDef definition
class ParticipantTypeDef(TypedDict):
attributes: NotRequired[Dict[str, str]],
firstJoinTime: NotRequired[datetime],
participantId: NotRequired[str],
published: NotRequired[bool],
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],
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]],
ListTagsForResourceRequestRequestTypeDef#
# ListTagsForResourceRequestRequestTypeDef definition
class ListTagsForResourceRequestRequestTypeDef(TypedDict):
resourceArn: 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],
CreateParticipantTokenResponseTypeDef#
# CreateParticipantTokenResponseTypeDef definition
class CreateParticipantTokenResponseTypeDef(TypedDict):
participantToken: ParticipantTokenTypeDef, # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
ListTagsForResourceResponseTypeDef#
# ListTagsForResourceResponseTypeDef definition
class ListTagsForResourceResponseTypeDef(TypedDict):
tags: Dict[str, str],
ResponseMetadata: ResponseMetadataTypeDef, # (1)
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
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)
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)