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

Invokes the CreateJob operation against Amazon Elastic Transcoder.

Syntax

New-ETSJob
-PipelineId <String>
-AlbumArt_Artwork <Artwork[]>
-Input_AspectRatio <String>
-Captions_CaptionFormat <CaptionFormat[]>
-InputCaptions_CaptionSource <CaptionSource[]>
-Captions_CaptionSource <CaptionSource[]>
-Output_Composition <Clip[]>
-Input_Container <String>
-TimeSpan_Duration <String>
-DetectedProperties_DurationMilli <Int64>
-DetectedProperties_FileSize <Int64>
-DetectedProperties_FrameRate <String>
-Input_FrameRate <String>
-DetectedProperties_Height <Int32>
-InputEncryptionInitializationVector <String>
-OutputEncryptionInitializationVector <String>
-ThumbnailEncryption_InitializationVector <String>
-Input <JobInput[]>
-Input_Interlaced <String>
-InputEncryptionKey <String>
-Input_Key <String>
-OutputEncryptionKey <String>
-Output_Key <String>
-ThumbnailEncryption_Key <String>
-InputEncryptionKeyMd5 <String>
-OutputEncryptionKeyMd5 <String>
-ThumbnailEncryption_KeyMd5 <String>
-InputCaptions_MergePolicy <String>
-AlbumArt_MergePolicy <String>
-Captions_MergePolicy <String>
-InputEncryptionMode <String>
-OutputEncryptionMode <String>
-ThumbnailEncryption_Mode <String>
-OutputKeyPrefix <String>
-Output <CreateJobOutput[]>
-Playlist <CreateJobPlaylist[]>
-Output_PresetId <String>
-Input_Resolution <String>
-Output_Rotate <String>
-Output_SegmentDuration <String>
-TimeSpan_StartTime <String>
-Output_ThumbnailPattern <String>
-UserMetadata <Hashtable>
-Output_Watermark <JobWatermark[]>
-DetectedProperties_Width <Int32>
-Force <SwitchParameter>

Description

When you create a job, Elastic Transcoder returns JSON data that includes the values that you specified plus information about the job that is created. If you have specified more than one output for your jobs (for example, one output for the Kindle Fire and another output for the Apple iPhone 4s), you currently must use the Elastic Transcoder API to list the jobs (as opposed to the AWS Console).

Parameters

-AlbumArt_Artwork <Artwork[]>
The file to be used as album art. There can be multiple artworks associated with an audio file, to a maximum of 20. Valid formats are .jpg and .png
Required?False
Position?Named
Accept pipeline input?False
-AlbumArt_MergePolicy <String>
A policy that determines how Elastic Transcoder handles the existence of multiple album artwork files.
  • Replace: The specified album art replaces any existing album art.
  • Prepend: The specified album art is placed in front of any existing album art.
  • Append: The specified album art is placed after any existing album art.
  • Fallback: If the original input file contains artwork, Elastic Transcoder uses that artwork for the output. If the original input does not contain artwork, Elastic Transcoder uses the specified album art file.
Required?False
Position?Named
Accept pipeline input?False
-Captions_CaptionFormat <CaptionFormat[]>
The array of file formats for the output captions. If you leave this value blank, Elastic Transcoder returns an error.
Required?False
Position?Named
Accept pipeline input?False
-Captions_CaptionSource <CaptionSource[]>
Source files for the input sidecar captions used during the transcoding process. To omit all sidecar captions, leave CaptionSources blank.
Required?False
Position?Named
Accept pipeline input?False
-Captions_MergePolicy <String>
A policy that determines how Elastic Transcoder handles the existence of multiple captions.
  • MergeOverride: Elastic Transcoder transcodes both embedded and sidecar captions into outputs. If captions for a language are embedded in the input file and also appear in a sidecar file, Elastic Transcoder uses the sidecar captions and ignores the embedded captions for that language.
  • MergeRetain: Elastic Transcoder transcodes both embedded and sidecar captions into outputs. If captions for a language are embedded in the input file and also appear in a sidecar file, Elastic Transcoder uses the embedded captions and ignores the sidecar captions for that language. If CaptionSources is empty, Elastic Transcoder omits all sidecar captions from the output files.
  • Override: Elastic Transcoder transcodes only the sidecar captions that you specify in CaptionSources.
