Skip to content

MediaTailorClient#

Index > MediaTailor > MediaTailorClient

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

MediaTailorClient#

Type annotations and code completion for boto3.client("mediatailor"). boto3 documentation

# MediaTailorClient usage example

from boto3.session import Session
from mypy_boto3_mediatailor.client import MediaTailorClient

def get_mediatailor_client() -> MediaTailorClient:
    return Session().client("mediatailor")

Exceptions#

boto3 client exceptions are generated in runtime. This class provides code completion for boto3.client("mediatailor").exceptions structure.

# Exceptions.exceptions usage example

client = boto3.client("mediatailor")

try:
    do_something(client)
except (
    client.exceptions.BadRequestException,
    client.exceptions.ClientError,
) as e:
    print(e)
# Exceptions.exceptions type checking example

from mypy_boto3_mediatailor.client import Exceptions

def handle_error(exc: Exceptions.BadRequestException) -> None:
    ...

Methods#

can_paginate#

Check if an operation can be paginated.

Type annotations and code completion for boto3.client("mediatailor").can_paginate method. boto3 documentation

# can_paginate method definition

def can_paginate(
    self,
    operation_name: str,
) -> bool:
    ...

close#

Closes underlying endpoint connections.

Type annotations and code completion for boto3.client("mediatailor").close method. boto3 documentation

# close method definition

def close(
    self,
) -> None:
    ...

configure_logs_for_channel#

Configures Amazon CloudWatch log settings for a channel.

Type annotations and code completion for boto3.client("mediatailor").configure_logs_for_channel method. boto3 documentation

# configure_logs_for_channel method definition

def configure_logs_for_channel(
    self,
    *,
    ChannelName: str,
    LogTypes: Sequence[LogTypeType],  # (1)
) -> ConfigureLogsForChannelResponseTypeDef:  # (2)
    ...
  1. See LogTypeType
  2. See ConfigureLogsForChannelResponseTypeDef 
# configure_logs_for_channel method usage example with argument unpacking

kwargs: ConfigureLogsForChannelRequestRequestTypeDef = {  # (1)
    "ChannelName": ...,
    "LogTypes": ...,
}

parent.configure_logs_for_channel(**kwargs)
  1. See ConfigureLogsForChannelRequestRequestTypeDef

configure_logs_for_playback_configuration#

Amazon CloudWatch log settings for a playback configuration.

Type annotations and code completion for boto3.client("mediatailor").configure_logs_for_playback_configuration method. boto3 documentation

# configure_logs_for_playback_configuration method definition

def configure_logs_for_playback_configuration(
    self,
    *,
    PercentEnabled: int,
    PlaybackConfigurationName: str,
) -> ConfigureLogsForPlaybackConfigurationResponseTypeDef:  # (1)
    ...
  1. See ConfigureLogsForPlaybackConfigurationResponseTypeDef 
# configure_logs_for_playback_configuration method usage example with argument unpacking

kwargs: ConfigureLogsForPlaybackConfigurationRequestRequestTypeDef = {  # (1)
    "PercentEnabled": ...,
    "PlaybackConfigurationName": ...,
}

parent.configure_logs_for_playback_configuration(**kwargs)
  1. See ConfigureLogsForPlaybackConfigurationRequestRequestTypeDef

create_channel#

Creates a channel.

Type annotations and code completion for boto3.client("mediatailor").create_channel method. boto3 documentation

# create_channel method definition

def create_channel(
    self,
    *,
    ChannelName: str,
    Outputs: Sequence[RequestOutputItemTypeDef],  # (1)
    PlaybackMode: PlaybackModeType,  # (2)
    FillerSlate: SlateSourceTypeDef = ...,  # (3)
    Tags: Mapping[str, str] = ...,
    Tier: TierType = ...,  # (4)
) -> CreateChannelResponseTypeDef:  # (5)
    ...
  1. See RequestOutputItemTypeDef
  2. See PlaybackModeType
  3. See SlateSourceTypeDef
  4. See TierType
  5. See CreateChannelResponseTypeDef 
