Skip to content

Ivs Realtime Classes

AutoParticipantRecordingConfigurationOutputTypeDef

storageConfigurationArn

  • Type:
  • Required: Yes

mediaTypes

  • Type: typing.Optional[typing.List[typing.Literal['AUDIO_ONLY', 'AUDIO_VIDEO']]]

AutoParticipantRecordingConfigurationTypeDef

storageConfigurationArn

  • Type:
  • Required: Yes

mediaTypes

  • Type: typing.Optional[typing.Sequence[typing.Literal['AUDIO_ONLY', 'AUDIO_VIDEO']]]

BaseValidatorModel

Oops! This Pydantic model is currently empty. Stay tuned!

ChannelDestinationConfigurationTypeDef

channelArn

  • Type:
  • Required: Yes

encoderConfigurationArn

  • Type: typing.Optional[str]

CompositionSummaryTypeDef

arn

  • Type:
  • Required: Yes

stageArn

  • Type:
  • Required: Yes

destinations

  • Type: typing.List[aws_resource_validator.pydantic_models.ivs_realtime_classes.DestinationSummaryTypeDef]
  • Required: Yes

state

  • Type: typing.Literal['ACTIVE', 'FAILED', 'STARTING', 'STOPPED', 'STOPPING']
  • Required: Yes

tags

  • Type: typing.Optional[typing.Dict[str, str]]

startTime

  • Type: typing.Optional[datetime.datetime]

endTime

  • Type: typing.Optional[datetime.datetime]

CompositionTypeDef

arn

  • Type:
  • Required: Yes

stageArn

  • Type:
  • Required: Yes

state

  • Type: typing.Literal['ACTIVE', 'FAILED', 'STARTING', 'STOPPED', 'STOPPING']
  • Required: Yes

layout

  • Type:
  • Required: Yes

destinations

  • Type: typing.List[aws_resource_validator.pydantic_models.ivs_realtime_classes.DestinationTypeDef]
  • Required: Yes

tags

  • Type: typing.Optional[typing.Dict[str, str]]

startTime

  • Type: typing.Optional[datetime.datetime]

endTime

  • Type: typing.Optional[datetime.datetime]

CreateEncoderConfigurationRequestRequestTypeDef

name

  • Type: typing.Optional[str]

video

  • Type: typing.Optional[aws_resource_validator.pydantic_models.ivs_realtime_classes.VideoTypeDef]

tags

  • Type: typing.Optional[typing.Mapping[str, str]]

CreateEncoderConfigurationResponseTypeDef

encoderConfiguration

  • Type:
  • Required: Yes

ResponseMetadata

  • Type:
  • Required: Yes

CreateParticipantTokenRequestRequestTypeDef

stageArn

  • Type:
  • Required: Yes

duration

  • Type: typing.Optional[int]

userId

  • Type: typing.Optional[str]

attributes

  • Type: typing.Optional[typing.Mapping[str, str]]

capabilities

  • Type: typing.Optional[typing.Sequence[typing.Literal['PUBLISH', 'SUBSCRIBE']]]

CreateParticipantTokenResponseTypeDef

participantToken

  • Type:
  • Required: Yes

ResponseMetadata

  • Type:
  • Required: Yes

CreateStageRequestRequestTypeDef

name

  • Type: typing.Optional[str]

participantTokenConfigurations

  • Type: typing.Optional[typing.Sequence[aws_resource_validator.pydantic_models.ivs_realtime_classes.ParticipantTokenConfigurationTypeDef]]

tags

  • Type: typing.Optional[typing.Mapping[str, str]]

autoParticipantRecordingConfiguration

  • Type: typing.Optional[aws_resource_validator.pydantic_models.ivs_realtime_classes.AutoParticipantRecordingConfigurationTypeDef]

CreateStageResponseTypeDef

stage

  • Type:
  • Required: Yes

participantTokens

  • Type: typing.List[aws_resource_validator.pydantic_models.ivs_realtime_classes.ParticipantTokenTypeDef]
  • Required: Yes

ResponseMetadata

  • Type:
  • Required: Yes

CreateStorageConfigurationRequestRequestTypeDef

s3

  • Type:
  • Required: Yes

name

  • Type: typing.Optional[str]

tags

  • Type: typing.Optional[typing.Mapping[str, str]]

