Skip to content

Type definitions#

Index > MediaTailor > Type definitions

Auto-generated documentation for MediaTailor type annotations stubs module mypy-boto3-mediatailor.

TimestampTypeDef#

# TimestampTypeDef definition

TimestampTypeDef = Union[
    datetime,
    str,
]

SecretsManagerAccessTokenConfigurationTypeDef#

# SecretsManagerAccessTokenConfigurationTypeDef definition

class SecretsManagerAccessTokenConfigurationTypeDef(TypedDict):
    HeaderName: NotRequired[str],
    SecretArn: NotRequired[str],
    SecretStringKey: NotRequired[str],

AdBreakOpportunityTypeDef#

# AdBreakOpportunityTypeDef definition

class AdBreakOpportunityTypeDef(TypedDict):
    OffsetMillis: int,

KeyValuePairTypeDef#

# KeyValuePairTypeDef definition

class KeyValuePairTypeDef(TypedDict):
    Key: str,
    Value: str,

SlateSourceTypeDef#

# SlateSourceTypeDef definition

class SlateSourceTypeDef(TypedDict):
    SourceLocationName: NotRequired[str],
    VodSourceName: NotRequired[str],

SpliceInsertMessageTypeDef#

# SpliceInsertMessageTypeDef definition

class SpliceInsertMessageTypeDef(TypedDict):
    AvailNum: NotRequired[int],
    AvailsExpected: NotRequired[int],
    SpliceEventId: NotRequired[int],
    UniqueProgramId: NotRequired[int],

AdMarkerPassthroughTypeDef#

# AdMarkerPassthroughTypeDef definition

class AdMarkerPassthroughTypeDef(TypedDict):
    Enabled: NotRequired[bool],

AlertTypeDef#

# AlertTypeDef definition

class AlertTypeDef(TypedDict):
    AlertCode: str,
    AlertMessage: str,
    LastModifiedTime: datetime,
    RelatedResourceArns: List[str],
    ResourceArn: str,
    Category: NotRequired[AlertCategoryType],  # (1)
  1. See AlertCategoryType

AvailMatchingCriteriaTypeDef#

# AvailMatchingCriteriaTypeDef definition

class AvailMatchingCriteriaTypeDef(TypedDict):
    DynamicVariable: str,
    Operator: OperatorType,  # (1)
  1. See OperatorType

AvailSuppressionTypeDef#

# AvailSuppressionTypeDef definition

class AvailSuppressionTypeDef(TypedDict):
    FillPolicy: NotRequired[FillPolicyType],  # (1)
    Mode: NotRequired[ModeType],  # (2)
    Value: NotRequired[str],
  1. See FillPolicyType
  2. See ModeType

BumperTypeDef#

# BumperTypeDef definition

class BumperTypeDef(TypedDict):
    EndUrl: NotRequired[str],
    StartUrl: NotRequired[str],

CdnConfigurationTypeDef#

# CdnConfigurationTypeDef definition

class CdnConfigurationTypeDef(TypedDict):
    AdSegmentUrlPrefix: NotRequired[str],
    ContentSegmentUrlPrefix: NotRequired[str],

LogConfigurationForChannelTypeDef#

# LogConfigurationForChannelTypeDef definition

class LogConfigurationForChannelTypeDef(TypedDict):
    LogTypes: NotRequired[List[LogTypeType]],  # (1)
  1. See LogTypeType

ClipRangeTypeDef#

# ClipRangeTypeDef definition

class ClipRangeTypeDef(TypedDict):
    EndOffsetMillis: int,

ConfigureLogsForChannelRequestRequestTypeDef#

# ConfigureLogsForChannelRequestRequestTypeDef definition

class ConfigureLogsForChannelRequestRequestTypeDef(TypedDict):
    ChannelName: str,
    LogTypes: Sequence[LogTypeType],  # (1)
  1. See LogTypeType

ResponseMetadataTypeDef#

# ResponseMetadataTypeDef definition

class ResponseMetadataTypeDef(TypedDict):
    RequestId: str,
    HostId: str,
    HTTPStatusCode: int,
    HTTPHeaders: Dict[str, str],
    RetryAttempts: int,

ConfigureLogsForPlaybackConfigurationRequestRequestTypeDef#

# ConfigureLogsForPlaybackConfigurationRequestRequestTypeDef definition

class ConfigureLogsForPlaybackConfigurationRequestRequestTypeDef(TypedDict):
    PercentEnabled: int,
    PlaybackConfigurationName: str,

HttpPackageConfigurationTypeDef#

# HttpPackageConfigurationTypeDef definition

class HttpPackageConfigurationTypeDef(TypedDict):
    Path: str,
    SourceGroup: str,
    Type: TypeType,  # (1)
  1. See TypeType

DefaultSegmentDeliveryConfigurationTypeDef#