# create_channel method usage example with argument unpacking

kwargs: CreateChannelRequestRequestTypeDef = {  # (1)
    "ChannelName": ...,
    "Outputs": ...,
    "PlaybackMode": ...,
}

parent.create_channel(**kwargs)
  1. See CreateChannelRequestRequestTypeDef

create_live_source#

The live source configuration.

Type annotations and code completion for boto3.client("mediatailor").create_live_source method. boto3 documentation

# create_live_source method definition

def create_live_source(
    self,
    *,
    HttpPackageConfigurations: Sequence[HttpPackageConfigurationTypeDef],  # (1)
    LiveSourceName: str,
    SourceLocationName: str,
    Tags: Mapping[str, str] = ...,
) -> CreateLiveSourceResponseTypeDef:  # (2)
    ...
  1. See HttpPackageConfigurationTypeDef
  2. See CreateLiveSourceResponseTypeDef 
# create_live_source method usage example with argument unpacking

kwargs: CreateLiveSourceRequestRequestTypeDef = {  # (1)
    "HttpPackageConfigurations": ...,
    "LiveSourceName": ...,
    "SourceLocationName": ...,
}

parent.create_live_source(**kwargs)
  1. See CreateLiveSourceRequestRequestTypeDef

create_prefetch_schedule#

Creates a prefetch schedule for a playback configuration.

Type annotations and code completion for boto3.client("mediatailor").create_prefetch_schedule method. boto3 documentation

# create_prefetch_schedule method definition

def create_prefetch_schedule(
    self,
    *,
    Consumption: PrefetchConsumptionTypeDef,  # (1)
    Name: str,
    PlaybackConfigurationName: str,
    Retrieval: PrefetchRetrievalTypeDef,  # (2)
    StreamId: str = ...,
) -> CreatePrefetchScheduleResponseTypeDef:  # (3)
    ...
  1. See PrefetchConsumptionTypeDef
  2. See PrefetchRetrievalTypeDef
  3. See CreatePrefetchScheduleResponseTypeDef 
# create_prefetch_schedule method usage example with argument unpacking

kwargs: CreatePrefetchScheduleRequestRequestTypeDef = {  # (1)
    "Consumption": ...,
    "Name": ...,
    "PlaybackConfigurationName": ...,
    "Retrieval": ...,
}

parent.create_prefetch_schedule(**kwargs)
  1. See CreatePrefetchScheduleRequestRequestTypeDef

create_program#

Creates a program within a channel.

Type annotations and code completion for boto3.client("mediatailor").create_program method. boto3 documentation

# create_program method definition

def create_program(
    self,
    *,
    ChannelName: str,
    ProgramName: str,
    ScheduleConfiguration: ScheduleConfigurationTypeDef,  # (1)
    SourceLocationName: str,
    AdBreaks: Sequence[AdBreakTypeDef] = ...,  # (2)
    LiveSourceName: str = ...,
    VodSourceName: str = ...,
) -> CreateProgramResponseTypeDef:  # (3)
    ...
  1. See ScheduleConfigurationTypeDef
  2. See AdBreakTypeDef
  3. See CreateProgramResponseTypeDef 
# create_program method usage example with argument unpacking

kwargs: CreateProgramRequestRequestTypeDef = {  # (1)
    "ChannelName": ...,
    "ProgramName": ...,
    "ScheduleConfiguration": ...,
    "SourceLocationName": ...,
}

parent.create_program(**kwargs)
  1. See CreateProgramRequestRequestTypeDef

create_source_location#

Creates a source location.

Type annotations and code completion for boto3.client("mediatailor").create_source_location method. boto3 documentation

# create_source_location method definition

