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.

Update-ETSPipeline Cmdlet

Amazon Elastic Transcoder

Search:

Synopsis

Calls the Amazon Elastic Transcoder UpdatePipeline API operation.

Syntax

Update-ETSPipeline

-Id <String>

-Name <String>

-InputBucket <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>

-Force <SwitchParameter>

Description

Use the UpdatePipeline operation to update settings for a pipeline.
When you change pipeline settings, your changes take effect immediately. Jobs that you have already submitted and that Elastic Transcoder has not started to process are affected in addition to jobs that you submit after you change settings.

Parameters

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-PKCS7, AES-CTR, or AES-GCM.

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.

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.

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.

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.

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.

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.

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.

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

Outputs

This cmdlet returns a Pipeline object.
The service call response (type Amazon.ElasticTranscoder.Model.UpdatePipelineResponse) can also be referenced from properties attached to the cmdlet entry in the $AWSHistory stack.
Additionally, the following properties are added as Note properties to the service response type instance for the cmdlet entry in the $AWSHistory stack: Warnings (type List<Amazon.ElasticTranscoder.Model.Warning>)