CreateStorageConfigurationResponseTypeDef

storageConfiguration

  • Type:
  • Required: Yes

ResponseMetadata

  • Type:
  • Required: Yes

DeleteEncoderConfigurationRequestRequestTypeDef

arn

  • Type:
  • Required: Yes

DeletePublicKeyRequestRequestTypeDef

arn

  • Type:
  • Required: Yes

DeleteStageRequestRequestTypeDef

arn

  • Type:
  • Required: Yes

DeleteStorageConfigurationRequestRequestTypeDef

arn

  • Type:
  • Required: Yes

DestinationConfigurationOutputTypeDef

name

  • Type: typing.Optional[str]

channel

  • Type: typing.Optional[aws_resource_validator.pydantic_models.ivs_realtime_classes.ChannelDestinationConfigurationTypeDef]

s3

  • Type: typing.Optional[aws_resource_validator.pydantic_models.ivs_realtime_classes.S3DestinationConfigurationOutputTypeDef]

DestinationConfigurationTypeDef

name

  • Type: typing.Optional[str]

channel

  • Type: typing.Optional[aws_resource_validator.pydantic_models.ivs_realtime_classes.ChannelDestinationConfigurationTypeDef]

s3

  • Type: typing.Optional[aws_resource_validator.pydantic_models.ivs_realtime_classes.S3DestinationConfigurationTypeDef]

DestinationDetailTypeDef

s3

  • Type: typing.Optional[aws_resource_validator.pydantic_models.ivs_realtime_classes.S3DetailTypeDef]

DestinationSummaryTypeDef

id

  • Type:
  • Required: Yes

state

  • Type: typing.Literal['ACTIVE', 'FAILED', 'RECONNECTING', 'STARTING', 'STOPPED', 'STOPPING']
  • Required: Yes

startTime

  • Type: typing.Optional[datetime.datetime]

endTime

  • Type: typing.Optional[datetime.datetime]

DestinationTypeDef

id

  • Type:
  • Required: Yes

state

  • Type: typing.Literal['ACTIVE', 'FAILED', 'RECONNECTING', 'STARTING', 'STOPPED', 'STOPPING']
  • Required: Yes

configuration

  • Type:
  • Required: Yes

startTime

  • Type: typing.Optional[datetime.datetime]

endTime

  • Type: typing.Optional[datetime.datetime]

detail

  • Type: typing.Optional[aws_resource_validator.pydantic_models.ivs_realtime_classes.DestinationDetailTypeDef]

DisconnectParticipantRequestRequestTypeDef

stageArn

  • Type:
  • Required: Yes

participantId

  • Type:
  • Required: Yes

reason

  • Type: typing.Optional[str]

EncoderConfigurationSummaryTypeDef

arn

  • Type:
  • Required: Yes

name

  • Type: typing.Optional[str]

tags

  • Type: typing.Optional[typing.Dict[str, str]]

EncoderConfigurationTypeDef

arn

  • Type:
  • Required: Yes

name

  • Type: typing.Optional[str]

video

  • Type: typing.Optional[aws_resource_validator.pydantic_models.ivs_realtime_classes.VideoTypeDef]

tags

  • Type: typing.Optional[typing.Dict[str, str]]

EventTypeDef

name

  • Type: typing.Optional[typing.Literal['JOINED', 'JOIN_ERROR', 'LEFT', 'PUBLISH_ERROR', 'PUBLISH_STARTED', 'PUBLISH_STOPPED', 'SUBSCRIBE_ERROR', 'SUBSCRIBE_STARTED', 'SUBSCRIBE_STOPPED']]

participantId

  • Type: typing.Optional[str]

eventTime

  • Type: typing.Optional[datetime.datetime]

remoteParticipantId

  • Type: typing.Optional[str]

errorCode

  • Type: typing.Optional[typing.Literal['INSUFFICIENT_CAPABILITIES', 'PUBLISHER_NOT_FOUND', 'QUOTA_EXCEEDED']]

GetCompositionRequestRequestTypeDef

arn

  • Type:
  • Required: Yes

GetCompositionResponseTypeDef

composition

  • Type:
  • Required: Yes

ResponseMetadata

  • Type:
  • Required: Yes

GetEncoderConfigurationRequestRequestTypeDef

arn

  • Type:
  • Required: Yes