def create_source_location(
    self,
    *,
    HttpConfiguration: HttpConfigurationTypeDef,  # (1)
    SourceLocationName: str,
    AccessConfiguration: AccessConfigurationTypeDef = ...,  # (2)
    DefaultSegmentDeliveryConfiguration: DefaultSegmentDeliveryConfigurationTypeDef = ...,  # (3)
    SegmentDeliveryConfigurations: Sequence[SegmentDeliveryConfigurationTypeDef] = ...,  # (4)
    Tags: Mapping[str, str] = ...,
) -> CreateSourceLocationResponseTypeDef:  # (5)
    ...
  1. See HttpConfigurationTypeDef
  2. See AccessConfigurationTypeDef
  3. See DefaultSegmentDeliveryConfigurationTypeDef
  4. See SegmentDeliveryConfigurationTypeDef
  5. See CreateSourceLocationResponseTypeDef 
# create_source_location method usage example with argument unpacking

kwargs: CreateSourceLocationRequestRequestTypeDef = {  # (1)
    "HttpConfiguration": ...,
    "SourceLocationName": ...,
}

parent.create_source_location(**kwargs)
  1. See CreateSourceLocationRequestRequestTypeDef

create_vod_source#

The VOD source configuration parameters.

Type annotations and code completion for boto3.client("mediatailor").create_vod_source method. boto3 documentation

# create_vod_source method definition

def create_vod_source(
    self,
    *,
    HttpPackageConfigurations: Sequence[HttpPackageConfigurationTypeDef],  # (1)
    SourceLocationName: str,
    VodSourceName: str,
    Tags: Mapping[str, str] = ...,
) -> CreateVodSourceResponseTypeDef:  # (2)
    ...
  1. See HttpPackageConfigurationTypeDef
  2. See CreateVodSourceResponseTypeDef 
# create_vod_source method usage example with argument unpacking

kwargs: CreateVodSourceRequestRequestTypeDef = {  # (1)
    "HttpPackageConfigurations": ...,
    "SourceLocationName": ...,
    "VodSourceName": ...,
}

parent.create_vod_source(**kwargs)
  1. See CreateVodSourceRequestRequestTypeDef

delete_channel#

Deletes a channel.

Type annotations and code completion for boto3.client("mediatailor").delete_channel method. boto3 documentation

# delete_channel method definition

def delete_channel(
    self,
    *,
    ChannelName: str,
) -> Dict[str, Any]:
    ...
# delete_channel method usage example with argument unpacking

kwargs: DeleteChannelRequestRequestTypeDef = {  # (1)
    "ChannelName": ...,
}

parent.delete_channel(**kwargs)
  1. See DeleteChannelRequestRequestTypeDef

delete_channel_policy#

The channel policy to delete.

Type annotations and code completion for boto3.client("mediatailor").delete_channel_policy method. boto3 documentation

# delete_channel_policy method definition

def delete_channel_policy(
    self,
    *,
    ChannelName: str,
) -> Dict[str, Any]:
    ...
# delete_channel_policy method usage example with argument unpacking

kwargs: DeleteChannelPolicyRequestRequestTypeDef = {  # (1)
    "ChannelName": ...,
}

parent.delete_channel_policy(**kwargs)
  1. See DeleteChannelPolicyRequestRequestTypeDef

delete_live_source#

The live source to delete.

Type annotations and code completion for boto3.client("mediatailor").delete_live_source method. boto3 documentation

# delete_live_source method definition

def delete_live_source(
    self,
    *,
    LiveSourceName: str,
    SourceLocationName: str,
) -> Dict[str, Any]:
    ...
# delete_live_source method usage example with argument unpacking

kwargs: DeleteLiveSourceRequestRequestTypeDef = {  # (1)
    "LiveSourceName": ...,
    "SourceLocationName": ...,
}

parent.delete_live_source(**kwargs)
  1. See DeleteLiveSourceRequestRequestTypeDef

