MediaTailorClient

Index > MediaTailor > MediaTailorClient

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

MediaTailorClient

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

# MediaTailorClient usage example

from boto3.session import Session
from types_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 types_boto3_mediatailor.client import Exceptions

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

Methods

can_paginate

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:
    ...

generate_presigned_url

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

# generate_presigned_url method definition

def generate_presigned_url(
    self,
    ClientMethod: str,
    Params: Mapping[str, Any] = ...,
    ExpiresIn: int = 3600,
    HttpMethod: str = ...,
) -> str:
    ...

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 Sequence[Literal['AS_RUN']]
2. See ConfigureLogsForChannelResponseTypeDef

# configure_logs_for_channel method usage example with argument unpacking

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

parent.configure_logs_for_channel(**kwargs)

1. See ConfigureLogsForChannelRequestTypeDef

configure_logs_for_playback_configuration

Defines where AWS Elemental MediaTailor sends logs for the 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,
    EnabledLoggingStrategies: Sequence[LoggingStrategyType] = ...,  # (1)
    AdsInteractionLog: AdsInteractionLogUnionTypeDef = ...,  # (2)
    ManifestServiceInteractionLog: ManifestServiceInteractionLogUnionTypeDef = ...,  # (3)
) -> ConfigureLogsForPlaybackConfigurationResponseTypeDef:  # (4)
    ...

1. See Sequence[LoggingStrategyType]
2. See AdsInteractionLogUnionTypeDef
3. See ManifestServiceInteractionLogUnionTypeDef
4. See ConfigureLogsForPlaybackConfigurationResponseTypeDef

# configure_logs_for_playback_configuration method usage example with argument unpacking

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

parent.configure_logs_for_playback_configuration(**kwargs)

1. See ConfigureLogsForPlaybackConfigurationRequestTypeDef

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)
    TimeShiftConfiguration: TimeShiftConfigurationTypeDef = ...,  # (5)
    Audiences: Sequence[str] = ...,
) -> CreateChannelResponseTypeDef:  # (6)
    ...

1. See Sequence[RequestOutputItemTypeDef]
2. See PlaybackModeType
3. See SlateSourceTypeDef
4. See TierType
5. See TimeShiftConfigurationTypeDef
6. See CreateChannelResponseTypeDef

# create_channel method usage example with argument unpacking

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

parent.create_channel(**kwargs)

1. See CreateChannelRequestTypeDef

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 Sequence[HttpPackageConfigurationTypeDef]
2. See CreateLiveSourceResponseTypeDef

# create_live_source method usage example with argument unpacking

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

parent.create_live_source(**kwargs)

1. See CreateLiveSourceRequestTypeDef

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,
    *,
    Name: str,
    PlaybackConfigurationName: str,
    Consumption: PrefetchConsumptionUnionTypeDef = ...,  # (1)
    Retrieval: PrefetchRetrievalUnionTypeDef = ...,  # (2)
    RecurringPrefetchConfiguration: RecurringPrefetchConfigurationUnionTypeDef = ...,  # (3)
    ScheduleType: PrefetchScheduleTypeType = ...,  # (4)
    StreamId: str = ...,
    Tags: Mapping[str, str] = ...,
) -> CreatePrefetchScheduleResponseTypeDef:  # (5)
    ...

1. See PrefetchConsumptionUnionTypeDef
2. See PrefetchRetrievalUnionTypeDef
3. See RecurringPrefetchConfigurationUnionTypeDef
4. See PrefetchScheduleTypeType
5. See CreatePrefetchScheduleResponseTypeDef

# create_prefetch_schedule method usage example with argument unpacking

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

parent.create_prefetch_schedule(**kwargs)

1. See CreatePrefetchScheduleRequestTypeDef

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[AdBreakUnionTypeDef] = ...,  # (2)
    LiveSourceName: str = ...,
    VodSourceName: str = ...,
    AudienceMedia: Sequence[AudienceMediaUnionTypeDef] = ...,  # (3)
    Tags: Mapping[str, str] = ...,
) -> CreateProgramResponseTypeDef:  # (4)
    ...

