Struct aws_sdk_elastictranscoder::Client

pub struct Client { /* private fields */ }

Client for Amazon Elastic Transcoder

Client for invoking operations on Amazon Elastic Transcoder. Each operation on Amazon Elastic Transcoder is a method on this this struct. .send() MUST be invoked on the generated operations to dispatch the request to the service.

Constructing a Client

A Config is required to construct a client. For most use cases, the aws-config crate should be used to automatically resolve this config using aws_config::load_from_env(), since this will resolve an SdkConfig which can be shared across multiple different AWS SDK clients. This config resolution process can be customized by calling aws_config::from_env() instead, which returns a ConfigLoader that uses the builder pattern to customize the default config.

In the simplest case, creating a client looks as follows:

let config = aws_config::load_from_env().await;
let client = aws_sdk_elastictranscoder::Client::new(&config);

Occasionally, SDKs may have additional service-specific values that can be set on the Config that is absent from SdkConfig, or slightly different settings for a specific client may be desired. The Config struct implements From<&SdkConfig>, so setting these specific settings can be done as follows:

let sdk_config = ::aws_config::load_from_env().await;
let config = aws_sdk_elastictranscoder::config::Builder::from(&sdk_config)
    .some_service_specific_setting("value")
    .build();

See the aws-config docs and Config for more information on customizing configuration.

Note: Client construction is expensive due to connection thread pool initialization, and should be done once at application start-up.

Using the Client

A client has a function for every operation that can be performed by the service. For example, the CancelJob operation has a Client::cancel_job, function which returns a builder for that operation. The fluent builder ultimately has a send() function that returns an async future that returns a result, as illustrated below:

let result = client.cancel_job()
    .id("example")
    .send()
    .await;

The underlying HTTP requests that get made by this can be modified with the customize_operation function on the fluent builder. See the customize module for more information.

Implementations

impl Client

pub fn cancel_job(&self) -> CancelJobFluentBuilder

Constructs a fluent builder for the CancelJob operation.

• The fluent builder is configurable:
  • id(impl Into<String>) / set_id(Option<String>):
    required: true
    

    The identifier of the job that you want to cancel.

    To get a list of the jobs (including their jobId) that have a status of Submitted, use the ListJobsByStatus API action.

    
    
• On success, responds with CancelJobOutput
• On failure, responds with SdkError<CancelJobError>

impl Client

pub fn create_job(&self) -> CreateJobFluentBuilder

Constructs a fluent builder for the CreateJob operation.

• The fluent builder is configurable:
  • pipeline_id(impl Into<String>) / set_pipeline_id(Option<String>):
    required: true
    

    The Id of the pipeline that you want Elastic Transcoder to use for transcoding. The pipeline determines several settings, including the Amazon S3 bucket from which Elastic Transcoder gets the files to transcode and the bucket into which Elastic Transcoder puts the transcoded files.

    
    
  • input(JobInput) / set_input(Option<JobInput>):
    required: false
    

    A section of the request body that provides information about the file that is being transcoded.

    
    
  • inputs(JobInput) / set_inputs(Option<Vec::<JobInput>>):
    required: false
    

    A section of the request body that provides information about the files that are being transcoded.

    
    
  • output(CreateJobOutput) / set_output(Option<CreateJobOutput>):
    required: false
    

    A section of the request body that provides information about the transcoded (target) file. We strongly recommend that you use the Outputs syntax instead of the Output syntax.

    
    
  • outputs(CreateJobOutput) / set_outputs(Option<Vec::<CreateJobOutput>>):
    required: false
    

    A section of the request body that provides information about the transcoded (target) files. We recommend that you use the Outputs syntax instead of the Output syntax.

    
    
  • output_key_prefix(impl Into<String>) / set_output_key_prefix(Option<String>):
    required: false
    

    The value, if any, that you want Elastic Transcoder to prepend to the names of all files that this job creates, including output files, thumbnails, and playlists.

    
    
  • playlists(CreateJobPlaylist) / set_playlists(Option<Vec::<CreateJobPlaylist>>):
    required: false
    

    If you specify a preset in PresetId for which the value of Container is fmp4 (Fragmented MP4) or ts (MPEG-TS), Playlists contains information about the master playlists that you want Elastic Transcoder to create.

    The maximum number of master playlists in a job is 30.

    
    
  • user_metadata(impl Into<String>, impl Into<String>) / set_user_metadata(Option<HashMap::<String, String>>):
    required: false
    

    User-defined metadata that you want to associate with an Elastic Transcoder job. You specify metadata in key/value pairs, and you can add up to 10 key/value pairs per job. Elastic Transcoder does not guarantee that key/value pairs are returned in the same order in which you specify them.

    
    
