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 MediaPackage v2 CreateOriginEndpoint API operation.

Syntax

New-MPV2OriginEndpoint
-OriginEndpointName <String>
-ChannelGroupName <String>
-ChannelName <String>
-EncryptionMethod_CmafEncryptionMethod <CmafEncryptionMethod>
-Encryption_ConstantInitializationVector <String>
-ContainerType <ContainerType>
-DashManifest <CreateDashManifestConfiguration[]>
-Description <String>
-SpekeKeyProvider_DrmSystem <String[]>
-ForceEndpointErrorConfiguration_EndpointErrorCondition <String[]>
-HlsManifest <CreateHlsManifestConfiguration[]>
-Segment_IncludeIframeOnlyStream <Boolean>
-Encryption_KeyRotationIntervalSecond <Int32>
-LowLatencyHlsManifest <CreateLowLatencyHlsManifestConfiguration[]>
-EncryptionContractConfiguration_PresetSpeke20Audio <PresetSpeke20Audio>
-EncryptionContractConfiguration_PresetSpeke20Video <PresetSpeke20Video>
-SpekeKeyProvider_ResourceId <String>
-SpekeKeyProvider_RoleArn <String>
-Scte_ScteFilter <String[]>
-Segment_SegmentDurationSecond <Int32>
-Segment_SegmentName <String>
-StartoverWindowSecond <Int32>
-Tag <Hashtable>
-EncryptionMethod_TsEncryptionMethod <TsEncryptionMethod>
-Segment_TsIncludeDvbSubtitle <Boolean>
-Segment_TsUseAudioRenditionGroup <Boolean>
-SpekeKeyProvider_Url <String>
-ClientToken <String>
-Select <String>
-PassThru <SwitchParameter>
-Force <SwitchParameter>
-ClientConfig <AmazonMediaPackageV2Config>

Description

The endpoint is attached to a channel, and represents the output of the live content. You can associate multiple endpoints to a single channel. Each endpoint gives players and downstream CDNs (such as Amazon CloudFront) access to the content for playback. Content can't be served from a channel until it has an endpoint. You can create only one endpoint with each request.

Parameters

-ChannelGroupName <String>
The name that describes the channel group. The name is the primary identifier for the channel group, and must be unique for your account in the AWS Region.
Required?True
Position?Named
Accept pipeline input?True (ByPropertyName)
-ChannelName <String>
The name that describes the channel. The name is the primary identifier for the channel, and must be unique for your account in the AWS Region and channel group.
Required?True
Position?Named
Accept pipeline input?True (ByPropertyName)
-ClientConfig <AmazonMediaPackageV2Config>
Amazon.PowerShell.Cmdlets.MPV2.AmazonMediaPackageV2ClientCmdlet.ClientConfig
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-ClientToken <String>
A unique, case-sensitive token that you provide to ensure the idempotency of the request.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-ContainerType <ContainerType>
The type of container to attach to this origin endpoint. A container type is a file format that encapsulates one or more media streams, such as audio and video, into a single file. You can't change the container type after you create the endpoint.
Required?True
Position?Named
Accept pipeline input?True (ByPropertyName)
-DashManifest <CreateDashManifestConfiguration[]>
A DASH manifest configuration.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesDashManifests
-Description <String>
Enter any descriptive text that helps you to identify the origin endpoint.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-Encryption_ConstantInitializationVector <String>
A 128-bit, 16-byte hex value represented by a 32-character string, used in conjunction with the key for encrypting content. If you don't specify a value, then MediaPackage creates the constant initialization vector (IV).
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesSegment_Encryption_ConstantInitializationVector
-Encryption_KeyRotationIntervalSecond <Int32>
The frequency (in seconds) of key changes for live workflows, in which content is streamed real time. The service retrieves content keys before the live content begins streaming, and then retrieves them as needed over the lifetime of the workflow. By default, key rotation is set to 300 seconds (5 minutes), the minimum rotation interval, which is equivalent to setting it to 300. If you don't enter an interval, content keys aren't rotated.The following example setting causes the service to rotate keys every thirty minutes: 1800
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesSegment_Encryption_KeyRotationIntervalSeconds
-EncryptionContractConfiguration_PresetSpeke20Audio <PresetSpeke20Audio>
A collection of audio encryption presets.Value description:
  • PRESET-AUDIO-1 - Use one content key to encrypt all of the audio tracks in your stream.
  • PRESET-AUDIO-2 - Use one content key to encrypt all of the stereo audio tracks and one content key to encrypt all of the multichannel audio tracks.
  • PRESET-AUDIO-3 - Use one content key to encrypt all of the stereo audio tracks, one content key to encrypt all of the multichannel audio tracks with 3 to 6 channels, and one content key to encrypt all of the multichannel audio tracks with more than 6 channels.
  • SHARED - Use the same content key for all of the audio and video tracks in your stream.
  • UNENCRYPTED - Don't encrypt any of the audio tracks in your stream.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesSegment_Encryption_SpekeKeyProvider_EncryptionContractConfiguration_PresetSpeke20Audio
