Struct Client

pub struct Client { /* private fields */ }

Client for AWS MediaTailor

Client for invoking operations on AWS MediaTailor. Each operation on AWS MediaTailor is a method on this this struct. .send() MUST be invoked on the generated operations to dispatch the request to the service.

Constructing a Client

A Config is required to construct a client. For most use cases, the aws-config crate should be used to automatically resolve this config using aws_config::load_from_env(), since this will resolve an SdkConfig which can be shared across multiple different AWS SDK clients. This config resolution process can be customized by calling aws_config::from_env() instead, which returns a ConfigLoader that uses the builder pattern to customize the default config.

In the simplest case, creating a client looks as follows:

let config = aws_config::load_from_env().await;
let client = aws_sdk_mediatailor::Client::new(&config);

Occasionally, SDKs may have additional service-specific values that can be set on the Config that is absent from SdkConfig, or slightly different settings for a specific client may be desired. The Builder struct implements From<&SdkConfig>, so setting these specific settings can be done as follows:

let sdk_config = ::aws_config::load_from_env().await;
let config = aws_sdk_mediatailor::config::Builder::from(&sdk_config)
    .some_service_specific_setting("value")
    .build();

See the aws-config docs and Config for more information on customizing configuration.

Note: Client construction is expensive due to connection thread pool initialization, and should be done once at application start-up.

Using the Client

A client has a function for every operation that can be performed by the service. For example, the ConfigureLogsForChannel operation has a Client::configure_logs_for_channel, function which returns a builder for that operation. The fluent builder ultimately has a send() function that returns an async future that returns a result, as illustrated below:

let result = client.configure_logs_for_channel()
    .channel_name("example")
    .send()
    .await;

The underlying HTTP requests that get made by this can be modified with the customize_operation function on the fluent builder. See the customize module for more information.

Implementations

impl Client

pub fn configure_logs_for_channel(&self) -> ConfigureLogsForChannelFluentBuilder

Constructs a fluent builder for the ConfigureLogsForChannel operation.

• The fluent builder is configurable:
  • channel_name(impl Into<String>) / set_channel_name(Option<String>):
    required: true
    

    The name of the channel.

    
    
  • log_types(LogType) / set_log_types(Option<Vec::<LogType>>):
    required: true
    

    The types of logs to collect.

    
    
• On success, responds with ConfigureLogsForChannelOutput with field(s):
  • channel_name(Option<String>):

    The name of the channel.

  • log_types(Option<Vec::<LogType>>):

    The types of logs collected.

• On failure, responds with SdkError<ConfigureLogsForChannelError>

impl Client

pub fn configure_logs_for_playback_configuration( &self, ) -> ConfigureLogsForPlaybackConfigurationFluentBuilder

Constructs a fluent builder for the ConfigureLogsForPlaybackConfiguration operation.

• The fluent builder is configurable:
  • percent_enabled(i32) / set_percent_enabled(Option<i32>):
    required: true
    

    The percentage of session logs that MediaTailor sends to your CloudWatch Logs account. For example, if your playback configuration has 1000 sessions and percentEnabled is set to 60, MediaTailor sends logs for 600 of the sessions to CloudWatch Logs. MediaTailor decides at random which of the playback configuration sessions to send logs for. If you want to view logs for a specific session, you can use the debug log mode.

    Valid values: 0 - 100

    
    
  • playback_configuration_name(impl Into<String>) / set_playback_configuration_name(Option<String>):
    required: true
    

    The name of the playback configuration.

    
    
  • enabled_logging_strategies(LoggingStrategy) / set_enabled_logging_strategies(Option<Vec::<LoggingStrategy>>):
    required: false
    

    The method used for collecting logs from AWS Elemental MediaTailor. To configure MediaTailor to send logs directly to Amazon CloudWatch Logs, choose LEGACY_CLOUDWATCH. To configure MediaTailor to send logs to CloudWatch, which then vends the logs to your destination of choice, choose VENDED_LOGS. Supported destinations are CloudWatch Logs log group, Amazon S3 bucket, and Amazon Data Firehose stream.

    To use vended logs, you must configure the delivery destination in Amazon CloudWatch, as described in Enable logging from AWS services, Logging that requires additional permissions [V2].

    
    
  • ads_interaction_log(AdsInteractionLog) / set_ads_interaction_log(Option<AdsInteractionLog>):
    required: false
    

    The event types that MediaTailor emits in logs for interactions with the ADS.

    
    
  • manifest_service_interaction_log(ManifestServiceInteractionLog) / set_manifest_service_interaction_log(Option<ManifestServiceInteractionLog>):
    required: false
    

    The event types that MediaTailor emits in logs for interactions with the origin server.

    
    
• On success, responds with ConfigureLogsForPlaybackConfigurationOutput with field(s):
  • percent_enabled(i32):

    The percentage of session logs that MediaTailor sends to your Cloudwatch Logs account.

  • playback_configuration_name(Option<String>):

    The name of the playback configuration.

  • enabled_logging_strategies(Option<Vec::<LoggingStrategy>>):

    The method used for collecting logs from AWS Elemental MediaTailor. LEGACY_CLOUDWATCH indicates that MediaTailor is sending logs directly to Amazon CloudWatch Logs. VENDED_LOGS indicates that MediaTailor is sending logs to CloudWatch, which then vends the logs to your destination of choice. Supported destinations are CloudWatch Logs log group, Amazon S3 bucket, and Amazon Data Firehose stream.

  • ads_interaction_log(Option<AdsInteractionLog>):

    The event types that MediaTailor emits in logs for interactions with the ADS.

  • manifest_service_interaction_log(Option<ManifestServiceInteractionLog>):

    The event types that MediaTailor emits in logs for interactions with the origin server.

• On failure, responds with SdkError<ConfigureLogsForPlaybackConfigurationError>

impl Client

pub fn create_channel(&self) -> CreateChannelFluentBuilder

Constructs a fluent builder for the CreateChannel operation.

• The fluent builder is configurable:
  • channel_name(impl Into<String>) / set_channel_name(Option<String>):
    required: true
    

    The name of the channel.

    
    
  • filler_slate(SlateSource) / set_filler_slate(Option<SlateSource>):
    required: false
    

    The slate used to fill gaps between programs in the schedule. You must configure filler slate if your channel uses the LINEAR PlaybackMode. MediaTailor doesn’t support filler slate for channels using the LOOP PlaybackMode.

    
    
  • outputs(RequestOutputItem) / set_outputs(Option<Vec::<RequestOutputItem>>):
    required: true
    

    The channel’s output properties.

    
    
  • playback_mode(PlaybackMode) / set_playback_mode(Option<PlaybackMode>):
    required: true
    

    The type of playback mode to use for this channel.

    LINEAR - The programs in the schedule play once back-to-back in the schedule.

    LOOP - The programs in the schedule play back-to-back in an endless loop. When the last program in the schedule stops playing, playback loops back to the first program in the schedule.

    
    
  • tags(impl Into<String>, impl Into<String>) / set_tags(Option<HashMap::<String, String>>):
    required: false
    

    The tags to assign to the channel. Tags are key-value pairs that you can associate with Amazon resources to help with organization, access control, and cost tracking. For more information, see Tagging AWS Elemental MediaTailor Resources.

    
    
  • tier(Tier) / set_tier(Option<Tier>):
    required: false
    

    The tier of the channel.

    
    
  • time_shift_configuration(TimeShiftConfiguration) / set_time_shift_configuration(Option<TimeShiftConfiguration>):
    required: false
    

    The time-shifted viewing configuration you want to associate to the channel.

    
    
  • audiences(impl Into<String>) / set_audiences(Option<Vec::<String>>):
    required: false
    

    The list of audiences defined in channel.

    
    
• On success, responds with CreateChannelOutput with field(s):
  • arn(Option<String>):

    The Amazon Resource Name (ARN) to assign to the channel.

  • channel_name(Option<String>):

    The name to assign to the channel.

  • channel_state(Option<ChannelState>):

    Indicates whether the channel is in a running state or not.

  • creation_time(Option<DateTime>):

    The timestamp of when the channel was created.

  • filler_slate(Option<SlateSource>):

    Contains information about the slate used to fill gaps between programs in the schedule.

  • last_modified_time(Option<DateTime>):

    The timestamp of when the channel was last modified.

  • outputs(Option<Vec::<ResponseOutputItem>>):

    The output properties to assign to the channel.

  • playback_mode(Option<String>):

    The playback mode to assign to the channel.

  • tags(Option<HashMap::<String, String>>):

    The tags to assign to the channel. Tags are key-value pairs that you can associate with Amazon resources to help with organization, access control, and cost tracking. For more information, see Tagging AWS Elemental MediaTailor Resources.

  • tier(Option<String>):

    The tier of the channel.

  • time_shift_configuration(Option<TimeShiftConfiguration>):

    The time-shifted viewing configuration assigned to the channel.

  • audiences(Option<Vec::<String>>):

    The list of audiences defined in channel.

• On failure, responds with SdkError<CreateChannelError>

impl Client

pub fn create_live_source(&self) -> CreateLiveSourceFluentBuilder

Constructs a fluent builder for the CreateLiveSource operation.