• On success, responds with CreateJobOutput with field(s):
  • job(Option<Job>):

    A section of the response body that provides information about the job that is created.

• On failure, responds with SdkError<CreateJobError>

impl Client

pub fn create_pipeline(&self) -> CreatePipelineFluentBuilder

Constructs a fluent builder for the CreatePipeline operation.

• The fluent builder is configurable:
  • name(impl Into<String>) / set_name(Option<String>):
    required: true
    

    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.

    
    
  • input_bucket(impl Into<String>) / set_input_bucket(Option<String>):
    required: true
    

    The Amazon S3 bucket in which you saved the media files that you want to transcode.

    
    
  • output_bucket(impl Into<String>) / set_output_bucket(Option<String>):
    required: false
    

    The Amazon S3 bucket in which you want Elastic Transcoder to save the transcoded files. (Use this, or use ContentConfig:Bucket plus ThumbnailConfig:Bucket.)

    Specify this value when all of the following are true:

    • You want to save transcoded files, thumbnails (if any), and playlists (if any) together in one bucket.

    • You do not want to specify the users or groups who have access to the transcoded files, thumbnails, and playlists.

    • You do not want to specify the permissions that Elastic Transcoder grants to the files.

      When Elastic Transcoder saves files in OutputBucket, it grants full control over the files only to the AWS account that owns the role that is specified by Role.

    • You want to associate the transcoded files and thumbnails with the Amazon S3 Standard storage class.

    If you want to save transcoded files and playlists in one bucket and thumbnails in another bucket, specify which users can access the transcoded files or the permissions the users have, or change the Amazon S3 storage class, omit OutputBucket and specify values for ContentConfig and ThumbnailConfig instead.

    
    
  • role(impl Into<String>) / set_role(Option<String>):
    required: true
    

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

    
    
  • aws_kms_key_arn(impl Into<String>) / set_aws_kms_key_arn(Option<String>):
    required: false
    

    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.

    
    
  • notifications(Notifications) / set_notifications(Option<Notifications>):
    required: false
    

    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 a job in this pipeline. This is the ARN that Amazon SNS returned when you created the topic. For more information, see Create a Topic in the Amazon Simple Notification Service Developer Guide.

    • Complete: The topic ARN for the Amazon SNS topic that you want to notify when Elastic Transcoder has finished processing a job in this pipeline. 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 while processing a job in this pipeline. 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 while processing a job in this pipeline. This is the ARN that Amazon SNS returned when you created the topic.

    
    
  • content_config(PipelineOutputConfig) / set_content_config(Option<PipelineOutputConfig>):
    required: false
    

    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.

    
    
  • thumbnail_config(PipelineOutputConfig) / set_thumbnail_config(Option<PipelineOutputConfig>):
    required: false
    

    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.

    
    
• On success, responds with CreatePipelineOutput with field(s):
  • pipeline(Option<Pipeline>):

    A section of the response body that provides information about the pipeline that is created.

  • warnings(Option<Vec::<Warning>>):

    Elastic Transcoder returns a warning if the resources used by your pipeline are not in the same region as the pipeline.

    Using resources in the same region, such as your Amazon S3 buckets, Amazon SNS notification topics, and AWS KMS key, reduces processing time and prevents cross-regional charges.

• On failure, responds with SdkError<CreatePipelineError>

impl Client

pub fn create_preset(&self) -> CreatePresetFluentBuilder

Constructs a fluent builder for the CreatePreset operation.

• The fluent builder is configurable:
  • name(impl Into<String>) / set_name(Option<String>):
    required: true
    

    The name of the preset. We recommend that the name be unique within the AWS account, but uniqueness is not enforced.

    
    
  • description(impl Into<String>) / set_description(Option<String>):
    required: false
    

    A description of the preset.

    
    
  • container(impl Into<String>) / set_container(Option<String>):
    required: true
    

    The container type for the output file. Valid values include flac, flv, fmp4, gif, mp3, mp4, mpg, mxf, oga, ogg, ts, and webm.

    
    
  • video(VideoParameters) / set_video(Option<VideoParameters>):
    required: false
    

    A section of the request body that specifies the video parameters.

    
    
  • audio(AudioParameters) / set_audio(Option<AudioParameters>):
    required: false
    

    A section of the request body that specifies the audio parameters.

    
    
  • thumbnails(Thumbnails) / set_thumbnails(Option<Thumbnails>):
    required: false
    

    A section of the request body that specifies the thumbnail parameters, if any.

    
    
