AWS SDK for C++  1.9.103
AWS SDK for C++
Public Member Functions | List of all members
Aws::ElasticTranscoder::Model::UpdatePipelineRequest Class Reference

#include <UpdatePipelineRequest.h>

+ Inheritance diagram for Aws::ElasticTranscoder::Model::UpdatePipelineRequest:

Public Member Functions

 UpdatePipelineRequest ()
 
virtual const char * GetServiceRequestName () const override
 
Aws::String SerializePayload () const override
 
const Aws::StringGetId () const
 
bool IdHasBeenSet () const
 
void SetId (const Aws::String &value)
 
void SetId (Aws::String &&value)
 
void SetId (const char *value)
 
UpdatePipelineRequestWithId (const Aws::String &value)
 
UpdatePipelineRequestWithId (Aws::String &&value)
 
UpdatePipelineRequestWithId (const char *value)
 
const Aws::StringGetName () const
 
bool NameHasBeenSet () const
 
void SetName (const Aws::String &value)
 
void SetName (Aws::String &&value)
 
void SetName (const char *value)
 
UpdatePipelineRequestWithName (const Aws::String &value)
 
UpdatePipelineRequestWithName (Aws::String &&value)
 
UpdatePipelineRequestWithName (const char *value)
 
const Aws::StringGetInputBucket () const
 
bool InputBucketHasBeenSet () const
 
void SetInputBucket (const Aws::String &value)
 
void SetInputBucket (Aws::String &&value)
 
void SetInputBucket (const char *value)
 
UpdatePipelineRequestWithInputBucket (const Aws::String &value)
 
UpdatePipelineRequestWithInputBucket (Aws::String &&value)
 
UpdatePipelineRequestWithInputBucket (const char *value)
 
const Aws::StringGetRole () const
 
bool RoleHasBeenSet () const
 
void SetRole (const Aws::String &value)
 
void SetRole (Aws::String &&value)
 
void SetRole (const char *value)
 
UpdatePipelineRequestWithRole (const Aws::String &value)
 
UpdatePipelineRequestWithRole (Aws::String &&value)
 
UpdatePipelineRequestWithRole (const char *value)
 
const Aws::StringGetAwsKmsKeyArn () const
 
bool AwsKmsKeyArnHasBeenSet () const
 
void SetAwsKmsKeyArn (const Aws::String &value)
 
void SetAwsKmsKeyArn (Aws::String &&value)
 
void SetAwsKmsKeyArn (const char *value)
 
UpdatePipelineRequestWithAwsKmsKeyArn (const Aws::String &value)
 
UpdatePipelineRequestWithAwsKmsKeyArn (Aws::String &&value)
 
UpdatePipelineRequestWithAwsKmsKeyArn (const char *value)
 
const NotificationsGetNotifications () const
 
bool NotificationsHasBeenSet () const
 
void SetNotifications (const Notifications &value)
 
void SetNotifications (Notifications &&value)
 
UpdatePipelineRequestWithNotifications (const Notifications &value)
 
UpdatePipelineRequestWithNotifications (Notifications &&value)
 
const PipelineOutputConfigGetContentConfig () const
 
bool ContentConfigHasBeenSet () const
 
void SetContentConfig (const PipelineOutputConfig &value)
 
void SetContentConfig (PipelineOutputConfig &&value)
 
UpdatePipelineRequestWithContentConfig (const PipelineOutputConfig &value)
 
UpdatePipelineRequestWithContentConfig (PipelineOutputConfig &&value)
 
const PipelineOutputConfigGetThumbnailConfig () const
 
bool ThumbnailConfigHasBeenSet () const
 
void SetThumbnailConfig (const PipelineOutputConfig &value)
 
void SetThumbnailConfig (PipelineOutputConfig &&value)
 
UpdatePipelineRequestWithThumbnailConfig (const PipelineOutputConfig &value)
 
UpdatePipelineRequestWithThumbnailConfig (PipelineOutputConfig &&value)
 
- Public Member Functions inherited from Aws::ElasticTranscoder::ElasticTranscoderRequest
virtual ~ElasticTranscoderRequest ()
 
void AddParametersToRequest (Aws::Http::HttpRequest &httpRequest) const
 
Aws::Http::HeaderValueCollection GetHeaders () const override
 
- Public Member Functions inherited from Aws::AmazonSerializableWebServiceRequest
 AmazonSerializableWebServiceRequest ()
 
virtual ~AmazonSerializableWebServiceRequest ()
 
std::shared_ptr< Aws::IOStreamGetBody () const override
 
