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 PutPlaybackConfiguration API operation.

Syntax

Set-EMTPlaybackConfiguration
-Name <String>
-AdDecisionServerUrl <String>
-LivePreRollConfiguration_AdDecisionServerUrl <String>
-HttpRequest_Body <String>
-CdnConfiguration <CdnConfiguration>
-HttpRequest_CompressRequest <CompressionMethod>
-ConfigurationAlias <Hashtable>
-DashConfiguration <DashConfigurationForPut>
-AdMarkerPassthrough_Enabled <Boolean>
-Bumper_EndUrl <String>
-AvailSuppression_FillPolicy <FillPolicy>
-FunctionMapping <Hashtable>
-HttpRequest_Header <Hashtable>
-InsertionMode <InsertionMode>
-LivePreRollConfiguration_MaxDurationSecond <Int32>
-HttpRequest_Method <Method>
-AvailSuppression_Mode <Mode>
-PersonalizationThresholdSecond <Int32>
-SlateAdUrl <String>
-Bumper_StartUrl <String>
-AdConditioningConfiguration_StreamingMediaFileConditioning <StreamingMediaFileConditioning>
-Tag <Hashtable>
-TranscodeProfileName <String>
-AvailSuppression_Value <String>
-VideoContentSourceUrl <String>
-Select <String>
-Force <SwitchParameter>
-ClientConfig <AmazonMediaTailorConfig>

Description

Creates a playback configuration. For information about MediaTailor configurations, see Working with configurations in AWS Elemental MediaTailor.

Parameters

