IVS / Client / insert_ad_break

insert_ad_break¶

IVS.Client.insert_ad_break(**kwargs)¶

Inserts an ad marker in the playlist for the specified channel and duration using the ad configuration associated with the channel.

Note: AWS Elemental MediaTailor (EMT), the service that handles ad requests, provides CloudWatch metrics to help you monitor the success or failure of each InsertAdBreak operation. See Monitoring AWS Elemental MediaTailor with Amazon CloudWatch metrics in the AWS Elemental MediaTailor User Guide for details on available metrics.

Request Syntax

response = client.insert_ad_break(
    channelArn='string',
    durationSeconds=123
)

Parameters:

channelArn (string) –
[REQUIRED]

ARN of the channel into which the ad break is inserted.
durationSeconds (integer) –
[REQUIRED]

Maximum duration of the ad break, in seconds.

Return type:

dict

Returns:

Response Syntax

{
    'adBreakId': 'string'
}

Response Structure

(dict) –
- adBreakId (string) –
  
  Unique identifier for the ad break that was inserted into the playlist.

Exceptions

IVS.Client.exceptions.ResourceNotFoundException
IVS.Client.exceptions.InternalServerException
IVS.Client.exceptions.AccessDeniedException
IVS.Client.exceptions.ValidationException
IVS.Client.exceptions.ChannelNotBroadcasting
IVS.Client.exceptions.ThrottlingException
IVS.Client.exceptions.ConflictException