You are viewing documentation for version 3 of the AWS SDK for Ruby. Version 2 documentation can be found here.

Class: Aws::ElasticTranscoder::Types::UpdatePipelineRequest

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-elastictranscoder/lib/aws-sdk-elastictranscoder/types.rb

Overview

Note:

When making an API call, you may pass UpdatePipelineRequest data as a hash:

{
  id: "Id", # required
  name: "Name",
  input_bucket: "BucketName",
  role: "Role",
  aws_kms_key_arn: "KeyArn",
  notifications: {
    progressing: "SnsTopic",
    completed: "SnsTopic",
    warning: "SnsTopic",
    error: "SnsTopic",
  },
  content_config: {
    bucket: "BucketName",
    storage_class: "StorageClass",
    permissions: [
      {
        grantee_type: "GranteeType",
        grantee: "Grantee",
        access: ["AccessControl"],
      },
    ],
  },
  thumbnail_config: {
    bucket: "BucketName",
    storage_class: "StorageClass",
    permissions: [
      {
        grantee_type: "GranteeType",
        grantee: "Grantee",
        access: ["AccessControl"],
      },
    ],
  },
}

The UpdatePipelineRequest structure.

Instance Attribute Summary collapse

Instance Attribute Details

#aws_kms_key_arnString

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.

Returns:

  • (String)


4603
4604
4605
4606
4607
4608
4609
4610
4611
4612
4613
# File 'gems/aws-sdk-elastictranscoder/lib/aws-sdk-elastictranscoder/types.rb', line 4603

class UpdatePipelineRequest < Struct.new(
  :id,
  :name,
  :input_bucket,
  :role,
  :aws_kms_key_arn,
  :notifications,
  :content_config,
  :thumbnail_config)
  include Aws::Structure
end

#content_configTypes::PipelineOutputConfig

The optional ContentConfig object specifies information about the Amazon S3 bucket in which you want Elastic Transcoder to save transcoded files and playlists: which bucket to use, which users you want to have access to the files, the type of access you want users to have, and the storage class that you want to assign to the files.

If you specify values for ContentConfig, you must also specify values for ThumbnailConfig.

If you specify values for ContentConfig and ThumbnailConfig, omit the OutputBucket object.

  • Bucket: The Amazon S3 bucket in which you want Elastic Transcoder to save transcoded files and playlists.

  • Permissions (Optional): The Permissions object specifies which users you want to have access to transcoded files 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.

  • Grantee Type: Specify the type of value that appears in the Grantee object:

    • Canonical: The value in the Grantee object is either the canonical user ID for an AWS account or an origin access identity for an Amazon CloudFront distribution. For more information about canonical user IDs, see Access Control List (ACL) Overview in the Amazon Simple Storage Service Developer Guide. For more information about using CloudFront origin access identities to require that users use CloudFront URLs instead of Amazon S3 URLs, see Using an Origin Access Identity to Restrict Access to Your Amazon S3 Content.

      A canonical user ID is not the same as an AWS account number.

    • Email: The value in the Grantee object is the registered email address of an AWS account.

    • Group: The value in the Grantee object is 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. To identify the user or group, you can specify the canonical user ID for an AWS account, an origin access identity for a CloudFront distribution, the registered email address of an AWS account, or a predefined Amazon S3 group

  • Access: The permission that you want to give to the AWS user that you specified in Grantee. Permissions are granted on the files that Elastic Transcoder adds to the bucket, including playlists and video files. 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.



4603
4604
4605
4606
4607
4608
4609
4610
4611
4612
4613
# File 'gems/aws-sdk-elastictranscoder/lib/aws-sdk-elastictranscoder/types.rb', line 4603

class UpdatePipelineRequest < Struct.new(
  :id,
  :name,
  :input_bucket,
  :role,
  :aws_kms_key_arn,
  :notifications,
  :content_config,
  :thumbnail_config)
  include Aws::Structure
end

#idString

The ID of the pipeline that you want to update.

Returns:

  • (String)


4603
4604
4605
4606
4607
4608
4609
4610
4611
4612
4613
# File 'gems/aws-sdk-elastictranscoder/lib/aws-sdk-elastictranscoder/types.rb', line 4603

class UpdatePipelineRequest < Struct.new(
  :id,
  :name,
  :input_bucket,
  :role,
  :aws_kms_key_arn,
  :notifications,
  :content_config,
  :thumbnail_config)
  include Aws::Structure
end

#input_bucketString

The Amazon S3 bucket in which you saved the media files that you want to transcode and the graphics that you want to use as watermarks.