- Public Member Functions inherited from Aws::AmazonWebServiceRequest
 AmazonWebServiceRequest ()
 
virtual ~AmazonWebServiceRequest ()=default
 
virtual void AddQueryStringParameters (Aws::Http::URI &uri) const
 
virtual void PutToPresignedUrl (Aws::Http::URI &uri) const
 
virtual bool IsStreaming () const
 
virtual bool IsEventStreamRequest () const
 
virtual bool SignBody () const
 
virtual bool IsChunked () const
 
virtual void SetRequestSignedHandler (const RequestSignedHandler &handler)
 
virtual const RequestSignedHandlerGetRequestSignedHandler () const
 
const Aws::IOStreamFactoryGetResponseStreamFactory () const
 
void SetResponseStreamFactory (const Aws::IOStreamFactory &factory)
 
virtual void SetDataReceivedEventHandler (const Aws::Http::DataReceivedEventHandler &dataReceivedEventHandler)
 
virtual void SetDataSentEventHandler (const Aws::Http::DataSentEventHandler &dataSentEventHandler)
 
virtual void SetContinueRequestHandler (const Aws::Http::ContinueRequestHandler &continueRequestHandler)
 
virtual void SetDataReceivedEventHandler (Aws::Http::DataReceivedEventHandler &&dataReceivedEventHandler)
 
virtual void SetDataSentEventHandler (Aws::Http::DataSentEventHandler &&dataSentEventHandler)
 
virtual void SetContinueRequestHandler (Aws::Http::ContinueRequestHandler &&continueRequestHandler)
 
virtual void SetRequestRetryHandler (const RequestRetryHandler &handler)
 
virtual void SetRequestRetryHandler (RequestRetryHandler &&handler)
 
virtual const Aws::Http::DataReceivedEventHandlerGetDataReceivedEventHandler () const
 
virtual const Aws::Http::DataSentEventHandlerGetDataSentEventHandler () const
 
virtual const Aws::Http::ContinueRequestHandlerGetContinueRequestHandler () const
 
virtual const RequestRetryHandlerGetRequestRetryHandler () const
 
virtual bool ShouldComputeContentMd5 () const
 

Additional Inherited Members

- Protected Member Functions inherited from Aws::ElasticTranscoder::ElasticTranscoderRequest
virtual Aws::Http::HeaderValueCollection GetRequestSpecificHeaders () const
 
- Protected Member Functions inherited from Aws::AmazonWebServiceRequest
virtual void DumpBodyToUrl (Aws::Http::URI &uri) const
 

Detailed Description

The UpdatePipelineRequest structure.

See Also:


AWS API Reference

Definition at line 27 of file UpdatePipelineRequest.h.

Constructor & Destructor Documentation

◆ UpdatePipelineRequest()

Aws::ElasticTranscoder::Model::UpdatePipelineRequest::UpdatePipelineRequest ( )

Member Function Documentation

◆ AwsKmsKeyArnHasBeenSet()

bool Aws::ElasticTranscoder::Model::UpdatePipelineRequest::AwsKmsKeyArnHasBeenSet ( ) const
inline

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.

Definition at line 257 of file UpdatePipelineRequest.h.

◆ ContentConfigHasBeenSet()

bool Aws::ElasticTranscoder::Model::UpdatePipelineRequest::ContentConfigHasBeenSet ( ) const
inline

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.

Definition at line 551 of file UpdatePipelineRequest.h.

◆ GetAwsKmsKeyArn()

const Aws::String& Aws::ElasticTranscoder::Model::UpdatePipelineRequest::GetAwsKmsKeyArn ( ) const
inline

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.

Definition at line 246 of file UpdatePipelineRequest.h.

◆ GetContentConfig()

const PipelineOutputConfig& Aws::ElasticTranscoder::Model::UpdatePipelineRequest::GetContentConfig ( ) const
inline

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.

Definition at line 498 of file UpdatePipelineRequest.h.

◆ GetId()

const Aws::String& Aws::ElasticTranscoder::Model::UpdatePipelineRequest::GetId ( ) const
inline

The ID of the pipeline that you want to update.

Definition at line 44 of file UpdatePipelineRequest.h.

◆ GetInputBucket()

const Aws::String& Aws::ElasticTranscoder::Model::UpdatePipelineRequest::GetInputBucket ( ) const
inline

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.

Definition at line 143 of file UpdatePipelineRequest.h.

◆ GetName()

const Aws::String& Aws::ElasticTranscoder::Model::UpdatePipelineRequest::GetName ( ) const
inline

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

Definition at line 87 of file UpdatePipelineRequest.h.

◆ GetNotifications()