• The fluent builder is configurable:
  • http_package_configurations(HttpPackageConfiguration) / set_http_package_configurations(Option<Vec::<HttpPackageConfiguration>>):
    required: true
    

    A list of HTTP package configuration parameters for this live source.

    
    
  • live_source_name(impl Into<String>) / set_live_source_name(Option<String>):
    required: true
    

    The name of the live source.

    
    
  • source_location_name(impl Into<String>) / set_source_location_name(Option<String>):
    required: true
    

    The name of the source location.

    
    
  • tags(impl Into<String>, impl Into<String>) / set_tags(Option<HashMap::<String, String>>):
    required: false
    

    The tags to assign to the live source. Tags are key-value pairs that you can associate with Amazon resources to help with organization, access control, and cost tracking. For more information, see Tagging AWS Elemental MediaTailor Resources.

    
    
• On success, responds with CreateLiveSourceOutput with field(s):
  • arn(Option<String>):

    The ARN to assign to the live source.

  • creation_time(Option<DateTime>):

    The time the live source was created.

  • http_package_configurations(Option<Vec::<HttpPackageConfiguration>>):

    A list of HTTP package configuration parameters for this live source.

  • last_modified_time(Option<DateTime>):

    The time the live source was last modified.

  • live_source_name(Option<String>):

    The name to assign to the live source.

  • source_location_name(Option<String>):

    The name to assign to the source location of the live source.

  • tags(Option<HashMap::<String, String>>):

    The tags to assign to the live source. Tags are key-value pairs that you can associate with Amazon resources to help with organization, access control, and cost tracking. For more information, see Tagging AWS Elemental MediaTailor Resources.

• On failure, responds with SdkError<CreateLiveSourceError>

impl Client

pub fn create_prefetch_schedule(&self) -> CreatePrefetchScheduleFluentBuilder

Constructs a fluent builder for the CreatePrefetchSchedule operation.

• The fluent builder is configurable:
  • consumption(PrefetchConsumption) / set_consumption(Option<PrefetchConsumption>):
    required: false
    

    The configuration settings for how and when MediaTailor consumes prefetched ads from the ad decision server for single prefetch schedules. Each consumption configuration contains an end time and an optional start time that define the consumption window. Prefetch schedules automatically expire no earlier than seven days after the end time.

    
    
  • name(impl Into<String>) / set_name(Option<String>):
    required: true
    

    The name to assign to the schedule request.

    
    
  • playback_configuration_name(impl Into<String>) / set_playback_configuration_name(Option<String>):
    required: true
    

    The name to assign to the playback configuration.

    
    
  • retrieval(PrefetchRetrieval) / set_retrieval(Option<PrefetchRetrieval>):
    required: false
    

    The configuration settings for retrieval of prefetched ads from the ad decision server. Only one set of prefetched ads will be retrieved and subsequently consumed for each ad break.

    
    
  • recurring_prefetch_configuration(RecurringPrefetchConfiguration) / set_recurring_prefetch_configuration(Option<RecurringPrefetchConfiguration>):
    required: false
    

    The configuration that defines how and when MediaTailor performs ad prefetching in a live event.

    
    
  • schedule_type(PrefetchScheduleType) / set_schedule_type(Option<PrefetchScheduleType>):
    required: false
    

    The frequency that MediaTailor creates prefetch schedules. SINGLE indicates that this schedule applies to one ad break. RECURRING indicates that MediaTailor automatically creates a schedule for each ad avail in a live event.

    For more information about the prefetch types and when you might use each, see Prefetching ads in Elemental MediaTailor.

    
    
  • stream_id(impl Into<String>) / set_stream_id(Option<String>):
    required: false
    

    An optional stream identifier that MediaTailor uses to prefetch ads for multiple streams that use the same playback configuration. If StreamId is specified, MediaTailor returns all of the prefetch schedules with an exact match on StreamId. If not specified, MediaTailor returns all of the prefetch schedules for the playback configuration, regardless of StreamId.

    
    
• On success, responds with CreatePrefetchScheduleOutput with field(s):
  • arn(Option<String>):

    The ARN to assign to the prefetch schedule.

  • consumption(Option<PrefetchConsumption>):

    The configuration settings for how and when MediaTailor consumes prefetched ads from the ad decision server for single prefetch schedules. Each consumption configuration contains an end time and an optional start time that define the consumption window. Prefetch schedules automatically expire no earlier than seven days after the end time.

  • name(Option<String>):

    The name to assign to the prefetch schedule.

  • playback_configuration_name(Option<String>):

    The name to assign to the playback configuration.

  • retrieval(Option<PrefetchRetrieval>):

    The configuration settings for retrieval of prefetched ads from the ad decision server. Only one set of prefetched ads will be retrieved and subsequently consumed for each ad break.

  • recurring_prefetch_configuration(Option<RecurringPrefetchConfiguration>):

    The configuration that defines how MediaTailor performs recurring prefetch.

  • schedule_type(Option<PrefetchScheduleType>):

    The frequency that MediaTailor creates prefetch schedules. SINGLE indicates that this schedule applies to one ad break. RECURRING indicates that MediaTailor automatically creates a schedule for each ad avail in a live event.

  • stream_id(Option<String>):

    An optional stream identifier that MediaTailor uses to prefetch ads for multiple streams that use the same playback configuration. If StreamId is specified, MediaTailor returns all of the prefetch schedules with an exact match on StreamId. If not specified, MediaTailor returns all of the prefetch schedules for the playback configuration, regardless of StreamId.

• On failure, responds with SdkError<CreatePrefetchScheduleError>

impl Client

pub fn create_program(&self) -> CreateProgramFluentBuilder

Constructs a fluent builder for the CreateProgram operation.

• The fluent builder is configurable:
  • ad_breaks(AdBreak) / set_ad_breaks(Option<Vec::<AdBreak>>):
    required: false
    

    The ad break configuration settings.

    
    
  • channel_name(impl Into<String>) / set_channel_name(Option<String>):
    required: true
    

    The name of the channel for this Program.

    
    
  • live_source_name(impl Into<String>) / set_live_source_name(Option<String>):
    required: false
    

    The name of the LiveSource for this Program.

    
    
  • program_name(impl Into<String>) / set_program_name(Option<String>):
    required: true
    

    The name of the Program.

    
    
  • schedule_configuration(ScheduleConfiguration) / set_schedule_configuration(Option<ScheduleConfiguration>):
    required: true
    

    The schedule configuration settings.

    
    
  • source_location_name(impl Into<String>) / set_source_location_name(Option<String>):
    required: true
    

    The name of the source location.

    
    
  • vod_source_name(impl Into<String>) / set_vod_source_name(Option<String>):
    required: false
    

    The name that’s used to refer to a VOD source.

    
    
  • audience_media(AudienceMedia) / set_audience_media(Option<Vec::<AudienceMedia>>):
    required: false
    

    The list of AudienceMedia defined in program.

    
    
• On success, responds with CreateProgramOutput with field(s):
  • ad_breaks(Option<Vec::<AdBreak>>):

    The ad break configuration settings.

  • arn(Option<String>):

    The ARN to assign to the program.

  • channel_name(Option<String>):

    The name to assign to the channel for this program.

  • creation_time(Option<DateTime>):

    The time the program was created.

  • live_source_name(Option<String>):

    The name of the LiveSource for this Program.

  • program_name(Option<String>):

    The name to assign to this program.

  • scheduled_start_time(Option<DateTime>):

    The scheduled start time for this Program.

  • source_location_name(Option<String>):

    The name to assign to the source location for this program.

  • vod_source_name(Option<String>):

    The name that’s used to refer to a VOD source.

  • clip_range(Option<ClipRange>):

    The clip range configuration settings.

  • duration_millis(Option<i64>):

    The duration of the live program in milliseconds.

  • audience_media(Option<Vec::<AudienceMedia>>):

    The list of AudienceMedia defined in program.

• On failure, responds with SdkError<CreateProgramError>

impl Client

pub fn create_source_location(&self) -> CreateSourceLocationFluentBuilder

Constructs a fluent builder for the CreateSourceLocation operation.

• The fluent builder is configurable:
  • access_configuration(AccessConfiguration) / set_access_configuration(Option<AccessConfiguration>):
    required: false
    

    Access configuration parameters. Configures the type of authentication used to access content from your source location.

    
    
  • default_segment_delivery_configuration(DefaultSegmentDeliveryConfiguration) / set_default_segment_delivery_configuration(Option<DefaultSegmentDeliveryConfiguration>):
    required: false
    

    The optional configuration for the server that serves segments.

    
    
  • http_configuration(HttpConfiguration) / set_http_configuration(Option<HttpConfiguration>):
    required: true
    

    The source’s HTTP package configurations.

    
    
  • segment_delivery_configurations(SegmentDeliveryConfiguration) / set_segment_delivery_configurations(Option<Vec::<SegmentDeliveryConfiguration>>):
    required: false
    

    A list of the segment delivery configurations associated with this resource.

    
    
  • source_location_name(impl Into<String>) / set_source_location_name(Option<String>):
    required: true
    

    The name associated with the source location.

    
    
  • tags(impl Into<String>, impl Into<String>) / set_tags(Option<HashMap::<String, String>>):
    required: false
    

    The tags to assign to the source location. Tags are key-value pairs that you can associate with Amazon resources to help with organization, access control, and cost tracking. For more information, see Tagging AWS Elemental MediaTailor Resources.

    
    