• On success, responds with CreatePresetOutput with field(s):
  • preset(Option<Preset>):

    A section of the response body that provides information about the preset that is created.

  • warning(Option<String>):

    If the preset settings don’t comply with the standards for the video codec but Elastic Transcoder created the preset, this message explains the reason the preset settings don’t meet the standard. Elastic Transcoder created the preset because the settings might produce acceptable output.

• On failure, responds with SdkError<CreatePresetError>

impl Client

pub fn delete_pipeline(&self) -> DeletePipelineFluentBuilder

Constructs a fluent builder for the DeletePipeline operation.

• The fluent builder is configurable:
  • id(impl Into<String>) / set_id(Option<String>):
    required: true
    

    The identifier of the pipeline that you want to delete.

    
    
• On success, responds with DeletePipelineOutput
• On failure, responds with SdkError<DeletePipelineError>

impl Client

pub fn delete_preset(&self) -> DeletePresetFluentBuilder

Constructs a fluent builder for the DeletePreset operation.

• The fluent builder is configurable:
  • id(impl Into<String>) / set_id(Option<String>):
    required: true
    

    The identifier of the preset for which you want to get detailed information.

    
    
• On success, responds with DeletePresetOutput
• On failure, responds with SdkError<DeletePresetError>

impl Client

pub fn list_jobs_by_pipeline(&self) -> ListJobsByPipelineFluentBuilder

Constructs a fluent builder for the ListJobsByPipeline operation. This operation supports pagination; See into_paginator().

• The fluent builder is configurable:
  • pipeline_id(impl Into<String>) / set_pipeline_id(Option<String>):
    required: true
    

    The ID of the pipeline for which you want to get job information.

    
    
  • ascending(impl Into<String>) / set_ascending(Option<String>):
    required: false
    

    To list jobs in chronological order by the date and time that they were submitted, enter true. To list jobs in reverse chronological order, enter false.

    
    
  • page_token(impl Into<String>) / set_page_token(Option<String>):
    required: false
    

    When Elastic Transcoder returns more than one page of results, use pageToken in subsequent GET requests to get each successive page of results.

    
    
• On success, responds with ListJobsByPipelineOutput with field(s):
  • jobs(Option<Vec::<Job>>):

    An array of Job objects that are in the specified pipeline.

  • next_page_token(Option<String>):

    A value that you use to access the second and subsequent pages of results, if any. When the jobs in the specified pipeline fit on one page or when you’ve reached the last page of results, the value of NextPageToken is null.

• On failure, responds with SdkError<ListJobsByPipelineError>

impl Client

pub fn list_jobs_by_status(&self) -> ListJobsByStatusFluentBuilder

Constructs a fluent builder for the ListJobsByStatus operation. This operation supports pagination; See into_paginator().

• The fluent builder is configurable:
  • status(impl Into<String>) / set_status(Option<String>):
    required: true
    

    To get information about all of the jobs associated with the current AWS account that have a given status, specify the following status: Submitted, Progressing, Complete, Canceled, or Error.

    
    
  • ascending(impl Into<String>) / set_ascending(Option<String>):
    required: false
    

    To list jobs in chronological order by the date and time that they were submitted, enter true. To list jobs in reverse chronological order, enter false.

    
    
  • page_token(impl Into<String>) / set_page_token(Option<String>):
    required: false
    

    When Elastic Transcoder returns more than one page of results, use pageToken in subsequent GET requests to get each successive page of results.

    
    
• On success, responds with ListJobsByStatusOutput with field(s):
  • jobs(Option<Vec::<Job>>):

    An array of Job objects that have the specified status.

  • next_page_token(Option<String>):

    A value that you use to access the second and subsequent pages of results, if any. When the jobs in the specified pipeline fit on one page or when you’ve reached the last page of results, the value of NextPageToken is null.

• On failure, responds with SdkError<ListJobsByStatusError>

impl Client

pub fn list_pipelines(&self) -> ListPipelinesFluentBuilder

Constructs a fluent builder for the ListPipelines operation. This operation supports pagination; See into_paginator().

• The fluent builder is configurable:
  • ascending(impl Into<String>) / set_ascending(Option<String>):
    required: false
    

    To list pipelines in chronological order by the date and time that they were created, enter true. To list pipelines in reverse chronological order, enter false.

    
    
  • page_token(impl Into<String>) / set_page_token(Option<String>):
    required: false
    

    When Elastic Transcoder returns more than one page of results, use pageToken in subsequent GET requests to get each successive page of results.

    
    