MergePolicy cannot be null.
Required?False
Position?Named
Accept pipeline input?False
-DetectedProperties_DurationMilli <Int64>
The detected duration of the input file, in milliseconds.
Required?False
Position?Named
Accept pipeline input?False
-DetectedProperties_FileSize <Int64>
The detected file size of the input file, in bytes.
Required?False
Position?Named
Accept pipeline input?False
-DetectedProperties_FrameRate <String>
The detected frame rate of the input file, in frames per second.
Required?False
Position?Named
Accept pipeline input?False
-DetectedProperties_Height <Int32>
The detected height of the input file, in pixels.
Required?False
Position?Named
Accept pipeline input?False
-DetectedProperties_Width <Int32>
The detected width of the input file, in pixels.
Required?False
Position?Named
Accept pipeline input?False
-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?False
-Input <JobInput[]>
A section of the request body that provides information about the files that are being transcoded.
Required?False
Position?Named
Accept pipeline input?False
-Input_AspectRatio <String>
The aspect ratio of the input file. If you want Elastic Transcoder to automatically detect the aspect ratio of the input file, specify auto. If you want to specify the aspect ratio for the output file, enter one of the following values:1:1, 4:3, 3:2, 16:9 If you specify a value other than auto, Elastic Transcoder disables automatic detection of the aspect ratio.
Required?False
Position?Named
Accept pipeline input?False
-Input_Container <String>
The container type for the input file. If you want Elastic Transcoder to automatically detect the container type of the input file, specify auto. If you want to specify the container type for the input file, enter one of the following values:3gp, aac, asf, avi, divx, flv, m4a, mkv, mov, mp3, mp4, mpeg, mpeg-ps, mpeg-ts, mxf, ogg, vob, wav, webm
Required?False
Position?Named
Accept pipeline input?False
-Input_FrameRate <String>
The frame rate of the input file. If you want Elastic Transcoder to automatically detect the frame rate of the input file, specify auto. If you want to specify the frame rate for the input file, enter one of the following values: 10, 15, 23.97, 24, 25, 29.97, 30, 60If you specify a value other than auto, Elastic Transcoder disables automatic detection of the frame rate.
Required?False
Position?Named
Accept pipeline input?False
-Input_Interlaced <String>
Whether the input file is interlaced. If you want Elastic Transcoder to automatically detect whether the input file is interlaced, specify auto. If you want to specify whether the input file is interlaced, enter one of the following values:true, falseIf you specify a value other than auto, Elastic Transcoder disables automatic detection of interlacing.
Required?False
Position?Named
Accept pipeline input?False
-Input_Key <String>
The name of the file to transcode. Elsewhere in the body of the JSON block is the the ID of the pipeline to use for processing the job. The InputBucket object in that pipeline tells Elastic Transcoder which Amazon S3 bucket to get the file from. If the file name includes a prefix, such as cooking/lasagna.mpg, include the prefix in the key. If the file isn't in the specified bucket, Elastic Transcoder returns an error.
Required?False
Position?Named
Accept pipeline input?False
-Input_Resolution <String>
This value must be auto, which causes Elastic Transcoder to automatically detect the resolution of the input file.
Required?False
Position?Named
Accept pipeline input?False
-InputCaptions_CaptionSource <CaptionSource[]>
Source files for the input sidecar captions used during the transcoding process. To omit all sidecar captions, leave CaptionSources blank.
Required?False
Position?Named
Accept pipeline input?False
-InputCaptions_MergePolicy <String>
A policy that determines how Elastic Transcoder handles the existence of multiple captions.
  • MergeOverride: Elastic Transcoder transcodes both embedded and sidecar captions into outputs. If captions for a language are embedded in the input file and also appear in a sidecar file, Elastic Transcoder uses the sidecar captions and ignores the embedded captions for that language.
  • MergeRetain: Elastic Transcoder transcodes both embedded and sidecar captions into outputs. If captions for a language are embedded in the input file and also appear in a sidecar file, Elastic Transcoder uses the embedded captions and ignores the sidecar captions for that language. If CaptionSources is empty, Elastic Transcoder omits all sidecar captions from the output files.
  • Override: Elastic Transcoder transcodes only the sidecar captions that you specify in CaptionSources.
