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

Client for Amazon Transcribe Service

Client for invoking operations on Amazon Transcribe Service. Each operation on Amazon Transcribe Service 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_transcribe::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_transcribe::config::Builder::from(&shared_config)
  .retry_config(RetryConfig::disabled())
  .build();
let client = aws_sdk_transcribe::Client::from_conf(config);

Implementations

Creates a client with the given service configuration.

Returns the client’s configuration.

Constructs a fluent builder for the CreateCallAnalyticsCategory operation.

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

      A unique name, chosen by you, for your call analytics category. For example, sentiment-positive-last30seconds.

    • rules(Vec<Rule>) / set_rules(Option<Vec<Rule>>):

      Rules make up a call analytics category. When creating a call analytics category, you must create between 1 and 20 rules for your category. For each rule, you specify a filter you want applied to the attributes of a call. For example, you can choose a sentiment filter that detects if a customer’s sentiment was positive during the last 30 seconds of the call.

  • On success, responds with CreateCallAnalyticsCategoryOutput with field(s):
    • category_properties(Option<CategoryProperties>):

      If your audio matches one of your categories, this field contains data on that category and its associated rules. This parameter shows which category is flagged (CategoryName) along with metadata for the rules that match your audio. Metadata includes the rule filter (such as InterruptionFilter, NonTalkTimeFilter, SentimentFilter, and TranscriptFilter) and where in your audio (StartTime and EndTime) the rule has a match.

  • On failure, responds with SdkError<CreateCallAnalyticsCategoryError>

Constructs a fluent builder for the CreateLanguageModel operation.

Constructs a fluent builder for the CreateMedicalVocabulary operation.

Constructs a fluent builder for the CreateVocabulary operation.

Constructs a fluent builder for the CreateVocabularyFilter operation.

Constructs a fluent builder for the DeleteCallAnalyticsCategory operation.

Constructs a fluent builder for the DeleteCallAnalyticsJob operation.

Constructs a fluent builder for the DeleteLanguageModel operation.

Constructs a fluent builder for the DeleteMedicalTranscriptionJob operation.

Constructs a fluent builder for the DeleteMedicalVocabulary operation.

Constructs a fluent builder for the DeleteTranscriptionJob operation.

Constructs a fluent builder for the DeleteVocabulary operation.

Constructs a fluent builder for the DeleteVocabularyFilter operation.

Constructs a fluent builder for the DescribeLanguageModel operation.

Constructs a fluent builder for the GetCallAnalyticsCategory operation.

Constructs a fluent builder for the GetCallAnalyticsJob operation.

Constructs a fluent builder for the GetMedicalTranscriptionJob operation.

Constructs a fluent builder for the GetMedicalVocabulary operation.

Constructs a fluent builder for the GetTranscriptionJob operation.

Constructs a fluent builder for the GetVocabulary operation.

Constructs a fluent builder for the GetVocabularyFilter operation.

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

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

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

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

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

Constructs a fluent builder for the ListTagsForResource operation.

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

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

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

