AWS Tools for Windows PowerShell
Command Reference

AWS services or capabilities described in AWS Documentation may vary by region/location. Click Getting Started with Amazon AWS to see specific differences applicable to the China (Beijing) Region.

Synopsis

Calls the AWS Elemental MediaTailor CreatePrefetchSchedule API operation.

Syntax

New-EMTPrefetchSchedule
-Name <String>
-Consumption_AvailMatchingCriterion <AvailMatchingCriteria[]>
-RecurringConsumption_AvailMatchingCriterion <AvailMatchingCriteria[]>
-RecurringRetrieval_DelayAfterAvailEndSecond <Int32>
-RecurringRetrieval_DynamicVariable <Hashtable>
-Retrieval_DynamicVariable <Hashtable>
-Consumption_EndTime <DateTime>
-RecurringPrefetchConfiguration_EndTime <DateTime>
-Retrieval_EndTime <DateTime>
-RecurringPrefetchConfiguration_RecurringRetrieval_TrafficShapingTpsConfiguration_PeakConcurrentUsers <Int32>
-Retrieval_TrafficShapingTpsConfiguration_PeakConcurrentUsers <Int32>
-RecurringPrefetchConfiguration_RecurringRetrieval_TrafficShapingTpsConfiguration_PeakTps <Int32>
-Retrieval_TrafficShapingTpsConfiguration_PeakTps <Int32>
-PlaybackConfigurationName <String>
-RecurringTrafficShaping_WindowDurationSeconds <Int32>
-TrafficShaping_WindowDurationSeconds <Int32>
-RecurringConsumption_RetrievedAdExpirationSecond <Int32>
-ScheduleType <PrefetchScheduleType>
-Consumption_StartTime <DateTime>
-RecurringPrefetchConfiguration_StartTime <DateTime>
-Retrieval_StartTime <DateTime>
-StreamId <String>
-RecurringRetrieval_TrafficShapingType <TrafficShapingType>
-Retrieval_TrafficShapingType <TrafficShapingType>
-Select <String>
-PassThru <SwitchParameter>
-Force <SwitchParameter>
-ClientConfig <AmazonMediaTailorConfig>

Description

Creates a prefetch schedule for a playback configuration. A prefetch schedule allows you to tell MediaTailor to fetch and prepare certain ads before an ad break happens. For more information about ad prefetching, see Using ad prefetching in the MediaTailor User Guide.

Parameters

-ClientConfig <AmazonMediaTailorConfig>
Amazon.PowerShell.Cmdlets.EMT.AmazonMediaTailorClientCmdlet.ClientConfig
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-Consumption_AvailMatchingCriterion <AvailMatchingCriteria[]>
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)
AliasesConsumption_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?False
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 retrieves them from the ad decision server.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-Force <SwitchParameter>
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)
-Name <String>
The name to assign to the schedule request.
Required?True
Position?1
Accept pipeline input?True (ByValue, ByPropertyName)
-PassThru <SwitchParameter>
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)
-RecurringConsumption_AvailMatchingCriterion <AvailMatchingCriteria[]>
The configuration for the dynamic variables that determine which ad breaks that MediaTailor inserts prefetched ads in.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesRecurringPrefetchConfiguration_RecurringConsumption_AvailMatchingCriteria
-RecurringConsumption_RetrievedAdExpirationSecond <Int32>
The number of seconds that an ad is available for insertion after it was prefetched.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesRecurringPrefetchConfiguration_RecurringConsumption_RetrievedAdExpirationSeconds
-RecurringPrefetchConfiguration_EndTime <DateTime>
The end time for the window that MediaTailor prefetches and inserts ads in a live event.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-RecurringPrefetchConfiguration_RecurringRetrieval_TrafficShapingTpsConfiguration_PeakConcurrentUsers <Int32>
The expected peak number of concurrent viewers for your content. MediaTailor uses this value along with peak TPS to determine how to distribute prefetch requests across the available capacity without exceeding your ADS limits.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-RecurringPrefetchConfiguration_RecurringRetrieval_TrafficShapingTpsConfiguration_PeakTps <Int32>
The maximum number of transactions per second (TPS) that your ad decision server (ADS) can handle. MediaTailor uses this value along with concurrent users and headroom multiplier to calculate optimal traffic distribution and prevent ADS overload.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-RecurringPrefetchConfiguration_StartTime <DateTime>
The start time for the window that MediaTailor prefetches and inserts ads in a live event.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-RecurringRetrieval_DelayAfterAvailEndSecond <Int32>
The number of seconds that MediaTailor waits after an ad avail before prefetching ads for the next avail. If not set, the default is 0 (no delay).
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesRecurringPrefetchConfiguration_RecurringRetrieval_DelayAfterAvailEndSeconds
-RecurringRetrieval_DynamicVariable <Hashtable>
The dynamic variables to use for substitution during prefetch requests to the ADS.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesRecurringPrefetchConfiguration_RecurringRetrieval_DynamicVariables
-RecurringRetrieval_TrafficShapingType <TrafficShapingType>
Indicates the type of traffic shaping used to limit the number of requests to the ADS at one time.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesRecurringPrefetchConfiguration_RecurringRetrieval_TrafficShapingType
-RecurringTrafficShaping_WindowDurationSeconds <Int32>
The amount of time, in seconds, that MediaTailor spreads prefetch requests to the ADS.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesRecurringPrefetchConfiguration_RecurringRetrieval_TrafficShapingRetrievalWindow_RetrievalWindowDurationSeconds, RecurringTrafficShaping_RetrievalWindowDurationSeconds
-Retrieval_DynamicVariable <Hashtable>
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)
AliasesRetrieval_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?False
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)
-Retrieval_TrafficShapingTpsConfiguration_PeakConcurrentUsers <Int32>
The expected peak number of concurrent viewers for your content. MediaTailor uses this value along with peak TPS to determine how to distribute prefetch requests across the available capacity without exceeding your ADS limits.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-Retrieval_TrafficShapingTpsConfiguration_PeakTps <Int32>
The maximum number of transactions per second (TPS) that your ad decision server (ADS) can handle. MediaTailor uses this value along with concurrent users and headroom multiplier to calculate optimal traffic distribution and prevent ADS overload.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-Retrieval_TrafficShapingType <TrafficShapingType>
Indicates the type of traffic shaping used to limit the number of requests to the ADS at one time.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-ScheduleType <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.For more information about the prefetch types and when you might use each, see Prefetching ads in Elemental MediaTailor.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-Select <String>
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)
-StreamId <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.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-TrafficShaping_WindowDurationSeconds <Int32>
The amount of time, in seconds, that MediaTailor spreads prefetch requests to the ADS.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesRetrieval_TrafficShapingRetrievalWindow_RetrievalWindowDurationSeconds, TrafficShaping_RetrievalWindowDurationSeconds