• On success, responds with CreateSourceLocationOutput with field(s):
  • access_configuration(Option<AccessConfiguration>):

    Access configuration parameters. Configures the type of authentication used to access content from your source location.

  • arn(Option<String>):

    The ARN to assign to the source location.

  • creation_time(Option<DateTime>):

    The time the source location was created.

  • default_segment_delivery_configuration(Option<DefaultSegmentDeliveryConfiguration>):

    The optional configuration for the server that serves segments.

  • http_configuration(Option<HttpConfiguration>):

    The source’s HTTP package configurations.

  • last_modified_time(Option<DateTime>):

    The time the source location was last modified.

  • segment_delivery_configurations(Option<Vec::<SegmentDeliveryConfiguration>>):

    The segment delivery configurations for the source location. For information about MediaTailor configurations, see Working with configurations in AWS Elemental MediaTailor.

  • source_location_name(Option<String>):

    The name to assign to the source location.

  • tags(Option<HashMap::<String, String>>):

    The tags to assign to the source location. Tags are key-value pairs that you can associate with Amazon resources to help with organization, access control, and cost tracking. For more information, see Tagging AWS Elemental MediaTailor Resources.

• On failure, responds with SdkError<CreateSourceLocationError>

impl Client

pub fn create_vod_source(&self) -> CreateVodSourceFluentBuilder

Constructs a fluent builder for the CreateVodSource operation.

• The fluent builder is configurable:
  • http_package_configurations(HttpPackageConfiguration) / set_http_package_configurations(Option<Vec::<HttpPackageConfiguration>>):
    required: true
    

    A list of HTTP package configuration parameters for this VOD source.

    
    
  • source_location_name(impl Into<String>) / set_source_location_name(Option<String>):
    required: true
    

    The name of the source location for this VOD source.

    
    
  • tags(impl Into<String>, impl Into<String>) / set_tags(Option<HashMap::<String, String>>):
    required: false
    

    The tags to assign to the VOD source. Tags are key-value pairs that you can associate with Amazon resources to help with organization, access control, and cost tracking. For more information, see Tagging AWS Elemental MediaTailor Resources.

    
    
  • vod_source_name(impl Into<String>) / set_vod_source_name(Option<String>):
    required: true
    

    The name associated with the VOD source.>

    
    
• On success, responds with CreateVodSourceOutput with field(s):
  • arn(Option<String>):

    The ARN to assign to this VOD source.

  • creation_time(Option<DateTime>):

    The time the VOD source was created.

  • http_package_configurations(Option<Vec::<HttpPackageConfiguration>>):

    A list of HTTP package configuration parameters for this VOD source.

  • last_modified_time(Option<DateTime>):

    The time the VOD source was last modified.

  • source_location_name(Option<String>):

    The name to assign to the source location for this VOD source.

  • tags(Option<HashMap::<String, String>>):

    The tags to assign to the VOD source. Tags are key-value pairs that you can associate with Amazon resources to help with organization, access control, and cost tracking. For more information, see Tagging AWS Elemental MediaTailor Resources.

  • vod_source_name(Option<String>):

    The name to assign to the VOD source.

• On failure, responds with SdkError<CreateVodSourceError>

impl Client

pub fn delete_channel(&self) -> DeleteChannelFluentBuilder

Constructs a fluent builder for the DeleteChannel operation.

• The fluent builder is configurable:
  • channel_name(impl Into<String>) / set_channel_name(Option<String>):
    required: true
    

    The name of the channel.

    
    
• On success, responds with DeleteChannelOutput
• On failure, responds with SdkError<DeleteChannelError>

impl Client

pub fn delete_channel_policy(&self) -> DeleteChannelPolicyFluentBuilder

Constructs a fluent builder for the DeleteChannelPolicy operation.

• The fluent builder is configurable:
  • channel_name(impl Into<String>) / set_channel_name(Option<String>):
    required: true
    

    The name of the channel associated with this channel policy.

    
    
• On success, responds with DeleteChannelPolicyOutput
• On failure, responds with SdkError<DeleteChannelPolicyError>

impl Client

pub fn delete_live_source(&self) -> DeleteLiveSourceFluentBuilder

Constructs a fluent builder for the DeleteLiveSource operation.

• The fluent builder is configurable:
  • live_source_name(impl Into<String>) / set_live_source_name(Option<String>):
    required: true
    

    The name of the live source.

    
    
  • source_location_name(impl Into<String>) / set_source_location_name(Option<String>):
    required: true
    

    The name of the source location associated with this Live Source.

    
    
• On success, responds with DeleteLiveSourceOutput
• On failure, responds with SdkError<DeleteLiveSourceError>

impl Client

pub fn delete_playback_configuration( &self, ) -> DeletePlaybackConfigurationFluentBuilder

Constructs a fluent builder for the DeletePlaybackConfiguration operation.

• The fluent builder is configurable:
  • name(impl Into<String>) / set_name(Option<String>):
    required: true
    

    The name of the playback configuration.

    
    
• On success, responds with DeletePlaybackConfigurationOutput
• On failure, responds with SdkError<DeletePlaybackConfigurationError>

impl Client

pub fn delete_prefetch_schedule(&self) -> DeletePrefetchScheduleFluentBuilder

Constructs a fluent builder for the DeletePrefetchSchedule operation.

• The fluent builder is configurable:
  • name(impl Into<String>) / set_name(Option<String>):
    required: true
    

    The name of the prefetch schedule. If the action is successful, the service sends back an HTTP 204 response with an empty HTTP body.

    
    
  • playback_configuration_name(impl Into<String>) / set_playback_configuration_name(Option<String>):
    required: true
    

    The name of the playback configuration for this prefetch schedule.

    
    
• On success, responds with DeletePrefetchScheduleOutput
• On failure, responds with SdkError<DeletePrefetchScheduleError>

impl Client

pub fn delete_program(&self) -> DeleteProgramFluentBuilder

Constructs a fluent builder for the DeleteProgram operation.

• The fluent builder is configurable:
  • channel_name(impl Into<String>) / set_channel_name(Option<String>):
    required: true
    

    The name of the channel.

    
    
  • program_name(impl Into<String>) / set_program_name(Option<String>):
    required: true
    

    The name of the program.

    
    
• On success, responds with DeleteProgramOutput
• On failure, responds with SdkError<DeleteProgramError>

impl Client

pub fn delete_source_location(&self) -> DeleteSourceLocationFluentBuilder

Constructs a fluent builder for the DeleteSourceLocation operation.

• The fluent builder is configurable:
  • source_location_name(impl Into<String>) / set_source_location_name(Option<String>):
    required: true
    

    The name of the source location.

    
    
• On success, responds with DeleteSourceLocationOutput
• On failure, responds with SdkError<DeleteSourceLocationError>

impl Client

pub fn delete_vod_source(&self) -> DeleteVodSourceFluentBuilder

Constructs a fluent builder for the DeleteVodSource operation.

• The fluent builder is configurable:
  • source_location_name(impl Into<String>) / set_source_location_name(Option<String>):
    required: true
    

    The name of the source location associated with this VOD Source.

    
    
  • vod_source_name(impl Into<String>) / set_vod_source_name(Option<String>):
    required: true
    

    The name of the VOD source.

    
    
• On success, responds with DeleteVodSourceOutput
• On failure, responds with SdkError<DeleteVodSourceError>

impl Client

pub fn describe_channel(&self) -> DescribeChannelFluentBuilder

Constructs a fluent builder for the DescribeChannel operation.

• The fluent builder is configurable:
  • channel_name(impl Into<String>) / set_channel_name(Option<String>):
    required: true
    

    The name of the channel.

    
    
• On success, responds with DescribeChannelOutput with field(s):
  • arn(Option<String>):

    The ARN of the channel.

  • channel_name(Option<String>):

    The name of the channel.

  • channel_state(Option<ChannelState>):

    Indicates whether the channel is in a running state or not.

  • creation_time(Option<DateTime>):

    The timestamp of when the channel was created.

  • filler_slate(Option<SlateSource>):

    Contains information about the slate used to fill gaps between programs in the schedule.

  • last_modified_time(Option<DateTime>):

    The timestamp of when the channel was last modified.

  • outputs(Option<Vec::<ResponseOutputItem>>):

    The channel’s output properties.

  • playback_mode(Option<String>):

    The channel’s playback mode.

  • tags(Option<HashMap::<String, String>>):

    The tags assigned to the channel. Tags are key-value pairs that you can associate with Amazon resources to help with organization, access control, and cost tracking. For more information, see Tagging AWS Elemental MediaTailor Resources.

  • tier(Option<String>):

    The channel’s tier.

  • log_configuration(Option<LogConfigurationForChannel>):

    The log configuration for the channel.

  • time_shift_configuration(Option<TimeShiftConfiguration>):

    The time-shifted viewing configuration for the channel.

  • audiences(Option<Vec::<String>>):

    The list of audiences defined in channel.

• On failure, responds with SdkError<DescribeChannelError>

impl Client

pub fn describe_live_source(&self) -> DescribeLiveSourceFluentBuilder

Constructs a fluent builder for the DescribeLiveSource operation.

• The fluent builder is configurable:
  • live_source_name(impl Into<String>) / set_live_source_name(Option<String>):
    required: true
    

    The name of the live source.

    
    
  • source_location_name(impl Into<String>) / set_source_location_name(Option<String>):
    required: true
    

    The name of the source location associated with this Live Source.

    
    
