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 Amazon Elastic Transcoder CreatePipeline API operation.

Syntax

New-ETSPipeline
-Name <String>
-InputBucket <String>
-OutputBucket <String>
-Role <String>
-AwsKmsKeyArn <String>
-ContentConfig_Bucket <String>
-ThumbnailConfig_Bucket <String>
-Notifications_Completed <String>
-Notifications_Error <String>
-ContentConfig_Permission <Permission[]>
-ThumbnailConfig_Permission <Permission[]>
-Notifications_Progressing <String>
-ContentConfig_StorageClass <String>
-ThumbnailConfig_StorageClass <String>
-Notifications_Warning <String>
-Select <String>
-PassThru <SwitchParameter>
-Force <SwitchParameter>
-ClientConfig <AmazonElasticTranscoderConfig>

Description

The CreatePipeline operation creates a pipeline with settings that you specify.

Parameters

-AwsKmsKeyArn <String>
The AWS Key Management Service (AWS KMS) key that you want to use with this pipeline.If you use either s3 or s3-aws-kms as your Encryption:Mode, you don't need to provide a key with your job because a default key, known as an AWS-KMS key, is created for you automatically. You need to provide an AWS-KMS key only if you want to use a non-default AWS-KMS key, or if you are using an Encryption:Mode of aes-cbc-pkcs7, aes-ctr, or aes-gcm.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-ClientConfig <AmazonElasticTranscoderConfig>
Amazon.PowerShell.Cmdlets.ETS.AmazonElasticTranscoderClientCmdlet.ClientConfig
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-ContentConfig_Bucket <String>
The Amazon S3 bucket in which you want Elastic Transcoder to save the transcoded files. Specify this value when all of the following are true:
  • You want to save transcoded files, thumbnails (if any), and playlists (if any) together in one bucket.
  • You do not want to specify the users or groups who have access to the transcoded files, thumbnails, and playlists.
  • You do not want to specify the permissions that Elastic Transcoder grants to the files.
  • You want to associate the transcoded files and thumbnails with the Amazon S3 Standard storage class.
If you want to save transcoded files and playlists in one bucket and thumbnails in another bucket, specify which users can access the transcoded files or the permissions the users have, or change the Amazon S3 storage class, omit OutputBucket and specify values for ContentConfig and ThumbnailConfig instead.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-ContentConfig_Permission <Permission[]>
Optional. The Permissions object specifies which users and/or predefined Amazon S3 groups you want to have access to transcoded files and playlists, and the type of access you want them to have. You can grant permissions to a maximum of 30 users and/or predefined Amazon S3 groups.If you include Permissions, Elastic Transcoder grants only the permissions that you specify. It does not grant full permissions to the owner of the role specified by Role. If you want that user to have full control, you must explicitly grant full control to the user. If you omit Permissions, Elastic Transcoder grants full control over the transcoded files and playlists to the owner of the role specified by Role, and grants no other permissions to any other user or group.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesContentConfig_Permissions
-ContentConfig_StorageClass <String>
The Amazon S3 storage class, Standard or ReducedRedundancy, that you want Elastic Transcoder to assign to the video files and playlists that it stores in your Amazon S3 bucket.
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)
-InputBucket <String>
The Amazon S3 bucket in which you saved the media files that you want to transcode.
Required?True
Position?2
Accept pipeline input?True (ByPropertyName)
-Name <String>
The name of the pipeline. We recommend that the name be unique within the AWS account, but uniqueness is not enforced.Constraints: Maximum 40 characters.
Required?True
Position?1
Accept pipeline input?True (ByValue, ByPropertyName)
-Notifications_Completed <String>
The Amazon SNS topic that you want to notify when Elastic Transcoder has finished processing the job.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-Notifications_Error <String>
The Amazon SNS topic that you want to notify when Elastic Transcoder encounters an error condition.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-Notifications_Progressing <String>
The Amazon Simple Notification Service (Amazon SNS) topic that you want to notify when Elastic Transcoder has started to process the job.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-Notifications_Warning <String>
The Amazon SNS topic that you want to notify when Elastic Transcoder encounters a warning condition.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-OutputBucket <String>
The Amazon S3 bucket in which you want Elastic Transcoder to save the transcoded files. (Use this, or use ContentConfig:Bucket plus ThumbnailConfig:Bucket.)Specify this value when all of the following are true:
  • You want to save transcoded files, thumbnails (if any), and playlists (if any) together in one bucket.
  • You do not want to specify the users or groups who have access to the transcoded files, thumbnails, and playlists.
  • You do not want to specify the permissions that Elastic Transcoder grants to the files.When Elastic Transcoder saves files in OutputBucket, it grants full control over the files only to the AWS account that owns the role that is specified by Role.
  • You want to associate the transcoded files and thumbnails with the Amazon S3 Standard storage class.
If you want to save transcoded files and playlists in one bucket and thumbnails in another bucket, specify which users can access the transcoded files or the permissions the users have, or change the Amazon S3 storage class, omit OutputBucket and specify values for ContentConfig and ThumbnailConfig instead.
Required?False
Position?3
Accept pipeline input?True (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)
-Role <String>
The IAM Amazon Resource Name (ARN) for the role that you want Elastic Transcoder to use to create the pipeline.
Required?True
Position?4
Accept pipeline input?True (ByPropertyName)
-Select <String>
Use the -Select parameter to control the cmdlet output. The default value is 'Pipeline'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.ElasticTranscoder.Model.CreatePipelineResponse). Specifying the name of a property of type Amazon.ElasticTranscoder.Model.CreatePipelineResponse 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)
-ThumbnailConfig_Bucket <String>
The Amazon S3 bucket in which you want Elastic Transcoder to save the transcoded files. Specify this value when all of the following are true:
  • You want to save transcoded files, thumbnails (if any), and playlists (if any) together in one bucket.
  • You do not want to specify the users or groups who have access to the transcoded files, thumbnails, and playlists.
  • You do not want to specify the permissions that Elastic Transcoder grants to the files.
  • You want to associate the transcoded files and thumbnails with the Amazon S3 Standard storage class.
If you want to save transcoded files and playlists in one bucket and thumbnails in another bucket, specify which users can access the transcoded files or the permissions the users have, or change the Amazon S3 storage class, omit OutputBucket and specify values for ContentConfig and ThumbnailConfig instead.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-ThumbnailConfig_Permission <Permission[]>
Optional. The Permissions object specifies which users and/or predefined Amazon S3 groups you want to have access to transcoded files and playlists, and the type of access you want them to have. You can grant permissions to a maximum of 30 users and/or predefined Amazon S3 groups.If you include Permissions, Elastic Transcoder grants only the permissions that you specify. It does not grant full permissions to the owner of the role specified by Role. If you want that user to have full control, you must explicitly grant full control to the user. If you omit Permissions, Elastic Transcoder grants full control over the transcoded files and playlists to the owner of the role specified by Role, and grants no other permissions to any other user or group.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesThumbnailConfig_Permissions
-ThumbnailConfig_StorageClass <String>
The Amazon S3 storage class, Standard or ReducedRedundancy, that you want Elastic Transcoder to assign to the video files and playlists that it stores in your Amazon S3 bucket.
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.ElasticTranscoder.Model.Pipeline or Amazon.ElasticTranscoder.Model.CreatePipelineResponse
This cmdlet returns an Amazon.ElasticTranscoder.Model.Pipeline object. The service call response (type Amazon.ElasticTranscoder.Model.CreatePipelineResponse) can also be referenced from properties attached to the cmdlet entry in the $AWSHistory stack.
Developer Guide
AWS Tools for PowerShell User Guide

Supported Version

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