MergePolicy cannot be null.
Required?False
Position?Named
Accept pipeline input?False
-InputEncryptionInitializationVector <String>
The series of random bits created by a random bit generator, unique for every encryption operation, that you used to encrypt your input files or that you want Elastic Transcoder to use to encrypt your output files. The initialization vector must be base64-encoded, and it must be exactly 16 bytes long before being base64-encoded.
Required?False
Position?Named
Accept pipeline input?False
-InputEncryptionKey <String>
The data encryption key that you want Elastic Transcoder to use to encrypt your output file, or that was used to encrypt your input file. The key must be base64-encoded and it must be one of the following bit lengths before being base64-encoded:128, 192, or 256. The key must also be encrypted by using the Amazon Key Management Service.
Required?False
Position?Named
Accept pipeline input?False
-InputEncryptionKeyMd5 <String>
The MD5 digest of the key that you used to encrypt your input file, or that you want Elastic Transcoder to use to encrypt your output file. Elastic Transcoder uses the key digest as a checksum to make sure your key was not corrupted in transit. The key MD5 must be base64-encoded, and it must be exactly 16 bytes long before being base64-encoded.
Required?False
Position?Named
Accept pipeline input?False
-InputEncryptionMode <String>
The specific server-side encryption mode that you want Elastic Transcoder to use when decrypting your input files or encrypting your output files. Elastic Transcoder supports the following options:
  • S3: Amazon S3 creates and manages the keys used for encrypting your files.
  • S3-AWS-KMS: Amazon S3 calls the Amazon Key Management Service, which creates and manages the keys that are used for encrypting your files. If you specify S3-AWS-KMS and you don't want to use the default key, you must add the AWS-KMS key that you want to use to your pipeline.
  • AES-CBC-PKCS7: A padded cipher-block mode of operation originally used for HLS files.
  • AES-CTR: AES Counter Mode.
  • AES-GCM: AES Galois Counter Mode, a mode of operation that is an authenticated encryption format, meaning that a file, key, or initialization vector that has been tampered with fails the decryption process.
For all three AES options, you must provide the following settings, which must be base64-encoded:
  • Key
  • Key MD5
  • Initialization Vector