• On success, responds with DescribeLiveSourceOutput with field(s):
  • arn(Option<String>):

    The ARN of the live source.

  • creation_time(Option<DateTime>):

    The timestamp that indicates when the live source was created.

  • http_package_configurations(Option<Vec::<HttpPackageConfiguration>>):

    The HTTP package configurations.

  • last_modified_time(Option<DateTime>):

    The timestamp that indicates when the live source was modified.

  • live_source_name(Option<String>):

    The name of the live source.

  • source_location_name(Option<String>):

    The name of the source location associated with the live source.

  • tags(Option<HashMap::<String, String>>):

    The tags assigned to the live source. Tags are key-value pairs that you can associate with Amazon resources to help with organization, access control, and cost tracking. For more information, see Tagging AWS Elemental MediaTailor Resources.

• On failure, responds with SdkError<DescribeLiveSourceError>

impl Client

pub fn describe_program(&self) -> DescribeProgramFluentBuilder

Constructs a fluent builder for the DescribeProgram operation.

• The fluent builder is configurable:
  • channel_name(impl Into<String>) / set_channel_name(Option<String>):
    required: true
    

    The name of the channel associated with this Program.

    
    
  • program_name(impl Into<String>) / set_program_name(Option<String>):
    required: true
    

    The name of the program.

    
    
• On success, responds with DescribeProgramOutput with field(s):
  • ad_breaks(Option<Vec::<AdBreak>>):

    The ad break configuration settings.

  • arn(Option<String>):

    The ARN of the program.

  • channel_name(Option<String>):

    The name of the channel that the program belongs to.

  • creation_time(Option<DateTime>):

    The timestamp of when the program was created.

  • live_source_name(Option<String>):

    The name of the LiveSource for this Program.

  • program_name(Option<String>):

    The name of the program.

  • scheduled_start_time(Option<DateTime>):

    The date and time that the program is scheduled to start in ISO 8601 format and Coordinated Universal Time (UTC). For example, the value 2021-03-27T17:48:16.751Z represents March 27, 2021 at 17:48:16.751 UTC.

  • source_location_name(Option<String>):

    The source location name.

  • vod_source_name(Option<String>):

    The name that’s used to refer to a VOD source.

  • clip_range(Option<ClipRange>):

    The clip range configuration settings.

  • duration_millis(Option<i64>):

    The duration of the live program in milliseconds.

  • audience_media(Option<Vec::<AudienceMedia>>):

    The list of AudienceMedia defined in program.

• On failure, responds with SdkError<DescribeProgramError>

impl Client

pub fn describe_source_location(&self) -> DescribeSourceLocationFluentBuilder

Constructs a fluent builder for the DescribeSourceLocation operation.

• The fluent builder is configurable:
  • source_location_name(impl Into<String>) / set_source_location_name(Option<String>):
    required: true
    

    The name of the source location.

    
    
• On success, responds with DescribeSourceLocationOutput with field(s):
  • access_configuration(Option<AccessConfiguration>):

    The access configuration for the source location.

  • arn(Option<String>):

    The ARN of the source location.

  • creation_time(Option<DateTime>):

    The timestamp that indicates when the source location was created.

  • default_segment_delivery_configuration(Option<DefaultSegmentDeliveryConfiguration>):

    The default segment delivery configuration settings.

  • http_configuration(Option<HttpConfiguration>):

    The HTTP package configuration settings for the source location.

  • last_modified_time(Option<DateTime>):

    The timestamp that indicates when the source location was last modified.

  • segment_delivery_configurations(Option<Vec::<SegmentDeliveryConfiguration>>):

    A list of the segment delivery configurations associated with this resource.

  • source_location_name(Option<String>):

    The name of the source location.

  • tags(Option<HashMap::<String, String>>):

    The tags assigned to the source location. Tags are key-value pairs that you can associate with Amazon resources to help with organization, access control, and cost tracking. For more information, see Tagging AWS Elemental MediaTailor Resources.

• On failure, responds with SdkError<DescribeSourceLocationError>

impl Client

pub fn describe_vod_source(&self) -> DescribeVodSourceFluentBuilder

Constructs a fluent builder for the DescribeVodSource operation.

• The fluent builder is configurable:
  • source_location_name(impl Into<String>) / set_source_location_name(Option<String>):
    required: true
    

    The name of the source location associated with this VOD Source.

    
    
  • vod_source_name(impl Into<String>) / set_vod_source_name(Option<String>):
    required: true
    

    The name of the VOD Source.

    
    
• On success, responds with DescribeVodSourceOutput with field(s):
  • ad_break_opportunities(Option<Vec::<AdBreakOpportunity>>):

    The ad break opportunities within the VOD source.

  • arn(Option<String>):

    The ARN of the VOD source.

  • creation_time(Option<DateTime>):

    The timestamp that indicates when the VOD source was created.

  • http_package_configurations(Option<Vec::<HttpPackageConfiguration>>):

    The HTTP package configurations.

  • last_modified_time(Option<DateTime>):

    The last modified time of the VOD source.

  • source_location_name(Option<String>):

    The name of the source location associated with the VOD source.

  • tags(Option<HashMap::<String, String>>):

    The tags assigned to the VOD source. Tags are key-value pairs that you can associate with Amazon resources to help with organization, access control, and cost tracking. For more information, see Tagging AWS Elemental MediaTailor Resources.

  • vod_source_name(Option<String>):

    The name of the VOD source.

• On failure, responds with SdkError<DescribeVodSourceError>

impl Client

pub fn get_channel_policy(&self) -> GetChannelPolicyFluentBuilder

Constructs a fluent builder for the GetChannelPolicy operation.

• The fluent builder is configurable:
  • channel_name(impl Into<String>) / set_channel_name(Option<String>):
    required: true
    

    The name of the channel associated with this Channel Policy.

    
    
• On success, responds with GetChannelPolicyOutput with field(s):
  • policy(Option<String>):

    The IAM policy for the channel. IAM policies are used to control access to your channel.

• On failure, responds with SdkError<GetChannelPolicyError>

impl Client

pub fn get_channel_schedule(&self) -> GetChannelScheduleFluentBuilder

Constructs a fluent builder for the GetChannelSchedule operation. This operation supports pagination; See into_paginator().

• The fluent builder is configurable:
  • channel_name(impl Into<String>) / set_channel_name(Option<String>):
    required: true
    

    The name of the channel associated with this Channel Schedule.

    
    
  • duration_minutes(impl Into<String>) / set_duration_minutes(Option<String>):
    required: false
    

    The duration in minutes of the channel schedule.

    
    
  • max_results(i32) / set_max_results(Option<i32>):
    required: false
    

    The maximum number of channel schedules that you want MediaTailor to return in response to the current request. If there are more than MaxResults channel schedules, use the value of NextToken in the response to get the next page of results.

    
    
  • next_token(impl Into<String>) / set_next_token(Option<String>):
    required: false
    

    (Optional) If the playback configuration has more than MaxResults channel schedules, use NextToken to get the second and subsequent pages of results.

    For the first GetChannelScheduleRequest request, omit this value.

    For the second and subsequent requests, get the value of NextToken from the previous response and specify that value for NextToken in the request.

    If the previous response didn’t include a NextToken element, there are no more channel schedules to get.

    
    
  • audience(impl Into<String>) / set_audience(Option<String>):
    required: false
    

    The single audience for GetChannelScheduleRequest.

    
    
• On success, responds with GetChannelScheduleOutput with field(s):
  • items(Option<Vec::<ScheduleEntry>>):

    A list of schedule entries for the channel.

  • next_token(Option<String>):

    Pagination token returned by the list request when results exceed the maximum allowed. Use the token to fetch the next page of results.

• On failure, responds with SdkError<GetChannelScheduleError>

impl Client

pub fn get_playback_configuration( &self, ) -> GetPlaybackConfigurationFluentBuilder

Constructs a fluent builder for the GetPlaybackConfiguration operation.

• The fluent builder is configurable:
  • name(impl Into<String>) / set_name(Option<String>):
    required: true
    

    The identifier for the playback configuration.

    
    
