AWS SDK Version 3 for .NET
API Reference

AWS services or capabilities described in AWS Documentation may vary by region/location. Click Getting Started with Amazon AWS to see specific differences applicable to the China (Beijing) Region.

Implementation for accessing TranscribeService Operations and objects for transcribing speech to text.

Inheritance Hierarchy

System.Object
  Amazon.Runtime.AmazonServiceClient
    Amazon.TranscribeService.AmazonTranscribeServiceClient

Namespace: Amazon.TranscribeService
Assembly: AWSSDK.TranscribeService.dll
Version: 3.x.y.z

Syntax

C#
public class AmazonTranscribeServiceClient : AmazonServiceClient
         IAmazonService, IAmazonTranscribeService, IDisposable

The AmazonTranscribeServiceClient type exposes the following members

Constructors

NameDescription
Public Method AmazonTranscribeServiceClient()

Constructs AmazonTranscribeServiceClient with the credentials loaded from the application's default configuration, and if unsuccessful from the Instance Profile service on an EC2 instance. Example App.config with credentials set.



    
        
    

             

Public Method AmazonTranscribeServiceClient(RegionEndpoint)

Constructs AmazonTranscribeServiceClient with the credentials loaded from the application's default configuration, and if unsuccessful from the Instance Profile service on an EC2 instance. Example App.config with credentials set.



    
        
    

             

Public Method AmazonTranscribeServiceClient(AmazonTranscribeServiceConfig)

Constructs AmazonTranscribeServiceClient with the credentials loaded from the application's default configuration, and if unsuccessful from the Instance Profile service on an EC2 instance. Example App.config with credentials set.



    
        
    

             

Public Method AmazonTranscribeServiceClient(AWSCredentials)

Constructs AmazonTranscribeServiceClient with AWS Credentials

Public Method AmazonTranscribeServiceClient(AWSCredentials, RegionEndpoint)

Constructs AmazonTranscribeServiceClient with AWS Credentials

Public Method AmazonTranscribeServiceClient(AWSCredentials, AmazonTranscribeServiceConfig)

Constructs AmazonTranscribeServiceClient with AWS Credentials and an AmazonTranscribeServiceClient Configuration object.

Public Method AmazonTranscribeServiceClient(string, string)

Constructs AmazonTranscribeServiceClient with AWS Access Key ID and AWS Secret Key

Public Method AmazonTranscribeServiceClient(string, string, RegionEndpoint)

Constructs AmazonTranscribeServiceClient with AWS Access Key ID and AWS Secret Key

Public Method AmazonTranscribeServiceClient(string, string, AmazonTranscribeServiceConfig)

Constructs AmazonTranscribeServiceClient with AWS Access Key ID, AWS Secret Key and an AmazonTranscribeServiceClient Configuration object.

Public Method AmazonTranscribeServiceClient(string, string, string)

Constructs AmazonTranscribeServiceClient with AWS Access Key ID and AWS Secret Key

Public Method AmazonTranscribeServiceClient(string, string, string, RegionEndpoint)

Constructs AmazonTranscribeServiceClient with AWS Access Key ID and AWS Secret Key

Public Method AmazonTranscribeServiceClient(string, string, string, AmazonTranscribeServiceConfig)

Constructs AmazonTranscribeServiceClient with AWS Access Key ID, AWS Secret Key and an AmazonTranscribeServiceClient Configuration object.

Properties

NameTypeDescription
Public Property Config Amazon.Runtime.IClientConfig Inherited from Amazon.Runtime.AmazonServiceClient.

Methods

Note:

Asynchronous operations (methods ending with Async) in the table below are for .NET 4.5 or higher. For .NET 3.5 the SDK follows the standard naming convention of BeginMethodName and EndMethodName to indicate asynchronous operations - these method pairs are not shown in the table below.

NameDescription
Public Method CreateVocabulary(CreateVocabularyRequest)

Creates a new custom vocabulary that you can use to change the way Amazon Transcribe handles transcription of an audio file.

Public Method CreateVocabularyAsync(CreateVocabularyRequest, CancellationToken)

Initiates the asynchronous execution of the CreateVocabulary operation.

Public Method DeleteVocabulary(DeleteVocabularyRequest)

Deletes a vocabulary from Amazon Transcribe.

Public Method DeleteVocabularyAsync(DeleteVocabularyRequest, CancellationToken)

Initiates the asynchronous execution of the DeleteVocabulary operation.

Public Method Dispose() Inherited from Amazon.Runtime.AmazonServiceClient.
Public Method GetTranscriptionJob(GetTranscriptionJobRequest)

Returns information about a transcription job. To see the status of the job, check the TranscriptionJobStatus field. If the status is COMPLETED, the job is finished and you can find the results at the location specified in the TranscriptionFileUri field.

Public Method GetTranscriptionJobAsync(GetTranscriptionJobRequest, CancellationToken)

Initiates the asynchronous execution of the GetTranscriptionJob operation.

Public Method GetVocabulary(GetVocabularyRequest)

Gets information about a vocabulary.

Public Method GetVocabularyAsync(GetVocabularyRequest, CancellationToken)

Initiates the asynchronous execution of the GetVocabulary operation.

Public Method ListTranscriptionJobs(ListTranscriptionJobsRequest)

Lists transcription jobs with the specified status.

Public Method ListTranscriptionJobsAsync(ListTranscriptionJobsRequest, CancellationToken)

Initiates the asynchronous execution of the ListTranscriptionJobs operation.

Public Method ListVocabularies(ListVocabulariesRequest)

Returns a list of vocabularies that match the specified criteria. If no criteria are specified, returns the entire list of vocabularies.

Public Method ListVocabulariesAsync(ListVocabulariesRequest, CancellationToken)

Initiates the asynchronous execution of the ListVocabularies operation.

Public Method StartTranscriptionJob(StartTranscriptionJobRequest)

Starts an asynchronous job to transcribe speech to text.

Public Method StartTranscriptionJobAsync(StartTranscriptionJobRequest, CancellationToken)

Initiates the asynchronous execution of the StartTranscriptionJob operation.

Public Method UpdateVocabulary(UpdateVocabularyRequest)

Updates an existing vocabulary with new values. The UpdateVocabulary operation overwrites all of the existing information with the values that you provide in the request.

Public Method UpdateVocabularyAsync(UpdateVocabularyRequest, CancellationToken)

Initiates the asynchronous execution of the UpdateVocabulary operation.

Events

NameDescription
Event AfterResponseEvent Inherited from Amazon.Runtime.AmazonServiceClient.
Event BeforeRequestEvent Inherited from Amazon.Runtime.AmazonServiceClient.
Event ExceptionEvent Inherited from Amazon.Runtime.AmazonServiceClient.

Version Information

.NET Standard:
Supported in: 1.3

.NET Framework:
Supported in: 4.5, 4.0, 3.5

Portable Class Library:
Supported in: Windows Store Apps
Supported in: Windows Phone 8.1
Supported in: Xamarin Android
Supported in: Xamarin iOS (Unified)
Supported in: Xamarin.Forms