• On success, responds with ListPipelinesOutput with field(s):
  • pipelines(Option<Vec::<Pipeline>>):

    An array of Pipeline objects.

  • next_page_token(Option<String>):

    A value that you use to access the second and subsequent pages of results, if any. When the pipelines fit on one page or when you’ve reached the last page of results, the value of NextPageToken is null.

• On failure, responds with SdkError<ListPipelinesError>

impl Client

pub fn list_presets(&self) -> ListPresetsFluentBuilder

Constructs a fluent builder for the ListPresets operation. This operation supports pagination; See into_paginator().

• The fluent builder is configurable:
  • ascending(impl Into<String>) / set_ascending(Option<String>):
    required: false
    

    To list presets in chronological order by the date and time that they were created, enter true. To list presets in reverse chronological order, enter false.

    
    
  • page_token(impl Into<String>) / set_page_token(Option<String>):
    required: false
    

    When Elastic Transcoder returns more than one page of results, use pageToken in subsequent GET requests to get each successive page of results.

    
    
• On success, responds with ListPresetsOutput with field(s):
  • presets(Option<Vec::<Preset>>):

    An array of Preset objects.

  • next_page_token(Option<String>):

    A value that you use to access the second and subsequent pages of results, if any. When the presets fit on one page or when you’ve reached the last page of results, the value of NextPageToken is null.

• On failure, responds with SdkError<ListPresetsError>

impl Client

pub fn read_job(&self) -> ReadJobFluentBuilder

Constructs a fluent builder for the ReadJob operation.

• The fluent builder is configurable:
  • id(impl Into<String>) / set_id(Option<String>):
    required: true
    

    The identifier of the job for which you want to get detailed information.

    
    
• On success, responds with ReadJobOutput with field(s):
  • job(Option<Job>):

    A section of the response body that provides information about the job.

• On failure, responds with SdkError<ReadJobError>

impl Client

pub fn read_pipeline(&self) -> ReadPipelineFluentBuilder

Constructs a fluent builder for the ReadPipeline operation.

• The fluent builder is configurable:
  • id(impl Into<String>) / set_id(Option<String>):
    required: true
    

    The identifier of the pipeline to read.

    
    
• On success, responds with ReadPipelineOutput with field(s):
  • pipeline(Option<Pipeline>):

    A section of the response body that provides information about the pipeline.

  • warnings(Option<Vec::<Warning>>):

    Elastic Transcoder returns a warning if the resources used by your pipeline are not in the same region as the pipeline.

    Using resources in the same region, such as your Amazon S3 buckets, Amazon SNS notification topics, and AWS KMS key, reduces processing time and prevents cross-regional charges.

• On failure, responds with SdkError<ReadPipelineError>

impl Client

pub fn read_preset(&self) -> ReadPresetFluentBuilder

Constructs a fluent builder for the ReadPreset operation.

• The fluent builder is configurable:
  • id(impl Into<String>) / set_id(Option<String>):
    required: true
    

    The identifier of the preset for which you want to get detailed information.

    
    
• On success, responds with ReadPresetOutput with field(s):
  • preset(Option<Preset>):

    A section of the response body that provides information about the preset.

• On failure, responds with SdkError<ReadPresetError>

impl Client

pub fn test_role(&self) -> TestRoleFluentBuilder

👎Deprecated

Constructs a fluent builder for the TestRole operation.

• The fluent builder is configurable:
  • role(impl Into<String>) / set_role(Option<String>):
    required: true
    

    The IAM Amazon Resource Name (ARN) for the role that you want Elastic Transcoder to test.

    
    
  • input_bucket(impl Into<String>) / set_input_bucket(Option<String>):
    required: true
    

    The Amazon S3 bucket that contains media files to be transcoded. The action attempts to read from this bucket.

    
    
  • output_bucket(impl Into<String>) / set_output_bucket(Option<String>):
    required: true
    

    The Amazon S3 bucket that Elastic Transcoder writes transcoded media files to. The action attempts to read from this bucket.

    
    
  • topics(impl Into<String>) / set_topics(Option<Vec::<String>>):
    required: true
    

    The ARNs of one or more Amazon Simple Notification Service (Amazon SNS) topics that you want the action to send a test notification to.

    
    
