Amazon.PowerShell.Cmdlets.EMT.AmazonMediaTailorClientCmdlet.ClientConfig
Required? | False |
Position? | Named |
Accept pipeline input? | True (ByPropertyName) |
If you only want MediaTailor to insert prefetched ads into avails (ad breaks) that match specific dynamic variables, such as scte.event_id, set the avail matching criteria.
Required? | False |
Position? | Named |
Accept pipeline input? | True (ByPropertyName) |
Aliases | Consumption_AvailMatchingCriteria |
-Consumption_EndTime <DateTime>
The time when MediaTailor no longer considers the prefetched ads for use in an ad break. MediaTailor automatically deletes prefetch schedules no less than seven days after the end time. If you'd like to manually delete the prefetch schedule, you can call DeletePrefetchSchedule.
Required? | True |
Position? | Named |
Accept pipeline input? | True (ByPropertyName) |
-Consumption_StartTime <DateTime>
The time when prefetched ads are considered for use in an ad break. If you don't specify StartTime, the prefetched ads are available after MediaTailor retrives them from the ad decision server.
Required? | False |
Position? | Named |
Accept pipeline input? | True (ByPropertyName) |
This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution.
Required? | False |
Position? | Named |
Accept pipeline input? | True (ByPropertyName) |
The name to assign to the schedule request.
Required? | True |
Position? | 1 |
Accept pipeline input? | True (ByValue, ByPropertyName) |
Changes the cmdlet behavior to return the value passed to the Name parameter. The -PassThru parameter is deprecated, use -Select '^Name' instead. This parameter will be removed in a future version.
Required? | False |
Position? | Named |
Accept pipeline input? | True (ByPropertyName) |
-PlaybackConfigurationName <
String>
The name to assign to the playback configuration.
Required? | True |
Position? | Named |
Accept pipeline input? | True (ByPropertyName) |
The dynamic variables to use for substitution during prefetch requests to the ad decision server (ADS).You initially configure
dynamic variables for the ADS URL when you set up your playback configuration. When you specify
DynamicVariables for prefetch retrieval, MediaTailor includes the dynamic variables in the request to the ADS.
Required? | False |
Position? | Named |
Accept pipeline input? | True (ByPropertyName) |
Aliases | Retrieval_DynamicVariables |
-Retrieval_EndTime <DateTime>
The time when prefetch retrieval ends for the ad break. Prefetching will be attempted for manifest requests that occur at or before this time.
Required? | True |
Position? | Named |
Accept pipeline input? | True (ByPropertyName) |
-Retrieval_StartTime <DateTime>
The time when prefetch retrievals can start for this break. Ad prefetching will be attempted for manifest requests that occur at or after this time. Defaults to the current time. If not specified, the prefetch retrieval starts as soon as possible.
Required? | False |
Position? | Named |
Accept pipeline input? | True (ByPropertyName) |
Use the -Select parameter to control the cmdlet output. The default value is '*'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.MediaTailor.Model.CreatePrefetchScheduleResponse). Specifying the name of a property of type Amazon.MediaTailor.Model.CreatePrefetchScheduleResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value.
Required? | False |
Position? | Named |
Accept pipeline input? | True (ByPropertyName) |
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.
Required? | False |
Position? | Named |
Accept pipeline input? | True (ByPropertyName) |