1. See ScheduleConfigurationTypeDef
2. See Sequence[AdBreakUnionTypeDef]
3. See Sequence[AudienceMediaUnionTypeDef]
4. See CreateProgramResponseTypeDef

# create_program method usage example with argument unpacking

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

parent.create_program(**kwargs)

1. See CreateProgramRequestTypeDef

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 Sequence[SegmentDeliveryConfigurationTypeDef]
5. See CreateSourceLocationResponseTypeDef

# create_source_location method usage example with argument unpacking

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

parent.create_source_location(**kwargs)

1. See CreateSourceLocationRequestTypeDef

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 Sequence[HttpPackageConfigurationTypeDef]
2. See CreateVodSourceResponseTypeDef

# create_vod_source method usage example with argument unpacking

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

parent.create_vod_source(**kwargs)

1. See CreateVodSourceRequestTypeDef

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: DeleteChannelRequestTypeDef = {  # (1)
    "ChannelName": ...,
}

parent.delete_channel(**kwargs)

1. See DeleteChannelRequestTypeDef

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: DeleteChannelPolicyRequestTypeDef = {  # (1)
    "ChannelName": ...,
}

parent.delete_channel_policy(**kwargs)

1. See DeleteChannelPolicyRequestTypeDef

delete_function

Deletes a function.

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

# delete_function method definition

def delete_function(
    self,
    *,
    FunctionId: str,
) -> dict[str, Any]:
    ...

# delete_function method usage example with argument unpacking

kwargs: DeleteFunctionRequestTypeDef = {  # (1)
    "FunctionId": ...,
}

parent.delete_function(**kwargs)

1. See DeleteFunctionRequestTypeDef

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: DeleteLiveSourceRequestTypeDef = {  # (1)
    "LiveSourceName": ...,
    "SourceLocationName": ...,
}

parent.delete_live_source(**kwargs)

1. See DeleteLiveSourceRequestTypeDef

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: DeletePlaybackConfigurationRequestTypeDef = {  # (1)
    "Name": ...,
}

parent.delete_playback_configuration(**kwargs)

1. See DeletePlaybackConfigurationRequestTypeDef

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: DeletePrefetchScheduleRequestTypeDef = {  # (1)
    "Name": ...,
    "PlaybackConfigurationName": ...,
}

parent.delete_prefetch_schedule(**kwargs)

1. See DeletePrefetchScheduleRequestTypeDef

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: DeleteProgramRequestTypeDef = {  # (1)
    "ChannelName": ...,
    "ProgramName": ...,
}

parent.delete_program(**kwargs)

1. See DeleteProgramRequestTypeDef

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: DeleteSourceLocationRequestTypeDef = {  # (1)
    "SourceLocationName": ...,
}

parent.delete_source_location(**kwargs)

1. See DeleteSourceLocationRequestTypeDef

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: DeleteVodSourceRequestTypeDef = {  # (1)
    "SourceLocationName": ...,
    "VodSourceName": ...,
}

parent.delete_vod_source(**kwargs)

1. See DeleteVodSourceRequestTypeDef

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: DescribeChannelRequestTypeDef = {  # (1)
    "ChannelName": ...,
}

parent.describe_channel(**kwargs)

1. See DescribeChannelRequestTypeDef

describe_live_source

The live source to describe.

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

# describe_live_source method definition

def describe_live_source(
    self,
    *,
    LiveSourceName: str,
    SourceLocationName: str,
) -> DescribeLiveSourceResponseTypeDef:  # (1)
    ...

1. See DescribeLiveSourceResponseTypeDef

# describe_live_source method usage example with argument unpacking

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

parent.describe_live_source(**kwargs)

1. See DescribeLiveSourceRequestTypeDef

describe_program

Describes a program within a channel.

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

# describe_program method definition

def describe_program(
    self,
    *,
    ChannelName: str,
    ProgramName: str,
) -> DescribeProgramResponseTypeDef:  # (1)
    ...