Common Credential and Region Parameters

-AccessKey <String>
The AWS access key for the user account. This can be a temporary access key if the corresponding session token is supplied to the -SessionToken parameter.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesAK
-Credential <AWSCredentials>
An AWSCredentials object instance containing access and secret key information, and optionally a token for session-based credentials.
Required?False
Position?Named
Accept pipeline input?True (ByValue, ByPropertyName)
-EndpointUrl <String>
The endpoint to make the call against.Note: This parameter is primarily for internal AWS use and is not required/should not be specified for normal usage. The cmdlets normally determine which endpoint to call based on the region specified to the -Region parameter or set as default in the shell (via Set-DefaultAWSRegion). Only specify this parameter if you must direct the call to a specific custom endpoint.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-NetworkCredential <PSCredential>
Used with SAML-based authentication when ProfileName references a SAML role profile. Contains the network credentials to be supplied during authentication with the configured identity provider's endpoint. This parameter is not required if the user's default network identity can or should be used during authentication.
Required?False
Position?Named
Accept pipeline input?True (ByValue, ByPropertyName)
-ProfileLocation <String>
Used to specify the name and location of the ini-format credential file (shared with the AWS CLI and other AWS SDKs)If this optional parameter is omitted this cmdlet will search the encrypted credential file used by the AWS SDK for .NET and AWS Toolkit for Visual Studio first. If the profile is not found then the cmdlet will search in the ini-format credential file at the default location: (user's home directory)\.aws\credentials.If this parameter is specified then this cmdlet will only search the ini-format credential file at the location given.As the current folder can vary in a shell or during script execution it is advised that you use specify a fully qualified path instead of a relative path.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesAWSProfilesLocation, ProfilesLocation
-ProfileName <String>
The user-defined name of an AWS credentials or SAML-based role profile containing credential information. The profile is expected to be found in the secure credential file shared with the AWS SDK for .NET and AWS Toolkit for Visual Studio. You can also specify the name of a profile stored in the .ini-format credential file used with the AWS CLI and other AWS SDKs.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesStoredCredentials, AWSProfileName
-Region <Object>
The system name of an AWS region or an AWSRegion instance. This governs the endpoint that will be used when calling service operations. Note that the AWS resources referenced in a call are usually region-specific.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesRegionToCall
-SecretKey <String>
The AWS secret key for the user account. This can be a temporary secret key if the corresponding session token is supplied to the -SessionToken parameter.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesSK, SecretAccessKey
-SessionToken <String>
The session token if the access and secret keys are temporary session-based credentials.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesST

Outputs

Amazon.MediaTailor.Model.CreatePrefetchScheduleResponse
This cmdlet returns an Amazon.MediaTailor.Model.CreatePrefetchScheduleResponse object containing multiple properties.
User Guide
Service API Reference
AWS Tools for PowerShell User Guide

Supported Version

AWS Tools for PowerShell: 2.x.y.z