const Notifications& Aws::ElasticTranscoder::Model::UpdatePipelineRequest::GetNotifications ( ) const
inline

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.

  • Complete: 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.

Definition at line 344 of file UpdatePipelineRequest.h.

◆ GetRole()

const Aws::String& Aws::ElasticTranscoder::Model::UpdatePipelineRequest::GetRole ( ) const
inline

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

Definition at line 192 of file UpdatePipelineRequest.h.

◆ GetServiceRequestName()

virtual const char* Aws::ElasticTranscoder::Model::UpdatePipelineRequest::GetServiceRequestName ( ) const
inlineoverridevirtual

Implements Aws::AmazonWebServiceRequest.

Definition at line 36 of file UpdatePipelineRequest.h.

◆ GetThumbnailConfig()

const PipelineOutputConfig& Aws::ElasticTranscoder::Model::UpdatePipelineRequest::GetThumbnailConfig ( ) const
inline

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.

Definition at line 811 of file UpdatePipelineRequest.h.

◆ IdHasBeenSet()

bool Aws::ElasticTranscoder::Model::UpdatePipelineRequest::IdHasBeenSet ( ) const
inline

The ID of the pipeline that you want to update.

Definition at line 49 of file UpdatePipelineRequest.h.

◆ InputBucketHasBeenSet()

bool Aws::ElasticTranscoder::Model::UpdatePipelineRequest::InputBucketHasBeenSet ( ) const
inline

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.

Definition at line 149 of file UpdatePipelineRequest.h.

◆ NameHasBeenSet()

bool Aws::ElasticTranscoder::Model::UpdatePipelineRequest::NameHasBeenSet ( ) const
inline

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

Definition at line 94 of file UpdatePipelineRequest.h.

◆ NotificationsHasBeenSet()

bool Aws::ElasticTranscoder::Model::UpdatePipelineRequest::NotificationsHasBeenSet ( ) const
inline

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.

  • Complete: 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.

Definition at line 364 of file UpdatePipelineRequest.h.

◆ RoleHasBeenSet()

bool Aws::ElasticTranscoder::Model::UpdatePipelineRequest::RoleHasBeenSet ( ) const
inline

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

Definition at line 198 of file UpdatePipelineRequest.h.

◆ SerializePayload()

Aws::String Aws::ElasticTranscoder::Model::UpdatePipelineRequest::SerializePayload ( ) const
overridevirtual

Convert payload into String.

Implements Aws::AmazonSerializableWebServiceRequest.

◆ SetAwsKmsKeyArn() [1/3]

void Aws::ElasticTranscoder::Model::UpdatePipelineRequest::SetAwsKmsKeyArn ( Aws::String &&  value)
inline

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.

Definition at line 279 of file UpdatePipelineRequest.h.

◆ SetAwsKmsKeyArn() [2/3]

void Aws::ElasticTranscoder::Model::UpdatePipelineRequest::SetAwsKmsKeyArn ( const Aws::String value)
inline

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.

Definition at line 268 of file UpdatePipelineRequest.h.

◆ SetAwsKmsKeyArn() [3/3]

void Aws::ElasticTranscoder::Model::UpdatePipelineRequest::SetAwsKmsKeyArn ( const char *  value)
inline

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.

Definition at line 290 of file UpdatePipelineRequest.h.

◆ SetContentConfig() [1/2]

void Aws::ElasticTranscoder::Model::UpdatePipelineRequest::SetContentConfig ( const PipelineOutputConfig value)
inline

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.

Definition at line 604 of file UpdatePipelineRequest.h.

◆ SetContentConfig() [2/2]

void Aws::ElasticTranscoder::Model::UpdatePipelineRequest::SetContentConfig ( PipelineOutputConfig &&  value)
inline

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.

Definition at line 657 of file UpdatePipelineRequest.h.

◆ SetId() [1/3]

void Aws::ElasticTranscoder::Model::UpdatePipelineRequest::SetId ( Aws::String &&  value)
inline

The ID of the pipeline that you want to update.

Definition at line 59 of file UpdatePipelineRequest.h.

◆ SetId() [2/3]

void Aws::ElasticTranscoder::Model::UpdatePipelineRequest::SetId ( const Aws::String value)
inline

The ID of the pipeline that you want to update.

Definition at line 54 of file UpdatePipelineRequest.h.

◆ SetId() [3/3]

void Aws::ElasticTranscoder::Model::UpdatePipelineRequest::SetId ( const char *  value)
inline

The ID of the pipeline that you want to update.

Definition at line 64 of file UpdatePipelineRequest.h.

◆ SetInputBucket() [1/3]