1. See DescribeProgramResponseTypeDef

# describe_program method usage example with argument unpacking

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

parent.describe_program(**kwargs)

1. See DescribeProgramRequestTypeDef

describe_source_location

Describes a source location.

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

# describe_source_location method definition

def describe_source_location(
    self,
    *,
    SourceLocationName: str,
) -> DescribeSourceLocationResponseTypeDef:  # (1)
    ...

1. See DescribeSourceLocationResponseTypeDef

# describe_source_location method usage example with argument unpacking

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

parent.describe_source_location(**kwargs)

1. See DescribeSourceLocationRequestTypeDef

describe_vod_source

Provides details about a specific video on demand (VOD) source in a specific source location.

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

# describe_vod_source method definition

def describe_vod_source(
    self,
    *,
    SourceLocationName: str,
    VodSourceName: str,
) -> DescribeVodSourceResponseTypeDef:  # (1)
    ...

1. See DescribeVodSourceResponseTypeDef

# describe_vod_source method usage example with argument unpacking

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

parent.describe_vod_source(**kwargs)

1. See DescribeVodSourceRequestTypeDef

get_channel_policy

Returns the channel's IAM policy.

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

# get_channel_policy method definition

def get_channel_policy(
    self,
    *,
    ChannelName: str,
) -> GetChannelPolicyResponseTypeDef:  # (1)
    ...

1. See GetChannelPolicyResponseTypeDef

# get_channel_policy method usage example with argument unpacking

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

parent.get_channel_policy(**kwargs)

1. See GetChannelPolicyRequestTypeDef

get_channel_schedule

Retrieves information about your channel's schedule.

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

# get_channel_schedule method definition

def get_channel_schedule(
    self,
    *,
    ChannelName: str,
    DurationMinutes: str = ...,
    MaxResults: int = ...,
    NextToken: str = ...,
    Audience: str = ...,
) -> GetChannelScheduleResponseTypeDef:  # (1)
    ...

1. See GetChannelScheduleResponseTypeDef

# get_channel_schedule method usage example with argument unpacking

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

parent.get_channel_schedule(**kwargs)

1. See GetChannelScheduleRequestTypeDef

get_function

Retrieves the configuration and metadata for a function.

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

# get_function method definition

def get_function(
    self,
    *,
    FunctionId: str,
) -> GetFunctionResponseTypeDef:  # (1)
    ...

1. See GetFunctionResponseTypeDef

# get_function method usage example with argument unpacking

kwargs: GetFunctionRequestTypeDef = {  # (1)
    "FunctionId": ...,
}

parent.get_function(**kwargs)

1. See GetFunctionRequestTypeDef

get_playback_configuration

Retrieves a playback configuration.

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

# get_playback_configuration method definition

def get_playback_configuration(
    self,
    *,
    Name: str,
) -> GetPlaybackConfigurationResponseTypeDef:  # (1)
    ...

1. See GetPlaybackConfigurationResponseTypeDef

# get_playback_configuration method usage example with argument unpacking

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

parent.get_playback_configuration(**kwargs)

1. See GetPlaybackConfigurationRequestTypeDef

get_prefetch_schedule

Retrieves a prefetch schedule for a playback configuration.

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

# get_prefetch_schedule method definition

def get_prefetch_schedule(
    self,
    *,
    Name: str,
    PlaybackConfigurationName: str,
) -> GetPrefetchScheduleResponseTypeDef:  # (1)
    ...

1. See GetPrefetchScheduleResponseTypeDef

# get_prefetch_schedule method usage example with argument unpacking

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

parent.get_prefetch_schedule(**kwargs)

1. See GetPrefetchScheduleRequestTypeDef

list_alerts

Lists the alerts that are associated with a MediaTailor channel assembly resource.

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

# list_alerts method definition

def list_alerts(
    self,
    *,
    ResourceArn: str,
    MaxResults: int = ...,
    NextToken: str = ...,
) -> ListAlertsResponseTypeDef:  # (1)
    ...

1. See ListAlertsResponseTypeDef