# DefaultSegmentDeliveryConfigurationTypeDef definition

class DefaultSegmentDeliveryConfigurationTypeDef(TypedDict):
    BaseUrl: NotRequired[str],

HttpConfigurationTypeDef#

# HttpConfigurationTypeDef definition

class HttpConfigurationTypeDef(TypedDict):
    BaseUrl: str,

SegmentDeliveryConfigurationTypeDef#

# SegmentDeliveryConfigurationTypeDef definition

class SegmentDeliveryConfigurationTypeDef(TypedDict):
    BaseUrl: NotRequired[str],
    Name: NotRequired[str],

DashConfigurationForPutTypeDef#

# DashConfigurationForPutTypeDef definition

class DashConfigurationForPutTypeDef(TypedDict):
    MpdLocation: NotRequired[str],
    OriginManifestType: NotRequired[OriginManifestTypeType],  # (1)
  1. See OriginManifestTypeType

DashConfigurationTypeDef#

# DashConfigurationTypeDef definition

class DashConfigurationTypeDef(TypedDict):
    ManifestEndpointPrefix: NotRequired[str],
    MpdLocation: NotRequired[str],
    OriginManifestType: NotRequired[OriginManifestTypeType],  # (1)
  1. See OriginManifestTypeType

DashPlaylistSettingsTypeDef#

# DashPlaylistSettingsTypeDef definition

class DashPlaylistSettingsTypeDef(TypedDict):
    ManifestWindowSeconds: NotRequired[int],
    MinBufferTimeSeconds: NotRequired[int],
    MinUpdatePeriodSeconds: NotRequired[int],
    SuggestedPresentationDelaySeconds: NotRequired[int],

DeleteChannelPolicyRequestRequestTypeDef#

# DeleteChannelPolicyRequestRequestTypeDef definition

class DeleteChannelPolicyRequestRequestTypeDef(TypedDict):
    ChannelName: str,

DeleteChannelRequestRequestTypeDef#

# DeleteChannelRequestRequestTypeDef definition

class DeleteChannelRequestRequestTypeDef(TypedDict):
    ChannelName: str,

DeleteLiveSourceRequestRequestTypeDef#

# DeleteLiveSourceRequestRequestTypeDef definition

class DeleteLiveSourceRequestRequestTypeDef(TypedDict):
    LiveSourceName: str,
    SourceLocationName: str,

DeletePlaybackConfigurationRequestRequestTypeDef#

# DeletePlaybackConfigurationRequestRequestTypeDef definition

class DeletePlaybackConfigurationRequestRequestTypeDef(TypedDict):
    Name: str,

DeletePrefetchScheduleRequestRequestTypeDef#

# DeletePrefetchScheduleRequestRequestTypeDef definition

class DeletePrefetchScheduleRequestRequestTypeDef(TypedDict):
    Name: str,
    PlaybackConfigurationName: str,

DeleteProgramRequestRequestTypeDef#

# DeleteProgramRequestRequestTypeDef definition

class DeleteProgramRequestRequestTypeDef(TypedDict):
    ChannelName: str,
    ProgramName: str,

DeleteSourceLocationRequestRequestTypeDef#

# DeleteSourceLocationRequestRequestTypeDef definition

class DeleteSourceLocationRequestRequestTypeDef(TypedDict):
    SourceLocationName: str,

DeleteVodSourceRequestRequestTypeDef#

# DeleteVodSourceRequestRequestTypeDef definition

class DeleteVodSourceRequestRequestTypeDef(TypedDict):
    SourceLocationName: str,
    VodSourceName: str,

DescribeChannelRequestRequestTypeDef#

# DescribeChannelRequestRequestTypeDef definition

class DescribeChannelRequestRequestTypeDef(TypedDict):
    ChannelName: str,

DescribeLiveSourceRequestRequestTypeDef#

# DescribeLiveSourceRequestRequestTypeDef definition

class DescribeLiveSourceRequestRequestTypeDef(TypedDict):
    LiveSourceName: str,
    SourceLocationName: str,

DescribeProgramRequestRequestTypeDef#

# DescribeProgramRequestRequestTypeDef definition

class DescribeProgramRequestRequestTypeDef(TypedDict):
    ChannelName: str,
    ProgramName: str,

DescribeSourceLocationRequestRequestTypeDef#

# DescribeSourceLocationRequestRequestTypeDef definition

class DescribeSourceLocationRequestRequestTypeDef(TypedDict):
    SourceLocationName: str,

DescribeVodSourceRequestRequestTypeDef#

# DescribeVodSourceRequestRequestTypeDef definition

class DescribeVodSourceRequestRequestTypeDef(TypedDict):
    SourceLocationName: str,
    VodSourceName: str,

GetChannelPolicyRequestRequestTypeDef#