GetEncoderConfigurationResponseTypeDef

encoderConfiguration

  • Type:
  • Required: Yes

ResponseMetadata

  • Type:
  • Required: Yes

GetParticipantRequestRequestTypeDef

stageArn

  • Type:
  • Required: Yes

sessionId

  • Type:
  • Required: Yes

participantId

  • Type:
  • Required: Yes

GetParticipantResponseTypeDef

participant

  • Type:
  • Required: Yes

ResponseMetadata

  • Type:
  • Required: Yes

GetPublicKeyRequestRequestTypeDef

arn

  • Type:
  • Required: Yes

GetPublicKeyResponseTypeDef

publicKey

  • Type:
  • Required: Yes

ResponseMetadata

  • Type:
  • Required: Yes

GetStageRequestRequestTypeDef

arn

  • Type:
  • Required: Yes

GetStageResponseTypeDef

stage

  • Type:
  • Required: Yes

ResponseMetadata

  • Type:
  • Required: Yes

GetStageSessionRequestRequestTypeDef

stageArn

  • Type:
  • Required: Yes

sessionId

  • Type:
  • Required: Yes

GetStageSessionResponseTypeDef

stageSession

  • Type:
  • Required: Yes

ResponseMetadata

  • Type:
  • Required: Yes

GetStorageConfigurationRequestRequestTypeDef

arn

  • Type:
  • Required: Yes

GetStorageConfigurationResponseTypeDef

storageConfiguration

  • Type:
  • Required: Yes

ResponseMetadata

  • Type:
  • Required: Yes

GridConfigurationTypeDef

featuredParticipantAttribute

  • Type: typing.Optional[str]

omitStoppedVideo

  • Type: typing.Optional[bool]

videoAspectRatio

  • Type: typing.Optional[typing.Literal['AUTO', 'PORTRAIT', 'SQUARE', 'VIDEO']]

videoFillMode

  • Type: typing.Optional[typing.Literal['CONTAIN', 'COVER', 'FILL']]

gridGap

  • Type: typing.Optional[int]

ImportPublicKeyRequestRequestTypeDef

publicKeyMaterial

  • Type:
  • Required: Yes

name

  • Type: typing.Optional[str]

tags

  • Type: typing.Optional[typing.Mapping[str, str]]

ImportPublicKeyResponseTypeDef

publicKey

  • Type:
  • Required: Yes

ResponseMetadata

  • Type:
  • Required: Yes

LayoutConfigurationTypeDef

grid

  • Type: typing.Optional[aws_resource_validator.pydantic_models.ivs_realtime_classes.GridConfigurationTypeDef]

pip

  • Type: typing.Optional[aws_resource_validator.pydantic_models.ivs_realtime_classes.PipConfigurationTypeDef]

ListCompositionsRequestRequestTypeDef

filterByStageArn

  • Type: typing.Optional[str]

filterByEncoderConfigurationArn

  • Type: typing.Optional[str]

nextToken

  • Type: typing.Optional[str]

maxResults

  • Type: typing.Optional[int]

ListCompositionsResponseTypeDef

compositions

  • Type: typing.List[aws_resource_validator.pydantic_models.ivs_realtime_classes.CompositionSummaryTypeDef]
  • Required: Yes

nextToken

  • Type:
  • Required: Yes

ResponseMetadata

  • Type:
  • Required: Yes

ListEncoderConfigurationsRequestRequestTypeDef

nextToken

  • Type: typing.Optional[str]

maxResults

  • Type: typing.Optional[int]

ListEncoderConfigurationsResponseTypeDef

encoderConfigurations

  • Type: typing.List[aws_resource_validator.pydantic_models.ivs_realtime_classes.EncoderConfigurationSummaryTypeDef]
  • Required: Yes

nextToken

  • Type:
  • Required: Yes

ResponseMetadata

  • Type:
  • Required: Yes

ListParticipantEventsRequestRequestTypeDef

stageArn

  • Type:
  • Required: Yes

sessionId

  • Type:
  • Required: Yes

participantId

  • Type:
  • Required: Yes

nextToken

  • Type: typing.Optional[str]

maxResults

  • Type: typing.Optional[int]

ListParticipantEventsResponseTypeDef

events

  • Type: typing.List[aws_resource_validator.pydantic_models.ivs_realtime_classes.EventTypeDef]
  • Required: Yes