# list_alerts method usage example with argument unpacking

kwargs: ListAlertsRequestTypeDef = {  # (1)
    "ResourceArn": ...,
}

parent.list_alerts(**kwargs)

1. See ListAlertsRequestTypeDef

list_channels

Retrieves information about the channels that are associated with the current AWS account.

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

# list_channels method definition

def list_channels(
    self,
    *,
    MaxResults: int = ...,
    NextToken: str = ...,
) -> ListChannelsResponseTypeDef:  # (1)
    ...

1. See ListChannelsResponseTypeDef

# list_channels method usage example with argument unpacking

kwargs: ListChannelsRequestTypeDef = {  # (1)
    "MaxResults": ...,
}

parent.list_channels(**kwargs)

1. See ListChannelsRequestTypeDef

list_functions

Retrieves all functions associated with your AWS account in the current Region.

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

# list_functions method definition

def list_functions(
    self,
    *,
    MaxResults: int = ...,
    NextToken: str = ...,
) -> ListFunctionsResponseTypeDef:  # (1)
    ...

1. See ListFunctionsResponseTypeDef

# list_functions method usage example with argument unpacking

kwargs: ListFunctionsRequestTypeDef = {  # (1)
    "MaxResults": ...,
}

parent.list_functions(**kwargs)

1. See ListFunctionsRequestTypeDef

list_live_sources

Lists the live sources contained in a source location.

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

# list_live_sources method definition

def list_live_sources(
    self,
    *,
    SourceLocationName: str,
    MaxResults: int = ...,
    NextToken: str = ...,
) -> ListLiveSourcesResponseTypeDef:  # (1)
    ...

1. See ListLiveSourcesResponseTypeDef

# list_live_sources method usage example with argument unpacking

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

parent.list_live_sources(**kwargs)

1. See ListLiveSourcesRequestTypeDef

list_playback_configurations

Retrieves existing playback configurations.

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

# list_playback_configurations method definition

def list_playback_configurations(
    self,
    *,
    MaxResults: int = ...,
    NextToken: str = ...,
) -> ListPlaybackConfigurationsResponseTypeDef:  # (1)
    ...

1. See ListPlaybackConfigurationsResponseTypeDef

# list_playback_configurations method usage example with argument unpacking

kwargs: ListPlaybackConfigurationsRequestTypeDef = {  # (1)
    "MaxResults": ...,
}

parent.list_playback_configurations(**kwargs)

1. See ListPlaybackConfigurationsRequestTypeDef

list_prefetch_schedules

Lists the prefetch schedules for a playback configuration.

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

# list_prefetch_schedules method definition

def list_prefetch_schedules(
    self,
    *,
    PlaybackConfigurationName: str,
    MaxResults: int = ...,
    NextToken: str = ...,
    ScheduleType: ListPrefetchScheduleTypeType = ...,  # (1)
    StreamId: str = ...,
) -> ListPrefetchSchedulesResponseTypeDef:  # (2)
    ...

1. See ListPrefetchScheduleTypeType
2. See ListPrefetchSchedulesResponseTypeDef

# list_prefetch_schedules method usage example with argument unpacking

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

parent.list_prefetch_schedules(**kwargs)

1. See ListPrefetchSchedulesRequestTypeDef

list_source_locations

Lists the source locations for a channel.

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

# list_source_locations method definition

def list_source_locations(
    self,
    *,
    MaxResults: int = ...,
    NextToken: str = ...,
) -> ListSourceLocationsResponseTypeDef:  # (1)
    ...

1. See ListSourceLocationsResponseTypeDef

# list_source_locations method usage example with argument unpacking

kwargs: ListSourceLocationsRequestTypeDef = {  # (1)
    "MaxResults": ...,
}

parent.list_source_locations(**kwargs)

1. See ListSourceLocationsRequestTypeDef

list_tags_for_resource

A list of tags that are associated with this resource.

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

# list_tags_for_resource method definition