• On success, responds with GetPlaybackConfigurationOutput with field(s):
  • ad_decision_server_url(Option<String>):

    The URL for the ad decision server (ADS). This includes the specification of static parameters and placeholders for dynamic parameters. AWS Elemental MediaTailor substitutes player-specific and session-specific parameters as needed when calling the ADS. Alternately, for testing, you can provide a static VAST URL. The maximum length is 25,000 characters.

  • avail_suppression(Option<AvailSuppression>):

    The configuration for avail suppression, also known as ad suppression. For more information about ad suppression, see Ad Suppression.

  • bumper(Option<Bumper>):

    The configuration for bumpers. Bumpers are short audio or video clips that play at the start or before the end of an ad break. To learn more about bumpers, see Bumpers.

  • cdn_configuration(Option<CdnConfiguration>):

    The configuration for using a content delivery network (CDN), like Amazon CloudFront, for content and ad segment management.

  • configuration_aliases(Option<HashMap::<String, HashMap::<String, String>>>):

    The player parameters and aliases used as dynamic variables during session initialization. For more information, see Domain Variables.

  • dash_configuration(Option<DashConfiguration>):

    The configuration for DASH content.

  • hls_configuration(Option<HlsConfiguration>):

    The configuration for HLS content.

  • insertion_mode(InsertionMode):

    The setting that controls whether players can use stitched or guided ad insertion. The default, STITCHED_ONLY, forces all player sessions to use stitched (server-side) ad insertion. Choosing PLAYER_SELECT allows players to select either stitched or guided ad insertion at session-initialization time. The default for players that do not specify an insertion mode is stitched.

  • live_pre_roll_configuration(Option<LivePreRollConfiguration>):

    The configuration for pre-roll ad insertion.

  • log_configuration(Option<LogConfiguration>):

    The configuration that defines where AWS Elemental MediaTailor sends logs for the playback configuration.

  • manifest_processing_rules(Option<ManifestProcessingRules>):

    The configuration for manifest processing rules. Manifest processing rules enable customization of the personalized manifests created by MediaTailor.

  • name(Option<String>):

    The identifier for the playback configuration.

  • personalization_threshold_seconds(Option<i32>):

    Defines the maximum duration of underfilled ad time (in seconds) allowed in an ad break. If the duration of underfilled ad time exceeds the personalization threshold, then the personalization of the ad break is abandoned and the underlying content is shown. This feature applies to ad replacement in live and VOD streams, rather than ad insertion, because it relies on an underlying content stream. For more information about ad break behavior, including ad replacement and insertion, see Ad Behavior in AWS Elemental MediaTailor.

  • playback_configuration_arn(Option<String>):

    The Amazon Resource Name (ARN) for the playback configuration.

  • playback_endpoint_prefix(Option<String>):

    The URL that the player accesses to get a manifest from AWS Elemental MediaTailor. This session will use server-side reporting.

  • session_initialization_endpoint_prefix(Option<String>):

    The URL that the player uses to initialize a session that uses client-side reporting.

  • slate_ad_url(Option<String>):

    The URL for a high-quality video asset to transcode and use to fill in time that’s not used by ads. AWS Elemental MediaTailor shows the slate to fill in gaps in media content. Configuring the slate is optional for non-VPAID playback configurations. For VPAID, the slate is required because MediaTailor provides it in the slots designated for dynamic ad content. The slate must be a high-quality asset that contains both audio and video.

  • tags(Option<HashMap::<String, String>>):

    The tags assigned to the playback configuration. Tags are key-value pairs that you can associate with Amazon resources to help with organization, access control, and cost tracking. For more information, see Tagging AWS Elemental MediaTailor Resources.

  • transcode_profile_name(Option<String>):

    The name that is used to associate this playback configuration with a custom transcode profile. This overrides the dynamic transcoding defaults of MediaTailor. Use this only if you have already set up custom profiles with the help of AWS Support.

  • video_content_source_url(Option<String>):

    The URL prefix for the parent manifest for the stream, minus the asset ID. The maximum length is 512 characters.

  • ad_conditioning_configuration(Option<AdConditioningConfiguration>):

    The setting that indicates what conditioning MediaTailor will perform on ads that the ad decision server (ADS) returns, and what priority MediaTailor uses when inserting ads.

• On failure, responds with SdkError<GetPlaybackConfigurationError>

impl Client

pub fn get_prefetch_schedule(&self) -> GetPrefetchScheduleFluentBuilder

Constructs a fluent builder for the GetPrefetchSchedule operation.

• The fluent builder is configurable:
  • name(impl Into<String>) / set_name(Option<String>):
    required: true
    

    The name of the prefetch schedule. The name must be unique among all prefetch schedules that are associated with the specified playback configuration.

    
    
  • playback_configuration_name(impl Into<String>) / set_playback_configuration_name(Option<String>):
    required: true
    

    Returns information about the prefetch schedule for a specific playback configuration. If you call GetPrefetchSchedule on an expired prefetch schedule, MediaTailor returns an HTTP 404 status code.

    
    
• On success, responds with GetPrefetchScheduleOutput with field(s):
  • arn(Option<String>):

    The Amazon Resource Name (ARN) of the prefetch schedule.

  • consumption(Option<PrefetchConsumption>):

    The configuration settings for how and when MediaTailor consumes prefetched ads from the ad decision server for single prefetch schedules. Each consumption configuration contains an end time and an optional start time that define the consumption window. Prefetch schedules automatically expire no earlier than seven days after the end time.

  • name(Option<String>):

    The name of the prefetch schedule. The name must be unique among all prefetch schedules that are associated with the specified playback configuration.

  • playback_configuration_name(Option<String>):

    The name of the playback configuration to create the prefetch schedule for.

  • retrieval(Option<PrefetchRetrieval>):

    A complex type that contains settings for prefetch retrieval from the ad decision server (ADS).

  • schedule_type(Option<PrefetchScheduleType>):

    The frequency that MediaTailor creates prefetch schedules. SINGLE indicates that this schedule applies to one ad break. RECURRING indicates that MediaTailor automatically creates a schedule for each ad avail in a live event.

  • recurring_prefetch_configuration(Option<RecurringPrefetchConfiguration>):

    The configuration that defines how and when MediaTailor performs ad prefetching in a live event.

  • stream_id(Option<String>):

    An optional stream identifier that you can specify in order to prefetch for multiple streams that use the same playback configuration.

• On failure, responds with SdkError<GetPrefetchScheduleError>

impl Client

pub fn list_alerts(&self) -> ListAlertsFluentBuilder

Constructs a fluent builder for the ListAlerts operation. This operation supports pagination; See into_paginator().

• The fluent builder is configurable:
  • max_results(i32) / set_max_results(Option<i32>):
    required: false
    

    The maximum number of alerts that you want MediaTailor to return in response to the current request. If there are more than MaxResults alerts, use the value of NextToken in the response to get the next page of results.

    
    
  • next_token(impl Into<String>) / set_next_token(Option<String>):
    required: false
    

    Pagination token returned by the list request when results exceed the maximum allowed. Use the token to fetch the next page of results.

    
    
  • resource_arn(impl Into<String>) / set_resource_arn(Option<String>):
    required: true
    

    The Amazon Resource Name (ARN) of the resource.

    
    
• On success, responds with ListAlertsOutput with field(s):
  • items(Option<Vec::<Alert>>):

    A list of alerts that are associated with this resource.

  • next_token(Option<String>):

    Pagination token returned by the list request when results exceed the maximum allowed. Use the token to fetch the next page of results.

• On failure, responds with SdkError<ListAlertsError>

impl Client

pub fn list_channels(&self) -> ListChannelsFluentBuilder

Constructs a fluent builder for the ListChannels operation. This operation supports pagination; See into_paginator().

• The fluent builder is configurable:
  • max_results(i32) / set_max_results(Option<i32>):
    required: false
    

    The maximum number of channels that you want MediaTailor to return in response to the current request. If there are more than MaxResults channels, use the value of NextToken in the response to get the next page of results.

    
    
  • next_token(impl Into<String>) / set_next_token(Option<String>):
    required: false
    

    Pagination token returned by the list request when results exceed the maximum allowed. Use the token to fetch the next page of results.

    
    
• On success, responds with ListChannelsOutput with field(s):
  • items(Option<Vec::<Channel>>):

    A list of channels that are associated with this account.

  • next_token(Option<String>):

    Pagination token returned by the list request when results exceed the maximum allowed. Use the token to fetch the next page of results.

• On failure, responds with SdkError<ListChannelsError>

impl Client

pub fn list_live_sources(&self) -> ListLiveSourcesFluentBuilder

Constructs a fluent builder for the ListLiveSources operation. This operation supports pagination; See into_paginator().

• The fluent builder is configurable:
  • max_results(i32) / set_max_results(Option<i32>):
    required: false
    

    The maximum number of live sources that you want MediaTailor to return in response to the current request. If there are more than MaxResults live sources, use the value of NextToken in the response to get the next page of results.

    
    
  • next_token(impl Into<String>) / set_next_token(Option<String>):
    required: false
    

    Pagination token returned by the list request when results exceed the maximum allowed. Use the token to fetch the next page of results.

    
    
  • source_location_name(impl Into<String>) / set_source_location_name(Option<String>):
    required: true
    

    The name of the source location associated with this Live Sources list.

    
    
• On success, responds with ListLiveSourcesOutput with field(s):
  • items(Option<Vec::<LiveSource>>):

    Lists the live sources.

  • next_token(Option<String>):

    Pagination token returned by the list request when results exceed the maximum allowed. Use the token to fetch the next page of results.

• On failure, responds with SdkError<ListLiveSourcesError>

impl Client

pub fn list_playback_configurations( &self, ) -> ListPlaybackConfigurationsFluentBuilder

Constructs a fluent builder for the ListPlaybackConfigurations operation. This operation supports pagination; See into_paginator().

• The fluent builder is configurable:
  • max_results(i32) / set_max_results(Option<i32>):
    required: false
    

    The maximum number of playback configurations that you want MediaTailor to return in response to the current request. If there are more than MaxResults playback configurations, use the value of NextToken in the response to get the next page of results.

    
    
  • next_token(impl Into<String>) / set_next_token(Option<String>):
    required: false
    

    Pagination token returned by the list request when results exceed the maximum allowed. Use the token to fetch the next page of results.

    
    
• On success, responds with ListPlaybackConfigurationsOutput with field(s):
  • items(Option<Vec::<PlaybackConfiguration>>):

    Array of playback configurations. This might be all the available configurations or a subset, depending on the settings that you provide and the total number of configurations stored.

  • next_token(Option<String>):

    Pagination token returned by the GET list request when results exceed the maximum allowed. Use the token to fetch the next page of results.

• On failure, responds with SdkError<ListPlaybackConfigurationsError>

impl Client

pub fn list_prefetch_schedules(&self) -> ListPrefetchSchedulesFluentBuilder

Constructs a fluent builder for the ListPrefetchSchedules operation. This operation supports pagination; See into_paginator().