nextToken

  • Type:
  • Required: Yes

ResponseMetadata

  • Type:
  • Required: Yes

ListParticipantsRequestRequestTypeDef

stageArn

  • Type:
  • Required: Yes

sessionId

  • Type:
  • Required: Yes

filterByUserId

  • Type: typing.Optional[str]

filterByPublished

  • Type: typing.Optional[bool]

filterByState

  • Type: typing.Optional[typing.Literal['CONNECTED', 'DISCONNECTED']]

nextToken

  • Type: typing.Optional[str]

maxResults

  • Type: typing.Optional[int]

filterByRecordingState

  • Type: typing.Optional[typing.Literal['ACTIVE', 'FAILED', 'STARTING', 'STOPPED', 'STOPPING']]

ListParticipantsResponseTypeDef

participants

  • Type: typing.List[aws_resource_validator.pydantic_models.ivs_realtime_classes.ParticipantSummaryTypeDef]
  • Required: Yes

nextToken

  • Type:
  • Required: Yes

ResponseMetadata

  • Type:
  • Required: Yes

ListPublicKeysRequestListPublicKeysPaginateTypeDef

PaginationConfig

  • Type: typing.Optional[aws_resource_validator.pydantic_models.ivs_realtime_classes.PaginatorConfigTypeDef]

ListPublicKeysRequestRequestTypeDef

nextToken

  • Type: typing.Optional[str]

maxResults

  • Type: typing.Optional[int]

ListPublicKeysResponseTypeDef

publicKeys

  • Type: typing.List[aws_resource_validator.pydantic_models.ivs_realtime_classes.PublicKeySummaryTypeDef]
  • Required: Yes

nextToken

  • Type:
  • Required: Yes

ResponseMetadata

  • Type:
  • Required: Yes

ListStageSessionsRequestRequestTypeDef

stageArn

  • Type:
  • Required: Yes

nextToken

  • Type: typing.Optional[str]

maxResults

  • Type: typing.Optional[int]

ListStageSessionsResponseTypeDef

stageSessions

  • Type: typing.List[aws_resource_validator.pydantic_models.ivs_realtime_classes.StageSessionSummaryTypeDef]
  • Required: Yes

nextToken

  • Type:
  • Required: Yes

ResponseMetadata

  • Type:
  • Required: Yes

ListStagesRequestRequestTypeDef

nextToken

  • Type: typing.Optional[str]

maxResults

  • Type: typing.Optional[int]

ListStagesResponseTypeDef

stages

  • Type: typing.List[aws_resource_validator.pydantic_models.ivs_realtime_classes.StageSummaryTypeDef]
  • Required: Yes

nextToken

  • Type:
  • Required: Yes

ResponseMetadata

  • Type:
  • Required: Yes

ListStorageConfigurationsRequestRequestTypeDef

nextToken

  • Type: typing.Optional[str]

maxResults

  • Type: typing.Optional[int]

ListStorageConfigurationsResponseTypeDef

storageConfigurations

  • Type: typing.List[aws_resource_validator.pydantic_models.ivs_realtime_classes.StorageConfigurationSummaryTypeDef]
  • Required: Yes

nextToken

  • Type:
  • Required: Yes

ResponseMetadata

  • Type:
  • Required: Yes

ListTagsForResourceRequestRequestTypeDef

resourceArn

  • Type:
  • Required: Yes

ListTagsForResourceResponseTypeDef

tags

  • Type: typing.Dict[str, str]
  • Required: Yes

ResponseMetadata

  • Type:
  • Required: Yes

PaginatorConfigTypeDef

MaxItems

  • Type: typing.Optional[int]

PageSize

  • Type: typing.Optional[int]

StartingToken

  • Type: typing.Optional[str]

ParticipantSummaryTypeDef

participantId

  • Type: typing.Optional[str]

userId

  • Type: typing.Optional[str]

state

  • Type: typing.Optional[typing.Literal['CONNECTED', 'DISCONNECTED']]

firstJoinTime

  • Type: typing.Optional[datetime.datetime]

published

  • Type: typing.Optional[bool]

recordingState

  • Type: typing.Optional[typing.Literal['ACTIVE', 'DISABLED', 'FAILED', 'STARTING', 'STOPPED', 'STOPPING']]