# GetChannelPolicyRequestRequestTypeDef definition

class GetChannelPolicyRequestRequestTypeDef(TypedDict):
    ChannelName: str,

PaginatorConfigTypeDef#

# PaginatorConfigTypeDef definition

class PaginatorConfigTypeDef(TypedDict):
    MaxItems: NotRequired[int],
    PageSize: NotRequired[int],
    StartingToken: NotRequired[str],

GetChannelScheduleRequestRequestTypeDef#

# GetChannelScheduleRequestRequestTypeDef definition

class GetChannelScheduleRequestRequestTypeDef(TypedDict):
    ChannelName: str,
    DurationMinutes: NotRequired[str],
    MaxResults: NotRequired[int],
    NextToken: NotRequired[str],

GetPlaybackConfigurationRequestRequestTypeDef#

# GetPlaybackConfigurationRequestRequestTypeDef definition

class GetPlaybackConfigurationRequestRequestTypeDef(TypedDict):
    Name: str,

HlsConfigurationTypeDef#

# HlsConfigurationTypeDef definition

class HlsConfigurationTypeDef(TypedDict):
    ManifestEndpointPrefix: NotRequired[str],

LivePreRollConfigurationTypeDef#

# LivePreRollConfigurationTypeDef definition

class LivePreRollConfigurationTypeDef(TypedDict):
    AdDecisionServerUrl: NotRequired[str],
    MaxDurationSeconds: NotRequired[int],

LogConfigurationTypeDef#

# LogConfigurationTypeDef definition

class LogConfigurationTypeDef(TypedDict):
    PercentEnabled: int,

GetPrefetchScheduleRequestRequestTypeDef#

# GetPrefetchScheduleRequestRequestTypeDef definition

class GetPrefetchScheduleRequestRequestTypeDef(TypedDict):
    Name: str,
    PlaybackConfigurationName: str,

HlsPlaylistSettingsPaginatorTypeDef#

# HlsPlaylistSettingsPaginatorTypeDef definition

class HlsPlaylistSettingsPaginatorTypeDef(TypedDict):
    AdMarkupType: NotRequired[List[AdMarkupTypeType]],  # (1)
    ManifestWindowSeconds: NotRequired[int],
  1. See AdMarkupTypeType

HlsPlaylistSettingsTypeDef#

# HlsPlaylistSettingsTypeDef definition

class HlsPlaylistSettingsTypeDef(TypedDict):
    AdMarkupType: NotRequired[Sequence[AdMarkupTypeType]],  # (1)
    ManifestWindowSeconds: NotRequired[int],
  1. See AdMarkupTypeType

ListAlertsRequestRequestTypeDef#

# ListAlertsRequestRequestTypeDef definition

class ListAlertsRequestRequestTypeDef(TypedDict):
    ResourceArn: str,
    MaxResults: NotRequired[int],
    NextToken: NotRequired[str],

ListChannelsRequestRequestTypeDef#

# ListChannelsRequestRequestTypeDef definition

class ListChannelsRequestRequestTypeDef(TypedDict):
    MaxResults: NotRequired[int],
    NextToken: NotRequired[str],

ListLiveSourcesRequestRequestTypeDef#

# ListLiveSourcesRequestRequestTypeDef definition

class ListLiveSourcesRequestRequestTypeDef(TypedDict):
    SourceLocationName: str,
    MaxResults: NotRequired[int],
    NextToken: NotRequired[str],

ListPlaybackConfigurationsRequestRequestTypeDef#

# ListPlaybackConfigurationsRequestRequestTypeDef definition

class ListPlaybackConfigurationsRequestRequestTypeDef(TypedDict):
    MaxResults: NotRequired[int],
    NextToken: NotRequired[str],

ListPrefetchSchedulesRequestRequestTypeDef#

# ListPrefetchSchedulesRequestRequestTypeDef definition

class ListPrefetchSchedulesRequestRequestTypeDef(TypedDict):
    PlaybackConfigurationName: str,
    MaxResults: NotRequired[int],
    NextToken: NotRequired[str],
    StreamId: NotRequired[str],

ListSourceLocationsRequestRequestTypeDef#

# ListSourceLocationsRequestRequestTypeDef definition

class ListSourceLocationsRequestRequestTypeDef(TypedDict):
    MaxResults: NotRequired[int],
    NextToken: NotRequired[str],

ListTagsForResourceRequestRequestTypeDef#

# ListTagsForResourceRequestRequestTypeDef definition

class ListTagsForResourceRequestRequestTypeDef(TypedDict):
    ResourceArn: str,

ListVodSourcesRequestRequestTypeDef#

# ListVodSourcesRequestRequestTypeDef definition

class ListVodSourcesRequestRequestTypeDef(TypedDict):
    SourceLocationName: str,
    MaxResults: NotRequired[int],
    NextToken: NotRequired[str],

