AWS SDK Version 2 for .NET
API 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.

.NET Framework 3.5
 
The pipeline (queue) that is used to manage jobs.

Inheritance Hierarchy

System.Object
  Amazon.ElasticTranscoder.Model.Pipeline

Namespace: Amazon.ElasticTranscoder.Model
Assembly: AWSSDK.dll
Version: (assembly version)

Syntax

C#
public class Pipeline : Object

The Pipeline type exposes the following members

Constructors

NameDescription
Public Method Pipeline()

Properties

NameTypeDescription
Public Property Arn System.String Gets and sets the property Arn.

The Amazon Resource Name (ARN) for the pipeline.

Public Property AwsKmsKeyArn System.String Gets and sets the property AwsKmsKeyArn.

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.

Public Property ContentConfig Amazon.ElasticTranscoder.Model.PipelineOutputConfig Gets and sets the property ContentConfig.

Information about the Amazon S3 bucket in which you want Elastic Transcoder to save transcoded files and playlists. Either you specify both ContentConfig and ThumbnailConfig, or you specify OutputBucket.

  • Bucket: The Amazon S3 bucket in which you want Elastic Transcoder to save transcoded files and playlists.
  • Permissions: A list of the users and/or predefined Amazon S3 groups you want to have access to transcoded files and playlists, and the type of access that you want them to have.
    • GranteeType: The type of value that appears in the Grantee object:
      • Canonical: Either the canonical user ID for an AWS account or an origin access identity for an Amazon CloudFront distribution.
      • Email: The registered email address of an AWS account.
      • Group: One of the following predefined Amazon S3 groups: AllUsers, AuthenticatedUsers, or LogDelivery.
    • Grantee: The AWS user or group that you want to have access to transcoded files and playlists.
    • Access: The permission that you want to give to the AWS user that is listed in Grantee. Valid values include:
      • READ: The grantee can read the objects and metadata for objects that Elastic Transcoder adds to the Amazon S3 bucket.
      • READ_ACP: The grantee can read the object ACL for objects that Elastic Transcoder adds to the Amazon S3 bucket.
      • WRITE_ACP: The grantee can write the ACL for the objects that Elastic Transcoder adds to the Amazon S3 bucket.
      • FULL_CONTROL: The grantee has READ, READ_ACP, and WRITE_ACP permissions for the objects that Elastic Transcoder adds to the Amazon S3 bucket.
  • StorageClass: 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.
Public Property Id System.String Gets and sets the property Id.

The identifier for the pipeline. You use this value to identify the pipeline in which you want to perform a variety of operations, such as creating a job or a preset.

Public Property InputBucket System.String Gets and sets the property InputBucket.

The Amazon S3 bucket from which Elastic Transcoder gets media files for transcoding and the graphics files, if any, that you want to use for watermarks.

Public Property Name System.String Gets and sets the property Name.

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

Public Property Notifications Amazon.ElasticTranscoder.Model.Notifications Gets and sets the property Notifications.

The Amazon Simple Notification Service (Amazon SNS) topic that you want to notify to report job status.

To receive notifications, you must also subscribe to the new topic in the Amazon SNS console.
  • Progressing (optional): The Amazon Simple Notification Service (Amazon SNS) topic that you want to notify when Elastic Transcoder has started to process the job.
  • Completed (optional): The Amazon SNS topic that you want to notify when Elastic Transcoder has finished processing the job.
  • Warning (optional): The Amazon SNS topic that you want to notify when Elastic Transcoder encounters a warning condition.
  • Error (optional): The Amazon SNS topic that you want to notify when Elastic Transcoder encounters an error condition.
Public Property OutputBucket System.String Gets and sets the property OutputBucket.

The Amazon S3 bucket in which you want Elastic Transcoder to save transcoded files, thumbnails, and playlists. Either you specify this value, or you specify both ContentConfig and ThumbnailConfig.

Public Property Role System.String Gets and sets the property Role.

The IAM Amazon Resource Name (ARN) for the role that Elastic Transcoder uses to transcode jobs for this pipeline.

Public Property Status System.String Gets and sets the property Status.

The current status of the pipeline:

  • Active: The pipeline is processing jobs.
  • Paused: The pipeline is not currently processing jobs.
Public Property ThumbnailConfig Amazon.ElasticTranscoder.Model.PipelineOutputConfig Gets and sets the property ThumbnailConfig.

Information about the Amazon S3 bucket in which you want Elastic Transcoder to save thumbnail files. Either you specify both ContentConfig and ThumbnailConfig, or you specify OutputBucket.

  • Bucket: The Amazon S3 bucket in which you want Elastic Transcoder to save thumbnail files.
  • Permissions: A list of the users and/or predefined Amazon S3 groups you want to have access to thumbnail files, and the type of access that you want them to have.
    • GranteeType: The type of value that appears in the Grantee object:
      • Canonical: Either the canonical user ID for an AWS account or an origin access identity for an Amazon CloudFront distribution. A canonical user ID is not the same as an AWS account number.
      • Email: The registered email address of an AWS account.
      • Group: One of the following predefined Amazon S3 groups: AllUsers, AuthenticatedUsers, or LogDelivery.
    • Grantee: The AWS user or group that you want to have access to thumbnail files.
    • Access: The permission that you want to give to the AWS user that is listed in Grantee. Valid values include:
      • READ: The grantee can read the thumbnails and metadata for thumbnails that Elastic Transcoder adds to the Amazon S3 bucket.
      • READ_ACP: The grantee can read the object ACL for thumbnails that Elastic Transcoder adds to the Amazon S3 bucket.
      • WRITE_ACP: The grantee can write the ACL for the thumbnails that Elastic Transcoder adds to the Amazon S3 bucket.
      • FULL_CONTROL: The grantee has READ, READ_ACP, and WRITE_ACP permissions for the thumbnails that Elastic Transcoder adds to the Amazon S3 bucket.
  • StorageClass: The Amazon S3 storage class, Standard or ReducedRedundancy, that you want Elastic Transcoder to assign to the thumbnails that it stores in your Amazon S3 bucket.

Version Information

.NET Framework:
Supported in: 4.5, 4.0, 3.5

.NET for Windows Store apps:
Supported in: Windows 8.1, Windows 8

.NET for Windows Phone:
Supported in: Windows Phone 8.1