• On success, responds with TestRoleOutput with field(s):
  • success(Option<String>):

    If the operation is successful, this value is true; otherwise, the value is false.

  • messages(Option<Vec::<String>>):

    If the Success element contains false, this value is an array of one or more error messages that were generated during the test process.

• On failure, responds with SdkError<TestRoleError>

impl Client

pub fn update_pipeline(&self) -> UpdatePipelineFluentBuilder

Constructs a fluent builder for the UpdatePipeline operation.

• The fluent builder is configurable:
  • id(impl Into<String>) / set_id(Option<String>):
    required: true
    

    The ID of the pipeline that you want to update.

    
    
  • name(impl Into<String>) / set_name(Option<String>):
    required: false
    

    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

    
    
  • input_bucket(impl Into<String>) / set_input_bucket(Option<String>):
    required: false
    

    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.

    
    
  • role(impl Into<String>) / set_role(Option<String>):
    required: false
    

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

    
    
  • aws_kms_key_arn(impl Into<String>) / set_aws_kms_key_arn(Option<String>):
    required: false
    

    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.

    
    
  • notifications(Notifications) / set_notifications(Option<Notifications>):
    required: false
    

    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.

    
    
  • content_config(PipelineOutputConfig) / set_content_config(Option<PipelineOutputConfig>):
    required: false
    

    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.

    
    
  • thumbnail_config(PipelineOutputConfig) / set_thumbnail_config(Option<PipelineOutputConfig>):
    required: false
    

    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.

    
    
• On success, responds with UpdatePipelineOutput with field(s):
  • pipeline(Option<Pipeline>):

    The pipeline updated by this UpdatePipelineResponse call.

  • warnings(Option<Vec::<Warning>>):

    Elastic Transcoder returns a warning if the resources used by your pipeline are not in the same region as the pipeline.

    Using resources in the same region, such as your Amazon S3 buckets, Amazon SNS notification topics, and AWS KMS key, reduces processing time and prevents cross-regional charges.

• On failure, responds with SdkError<UpdatePipelineError>

impl Client

pub fn update_pipeline_notifications( &self ) -> UpdatePipelineNotificationsFluentBuilder

Constructs a fluent builder for the UpdatePipelineNotifications operation.

• The fluent builder is configurable:
  • id(impl Into<String>) / set_id(Option<String>):
    required: true
    

    The identifier of the pipeline for which you want to change notification settings.

    
    
  • notifications(Notifications) / set_notifications(Option<Notifications>):
    required: true
    

    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.

    
    
• On success, responds with UpdatePipelineNotificationsOutput with field(s):
  • pipeline(Option<Pipeline>):

    A section of the response body that provides information about the pipeline associated with this notification.

• On failure, responds with SdkError<UpdatePipelineNotificationsError>

impl Client

pub fn update_pipeline_status(&self) -> UpdatePipelineStatusFluentBuilder

Constructs a fluent builder for the UpdatePipelineStatus operation.

• The fluent builder is configurable:
  • id(impl Into<String>) / set_id(Option<String>):
    required: true
    

    The identifier of the pipeline to update.

    
    
  • status(impl Into<String>) / set_status(Option<String>):
    required: true
    

    The desired status of the pipeline:

    • Active: The pipeline is processing jobs.

    • Paused: The pipeline is not currently processing jobs.

    
    
• On success, responds with UpdatePipelineStatusOutput with field(s):
  • pipeline(Option<Pipeline>):

    A section of the response body that provides information about the pipeline.

• On failure, responds with SdkError<UpdatePipelineStatusError>

impl Client

pub fn from_conf(conf: Config) -> Self

Creates a new client from the service Config.

Panics

This method will panic in the following cases:

• Retries or timeouts are enabled without a sleep_impl configured.
• Identity caching is enabled without a sleep_impl and time_source configured.
• No behavior_version is provided.

The panic message for each of these will have instructions on how to resolve them.

pub fn config(&self) -> &Config

Returns the client’s configuration.

impl Client

pub fn new(sdk_config: &SdkConfig) -> Self

Creates a new client from an SDK Config.

Panics

• This method will panic if the sdk_config is missing an async sleep implementation. If you experience this panic, set the sleep_impl on the Config passed into this function to fix it.
• This method will panic if the sdk_config is missing an HTTP connector. If you experience this panic, set the http_connector on the Config passed into this function to fix it.
• This method will panic if no BehaviorVersion is provided. If you experience this panic, set behavior_version on the Config or enable the behavior-version-latest Cargo feature.

Trait Implementations

impl Clone for Client

fn clone(&self) -> Client

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for Client

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.