• The fluent builder is configurable:
  • max_results(i32) / set_max_results(Option<i32>):
    required: false
    

    The maximum number of prefetch schedules that you want MediaTailor to return in response to the current request. If there are more than MaxResults prefetch schedules, use the value of NextToken in the response to get the next page of results.

    
    
  • next_token(impl Into<String>) / set_next_token(Option<String>):
    required: false
    

    (Optional) If the playback configuration has more than MaxResults prefetch schedules, use NextToken to get the second and subsequent pages of results.

    For the first ListPrefetchSchedulesRequest request, omit this value.

    For the second and subsequent requests, get the value of NextToken from the previous response and specify that value for NextToken in the request.

    If the previous response didn’t include a NextToken element, there are no more prefetch schedules to get.

    
    
  • playback_configuration_name(impl Into<String>) / set_playback_configuration_name(Option<String>):
    required: true
    

    Retrieves the prefetch schedule(s) for a specific playback configuration.

    
    
  • schedule_type(ListPrefetchScheduleType) / set_schedule_type(Option<ListPrefetchScheduleType>):
    required: false
    

    The type of prefetch schedules that you want to list. SINGLE indicates that you want to list the configured single prefetch schedules. RECURRING indicates that you want to list the configured recurring prefetch schedules. ALL indicates that you want to list all configured prefetch schedules.

    
    
  • stream_id(impl Into<String>) / set_stream_id(Option<String>):
    required: false
    

    An optional filtering parameter whereby MediaTailor filters the prefetch schedules to include only specific streams.

    
    
• On success, responds with ListPrefetchSchedulesOutput with field(s):
  • items(Option<Vec::<PrefetchSchedule>>):

    Lists the prefetch schedules. An empty Items list doesn’t mean there aren’t more items to fetch, just that that page was empty.

  • next_token(Option<String>):

    Pagination token returned by the list request when results exceed the maximum allowed. Use the token to fetch the next page of results.

• On failure, responds with SdkError<ListPrefetchSchedulesError>

impl Client

pub fn list_source_locations(&self) -> ListSourceLocationsFluentBuilder

Constructs a fluent builder for the ListSourceLocations operation. This operation supports pagination; See into_paginator().

• The fluent builder is configurable:
  • max_results(i32) / set_max_results(Option<i32>):
    required: false
    

    The maximum number of source locations that you want MediaTailor to return in response to the current request. If there are more than MaxResults source locations, use the value of NextToken in the response to get the next page of results.

    
    
  • next_token(impl Into<String>) / set_next_token(Option<String>):
    required: false
    

    Pagination token returned by the list request when results exceed the maximum allowed. Use the token to fetch the next page of results.

    
    
• On success, responds with ListSourceLocationsOutput with field(s):
  • items(Option<Vec::<SourceLocation>>):

    A list of source locations.

  • next_token(Option<String>):

    Pagination token returned by the list request when results exceed the maximum allowed. Use the token to fetch the next page of results.

• On failure, responds with SdkError<ListSourceLocationsError>

impl Client

pub fn list_tags_for_resource(&self) -> ListTagsForResourceFluentBuilder

Constructs a fluent builder for the ListTagsForResource operation.

• The fluent builder is configurable:
  • resource_arn(impl Into<String>) / set_resource_arn(Option<String>):
    required: true
    

    The Amazon Resource Name (ARN) associated with this resource.

    
    
• On success, responds with ListTagsForResourceOutput with field(s):
  • tags(Option<HashMap::<String, String>>):

    The tags associated with this resource. Tags are key-value pairs that you can associate with Amazon resources to help with organization, access control, and cost tracking. For more information, see Tagging AWS Elemental MediaTailor Resources.

• On failure, responds with SdkError<ListTagsForResourceError>

impl Client

pub fn list_vod_sources(&self) -> ListVodSourcesFluentBuilder

Constructs a fluent builder for the ListVodSources operation. This operation supports pagination; See into_paginator().

• The fluent builder is configurable:
  • max_results(i32) / set_max_results(Option<i32>):
    required: false
    

    The maximum number of VOD sources that you want MediaTailor to return in response to the current request. If there are more than MaxResults VOD sources, use the value of NextToken in the response to get the next page of results.

    
    
  • next_token(impl Into<String>) / set_next_token(Option<String>):
    required: false
    

    Pagination token returned by the list request when results exceed the maximum allowed. Use the token to fetch the next page of results.

    
    
  • source_location_name(impl Into<String>) / set_source_location_name(Option<String>):
    required: true
    

    The name of the source location associated with this VOD Source list.

    
    
• On success, responds with ListVodSourcesOutput with field(s):
  • items(Option<Vec::<VodSource>>):

    Lists the VOD sources.

  • next_token(Option<String>):

    Pagination token returned by the list request when results exceed the maximum allowed. Use the token to fetch the next page of results.

• On failure, responds with SdkError<ListVodSourcesError>

impl Client

pub fn put_channel_policy(&self) -> PutChannelPolicyFluentBuilder

Constructs a fluent builder for the PutChannelPolicy operation.

• The fluent builder is configurable:
  • channel_name(impl Into<String>) / set_channel_name(Option<String>):
    required: true
    

    The channel name associated with this Channel Policy.

    
    
  • policy(impl Into<String>) / set_policy(Option<String>):
    required: true
    

    Adds an IAM role that determines the permissions of your channel.

    
    
• On success, responds with PutChannelPolicyOutput
• On failure, responds with SdkError<PutChannelPolicyError>

impl Client

pub fn put_playback_configuration( &self, ) -> PutPlaybackConfigurationFluentBuilder

Constructs a fluent builder for the PutPlaybackConfiguration operation.

• The fluent builder is configurable:
  • ad_decision_server_url(impl Into<String>) / set_ad_decision_server_url(Option<String>):
    required: false
    

    The URL for the ad decision server (ADS). This includes the specification of static parameters and placeholders for dynamic parameters. AWS Elemental MediaTailor substitutes player-specific and session-specific parameters as needed when calling the ADS. Alternately, for testing you can provide a static VAST URL. The maximum length is 25,000 characters.

    
    
  • avail_suppression(AvailSuppression) / set_avail_suppression(Option<AvailSuppression>):
    required: false
    

    The configuration for avail suppression, also known as ad suppression. For more information about ad suppression, see Ad Suppression.

    
    
  • bumper(Bumper) / set_bumper(Option<Bumper>):
    required: false
    

    The configuration for bumpers. Bumpers are short audio or video clips that play at the start or before the end of an ad break. To learn more about bumpers, see Bumpers.

    
    
  • cdn_configuration(CdnConfiguration) / set_cdn_configuration(Option<CdnConfiguration>):
    required: false
    

    The configuration for using a content delivery network (CDN), like Amazon CloudFront, for content and ad segment management.

    
    
  • configuration_aliases(impl Into<String>, HashMap::<String, String>) / set_configuration_aliases(Option<HashMap::<String, HashMap::<String, String>>>):
    required: false
    

    The player parameters and aliases used as dynamic variables during session initialization. For more information, see Domain Variables.

    
    
  • dash_configuration(DashConfigurationForPut) / set_dash_configuration(Option<DashConfigurationForPut>):
    required: false
    

    The configuration for DASH content.

    
    
  • insertion_mode(InsertionMode) / set_insertion_mode(Option<InsertionMode>):
    required: false
    

    The setting that controls whether players can use stitched or guided ad insertion. The default, STITCHED_ONLY, forces all player sessions to use stitched (server-side) ad insertion. Choosing PLAYER_SELECT allows players to select either stitched or guided ad insertion at session-initialization time. The default for players that do not specify an insertion mode is stitched.

    
    
  • live_pre_roll_configuration(LivePreRollConfiguration) / set_live_pre_roll_configuration(Option<LivePreRollConfiguration>):
    required: false
    

    The configuration for pre-roll ad insertion.

    
    
  • manifest_processing_rules(ManifestProcessingRules) / set_manifest_processing_rules(Option<ManifestProcessingRules>):
    required: false
    

    The configuration for manifest processing rules. Manifest processing rules enable customization of the personalized manifests created by MediaTailor.

    
    
  • name(impl Into<String>) / set_name(Option<String>):
    required: true
    

    The identifier for the playback configuration.

    
    
  • personalization_threshold_seconds(i32) / set_personalization_threshold_seconds(Option<i32>):
    required: false
    

    Defines the maximum duration of underfilled ad time (in seconds) allowed in an ad break. If the duration of underfilled ad time exceeds the personalization threshold, then the personalization of the ad break is abandoned and the underlying content is shown. This feature applies to ad replacement in live and VOD streams, rather than ad insertion, because it relies on an underlying content stream. For more information about ad break behavior, including ad replacement and insertion, see Ad Behavior in AWS Elemental MediaTailor.

    
    
  • slate_ad_url(impl Into<String>) / set_slate_ad_url(Option<String>):
    required: false
    

    The URL for a high-quality video asset to transcode and use to fill in time that’s not used by ads. AWS Elemental MediaTailor shows the slate to fill in gaps in media content. Configuring the slate is optional for non-VPAID configurations. For VPAID, the slate is required because MediaTailor provides it in the slots that are designated for dynamic ad content. The slate must be a high-quality asset that contains both audio and video.

    
    
  • tags(impl Into<String>, impl Into<String>) / set_tags(Option<HashMap::<String, String>>):
    required: false
    

    The tags to assign to the playback configuration. Tags are key-value pairs that you can associate with Amazon resources to help with organization, access control, and cost tracking. For more information, see Tagging AWS Elemental MediaTailor Resources.

    
    
  • transcode_profile_name(impl Into<String>) / set_transcode_profile_name(Option<String>):
    required: false
    

    The name that is used to associate this playback configuration with a custom transcode profile. This overrides the dynamic transcoding defaults of MediaTailor. Use this only if you have already set up custom profiles with the help of AWS Support.

    
    
  • video_content_source_url(impl Into<String>) / set_video_content_source_url(Option<String>):
    required: false
    

    The URL prefix for the parent manifest for the stream, minus the asset ID. The maximum length is 512 characters.

    
    
  • ad_conditioning_configuration(AdConditioningConfiguration) / set_ad_conditioning_configuration(Option<AdConditioningConfiguration>):
    required: false
    

    The setting that indicates what conditioning MediaTailor will perform on ads that the ad decision server (ADS) returns, and what priority MediaTailor uses when inserting ads.

    
    