-EncryptionContractConfiguration_PresetSpeke20Video <PresetSpeke20Video>
A collection of video encryption presets.Value description:
  • PRESET-VIDEO-1 - Use one content key to encrypt all of the video tracks in your stream.
  • PRESET-VIDEO-2 - Use one content key to encrypt all of the SD video tracks and one content key for all HD and higher resolutions video tracks.
  • PRESET-VIDEO-3 - Use one content key to encrypt all of the SD video tracks, one content key for HD video tracks and one content key for all UHD video tracks.
  • PRESET-VIDEO-4 - Use one content key to encrypt all of the SD video tracks, one content key for HD video tracks, one content key for all UHD1 video tracks and one content key for all UHD2 video tracks.
  • PRESET-VIDEO-5 - Use one content key to encrypt all of the SD video tracks, one content key for HD1 video tracks, one content key for HD2 video tracks, one content key for all UHD1 video tracks and one content key for all UHD2 video tracks.
  • PRESET-VIDEO-6 - Use one content key to encrypt all of the SD video tracks, one content key for HD1 video tracks, one content key for HD2 video tracks and one content key for all UHD video tracks.
  • PRESET-VIDEO-7 - Use one content key to encrypt all of the SD+HD1 video tracks, one content key for HD2 video tracks and one content key for all UHD video tracks.
  • PRESET-VIDEO-8 - Use one content key to encrypt all of the SD+HD1 video tracks, one content key for HD2 video tracks, one content key for all UHD1 video tracks and one content key for all UHD2 video tracks.
  • SHARED - Use the same content key for all of the video and audio tracks in your stream.
  • UNENCRYPTED - Don't encrypt any of the video tracks in your stream.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesSegment_Encryption_SpekeKeyProvider_EncryptionContractConfiguration_PresetSpeke20Video
-EncryptionMethod_CmafEncryptionMethod <CmafEncryptionMethod>
The encryption method to use.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesSegment_Encryption_EncryptionMethod_CmafEncryptionMethod
-EncryptionMethod_TsEncryptionMethod <TsEncryptionMethod>
The encryption method to use.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesSegment_Encryption_EncryptionMethod_TsEncryptionMethod
-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)
-ForceEndpointErrorConfiguration_EndpointErrorCondition <String[]>
The failover conditions for the endpoint. The options are:
  • STALE_MANIFEST - The manifest stalled and there are no new segments or parts.
  • INCOMPLETE_MANIFEST - There is a gap in the manifest.
  • MISSING_DRM_KEY - Key rotation is enabled but we're unable to fetch the key for the current key period.
  • SLATE_INPUT - The segments which contain slate content are considered to be missing content.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesForceEndpointErrorConfiguration_EndpointErrorConditions
