pub struct Client { /* private fields */ }
Expand description

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.

Examples

Constructing a client and invoking an operation

    // create a shared configuration. This can be used & shared between multiple service clients.
    let shared_config = aws_config::load_from_env().await;
    let client = aws_sdk_elastictranscoder::Client::new(&shared_config);
    // invoke an operation
    /* let rsp = client
        .<operation_name>().
        .<param>("some value")
        .send().await; */

Constructing a client with custom configuration

use aws_config::RetryConfig;
    let shared_config = aws_config::load_from_env().await;
    let config = aws_sdk_elastictranscoder::config::Builder::from(&shared_config)
        .retry_config(RetryConfig::disabled())
        .build();
    let client = aws_sdk_elastictranscoder::Client::from_conf(config);

Implementations

Creates a client with the given service configuration.

Returns the client’s configuration.

Constructs a fluent builder for the CancelJob operation.

Constructs a fluent builder for the CreateJob operation.

Constructs a fluent builder for the CreatePipeline operation.

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

      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>):

      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>):

      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>):

      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>):

      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>):

      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>):

      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>):

      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>

Constructs a fluent builder for the CreatePreset operation.

Constructs a fluent builder for the DeletePipeline operation.

Constructs a fluent builder for the DeletePreset operation.

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

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

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

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

Constructs a fluent builder for the ReadJob operation.

Constructs a fluent builder for the ReadPipeline operation.

Constructs a fluent builder for the ReadPreset operation.

Constructs a fluent builder for the TestRole operation.

Constructs a fluent builder for the UpdatePipeline operation.

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

      The ID of the pipeline that you want to update.

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

      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>):

      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>):

      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>):

      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>):

      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>):

      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>):

      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>

Constructs a fluent builder for the UpdatePipelineNotifications operation.

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

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

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

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

      To receive notifications, you must also subscribe to the new topic in the Amazon SNS console.

      • Progressing: The topic ARN for the Amazon Simple Notification Service (Amazon SNS) topic that you want to notify when Elastic Transcoder has started to process jobs that are added to this pipeline. This is the ARN that Amazon SNS returned when you created the topic.

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

Constructs a fluent builder for the UpdatePipelineStatus operation.

Creates a client with the given service config and connector override.

Creates a new client from a shared config.

Creates a new client from the service Config.

Trait Implementations

Returns a copy of the value. Read more

Performs copy-assignment from source. Read more

Formats the value using the given formatter. Read more

Performs the conversion.

Auto Trait Implementations

Blanket Implementations

Gets the TypeId of self. Read more

Immutably borrows from an owned value. Read more

Mutably borrows from an owned value. Read more

Returns the argument unchanged.

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more

Instruments this type with the current Span, returning an Instrumented wrapper. Read more

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

The resulting type after obtaining ownership.

Creates owned data from borrowed data, usually by cloning. Read more

🔬 This is a nightly-only experimental API. (toowned_clone_into)

Uses borrowed data to replace owned data, usually by cloning. Read more

The type returned in the event of a conversion error.

Performs the conversion.

The type returned in the event of a conversion error.

Performs the conversion.

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more