delete_playback_configuration#

Deletes a playback configuration.

Type annotations and code completion for boto3.client("mediatailor").delete_playback_configuration method. boto3 documentation

# delete_playback_configuration method definition

def delete_playback_configuration(
    self,
    *,
    Name: str,
) -> Dict[str, Any]:
    ...
# delete_playback_configuration method usage example with argument unpacking

kwargs: DeletePlaybackConfigurationRequestRequestTypeDef = {  # (1)
    "Name": ...,
}

parent.delete_playback_configuration(**kwargs)
  1. See DeletePlaybackConfigurationRequestRequestTypeDef

delete_prefetch_schedule#

Deletes a prefetch schedule for a specific playback configuration.

Type annotations and code completion for boto3.client("mediatailor").delete_prefetch_schedule method. boto3 documentation

# delete_prefetch_schedule method definition

def delete_prefetch_schedule(
    self,
    *,
    Name: str,
    PlaybackConfigurationName: str,
) -> Dict[str, Any]:
    ...
# delete_prefetch_schedule method usage example with argument unpacking

kwargs: DeletePrefetchScheduleRequestRequestTypeDef = {  # (1)
    "Name": ...,
    "PlaybackConfigurationName": ...,
}

parent.delete_prefetch_schedule(**kwargs)
  1. See DeletePrefetchScheduleRequestRequestTypeDef

delete_program#

Deletes a program within a channel.

Type annotations and code completion for boto3.client("mediatailor").delete_program method. boto3 documentation

# delete_program method definition

def delete_program(
    self,
    *,
    ChannelName: str,
    ProgramName: str,
) -> Dict[str, Any]:
    ...
# delete_program method usage example with argument unpacking

kwargs: DeleteProgramRequestRequestTypeDef = {  # (1)
    "ChannelName": ...,
    "ProgramName": ...,
}

parent.delete_program(**kwargs)
  1. See DeleteProgramRequestRequestTypeDef

delete_source_location#

Deletes a source location.

Type annotations and code completion for boto3.client("mediatailor").delete_source_location method. boto3 documentation

# delete_source_location method definition

def delete_source_location(
    self,
    *,
    SourceLocationName: str,
) -> Dict[str, Any]:
    ...
# delete_source_location method usage example with argument unpacking

kwargs: DeleteSourceLocationRequestRequestTypeDef = {  # (1)
    "SourceLocationName": ...,
}

parent.delete_source_location(**kwargs)
  1. See DeleteSourceLocationRequestRequestTypeDef

delete_vod_source#

The video on demand (VOD) source to delete.

Type annotations and code completion for boto3.client("mediatailor").delete_vod_source method. boto3 documentation

# delete_vod_source method definition

def delete_vod_source(
    self,
    *,
    SourceLocationName: str,
    VodSourceName: str,
) -> Dict[str, Any]:
    ...
# delete_vod_source method usage example with argument unpacking

kwargs: DeleteVodSourceRequestRequestTypeDef = {  # (1)
    "SourceLocationName": ...,
    "VodSourceName": ...,
}

parent.delete_vod_source(**kwargs)
  1. See DeleteVodSourceRequestRequestTypeDef

describe_channel#

Describes a channel.

Type annotations and code completion for boto3.client("mediatailor").describe_channel method. boto3 documentation

# describe_channel method definition

def describe_channel(
    self,
    *,
    ChannelName: str,
) -> DescribeChannelResponseTypeDef:  # (1)
    ...
  1. See DescribeChannelResponseTypeDef 
# describe_channel method usage example with argument unpacking

kwargs: DescribeChannelRequestRequestTypeDef = {  # (1)
    "ChannelName": ...,
}

parent.describe_channel(**kwargs)
  1. See DescribeChannelRequestRequestTypeDef

describe_live_source#

The live source to describe.

Type annotations and code completion for boto3.client("mediatailor").describe_live_source method.