Returns:

  • (String)


4603
4604
4605
4606
4607
4608
4609
4610
4611
4612
4613
# File 'gems/aws-sdk-elastictranscoder/lib/aws-sdk-elastictranscoder/types.rb', line 4603

class UpdatePipelineRequest < Struct.new(
  :id,
  :name,
  :input_bucket,
  :role,
  :aws_kms_key_arn,
  :notifications,
  :content_config,
  :thumbnail_config)
  include Aws::Structure
end

#nameString

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

Returns:

  • (String)


4603
4604
4605
4606
4607
4608
4609
4610
4611
4612
4613
# File 'gems/aws-sdk-elastictranscoder/lib/aws-sdk-elastictranscoder/types.rb', line 4603

class UpdatePipelineRequest < Struct.new(
  :id,
  :name,
  :input_bucket,
  :role,
  :aws_kms_key_arn,
  :notifications,
  :content_config,
  :thumbnail_config)
  include Aws::Structure
end

#notificationsTypes::Notifications

The topic ARN for 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: The topic ARN for the Amazon Simple Notification Service (Amazon SNS) topic that you want to notify when Elastic Transcoder has started to process jobs that are added to this pipeline. This is the ARN that Amazon SNS returned when you created the topic.

  • Completed: The topic ARN for the Amazon SNS topic that you want to notify when Elastic Transcoder has finished processing a job. This is the ARN that Amazon SNS returned when you created the topic.

  • Warning: The topic ARN for the Amazon SNS topic that you want to notify when Elastic Transcoder encounters a warning condition. This is the ARN that Amazon SNS returned when you created the topic.

  • Error: The topic ARN for the Amazon SNS topic that you want to notify when Elastic Transcoder encounters an error condition. This is the ARN that Amazon SNS returned when you created the topic.



4603
4604
4605
4606
4607
4608
4609
4610
4611
4612
4613
# File 'gems/aws-sdk-elastictranscoder/lib/aws-sdk-elastictranscoder/types.rb', line 4603

class UpdatePipelineRequest < Struct.new(
  :id,
  :name,
  :input_bucket,
  :role,
  :aws_kms_key_arn,
  :notifications,
  :content_config,
  :thumbnail_config)
  include Aws::Structure
end

#roleString

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

Returns:

  • (String)


4603
4604
4605
4606
4607
4608
4609
4610
4611
4612
4613
# File 'gems/aws-sdk-elastictranscoder/lib/aws-sdk-elastictranscoder/types.rb', line 4603

class UpdatePipelineRequest < Struct.new(
  :id,
  :name,
  :input_bucket,
  :role,
  :aws_kms_key_arn,
  :notifications,
  :content_config,
  :thumbnail_config)
  include Aws::Structure
end

#thumbnail_configTypes::PipelineOutputConfig

The ThumbnailConfig object specifies several values, including the Amazon S3 bucket in which you want Elastic Transcoder to save thumbnail files, which users you want to have access to the files, the type of access you want users to have, and the storage class that you want to assign to the files.

If you specify values for ContentConfig, you must also specify values for ThumbnailConfig even if you don't want to create thumbnails.

If you specify values for ContentConfig and ThumbnailConfig, omit the OutputBucket object.

  • Bucket: The Amazon S3 bucket in which you want Elastic Transcoder to save thumbnail files.

  • Permissions (Optional): The Permissions object specifies which users and/or predefined Amazon S3 groups you want to have access to thumbnail files, 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.

  • GranteeType: Specify the type of value that appears in the Grantee object:

    • Canonical: The value in the Grantee object is 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 value in the Grantee object is the registered email address of an AWS account.

    • Group: The value in the Grantee object is 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. To identify the user or group, you can specify the canonical user ID for an AWS account, an origin access identity for a CloudFront distribution, the registered email address of an AWS account, or a predefined Amazon S3 group.

  • Access: The permission that you want to give to the AWS user that you specified in Grantee. Permissions are granted on the thumbnail files that Elastic Transcoder adds to the bucket. Valid values include:

    • READ: The grantee can read the thumbnails and metadata for objects 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.



4603
4604
4605
4606
4607
4608
4609
4610
4611
4612
4613
# File 'gems/aws-sdk-elastictranscoder/lib/aws-sdk-elastictranscoder/types.rb', line 4603

class UpdatePipelineRequest < Struct.new(
  :id,
  :name,
  :input_bucket,
  :role,
  :aws_kms_key_arn,
  :notifications,
  :content_config,
  :thumbnail_config)
  include Aws::Structure
end