PrefetchRetrievalPaginatorTypeDef#

# PrefetchRetrievalPaginatorTypeDef definition

class PrefetchRetrievalPaginatorTypeDef(TypedDict):
    EndTime: datetime,
    DynamicVariables: NotRequired[Dict[str, str]],
    StartTime: NotRequired[datetime],

PutChannelPolicyRequestRequestTypeDef#

# PutChannelPolicyRequestRequestTypeDef definition

class PutChannelPolicyRequestRequestTypeDef(TypedDict):
    ChannelName: str,
    Policy: str,

ScheduleAdBreakTypeDef#

# ScheduleAdBreakTypeDef definition

class ScheduleAdBreakTypeDef(TypedDict):
    ApproximateDurationSeconds: NotRequired[int],
    ApproximateStartTime: NotRequired[datetime],
    SourceLocationName: NotRequired[str],
    VodSourceName: NotRequired[str],

TransitionTypeDef#

# TransitionTypeDef definition

class TransitionTypeDef(TypedDict):
    RelativePosition: RelativePositionType,  # (1)
    Type: str,
    DurationMillis: NotRequired[int],
    RelativeProgram: NotRequired[str],
    ScheduledStartTimeMillis: NotRequired[int],
  1. See RelativePositionType

SegmentationDescriptorTypeDef#

# SegmentationDescriptorTypeDef definition

class SegmentationDescriptorTypeDef(TypedDict):
    SegmentNum: NotRequired[int],
    SegmentationEventId: NotRequired[int],
    SegmentationTypeId: NotRequired[int],
    SegmentationUpid: NotRequired[str],
    SegmentationUpidType: NotRequired[int],
    SegmentsExpected: NotRequired[int],
    SubSegmentNum: NotRequired[int],
    SubSegmentsExpected: NotRequired[int],

StartChannelRequestRequestTypeDef#

# StartChannelRequestRequestTypeDef definition

class StartChannelRequestRequestTypeDef(TypedDict):
    ChannelName: str,

StopChannelRequestRequestTypeDef#

# StopChannelRequestRequestTypeDef definition

class StopChannelRequestRequestTypeDef(TypedDict):
    ChannelName: str,

TagResourceRequestRequestTypeDef#

# TagResourceRequestRequestTypeDef definition

class TagResourceRequestRequestTypeDef(TypedDict):
    ResourceArn: str,
    Tags: Mapping[str, str],

UntagResourceRequestRequestTypeDef#

# UntagResourceRequestRequestTypeDef definition

class UntagResourceRequestRequestTypeDef(TypedDict):
    ResourceArn: str,
    TagKeys: Sequence[str],

UpdateProgramTransitionTypeDef#

# UpdateProgramTransitionTypeDef definition

class UpdateProgramTransitionTypeDef(TypedDict):
    DurationMillis: NotRequired[int],
    ScheduledStartTimeMillis: NotRequired[int],

AccessConfigurationTypeDef#

# AccessConfigurationTypeDef definition

class AccessConfigurationTypeDef(TypedDict):
    AccessType: NotRequired[AccessTypeType],  # (1)
    SecretsManagerAccessTokenConfiguration: NotRequired[SecretsManagerAccessTokenConfigurationTypeDef],  # (2)
  1. See AccessTypeType
  2. See SecretsManagerAccessTokenConfigurationTypeDef

ManifestProcessingRulesTypeDef#

# ManifestProcessingRulesTypeDef definition

class ManifestProcessingRulesTypeDef(TypedDict):
    AdMarkerPassthrough: NotRequired[AdMarkerPassthroughTypeDef],  # (1)
  1. See AdMarkerPassthroughTypeDef

PrefetchConsumptionPaginatorTypeDef#

# PrefetchConsumptionPaginatorTypeDef definition

class PrefetchConsumptionPaginatorTypeDef(TypedDict):
    EndTime: datetime,
    AvailMatchingCriteria: NotRequired[List[AvailMatchingCriteriaTypeDef]],  # (1)
    StartTime: NotRequired[datetime],
  1. See AvailMatchingCriteriaTypeDef

ConfigureLogsForChannelResponseTypeDef#

# ConfigureLogsForChannelResponseTypeDef definition

class ConfigureLogsForChannelResponseTypeDef(TypedDict):
    ChannelName: str,
    LogTypes: List[LogTypeType],  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See LogTypeType
  2. See ResponseMetadataTypeDef

ConfigureLogsForPlaybackConfigurationResponseTypeDef#

# ConfigureLogsForPlaybackConfigurationResponseTypeDef definition

class ConfigureLogsForPlaybackConfigurationResponseTypeDef(TypedDict):
    PercentEnabled: int,
    PlaybackConfigurationName: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
  1. See