-HlsManifest <CreateHlsManifestConfiguration[]>
An HTTP live streaming (HLS) manifest configuration.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesHlsManifests
-LowLatencyHlsManifest <CreateLowLatencyHlsManifestConfiguration[]>
A low-latency HLS manifest configuration.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesLowLatencyHlsManifests
-OriginEndpointName <String>
The name that describes the origin endpoint. The name is the primary identifier for the origin endpoint, and must be unique for your account in the AWS Region and channel. You can't use spaces in the name. You can't change the name after you create the endpoint.
Required?True
Position?1
Accept pipeline input?True (ByValue, ByPropertyName)
-PassThru <SwitchParameter>
Changes the cmdlet behavior to return the value passed to the OriginEndpointName parameter. The -PassThru parameter is deprecated, use -Select '^OriginEndpointName' instead. This parameter will be removed in a future version.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-Scte_ScteFilter <String[]>
The SCTE-35 message types that you want to be treated as ad markers in the output.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesSegment_Scte_ScteFilter
-Segment_IncludeIframeOnlyStream <Boolean>
When selected, the stream set includes an additional I-frame only stream, along with the other tracks. If false, this extra stream is not included. MediaPackage generates an I-frame only stream from the first rendition in the manifest. The service inserts EXT-I-FRAMES-ONLY tags in the output manifest, and then generates and includes an I-frames only playlist in the stream. This playlist permits player functionality like fast forward and rewind.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesSegment_IncludeIframeOnlyStreams
-Segment_SegmentDurationSecond <Int32>
The duration (in seconds) of each segment. Enter a value equal to, or a multiple of, the input segment duration. If the value that you enter is different from the input segment duration, MediaPackage rounds segments to the nearest multiple of the input segment duration.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesSegment_SegmentDurationSeconds
-Segment_SegmentName <String>
The name that describes the segment. The name is the base name of the segment used in all content manifests inside of the endpoint. You can't use spaces in the name.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-Segment_TsIncludeDvbSubtitle <Boolean>
By default, MediaPackage excludes all digital video broadcasting (DVB) subtitles from the output. When selected, MediaPackage passes through DVB subtitles into the output.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesSegment_TsIncludeDvbSubtitles
-Segment_TsUseAudioRenditionGroup <Boolean>
When selected, MediaPackage bundles all audio tracks in a rendition group. All other tracks in the stream can be used with any audio rendition from the group.
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.MediaPackageV2.Model.CreateOriginEndpointResponse). Specifying the name of a property of type Amazon.MediaPackageV2.Model.CreateOriginEndpointResponse 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)
-SpekeKeyProvider_DrmSystem <String[]>
The DRM solution provider you're using to protect your content during distribution.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesSegment_Encryption_SpekeKeyProvider_DrmSystems
-SpekeKeyProvider_ResourceId <String>
The unique identifier for the content. The service sends this to the key server to identify the current endpoint. How unique you make this depends on how fine-grained you want access controls to be. The service does not permit you to use the same ID for two simultaneous encryption processes. The resource ID is also known as the content ID.The following example shows a resource ID: MovieNight20171126093045
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesSegment_Encryption_SpekeKeyProvider_ResourceId
-SpekeKeyProvider_RoleArn <String>
The ARN for the IAM role granted by the key provider that provides access to the key provider API. This role must have a trust policy that allows MediaPackage to assume the role, and it must have a sufficient permissions policy to allow access to the specific key retrieval URL. Get this from your DRM solution provider.Valid format: arn:aws:iam::{accountID}:role/{name}. The following example shows a role ARN: arn:aws:iam::444455556666:role/SpekeAccess
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesSegment_Encryption_SpekeKeyProvider_RoleArn
-SpekeKeyProvider_Url <String>
The URL of the API Gateway proxy that you set up to talk to your key server. The API Gateway proxy must reside in the same AWS Region as MediaPackage and must start with https://.The following example shows a URL: https://1wm2dx1f33.execute-api.us-west-2.amazonaws.com/SpekeSample/copyProtection
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesSegment_Encryption_SpekeKeyProvider_Url
-StartoverWindowSecond <Int32>
The size of the window (in seconds) to create a window of the live stream that's available for on-demand viewing. Viewers can start-over or catch-up on content that falls within the window. The maximum startover window is 1,209,600 seconds (14 days).
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesStartoverWindowSeconds
-Tag <Hashtable>
A comma-separated list of tag key:value pairs that you define. For example:"Key1": "Value1","Key2": "Value2"
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesTags

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.MediaPackageV2.Model.CreateOriginEndpointResponse
This cmdlet returns an Amazon.MediaPackageV2.Model.CreateOriginEndpointResponse object containing multiple properties. The object can also be referenced from properties attached to the cmdlet entry in the $AWSHistory stack.
AWS Tools for PowerShell User Guide

Supported Version

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