• On success, responds with PutPlaybackConfigurationOutput with field(s):
  • ad_decision_server_url(Option<String>):

    The URL for the ad decision server (ADS). This includes the specification of static parameters and placeholders for dynamic parameters. AWS Elemental MediaTailor substitutes player-specific and session-specific parameters as needed when calling the ADS. Alternately, for testing you can provide a static VAST URL. The maximum length is 25,000 characters.

  • avail_suppression(Option<AvailSuppression>):

    The configuration for avail suppression, also known as ad suppression. For more information about ad suppression, see Ad Suppression.

  • bumper(Option<Bumper>):

    The configuration for bumpers. Bumpers are short audio or video clips that play at the start or before the end of an ad break. To learn more about bumpers, see Bumpers.

  • cdn_configuration(Option<CdnConfiguration>):

    The configuration for using a content delivery network (CDN), like Amazon CloudFront, for content and ad segment management.

  • configuration_aliases(Option<HashMap::<String, HashMap::<String, String>>>):

    The player parameters and aliases used as dynamic variables during session initialization. For more information, see Domain Variables.

  • dash_configuration(Option<DashConfiguration>):

    The configuration for DASH content.

  • hls_configuration(Option<HlsConfiguration>):

    The configuration for HLS content.

  • insertion_mode(InsertionMode):

    The setting that controls whether players can use stitched or guided ad insertion. The default, STITCHED_ONLY, forces all player sessions to use stitched (server-side) ad insertion. Choosing PLAYER_SELECT allows players to select either stitched or guided ad insertion at session-initialization time. The default for players that do not specify an insertion mode is stitched.

  • live_pre_roll_configuration(Option<LivePreRollConfiguration>):

    The configuration for pre-roll ad insertion.

  • log_configuration(Option<LogConfiguration>):

    The configuration that defines where AWS Elemental MediaTailor sends logs for the playback configuration.

  • manifest_processing_rules(Option<ManifestProcessingRules>):

    The configuration for manifest processing rules. Manifest processing rules enable customization of the personalized manifests created by MediaTailor.

  • name(Option<String>):

    The identifier for the playback configuration.

  • personalization_threshold_seconds(Option<i32>):

    Defines the maximum duration of underfilled ad time (in seconds) allowed in an ad break. If the duration of underfilled ad time exceeds the personalization threshold, then the personalization of the ad break is abandoned and the underlying content is shown. This feature applies to ad replacement in live and VOD streams, rather than ad insertion, because it relies on an underlying content stream. For more information about ad break behavior, including ad replacement and insertion, see Ad Behavior in AWS Elemental MediaTailor.

  • playback_configuration_arn(Option<String>):

    The Amazon Resource Name (ARN) associated with the playback configuration.

  • playback_endpoint_prefix(Option<String>):

    The playback endpoint prefix associated with the playback configuration.

  • session_initialization_endpoint_prefix(Option<String>):

    The session initialization endpoint prefix associated with the playback configuration.

  • slate_ad_url(Option<String>):

    The URL for a high-quality video asset to transcode and use to fill in time that’s not used by ads. AWS Elemental MediaTailor shows the slate to fill in gaps in media content. Configuring the slate is optional for non-VPAID configurations. For VPAID, the slate is required because MediaTailor provides it in the slots that are designated for dynamic ad content. The slate must be a high-quality asset that contains both audio and video.

  • tags(Option<HashMap::<String, String>>):

    The tags to assign to the playback configuration. Tags are key-value pairs that you can associate with Amazon resources to help with organization, access control, and cost tracking. For more information, see Tagging AWS Elemental MediaTailor Resources.

  • transcode_profile_name(Option<String>):

    The name that is used to associate this playback configuration with a custom transcode profile. This overrides the dynamic transcoding defaults of MediaTailor. Use this only if you have already set up custom profiles with the help of AWS Support.

  • video_content_source_url(Option<String>):

    The URL prefix for the parent manifest for the stream, minus the asset ID. The maximum length is 512 characters.

  • ad_conditioning_configuration(Option<AdConditioningConfiguration>):

    The setting that indicates what conditioning MediaTailor will perform on ads that the ad decision server (ADS) returns, and what priority MediaTailor uses when inserting ads.

• On failure, responds with SdkError<PutPlaybackConfigurationError>

impl Client

pub fn start_channel(&self) -> StartChannelFluentBuilder

Constructs a fluent builder for the StartChannel operation.

• The fluent builder is configurable:
  • channel_name(impl Into<String>) / set_channel_name(Option<String>):
    required: true
    

    The name of the channel.

    
    
• On success, responds with StartChannelOutput
• On failure, responds with SdkError<StartChannelError>

impl Client

pub fn stop_channel(&self) -> StopChannelFluentBuilder

Constructs a fluent builder for the StopChannel operation.

• The fluent builder is configurable:
  • channel_name(impl Into<String>) / set_channel_name(Option<String>):
    required: true
    

    The name of the channel.

    
    
• On success, responds with StopChannelOutput
• On failure, responds with SdkError<StopChannelError>

impl Client

pub fn tag_resource(&self) -> TagResourceFluentBuilder

Constructs a fluent builder for the TagResource operation.

• The fluent builder is configurable:
  • resource_arn(impl Into<String>) / set_resource_arn(Option<String>):
    required: true
    

    The Amazon Resource Name (ARN) associated with the resource.

    
    
  • tags(impl Into<String>, impl Into<String>) / set_tags(Option<HashMap::<String, String>>):
    required: true
    

    The tags to assign to the resource. Tags are key-value pairs that you can associate with Amazon resources to help with organization, access control, and cost tracking. For more information, see Tagging AWS Elemental MediaTailor Resources.

    
    
• On success, responds with TagResourceOutput
• On failure, responds with SdkError<TagResourceError>

impl Client

pub fn untag_resource(&self) -> UntagResourceFluentBuilder

Constructs a fluent builder for the UntagResource operation.

• The fluent builder is configurable:
  • resource_arn(impl Into<String>) / set_resource_arn(Option<String>):
    required: true
    

    The Amazon Resource Name (ARN) of the resource to untag.

    
    
  • tag_keys(impl Into<String>) / set_tag_keys(Option<Vec::<String>>):
    required: true
    

    The tag keys associated with the resource.

    
    
• On success, responds with UntagResourceOutput
• On failure, responds with SdkError<UntagResourceError>

impl Client

pub fn update_channel(&self) -> UpdateChannelFluentBuilder

Constructs a fluent builder for the UpdateChannel operation.

• The fluent builder is configurable:
  • channel_name(impl Into<String>) / set_channel_name(Option<String>):
    required: true
    

    The name of the channel.

    
    
  • filler_slate(SlateSource) / set_filler_slate(Option<SlateSource>):
    required: false
    

    The slate used to fill gaps between programs in the schedule. You must configure filler slate if your channel uses the LINEAR PlaybackMode. MediaTailor doesn’t support filler slate for channels using the LOOP PlaybackMode.

    
    
  • outputs(RequestOutputItem) / set_outputs(Option<Vec::<RequestOutputItem>>):
    required: true
    

    The channel’s output properties.

    
    
  • time_shift_configuration(TimeShiftConfiguration) / set_time_shift_configuration(Option<TimeShiftConfiguration>):
    required: false
    

    The time-shifted viewing configuration you want to associate to the channel.

    
    
  • audiences(impl Into<String>) / set_audiences(Option<Vec::<String>>):
    required: false
    

    The list of audiences defined in channel.

    
    
• On success, responds with UpdateChannelOutput with field(s):
  • arn(Option<String>):

    The Amazon Resource Name (ARN) associated with the channel.

  • channel_name(Option<String>):

    The name of the channel.

  • channel_state(Option<ChannelState>):

    Returns the state whether the channel is running or not.

  • creation_time(Option<DateTime>):

    The timestamp of when the channel was created.

  • filler_slate(Option<SlateSource>):

    The slate used to fill gaps between programs in the schedule. You must configure filler slate if your channel uses the LINEAR PlaybackMode. MediaTailor doesn’t support filler slate for channels using the LOOP PlaybackMode.

  • last_modified_time(Option<DateTime>):

    The timestamp that indicates when the channel was last modified.

  • outputs(Option<Vec::<ResponseOutputItem>>):

    The channel’s output properties.

  • playback_mode(Option<String>):

    The type of playback mode for this channel.

    LINEAR - Programs play back-to-back only once.

    LOOP - Programs play back-to-back in an endless loop. When the last program in the schedule plays, playback loops back to the first program in the schedule.

  • tags(Option<HashMap::<String, String>>):

    The tags to assign to the channel. Tags are key-value pairs that you can associate with Amazon resources to help with organization, access control, and cost tracking. For more information, see Tagging AWS Elemental MediaTailor Resources.

  • tier(Option<String>):

    The tier associated with this Channel.

  • time_shift_configuration(Option<TimeShiftConfiguration>):

    The time-shifted viewing configuration for the channel.

  • audiences(Option<Vec::<String>>):

    The list of audiences defined in channel.