def list_tags_for_resource(
    self,
    *,
    ResourceArn: str,
) -> ListTagsForResourceResponseTypeDef:  # (1)
    ...

1. See ListTagsForResourceResponseTypeDef

# list_tags_for_resource method usage example with argument unpacking

kwargs: ListTagsForResourceRequestTypeDef = {  # (1)
    "ResourceArn": ...,
}

parent.list_tags_for_resource(**kwargs)

1. See ListTagsForResourceRequestTypeDef

list_vod_sources

Lists the VOD sources contained in a source location.

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

# list_vod_sources method definition

def list_vod_sources(
    self,
    *,
    SourceLocationName: str,
    MaxResults: int = ...,
    NextToken: str = ...,
) -> ListVodSourcesResponseTypeDef:  # (1)
    ...

1. See ListVodSourcesResponseTypeDef

# list_vod_sources method usage example with argument unpacking

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

parent.list_vod_sources(**kwargs)

1. See ListVodSourcesRequestTypeDef

put_channel_policy

Creates an IAM policy for the channel.

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

# put_channel_policy method definition

def put_channel_policy(
    self,
    *,
    ChannelName: str,
    Policy: str,
) -> dict[str, Any]:
    ...

# put_channel_policy method usage example with argument unpacking

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

parent.put_channel_policy(**kwargs)

1. See PutChannelPolicyRequestTypeDef

put_function

Creates or updates a function.

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

# put_function method definition

def put_function(
    self,
    *,
    FunctionId: str,
    FunctionType: FunctionTypeType,  # (1)
    Description: str = ...,
    HttpRequestConfiguration: HttpRequestConfigurationUnionTypeDef = ...,  # (2)
    CustomOutputConfiguration: CustomOutputConfigurationUnionTypeDef = ...,  # (3)
    ConcurrentExecutorConfiguration: ConcurrentExecutorConfigurationUnionTypeDef = ...,  # (4)
    SequentialExecutorConfiguration: SequentialExecutorConfigurationUnionTypeDef = ...,  # (5)
    VastRequestConfiguration: VastRequestConfigurationUnionTypeDef = ...,  # (6)
    Tags: Mapping[str, str] = ...,
) -> PutFunctionResponseTypeDef:  # (7)
    ...

1. See FunctionTypeType
2. See HttpRequestConfigurationUnionTypeDef
3. See CustomOutputConfigurationUnionTypeDef
4. See ConcurrentExecutorConfigurationUnionTypeDef
5. See SequentialExecutorConfigurationUnionTypeDef
6. See VastRequestConfigurationUnionTypeDef
7. See PutFunctionResponseTypeDef

# put_function method usage example with argument unpacking

kwargs: PutFunctionRequestTypeDef = {  # (1)
    "FunctionId": ...,
    "FunctionType": ...,
}

parent.put_function(**kwargs)

1. See PutFunctionRequestTypeDef

put_playback_configuration

Creates a playback configuration.

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

# put_playback_configuration method definition

def put_playback_configuration(
    self,
    *,
    Name: str,
    AdDecisionServerUrl: str = ...,
    AvailSuppression: AvailSuppressionTypeDef = ...,  # (1)
    Bumper: BumperTypeDef = ...,  # (2)
    CdnConfiguration: CdnConfigurationTypeDef = ...,  # (3)
    ConfigurationAliases: Mapping[str, Mapping[str, str]] = ...,
    DashConfiguration: DashConfigurationForPutTypeDef = ...,  # (4)
    InsertionMode: InsertionModeType = ...,  # (5)
    LivePreRollConfiguration: LivePreRollConfigurationTypeDef = ...,  # (6)
    ManifestProcessingRules: ManifestProcessingRulesTypeDef = ...,  # (7)
    PersonalizationThresholdSeconds: int = ...,
    SlateAdUrl: str = ...,
    Tags: Mapping[str, str] = ...,
    TranscodeProfileName: str = ...,
    VideoContentSourceUrl: str = ...,
    AdConditioningConfiguration: AdConditioningConfigurationTypeDef = ...,  # (8)
    AdDecisionServerConfiguration: AdDecisionServerConfigurationUnionTypeDef = ...,  # (9)
    YieldOptimizationConfiguration: YieldOptimizationConfigurationTypeDef = ...,  # (10)
    FunctionMapping: Mapping[EventNameType, str] = ...,  # (11)
    AdsPersonalizationTimeouts: AdsPersonalizationTimeoutsTypeDef = ...,  # (12)
    AdsPersonalizationConcurrency: AdsPersonalizationConcurrencyTypeDef = ...,  # (13)
) -> PutPlaybackConfigurationResponseTypeDef:  # (14)
    ...

