Type definitions#
Index > ChimeSDKMediaPipelines > Type definitions
Auto-generated documentation for ChimeSDKMediaPipelines type annotations stubs module mypy-boto3-chime-sdk-media-pipelines.
TimestampTypeDef#
# TimestampTypeDef definition
TimestampTypeDef = Union[
datetime,
str,
]
ActiveSpeakerOnlyConfigurationTypeDef#
# ActiveSpeakerOnlyConfigurationTypeDef definition
class ActiveSpeakerOnlyConfigurationTypeDef(TypedDict):
ActiveSpeakerPosition: NotRequired[ActiveSpeakerPositionType], # (1)
PostCallAnalyticsSettingsTypeDef#
# PostCallAnalyticsSettingsTypeDef definition
class PostCallAnalyticsSettingsTypeDef(TypedDict):
OutputLocation: str,
DataAccessRoleArn: str,
ContentRedactionOutput: NotRequired[ContentRedactionOutputType], # (1)
OutputEncryptionKMSKeyId: NotRequired[str],
AmazonTranscribeProcessorConfigurationTypeDef#
# AmazonTranscribeProcessorConfigurationTypeDef definition
class AmazonTranscribeProcessorConfigurationTypeDef(TypedDict):
LanguageCode: NotRequired[CallAnalyticsLanguageCodeType], # (1)
VocabularyName: NotRequired[str],
VocabularyFilterName: NotRequired[str],
VocabularyFilterMethod: NotRequired[VocabularyFilterMethodType], # (2)
ShowSpeakerLabel: NotRequired[bool],
EnablePartialResultsStabilization: NotRequired[bool],
PartialResultsStability: NotRequired[PartialResultsStabilityType], # (3)
ContentIdentificationType: NotRequired[ContentTypeType], # (4)
ContentRedactionType: NotRequired[ContentTypeType], # (4)
PiiEntityTypes: NotRequired[str],
LanguageModelName: NotRequired[str],
FilterPartialResults: NotRequired[bool],
IdentifyLanguage: NotRequired[bool],
LanguageOptions: NotRequired[str],
PreferredLanguage: NotRequired[CallAnalyticsLanguageCodeType], # (1)
VocabularyNames: NotRequired[str],
VocabularyFilterNames: NotRequired[str],
- See CallAnalyticsLanguageCodeType
- See VocabularyFilterMethodType
- See PartialResultsStabilityType
- See ContentTypeType
- See ContentTypeType
- See CallAnalyticsLanguageCodeType
AudioConcatenationConfigurationTypeDef#
# AudioConcatenationConfigurationTypeDef definition
class AudioConcatenationConfigurationTypeDef(TypedDict):
State: AudioArtifactsConcatenationStateType, # (1)
CompositedVideoConcatenationConfigurationTypeDef#
# CompositedVideoConcatenationConfigurationTypeDef definition
class CompositedVideoConcatenationConfigurationTypeDef(TypedDict):
State: ArtifactsConcatenationStateType, # (1)
ContentConcatenationConfigurationTypeDef#
# ContentConcatenationConfigurationTypeDef definition
class ContentConcatenationConfigurationTypeDef(TypedDict):
State: ArtifactsConcatenationStateType, # (1)
DataChannelConcatenationConfigurationTypeDef#
# DataChannelConcatenationConfigurationTypeDef definition
class DataChannelConcatenationConfigurationTypeDef(TypedDict):
State: ArtifactsConcatenationStateType, # (1)
MeetingEventsConcatenationConfigurationTypeDef#
# MeetingEventsConcatenationConfigurationTypeDef definition
class MeetingEventsConcatenationConfigurationTypeDef(TypedDict):
State: ArtifactsConcatenationStateType, # (1)
TranscriptionMessagesConcatenationConfigurationTypeDef#
# TranscriptionMessagesConcatenationConfigurationTypeDef definition
class TranscriptionMessagesConcatenationConfigurationTypeDef(TypedDict):
State: ArtifactsConcatenationStateType, # (1)
VideoConcatenationConfigurationTypeDef#
# VideoConcatenationConfigurationTypeDef definition
class VideoConcatenationConfigurationTypeDef(TypedDict):
State: ArtifactsConcatenationStateType, # (1)
AudioArtifactsConfigurationTypeDef#
# AudioArtifactsConfigurationTypeDef definition
class AudioArtifactsConfigurationTypeDef(TypedDict):
MuxType: AudioMuxTypeType, # (1)
- See AudioMuxTypeType
ContentArtifactsConfigurationTypeDef#
# ContentArtifactsConfigurationTypeDef definition
class ContentArtifactsConfigurationTypeDef(TypedDict):
State: ArtifactsStateType, # (1)
MuxType: NotRequired[ContentMuxTypeType], # (2)
- See ArtifactsStateType
- See ContentMuxTypeType
VideoArtifactsConfigurationTypeDef#
# VideoArtifactsConfigurationTypeDef definition
class VideoArtifactsConfigurationTypeDef(TypedDict):
State: ArtifactsStateType, # (1)
MuxType: NotRequired[VideoMuxTypeType], # (2)
- See ArtifactsStateType
- See VideoMuxTypeType
ChannelDefinitionTypeDef#
# ChannelDefinitionTypeDef definition
class ChannelDefinitionTypeDef(TypedDict):
ChannelId: int,
ParticipantRole: NotRequired[ParticipantRoleType], # (1)
S3BucketSinkConfigurationTypeDef#
# S3BucketSinkConfigurationTypeDef definition
class S3BucketSinkConfigurationTypeDef(TypedDict):
Destination: str,
TagTypeDef#
# TagTypeDef definition
class TagTypeDef(TypedDict):
Key: str,
Value: str,
ResponseMetadataTypeDef#
# ResponseMetadataTypeDef definition
class ResponseMetadataTypeDef(TypedDict):
RequestId: str,
HostId: str,
HTTPStatusCode: int,
HTTPHeaders: Dict[str, str],
RetryAttempts: int,
S3RecordingSinkRuntimeConfigurationTypeDef#
# S3RecordingSinkRuntimeConfigurationTypeDef definition
class S3RecordingSinkRuntimeConfigurationTypeDef(TypedDict):
Destination: str,
RecordingFileFormat: RecordingFileFormatType, # (1)
KinesisVideoStreamConfigurationTypeDef#
# KinesisVideoStreamConfigurationTypeDef definition
class KinesisVideoStreamConfigurationTypeDef(TypedDict):
Region: str,
DataRetentionInHours: NotRequired[int],
MediaStreamSinkTypeDef#
# MediaStreamSinkTypeDef definition
class MediaStreamSinkTypeDef(TypedDict):
SinkArn: str,
SinkType: MediaStreamPipelineSinkTypeType, # (1)
ReservedStreamCapacity: int,
MediaStreamType: MediaStreamTypeType, # (2)
MediaStreamSourceTypeDef#
# MediaStreamSourceTypeDef definition
class MediaStreamSourceTypeDef(TypedDict):
SourceType: MediaPipelineSourceTypeType, # (1)
SourceArn: str,
DeleteMediaCapturePipelineRequestRequestTypeDef#
# DeleteMediaCapturePipelineRequestRequestTypeDef definition
class DeleteMediaCapturePipelineRequestRequestTypeDef(TypedDict):
MediaPipelineId: str,
DeleteMediaInsightsPipelineConfigurationRequestRequestTypeDef#
# DeleteMediaInsightsPipelineConfigurationRequestRequestTypeDef definition
class DeleteMediaInsightsPipelineConfigurationRequestRequestTypeDef(TypedDict):
Identifier: str,
DeleteMediaPipelineKinesisVideoStreamPoolRequestRequestTypeDef#
# DeleteMediaPipelineKinesisVideoStreamPoolRequestRequestTypeDef definition
class DeleteMediaPipelineKinesisVideoStreamPoolRequestRequestTypeDef(TypedDict):
Identifier: str,
DeleteMediaPipelineRequestRequestTypeDef#
# DeleteMediaPipelineRequestRequestTypeDef definition
class DeleteMediaPipelineRequestRequestTypeDef(TypedDict):
MediaPipelineId: str,
GetMediaCapturePipelineRequestRequestTypeDef#
# GetMediaCapturePipelineRequestRequestTypeDef definition
class GetMediaCapturePipelineRequestRequestTypeDef(TypedDict):
MediaPipelineId: str,
GetMediaInsightsPipelineConfigurationRequestRequestTypeDef#
# GetMediaInsightsPipelineConfigurationRequestRequestTypeDef definition
class GetMediaInsightsPipelineConfigurationRequestRequestTypeDef(TypedDict):
Identifier: str,
GetMediaPipelineKinesisVideoStreamPoolRequestRequestTypeDef#
# GetMediaPipelineKinesisVideoStreamPoolRequestRequestTypeDef definition
class GetMediaPipelineKinesisVideoStreamPoolRequestRequestTypeDef(TypedDict):
Identifier: str,
GetMediaPipelineRequestRequestTypeDef#
# GetMediaPipelineRequestRequestTypeDef definition
class GetMediaPipelineRequestRequestTypeDef(TypedDict):
MediaPipelineId: str,
GetSpeakerSearchTaskRequestRequestTypeDef#
# GetSpeakerSearchTaskRequestRequestTypeDef definition
class GetSpeakerSearchTaskRequestRequestTypeDef(TypedDict):
Identifier: str,
SpeakerSearchTaskId: str,
SpeakerSearchTaskTypeDef#
# SpeakerSearchTaskTypeDef definition
class SpeakerSearchTaskTypeDef(TypedDict):
SpeakerSearchTaskId: NotRequired[str],
SpeakerSearchTaskStatus: NotRequired[MediaPipelineTaskStatusType], # (1)
CreatedTimestamp: NotRequired[datetime],
UpdatedTimestamp: NotRequired[datetime],
GetVoiceToneAnalysisTaskRequestRequestTypeDef#
# GetVoiceToneAnalysisTaskRequestRequestTypeDef definition
class GetVoiceToneAnalysisTaskRequestRequestTypeDef(TypedDict):
Identifier: str,
VoiceToneAnalysisTaskId: str,
VoiceToneAnalysisTaskTypeDef#
# VoiceToneAnalysisTaskTypeDef definition
class VoiceToneAnalysisTaskTypeDef(TypedDict):
VoiceToneAnalysisTaskId: NotRequired[str],
VoiceToneAnalysisTaskStatus: NotRequired[MediaPipelineTaskStatusType], # (1)
CreatedTimestamp: NotRequired[datetime],
UpdatedTimestamp: NotRequired[datetime],
HorizontalLayoutConfigurationTypeDef#
# HorizontalLayoutConfigurationTypeDef definition
class HorizontalLayoutConfigurationTypeDef(TypedDict):
TileOrder: NotRequired[TileOrderType], # (1)
TilePosition: NotRequired[HorizontalTilePositionType], # (2)
TileCount: NotRequired[int],
TileAspectRatio: NotRequired[str],
PresenterOnlyConfigurationTypeDef#
# PresenterOnlyConfigurationTypeDef definition
class PresenterOnlyConfigurationTypeDef(TypedDict):
PresenterPosition: NotRequired[PresenterPositionType], # (1)
VerticalLayoutConfigurationTypeDef#
# VerticalLayoutConfigurationTypeDef definition
class VerticalLayoutConfigurationTypeDef(TypedDict):
TileOrder: NotRequired[TileOrderType], # (1)
TilePosition: NotRequired[VerticalTilePositionType], # (2)
TileCount: NotRequired[int],
TileAspectRatio: NotRequired[str],
VideoAttributeTypeDef#
# VideoAttributeTypeDef definition
class VideoAttributeTypeDef(TypedDict):
CornerRadius: NotRequired[int],
BorderColor: NotRequired[BorderColorType], # (1)
HighlightColor: NotRequired[HighlightColorType], # (2)
BorderThickness: NotRequired[int],
- See BorderColorType
- See HighlightColorType
IssueDetectionConfigurationTypeDef#
# IssueDetectionConfigurationTypeDef definition
class IssueDetectionConfigurationTypeDef(TypedDict):
RuleName: str,
KeywordMatchConfigurationTypeDef#
# KeywordMatchConfigurationTypeDef definition
class KeywordMatchConfigurationTypeDef(TypedDict):
RuleName: str,
Keywords: Sequence[str],
Negate: NotRequired[bool],
KinesisDataStreamSinkConfigurationTypeDef#
# KinesisDataStreamSinkConfigurationTypeDef definition
class KinesisDataStreamSinkConfigurationTypeDef(TypedDict):
InsightsTarget: NotRequired[str],
KinesisVideoStreamConfigurationUpdateTypeDef#
# KinesisVideoStreamConfigurationUpdateTypeDef definition
class KinesisVideoStreamConfigurationUpdateTypeDef(TypedDict):
DataRetentionInHours: NotRequired[int],
KinesisVideoStreamPoolSummaryTypeDef#
# KinesisVideoStreamPoolSummaryTypeDef definition
class KinesisVideoStreamPoolSummaryTypeDef(TypedDict):
PoolName: NotRequired[str],
PoolId: NotRequired[str],
PoolArn: NotRequired[str],
RecordingStreamConfigurationTypeDef#
# RecordingStreamConfigurationTypeDef definition
class RecordingStreamConfigurationTypeDef(TypedDict):
StreamArn: NotRequired[str],
KinesisVideoStreamSourceTaskConfigurationTypeDef#
# KinesisVideoStreamSourceTaskConfigurationTypeDef definition
class KinesisVideoStreamSourceTaskConfigurationTypeDef(TypedDict):
StreamArn: str,
ChannelId: int,
FragmentNumber: NotRequired[str],
LambdaFunctionSinkConfigurationTypeDef#
# LambdaFunctionSinkConfigurationTypeDef definition
class LambdaFunctionSinkConfigurationTypeDef(TypedDict):
InsightsTarget: NotRequired[str],
ListMediaCapturePipelinesRequestRequestTypeDef#
# ListMediaCapturePipelinesRequestRequestTypeDef definition
class ListMediaCapturePipelinesRequestRequestTypeDef(TypedDict):
NextToken: NotRequired[str],
MaxResults: NotRequired[int],
MediaCapturePipelineSummaryTypeDef#
# MediaCapturePipelineSummaryTypeDef definition
class MediaCapturePipelineSummaryTypeDef(TypedDict):
MediaPipelineId: NotRequired[str],
MediaPipelineArn: NotRequired[str],
ListMediaInsightsPipelineConfigurationsRequestRequestTypeDef#
# ListMediaInsightsPipelineConfigurationsRequestRequestTypeDef definition
class ListMediaInsightsPipelineConfigurationsRequestRequestTypeDef(TypedDict):
NextToken: NotRequired[str],
MaxResults: NotRequired[int],
MediaInsightsPipelineConfigurationSummaryTypeDef#
# MediaInsightsPipelineConfigurationSummaryTypeDef definition
class MediaInsightsPipelineConfigurationSummaryTypeDef(TypedDict):
MediaInsightsPipelineConfigurationName: NotRequired[str],
MediaInsightsPipelineConfigurationId: NotRequired[str],
MediaInsightsPipelineConfigurationArn: NotRequired[str],
ListMediaPipelineKinesisVideoStreamPoolsRequestRequestTypeDef#
# ListMediaPipelineKinesisVideoStreamPoolsRequestRequestTypeDef definition
class ListMediaPipelineKinesisVideoStreamPoolsRequestRequestTypeDef(TypedDict):
NextToken: NotRequired[str],
MaxResults: NotRequired[int],
ListMediaPipelinesRequestRequestTypeDef#
# ListMediaPipelinesRequestRequestTypeDef definition
class ListMediaPipelinesRequestRequestTypeDef(TypedDict):
NextToken: NotRequired[str],
MaxResults: NotRequired[int],
MediaPipelineSummaryTypeDef#
# MediaPipelineSummaryTypeDef definition
class MediaPipelineSummaryTypeDef(TypedDict):
MediaPipelineId: NotRequired[str],
MediaPipelineArn: NotRequired[str],
ListTagsForResourceRequestRequestTypeDef#
# ListTagsForResourceRequestRequestTypeDef definition
class ListTagsForResourceRequestRequestTypeDef(TypedDict):
ResourceARN: str,
LiveConnectorRTMPConfigurationTypeDef#
# LiveConnectorRTMPConfigurationTypeDef definition
class LiveConnectorRTMPConfigurationTypeDef(TypedDict):
Url: str,
AudioChannels: NotRequired[AudioChannelsOptionType], # (1)
AudioSampleRate: NotRequired[str],
S3RecordingSinkConfigurationTypeDef#
# S3RecordingSinkConfigurationTypeDef definition
class S3RecordingSinkConfigurationTypeDef(TypedDict):
Destination: NotRequired[str],
RecordingFileFormat: NotRequired[RecordingFileFormatType], # (1)
SnsTopicSinkConfigurationTypeDef#
# SnsTopicSinkConfigurationTypeDef definition
class SnsTopicSinkConfigurationTypeDef(TypedDict):
InsightsTarget: NotRequired[str],
SqsQueueSinkConfigurationTypeDef#
# SqsQueueSinkConfigurationTypeDef definition
class SqsQueueSinkConfigurationTypeDef(TypedDict):
InsightsTarget: NotRequired[str],
VoiceAnalyticsProcessorConfigurationTypeDef#
# VoiceAnalyticsProcessorConfigurationTypeDef definition
class VoiceAnalyticsProcessorConfigurationTypeDef(TypedDict):
SpeakerSearchStatus: NotRequired[VoiceAnalyticsConfigurationStatusType], # (1)
VoiceToneAnalysisStatus: NotRequired[VoiceAnalyticsConfigurationStatusType], # (1)
VoiceEnhancementSinkConfigurationTypeDef#
# VoiceEnhancementSinkConfigurationTypeDef definition
class VoiceEnhancementSinkConfigurationTypeDef(TypedDict):
Disabled: NotRequired[bool],
MediaInsightsPipelineElementStatusTypeDef#
# MediaInsightsPipelineElementStatusTypeDef definition
class MediaInsightsPipelineElementStatusTypeDef(TypedDict):
Type: NotRequired[MediaInsightsPipelineConfigurationElementTypeType], # (1)
Status: NotRequired[MediaPipelineElementStatusType], # (2)
SentimentConfigurationTypeDef#
# SentimentConfigurationTypeDef definition
class SentimentConfigurationTypeDef(TypedDict):
RuleName: str,
SentimentType: SentimentTypeType, # (1)
TimePeriod: int,
SelectedVideoStreamsTypeDef#
# SelectedVideoStreamsTypeDef definition
class SelectedVideoStreamsTypeDef(TypedDict):
AttendeeIds: NotRequired[Sequence[str]],
ExternalUserIds: NotRequired[Sequence[str]],
StopSpeakerSearchTaskRequestRequestTypeDef#
# StopSpeakerSearchTaskRequestRequestTypeDef definition
class StopSpeakerSearchTaskRequestRequestTypeDef(TypedDict):
Identifier: str,
SpeakerSearchTaskId: str,
StopVoiceToneAnalysisTaskRequestRequestTypeDef#
# StopVoiceToneAnalysisTaskRequestRequestTypeDef definition
class StopVoiceToneAnalysisTaskRequestRequestTypeDef(TypedDict):
Identifier: str,
VoiceToneAnalysisTaskId: str,
UntagResourceRequestRequestTypeDef#
# UntagResourceRequestRequestTypeDef definition
class UntagResourceRequestRequestTypeDef(TypedDict):
ResourceARN: str,
TagKeys: Sequence[str],
UpdateMediaInsightsPipelineStatusRequestRequestTypeDef#
# UpdateMediaInsightsPipelineStatusRequestRequestTypeDef definition
class UpdateMediaInsightsPipelineStatusRequestRequestTypeDef(TypedDict):
Identifier: str,
UpdateStatus: MediaPipelineStatusUpdateType, # (1)
AmazonTranscribeCallAnalyticsProcessorConfigurationTypeDef#
# AmazonTranscribeCallAnalyticsProcessorConfigurationTypeDef definition
class AmazonTranscribeCallAnalyticsProcessorConfigurationTypeDef(TypedDict):
LanguageCode: CallAnalyticsLanguageCodeType, # (1)
VocabularyName: NotRequired[str],
VocabularyFilterName: NotRequired[str],
VocabularyFilterMethod: NotRequired[VocabularyFilterMethodType], # (2)
LanguageModelName: NotRequired[str],
EnablePartialResultsStabilization: NotRequired[bool],
PartialResultsStability: NotRequired[PartialResultsStabilityType], # (3)
ContentIdentificationType: NotRequired[ContentTypeType], # (4)
ContentRedactionType: NotRequired[ContentTypeType], # (4)
PiiEntityTypes: NotRequired[str],
FilterPartialResults: NotRequired[bool],
PostCallAnalyticsSettings: NotRequired[PostCallAnalyticsSettingsTypeDef], # (6)
CallAnalyticsStreamCategories: NotRequired[Sequence[str]],
- See CallAnalyticsLanguageCodeType
- See VocabularyFilterMethodType
- See PartialResultsStabilityType
- See ContentTypeType
- See ContentTypeType
- See PostCallAnalyticsSettingsTypeDef
ArtifactsConcatenationConfigurationTypeDef#
# ArtifactsConcatenationConfigurationTypeDef definition
class ArtifactsConcatenationConfigurationTypeDef(TypedDict):
Audio: AudioConcatenationConfigurationTypeDef, # (1)
Video: VideoConcatenationConfigurationTypeDef, # (2)
Content: ContentConcatenationConfigurationTypeDef, # (3)
DataChannel: DataChannelConcatenationConfigurationTypeDef, # (4)
TranscriptionMessages: TranscriptionMessagesConcatenationConfigurationTypeDef, # (5)
MeetingEvents: MeetingEventsConcatenationConfigurationTypeDef, # (6)
CompositedVideo: CompositedVideoConcatenationConfigurationTypeDef, # (7)
- See AudioConcatenationConfigurationTypeDef
- See VideoConcatenationConfigurationTypeDef
- See ContentConcatenationConfigurationTypeDef
- See DataChannelConcatenationConfigurationTypeDef
- See TranscriptionMessagesConcatenationConfigurationTypeDef
- See MeetingEventsConcatenationConfigurationTypeDef
- See CompositedVideoConcatenationConfigurationTypeDef
StreamChannelDefinitionTypeDef#
# StreamChannelDefinitionTypeDef definition
class StreamChannelDefinitionTypeDef(TypedDict):
NumberOfChannels: int,
ChannelDefinitions: NotRequired[Sequence[ChannelDefinitionTypeDef]], # (1)
ConcatenationSinkTypeDef#
# ConcatenationSinkTypeDef definition
class ConcatenationSinkTypeDef(TypedDict):
Type: ConcatenationSinkTypeType, # (1)
S3BucketSinkConfiguration: S3BucketSinkConfigurationTypeDef, # (2)
TagResourceRequestRequestTypeDef#
# TagResourceRequestRequestTypeDef definition
class TagResourceRequestRequestTypeDef(TypedDict):
ResourceARN: str,
Tags: Sequence[TagTypeDef], # (1)
- See TagTypeDef
EmptyResponseMetadataTypeDef#
# EmptyResponseMetadataTypeDef definition
class EmptyResponseMetadataTypeDef(TypedDict):
ResponseMetadata: ResponseMetadataTypeDef, # (1)