void Aws::ElasticTranscoder::Model::UpdatePipelineRequest::SetInputBucket ( Aws::String &&  value)
inline

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.

Definition at line 161 of file UpdatePipelineRequest.h.

◆ SetInputBucket() [2/3]

void Aws::ElasticTranscoder::Model::UpdatePipelineRequest::SetInputBucket ( const Aws::String value)
inline

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.

Definition at line 155 of file UpdatePipelineRequest.h.

◆ SetInputBucket() [3/3]

void Aws::ElasticTranscoder::Model::UpdatePipelineRequest::SetInputBucket ( const char *  value)
inline

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.

Definition at line 167 of file UpdatePipelineRequest.h.

◆ SetName() [1/3]

void Aws::ElasticTranscoder::Model::UpdatePipelineRequest::SetName ( Aws::String &&  value)
inline

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

Definition at line 108 of file UpdatePipelineRequest.h.

◆ SetName() [2/3]

void Aws::ElasticTranscoder::Model::UpdatePipelineRequest::SetName ( const Aws::String value)
inline

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

Definition at line 101 of file UpdatePipelineRequest.h.

◆ SetName() [3/3]

void Aws::ElasticTranscoder::Model::UpdatePipelineRequest::SetName ( const char *  value)
inline

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

Definition at line 115 of file UpdatePipelineRequest.h.

◆ SetNotifications() [1/2]

void Aws::ElasticTranscoder::Model::UpdatePipelineRequest::SetNotifications ( const Notifications value)
inline

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.

  • Complete: 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.

Definition at line 384 of file UpdatePipelineRequest.h.

◆ SetNotifications() [2/2]

void Aws::ElasticTranscoder::Model::UpdatePipelineRequest::SetNotifications ( Notifications &&  value)
inline

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.

  • Complete: 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.

Definition at line 404 of file UpdatePipelineRequest.h.

◆ SetRole() [1/3]

void Aws::ElasticTranscoder::Model::UpdatePipelineRequest::SetRole ( Aws::String &&  value)
inline

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

Definition at line 210 of file UpdatePipelineRequest.h.

◆ SetRole() [2/3]

void Aws::ElasticTranscoder::Model::UpdatePipelineRequest::SetRole ( const Aws::String value)
inline

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

Definition at line 204 of file UpdatePipelineRequest.h.

◆ SetRole() [3/3]

void Aws::ElasticTranscoder::Model::UpdatePipelineRequest::SetRole ( const char *  value)
inline

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

Definition at line 216 of file UpdatePipelineRequest.h.

◆ SetThumbnailConfig() [1/2]

void Aws::ElasticTranscoder::Model::UpdatePipelineRequest::SetThumbnailConfig ( const PipelineOutputConfig value)
inline

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.

Definition at line 905 of file UpdatePipelineRequest.h.

◆ SetThumbnailConfig() [2/2]

void Aws::ElasticTranscoder::Model::UpdatePipelineRequest::SetThumbnailConfig ( PipelineOutputConfig &&  value)
inline

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.

Definition at line 952 of file UpdatePipelineRequest.h.

◆ ThumbnailConfigHasBeenSet()

bool Aws::ElasticTranscoder::Model::UpdatePipelineRequest::ThumbnailConfigHasBeenSet ( ) const
inline

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.

Definition at line 858 of file UpdatePipelineRequest.h.

◆ WithAwsKmsKeyArn() [1/3]

UpdatePipelineRequest& Aws::ElasticTranscoder::Model::UpdatePipelineRequest::WithAwsKmsKeyArn ( Aws::String &&  value)
inline

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.

Definition at line 312 of file UpdatePipelineRequest.h.

◆ WithAwsKmsKeyArn() [2/3]

UpdatePipelineRequest& Aws::ElasticTranscoder::Model::UpdatePipelineRequest::WithAwsKmsKeyArn ( const Aws::String value)
inline

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.

Definition at line 301 of file UpdatePipelineRequest.h.

◆ WithAwsKmsKeyArn() [3/3]

UpdatePipelineRequest& Aws::ElasticTranscoder::Model::UpdatePipelineRequest::WithAwsKmsKeyArn ( const char *  value)
inline

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.

Definition at line 323 of file UpdatePipelineRequest.h.

◆ WithContentConfig() [1/2]

UpdatePipelineRequest& Aws::ElasticTranscoder::Model::UpdatePipelineRequest::WithContentConfig ( const PipelineOutputConfig value)
inline

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.

Definition at line 710 of file UpdatePipelineRequest.h.

◆ WithContentConfig() [2/2]