1. See AvailSuppressionTypeDef
2. See BumperTypeDef
3. See CdnConfigurationTypeDef
4. See DashConfigurationForPutTypeDef
5. See InsertionModeType
6. See LivePreRollConfigurationTypeDef
7. See ManifestProcessingRulesTypeDef
8. See AdConditioningConfigurationTypeDef
9. See AdDecisionServerConfigurationUnionTypeDef
10. See YieldOptimizationConfigurationTypeDef
11. See Mapping[EventNameType, str]
12. See AdsPersonalizationTimeoutsTypeDef
13. See AdsPersonalizationConcurrencyTypeDef
14. See PutPlaybackConfigurationResponseTypeDef

# put_playback_configuration method usage example with argument unpacking

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

parent.put_playback_configuration(**kwargs)

1. See PutPlaybackConfigurationRequestTypeDef

start_channel

Starts a channel.

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

# start_channel method definition

def start_channel(
    self,
    *,
    ChannelName: str,
) -> dict[str, Any]:
    ...

# start_channel method usage example with argument unpacking

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

parent.start_channel(**kwargs)

1. See StartChannelRequestTypeDef

stop_channel

Stops a channel.

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

# stop_channel method definition

def stop_channel(
    self,
    *,
    ChannelName: str,
) -> dict[str, Any]:
    ...

# stop_channel method usage example with argument unpacking

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

parent.stop_channel(**kwargs)

1. See StopChannelRequestTypeDef

tag_resource

The resource to tag.

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

# tag_resource method definition

def tag_resource(
    self,
    *,
    ResourceArn: str,
    Tags: Mapping[str, str],
) -> EmptyResponseMetadataTypeDef:  # (1)
    ...

1. See EmptyResponseMetadataTypeDef

# tag_resource method usage example with argument unpacking

kwargs: TagResourceRequestTypeDef = {  # (1)
    "ResourceArn": ...,
    "Tags": ...,
}

parent.tag_resource(**kwargs)

1. See TagResourceRequestTypeDef

untag_resource

The resource to untag.

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

# untag_resource method definition

def untag_resource(
    self,
    *,
    ResourceArn: str,
    TagKeys: Sequence[str],
) -> EmptyResponseMetadataTypeDef:  # (1)
    ...

1. See EmptyResponseMetadataTypeDef

# untag_resource method usage example with argument unpacking

kwargs: UntagResourceRequestTypeDef = {  # (1)
    "ResourceArn": ...,
    "TagKeys": ...,
}

parent.untag_resource(**kwargs)

1. See UntagResourceRequestTypeDef

update_channel

Updates a channel.

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

# update_channel method definition

def update_channel(
    self,
    *,
    ChannelName: str,
    Outputs: Sequence[RequestOutputItemTypeDef],  # (1)
    FillerSlate: SlateSourceTypeDef = ...,  # (2)
    TimeShiftConfiguration: TimeShiftConfigurationTypeDef = ...,  # (3)
    Audiences: Sequence[str] = ...,
) -> UpdateChannelResponseTypeDef:  # (4)
    ...

1. See Sequence[RequestOutputItemTypeDef]
2. See SlateSourceTypeDef
3. See TimeShiftConfigurationTypeDef
4. See UpdateChannelResponseTypeDef

# update_channel method usage example with argument unpacking

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

parent.update_channel(**kwargs)

1. See UpdateChannelRequestTypeDef

update_live_source