• On failure, responds with SdkError<UpdateChannelError>

impl Client

pub fn update_live_source(&self) -> UpdateLiveSourceFluentBuilder

Constructs a fluent builder for the UpdateLiveSource operation.

• The fluent builder is configurable:
  • http_package_configurations(HttpPackageConfiguration) / set_http_package_configurations(Option<Vec::<HttpPackageConfiguration>>):
    required: true
    

    A list of HTTP package configurations for the live source on this account.

    
    
  • live_source_name(impl Into<String>) / set_live_source_name(Option<String>):
    required: true
    

    The name of the live source.

    
    
  • source_location_name(impl Into<String>) / set_source_location_name(Option<String>):
    required: true
    

    The name of the source location associated with this Live Source.

    
    
• On success, responds with UpdateLiveSourceOutput with field(s):
  • arn(Option<String>):

    The Amazon Resource Name (ARN) associated with this live source.

  • creation_time(Option<DateTime>):

    The timestamp that indicates when the live source was created.

  • http_package_configurations(Option<Vec::<HttpPackageConfiguration>>):

    A list of HTTP package configurations for the live source on this account.

  • last_modified_time(Option<DateTime>):

    The timestamp that indicates when the live source was last modified.

  • live_source_name(Option<String>):

    The name of the live source.

  • source_location_name(Option<String>):

    The name of the source location associated with the live source.

  • tags(Option<HashMap::<String, String>>):

    The tags to assign to the live source. Tags are key-value pairs that you can associate with Amazon resources to help with organization, access control, and cost tracking. For more information, see Tagging AWS Elemental MediaTailor Resources.

• On failure, responds with SdkError<UpdateLiveSourceError>

impl Client

pub fn update_program(&self) -> UpdateProgramFluentBuilder

Constructs a fluent builder for the UpdateProgram operation.

• The fluent builder is configurable:
  • ad_breaks(AdBreak) / set_ad_breaks(Option<Vec::<AdBreak>>):
    required: false
    

    The ad break configuration settings.

    
    
  • channel_name(impl Into<String>) / set_channel_name(Option<String>):
    required: true
    

    The name of the channel for this Program.

    
    
  • program_name(impl Into<String>) / set_program_name(Option<String>):
    required: true
    

    The name of the Program.

    
    
  • schedule_configuration(UpdateProgramScheduleConfiguration) / set_schedule_configuration(Option<UpdateProgramScheduleConfiguration>):
    required: true
    

    The schedule configuration settings.

    
    
  • audience_media(AudienceMedia) / set_audience_media(Option<Vec::<AudienceMedia>>):
    required: false
    

    The list of AudienceMedia defined in program.

    
    
• On success, responds with UpdateProgramOutput with field(s):
  • ad_breaks(Option<Vec::<AdBreak>>):

    The ad break configuration settings.

  • arn(Option<String>):

    The ARN to assign to the program.

  • channel_name(Option<String>):

    The name to assign to the channel for this program.

  • creation_time(Option<DateTime>):

    The time the program was created.

  • program_name(Option<String>):

    The name to assign to this program.

  • source_location_name(Option<String>):

    The name to assign to the source location for this program.

  • vod_source_name(Option<String>):

    The name that’s used to refer to a VOD source.

  • live_source_name(Option<String>):

    The name of the LiveSource for this Program.

  • clip_range(Option<ClipRange>):

    The clip range configuration settings.

  • duration_millis(Option<i64>):

    The duration of the live program in milliseconds.

  • scheduled_start_time(Option<DateTime>):

    The scheduled start time for this Program.

  • audience_media(Option<Vec::<AudienceMedia>>):

    The list of AudienceMedia defined in program.

• On failure, responds with SdkError<UpdateProgramError>

impl Client

pub fn update_source_location(&self) -> UpdateSourceLocationFluentBuilder

Constructs a fluent builder for the UpdateSourceLocation operation.

• The fluent builder is configurable:
  • access_configuration(AccessConfiguration) / set_access_configuration(Option<AccessConfiguration>):
    required: false
    

    Access configuration parameters. Configures the type of authentication used to access content from your source location.

    
    
  • default_segment_delivery_configuration(DefaultSegmentDeliveryConfiguration) / set_default_segment_delivery_configuration(Option<DefaultSegmentDeliveryConfiguration>):
    required: false
    

    The optional configuration for the host server that serves segments.

    
    
  • http_configuration(HttpConfiguration) / set_http_configuration(Option<HttpConfiguration>):
    required: true
    

    The HTTP configuration for the source location.

    
    
  • segment_delivery_configurations(SegmentDeliveryConfiguration) / set_segment_delivery_configurations(Option<Vec::<SegmentDeliveryConfiguration>>):
    required: false
    

    A list of the segment delivery configurations associated with this resource.

    
    
  • source_location_name(impl Into<String>) / set_source_location_name(Option<String>):
    required: true
    

    The name of the source location.

    
    
• On success, responds with UpdateSourceLocationOutput with field(s):
  • access_configuration(Option<AccessConfiguration>):

    Access configuration parameters. Configures the type of authentication used to access content from your source location.

  • arn(Option<String>):

    The Amazon Resource Name (ARN) associated with the source location.

  • creation_time(Option<DateTime>):

    The timestamp that indicates when the source location was created.

  • default_segment_delivery_configuration(Option<DefaultSegmentDeliveryConfiguration>):

    The optional configuration for the host server that serves segments.

  • http_configuration(Option<HttpConfiguration>):

    The HTTP configuration for the source location.

  • last_modified_time(Option<DateTime>):

    The timestamp that indicates when the source location was last modified.

  • segment_delivery_configurations(Option<Vec::<SegmentDeliveryConfiguration>>):

    The segment delivery configurations for the source location. For information about MediaTailor configurations, see Working with configurations in AWS Elemental MediaTailor.

  • source_location_name(Option<String>):

    The name of the source location.

  • tags(Option<HashMap::<String, String>>):

    The tags to assign to the source location. Tags are key-value pairs that you can associate with Amazon resources to help with organization, access control, and cost tracking. For more information, see Tagging AWS Elemental MediaTailor Resources.

• On failure, responds with SdkError<UpdateSourceLocationError>

impl Client

pub fn update_vod_source(&self) -> UpdateVodSourceFluentBuilder

Constructs a fluent builder for the UpdateVodSource operation.

• The fluent builder is configurable:
  • http_package_configurations(HttpPackageConfiguration) / set_http_package_configurations(Option<Vec::<HttpPackageConfiguration>>):
    required: true
    

    A list of HTTP package configurations for the VOD source on this account.

    
    
  • source_location_name(impl Into<String>) / set_source_location_name(Option<String>):
    required: true
    

    The name of the source location associated with this VOD Source.

    
    
  • vod_source_name(impl Into<String>) / set_vod_source_name(Option<String>):
    required: true
    

    The name of the VOD source.

    
    
• On success, responds with UpdateVodSourceOutput with field(s):
  • arn(Option<String>):

    The Amazon Resource Name (ARN) associated with the VOD source.

  • creation_time(Option<DateTime>):

    The timestamp that indicates when the VOD source was created.

  • http_package_configurations(Option<Vec::<HttpPackageConfiguration>>):

    A list of HTTP package configurations for the VOD source on this account.

  • last_modified_time(Option<DateTime>):

    The timestamp that indicates when the VOD source was last modified.

  • source_location_name(Option<String>):

    The name of the source location associated with the VOD source.

  • tags(Option<HashMap::<String, String>>):

    The tags to assign to the VOD source. Tags are key-value pairs that you can associate with Amazon resources to help with organization, access control, and cost tracking. For more information, see Tagging AWS Elemental MediaTailor Resources.

  • vod_source_name(Option<String>):

    The name of the VOD source.

• On failure, responds with SdkError<UpdateVodSourceError>

impl Client

pub fn from_conf(conf: Config) -> Self

Creates a new client from the service Config.

Panics

This method will panic in the following cases:

• Retries or timeouts are enabled without a sleep_impl configured.
• Identity caching is enabled without a sleep_impl and time_source configured.
• No behavior_version is provided.

The panic message for each of these will have instructions on how to resolve them.

pub fn config(&self) -> &Config

Returns the client’s configuration.

impl Client

pub fn new(sdk_config: &SdkConfig) -> Self

Creates a new client from an SDK Config.

Panics

• This method will panic if the sdk_config is missing an async sleep implementation. If you experience this panic, set the sleep_impl on the Config passed into this function to fix it.
• This method will panic if the sdk_config is missing an HTTP connector. If you experience this panic, set the http_connector on the Config passed into this function to fix it.
• This method will panic if no BehaviorVersion is provided. If you experience this panic, set behavior_version on the Config or enable the behavior-version-latest Cargo feature.

Trait Implementations

impl Clone for Client

fn clone(&self) -> Client

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for Client

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.