-AdConditioningConfiguration_StreamingMediaFileConditioning <StreamingMediaFileConditioning>
For ads that have media files with streaming delivery and supported file extensions, indicates what transcoding action MediaTailor takes when it first receives these ads from the ADS. TRANSCODE indicates that MediaTailor must transcode the ads. NONE indicates that you have already transcoded the ads outside of MediaTailor and don't need them transcoded as part of the ad insertion workflow. For more information about ad conditioning see Using preconditioned ads in the Elemental MediaTailor user guide.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-AdDecisionServerUrl <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.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-AdMarkerPassthrough_Enabled <Boolean>
Enables ad marker passthrough for your configuration.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesManifestProcessingRules_AdMarkerPassthrough_Enabled
-AvailSuppression_FillPolicy <FillPolicy>
Defines the policy to apply to the avail suppression mode. BEHIND_LIVE_EDGE will always use the full avail suppression policy. AFTER_LIVE_EDGE mode can be used to invoke partial ad break fills when a session starts mid-break.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-AvailSuppression_Mode <Mode>
Sets the ad suppression mode. By default, ad suppression is off and all ad breaks are filled with ads or slate. When Mode is set to BEHIND_LIVE_EDGE, ad suppression is active and MediaTailor won't fill ad breaks on or behind the ad suppression Value time in the manifest lookback window. When Mode is set to AFTER_LIVE_EDGE, ad suppression is active and MediaTailor won't fill ad breaks that are within the live edge plus the avail suppression value.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-AvailSuppression_Value <String>
A live edge offset time in HH:MM:SS. MediaTailor won't fill ad breaks on or behind this time in the manifest lookback window. If Value is set to 00:00:00, it is in sync with the live edge, and MediaTailor won't fill any ad breaks on or behind the live edge. If you set a Value time, MediaTailor won't fill any ad breaks on or behind this time in the manifest lookback window. For example, if you set 00:45:00, then MediaTailor will fill ad breaks that occur within 45 minutes behind the live edge, but won't fill ad breaks on or behind 45 minutes behind the live edge.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-Bumper_EndUrl <String>
The URL for the end bumper asset.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-Bumper_StartUrl <String>
The URL for the start bumper asset.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-CdnConfiguration <CdnConfiguration>
The configuration for using a content delivery network (CDN), like Amazon CloudFront, for content and ad segment management.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-ClientConfig <AmazonMediaTailorConfig>
Amazon.PowerShell.Cmdlets.EMT.AmazonMediaTailorClientCmdlet.ClientConfig
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-ConfigurationAlias <Hashtable>
The player parameters and aliases used as dynamic variables during session initialization. For more information, see Domain Variables. Starting with version 4 of the SDK this property will default to null. If no data for this property is returned from the service the property will also be null. This was changed to improve performance and allow the SDK and caller to distinguish between a property not set or a property being empty to clear out a value. To retain the previous SDK behavior set the AWSConfigs.InitializeCollections static property to true.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesConfigurationAliases
-DashConfiguration <DashConfigurationForPut>
The configuration for DASH content.
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)
-FunctionMapping <Hashtable>
A map of lifecycle hook event names to function identifiers. The function mapping specifies which function MediaTailor executes at each lifecycle hook during ad insertion. Valid keys are PRE_SESSION_INITIALIZATION and PRE_ADS_REQUEST. For more information, see Functions lifecycle hooks in the MediaTailor User Guide. Starting with version 4 of the SDK this property will default to null. If no data for this property is returned from the service the property will also be null. This was changed to improve performance and allow the SDK and caller to distinguish between a property not set or a property being empty to clear out a value. To retain the previous SDK behavior set the AWSConfigs.InitializeCollections static property to true.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-HttpRequest_Body <String>
The request body content to send with HTTP requests to the ad decision server. This value is only eligible for POST requests.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesAdDecisionServerConfiguration_HttpRequest_Body
-HttpRequest_CompressRequest <CompressionMethod>
The compression method to apply to requests sent to the ad decision server. Supported values are NONE and GZIP. This value is only eligible for POST requests.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesAdDecisionServerConfiguration_HttpRequest_CompressRequest
-HttpRequest_Header <Hashtable>
Custom HTTP headers to include in requests to the ad decision server. Specify headers as key-value pairs. This value is only eligible for POST requests. Starting with version 4 of the SDK this property will default to null. If no data for this property is returned from the service the property will also be null. This was changed to improve performance and allow the SDK and caller to distinguish between a property not set or a property being empty to clear out a value. To retain the previous SDK behavior set the AWSConfigs.InitializeCollections static property to true.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesAdDecisionServerConfiguration_HttpRequest_Headers
-HttpRequest_Method <Method>
The HTTP method to use when making requests to the ad decision server. Supported values are GET and POST.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesAdDecisionServerConfiguration_HttpRequest_Method
-InsertionMode <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.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-LivePreRollConfiguration_AdDecisionServerUrl <String>
The URL for the ad decision server (ADS) for pre-roll 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.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-LivePreRollConfiguration_MaxDurationSecond <Int32>
The maximum allowed duration for the pre-roll ad avail. AWS Elemental MediaTailor won't play pre-roll ads to exceed this duration, regardless of the total duration of ads that the ADS returns.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesLivePreRollConfiguration_MaxDurationSeconds
-Name <String>
The identifier for the playback configuration.
Required?True
Position?1
Accept pipeline input?True (ByValue, ByPropertyName)
-PersonalizationThresholdSecond <Int32>
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.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesPersonalizationThresholdSeconds
-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.PutPlaybackConfigurationResponse). Specifying the name of a property of type Amazon.MediaTailor.Model.PutPlaybackConfigurationResponse 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)
-SlateAdUrl <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.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-Tag <Hashtable>
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. Starting with version 4 of the SDK this property will default to null. If no data for this property is returned from the service the property will also be null. This was changed to improve performance and allow the SDK and caller to distinguish between a property not set or a property being empty to clear out a value. To retain the previous SDK behavior set the AWSConfigs.InitializeCollections static property to true.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesTags
-TranscodeProfileName <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.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-VideoContentSourceUrl <String>
The URL prefix for the parent manifest for the stream, minus the asset ID. The maximum length is 512 characters.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)

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.PutPlaybackConfigurationResponse
This cmdlet returns an Amazon.MediaTailor.Model.PutPlaybackConfigurationResponse 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