Updates a live source's configuration.

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

# update_live_source method definition

def update_live_source(
    self,
    *,
    HttpPackageConfigurations: Sequence[HttpPackageConfigurationTypeDef],  # (1)
    LiveSourceName: str,
    SourceLocationName: str,
) -> UpdateLiveSourceResponseTypeDef:  # (2)
    ...

1. See Sequence[HttpPackageConfigurationTypeDef]
2. See UpdateLiveSourceResponseTypeDef

# update_live_source method usage example with argument unpacking

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

parent.update_live_source(**kwargs)

1. See UpdateLiveSourceRequestTypeDef

update_program

Updates a program within a channel.

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

# update_program method definition

def update_program(
    self,
    *,
    ChannelName: str,
    ProgramName: str,
    ScheduleConfiguration: UpdateProgramScheduleConfigurationTypeDef,  # (1)
    AdBreaks: Sequence[AdBreakUnionTypeDef] = ...,  # (2)
    AudienceMedia: Sequence[AudienceMediaUnionTypeDef] = ...,  # (3)
) -> UpdateProgramResponseTypeDef:  # (4)
    ...

1. See UpdateProgramScheduleConfigurationTypeDef
2. See Sequence[AdBreakUnionTypeDef]
3. See Sequence[AudienceMediaUnionTypeDef]
4. See UpdateProgramResponseTypeDef

# update_program method usage example with argument unpacking

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

parent.update_program(**kwargs)

1. See UpdateProgramRequestTypeDef

update_source_location

Updates a source location.

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

# update_source_location method definition

def update_source_location(
    self,
    *,
    HttpConfiguration: HttpConfigurationTypeDef,  # (1)
    SourceLocationName: str,
    AccessConfiguration: AccessConfigurationTypeDef = ...,  # (2)
    DefaultSegmentDeliveryConfiguration: DefaultSegmentDeliveryConfigurationTypeDef = ...,  # (3)
    SegmentDeliveryConfigurations: Sequence[SegmentDeliveryConfigurationTypeDef] = ...,  # (4)
) -> UpdateSourceLocationResponseTypeDef:  # (5)
    ...

1. See HttpConfigurationTypeDef
2. See AccessConfigurationTypeDef
3. See DefaultSegmentDeliveryConfigurationTypeDef
4. See Sequence[SegmentDeliveryConfigurationTypeDef]
5. See UpdateSourceLocationResponseTypeDef

# update_source_location method usage example with argument unpacking

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

parent.update_source_location(**kwargs)

1. See UpdateSourceLocationRequestTypeDef

update_vod_source

Updates a VOD source's configuration.

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

# update_vod_source method definition

def update_vod_source(
    self,
    *,
    HttpPackageConfigurations: Sequence[HttpPackageConfigurationTypeDef],  # (1)
    SourceLocationName: str,
    VodSourceName: str,
) -> UpdateVodSourceResponseTypeDef:  # (2)
    ...

1. See Sequence[HttpPackageConfigurationTypeDef]
2. See UpdateVodSourceResponseTypeDef

# update_vod_source method usage example with argument unpacking

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

parent.update_vod_source(**kwargs)

1. See UpdateVodSourceRequestTypeDef

get_paginator

Type annotations and code completion for boto3.client("mediatailor").get_paginator method with overloads.

• client.get_paginator("get_channel_schedule") -> GetChannelSchedulePaginator
• client.get_paginator("list_alerts") -> ListAlertsPaginator
• client.get_paginator("list_channels") -> ListChannelsPaginator
• client.get_paginator("list_functions") -> ListFunctionsPaginator
• client.get_paginator("list_live_sources") -> ListLiveSourcesPaginator
• client.get_paginator("list_playback_configurations") -> ListPlaybackConfigurationsPaginator
• client.get_paginator("list_prefetch_schedules") -> ListPrefetchSchedulesPaginator
• client.get_paginator("list_source_locations") -> ListSourceLocationsPaginator
• client.get_paginator("list_vod_sources") -> ListVodSourcesPaginator