ParticipantTokenConfigurationTypeDef

duration

  • Type: typing.Optional[int]

userId

  • Type: typing.Optional[str]

attributes

  • Type: typing.Optional[typing.Mapping[str, str]]

capabilities

  • Type: typing.Optional[typing.Sequence[typing.Literal['PUBLISH', 'SUBSCRIBE']]]

ParticipantTokenTypeDef

participantId

  • Type: typing.Optional[str]

token

  • Type: typing.Optional[str]

userId

  • Type: typing.Optional[str]

attributes

  • Type: typing.Optional[typing.Dict[str, str]]

duration

  • Type: typing.Optional[int]

capabilities

  • Type: typing.Optional[typing.List[typing.Literal['PUBLISH', 'SUBSCRIBE']]]

expirationTime

  • Type: typing.Optional[datetime.datetime]

ParticipantTypeDef

participantId

  • Type: typing.Optional[str]

userId

  • Type: typing.Optional[str]

state

  • Type: typing.Optional[typing.Literal['CONNECTED', 'DISCONNECTED']]

firstJoinTime

  • Type: typing.Optional[datetime.datetime]

attributes

  • Type: typing.Optional[typing.Dict[str, str]]

published

  • Type: typing.Optional[bool]

ispName

  • Type: typing.Optional[str]

osName

  • Type: typing.Optional[str]

osVersion

  • Type: typing.Optional[str]

browserName

  • Type: typing.Optional[str]

browserVersion

  • Type: typing.Optional[str]

sdkVersion

  • Type: typing.Optional[str]

recordingS3BucketName

  • Type: typing.Optional[str]

recordingS3Prefix

  • Type: typing.Optional[str]

recordingState

  • Type: typing.Optional[typing.Literal['ACTIVE', 'DISABLED', 'FAILED', 'STARTING', 'STOPPED', 'STOPPING']]

PipConfigurationTypeDef

featuredParticipantAttribute

  • Type: typing.Optional[str]

omitStoppedVideo

  • Type: typing.Optional[bool]

videoFillMode

  • Type: typing.Optional[typing.Literal['CONTAIN', 'COVER', 'FILL']]

gridGap

  • Type: typing.Optional[int]

pipParticipantAttribute

  • Type: typing.Optional[str]

pipBehavior

  • Type: typing.Optional[typing.Literal['DYNAMIC', 'STATIC']]

pipOffset

  • Type: typing.Optional[int]

pipPosition

  • Type: typing.Optional[typing.Literal['BOTTOM_LEFT', 'BOTTOM_RIGHT', 'TOP_LEFT', 'TOP_RIGHT']]

pipWidth

  • Type: typing.Optional[int]

pipHeight

  • Type: typing.Optional[int]

PublicKeySummaryTypeDef

arn

  • Type: typing.Optional[str]

name

  • Type: typing.Optional[str]

tags

  • Type: typing.Optional[typing.Dict[str, str]]

PublicKeyTypeDef

arn

  • Type: typing.Optional[str]

name

  • Type: typing.Optional[str]

publicKeyMaterial

  • Type: typing.Optional[str]

fingerprint

  • Type: typing.Optional[str]

tags

  • Type: typing.Optional[typing.Dict[str, str]]

RecordingConfigurationTypeDef

format

  • Type: typing.Optional[typing.Literal['HLS']]

ResponseMetadataTypeDef

RequestId

  • Type:
  • Required: Yes

HTTPStatusCode

  • Type:
  • Required: Yes

HTTPHeaders

  • Type: typing.Dict[str, str]
  • Required: Yes

RetryAttempts

  • Type:
  • Required: Yes

HostId

  • Type: typing.Optional[str]

S3DestinationConfigurationOutputTypeDef

storageConfigurationArn

  • Type:
  • Required: Yes

encoderConfigurationArns

  • Type: typing.List[str]
  • Required: Yes

recordingConfiguration

  • Type: typing.Optional[aws_resource_validator.pydantic_models.ivs_realtime_classes.RecordingConfigurationTypeDef]

S3DestinationConfigurationTypeDef

storageConfigurationArn

  • Type:
  • Required: Yes

encoderConfigurationArns

  • Type: typing.Sequence[str]
  • Required: Yes