For the AES modes, your private encryption keys and your unencrypted data are never stored by AWS; therefore, it is important that you safely manage your encryption keys. If you lose them, you won't be able to unencrypt your data.
Required?False
Position?Named
Accept pipeline input?False
A section of the request body that provides information about the transcoded (target) files. We recommend that you use the Outputs syntax instead of the Output syntax.
Required?False
Position?Named
Accept pipeline input?False
-Output_Composition <Clip[]>
You can create an output file that contains an excerpt from the input file. This excerpt, called a clip, can come from the beginning, middle, or end of the file. The Composition object contains settings for the clips that make up an output file. For the current release, you can only specify settings for a single clip per output file. The Composition object cannot be null.
Required?False
Position?Named
Accept pipeline input?False
-Output_Key <String>
The name to assign to the transcoded file. Elastic Transcoder saves the file in the Amazon S3 bucket specified by the OutputBucket object in the pipeline that is specified by the pipeline ID. If a file with the specified name already exists in the output bucket, the job fails.
Required?False
Position?Named
Accept pipeline input?False
-Output_PresetId <String>
The Id of the preset to use for this job. The preset determines the audio, video, and thumbnail settings that Elastic Transcoder uses for transcoding.
Required?False
Position?Named
Accept pipeline input?False
-Output_Rotate <String>
The number of degrees clockwise by which you want Elastic Transcoder to rotate the output relative to the input. Enter one of the following values: auto, 0, 90, 180, 270. The value auto generally works only if the file that you're transcoding contains rotation metadata.
Required?False
Position?Named
Accept pipeline input?False
-Output_SegmentDuration <String>
(Outputs in Fragmented MP4 or MPEG-TS format only.If you specify a preset in PresetId for which the value of Container is fmp4 (Fragmented MP4) or ts (MPEG-TS), SegmentDuration is the target maximum duration of each segment in seconds. For HLSv3 format playlists, each media segment is stored in a separate .ts file. For HLSv4 and Smooth playlists, all media segments for an output are stored in a single file. Each segment is approximately the length of the SegmentDuration, though individual segments might be shorter or longer.The range of valid values is 1 to 60 seconds. If the duration of the video is not evenly divisible by SegmentDuration, the duration of the last segment is the remainder of total length/SegmentDuration.Elastic Transcoder creates an output-specific playlist for each output HLS output that you specify in OutputKeys. To add an output to the master playlist for this job, include it in the OutputKeys of the associated playlist.
Required?False
Position?Named
Accept pipeline input?False
-Output_ThumbnailPattern <String>
Whether you want Elastic Transcoder to create thumbnails for your videos and, if so, how you want Elastic Transcoder to name the files.If you don't want Elastic Transcoder to create thumbnails, specify "".If you do want Elastic Transcoder to create thumbnails, specify the information that you want to include in the file name for each thumbnail. You can specify the following values in any sequence:
  • {count} (Required): If you want to create thumbnails, you must include {count} in the ThumbnailPattern object. Wherever you specify {count}, Elastic Transcoder adds a five-digit sequence number (beginning with 00001) to thumbnail file names. The number indicates where a given thumbnail appears in the sequence of thumbnails for a transcoded file. If you specify a literal value and/or {resolution} but you omit {count}, Elastic Transcoder returns a validation error and does not create the job.
  • Literal values (Optional): You can specify literal values anywhere in the ThumbnailPattern object. For example, you can include them as a file name prefix or as a delimiter between {resolution} and {count}.
  • {resolution} (Optional): If you want Elastic Transcoder to include the resolution in the file name, include {resolution} in the ThumbnailPattern object.
When creating thumbnails, Elastic Transcoder automatically saves the files in the format (.jpg or .png) that appears in the preset that you specified in the PresetID value of CreateJobOutput. Elastic Transcoder also appends the applicable file name extension.
Required?False
Position?Named
Accept pipeline input?False
-Output_Watermark <JobWatermark[]>
Information about the watermarks that you want Elastic Transcoder to add to the video during transcoding. You can specify up to four watermarks for each output. Settings for each watermark must be defined in the preset for the current output.
Required?False
Position?Named
Accept pipeline input?False
-OutputEncryptionInitializationVector <String>
The series of random bits created by a random bit generator, unique for every encryption operation, that you used to encrypt your input files or that you want Elastic Transcoder to use to encrypt your output files. The initialization vector must be base64-encoded, and it must be exactly 16 bytes long before being base64-encoded.
Required?False
Position?Named
Accept pipeline input?False
-OutputEncryptionKey <String>
The data encryption key that you want Elastic Transcoder to use to encrypt your output file, or that was used to encrypt your input file. The key must be base64-encoded and it must be one of the following bit lengths before being base64-encoded:128, 192, or 256. The key must also be encrypted by using the Amazon Key Management Service.
Required?False
Position?Named
Accept pipeline input?False
-OutputEncryptionKeyMd5 <String>
The MD5 digest of the key that you used to encrypt your input file, or that you want Elastic Transcoder to use to encrypt your output file. Elastic Transcoder uses the key digest as a checksum to make sure your key was not corrupted in transit. The key MD5 must be base64-encoded, and it must be exactly 16 bytes long before being base64-encoded.
Required?False
Position?Named
Accept pipeline input?False
-OutputEncryptionMode <String>
The specific server-side encryption mode that you want Elastic Transcoder to use when decrypting your input files or encrypting your output files. Elastic Transcoder supports the following options:
  • S3: Amazon S3 creates and manages the keys used for encrypting your files.
  • S3-AWS-KMS: Amazon S3 calls the Amazon Key Management Service, which creates and manages the keys that are used for encrypting your files. If you specify S3-AWS-KMS and you don't want to use the default key, you must add the AWS-KMS key that you want to use to your pipeline.
  • AES-CBC-PKCS7: A padded cipher-block mode of operation originally used for HLS files.
  • AES-CTR: AES Counter Mode.
  • AES-GCM: AES Galois Counter Mode, a mode of operation that is an authenticated encryption format, meaning that a file, key, or initialization vector that has been tampered with fails the decryption process.
For all three AES options, you must provide the following settings, which must be base64-encoded:
  • Key
  • Key MD5
  • Initialization Vector
For the AES modes, your private encryption keys and your unencrypted data are never stored by AWS; therefore, it is important that you safely manage your encryption keys. If you lose them, you won't be able to unencrypt your data.
Required?False
Position?Named
Accept pipeline input?False
-OutputKeyPrefix <String>
The value, if any, that you want Elastic Transcoder to prepend to the names of all files that this job creates, including output files, thumbnails, and playlists.
Required?False
Position?Named
Accept pipeline input?False
-PipelineId <String>
The Id of the pipeline that you want Elastic Transcoder to use for transcoding. The pipeline determines several settings, including the Amazon S3 bucket from which Elastic Transcoder gets the files to transcode and the bucket into which Elastic Transcoder puts the transcoded files.
Required?False
Position?1
Accept pipeline input?True (ByValue, ByPropertyName)
If you specify a preset in PresetId for which the value of Container is fmp4 (Fragmented MP4) or ts (MPEG-TS), Playlists contains information about the master playlists that you want Elastic Transcoder to create.The maximum number of master playlists in a job is 30.
Required?False
Position?Named
Accept pipeline input?False
-ThumbnailEncryption_InitializationVector <String>
The series of random bits created by a random bit generator, unique for every encryption operation, that you used to encrypt your input files or that you want Elastic Transcoder to use to encrypt your output files. The initialization vector must be base64-encoded, and it must be exactly 16 bytes long before being base64-encoded.
Required?False
Position?Named
Accept pipeline input?False
-ThumbnailEncryption_Key <String>
The data encryption key that you want Elastic Transcoder to use to encrypt your output file, or that was used to encrypt your input file. The key must be base64-encoded and it must be one of the following bit lengths before being base64-encoded:128, 192, or 256. The key must also be encrypted by using the Amazon Key Management Service.
Required?False
Position?Named
Accept pipeline input?False
-ThumbnailEncryption_KeyMd5 <String>
The MD5 digest of the key that you used to encrypt your input file, or that you want Elastic Transcoder to use to encrypt your output file. Elastic Transcoder uses the key digest as a checksum to make sure your key was not corrupted in transit. The key MD5 must be base64-encoded, and it must be exactly 16 bytes long before being base64-encoded.
Required?False
Position?Named
Accept pipeline input?False
-ThumbnailEncryption_Mode <String>
The specific server-side encryption mode that you want Elastic Transcoder to use when decrypting your input files or encrypting your output files. Elastic Transcoder supports the following options:
  • S3: Amazon S3 creates and manages the keys used for encrypting your files.
  • S3-AWS-KMS: Amazon S3 calls the Amazon Key Management Service, which creates and manages the keys that are used for encrypting your files. If you specify S3-AWS-KMS and you don't want to use the default key, you must add the AWS-KMS key that you want to use to your pipeline.
  • AES-CBC-PKCS7: A padded cipher-block mode of operation originally used for HLS files.
  • AES-CTR: AES Counter Mode.
  • AES-GCM: AES Galois Counter Mode, a mode of operation that is an authenticated encryption format, meaning that a file, key, or initialization vector that has been tampered with fails the decryption process.
For all three AES options, you must provide the following settings, which must be base64-encoded:
  • Key
  • Key MD5
  • Initialization Vector
For the AES modes, your private encryption keys and your unencrypted data are never stored by AWS; therefore, it is important that you safely manage your encryption keys. If you lose them, you won't be able to unencrypt your data.
Required?False
Position?Named
Accept pipeline input?False
-TimeSpan_Duration <String>
The duration of the clip. The format can be either HH:mm:ss.SSS (maximum value: 23:59:59.999; SSS is thousandths of a second) or sssss.SSS (maximum value: 86399.999). If you don't specify a value, Elastic Transcoder creates an output file from StartTime to the end of the file.If you specify a value longer than the duration of the input file, Elastic Transcoder transcodes the file and returns a warning message.
Required?False
Position?Named
Accept pipeline input?False
-TimeSpan_StartTime <String>
The place in the input file where you want a clip to start. The format can be either HH:mm:ss.SSS (maximum value: 23:59:59.999; SSS is thousandths of a second) or sssss.SSS (maximum value: 86399.999). If you don't specify a value, Elastic Transcoder starts at the beginning of the input file.
Required?False
Position?Named
Accept pipeline input?False
-UserMetadata <Hashtable>
User-defined metadata that you want to associate with an Elastic Transcoder job. You specify metadata in key/value pairs, and you can add up to 10 key/value pairs per job. Elastic Transcoder does not guarantee that key/value pairs are returned in the same order in which you specify them.
Required?False
Position?Named
Accept pipeline input?False

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? False
-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? False
-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. Note that the encrypted credential file is not supported on all platforms. It will be skipped when searching for profiles on Windows Nano Server, Mac, and Linux platforms.

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? False
-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? False
-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? False
-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? False
-SessionToken <String>
The session token if the access and secret keys are temporary session-based credentials.
Required? False
Position? Named
Accept pipeline input? False
-Region <String>
The system name of the AWS region in which the operation should be invoked. For example, us-east-1, eu-west-1 etc.
Required? False
Position? Named
Accept pipeline input? False
-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? False

Inputs

You can pipe a String object to this cmdlet for the PipelineId parameter.

Outputs

This cmdlet returns a Job object. The service call response (type Amazon.ElasticTranscoder.Model.CreateJobResponse) can also be referenced from properties attached to the cmdlet entry in the $AWSHistory stack.

Supported Version

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