UpdatePipelineRequest& Aws::ElasticTranscoder::Model::UpdatePipelineRequest::WithContentConfig ( PipelineOutputConfig &&  value)
inline

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.

Definition at line 763 of file UpdatePipelineRequest.h.

◆ WithId() [1/3]

UpdatePipelineRequest& Aws::ElasticTranscoder::Model::UpdatePipelineRequest::WithId ( Aws::String &&  value)
inline

The ID of the pipeline that you want to update.

Definition at line 74 of file UpdatePipelineRequest.h.

◆ WithId() [2/3]

UpdatePipelineRequest& Aws::ElasticTranscoder::Model::UpdatePipelineRequest::WithId ( const Aws::String value)
inline

The ID of the pipeline that you want to update.

Definition at line 69 of file UpdatePipelineRequest.h.

◆ WithId() [3/3]

UpdatePipelineRequest& Aws::ElasticTranscoder::Model::UpdatePipelineRequest::WithId ( const char *  value)
inline

The ID of the pipeline that you want to update.

Definition at line 79 of file UpdatePipelineRequest.h.

◆ WithInputBucket() [1/3]

UpdatePipelineRequest& Aws::ElasticTranscoder::Model::UpdatePipelineRequest::WithInputBucket ( Aws::String &&  value)
inline

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.

Definition at line 179 of file UpdatePipelineRequest.h.

◆ WithInputBucket() [2/3]

UpdatePipelineRequest& Aws::ElasticTranscoder::Model::UpdatePipelineRequest::WithInputBucket ( const Aws::String value)
inline

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.

Definition at line 173 of file UpdatePipelineRequest.h.

◆ WithInputBucket() [3/3]

UpdatePipelineRequest& Aws::ElasticTranscoder::Model::UpdatePipelineRequest::WithInputBucket ( const char *  value)
inline

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.

Definition at line 185 of file UpdatePipelineRequest.h.

◆ WithName() [1/3]

UpdatePipelineRequest& Aws::ElasticTranscoder::Model::UpdatePipelineRequest::WithName ( Aws::String &&  value)
inline

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

Definition at line 129 of file UpdatePipelineRequest.h.

◆ WithName() [2/3]

UpdatePipelineRequest& Aws::ElasticTranscoder::Model::UpdatePipelineRequest::WithName ( const Aws::String value)
inline

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

Definition at line 122 of file UpdatePipelineRequest.h.

◆ WithName() [3/3]

UpdatePipelineRequest& Aws::ElasticTranscoder::Model::UpdatePipelineRequest::WithName ( const char *  value)
inline

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

Definition at line 136 of file UpdatePipelineRequest.h.

◆ WithNotifications() [1/2]

UpdatePipelineRequest& Aws::ElasticTranscoder::Model::UpdatePipelineRequest::WithNotifications ( const Notifications value)
inline

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.

  • Complete: 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.

Definition at line 424 of file UpdatePipelineRequest.h.

◆ WithNotifications() [2/2]

UpdatePipelineRequest& Aws::ElasticTranscoder::Model::UpdatePipelineRequest::WithNotifications ( Notifications &&  value)
inline

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.

  • Complete: 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.

Definition at line 444 of file UpdatePipelineRequest.h.

◆ WithRole() [1/3]

UpdatePipelineRequest& Aws::ElasticTranscoder::Model::UpdatePipelineRequest::WithRole ( Aws::String &&  value)
inline

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

Definition at line 228 of file UpdatePipelineRequest.h.

◆ WithRole() [2/3]

UpdatePipelineRequest& Aws::ElasticTranscoder::Model::UpdatePipelineRequest::WithRole ( const Aws::String value)
inline

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

Definition at line 222 of file UpdatePipelineRequest.h.

◆ WithRole() [3/3]

UpdatePipelineRequest& Aws::ElasticTranscoder::Model::UpdatePipelineRequest::WithRole ( const char *  value)
inline

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

Definition at line 234 of file UpdatePipelineRequest.h.

◆ WithThumbnailConfig() [1/2]

UpdatePipelineRequest& Aws::ElasticTranscoder::Model::UpdatePipelineRequest::WithThumbnailConfig ( const PipelineOutputConfig value)
inline

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.

Definition at line 999 of file UpdatePipelineRequest.h.

◆ WithThumbnailConfig() [2/2]

UpdatePipelineRequest& Aws::ElasticTranscoder::Model::UpdatePipelineRequest::WithThumbnailConfig ( PipelineOutputConfig &&  value)
inline

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.

Definition at line 1046 of file UpdatePipelineRequest.h.


The documentation for this class was generated from the following file: