AWSTranscribe

Objective-C

@interface AWSTranscribe

Swift

class AWSTranscribe

Amazon Transcribe offers three main types of batch transcription: Standard, Medical, and Call Analytics.

  • Standard transcriptions are the most common option. Refer to for details.

  • Medical transcriptions are tailored to medical professionals and incorporate medical terms. A common use case for this service is transcribing doctor-patient dialogue into after-visit notes. Refer to for details.

  • Call Analytics transcriptions are designed for use with call center audio on two different channels; if you’re looking for insight into customer service calls, use this option. Refer to for details.

  • The service configuration used to instantiate this service client.

    Warning

    Once the client is instantiated, do not modify the configuration object. It may cause unspecified behaviors.

    Declaration

    Objective-C

    @property (nonatomic, strong, readonly) AWSServiceConfiguration *configuration

  • Returns the singleton service client. If the singleton object does not exist, the SDK instantiates the default service client with defaultServiceConfiguration from [AWSServiceManager defaultServiceManager]. The reference to this object is maintained by the SDK, and you do not need to retain it manually.

    For example, set the default service configuration in - application:didFinishLaunchingWithOptions:

    Swift

    func application(_ application: UIApplication, didFinishLaunchingWithOptions launchOptions: [UIApplicationLaunchOptionsKey: Any]?) -> Bool {
   let credentialProvider = AWSCognitoCredentialsProvider(regionType: .USEast1, identityPoolId: "YourIdentityPoolId")
   let configuration = AWSServiceConfiguration(region: .USEast1, credentialsProvider: credentialProvider)
   AWSServiceManager.default().defaultServiceConfiguration = configuration

   return true

    }

    Objective-C

    - (BOOL)application:(UIApplication *)application didFinishLaunchingWithOptions:(NSDictionary *)launchOptions {
     AWSCognitoCredentialsProvider *credentialsProvider = [[AWSCognitoCredentialsProvider alloc] initWithRegionType:AWSRegionUSEast1
                                                                                                     identityPoolId:@"YourIdentityPoolId"];
     AWSServiceConfiguration *configuration = [[AWSServiceConfiguration alloc] initWithRegion:AWSRegionUSEast1
                                                                          credentialsProvider:credentialsProvider];
     [AWSServiceManager defaultServiceManager].defaultServiceConfiguration = configuration;

     return YES;
 }

    Then call the following to get the default service client:

    Swift

    let Transcribe = AWSTranscribe.default()

    Objective-C

    AWSTranscribe *Transcribe = [AWSTranscribe defaultTranscribe];

    Declaration

    Objective-C

    + (nonnull instancetype)defaultTranscribe;

    Swift

    class func `default`() -> Self

    Return Value

    The default service client.

  • Creates a service client with the given service configuration and registers it for the key.

    For example, set the default service configuration in - application:didFinishLaunchingWithOptions:

    Swift

    func application(_ application: UIApplication, didFinishLaunchingWithOptions launchOptions: [UIApplicationLaunchOptionsKey: Any]?) -> Bool {
   let credentialProvider = AWSCognitoCredentialsProvider(regionType: .USEast1, identityPoolId: "YourIdentityPoolId")
   let configuration = AWSServiceConfiguration(region: .USWest2, credentialsProvider: credentialProvider)
   AWSTranscribe.register(with: configuration!, forKey: "USWest2Transcribe")

   return true

    }

    Objective-C

    - (BOOL)application:(UIApplication *)application didFinishLaunchingWithOptions:(NSDictionary *)launchOptions {
    AWSCognitoCredentialsProvider *credentialsProvider = [[AWSCognitoCredentialsProvider alloc] initWithRegionType:AWSRegionUSEast1
                                                                                                    identityPoolId:@"YourIdentityPoolId"];
    AWSServiceConfiguration *configuration = [[AWSServiceConfiguration alloc] initWithRegion:AWSRegionUSWest2
                                                                         credentialsProvider:credentialsProvider];

    [AWSTranscribe registerTranscribeWithConfiguration:configuration forKey:@"USWest2Transcribe"];

    return YES;
}

    Then call the following to get the service client:

    Swift

    let Transcribe = AWSTranscribe(forKey: "USWest2Transcribe")

    Objective-C

    AWSTranscribe *Transcribe = [AWSTranscribe TranscribeForKey:@"USWest2Transcribe"];

    Warning

    After calling this method, do not modify the configuration object. It may cause unspecified behaviors.

    Declaration

    Objective-C

    + (void)registerTranscribeWithConfiguration:(id)configuration
                                     forKey:(nonnull NSString *)key;

    Swift

    class func register(withConfiguration configuration: Any!, forKey key: String)

    Parameters

    configuration

    A service configuration object.
    key

    A string to identify the service client.

  • Retrieves the service client associated with the key. You need to call + registerTranscribeWithConfiguration:forKey: before invoking this method.

    For example, set the default service configuration in - application:didFinishLaunchingWithOptions:

    Swift

    func application(_ application: UIApplication, didFinishLaunchingWithOptions launchOptions: [UIApplicationLaunchOptionsKey: Any]?) -> Bool {
   let credentialProvider = AWSCognitoCredentialsProvider(regionType: .USEast1, identityPoolId: "YourIdentityPoolId")
   let configuration = AWSServiceConfiguration(region: .USWest2, credentialsProvider: credentialProvider)
   AWSTranscribe.register(with: configuration!, forKey: "USWest2Transcribe")

   return true

    }

    Objective-C

    - (BOOL)application:(UIApplication *)application didFinishLaunchingWithOptions:(NSDictionary *)launchOptions {
    AWSCognitoCredentialsProvider *credentialsProvider = [[AWSCognitoCredentialsProvider alloc] initWithRegionType:AWSRegionUSEast1
                                                                                                    identityPoolId:@"YourIdentityPoolId"];
    AWSServiceConfiguration *configuration = [[AWSServiceConfiguration alloc] initWithRegion:AWSRegionUSWest2
                                                                         credentialsProvider:credentialsProvider];

    [AWSTranscribe registerTranscribeWithConfiguration:configuration forKey:@"USWest2Transcribe"];

    return YES;
}

    Then call the following to get the service client:

    Swift

    let Transcribe = AWSTranscribe(forKey: "USWest2Transcribe")

    Objective-C

    AWSTranscribe *Transcribe = [AWSTranscribe TranscribeForKey:@"USWest2Transcribe"];

    Declaration

    Objective-C

    + (nonnull instancetype)TranscribeForKey:(nonnull NSString *)key;

    Swift

    convenience init(forKey key: String)

    Parameters

    key

    A string to identify the service client.

    Return Value

    An instance of the service client.

  • Removes the service client associated with the key and release it.

    Warning

    Before calling this method, make sure no method is running on this client.

    Declaration

    Objective-C

    + (void)removeTranscribeForKey:(nonnull NSString *)key;

    Swift

    class func remove(forKey key: String)

    Parameters

    key

    A string to identify the service client.

  • Creates a new Call Analytics category.

    All categories are automatically applied to your Call Analytics transcriptions. Note that in order to apply categories to your transcriptions, you must create them before submitting your transcription request, as categories cannot be applied retroactively.

    When creating a new category, you can use the InputType parameter to label the category as a POST_CALL or a REAL_TIME category. POST_CALL categories can only be applied to post-call transcriptions and REAL_TIME categories can only be applied to real-time transcriptions. If you do not include InputType, your category is created as a POST_CALL category by default.

    Call Analytics categories are composed of rules. For each category, you must create between 1 and 20 rules. Rules can include these parameters: , , , and .

    To update an existing category, see .

    To learn more about Call Analytics categories, see Creating categories for post-call transcriptions and Creating categories for real-time transcriptions.

    See

    AWSTranscribeCreateCallAnalyticsCategoryRequest

    See

    AWSTranscribeCreateCallAnalyticsCategoryResponse

    Declaration

    Objective-C

    - (id)createCallAnalyticsCategory:
    (nonnull AWSTranscribeCreateCallAnalyticsCategoryRequest *)request;

    Swift

    func createCallAnalyticsCategory(_ request: AWSTranscribeCreateCallAnalyticsCategoryRequest) -> Any!

    Parameters

    request

    A container for the necessary parameters to execute the CreateCallAnalyticsCategory service method.

    Return Value

    An instance of AWSTask. On successful execution, task.result will contain an instance of AWSTranscribeCreateCallAnalyticsCategoryResponse. On failed execution, task.error may contain an NSError with AWSTranscribeErrorDomain domain and the following error code: AWSTranscribeErrorBadRequest, AWSTranscribeErrorLimitExceeded, AWSTranscribeErrorInternalFailure, AWSTranscribeErrorConflict.

  • Creates a new Call Analytics category.

    All categories are automatically applied to your Call Analytics transcriptions. Note that in order to apply categories to your transcriptions, you must create them before submitting your transcription request, as categories cannot be applied retroactively.

    When creating a new category, you can use the InputType parameter to label the category as a POST_CALL or a REAL_TIME category. POST_CALL categories can only be applied to post-call transcriptions and REAL_TIME categories can only be applied to real-time transcriptions. If you do not include InputType, your category is created as a POST_CALL category by default.

    Call Analytics categories are composed of rules. For each category, you must create between 1 and 20 rules. Rules can include these parameters: , , , and .

    To update an existing category, see .

    To learn more about Call Analytics categories, see Creating categories for post-call transcriptions and Creating categories for real-time transcriptions.

    See

    AWSTranscribeCreateCallAnalyticsCategoryRequest

    See

    AWSTranscribeCreateCallAnalyticsCategoryResponse

    Declaration

    Objective-C

    - (void)createCallAnalyticsCategory:
            (nonnull AWSTranscribeCreateCallAnalyticsCategoryRequest *)request
                  completionHandler:
                      (void (^_Nullable)(
                          AWSTranscribeCreateCallAnalyticsCategoryResponse
                              *_Nullable,
                          NSError *_Nullable))completionHandler;

    Swift

    func createCallAnalyticsCategory(_ request: AWSTranscribeCreateCallAnalyticsCategoryRequest) async throws -> AWSTranscribeCreateCallAnalyticsCategoryResponse

    Parameters

    request

    A container for the necessary parameters to execute the CreateCallAnalyticsCategory service method.
    completionHandler

    The completion handler to call when the load request is complete. response - A response object, or nil if the request failed. error - An error object that indicates why the request failed, or nil if the request was successful. On failed execution, error may contain an NSError with AWSTranscribeErrorDomain domain and the following error code: AWSTranscribeErrorBadRequest, AWSTranscribeErrorLimitExceeded, AWSTranscribeErrorInternalFailure, AWSTranscribeErrorConflict.

  • Creates a new custom language model.

    When creating a new custom language model, you must specify:

    • If you want a Wideband (audio sample rates over 16,000 Hz) or Narrowband (audio sample rates under 16,000 Hz) base model

    • The location of your training and tuning files (this must be an Amazon S3 URI)

    • The language of your model

    • A unique name for your model

    See

    AWSTranscribeCreateLanguageModelRequest

    See

    AWSTranscribeCreateLanguageModelResponse

    Declaration

    Objective-C

    - (id)createLanguageModel:
    (nonnull AWSTranscribeCreateLanguageModelRequest *)request;

    Swift

    func createLanguageModel(_ request: AWSTranscribeCreateLanguageModelRequest) -> Any!

    Parameters

    request

    A container for the necessary parameters to execute the CreateLanguageModel service method.

    Return Value

    An instance of AWSTask. On successful execution, task.result will contain an instance of AWSTranscribeCreateLanguageModelResponse. On failed execution, task.error may contain an NSError with AWSTranscribeErrorDomain domain and the following error code: AWSTranscribeErrorBadRequest, AWSTranscribeErrorLimitExceeded, AWSTranscribeErrorInternalFailure, AWSTranscribeErrorConflict.

  • Creates a new custom language model.

    When creating a new custom language model, you must specify:

    • If you want a Wideband (audio sample rates over 16,000 Hz) or Narrowband (audio sample rates under 16,000 Hz) base model

    • The location of your training and tuning files (this must be an Amazon S3 URI)

    • The language of your model

    • A unique name for your model

    See

    AWSTranscribeCreateLanguageModelRequest

    See

    AWSTranscribeCreateLanguageModelResponse

    Declaration

    Objective-C

    - (void)createLanguageModel:
            (nonnull AWSTranscribeCreateLanguageModelRequest *)request
          completionHandler:
              (void (^_Nullable)(
                  AWSTranscribeCreateLanguageModelResponse *_Nullable,
                  NSError *_Nullable))completionHandler;

    Swift

    func createLanguageModel(_ request: AWSTranscribeCreateLanguageModelRequest) async throws -> AWSTranscribeCreateLanguageModelResponse

    Parameters

    request

    A container for the necessary parameters to execute the CreateLanguageModel service method.
    completionHandler

    The completion handler to call when the load request is complete. response - A response object, or nil if the request failed. error - An error object that indicates why the request failed, or nil if the request was successful. On failed execution, error may contain an NSError with AWSTranscribeErrorDomain domain and the following error code: AWSTranscribeErrorBadRequest, AWSTranscribeErrorLimitExceeded, AWSTranscribeErrorInternalFailure, AWSTranscribeErrorConflict.

  • Creates a new custom medical vocabulary.

    Before creating a new custom medical vocabulary, you must first upload a text file that contains your vocabulary table into an Amazon S3 bucket. Note that this differs from , where you can include a list of terms within your request using the Phrases flag; CreateMedicalVocabulary does not support the Phrases flag and only accepts vocabularies in table format.

    Each language has a character set that contains all allowed characters for that specific language. If you use unsupported characters, your custom vocabulary request fails. Refer to Character Sets for Custom Vocabularies to get the character set for your language.

    For more information, see Custom vocabularies.

    See

    AWSTranscribeCreateMedicalVocabularyRequest

    See

    AWSTranscribeCreateMedicalVocabularyResponse

    Declaration

    Objective-C

    - (id)createMedicalVocabulary:
    (nonnull AWSTranscribeCreateMedicalVocabularyRequest *)request;

    Swift

    func createMedicalVocabulary(_ request: AWSTranscribeCreateMedicalVocabularyRequest) -> Any!

    Parameters

    request

    A container for the necessary parameters to execute the CreateMedicalVocabulary service method.

    Return Value

    An instance of AWSTask. On successful execution, task.result will contain an instance of AWSTranscribeCreateMedicalVocabularyResponse. On failed execution, task.error may contain an NSError with AWSTranscribeErrorDomain domain and the following error code: AWSTranscribeErrorBadRequest, AWSTranscribeErrorLimitExceeded, AWSTranscribeErrorInternalFailure, AWSTranscribeErrorConflict.

  • Creates a new custom medical vocabulary.

    Before creating a new custom medical vocabulary, you must first upload a text file that contains your vocabulary table into an Amazon S3 bucket. Note that this differs from , where you can include a list of terms within your request using the Phrases flag; CreateMedicalVocabulary does not support the Phrases flag and only accepts vocabularies in table format.

    Each language has a character set that contains all allowed characters for that specific language. If you use unsupported characters, your custom vocabulary request fails. Refer to Character Sets for Custom Vocabularies to get the character set for your language.

    For more information, see Custom vocabularies.

    See

    AWSTranscribeCreateMedicalVocabularyRequest

    See

    AWSTranscribeCreateMedicalVocabularyResponse

    Declaration

    Objective-C

    - (void)createMedicalVocabulary:
            (nonnull AWSTranscribeCreateMedicalVocabularyRequest *)request
              completionHandler:
                  (void (^_Nullable)(
                      AWSTranscribeCreateMedicalVocabularyResponse *_Nullable,
                      NSError *_Nullable))completionHandler;

    Swift

    func createMedicalVocabulary(_ request: AWSTranscribeCreateMedicalVocabularyRequest) async throws -> AWSTranscribeCreateMedicalVocabularyResponse

    Parameters

    request

    A container for the necessary parameters to execute the CreateMedicalVocabulary service method.
    completionHandler

    The completion handler to call when the load request is complete. response - A response object, or nil if the request failed. error - An error object that indicates why the request failed, or nil if the request was successful. On failed execution, error may contain an NSError with AWSTranscribeErrorDomain domain and the following error code: AWSTranscribeErrorBadRequest, AWSTranscribeErrorLimitExceeded, AWSTranscribeErrorInternalFailure, AWSTranscribeErrorConflict.

  • Creates a new custom vocabulary.

    When creating a new custom vocabulary, you can either upload a text file that contains your new entries, phrases, and terms into an Amazon S3 bucket and include the URI in your request. Or you can include a list of terms directly in your request using the Phrases flag.

    Each language has a character set that contains all allowed characters for that specific language. If you use unsupported characters, your custom vocabulary request fails. Refer to Character Sets for Custom Vocabularies to get the character set for your language.

    For more information, see Custom vocabularies.

    See

    AWSTranscribeCreateVocabularyRequest

    See

    AWSTranscribeCreateVocabularyResponse

    Declaration

    Objective-C

    - (id)createVocabulary:(nonnull AWSTranscribeCreateVocabularyRequest *)request;

    Swift

    func createVocabulary(_ request: AWSTranscribeCreateVocabularyRequest) -> Any!

    Parameters

    request

    A container for the necessary parameters to execute the CreateVocabulary service method.

    Return Value

    An instance of AWSTask. On successful execution, task.result will contain an instance of AWSTranscribeCreateVocabularyResponse. On failed execution, task.error may contain an NSError with AWSTranscribeErrorDomain domain and the following error code: AWSTranscribeErrorBadRequest, AWSTranscribeErrorLimitExceeded, AWSTranscribeErrorInternalFailure, AWSTranscribeErrorConflict.

  • Creates a new custom vocabulary.

    When creating a new custom vocabulary, you can either upload a text file that contains your new entries, phrases, and terms into an Amazon S3 bucket and include the URI in your request. Or you can include a list of terms directly in your request using the Phrases flag.

    Each language has a character set that contains all allowed characters for that specific language. If you use unsupported characters, your custom vocabulary request fails. Refer to Character Sets for Custom Vocabularies to get the character set for your language.

    For more information, see Custom vocabularies.

    See

    AWSTranscribeCreateVocabularyRequest

    See

    AWSTranscribeCreateVocabularyResponse

    Declaration

    Objective-C

    - (void)createVocabulary:(nonnull AWSTranscribeCreateVocabularyRequest *)request
       completionHandler:
           (void (^_Nullable)(AWSTranscribeCreateVocabularyResponse *_Nullable,
                              NSError *_Nullable))completionHandler;

    Swift

    func createVocabulary(_ request: AWSTranscribeCreateVocabularyRequest) async throws -> AWSTranscribeCreateVocabularyResponse

    Parameters

    request

    A container for the necessary parameters to execute the CreateVocabulary service method.
    completionHandler

    The completion handler to call when the load request is complete. response - A response object, or nil if the request failed. error - An error object that indicates why the request failed, or nil if the request was successful. On failed execution, error may contain an NSError with AWSTranscribeErrorDomain domain and the following error code: AWSTranscribeErrorBadRequest, AWSTranscribeErrorLimitExceeded, AWSTranscribeErrorInternalFailure, AWSTranscribeErrorConflict.

  • Creates a new custom vocabulary filter.

    You can use custom vocabulary filters to mask, delete, or flag specific words from your transcript. Custom vocabulary filters are commonly used to mask profanity in transcripts.

    Each language has a character set that contains all allowed characters for that specific language. If you use unsupported characters, your custom vocabulary filter request fails. Refer to Character Sets for Custom Vocabularies to get the character set for your language.

    For more information, see Vocabulary filtering.

    See

    AWSTranscribeCreateVocabularyFilterRequest

    See

    AWSTranscribeCreateVocabularyFilterResponse

    Declaration

    Objective-C

    - (id)createVocabularyFilter:
    (nonnull AWSTranscribeCreateVocabularyFilterRequest *)request;

    Swift

    func createVocabularyFilter(_ request: AWSTranscribeCreateVocabularyFilterRequest) -> Any!

    Parameters

    request

    A container for the necessary parameters to execute the CreateVocabularyFilter service method.

    Return Value

    An instance of AWSTask. On successful execution, task.result will contain an instance of AWSTranscribeCreateVocabularyFilterResponse. On failed execution, task.error may contain an NSError with AWSTranscribeErrorDomain domain and the following error code: AWSTranscribeErrorBadRequest, AWSTranscribeErrorLimitExceeded, AWSTranscribeErrorInternalFailure, AWSTranscribeErrorConflict.

  • Creates a new custom vocabulary filter.

    You can use custom vocabulary filters to mask, delete, or flag specific words from your transcript. Custom vocabulary filters are commonly used to mask profanity in transcripts.

    Each language has a character set that contains all allowed characters for that specific language. If you use unsupported characters, your custom vocabulary filter request fails. Refer to Character Sets for Custom Vocabularies to get the character set for your language.

    For more information, see Vocabulary filtering.

    See

    AWSTranscribeCreateVocabularyFilterRequest

    See

    AWSTranscribeCreateVocabularyFilterResponse

    Declaration

    Objective-C

    - (void)createVocabularyFilter:
            (nonnull AWSTranscribeCreateVocabularyFilterRequest *)request
             completionHandler:
                 (void (^_Nullable)(
                     AWSTranscribeCreateVocabularyFilterResponse *_Nullable,
                     NSError *_Nullable))completionHandler;

    Swift

    func createVocabularyFilter(_ request: AWSTranscribeCreateVocabularyFilterRequest) async throws -> AWSTranscribeCreateVocabularyFilterResponse

    Parameters

    request

    A container for the necessary parameters to execute the CreateVocabularyFilter service method.
    completionHandler

    The completion handler to call when the load request is complete. response - A response object, or nil if the request failed. error - An error object that indicates why the request failed, or nil if the request was successful. On failed execution, error may contain an NSError with AWSTranscribeErrorDomain domain and the following error code: AWSTranscribeErrorBadRequest, AWSTranscribeErrorLimitExceeded, AWSTranscribeErrorInternalFailure, AWSTranscribeErrorConflict.

  • Deletes a Call Analytics category. To use this operation, specify the name of the category you want to delete using CategoryName. Category names are case sensitive.

    See

    AWSTranscribeDeleteCallAnalyticsCategoryRequest

    See

    AWSTranscribeDeleteCallAnalyticsCategoryResponse

    Declaration

    Objective-C

    - (id)deleteCallAnalyticsCategory:
    (nonnull AWSTranscribeDeleteCallAnalyticsCategoryRequest *)request;

    Swift

    func deleteCallAnalyticsCategory(_ request: AWSTranscribeDeleteCallAnalyticsCategoryRequest) -> Any!

    Parameters

    request

    A container for the necessary parameters to execute the DeleteCallAnalyticsCategory service method.

    Return Value

    An instance of AWSTask. On successful execution, task.result will contain an instance of AWSTranscribeDeleteCallAnalyticsCategoryResponse. On failed execution, task.error may contain an NSError with AWSTranscribeErrorDomain domain and the following error code: AWSTranscribeErrorNotFound, AWSTranscribeErrorLimitExceeded, AWSTranscribeErrorBadRequest, AWSTranscribeErrorInternalFailure.

  • Deletes a Call Analytics category. To use this operation, specify the name of the category you want to delete using CategoryName. Category names are case sensitive.

    See

    AWSTranscribeDeleteCallAnalyticsCategoryRequest

    See

    AWSTranscribeDeleteCallAnalyticsCategoryResponse

    Declaration

    Objective-C

    - (void)deleteCallAnalyticsCategory:
            (nonnull AWSTranscribeDeleteCallAnalyticsCategoryRequest *)request
                  completionHandler:
                      (void (^_Nullable)(
                          AWSTranscribeDeleteCallAnalyticsCategoryResponse
                              *_Nullable,
                          NSError *_Nullable))completionHandler;

    Swift

    func deleteCallAnalyticsCategory(_ request: AWSTranscribeDeleteCallAnalyticsCategoryRequest) async throws -> AWSTranscribeDeleteCallAnalyticsCategoryResponse

    Parameters

    request

    A container for the necessary parameters to execute the DeleteCallAnalyticsCategory service method.
    completionHandler

    The completion handler to call when the load request is complete. response - A response object, or nil if the request failed. error - An error object that indicates why the request failed, or nil if the request was successful. On failed execution, error may contain an NSError with AWSTranscribeErrorDomain domain and the following error code: AWSTranscribeErrorNotFound, AWSTranscribeErrorLimitExceeded, AWSTranscribeErrorBadRequest, AWSTranscribeErrorInternalFailure.

  • Deletes a Call Analytics job. To use this operation, specify the name of the job you want to delete using CallAnalyticsJobName. Job names are case sensitive.

    See

    AWSTranscribeDeleteCallAnalyticsJobRequest

    See

    AWSTranscribeDeleteCallAnalyticsJobResponse

    Declaration

    Objective-C

    - (id)deleteCallAnalyticsJob:
    (nonnull AWSTranscribeDeleteCallAnalyticsJobRequest *)request;

    Swift

    func deleteCallAnalyticsJob(_ request: AWSTranscribeDeleteCallAnalyticsJobRequest) -> Any!

    Parameters

    request

    A container for the necessary parameters to execute the DeleteCallAnalyticsJob service method.

    Return Value

    An instance of AWSTask. On successful execution, task.result will contain an instance of AWSTranscribeDeleteCallAnalyticsJobResponse. On failed execution, task.error may contain an NSError with AWSTranscribeErrorDomain domain and the following error code: AWSTranscribeErrorLimitExceeded, AWSTranscribeErrorBadRequest, AWSTranscribeErrorInternalFailure.

  • Deletes a Call Analytics job. To use this operation, specify the name of the job you want to delete using CallAnalyticsJobName. Job names are case sensitive.

    See

    AWSTranscribeDeleteCallAnalyticsJobRequest

    See

    AWSTranscribeDeleteCallAnalyticsJobResponse

    Declaration

    Objective-C

    - (void)deleteCallAnalyticsJob:
            (nonnull AWSTranscribeDeleteCallAnalyticsJobRequest *)request
             completionHandler:
                 (void (^_Nullable)(
                     AWSTranscribeDeleteCallAnalyticsJobResponse *_Nullable,
                     NSError *_Nullable))completionHandler;

    Swift

    func deleteCallAnalyticsJob(_ request: AWSTranscribeDeleteCallAnalyticsJobRequest) async throws -> AWSTranscribeDeleteCallAnalyticsJobResponse

    Parameters

    request

    A container for the necessary parameters to execute the DeleteCallAnalyticsJob service method.
    completionHandler

    The completion handler to call when the load request is complete. response - A response object, or nil if the request failed. error - An error object that indicates why the request failed, or nil if the request was successful. On failed execution, error may contain an NSError with AWSTranscribeErrorDomain domain and the following error code: AWSTranscribeErrorLimitExceeded, AWSTranscribeErrorBadRequest, AWSTranscribeErrorInternalFailure.

  • Deletes a custom language model. To use this operation, specify the name of the language model you want to delete using ModelName. custom language model names are case sensitive.

    See

    AWSTranscribeDeleteLanguageModelRequest

    Declaration

    Objective-C

    - (id)deleteLanguageModel:
    (nonnull AWSTranscribeDeleteLanguageModelRequest *)request;

    Swift

    func deleteLanguageModel(_ request: AWSTranscribeDeleteLanguageModelRequest) -> Any!

    Parameters

    request

    A container for the necessary parameters to execute the DeleteLanguageModel service method.

    Return Value

    An instance of AWSTask. On successful execution, task.result will be nil. On failed execution, task.error may contain an NSError with AWSTranscribeErrorDomain domain and the following error code: AWSTranscribeErrorBadRequest, AWSTranscribeErrorLimitExceeded, AWSTranscribeErrorInternalFailure.

  • Deletes a custom language model. To use this operation, specify the name of the language model you want to delete using ModelName. custom language model names are case sensitive.

    See

    AWSTranscribeDeleteLanguageModelRequest

    Declaration

    Objective-C

    - (void)deleteLanguageModel:
            (nonnull AWSTranscribeDeleteLanguageModelRequest *)request
          completionHandler:
              (void (^_Nullable)(NSError *_Nullable))completionHandler;

    Swift

    func deleteLanguageModel(_ request: AWSTranscribeDeleteLanguageModelRequest) async throws

    Parameters

    request

    A container for the necessary parameters to execute the DeleteLanguageModel service method.
    completionHandler

    The completion handler to call when the load request is complete. error - An error object that indicates why the request failed, or nil if the request was successful. On failed execution, error may contain an NSError with AWSTranscribeErrorDomain domain and the following error code: AWSTranscribeErrorBadRequest, AWSTranscribeErrorLimitExceeded, AWSTranscribeErrorInternalFailure.

  • Deletes a Medical Scribe job. To use this operation, specify the name of the job you want to delete using MedicalScribeJobName. Job names are case sensitive.

    See

    AWSTranscribeDeleteMedicalScribeJobRequest

    Declaration

    Objective-C

    - (id)deleteMedicalScribeJob:
    (nonnull AWSTranscribeDeleteMedicalScribeJobRequest *)request;

    Swift

    func deleteMedicalScribeJob(_ request: AWSTranscribeDeleteMedicalScribeJobRequest) -> Any!

    Parameters

    request

    A container for the necessary parameters to execute the DeleteMedicalScribeJob service method.

    Return Value

    An instance of AWSTask. On successful execution, task.result will be nil. On failed execution, task.error may contain an NSError with AWSTranscribeErrorDomain domain and the following error code: AWSTranscribeErrorLimitExceeded, AWSTranscribeErrorBadRequest, AWSTranscribeErrorInternalFailure.

  • Deletes a Medical Scribe job. To use this operation, specify the name of the job you want to delete using MedicalScribeJobName. Job names are case sensitive.

    See

    AWSTranscribeDeleteMedicalScribeJobRequest

    Declaration

    Objective-C

    - (void)deleteMedicalScribeJob:
            (nonnull AWSTranscribeDeleteMedicalScribeJobRequest *)request
             completionHandler:
                 (void (^_Nullable)(NSError *_Nullable))completionHandler;

    Swift

    func deleteMedicalScribeJob(_ request: AWSTranscribeDeleteMedicalScribeJobRequest) async throws

    Parameters

    request

    A container for the necessary parameters to execute the DeleteMedicalScribeJob service method.
    completionHandler

    The completion handler to call when the load request is complete. error - An error object that indicates why the request failed, or nil if the request was successful. On failed execution, error may contain an NSError with AWSTranscribeErrorDomain domain and the following error code: AWSTranscribeErrorLimitExceeded, AWSTranscribeErrorBadRequest, AWSTranscribeErrorInternalFailure.

  • Deletes a medical transcription job. To use this operation, specify the name of the job you want to delete using MedicalTranscriptionJobName. Job names are case sensitive.

    See

    AWSTranscribeDeleteMedicalTranscriptionJobRequest

    Declaration

    Objective-C

    - (id)deleteMedicalTranscriptionJob:
    (nonnull AWSTranscribeDeleteMedicalTranscriptionJobRequest *)request;

    Swift

    func deleteMedicalTranscriptionJob(_ request: AWSTranscribeDeleteMedicalTranscriptionJobRequest) -> Any!

    Parameters

    request

    A container for the necessary parameters to execute the DeleteMedicalTranscriptionJob service method.

    Return Value

    An instance of AWSTask. On successful execution, task.result will be nil. On failed execution, task.error may contain an NSError with AWSTranscribeErrorDomain domain and the following error code: AWSTranscribeErrorLimitExceeded, AWSTranscribeErrorBadRequest, AWSTranscribeErrorInternalFailure.

  • Deletes a medical transcription job. To use this operation, specify the name of the job you want to delete using MedicalTranscriptionJobName. Job names are case sensitive.

    See

    AWSTranscribeDeleteMedicalTranscriptionJobRequest

    Declaration

    Objective-C

    - (void)deleteMedicalTranscriptionJob:
            (nonnull AWSTranscribeDeleteMedicalTranscriptionJobRequest *)request
                    completionHandler:(void (^_Nullable)(NSError *_Nullable))
                                          completionHandler;

    Swift

    func deleteMedicalTranscriptionJob(_ request: AWSTranscribeDeleteMedicalTranscriptionJobRequest) async throws

    Parameters

    request

    A container for the necessary parameters to execute the DeleteMedicalTranscriptionJob service method.
    completionHandler

    The completion handler to call when the load request is complete. error - An error object that indicates why the request failed, or nil if the request was successful. On failed execution, error may contain an NSError with AWSTranscribeErrorDomain domain and the following error code: AWSTranscribeErrorLimitExceeded, AWSTranscribeErrorBadRequest, AWSTranscribeErrorInternalFailure.

  • Deletes a custom medical vocabulary. To use this operation, specify the name of the custom vocabulary you want to delete using VocabularyName. Custom vocabulary names are case sensitive.

    See

    AWSTranscribeDeleteMedicalVocabularyRequest

    Declaration

    Objective-C

    - (id)deleteMedicalVocabulary:
    (nonnull AWSTranscribeDeleteMedicalVocabularyRequest *)request;

    Swift

    func deleteMedicalVocabulary(_ request: AWSTranscribeDeleteMedicalVocabularyRequest) -> Any!

    Parameters

    request

    A container for the necessary parameters to execute the DeleteMedicalVocabulary service method.

    Return Value

    An instance of AWSTask. On successful execution, task.result will be nil. On failed execution, task.error may contain an NSError with AWSTranscribeErrorDomain domain and the following error code: AWSTranscribeErrorNotFound, AWSTranscribeErrorLimitExceeded, AWSTranscribeErrorBadRequest, AWSTranscribeErrorInternalFailure.

  • Deletes a custom medical vocabulary. To use this operation, specify the name of the custom vocabulary you want to delete using VocabularyName. Custom vocabulary names are case sensitive.

    See

    AWSTranscribeDeleteMedicalVocabularyRequest

    Declaration

    Objective-C

    - (void)deleteMedicalVocabulary:
            (nonnull AWSTranscribeDeleteMedicalVocabularyRequest *)request
              completionHandler:
                  (void (^_Nullable)(NSError *_Nullable))completionHandler;

    Swift

    func deleteMedicalVocabulary(_ request: AWSTranscribeDeleteMedicalVocabularyRequest) async throws

    Parameters

    request

    A container for the necessary parameters to execute the DeleteMedicalVocabulary service method.
    completionHandler

    The completion handler to call when the load request is complete. error - An error object that indicates why the request failed, or nil if the request was successful. On failed execution, error may contain an NSError with AWSTranscribeErrorDomain domain and the following error code: AWSTranscribeErrorNotFound, AWSTranscribeErrorLimitExceeded, AWSTranscribeErrorBadRequest, AWSTranscribeErrorInternalFailure.

  • Deletes a transcription job. To use this operation, specify the name of the job you want to delete using TranscriptionJobName. Job names are case sensitive.

    See

    AWSTranscribeDeleteTranscriptionJobRequest

    Declaration

    Objective-C

    - (id)deleteTranscriptionJob:
    (nonnull AWSTranscribeDeleteTranscriptionJobRequest *)request;

    Swift

    func deleteTranscriptionJob(_ request: AWSTranscribeDeleteTranscriptionJobRequest) -> Any!

    Parameters

    request

    A container for the necessary parameters to execute the DeleteTranscriptionJob service method.

    Return Value

    An instance of AWSTask. On successful execution, task.result will be nil. On failed execution, task.error may contain an NSError with AWSTranscribeErrorDomain domain and the following error code: AWSTranscribeErrorLimitExceeded, AWSTranscribeErrorBadRequest, AWSTranscribeErrorInternalFailure.

  • Deletes a transcription job. To use this operation, specify the name of the job you want to delete using TranscriptionJobName. Job names are case sensitive.

    See

    AWSTranscribeDeleteTranscriptionJobRequest

    Declaration

    Objective-C

    - (void)deleteTranscriptionJob:
            (nonnull AWSTranscribeDeleteTranscriptionJobRequest *)request
             completionHandler:
                 (void (^_Nullable)(NSError *_Nullable))completionHandler;

    Swift

    func deleteTranscriptionJob(_ request: AWSTranscribeDeleteTranscriptionJobRequest) async throws

    Parameters

    request

    A container for the necessary parameters to execute the DeleteTranscriptionJob service method.
    completionHandler

    The completion handler to call when the load request is complete. error - An error object that indicates why the request failed, or nil if the request was successful. On failed execution, error may contain an NSError with AWSTranscribeErrorDomain domain and the following error code: AWSTranscribeErrorLimitExceeded, AWSTranscribeErrorBadRequest, AWSTranscribeErrorInternalFailure.

  • Deletes a custom vocabulary. To use this operation, specify the name of the custom vocabulary you want to delete using VocabularyName. Custom vocabulary names are case sensitive.

    See

    AWSTranscribeDeleteVocabularyRequest

    Declaration

    Objective-C

    - (id)deleteVocabulary:(nonnull AWSTranscribeDeleteVocabularyRequest *)request;

    Swift

    func deleteVocabulary(_ request: AWSTranscribeDeleteVocabularyRequest) -> Any!

    Parameters

    request

    A container for the necessary parameters to execute the DeleteVocabulary service method.

    Return Value

    An instance of AWSTask. On successful execution, task.result will be nil. On failed execution, task.error may contain an NSError with AWSTranscribeErrorDomain domain and the following error code: AWSTranscribeErrorNotFound, AWSTranscribeErrorLimitExceeded, AWSTranscribeErrorBadRequest, AWSTranscribeErrorInternalFailure.

  • Deletes a custom vocabulary. To use this operation, specify the name of the custom vocabulary you want to delete using VocabularyName. Custom vocabulary names are case sensitive.

    See

    AWSTranscribeDeleteVocabularyRequest

    Declaration

    Objective-C

    - (void)deleteVocabulary:(nonnull AWSTranscribeDeleteVocabularyRequest *)request
       completionHandler:
           (void (^_Nullable)(NSError *_Nullable))completionHandler;

    Swift

    func deleteVocabulary(_ request: AWSTranscribeDeleteVocabularyRequest) async throws

    Parameters

    request

    A container for the necessary parameters to execute the DeleteVocabulary service method.
    completionHandler

    The completion handler to call when the load request is complete. error - An error object that indicates why the request failed, or nil if the request was successful. On failed execution, error may contain an NSError with AWSTranscribeErrorDomain domain and the following error code: AWSTranscribeErrorNotFound, AWSTranscribeErrorLimitExceeded, AWSTranscribeErrorBadRequest, AWSTranscribeErrorInternalFailure.

  • Deletes a custom vocabulary filter. To use this operation, specify the name of the custom vocabulary filter you want to delete using VocabularyFilterName. Custom vocabulary filter names are case sensitive.

    See

    AWSTranscribeDeleteVocabularyFilterRequest

    Declaration

    Objective-C

    - (id)deleteVocabularyFilter:
    (nonnull AWSTranscribeDeleteVocabularyFilterRequest *)request;

    Swift

    func deleteVocabularyFilter(_ request: AWSTranscribeDeleteVocabularyFilterRequest) -> Any!

    Parameters

    request

    A container for the necessary parameters to execute the DeleteVocabularyFilter service method.

    Return Value

    An instance of AWSTask. On successful execution, task.result will be nil. On failed execution, task.error may contain an NSError with AWSTranscribeErrorDomain domain and the following error code: AWSTranscribeErrorNotFound, AWSTranscribeErrorLimitExceeded, AWSTranscribeErrorBadRequest, AWSTranscribeErrorInternalFailure.

  • Deletes a custom vocabulary filter. To use this operation, specify the name of the custom vocabulary filter you want to delete using VocabularyFilterName. Custom vocabulary filter names are case sensitive.

    See

    AWSTranscribeDeleteVocabularyFilterRequest

    Declaration

    Objective-C

    - (void)deleteVocabularyFilter:
            (nonnull AWSTranscribeDeleteVocabularyFilterRequest *)request
             completionHandler:
                 (void (^_Nullable)(NSError *_Nullable))completionHandler;

    Swift

    func deleteVocabularyFilter(_ request: AWSTranscribeDeleteVocabularyFilterRequest) async throws

    Parameters

    request

    A container for the necessary parameters to execute the DeleteVocabularyFilter service method.
    completionHandler

    The completion handler to call when the load request is complete. error - An error object that indicates why the request failed, or nil if the request was successful. On failed execution, error may contain an NSError with AWSTranscribeErrorDomain domain and the following error code: AWSTranscribeErrorNotFound, AWSTranscribeErrorLimitExceeded, AWSTranscribeErrorBadRequest, AWSTranscribeErrorInternalFailure.

  • Provides information about the specified custom language model.

    This operation also shows if the base language model that you used to create your custom language model has been updated. If Amazon Transcribe has updated the base model, you can create a new custom language model using the updated base model.

    If you tried to create a new custom language model and the request wasn’t successful, you can use DescribeLanguageModel to help identify the reason for this failure.

    See

    AWSTranscribeDescribeLanguageModelRequest

    See

    AWSTranscribeDescribeLanguageModelResponse

    Declaration

    Objective-C

    - (id)describeLanguageModel:
    (nonnull AWSTranscribeDescribeLanguageModelRequest *)request;

    Swift

    func describeLanguageModel(_ request: AWSTranscribeDescribeLanguageModelRequest) -> Any!

    Parameters

    request

    A container for the necessary parameters to execute the DescribeLanguageModel service method.

    Return Value

    An instance of AWSTask. On successful execution, task.result will contain an instance of AWSTranscribeDescribeLanguageModelResponse. On failed execution, task.error may contain an NSError with AWSTranscribeErrorDomain domain and the following error code: AWSTranscribeErrorBadRequest, AWSTranscribeErrorLimitExceeded, AWSTranscribeErrorInternalFailure, AWSTranscribeErrorNotFound.

  • Provides information about the specified custom language model.

    This operation also shows if the base language model that you used to create your custom language model has been updated. If Amazon Transcribe has updated the base model, you can create a new custom language model using the updated base model.

    If you tried to create a new custom language model and the request wasn’t successful, you can use DescribeLanguageModel to help identify the reason for this failure.

    See

    AWSTranscribeDescribeLanguageModelRequest

    See

    AWSTranscribeDescribeLanguageModelResponse

    Declaration

    Objective-C

    - (void)describeLanguageModel:
            (nonnull AWSTranscribeDescribeLanguageModelRequest *)request
            completionHandler:
                (void (^_Nullable)(
                    AWSTranscribeDescribeLanguageModelResponse *_Nullable,
                    NSError *_Nullable))completionHandler;

    Swift

    func describeLanguageModel(_ request: AWSTranscribeDescribeLanguageModelRequest) async throws -> AWSTranscribeDescribeLanguageModelResponse

    Parameters

    request

    A container for the necessary parameters to execute the DescribeLanguageModel service method.
    completionHandler

    The completion handler to call when the load request is complete. response - A response object, or nil if the request failed. error - An error object that indicates why the request failed, or nil if the request was successful. On failed execution, error may contain an NSError with AWSTranscribeErrorDomain domain and the following error code: AWSTranscribeErrorBadRequest, AWSTranscribeErrorLimitExceeded, AWSTranscribeErrorInternalFailure, AWSTranscribeErrorNotFound.

  • Provides information about the specified Call Analytics category.

    To get a list of your Call Analytics categories, use the operation.

    See

    AWSTranscribeGetCallAnalyticsCategoryRequest

    See

    AWSTranscribeGetCallAnalyticsCategoryResponse

    Declaration

    Objective-C

    - (id)getCallAnalyticsCategory:
    (nonnull AWSTranscribeGetCallAnalyticsCategoryRequest *)request;

    Swift

    func getCallAnalyticsCategory(_ request: AWSTranscribeGetCallAnalyticsCategoryRequest) -> Any!

    Parameters

    request

    A container for the necessary parameters to execute the GetCallAnalyticsCategory service method.

    Return Value

    An instance of AWSTask. On successful execution, task.result will contain an instance of AWSTranscribeGetCallAnalyticsCategoryResponse. On failed execution, task.error may contain an NSError with AWSTranscribeErrorDomain domain and the following error code: AWSTranscribeErrorNotFound, AWSTranscribeErrorLimitExceeded, AWSTranscribeErrorInternalFailure, AWSTranscribeErrorBadRequest.

  • Provides information about the specified Call Analytics category.

    To get a list of your Call Analytics categories, use the operation.

    See

    AWSTranscribeGetCallAnalyticsCategoryRequest

    See

    AWSTranscribeGetCallAnalyticsCategoryResponse

    Declaration

    Objective-C

    - (void)getCallAnalyticsCategory:
            (nonnull AWSTranscribeGetCallAnalyticsCategoryRequest *)request
               completionHandler:
                   (void (^_Nullable)(
                       AWSTranscribeGetCallAnalyticsCategoryResponse *_Nullable,
                       NSError *_Nullable))completionHandler;

    Swift

    func callAnalyticsCategory(_ request: AWSTranscribeGetCallAnalyticsCategoryRequest) async throws -> AWSTranscribeGetCallAnalyticsCategoryResponse

    Parameters

    request

    A container for the necessary parameters to execute the GetCallAnalyticsCategory service method.
    completionHandler

    The completion handler to call when the load request is complete. response - A response object, or nil if the request failed. error - An error object that indicates why the request failed, or nil if the request was successful. On failed execution, error may contain an NSError with AWSTranscribeErrorDomain domain and the following error code: AWSTranscribeErrorNotFound, AWSTranscribeErrorLimitExceeded, AWSTranscribeErrorInternalFailure, AWSTranscribeErrorBadRequest.

  • Provides information about the specified Call Analytics job.

    To view the job’s status, refer to CallAnalyticsJobStatus. If the status is COMPLETED, the job is finished. You can find your completed transcript at the URI specified in TranscriptFileUri. If the status is FAILED, FailureReason provides details on why your transcription job failed.

    If you enabled personally identifiable information (PII) redaction, the redacted transcript appears at the location specified in RedactedTranscriptFileUri.

    If you chose to redact the audio in your media file, you can find your redacted media file at the location specified in RedactedMediaFileUri.

    To get a list of your Call Analytics jobs, use the operation.

    See

    AWSTranscribeGetCallAnalyticsJobRequest

    See

    AWSTranscribeGetCallAnalyticsJobResponse

    Declaration

    Objective-C

    - (id)getCallAnalyticsJob:
    (nonnull AWSTranscribeGetCallAnalyticsJobRequest *)request;

    Swift

    func getCallAnalyticsJob(_ request: AWSTranscribeGetCallAnalyticsJobRequest) -> Any!

    Parameters

    request

    A container for the necessary parameters to execute the GetCallAnalyticsJob service method.

    Return Value

    An instance of AWSTask. On successful execution, task.result will contain an instance of AWSTranscribeGetCallAnalyticsJobResponse. On failed execution, task.error may contain an NSError with AWSTranscribeErrorDomain domain and the following error code: AWSTranscribeErrorBadRequest, AWSTranscribeErrorLimitExceeded, AWSTranscribeErrorInternalFailure, AWSTranscribeErrorNotFound.

  • Provides information about the specified Call Analytics job.

    To view the job’s status, refer to CallAnalyticsJobStatus. If the status is COMPLETED, the job is finished. You can find your completed transcript at the URI specified in TranscriptFileUri. If the status is FAILED, FailureReason provides details on why your transcription job failed.

    If you enabled personally identifiable information (PII) redaction, the redacted transcript appears at the location specified in RedactedTranscriptFileUri.

    If you chose to redact the audio in your media file, you can find your redacted media file at the location specified in RedactedMediaFileUri.

    To get a list of your Call Analytics jobs, use the operation.

    See

    AWSTranscribeGetCallAnalyticsJobRequest

    See

    AWSTranscribeGetCallAnalyticsJobResponse

    Declaration

    Objective-C

    - (void)getCallAnalyticsJob:
            (nonnull AWSTranscribeGetCallAnalyticsJobRequest *)request
          completionHandler:
              (void (^_Nullable)(
                  AWSTranscribeGetCallAnalyticsJobResponse *_Nullable,
                  NSError *_Nullable))completionHandler;

    Swift

    func callAnalyticsJob(_ request: AWSTranscribeGetCallAnalyticsJobRequest) async throws -> AWSTranscribeGetCallAnalyticsJobResponse

    Parameters

    request

    A container for the necessary parameters to execute the GetCallAnalyticsJob service method.
    completionHandler

    The completion handler to call when the load request is complete. response - A response object, or nil if the request failed. error - An error object that indicates why the request failed, or nil if the request was successful. On failed execution, error may contain an NSError with AWSTranscribeErrorDomain domain and the following error code: AWSTranscribeErrorBadRequest, AWSTranscribeErrorLimitExceeded, AWSTranscribeErrorInternalFailure, AWSTranscribeErrorNotFound.

  • Provides information about the specified Medical Scribe job.

    To view the status of the specified medical transcription job, check the MedicalScribeJobStatus field. If the status is COMPLETED, the job is finished. You can find the results at the location specified in MedicalScribeOutput. If the status is FAILED, FailureReason provides details on why your Medical Scribe job failed.

    To get a list of your Medical Scribe jobs, use the operation.

    See

    AWSTranscribeGetMedicalScribeJobRequest

    See

    AWSTranscribeGetMedicalScribeJobResponse

    Declaration

    Objective-C

    - (id)getMedicalScribeJob:
    (nonnull AWSTranscribeGetMedicalScribeJobRequest *)request;

    Swift

    func getMedicalScribeJob(_ request: AWSTranscribeGetMedicalScribeJobRequest) -> Any!

    Parameters

    request

    A container for the necessary parameters to execute the GetMedicalScribeJob service method.

    Return Value

    An instance of AWSTask. On successful execution, task.result will contain an instance of AWSTranscribeGetMedicalScribeJobResponse. On failed execution, task.error may contain an NSError with AWSTranscribeErrorDomain domain and the following error code: AWSTranscribeErrorBadRequest, AWSTranscribeErrorLimitExceeded, AWSTranscribeErrorInternalFailure, AWSTranscribeErrorNotFound.

  • Provides information about the specified Medical Scribe job.

    To view the status of the specified medical transcription job, check the MedicalScribeJobStatus field. If the status is COMPLETED, the job is finished. You can find the results at the location specified in MedicalScribeOutput. If the status is FAILED, FailureReason provides details on why your Medical Scribe job failed.

    To get a list of your Medical Scribe jobs, use the operation.

    See

    AWSTranscribeGetMedicalScribeJobRequest

    See

    AWSTranscribeGetMedicalScribeJobResponse

    Declaration

    Objective-C

    - (void)getMedicalScribeJob:
            (nonnull AWSTranscribeGetMedicalScribeJobRequest *)request
          completionHandler:
              (void (^_Nullable)(
                  AWSTranscribeGetMedicalScribeJobResponse *_Nullable,
                  NSError *_Nullable))completionHandler;

    Swift

    func medicalScribeJob(_ request: AWSTranscribeGetMedicalScribeJobRequest) async throws -> AWSTranscribeGetMedicalScribeJobResponse

    Parameters

    request

    A container for the necessary parameters to execute the GetMedicalScribeJob service method.
    completionHandler

    The completion handler to call when the load request is complete. response - A response object, or nil if the request failed. error - An error object that indicates why the request failed, or nil if the request was successful. On failed execution, error may contain an NSError with AWSTranscribeErrorDomain domain and the following error code: AWSTranscribeErrorBadRequest, AWSTranscribeErrorLimitExceeded, AWSTranscribeErrorInternalFailure, AWSTranscribeErrorNotFound.

  • Provides information about the specified medical transcription job.

    To view the status of the specified medical transcription job, check the TranscriptionJobStatus field. If the status is COMPLETED, the job is finished. You can find the results at the location specified in TranscriptFileUri. If the status is FAILED, FailureReason provides details on why your transcription job failed.

    To get a list of your medical transcription jobs, use the operation.

    See

    AWSTranscribeGetMedicalTranscriptionJobRequest

    See

    AWSTranscribeGetMedicalTranscriptionJobResponse

    Declaration

    Objective-C

    - (id)getMedicalTranscriptionJob:
    (nonnull AWSTranscribeGetMedicalTranscriptionJobRequest *)request;

    Swift

    func getMedicalTranscriptionJob(_ request: AWSTranscribeGetMedicalTranscriptionJobRequest) -> Any!

    Parameters

    request

    A container for the necessary parameters to execute the GetMedicalTranscriptionJob service method.

    Return Value

    An instance of AWSTask. On successful execution, task.result will contain an instance of AWSTranscribeGetMedicalTranscriptionJobResponse. On failed execution, task.error may contain an NSError with AWSTranscribeErrorDomain domain and the following error code: AWSTranscribeErrorBadRequest, AWSTranscribeErrorLimitExceeded, AWSTranscribeErrorInternalFailure, AWSTranscribeErrorNotFound.

  • Provides information about the specified medical transcription job.

    To view the status of the specified medical transcription job, check the TranscriptionJobStatus field. If the status is COMPLETED, the job is finished. You can find the results at the location specified in TranscriptFileUri. If the status is FAILED, FailureReason provides details on why your transcription job failed.

    To get a list of your medical transcription jobs, use the operation.

    See

    AWSTranscribeGetMedicalTranscriptionJobRequest

    See

    AWSTranscribeGetMedicalTranscriptionJobResponse

    Declaration

    Objective-C

    - (void)
    getMedicalTranscriptionJob:
        (nonnull AWSTranscribeGetMedicalTranscriptionJobRequest *)request
             completionHandler:
                 (void (^_Nullable)(
                     AWSTranscribeGetMedicalTranscriptionJobResponse *_Nullable,
                     NSError *_Nullable))completionHandler;

    Swift

    func medicalTranscriptionJob(_ request: AWSTranscribeGetMedicalTranscriptionJobRequest) async throws -> AWSTranscribeGetMedicalTranscriptionJobResponse

    Parameters

    request

    A container for the necessary parameters to execute the GetMedicalTranscriptionJob service method.
    completionHandler

    The completion handler to call when the load request is complete. response - A response object, or nil if the request failed. error - An error object that indicates why the request failed, or nil if the request was successful. On failed execution, error may contain an NSError with AWSTranscribeErrorDomain domain and the following error code: AWSTranscribeErrorBadRequest, AWSTranscribeErrorLimitExceeded, AWSTranscribeErrorInternalFailure, AWSTranscribeErrorNotFound.

  • Provides information about the specified custom medical vocabulary.

    To view the status of the specified custom medical vocabulary, check the VocabularyState field. If the status is READY, your custom vocabulary is available to use. If the status is FAILED, FailureReason provides details on why your vocabulary failed.

    To get a list of your custom medical vocabularies, use the operation.

    See

    AWSTranscribeGetMedicalVocabularyRequest

    See

    AWSTranscribeGetMedicalVocabularyResponse

    Declaration

    Objective-C

    - (id)getMedicalVocabulary:
    (nonnull AWSTranscribeGetMedicalVocabularyRequest *)request;

    Swift

    func getMedicalVocabulary(_ request: AWSTranscribeGetMedicalVocabularyRequest) -> Any!

    Parameters

    request

    A container for the necessary parameters to execute the GetMedicalVocabulary service method.

    Return Value

    An instance of AWSTask. On successful execution, task.result will contain an instance of AWSTranscribeGetMedicalVocabularyResponse. On failed execution, task.error may contain an NSError with AWSTranscribeErrorDomain domain and the following error code: AWSTranscribeErrorNotFound, AWSTranscribeErrorLimitExceeded, AWSTranscribeErrorInternalFailure, AWSTranscribeErrorBadRequest.

  • Provides information about the specified custom medical vocabulary.

    To view the status of the specified custom medical vocabulary, check the VocabularyState field. If the status is READY, your custom vocabulary is available to use. If the status is FAILED, FailureReason provides details on why your vocabulary failed.

    To get a list of your custom medical vocabularies, use the operation.

    See

    AWSTranscribeGetMedicalVocabularyRequest

    See

    AWSTranscribeGetMedicalVocabularyResponse

    Declaration

    Objective-C

    - (void)getMedicalVocabulary:
            (nonnull AWSTranscribeGetMedicalVocabularyRequest *)request
           completionHandler:
               (void (^_Nullable)(
                   AWSTranscribeGetMedicalVocabularyResponse *_Nullable,
                   NSError *_Nullable))completionHandler;

    Swift

    func medicalVocabulary(_ request: AWSTranscribeGetMedicalVocabularyRequest) async throws -> AWSTranscribeGetMedicalVocabularyResponse

    Parameters

    request

    A container for the necessary parameters to execute the GetMedicalVocabulary service method.
    completionHandler

    The completion handler to call when the load request is complete. response - A response object, or nil if the request failed. error - An error object that indicates why the request failed, or nil if the request was successful. On failed execution, error may contain an NSError with AWSTranscribeErrorDomain domain and the following error code: AWSTranscribeErrorNotFound, AWSTranscribeErrorLimitExceeded, AWSTranscribeErrorInternalFailure, AWSTranscribeErrorBadRequest.

  • Provides information about the specified transcription job.

    To view the status of the specified transcription job, check the TranscriptionJobStatus field. If the status is COMPLETED, the job is finished. You can find the results at the location specified in TranscriptFileUri. If the status is FAILED, FailureReason provides details on why your transcription job failed.

    If you enabled content redaction, the redacted transcript can be found at the location specified in RedactedTranscriptFileUri.

    To get a list of your transcription jobs, use the operation.

    See

    AWSTranscribeGetTranscriptionJobRequest

    See

    AWSTranscribeGetTranscriptionJobResponse

    Declaration

    Objective-C

    - (id)getTranscriptionJob:
    (nonnull AWSTranscribeGetTranscriptionJobRequest *)request;

    Swift

    func getTranscriptionJob(_ request: AWSTranscribeGetTranscriptionJobRequest) -> Any!

    Parameters

    request

    A container for the necessary parameters to execute the GetTranscriptionJob service method.

    Return Value

    An instance of AWSTask. On successful execution, task.result will contain an instance of AWSTranscribeGetTranscriptionJobResponse. On failed execution, task.error may contain an NSError with AWSTranscribeErrorDomain domain and the following error code: AWSTranscribeErrorBadRequest, AWSTranscribeErrorLimitExceeded, AWSTranscribeErrorInternalFailure, AWSTranscribeErrorNotFound.

  • Provides information about the specified transcription job.

    To view the status of the specified transcription job, check the TranscriptionJobStatus field. If the status is COMPLETED, the job is finished. You can find the results at the location specified in TranscriptFileUri. If the status is FAILED, FailureReason provides details on why your transcription job failed.

    If you enabled content redaction, the redacted transcript can be found at the location specified in RedactedTranscriptFileUri.

    To get a list of your transcription jobs, use the operation.

    See

    AWSTranscribeGetTranscriptionJobRequest

    See

    AWSTranscribeGetTranscriptionJobResponse

    Declaration

    Objective-C

    - (void)getTranscriptionJob:
            (nonnull AWSTranscribeGetTranscriptionJobRequest *)request
          completionHandler:
              (void (^_Nullable)(
                  AWSTranscribeGetTranscriptionJobResponse *_Nullable,
                  NSError *_Nullable))completionHandler;

    Swift

    func transcriptionJob(_ request: AWSTranscribeGetTranscriptionJobRequest) async throws -> AWSTranscribeGetTranscriptionJobResponse

    Parameters

    request

    A container for the necessary parameters to execute the GetTranscriptionJob service method.
    completionHandler

    The completion handler to call when the load request is complete. response - A response object, or nil if the request failed. error - An error object that indicates why the request failed, or nil if the request was successful. On failed execution, error may contain an NSError with AWSTranscribeErrorDomain domain and the following error code: AWSTranscribeErrorBadRequest, AWSTranscribeErrorLimitExceeded, AWSTranscribeErrorInternalFailure, AWSTranscribeErrorNotFound.

  • Provides information about the specified custom vocabulary.

    To view the status of the specified custom vocabulary, check the VocabularyState field. If the status is READY, your custom vocabulary is available to use. If the status is FAILED, FailureReason provides details on why your custom vocabulary failed.

    To get a list of your custom vocabularies, use the operation.

    See

    AWSTranscribeGetVocabularyRequest

    See

    AWSTranscribeGetVocabularyResponse

    Declaration

    Objective-C

    - (id)getVocabulary:(nonnull AWSTranscribeGetVocabularyRequest *)request;

    Swift

    func getVocabulary(_ request: AWSTranscribeGetVocabularyRequest) -> Any!

    Parameters

    request

    A container for the necessary parameters to execute the GetVocabulary service method.

    Return Value

    An instance of AWSTask. On successful execution, task.result will contain an instance of AWSTranscribeGetVocabularyResponse. On failed execution, task.error may contain an NSError with AWSTranscribeErrorDomain domain and the following error code: AWSTranscribeErrorNotFound, AWSTranscribeErrorLimitExceeded, AWSTranscribeErrorInternalFailure, AWSTranscribeErrorBadRequest.

  • Provides information about the specified custom vocabulary.

    To view the status of the specified custom vocabulary, check the VocabularyState field. If the status is READY, your custom vocabulary is available to use. If the status is FAILED, FailureReason provides details on why your custom vocabulary failed.

    To get a list of your custom vocabularies, use the operation.

    See

    AWSTranscribeGetVocabularyRequest

    See

    AWSTranscribeGetVocabularyResponse

    Declaration

    Objective-C

    - (void)getVocabulary:(nonnull AWSTranscribeGetVocabularyRequest *)request
    completionHandler:
        (void (^_Nullable)(AWSTranscribeGetVocabularyResponse *_Nullable,
                           NSError *_Nullable))completionHandler;

    Swift

    func vocabulary(_ request: AWSTranscribeGetVocabularyRequest) async throws -> AWSTranscribeGetVocabularyResponse

    Parameters

    request

    A container for the necessary parameters to execute the GetVocabulary service method.
    completionHandler

    The completion handler to call when the load request is complete. response - A response object, or nil if the request failed. error - An error object that indicates why the request failed, or nil if the request was successful. On failed execution, error may contain an NSError with AWSTranscribeErrorDomain domain and the following error code: AWSTranscribeErrorNotFound, AWSTranscribeErrorLimitExceeded, AWSTranscribeErrorInternalFailure, AWSTranscribeErrorBadRequest.

  • Provides information about the specified custom vocabulary filter.

    To get a list of your custom vocabulary filters, use the operation.

    See

    AWSTranscribeGetVocabularyFilterRequest

    See

    AWSTranscribeGetVocabularyFilterResponse

    Declaration

    Objective-C

    - (id)getVocabularyFilter:
    (nonnull AWSTranscribeGetVocabularyFilterRequest *)request;

    Swift

    func getVocabularyFilter(_ request: AWSTranscribeGetVocabularyFilterRequest) -> Any!

    Parameters

    request

    A container for the necessary parameters to execute the GetVocabularyFilter service method.

    Return Value

    An instance of AWSTask. On successful execution, task.result will contain an instance of AWSTranscribeGetVocabularyFilterResponse. On failed execution, task.error may contain an NSError with AWSTranscribeErrorDomain domain and the following error code: AWSTranscribeErrorNotFound, AWSTranscribeErrorLimitExceeded, AWSTranscribeErrorInternalFailure, AWSTranscribeErrorBadRequest.

  • Provides information about the specified custom vocabulary filter.

    To get a list of your custom vocabulary filters, use the operation.

    See

    AWSTranscribeGetVocabularyFilterRequest

    See

    AWSTranscribeGetVocabularyFilterResponse

    Declaration

    Objective-C

    - (void)getVocabularyFilter:
            (nonnull AWSTranscribeGetVocabularyFilterRequest *)request
          completionHandler:
              (void (^_Nullable)(
                  AWSTranscribeGetVocabularyFilterResponse *_Nullable,
                  NSError *_Nullable))completionHandler;

    Swift

    func vocabularyFilter(_ request: AWSTranscribeGetVocabularyFilterRequest) async throws -> AWSTranscribeGetVocabularyFilterResponse

    Parameters

    request

    A container for the necessary parameters to execute the GetVocabularyFilter service method.
    completionHandler

    The completion handler to call when the load request is complete. response - A response object, or nil if the request failed. error - An error object that indicates why the request failed, or nil if the request was successful. On failed execution, error may contain an NSError with AWSTranscribeErrorDomain domain and the following error code: AWSTranscribeErrorNotFound, AWSTranscribeErrorLimitExceeded, AWSTranscribeErrorInternalFailure, AWSTranscribeErrorBadRequest.

  • Provides a list of Call Analytics categories, including all rules that make up each category.

    To get detailed information about a specific Call Analytics category, use the operation.

    See

    AWSTranscribeListCallAnalyticsCategoriesRequest

    See

    AWSTranscribeListCallAnalyticsCategoriesResponse

    Declaration

    Objective-C

    - (id)listCallAnalyticsCategories:
    (nonnull AWSTranscribeListCallAnalyticsCategoriesRequest *)request;

    Swift

    func listCallAnalyticsCategories(_ request: AWSTranscribeListCallAnalyticsCategoriesRequest) -> Any!

    Parameters

    request

    A container for the necessary parameters to execute the ListCallAnalyticsCategories service method.

    Return Value

    An instance of AWSTask. On successful execution, task.result will contain an instance of AWSTranscribeListCallAnalyticsCategoriesResponse. On failed execution, task.error may contain an NSError with AWSTranscribeErrorDomain domain and the following error code: AWSTranscribeErrorBadRequest, AWSTranscribeErrorLimitExceeded, AWSTranscribeErrorInternalFailure.

  • Provides a list of Call Analytics categories, including all rules that make up each category.

    To get detailed information about a specific Call Analytics category, use the operation.

    See

    AWSTranscribeListCallAnalyticsCategoriesRequest

    See

    AWSTranscribeListCallAnalyticsCategoriesResponse

    Declaration

    Objective-C

    - (void)listCallAnalyticsCategories:
            (nonnull AWSTranscribeListCallAnalyticsCategoriesRequest *)request
                  completionHandler:
                      (void (^_Nullable)(
                          AWSTranscribeListCallAnalyticsCategoriesResponse
                              *_Nullable,
                          NSError *_Nullable))completionHandler;

    Swift

    func listCallAnalyticsCategories(_ request: AWSTranscribeListCallAnalyticsCategoriesRequest) async throws -> AWSTranscribeListCallAnalyticsCategoriesResponse

    Parameters

    request

    A container for the necessary parameters to execute the ListCallAnalyticsCategories service method.
    completionHandler

    The completion handler to call when the load request is complete. response - A response object, or nil if the request failed. error - An error object that indicates why the request failed, or nil if the request was successful. On failed execution, error may contain an NSError with AWSTranscribeErrorDomain domain and the following error code: AWSTranscribeErrorBadRequest, AWSTranscribeErrorLimitExceeded, AWSTranscribeErrorInternalFailure.

  • Provides a list of Call Analytics jobs that match the specified criteria. If no criteria are specified, all Call Analytics jobs are returned.

    To get detailed information about a specific Call Analytics job, use the operation.

    See

    AWSTranscribeListCallAnalyticsJobsRequest

    See

    AWSTranscribeListCallAnalyticsJobsResponse

    Declaration

    Objective-C

    - (id)listCallAnalyticsJobs:
    (nonnull AWSTranscribeListCallAnalyticsJobsRequest *)request;

    Swift

    func listCallAnalyticsJobs(_ request: AWSTranscribeListCallAnalyticsJobsRequest) -> Any!

    Parameters

    request

    A container for the necessary parameters to execute the ListCallAnalyticsJobs service method.

    Return Value

    An instance of AWSTask. On successful execution, task.result will contain an instance of AWSTranscribeListCallAnalyticsJobsResponse. On failed execution, task.error may contain an NSError with AWSTranscribeErrorDomain domain and the following error code: AWSTranscribeErrorBadRequest, AWSTranscribeErrorLimitExceeded, AWSTranscribeErrorInternalFailure.

  • Provides a list of Call Analytics jobs that match the specified criteria. If no criteria are specified, all Call Analytics jobs are returned.

    To get detailed information about a specific Call Analytics job, use the operation.

    See

    AWSTranscribeListCallAnalyticsJobsRequest

    See

    AWSTranscribeListCallAnalyticsJobsResponse

    Declaration

    Objective-C

    - (void)listCallAnalyticsJobs:
            (nonnull AWSTranscribeListCallAnalyticsJobsRequest *)request
            completionHandler:
                (void (^_Nullable)(
                    AWSTranscribeListCallAnalyticsJobsResponse *_Nullable,
                    NSError *_Nullable))completionHandler;

    Swift

    func listCallAnalyticsJobs(_ request: AWSTranscribeListCallAnalyticsJobsRequest) async throws -> AWSTranscribeListCallAnalyticsJobsResponse

    Parameters

    request

    A container for the necessary parameters to execute the ListCallAnalyticsJobs service method.
    completionHandler

    The completion handler to call when the load request is complete. response - A response object, or nil if the request failed. error - An error object that indicates why the request failed, or nil if the request was successful. On failed execution, error may contain an NSError with AWSTranscribeErrorDomain domain and the following error code: AWSTranscribeErrorBadRequest, AWSTranscribeErrorLimitExceeded, AWSTranscribeErrorInternalFailure.

  • Provides a list of custom language models that match the specified criteria. If no criteria are specified, all custom language models are returned.

    To get detailed information about a specific custom language model, use the operation.

    See

    AWSTranscribeListLanguageModelsRequest

    See

    AWSTranscribeListLanguageModelsResponse

    Declaration

    Objective-C

    - (id)listLanguageModels:
    (nonnull AWSTranscribeListLanguageModelsRequest *)request;

    Swift

    func listLanguageModels(_ request: AWSTranscribeListLanguageModelsRequest) -> Any!

    Parameters

    request

    A container for the necessary parameters to execute the ListLanguageModels service method.

    Return Value

    An instance of AWSTask. On successful execution, task.result will contain an instance of AWSTranscribeListLanguageModelsResponse. On failed execution, task.error may contain an NSError with AWSTranscribeErrorDomain domain and the following error code: AWSTranscribeErrorBadRequest, AWSTranscribeErrorLimitExceeded, AWSTranscribeErrorInternalFailure.

  • Provides a list of custom language models that match the specified criteria. If no criteria are specified, all custom language models are returned.

    To get detailed information about a specific custom language model, use the operation.

    See

    AWSTranscribeListLanguageModelsRequest

    See

    AWSTranscribeListLanguageModelsResponse

    Declaration

    Objective-C

    - (void)
    listLanguageModels:(nonnull AWSTranscribeListLanguageModelsRequest *)request
     completionHandler:
         (void (^_Nullable)(AWSTranscribeListLanguageModelsResponse *_Nullable,
                            NSError *_Nullable))completionHandler;

    Swift

    func listLanguageModels(_ request: AWSTranscribeListLanguageModelsRequest) async throws -> AWSTranscribeListLanguageModelsResponse

    Parameters

    request

    A container for the necessary parameters to execute the ListLanguageModels service method.
    completionHandler

    The completion handler to call when the load request is complete. response - A response object, or nil if the request failed. error - An error object that indicates why the request failed, or nil if the request was successful. On failed execution, error may contain an NSError with AWSTranscribeErrorDomain domain and the following error code: AWSTranscribeErrorBadRequest, AWSTranscribeErrorLimitExceeded, AWSTranscribeErrorInternalFailure.

  • Provides a list of Medical Scribe jobs that match the specified criteria. If no criteria are specified, all Medical Scribe jobs are returned.

    To get detailed information about a specific Medical Scribe job, use the operation.

    See

    AWSTranscribeListMedicalScribeJobsRequest

    See

    AWSTranscribeListMedicalScribeJobsResponse

    Declaration

    Objective-C

    - (id)listMedicalScribeJobs:
    (nonnull AWSTranscribeListMedicalScribeJobsRequest *)request;

    Swift

    func listMedicalScribeJobs(_ request: AWSTranscribeListMedicalScribeJobsRequest) -> Any!

    Parameters

    request

    A container for the necessary parameters to execute the ListMedicalScribeJobs service method.

    Return Value

    An instance of AWSTask. On successful execution, task.result will contain an instance of AWSTranscribeListMedicalScribeJobsResponse. On failed execution, task.error may contain an NSError with AWSTranscribeErrorDomain domain and the following error code: AWSTranscribeErrorBadRequest, AWSTranscribeErrorLimitExceeded, AWSTranscribeErrorInternalFailure.

  • Provides a list of Medical Scribe jobs that match the specified criteria. If no criteria are specified, all Medical Scribe jobs are returned.

    To get detailed information about a specific Medical Scribe job, use the operation.

    See

    AWSTranscribeListMedicalScribeJobsRequest

    See

    AWSTranscribeListMedicalScribeJobsResponse

    Declaration

    Objective-C

    - (void)listMedicalScribeJobs:
            (nonnull AWSTranscribeListMedicalScribeJobsRequest *)request
            completionHandler:
                (void (^_Nullable)(
                    AWSTranscribeListMedicalScribeJobsResponse *_Nullable,
                    NSError *_Nullable))completionHandler;

    Swift

    func listMedicalScribeJobs(_ request: AWSTranscribeListMedicalScribeJobsRequest) async throws -> AWSTranscribeListMedicalScribeJobsResponse

    Parameters

    request

    A container for the necessary parameters to execute the ListMedicalScribeJobs service method.
    completionHandler

    The completion handler to call when the load request is complete. response - A response object, or nil if the request failed. error - An error object that indicates why the request failed, or nil if the request was successful. On failed execution, error may contain an NSError with AWSTranscribeErrorDomain domain and the following error code: AWSTranscribeErrorBadRequest, AWSTranscribeErrorLimitExceeded, AWSTranscribeErrorInternalFailure.

  • Provides a list of medical transcription jobs that match the specified criteria. If no criteria are specified, all medical transcription jobs are returned.

    To get detailed information about a specific medical transcription job, use the operation.

    See

    AWSTranscribeListMedicalTranscriptionJobsRequest

    See

    AWSTranscribeListMedicalTranscriptionJobsResponse

    Declaration

    Objective-C

    - (id)listMedicalTranscriptionJobs:
    (nonnull AWSTranscribeListMedicalTranscriptionJobsRequest *)request;

    Swift

    func listMedicalTranscriptionJobs(_ request: AWSTranscribeListMedicalTranscriptionJobsRequest) -> Any!

    Parameters

    request

    A container for the necessary parameters to execute the ListMedicalTranscriptionJobs service method.

    Return Value

    An instance of AWSTask. On successful execution, task.result will contain an instance of AWSTranscribeListMedicalTranscriptionJobsResponse. On failed execution, task.error may contain an NSError with AWSTranscribeErrorDomain domain and the following error code: AWSTranscribeErrorBadRequest, AWSTranscribeErrorLimitExceeded, AWSTranscribeErrorInternalFailure.

  • Provides a list of medical transcription jobs that match the specified criteria. If no criteria are specified, all medical transcription jobs are returned.

    To get detailed information about a specific medical transcription job, use the operation.

    See

    AWSTranscribeListMedicalTranscriptionJobsRequest

    See

    AWSTranscribeListMedicalTranscriptionJobsResponse

    Declaration

    Objective-C

    - (void)listMedicalTranscriptionJobs:
            (nonnull AWSTranscribeListMedicalTranscriptionJobsRequest *)request
                   completionHandler:
                       (void (^_Nullable)(
                           AWSTranscribeListMedicalTranscriptionJobsResponse
                               *_Nullable,
                           NSError *_Nullable))completionHandler;

    Swift

    func listMedicalTranscriptionJobs(_ request: AWSTranscribeListMedicalTranscriptionJobsRequest) async throws -> AWSTranscribeListMedicalTranscriptionJobsResponse

    Parameters

    request

    A container for the necessary parameters to execute the ListMedicalTranscriptionJobs service method.
    completionHandler

    The completion handler to call when the load request is complete. response - A response object, or nil if the request failed. error - An error object that indicates why the request failed, or nil if the request was successful. On failed execution, error may contain an NSError with AWSTranscribeErrorDomain domain and the following error code: AWSTranscribeErrorBadRequest, AWSTranscribeErrorLimitExceeded, AWSTranscribeErrorInternalFailure.

  • Provides a list of custom medical vocabularies that match the specified criteria. If no criteria are specified, all custom medical vocabularies are returned.

    To get detailed information about a specific custom medical vocabulary, use the operation.

    See

    AWSTranscribeListMedicalVocabulariesRequest

    See

    AWSTranscribeListMedicalVocabulariesResponse

    Declaration

    Objective-C

    - (id)listMedicalVocabularies:
    (nonnull AWSTranscribeListMedicalVocabulariesRequest *)request;

    Swift

    func listMedicalVocabularies(_ request: AWSTranscribeListMedicalVocabulariesRequest) -> Any!

    Parameters

    request

    A container for the necessary parameters to execute the ListMedicalVocabularies service method.

    Return Value

    An instance of AWSTask. On successful execution, task.result will contain an instance of AWSTranscribeListMedicalVocabulariesResponse. On failed execution, task.error may contain an NSError with AWSTranscribeErrorDomain domain and the following error code: AWSTranscribeErrorBadRequest, AWSTranscribeErrorLimitExceeded, AWSTranscribeErrorInternalFailure.

  • Provides a list of custom medical vocabularies that match the specified criteria. If no criteria are specified, all custom medical vocabularies are returned.

    To get detailed information about a specific custom medical vocabulary, use the operation.

    See

    AWSTranscribeListMedicalVocabulariesRequest

    See

    AWSTranscribeListMedicalVocabulariesResponse

    Declaration

    Objective-C

    - (void)listMedicalVocabularies:
            (nonnull AWSTranscribeListMedicalVocabulariesRequest *)request
              completionHandler:
                  (void (^_Nullable)(
                      AWSTranscribeListMedicalVocabulariesResponse *_Nullable,
                      NSError *_Nullable))completionHandler;

    Swift

    func listMedicalVocabularies(_ request: AWSTranscribeListMedicalVocabulariesRequest) async throws -> AWSTranscribeListMedicalVocabulariesResponse

    Parameters

    request

    A container for the necessary parameters to execute the ListMedicalVocabularies service method.
    completionHandler

    The completion handler to call when the load request is complete. response - A response object, or nil if the request failed. error - An error object that indicates why the request failed, or nil if the request was successful. On failed execution, error may contain an NSError with AWSTranscribeErrorDomain domain and the following error code: AWSTranscribeErrorBadRequest, AWSTranscribeErrorLimitExceeded, AWSTranscribeErrorInternalFailure.

  • Lists all tags associated with the specified transcription job, vocabulary, model, or resource.

    To learn more about using tags with Amazon Transcribe, refer to Tagging resources.

    See

    AWSTranscribeListTagsForResourceRequest

    See

    AWSTranscribeListTagsForResourceResponse

    Declaration

    Objective-C

    - (id)listTagsForResource:
    (nonnull AWSTranscribeListTagsForResourceRequest *)request;

    Swift

    func listTags(forResource request: AWSTranscribeListTagsForResourceRequest) -> Any!

    Parameters

    request

    A container for the necessary parameters to execute the ListTagsForResource service method.

    Return Value

    An instance of AWSTask. On successful execution, task.result will contain an instance of AWSTranscribeListTagsForResourceResponse. On failed execution, task.error may contain an NSError with AWSTranscribeErrorDomain domain and the following error code: AWSTranscribeErrorBadRequest, AWSTranscribeErrorNotFound, AWSTranscribeErrorLimitExceeded, AWSTranscribeErrorInternalFailure.

  • Lists all tags associated with the specified transcription job, vocabulary, model, or resource.

    To learn more about using tags with Amazon Transcribe, refer to Tagging resources.

    See

    AWSTranscribeListTagsForResourceRequest

    See

    AWSTranscribeListTagsForResourceResponse

    Declaration

    Objective-C

    - (void)listTagsForResource:
            (nonnull AWSTranscribeListTagsForResourceRequest *)request
          completionHandler:
              (void (^_Nullable)(
                  AWSTranscribeListTagsForResourceResponse *_Nullable,
                  NSError *_Nullable))completionHandler;

    Swift

    func listTags(forResource request: AWSTranscribeListTagsForResourceRequest) async throws -> AWSTranscribeListTagsForResourceResponse

    Parameters

    request

    A container for the necessary parameters to execute the ListTagsForResource service method.
    completionHandler

    The completion handler to call when the load request is complete. response - A response object, or nil if the request failed. error - An error object that indicates why the request failed, or nil if the request was successful. On failed execution, error may contain an NSError with AWSTranscribeErrorDomain domain and the following error code: AWSTranscribeErrorBadRequest, AWSTranscribeErrorNotFound, AWSTranscribeErrorLimitExceeded, AWSTranscribeErrorInternalFailure.

  • Provides a list of transcription jobs that match the specified criteria. If no criteria are specified, all transcription jobs are returned.

    To get detailed information about a specific transcription job, use the operation.

    See

    AWSTranscribeListTranscriptionJobsRequest

    See

    AWSTranscribeListTranscriptionJobsResponse

    Declaration

    Objective-C

    - (id)listTranscriptionJobs:
    (nonnull AWSTranscribeListTranscriptionJobsRequest *)request;

    Swift

    func listTranscriptionJobs(_ request: AWSTranscribeListTranscriptionJobsRequest) -> Any!

    Parameters

    request

    A container for the necessary parameters to execute the ListTranscriptionJobs service method.

    Return Value

    An instance of AWSTask. On successful execution, task.result will contain an instance of AWSTranscribeListTranscriptionJobsResponse. On failed execution, task.error may contain an NSError with AWSTranscribeErrorDomain domain and the following error code: AWSTranscribeErrorBadRequest, AWSTranscribeErrorLimitExceeded, AWSTranscribeErrorInternalFailure.

  • Provides a list of transcription jobs that match the specified criteria. If no criteria are specified, all transcription jobs are returned.

    To get detailed information about a specific transcription job, use the operation.

    See

    AWSTranscribeListTranscriptionJobsRequest

    See

    AWSTranscribeListTranscriptionJobsResponse

    Declaration

    Objective-C

    - (void)listTranscriptionJobs:
            (nonnull AWSTranscribeListTranscriptionJobsRequest *)request
            completionHandler:
                (void (^_Nullable)(
                    AWSTranscribeListTranscriptionJobsResponse *_Nullable,
                    NSError *_Nullable))completionHandler;

    Swift

    func listTranscriptionJobs(_ request: AWSTranscribeListTranscriptionJobsRequest) async throws -> AWSTranscribeListTranscriptionJobsResponse

    Parameters

    request

    A container for the necessary parameters to execute the ListTranscriptionJobs service method.
    completionHandler

    The completion handler to call when the load request is complete. response - A response object, or nil if the request failed. error - An error object that indicates why the request failed, or nil if the request was successful. On failed execution, error may contain an NSError with AWSTranscribeErrorDomain domain and the following error code: AWSTranscribeErrorBadRequest, AWSTranscribeErrorLimitExceeded, AWSTranscribeErrorInternalFailure.

  • Provides a list of custom vocabularies that match the specified criteria. If no criteria are specified, all custom vocabularies are returned.

    To get detailed information about a specific custom vocabulary, use the operation.

    See

    AWSTranscribeListVocabulariesRequest

    See

    AWSTranscribeListVocabulariesResponse

    Declaration

    Objective-C

    - (id)listVocabularies:(nonnull AWSTranscribeListVocabulariesRequest *)request;

    Swift

    func listVocabularies(_ request: AWSTranscribeListVocabulariesRequest) -> Any!

    Parameters

    request

    A container for the necessary parameters to execute the ListVocabularies service method.

    Return Value

    An instance of AWSTask. On successful execution, task.result will contain an instance of AWSTranscribeListVocabulariesResponse. On failed execution, task.error may contain an NSError with AWSTranscribeErrorDomain domain and the following error code: AWSTranscribeErrorBadRequest, AWSTranscribeErrorLimitExceeded, AWSTranscribeErrorInternalFailure.

  • Provides a list of custom vocabularies that match the specified criteria. If no criteria are specified, all custom vocabularies are returned.

    To get detailed information about a specific custom vocabulary, use the operation.

    See

    AWSTranscribeListVocabulariesRequest

    See

    AWSTranscribeListVocabulariesResponse

    Declaration

    Objective-C

    - (void)listVocabularies:(nonnull AWSTranscribeListVocabulariesRequest *)request
       completionHandler:
           (void (^_Nullable)(AWSTranscribeListVocabulariesResponse *_Nullable,
                              NSError *_Nullable))completionHandler;

    Swift

    func listVocabularies(_ request: AWSTranscribeListVocabulariesRequest) async throws -> AWSTranscribeListVocabulariesResponse

    Parameters

    request

    A container for the necessary parameters to execute the ListVocabularies service method.
    completionHandler

    The completion handler to call when the load request is complete. response - A response object, or nil if the request failed. error - An error object that indicates why the request failed, or nil if the request was successful. On failed execution, error may contain an NSError with AWSTranscribeErrorDomain domain and the following error code: AWSTranscribeErrorBadRequest, AWSTranscribeErrorLimitExceeded, AWSTranscribeErrorInternalFailure.

  • Provides a list of custom vocabulary filters that match the specified criteria. If no criteria are specified, all custom vocabularies are returned.

    To get detailed information about a specific custom vocabulary filter, use the operation.

    See

    AWSTranscribeListVocabularyFiltersRequest

    See

    AWSTranscribeListVocabularyFiltersResponse

    Declaration

    Objective-C

    - (id)listVocabularyFilters:
    (nonnull AWSTranscribeListVocabularyFiltersRequest *)request;

    Swift

    func listVocabularyFilters(_ request: AWSTranscribeListVocabularyFiltersRequest) -> Any!

    Parameters

    request

    A container for the necessary parameters to execute the ListVocabularyFilters service method.

    Return Value

    An instance of AWSTask. On successful execution, task.result will contain an instance of AWSTranscribeListVocabularyFiltersResponse. On failed execution, task.error may contain an NSError with AWSTranscribeErrorDomain domain and the following error code: AWSTranscribeErrorBadRequest, AWSTranscribeErrorLimitExceeded, AWSTranscribeErrorInternalFailure.

  • Provides a list of custom vocabulary filters that match the specified criteria. If no criteria are specified, all custom vocabularies are returned.

    To get detailed information about a specific custom vocabulary filter, use the operation.

    See

    AWSTranscribeListVocabularyFiltersRequest

    See

    AWSTranscribeListVocabularyFiltersResponse

    Declaration

    Objective-C

    - (void)listVocabularyFilters:
            (nonnull AWSTranscribeListVocabularyFiltersRequest *)request
            completionHandler:
                (void (^_Nullable)(
                    AWSTranscribeListVocabularyFiltersResponse *_Nullable,
                    NSError *_Nullable))completionHandler;

    Swift

    func listVocabularyFilters(_ request: AWSTranscribeListVocabularyFiltersRequest) async throws -> AWSTranscribeListVocabularyFiltersResponse

    Parameters

    request

    A container for the necessary parameters to execute the ListVocabularyFilters service method.
    completionHandler

    The completion handler to call when the load request is complete. response - A response object, or nil if the request failed. error - An error object that indicates why the request failed, or nil if the request was successful. On failed execution, error may contain an NSError with AWSTranscribeErrorDomain domain and the following error code: AWSTranscribeErrorBadRequest, AWSTranscribeErrorLimitExceeded, AWSTranscribeErrorInternalFailure.

  • Transcribes the audio from a customer service call and applies any additional Request Parameters you choose to include in your request.

    In addition to many standard transcription features, Call Analytics provides you with call characteristics, call summarization, speaker sentiment, and optional redaction of your text transcript and your audio file. You can also apply custom categories to flag specified conditions. To learn more about these features and insights, refer to Analyzing call center audio with Call Analytics.

    If you want to apply categories to your Call Analytics job, you must create them before submitting your job request. Categories cannot be retroactively applied to a job. To create a new category, use the operation. To learn more about Call Analytics categories, see Creating categories for post-call transcriptions and Creating categories for real-time transcriptions.

    To make a StartCallAnalyticsJob request, you must first upload your media file into an Amazon S3 bucket; you can then specify the Amazon S3 location of the file using the Media parameter.

    Note that job queuing is enabled by default for Call Analytics jobs.

    You must include the following parameters in your StartCallAnalyticsJob request:

    • region: The Amazon Web Services Region where you are making your request. For a list of Amazon Web Services Regions supported with Amazon Transcribe, refer to Amazon Transcribe endpoints and quotas.

    • CallAnalyticsJobName: A custom name that you create for your transcription job that’s unique within your Amazon Web Services account.

    • DataAccessRoleArn: The Amazon Resource Name (ARN) of an IAM role that has permissions to access the Amazon S3 bucket that contains your input files.

    • Media (MediaFileUri or RedactedMediaFileUri): The Amazon S3 location of your media file.

    With Call Analytics, you can redact the audio contained in your media file by including RedactedMediaFileUri, instead of MediaFileUri, to specify the location of your input audio. If you choose to redact your audio, you can find your redacted media at the location specified in the RedactedMediaFileUri field of your response.

    See

    AWSTranscribeStartCallAnalyticsJobRequest

    See

    AWSTranscribeStartCallAnalyticsJobResponse

    Declaration

    Objective-C

    - (id)startCallAnalyticsJob:
    (nonnull AWSTranscribeStartCallAnalyticsJobRequest *)request;

    Swift

    func startCallAnalyticsJob(_ request: AWSTranscribeStartCallAnalyticsJobRequest) -> Any!

    Parameters

    request

    A container for the necessary parameters to execute the StartCallAnalyticsJob service method.

    Return Value

    An instance of AWSTask. On successful execution, task.result will contain an instance of AWSTranscribeStartCallAnalyticsJobResponse. On failed execution, task.error may contain an NSError with AWSTranscribeErrorDomain domain and the following error code: AWSTranscribeErrorBadRequest, AWSTranscribeErrorLimitExceeded, AWSTranscribeErrorInternalFailure, AWSTranscribeErrorConflict.

  • Transcribes the audio from a customer service call and applies any additional Request Parameters you choose to include in your request.

    In addition to many standard transcription features, Call Analytics provides you with call characteristics, call summarization, speaker sentiment, and optional redaction of your text transcript and your audio file. You can also apply custom categories to flag specified conditions. To learn more about these features and insights, refer to Analyzing call center audio with Call Analytics.

    If you want to apply categories to your Call Analytics job, you must create them before submitting your job request. Categories cannot be retroactively applied to a job. To create a new category, use the operation. To learn more about Call Analytics categories, see Creating categories for post-call transcriptions and Creating categories for real-time transcriptions.

    To make a StartCallAnalyticsJob request, you must first upload your media file into an Amazon S3 bucket; you can then specify the Amazon S3 location of the file using the Media parameter.

    Note that job queuing is enabled by default for Call Analytics jobs.

    You must include the following parameters in your StartCallAnalyticsJob request:

    • region: The Amazon Web Services Region where you are making your request. For a list of Amazon Web Services Regions supported with Amazon Transcribe, refer to Amazon Transcribe endpoints and quotas.

    • CallAnalyticsJobName: A custom name that you create for your transcription job that’s unique within your Amazon Web Services account.

    • DataAccessRoleArn: The Amazon Resource Name (ARN) of an IAM role that has permissions to access the Amazon S3 bucket that contains your input files.

    • Media (MediaFileUri or RedactedMediaFileUri): The Amazon S3 location of your media file.

    With Call Analytics, you can redact the audio contained in your media file by including RedactedMediaFileUri, instead of MediaFileUri, to specify the location of your input audio. If you choose to redact your audio, you can find your redacted media at the location specified in the RedactedMediaFileUri field of your response.

    See

    AWSTranscribeStartCallAnalyticsJobRequest

    See

    AWSTranscribeStartCallAnalyticsJobResponse

    Declaration

    Objective-C

    - (void)startCallAnalyticsJob:
            (nonnull AWSTranscribeStartCallAnalyticsJobRequest *)request
            completionHandler:
                (void (^_Nullable)(
                    AWSTranscribeStartCallAnalyticsJobResponse *_Nullable,
                    NSError *_Nullable))completionHandler;

    Swift

    func startCallAnalyticsJob(_ request: AWSTranscribeStartCallAnalyticsJobRequest) async throws -> AWSTranscribeStartCallAnalyticsJobResponse

    Parameters

    request

    A container for the necessary parameters to execute the StartCallAnalyticsJob service method.
    completionHandler

    The completion handler to call when the load request is complete. response - A response object, or nil if the request failed. error - An error object that indicates why the request failed, or nil if the request was successful. On failed execution, error may contain an NSError with AWSTranscribeErrorDomain domain and the following error code: AWSTranscribeErrorBadRequest, AWSTranscribeErrorLimitExceeded, AWSTranscribeErrorInternalFailure, AWSTranscribeErrorConflict.

  • Transcribes patient-clinician conversations and generates clinical notes.

    Amazon Web Services HealthScribe automatically provides rich conversation transcripts, identifies speaker roles, classifies dialogues, extracts medical terms, and generates preliminary clinical notes. To learn more about these features, refer to Amazon Web Services HealthScribe.

    To make a StartMedicalScribeJob request, you must first upload your media file into an Amazon S3 bucket; you can then specify the Amazon S3 location of the file using the Media parameter.

    You must include the following parameters in your StartMedicalTranscriptionJob request:

    • DataAccessRoleArn: The ARN of an IAM role with the these minimum permissions: read permission on input file Amazon S3 bucket specified in Media, write permission on the Amazon S3 bucket specified in OutputBucketName, and full permissions on the KMS key specified in OutputEncryptionKMSKeyId (if set). The role should also allow transcribe.amazonaws.com to assume it.

    • Media (MediaFileUri): The Amazon S3 location of your media file.

    • MedicalScribeJobName: A custom name you create for your MedicalScribe job that is unique within your Amazon Web Services account.

    • OutputBucketName: The Amazon S3 bucket where you want your output files stored.

    • Settings: A MedicalScribeSettings obect that must set exactly one of ShowSpeakerLabels or ChannelIdentification to true. If ShowSpeakerLabels is true, MaxSpeakerLabels must also be set.

    • ChannelDefinitions: A MedicalScribeChannelDefinitions array should be set if and only if the ChannelIdentification value of Settings is set to true.

    See

    AWSTranscribeStartMedicalScribeJobRequest

    See

    AWSTranscribeStartMedicalScribeJobResponse

    Declaration

    Objective-C

    - (id)startMedicalScribeJob:
    (nonnull AWSTranscribeStartMedicalScribeJobRequest *)request;

    Swift

    func startMedicalScribeJob(_ request: AWSTranscribeStartMedicalScribeJobRequest) -> Any!

    Parameters

    request

    A container for the necessary parameters to execute the StartMedicalScribeJob service method.

    Return Value

    An instance of AWSTask. On successful execution, task.result will contain an instance of AWSTranscribeStartMedicalScribeJobResponse. On failed execution, task.error may contain an NSError with AWSTranscribeErrorDomain domain and the following error code: AWSTranscribeErrorBadRequest, AWSTranscribeErrorLimitExceeded, AWSTranscribeErrorInternalFailure, AWSTranscribeErrorConflict.

  • Transcribes patient-clinician conversations and generates clinical notes.

    Amazon Web Services HealthScribe automatically provides rich conversation transcripts, identifies speaker roles, classifies dialogues, extracts medical terms, and generates preliminary clinical notes. To learn more about these features, refer to Amazon Web Services HealthScribe.

    To make a StartMedicalScribeJob request, you must first upload your media file into an Amazon S3 bucket; you can then specify the Amazon S3 location of the file using the Media parameter.

    You must include the following parameters in your StartMedicalTranscriptionJob request:

    • DataAccessRoleArn: The ARN of an IAM role with the these minimum permissions: read permission on input file Amazon S3 bucket specified in Media, write permission on the Amazon S3 bucket specified in OutputBucketName, and full permissions on the KMS key specified in OutputEncryptionKMSKeyId (if set). The role should also allow transcribe.amazonaws.com to assume it.

    • Media (MediaFileUri): The Amazon S3 location of your media file.

    • MedicalScribeJobName: A custom name you create for your MedicalScribe job that is unique within your Amazon Web Services account.

    • OutputBucketName: The Amazon S3 bucket where you want your output files stored.

    • Settings: A MedicalScribeSettings obect that must set exactly one of ShowSpeakerLabels or ChannelIdentification to true. If ShowSpeakerLabels is true, MaxSpeakerLabels must also be set.

    • ChannelDefinitions: A MedicalScribeChannelDefinitions array should be set if and only if the ChannelIdentification value of Settings is set to true.

    See

    AWSTranscribeStartMedicalScribeJobRequest

    See

    AWSTranscribeStartMedicalScribeJobResponse

    Declaration

    Objective-C

    - (void)startMedicalScribeJob:
            (nonnull AWSTranscribeStartMedicalScribeJobRequest *)request
            completionHandler:
                (void (^_Nullable)(
                    AWSTranscribeStartMedicalScribeJobResponse *_Nullable,
                    NSError *_Nullable))completionHandler;

    Swift

    func startMedicalScribeJob(_ request: AWSTranscribeStartMedicalScribeJobRequest) async throws -> AWSTranscribeStartMedicalScribeJobResponse

    Parameters

    request

    A container for the necessary parameters to execute the StartMedicalScribeJob service method.
    completionHandler

    The completion handler to call when the load request is complete. response - A response object, or nil if the request failed. error - An error object that indicates why the request failed, or nil if the request was successful. On failed execution, error may contain an NSError with AWSTranscribeErrorDomain domain and the following error code: AWSTranscribeErrorBadRequest, AWSTranscribeErrorLimitExceeded, AWSTranscribeErrorInternalFailure, AWSTranscribeErrorConflict.

  • Transcribes the audio from a medical dictation or conversation and applies any additional Request Parameters you choose to include in your request.

    In addition to many standard transcription features, Amazon Transcribe Medical provides you with a robust medical vocabulary and, optionally, content identification, which adds flags to personal health information (PHI). To learn more about these features, refer to How Amazon Transcribe Medical works.

    To make a StartMedicalTranscriptionJob request, you must first upload your media file into an Amazon S3 bucket; you can then specify the Amazon S3 location of the file using the Media parameter.

    You must include the following parameters in your StartMedicalTranscriptionJob request:

    • region: The Amazon Web Services Region where you are making your request. For a list of Amazon Web Services Regions supported with Amazon Transcribe, refer to Amazon Transcribe endpoints and quotas.

    • MedicalTranscriptionJobName: A custom name you create for your transcription job that is unique within your Amazon Web Services account.

    • Media (MediaFileUri): The Amazon S3 location of your media file.

    • LanguageCode: This must be en-US.

    • OutputBucketName: The Amazon S3 bucket where you want your transcript stored. If you want your output stored in a sub-folder of this bucket, you must also include OutputKey.

    • Specialty: This must be PRIMARYCARE.

    • Type: Choose whether your audio is a conversation or a dictation.

    See

    AWSTranscribeStartMedicalTranscriptionJobRequest

    See

    AWSTranscribeStartMedicalTranscriptionJobResponse

    Declaration

    Objective-C

    - (id)startMedicalTranscriptionJob:
    (nonnull AWSTranscribeStartMedicalTranscriptionJobRequest *)request;

    Swift

    func startMedicalTranscriptionJob(_ request: AWSTranscribeStartMedicalTranscriptionJobRequest) -> Any!

    Parameters

    request

    A container for the necessary parameters to execute the StartMedicalTranscriptionJob service method.

    Return Value

    An instance of AWSTask. On successful execution, task.result will contain an instance of AWSTranscribeStartMedicalTranscriptionJobResponse. On failed execution, task.error may contain an NSError with AWSTranscribeErrorDomain domain and the following error code: AWSTranscribeErrorBadRequest, AWSTranscribeErrorLimitExceeded, AWSTranscribeErrorInternalFailure, AWSTranscribeErrorConflict.

  • Transcribes the audio from a medical dictation or conversation and applies any additional Request Parameters you choose to include in your request.

    In addition to many standard transcription features, Amazon Transcribe Medical provides you with a robust medical vocabulary and, optionally, content identification, which adds flags to personal health information (PHI). To learn more about these features, refer to How Amazon Transcribe Medical works.

    To make a StartMedicalTranscriptionJob request, you must first upload your media file into an Amazon S3 bucket; you can then specify the Amazon S3 location of the file using the Media parameter.

    You must include the following parameters in your StartMedicalTranscriptionJob request:

    • region: The Amazon Web Services Region where you are making your request. For a list of Amazon Web Services Regions supported with Amazon Transcribe, refer to Amazon Transcribe endpoints and quotas.

    • MedicalTranscriptionJobName: A custom name you create for your transcription job that is unique within your Amazon Web Services account.

    • Media (MediaFileUri): The Amazon S3 location of your media file.

    • LanguageCode: This must be en-US.

    • OutputBucketName: The Amazon S3 bucket where you want your transcript stored. If you want your output stored in a sub-folder of this bucket, you must also include OutputKey.

    • Specialty: This must be PRIMARYCARE.

    • Type: Choose whether your audio is a conversation or a dictation.

    See

    AWSTranscribeStartMedicalTranscriptionJobRequest

    See

    AWSTranscribeStartMedicalTranscriptionJobResponse

    Declaration

    Objective-C

    - (void)startMedicalTranscriptionJob:
            (nonnull AWSTranscribeStartMedicalTranscriptionJobRequest *)request
                   completionHandler:
                       (void (^_Nullable)(
                           AWSTranscribeStartMedicalTranscriptionJobResponse
                               *_Nullable,
                           NSError *_Nullable))completionHandler;

    Swift

    func startMedicalTranscriptionJob(_ request: AWSTranscribeStartMedicalTranscriptionJobRequest) async throws -> AWSTranscribeStartMedicalTranscriptionJobResponse

    Parameters

    request

    A container for the necessary parameters to execute the StartMedicalTranscriptionJob service method.
    completionHandler

    The completion handler to call when the load request is complete. response - A response object, or nil if the request failed. error - An error object that indicates why the request failed, or nil if the request was successful. On failed execution, error may contain an NSError with AWSTranscribeErrorDomain domain and the following error code: AWSTranscribeErrorBadRequest, AWSTranscribeErrorLimitExceeded, AWSTranscribeErrorInternalFailure, AWSTranscribeErrorConflict.

  • Transcribes the audio from a media file and applies any additional Request Parameters you choose to include in your request.

    To make a StartTranscriptionJob request, you must first upload your media file into an Amazon S3 bucket; you can then specify the Amazon S3 location of the file using the Media parameter.

    You must include the following parameters in your StartTranscriptionJob request:

    • region: The Amazon Web Services Region where you are making your request. For a list of Amazon Web Services Regions supported with Amazon Transcribe, refer to Amazon Transcribe endpoints and quotas.

    • TranscriptionJobName: A custom name you create for your transcription job that is unique within your Amazon Web Services account.

    • Media (MediaFileUri): The Amazon S3 location of your media file.

    • One of LanguageCode, IdentifyLanguage, or IdentifyMultipleLanguages: If you know the language of your media file, specify it using the LanguageCode parameter; you can find all valid language codes in the Supported languages table. If you do not know the languages spoken in your media, use either IdentifyLanguage or IdentifyMultipleLanguages and let Amazon Transcribe identify the languages for you.

    See

    AWSTranscribeStartTranscriptionJobRequest

    See

    AWSTranscribeStartTranscriptionJobResponse

    Declaration

    Objective-C

    - (id)startTranscriptionJob:
    (nonnull AWSTranscribeStartTranscriptionJobRequest *)request;

    Swift

    func startTranscriptionJob(_ request: AWSTranscribeStartTranscriptionJobRequest) -> Any!

    Parameters

    request

    A container for the necessary parameters to execute the StartTranscriptionJob service method.

    Return Value

    An instance of AWSTask. On successful execution, task.result will contain an instance of AWSTranscribeStartTranscriptionJobResponse. On failed execution, task.error may contain an NSError with AWSTranscribeErrorDomain domain and the following error code: AWSTranscribeErrorBadRequest, AWSTranscribeErrorLimitExceeded, AWSTranscribeErrorInternalFailure, AWSTranscribeErrorConflict.

  • Transcribes the audio from a media file and applies any additional Request Parameters you choose to include in your request.

    To make a StartTranscriptionJob request, you must first upload your media file into an Amazon S3 bucket; you can then specify the Amazon S3 location of the file using the Media parameter.

    You must include the following parameters in your StartTranscriptionJob request:

    • region: The Amazon Web Services Region where you are making your request. For a list of Amazon Web Services Regions supported with Amazon Transcribe, refer to Amazon Transcribe endpoints and quotas.

    • TranscriptionJobName: A custom name you create for your transcription job that is unique within your Amazon Web Services account.

    • Media (MediaFileUri): The Amazon S3 location of your media file.

    • One of LanguageCode, IdentifyLanguage, or IdentifyMultipleLanguages: If you know the language of your media file, specify it using the LanguageCode parameter; you can find all valid language codes in the Supported languages table. If you do not know the languages spoken in your media, use either IdentifyLanguage or IdentifyMultipleLanguages and let Amazon Transcribe identify the languages for you.

    See

    AWSTranscribeStartTranscriptionJobRequest

    See

    AWSTranscribeStartTranscriptionJobResponse

    Declaration

    Objective-C

    - (void)startTranscriptionJob:
            (nonnull AWSTranscribeStartTranscriptionJobRequest *)request
            completionHandler:
                (void (^_Nullable)(
                    AWSTranscribeStartTranscriptionJobResponse *_Nullable,
                    NSError *_Nullable))completionHandler;

    Swift

    func startTranscriptionJob(_ request: AWSTranscribeStartTranscriptionJobRequest) async throws -> AWSTranscribeStartTranscriptionJobResponse

    Parameters

    request

    A container for the necessary parameters to execute the StartTranscriptionJob service method.
    completionHandler

    The completion handler to call when the load request is complete. response - A response object, or nil if the request failed. error - An error object that indicates why the request failed, or nil if the request was successful. On failed execution, error may contain an NSError with AWSTranscribeErrorDomain domain and the following error code: AWSTranscribeErrorBadRequest, AWSTranscribeErrorLimitExceeded, AWSTranscribeErrorInternalFailure, AWSTranscribeErrorConflict.

  • Adds one or more custom tags, each in the form of a key:value pair, to the specified resource.

    To learn more about using tags with Amazon Transcribe, refer to Tagging resources.

    See

    AWSTranscribeTagResourceRequest

    See

    AWSTranscribeTagResourceResponse

    Declaration

    Objective-C

    - (id)tagResource:(nonnull AWSTranscribeTagResourceRequest *)request;

    Swift

    func tagResource(_ request: AWSTranscribeTagResourceRequest) -> Any!

    Parameters

    request

    A container for the necessary parameters to execute the TagResource service method.

    Return Value

    An instance of AWSTask. On successful execution, task.result will contain an instance of AWSTranscribeTagResourceResponse. On failed execution, task.error may contain an NSError with AWSTranscribeErrorDomain domain and the following error code: AWSTranscribeErrorBadRequest, AWSTranscribeErrorConflict, AWSTranscribeErrorNotFound, AWSTranscribeErrorLimitExceeded, AWSTranscribeErrorInternalFailure.

  • Adds one or more custom tags, each in the form of a key:value pair, to the specified resource.

    To learn more about using tags with Amazon Transcribe, refer to Tagging resources.

    See

    AWSTranscribeTagResourceRequest

    See

    AWSTranscribeTagResourceResponse

    Declaration

    Objective-C

    - (void)tagResource:(nonnull AWSTranscribeTagResourceRequest *)request
    completionHandler:
        (void (^_Nullable)(AWSTranscribeTagResourceResponse *_Nullable,
                           NSError *_Nullable))completionHandler;

    Swift

    func tagResource(_ request: AWSTranscribeTagResourceRequest) async throws -> AWSTranscribeTagResourceResponse

    Parameters

    request

    A container for the necessary parameters to execute the TagResource service method.
    completionHandler

    The completion handler to call when the load request is complete. response - A response object, or nil if the request failed. error - An error object that indicates why the request failed, or nil if the request was successful. On failed execution, error may contain an NSError with AWSTranscribeErrorDomain domain and the following error code: AWSTranscribeErrorBadRequest, AWSTranscribeErrorConflict, AWSTranscribeErrorNotFound, AWSTranscribeErrorLimitExceeded, AWSTranscribeErrorInternalFailure.

  • Removes the specified tags from the specified Amazon Transcribe resource.

    If you include UntagResource in your request, you must also include ResourceArn and TagKeys.

    See

    AWSTranscribeUntagResourceRequest

    See

    AWSTranscribeUntagResourceResponse

    Declaration

    Objective-C

    - (id)untagResource:(nonnull AWSTranscribeUntagResourceRequest *)request;

    Swift

    func untagResource(_ request: AWSTranscribeUntagResourceRequest) -> Any!

    Parameters

    request

    A container for the necessary parameters to execute the UntagResource service method.

    Return Value

    An instance of AWSTask. On successful execution, task.result will contain an instance of AWSTranscribeUntagResourceResponse. On failed execution, task.error may contain an NSError with AWSTranscribeErrorDomain domain and the following error code: AWSTranscribeErrorLimitExceeded, AWSTranscribeErrorBadRequest, AWSTranscribeErrorConflict, AWSTranscribeErrorNotFound, AWSTranscribeErrorInternalFailure.

  • Removes the specified tags from the specified Amazon Transcribe resource.

    If you include UntagResource in your request, you must also include ResourceArn and TagKeys.

    See

    AWSTranscribeUntagResourceRequest

    See

    AWSTranscribeUntagResourceResponse

    Declaration

    Objective-C

    - (void)untagResource:(nonnull AWSTranscribeUntagResourceRequest *)request
    completionHandler:
        (void (^_Nullable)(AWSTranscribeUntagResourceResponse *_Nullable,
                           NSError *_Nullable))completionHandler;

    Swift

    func untagResource(_ request: AWSTranscribeUntagResourceRequest) async throws -> AWSTranscribeUntagResourceResponse

    Parameters

    request

    A container for the necessary parameters to execute the UntagResource service method.
    completionHandler

    The completion handler to call when the load request is complete. response - A response object, or nil if the request failed. error - An error object that indicates why the request failed, or nil if the request was successful. On failed execution, error may contain an NSError with AWSTranscribeErrorDomain domain and the following error code: AWSTranscribeErrorLimitExceeded, AWSTranscribeErrorBadRequest, AWSTranscribeErrorConflict, AWSTranscribeErrorNotFound, AWSTranscribeErrorInternalFailure.

  • Updates the specified Call Analytics category with new rules. Note that the UpdateCallAnalyticsCategory operation overwrites all existing rules contained in the specified category. You cannot append additional rules onto an existing category.

    To create a new category, see .

    See

    AWSTranscribeUpdateCallAnalyticsCategoryRequest

    See

    AWSTranscribeUpdateCallAnalyticsCategoryResponse

    Declaration

    Objective-C

    - (id)updateCallAnalyticsCategory:
    (nonnull AWSTranscribeUpdateCallAnalyticsCategoryRequest *)request;

    Swift

    func updateCallAnalyticsCategory(_ request: AWSTranscribeUpdateCallAnalyticsCategoryRequest) -> Any!

    Parameters

    request

    A container for the necessary parameters to execute the UpdateCallAnalyticsCategory service method.

    Return Value

    An instance of AWSTask. On successful execution, task.result will contain an instance of AWSTranscribeUpdateCallAnalyticsCategoryResponse. On failed execution, task.error may contain an NSError with AWSTranscribeErrorDomain domain and the following error code: AWSTranscribeErrorBadRequest, AWSTranscribeErrorLimitExceeded, AWSTranscribeErrorInternalFailure, AWSTranscribeErrorNotFound, AWSTranscribeErrorConflict.

  • Updates the specified Call Analytics category with new rules. Note that the UpdateCallAnalyticsCategory operation overwrites all existing rules contained in the specified category. You cannot append additional rules onto an existing category.

    To create a new category, see .

    See

    AWSTranscribeUpdateCallAnalyticsCategoryRequest

    See

    AWSTranscribeUpdateCallAnalyticsCategoryResponse

    Declaration

    Objective-C

    - (void)updateCallAnalyticsCategory:
            (nonnull AWSTranscribeUpdateCallAnalyticsCategoryRequest *)request
                  completionHandler:
                      (void (^_Nullable)(
                          AWSTranscribeUpdateCallAnalyticsCategoryResponse
                              *_Nullable,
                          NSError *_Nullable))completionHandler;

    Swift

    func updateCallAnalyticsCategory(_ request: AWSTranscribeUpdateCallAnalyticsCategoryRequest) async throws -> AWSTranscribeUpdateCallAnalyticsCategoryResponse

    Parameters

    request

    A container for the necessary parameters to execute the UpdateCallAnalyticsCategory service method.
    completionHandler

    The completion handler to call when the load request is complete. response - A response object, or nil if the request failed. error - An error object that indicates why the request failed, or nil if the request was successful. On failed execution, error may contain an NSError with AWSTranscribeErrorDomain domain and the following error code: AWSTranscribeErrorBadRequest, AWSTranscribeErrorLimitExceeded, AWSTranscribeErrorInternalFailure, AWSTranscribeErrorNotFound, AWSTranscribeErrorConflict.

  • Updates an existing custom medical vocabulary with new values. This operation overwrites all existing information with your new values; you cannot append new terms onto an existing custom vocabulary.

    See

    AWSTranscribeUpdateMedicalVocabularyRequest

    See

    AWSTranscribeUpdateMedicalVocabularyResponse

    Declaration

    Objective-C

    - (id)updateMedicalVocabulary:
    (nonnull AWSTranscribeUpdateMedicalVocabularyRequest *)request;

    Swift

    func updateMedicalVocabulary(_ request: AWSTranscribeUpdateMedicalVocabularyRequest) -> Any!

    Parameters

    request

    A container for the necessary parameters to execute the UpdateMedicalVocabulary service method.

    Return Value

    An instance of AWSTask. On successful execution, task.result will contain an instance of AWSTranscribeUpdateMedicalVocabularyResponse. On failed execution, task.error may contain an NSError with AWSTranscribeErrorDomain domain and the following error code: AWSTranscribeErrorBadRequest, AWSTranscribeErrorLimitExceeded, AWSTranscribeErrorInternalFailure, AWSTranscribeErrorNotFound, AWSTranscribeErrorConflict.

  • Updates an existing custom medical vocabulary with new values. This operation overwrites all existing information with your new values; you cannot append new terms onto an existing custom vocabulary.

    See

    AWSTranscribeUpdateMedicalVocabularyRequest

    See

    AWSTranscribeUpdateMedicalVocabularyResponse

    Declaration

    Objective-C

    - (void)updateMedicalVocabulary:
            (nonnull AWSTranscribeUpdateMedicalVocabularyRequest *)request
              completionHandler:
                  (void (^_Nullable)(
                      AWSTranscribeUpdateMedicalVocabularyResponse *_Nullable,
                      NSError *_Nullable))completionHandler;

    Swift

    func updateMedicalVocabulary(_ request: AWSTranscribeUpdateMedicalVocabularyRequest) async throws -> AWSTranscribeUpdateMedicalVocabularyResponse

    Parameters

    request

    A container for the necessary parameters to execute the UpdateMedicalVocabulary service method.
    completionHandler

    The completion handler to call when the load request is complete. response - A response object, or nil if the request failed. error - An error object that indicates why the request failed, or nil if the request was successful. On failed execution, error may contain an NSError with AWSTranscribeErrorDomain domain and the following error code: AWSTranscribeErrorBadRequest, AWSTranscribeErrorLimitExceeded, AWSTranscribeErrorInternalFailure, AWSTranscribeErrorNotFound, AWSTranscribeErrorConflict.

  • Updates an existing custom vocabulary with new values. This operation overwrites all existing information with your new values; you cannot append new terms onto an existing custom vocabulary.

    See

    AWSTranscribeUpdateVocabularyRequest

    See

    AWSTranscribeUpdateVocabularyResponse

    Declaration

    Objective-C

    - (id)updateVocabulary:(nonnull AWSTranscribeUpdateVocabularyRequest *)request;

    Swift

    func updateVocabulary(_ request: AWSTranscribeUpdateVocabularyRequest) -> Any!

    Parameters

    request

    A container for the necessary parameters to execute the UpdateVocabulary service method.

    Return Value

    An instance of AWSTask. On successful execution, task.result will contain an instance of AWSTranscribeUpdateVocabularyResponse. On failed execution, task.error may contain an NSError with AWSTranscribeErrorDomain domain and the following error code: AWSTranscribeErrorBadRequest, AWSTranscribeErrorLimitExceeded, AWSTranscribeErrorInternalFailure, AWSTranscribeErrorNotFound, AWSTranscribeErrorConflict.

  • Updates an existing custom vocabulary with new values. This operation overwrites all existing information with your new values; you cannot append new terms onto an existing custom vocabulary.

    See

    AWSTranscribeUpdateVocabularyRequest

    See

    AWSTranscribeUpdateVocabularyResponse

    Declaration

    Objective-C

    - (void)updateVocabulary:(nonnull AWSTranscribeUpdateVocabularyRequest *)request
       completionHandler:
           (void (^_Nullable)(AWSTranscribeUpdateVocabularyResponse *_Nullable,
                              NSError *_Nullable))completionHandler;

    Swift

    func updateVocabulary(_ request: AWSTranscribeUpdateVocabularyRequest) async throws -> AWSTranscribeUpdateVocabularyResponse

    Parameters

    request

    A container for the necessary parameters to execute the UpdateVocabulary service method.
    completionHandler

    The completion handler to call when the load request is complete. response - A response object, or nil if the request failed. error - An error object that indicates why the request failed, or nil if the request was successful. On failed execution, error may contain an NSError with AWSTranscribeErrorDomain domain and the following error code: AWSTranscribeErrorBadRequest, AWSTranscribeErrorLimitExceeded, AWSTranscribeErrorInternalFailure, AWSTranscribeErrorNotFound, AWSTranscribeErrorConflict.

  • Updates an existing custom vocabulary filter with a new list of words. The new list you provide overwrites all previous entries; you cannot append new terms onto an existing custom vocabulary filter.

    See

    AWSTranscribeUpdateVocabularyFilterRequest

    See

    AWSTranscribeUpdateVocabularyFilterResponse

    Declaration

    Objective-C

    - (id)updateVocabularyFilter:
    (nonnull AWSTranscribeUpdateVocabularyFilterRequest *)request;

    Swift

    func updateVocabularyFilter(_ request: AWSTranscribeUpdateVocabularyFilterRequest) -> Any!

    Parameters

    request

    A container for the necessary parameters to execute the UpdateVocabularyFilter service method.

    Return Value

    An instance of AWSTask. On successful execution, task.result will contain an instance of AWSTranscribeUpdateVocabularyFilterResponse. On failed execution, task.error may contain an NSError with AWSTranscribeErrorDomain domain and the following error code: AWSTranscribeErrorBadRequest, AWSTranscribeErrorLimitExceeded, AWSTranscribeErrorInternalFailure, AWSTranscribeErrorNotFound.

  • Updates an existing custom vocabulary filter with a new list of words. The new list you provide overwrites all previous entries; you cannot append new terms onto an existing custom vocabulary filter.

    See

    AWSTranscribeUpdateVocabularyFilterRequest

    See

    AWSTranscribeUpdateVocabularyFilterResponse

    Declaration

    Objective-C

    - (void)updateVocabularyFilter:
            (nonnull AWSTranscribeUpdateVocabularyFilterRequest *)request
             completionHandler:
                 (void (^_Nullable)(
                     AWSTranscribeUpdateVocabularyFilterResponse *_Nullable,
                     NSError *_Nullable))completionHandler;

    Swift

    func updateVocabularyFilter(_ request: AWSTranscribeUpdateVocabularyFilterRequest) async throws -> AWSTranscribeUpdateVocabularyFilterResponse

    Parameters

    request

    A container for the necessary parameters to execute the UpdateVocabularyFilter service method.
    completionHandler

    The completion handler to call when the load request is complete. response - A response object, or nil if the request failed. error - An error object that indicates why the request failed, or nil if the request was successful. On failed execution, error may contain an NSError with AWSTranscribeErrorDomain domain and the following error code: AWSTranscribeErrorBadRequest, AWSTranscribeErrorLimitExceeded, AWSTranscribeErrorInternalFailure, AWSTranscribeErrorNotFound.