recordingConfiguration

  • Type: typing.Optional[aws_resource_validator.pydantic_models.ivs_realtime_classes.RecordingConfigurationTypeDef]

S3DetailTypeDef

recordingPrefix

  • Type:
  • Required: Yes

S3StorageConfigurationTypeDef

bucketName

  • Type:
  • Required: Yes

StageEndpointsTypeDef

events

  • Type: typing.Optional[str]

whip

  • Type: typing.Optional[str]

StageSessionSummaryTypeDef

sessionId

  • Type: typing.Optional[str]

startTime

  • Type: typing.Optional[datetime.datetime]

endTime

  • Type: typing.Optional[datetime.datetime]

StageSessionTypeDef

sessionId

  • Type: typing.Optional[str]

startTime

  • Type: typing.Optional[datetime.datetime]

endTime

  • Type: typing.Optional[datetime.datetime]

StageSummaryTypeDef

arn

  • Type:
  • Required: Yes

name

  • Type: typing.Optional[str]

activeSessionId

  • Type: typing.Optional[str]

tags

  • Type: typing.Optional[typing.Dict[str, str]]

StageTypeDef

arn

  • Type:
  • Required: Yes

name

  • Type: typing.Optional[str]

activeSessionId

  • Type: typing.Optional[str]

tags

  • Type: typing.Optional[typing.Dict[str, str]]

autoParticipantRecordingConfiguration

  • Type: typing.Optional[aws_resource_validator.pydantic_models.ivs_realtime_classes.AutoParticipantRecordingConfigurationOutputTypeDef]

endpoints

  • Type: typing.Optional[aws_resource_validator.pydantic_models.ivs_realtime_classes.StageEndpointsTypeDef]

StartCompositionRequestRequestTypeDef

stageArn

  • Type:
  • Required: Yes

destinations

  • Type: typing.Sequence[typing.Union[aws_resource_validator.pydantic_models.ivs_realtime_classes.DestinationConfigurationTypeDef, aws_resource_validator.pydantic_models.ivs_realtime_classes.DestinationConfigurationOutputTypeDef]]
  • Required: Yes

idempotencyToken

  • Type: typing.Optional[str]

layout

  • Type: typing.Optional[aws_resource_validator.pydantic_models.ivs_realtime_classes.LayoutConfigurationTypeDef]

tags

  • Type: typing.Optional[typing.Mapping[str, str]]

StartCompositionResponseTypeDef

composition

  • Type:
  • Required: Yes

ResponseMetadata

  • Type:
  • Required: Yes

StopCompositionRequestRequestTypeDef

arn

  • Type:
  • Required: Yes

StorageConfigurationSummaryTypeDef

arn

  • Type:
  • Required: Yes

name

  • Type: typing.Optional[str]

s3

  • Type: typing.Optional[aws_resource_validator.pydantic_models.ivs_realtime_classes.S3StorageConfigurationTypeDef]

tags

  • Type: typing.Optional[typing.Dict[str, str]]

StorageConfigurationTypeDef

arn

  • Type:
  • Required: Yes

name

  • Type: typing.Optional[str]

s3

  • Type: typing.Optional[aws_resource_validator.pydantic_models.ivs_realtime_classes.S3StorageConfigurationTypeDef]

tags

  • Type: typing.Optional[typing.Dict[str, str]]

TagResourceRequestRequestTypeDef

resourceArn

  • Type:
  • Required: Yes

tags

  • Type: typing.Mapping[str, str]
  • Required: Yes

UntagResourceRequestRequestTypeDef

resourceArn

  • Type:
  • Required: Yes

tagKeys

  • Type: typing.Sequence[str]
  • Required: Yes

UpdateStageRequestRequestTypeDef

arn

  • Type:
  • Required: Yes

name

  • Type: typing.Optional[str]

autoParticipantRecordingConfiguration

  • Type: typing.Optional[aws_resource_validator.pydantic_models.ivs_realtime_classes.AutoParticipantRecordingConfigurationTypeDef]

UpdateStageResponseTypeDef

stage

  • Type:
  • Required: Yes

ResponseMetadata

  • Type:
  • Required: Yes

VideoTypeDef

width

  • Type: typing.Optional[int]

height

  • Type: typing.Optional[int]

framerate

  • Type: typing.Optional[float]

bitrate

  • Type: typing.Optional[int]