Constructs a fluent builder for the StartCallAnalyticsJob operation.

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

      The name of the call analytics job. You can’t use the string “.” or “..” by themselves as the job name. The name must also be unique within an Amazon Web Services account. If you try to create a call analytics job with the same name as a previous call analytics job, you get a ConflictException error.

    • media(Media) / set_media(Option<Media>):

      Describes the input media file in a transcription request.

    • output_location(impl Into<String>) / set_output_location(Option<String>):

      The Amazon S3 location where the output of the call analytics job is stored. You can provide the following location types to store the output of call analytics job:

      • s3://DOC-EXAMPLE-BUCKET1

        If you specify a bucket, Amazon Transcribe saves the output of the analytics job as a JSON file at the root level of the bucket.

      • s3://DOC-EXAMPLE-BUCKET1/folder/

        f you specify a path, Amazon Transcribe saves the output of the analytics job as s3://DOC-EXAMPLE-BUCKET1/folder/your-transcription-job-name.json.

        If you specify a folder, you must provide a trailing slash.

      • s3://DOC-EXAMPLE-BUCKET1/folder/filename.json.

        If you provide a path that has the filename specified, Amazon Transcribe saves the output of the analytics job as s3://DOC-EXAMPLEBUCKET1/folder/filename.json.

      You can specify an Amazon Web Services Key Management Service (KMS) key to encrypt the output of our analytics job using the OutputEncryptionKMSKeyId parameter. If you don’t specify a KMS key, Amazon Transcribe uses the default Amazon S3 key for server-side encryption of the analytics job output that is placed in your S3 bucket.

    • output_encryption_kms_key_id(impl Into<String>) / set_output_encryption_kms_key_id(Option<String>):

      The Amazon Resource Name (ARN) of the Amazon Web Services Key Management Service key used to encrypt the output of the call analytics job. The user calling the operation must have permission to use the specified KMS key.

      You use either of the following to identify an Amazon Web Services KMS key in the current account:

      • KMS Key ID: “1234abcd-12ab-34cd-56ef-1234567890ab”

      • KMS Key Alias: “alias/ExampleAlias”

      You can use either of the following to identify a KMS key in the current account or another account:

      • Amazon Resource Name (ARN) of a KMS key in the current account or another account: “arn:aws:kms:region:account ID:key/1234abcd-12ab-34cd-56ef1234567890ab”

      • ARN of a KMS Key Alias: “arn:aws:kms:region:accountID:alias/ExampleAlias”

      If you don’t specify an encryption key, the output of the call analytics job is encrypted with the default Amazon S3 key (SSE-S3).

      If you specify a KMS key to encrypt your output, you must also specify an output location in the OutputLocation parameter.

    • data_access_role_arn(impl Into<String>) / set_data_access_role_arn(Option<String>):

      The Amazon Resource Name (ARN) of a role that has access to the S3 bucket that contains your input files. Amazon Transcribe assumes this role to read queued audio files. If you have specified an output S3 bucket for your transcription results, this role should have access to the output bucket as well.

    • settings(CallAnalyticsJobSettings) / set_settings(Option<CallAnalyticsJobSettings>):

      A Settings object that provides optional settings for a call analytics job.

    • channel_definitions(Vec<ChannelDefinition>) / set_channel_definitions(Option<Vec<ChannelDefinition>>):

      When you start a call analytics job, you must pass an array that maps the agent and the customer to specific audio channels. The values you can assign to a channel are 0 and 1. The agent and the customer must each have their own channel. You can’t assign more than one channel to an agent or customer.

  • On success, responds with StartCallAnalyticsJobOutput with field(s):
  • On failure, responds with SdkError<StartCallAnalyticsJobError>

Constructs a fluent builder for the StartMedicalTranscriptionJob operation.

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

      The name of the medical transcription job. You can’t use the strings “.” or “..” by themselves as the job name. The name must also be unique within an Amazon Web Services account. If you try to create a medical transcription job with the same name as a previous medical transcription job, you get a ConflictException error.

    • language_code(LanguageCode) / set_language_code(Option<LanguageCode>):

      The language code for the language spoken in the input media file. US English (en-US) is the valid value for medical transcription jobs. Any other value you enter for language code results in a BadRequestException error.

    • media_sample_rate_hertz(i32) / set_media_sample_rate_hertz(Option<i32>):

      The sample rate, in Hertz, of the audio track in the input media file.

      If you do not specify the media sample rate, Amazon Transcribe Medical determines the sample rate. If you specify the sample rate, it must match the rate detected by Amazon Transcribe Medical. In most cases, you should leave the MediaSampleRateHertz field blank and let Amazon Transcribe Medical determine the sample rate.

    • media_format(MediaFormat) / set_media_format(Option<MediaFormat>):

      The audio format of the input media file.

    • media(Media) / set_media(Option<Media>):

      Describes the input media file in a transcription request.

    • output_bucket_name(impl Into<String>) / set_output_bucket_name(Option<String>):

      The Amazon S3 location where the transcription is stored.

      You must set OutputBucketName for Amazon Transcribe Medical to store the transcription results. Your transcript appears in the S3 location you specify. When you call the GetMedicalTranscriptionJob, the operation returns this location in the TranscriptFileUri field. The S3 bucket must have permissions that allow Amazon Transcribe Medical to put files in the bucket. For more information, see Permissions Required for IAM User Roles.

      You can specify an Amazon Web Services Key Management Service (KMS) key to encrypt the output of your transcription using the OutputEncryptionKMSKeyId parameter. If you don’t specify a KMS key, Amazon Transcribe Medical uses the default Amazon S3 key for server-side encryption of transcripts that are placed in your S3 bucket.

    • output_key(impl Into<String>) / set_output_key(Option<String>):

      You can specify a location in an Amazon S3 bucket to store the output of your medical transcription job.

      If you don’t specify an output key, Amazon Transcribe Medical stores the output of your transcription job in the Amazon S3 bucket you specified. By default, the object key is “your-transcription-job-name.json”.

      You can use output keys to specify the Amazon S3 prefix and file name of the transcription output. For example, specifying the Amazon S3 prefix, “folder1/folder2/”, as an output key would lead to the output being stored as “folder1/folder2/your-transcription-job-name.json”. If you specify “my-other-job-name.json” as the output key, the object key is changed to “my-other-job-name.json”. You can use an output key to change both the prefix and the file name, for example “folder/my-other-job-name.json”.

      If you specify an output key, you must also specify an S3 bucket in the OutputBucketName parameter.

    • output_encryption_kms_key_id(impl Into<String>) / set_output_encryption_kms_key_id(Option<String>):

      The Amazon Resource Name (ARN) of the Amazon Web Services Key Management Service (KMS) key used to encrypt the output of the transcription job. The user calling the StartMedicalTranscriptionJob operation must have permission to use the specified KMS key.

      You use either of the following to identify a KMS key in the current account:

      • KMS Key ID: “1234abcd-12ab-34cd-56ef-1234567890ab”

      • KMS Key Alias: “alias/ExampleAlias”

      You can use either of the following to identify a KMS key in the current account or another account:

      • Amazon Resource Name (ARN) of a KMS key in the current account or another account: “arn:aws:kms:region:account-ID:key/1234abcd-12ab-34cd-56ef-1234567890ab”

      • ARN of a KMS Key Alias: “arn:aws:kms:region:account ID:alias/ExampleAlias”

      If you don’t specify an encryption key, the output of the medical transcription job is encrypted with the default Amazon S3 key (SSE-S3).

      If you specify a KMS key to encrypt your output, you must also specify an output location in the OutputBucketName parameter.

    • kms_encryption_context(HashMap<String, String>) / set_kms_encryption_context(Option<HashMap<String, String>>):

      A map of plain text, non-secret key:value pairs, known as encryption context pairs, that provide an added layer of security for your data.

    • settings(MedicalTranscriptionSetting) / set_settings(Option<MedicalTranscriptionSetting>):

      Optional settings for the medical transcription job.

    • content_identification_type(MedicalContentIdentificationType) / set_content_identification_type(Option<MedicalContentIdentificationType>):

      You can configure Amazon Transcribe Medical to label content in the transcription output. If you specify PHI, Amazon Transcribe Medical labels the personal health information (PHI) that it identifies in the transcription output.

    • specialty(Specialty) / set_specialty(Option<Specialty>):

      The medical specialty of any clinician speaking in the input media.

    • r#type(Type) / set_type(Option<Type>):

      The type of speech in the input audio. CONVERSATION refers to conversations between two or more speakers, e.g., a conversations between doctors and patients. DICTATION refers to single-speaker dictated speech, such as clinical notes.

    • tags(Vec<Tag>) / set_tags(Option<Vec<Tag>>):

      Add tags to an Amazon Transcribe Medical transcription job.

  • On success, responds with StartMedicalTranscriptionJobOutput with field(s):
  • On failure, responds with SdkError<StartMedicalTranscriptionJobError>

Constructs a fluent builder for the StartTranscriptionJob operation.

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

      The name of the job. You can’t use the strings “.” or “..” by themselves as the job name. The name must also be unique within an Amazon Web Services account. If you try to create a transcription job with the same name as a previous transcription job, you get a ConflictException error.

    • language_code(LanguageCode) / set_language_code(Option<LanguageCode>):

      The language code for the language used in the input media file. You must include either LanguageCode or IdentifyLanguage in your request.

      To transcribe speech in Modern Standard Arabic (ar-SA), your audio or video file must be encoded at a sample rate of 16,000 Hz or higher.

    • media_sample_rate_hertz(i32) / set_media_sample_rate_hertz(Option<i32>):

      The sample rate, in Hertz, of the audio track in the input media file.

      If you do not specify the media sample rate, Amazon Transcribe determines the sample rate. If you specify the sample rate, it must match the sample rate detected by Amazon Transcribe. In most cases, you should leave the MediaSampleRateHertz field blank and let Amazon Transcribe determine the sample rate.

    • media_format(MediaFormat) / set_media_format(Option<MediaFormat>):

      The format of the input media file.

    • media(Media) / set_media(Option<Media>):

      An object that describes the input media for a transcription job.

    • output_bucket_name(impl Into<String>) / set_output_bucket_name(Option<String>):

      The location where the transcription is stored.

      If you set the OutputBucketName, Amazon Transcribe puts the transcript in the specified S3 bucket. When you call the GetTranscriptionJob operation, the operation returns this location in the TranscriptFileUri field. If you enable content redaction, the redacted transcript appears in RedactedTranscriptFileUri. If you enable content redaction and choose to output an unredacted transcript, that transcript’s location still appears in the TranscriptFileUri. The S3 bucket must have permissions that allow Amazon Transcribe to put files in the bucket. For more information, see Permissions Required for IAM User Roles.

      You can specify an Amazon Web Services Key Management Service (KMS) key to encrypt the output of your transcription using the OutputEncryptionKMSKeyId parameter. If you don’t specify a KMS key, Amazon Transcribe uses the default Amazon S3 key for server-side encryption of transcripts that are placed in your S3 bucket.

      If you don’t set the OutputBucketName, Amazon Transcribe generates a pre-signed URL, a shareable URL that provides secure access to your transcription, and returns it in the TranscriptFileUri field. Use this URL to download the transcription.

    • output_key(impl Into<String>) / set_output_key(Option<String>):

      You can specify a location in an Amazon S3 bucket to store the output of your transcription job.

      If you don’t specify an output key, Amazon Transcribe stores the output of your transcription job in the Amazon S3 bucket you specified. By default, the object key is “your-transcription-job-name.json”.

      You can use output keys to specify the Amazon S3 prefix and file name of the transcription output. For example, specifying the Amazon S3 prefix, “folder1/folder2/”, as an output key would lead to the output being stored as “folder1/folder2/your-transcription-job-name.json”. If you specify “my-other-job-name.json” as the output key, the object key is changed to “my-other-job-name.json”. You can use an output key to change both the prefix and the file name, for example “folder/my-other-job-name.json”.

      If you specify an output key, you must also specify an S3 bucket in the OutputBucketName parameter.

    • output_encryption_kms_key_id(impl Into<String>) / set_output_encryption_kms_key_id(Option<String>):

      The Amazon Resource Name (ARN) of the Amazon Web Services Key Management Service (KMS) key used to encrypt the output of the transcription job. The user calling the StartTranscriptionJob operation must have permission to use the specified KMS key.

      You can use either of the following to identify a KMS key in the current account:

      • KMS Key ID: “1234abcd-12ab-34cd-56ef-1234567890ab”

      • KMS Key Alias: “alias/ExampleAlias”

      You can use either of the following to identify a KMS key in the current account or another account:

      • Amazon Resource Name (ARN) of a KMS Key: “arn:aws:kms:region:account ID:key/1234abcd-12ab-34cd-56ef-1234567890ab”

      • ARN of a KMS Key Alias: “arn:aws:kms:region:account-ID:alias/ExampleAlias”

      If you don’t specify an encryption key, the output of the transcription job is encrypted with the default Amazon S3 key (SSE-S3).

      If you specify a KMS key to encrypt your output, you must also specify an output location in the OutputBucketName parameter.

    • kms_encryption_context(HashMap<String, String>) / set_kms_encryption_context(Option<HashMap<String, String>>):

      A map of plain text, non-secret key:value pairs, known as encryption context pairs, that provide an added layer of security for your data.

    • settings(Settings) / set_settings(Option<Settings>):

      A Settings object that provides optional settings for a transcription job.

    • model_settings(ModelSettings) / set_model_settings(Option<ModelSettings>):

      Choose the custom language model you use for your transcription job in this parameter.

    • job_execution_settings(JobExecutionSettings) / set_job_execution_settings(Option<JobExecutionSettings>):

      Provides information about how a transcription job is executed. Use this field to indicate that the job can be queued for deferred execution if the concurrency limit is reached and there are no slots available to immediately run the job.

    • content_redaction(ContentRedaction) / set_content_redaction(Option<ContentRedaction>):

      An object that contains the request parameters for content redaction.

    • identify_language(bool) / set_identify_language(Option<bool>):

      Set this field to true to enable automatic language identification. Automatic language identification is disabled by default. You receive a BadRequestException error if you enter a value for a LanguageCode.

      You must include either LanguageCode or IdentifyLanguage in your request.

    • language_options(Vec<LanguageCode>) / set_language_options(Option<Vec<LanguageCode>>):

      An object containing a list of languages that might be present in your collection of audio files. Automatic language identification chooses a language that best matches the source audio from that list.

      To transcribe speech in Modern Standard Arabic (ar-SA), your audio or video file must be encoded at a sample rate of 16,000 Hz or higher.

    • subtitles(Subtitles) / set_subtitles(Option<Subtitles>):

      Add subtitles to your batch transcription job.

    • tags(Vec<Tag>) / set_tags(Option<Vec<Tag>>):

      Add tags to an Amazon Transcribe transcription job.

    • language_id_settings(HashMap<LanguageCode, LanguageIdSettings>) / set_language_id_settings(Option<HashMap<LanguageCode, LanguageIdSettings>>):

      The language identification settings associated with your transcription job. These settings include VocabularyName, VocabularyFilterName, and LanguageModelName.

  • On success, responds with StartTranscriptionJobOutput with field(s):
  • On failure, responds with SdkError<StartTranscriptionJobError>

Constructs a fluent builder for the TagResource operation.

Constructs a fluent builder for the UntagResource operation.

Constructs a fluent builder for the UpdateCallAnalyticsCategory operation.

Constructs a fluent builder for the UpdateMedicalVocabulary operation.

Constructs a fluent builder for the UpdateVocabulary operation.

Constructs a fluent builder for the UpdateVocabularyFilter 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

Converts to this type from the input type.

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

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