Class: AWS.TranscribeService

var params = {
  BaseModelName: NarrowBand | WideBand, /* required */
  InputDataConfig: { /* required */
    DataAccessRoleArn: 'STRING_VALUE', /* required */
    S3Uri: 'STRING_VALUE', /* required */
    TuningDataS3Uri: 'STRING_VALUE'
  },
  LanguageCode: en-US | hi-IN | es-US | en-GB | en-AU | de-DE | ja-JP, /* required */
  ModelName: 'STRING_VALUE', /* required */
  Tags: [
    {
      Key: 'STRING_VALUE', /* required */
      Value: 'STRING_VALUE' /* required */
    },
    /* more items */
  ]
};
transcribeservice.createLanguageModel(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • LanguageCode — (String)

    The language code that represents the language of your model. Each custom language model must contain terms in only one language, and the language you select for your custom language model must match the language of your training and tuning data.

    For a list of supported languages and their associated language codes, refer to the Supported languages table. Note that US English (en-US) is the only language supported with Amazon Transcribe Medical.

    A custom language model can only be used to transcribe files in the same language as the model. For example, if you create a custom language model using US English (en-US), you can only apply this model to files that contain English audio.

    Possible values include:
    • "en-US"
    • "hi-IN"
    • "es-US"
    • "en-GB"
    • "en-AU"
    • "de-DE"
    • "ja-JP"
  • BaseModelName — (String)

    The Amazon Transcribe standard language model, or base model, used to create your custom language model. Amazon Transcribe offers two options for base models: Wideband and Narrowband.

    If the audio you want to transcribe has a sample rate of 16,000 Hz or greater, choose WideBand. To transcribe audio with a sample rate less than 16,000 Hz, choose NarrowBand.

    Possible values include:
    • "NarrowBand"
    • "WideBand"
  • ModelName — (String)

    A unique name, chosen by you, for your custom language model.

    This name is case sensitive, cannot contain spaces, and must be unique within an Amazon Web Services account. If you try to create a new custom language model with the same name as an existing custom language model, you get a ConflictException error.

  • InputDataConfig — (map)

    Contains the Amazon S3 location of the training data you want to use to create a new custom language model, and permissions to access this location.

    When using InputDataConfig, you must include these sub-parameters: S3Uri, which is the Amazon S3 location of your training data, and DataAccessRoleArn, which is the Amazon Resource Name (ARN) of the role that has permission to access your specified Amazon S3 location. You can optionally include TuningDataS3Uri, which is the Amazon S3 location of your tuning data. If you specify different Amazon S3 locations for training and tuning data, the ARN you use must have permissions to access both locations.

    • S3Uri — required — (String)

      The Amazon S3 location (URI) of the text files you want to use to train your custom language model.

      Here's an example URI path: s3://DOC-EXAMPLE-BUCKET/my-model-training-data/

    • TuningDataS3Uri — (String)

      The Amazon S3 location (URI) of the text files you want to use to tune your custom language model.

      Here's an example URI path: s3://DOC-EXAMPLE-BUCKET/my-model-tuning-data/

    • DataAccessRoleArn — required — (String)

      The Amazon Resource Name (ARN) of an IAM role that has permissions to access the Amazon S3 bucket that contains your input files. If the role that you specify doesn’t have the appropriate permissions to access the specified Amazon S3 location, your request fails.

      IAM role ARNs have the format arn:partition:iam::account:role/role-name-with-path. For example: arn:aws:iam::111122223333:role/Admin.

      For more information, see IAM ARNs.

  • Tags — (Array<map>)

    Adds one or more custom tags, each in the form of a key:value pair, to a new custom language model at the time you create this new model.

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

    • Key — required — (String)

      The first part of a key:value pair that forms a tag associated with a given resource. For example, in the tag Department:Sales, the key is 'Department'.

    • Value — required — (String)

      The second part of a key:value pair that forms a tag associated with a given resource. For example, in the tag Department:Sales, the value is 'Sales'.

      Note that you can set the value of a tag to an empty string, but you can't set the value of a tag to null. Omitting the tag value is the same as using an empty string.

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

    • LanguageCode — (String)

      The language code you selected for your custom language model.

      Possible values include:
      • "en-US"
      • "hi-IN"
      • "es-US"
      • "en-GB"
      • "en-AU"
      • "de-DE"
      • "ja-JP"
    • BaseModelName — (String)

      The Amazon Transcribe standard language model, or base model, you specified when creating your custom language model.

      Possible values include:
      • "NarrowBand"
      • "WideBand"
    • ModelName — (String)

      The name of your custom language model.

    • InputDataConfig — (map)

      Lists your data access role ARN (Amazon Resource Name) and the Amazon S3 locations you provided for your training (S3Uri) and tuning (TuningDataS3Uri) data.

      • S3Uri — required — (String)

        The Amazon S3 location (URI) of the text files you want to use to train your custom language model.

        Here's an example URI path: s3://DOC-EXAMPLE-BUCKET/my-model-training-data/

      • TuningDataS3Uri — (String)

        The Amazon S3 location (URI) of the text files you want to use to tune your custom language model.

        Here's an example URI path: s3://DOC-EXAMPLE-BUCKET/my-model-tuning-data/

      • DataAccessRoleArn — required — (String)

        The Amazon Resource Name (ARN) of an IAM role that has permissions to access the Amazon S3 bucket that contains your input files. If the role that you specify doesn’t have the appropriate permissions to access the specified Amazon S3 location, your request fails.

        IAM role ARNs have the format arn:partition:iam::account:role/role-name-with-path. For example: arn:aws:iam::111122223333:role/Admin.

        For more information, see IAM ARNs.

    • ModelStatus — (String)

      The status of your custom language model. When the status displays as COMPLETED, your model is ready to use.

      Possible values include:
      • "IN_PROGRESS"
      • "FAILED"
      • "COMPLETED"

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  LanguageCode: af-ZA | ar-AE | ar-SA | da-DK | de-CH | de-DE | en-AB | en-AU | en-GB | en-IE | en-IN | en-US | en-WL | es-ES | es-US | fa-IR | fr-CA | fr-FR | he-IL | hi-IN | id-ID | it-IT | ja-JP | ko-KR | ms-MY | nl-NL | pt-BR | pt-PT | ru-RU | ta-IN | te-IN | tr-TR | zh-CN | zh-TW | th-TH | en-ZA | en-NZ | vi-VN | sv-SE | ab-GE | ast-ES | az-AZ | ba-RU | be-BY | bg-BG | bn-IN | bs-BA | ca-ES | ckb-IQ | ckb-IR | cs-CZ | cy-WL | el-GR | et-ET | eu-ES | fi-FI | gl-ES | gu-IN | ha-NG | hr-HR | hu-HU | hy-AM | is-IS | ka-GE | kab-DZ | kk-KZ | kn-IN | ky-KG | lg-IN | lt-LT | lv-LV | mhr-RU | mi-NZ | mk-MK | ml-IN | mn-MN | mr-IN | mt-MT | no-NO | or-IN | pa-IN | pl-PL | ps-AF | ro-RO | rw-RW | si-LK | sk-SK | sl-SI | so-SO | sr-RS | su-ID | sw-BI | sw-KE | sw-RW | sw-TZ | sw-UG | tl-PH | tt-RU | ug-CN | uk-UA | uz-UZ | wo-SN | zu-ZA, /* required */
  VocabularyFileUri: 'STRING_VALUE', /* required */
  VocabularyName: 'STRING_VALUE', /* required */
  Tags: [
    {
      Key: 'STRING_VALUE', /* required */
      Value: 'STRING_VALUE' /* required */
    },
    /* more items */
  ]
};
transcribeservice.createMedicalVocabulary(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • VocabularyName — (String)

    A unique name, chosen by you, for your new custom medical vocabulary.

    This name is case sensitive, cannot contain spaces, and must be unique within an Amazon Web Services account. If you try to create a new custom medical vocabulary with the same name as an existing custom medical vocabulary, you get a ConflictException error.

  • LanguageCode — (String)

    The language code that represents the language of the entries in your custom vocabulary. US English (en-US) is the only language supported with Amazon Transcribe Medical.

    Possible values include:
    • "af-ZA"
    • "ar-AE"
    • "ar-SA"
    • "da-DK"
    • "de-CH"
    • "de-DE"
    • "en-AB"
    • "en-AU"
    • "en-GB"
    • "en-IE"
    • "en-IN"
    • "en-US"
    • "en-WL"
    • "es-ES"
    • "es-US"
    • "fa-IR"
    • "fr-CA"
    • "fr-FR"
    • "he-IL"
    • "hi-IN"
    • "id-ID"
    • "it-IT"
    • "ja-JP"
    • "ko-KR"
    • "ms-MY"
    • "nl-NL"
    • "pt-BR"
    • "pt-PT"
    • "ru-RU"
    • "ta-IN"
    • "te-IN"
    • "tr-TR"
    • "zh-CN"
    • "zh-TW"
    • "th-TH"
    • "en-ZA"
    • "en-NZ"
    • "vi-VN"
    • "sv-SE"
    • "ab-GE"
    • "ast-ES"
    • "az-AZ"
    • "ba-RU"
    • "be-BY"
    • "bg-BG"
    • "bn-IN"
    • "bs-BA"
    • "ca-ES"
    • "ckb-IQ"
    • "ckb-IR"
    • "cs-CZ"
    • "cy-WL"
    • "el-GR"
    • "et-ET"
    • "eu-ES"
    • "fi-FI"
    • "gl-ES"
    • "gu-IN"
    • "ha-NG"
    • "hr-HR"
    • "hu-HU"
    • "hy-AM"
    • "is-IS"
    • "ka-GE"
    • "kab-DZ"
    • "kk-KZ"
    • "kn-IN"
    • "ky-KG"
    • "lg-IN"
    • "lt-LT"
    • "lv-LV"
    • "mhr-RU"
    • "mi-NZ"
    • "mk-MK"
    • "ml-IN"
    • "mn-MN"
    • "mr-IN"
    • "mt-MT"
    • "no-NO"
    • "or-IN"
    • "pa-IN"
    • "pl-PL"
    • "ps-AF"
    • "ro-RO"
    • "rw-RW"
    • "si-LK"
    • "sk-SK"
    • "sl-SI"
    • "so-SO"
    • "sr-RS"
    • "su-ID"
    • "sw-BI"
    • "sw-KE"
    • "sw-RW"
    • "sw-TZ"
    • "sw-UG"
    • "tl-PH"
    • "tt-RU"
    • "ug-CN"
    • "uk-UA"
    • "uz-UZ"
    • "wo-SN"
    • "zu-ZA"
  • VocabularyFileUri — (String)

    The Amazon S3 location (URI) of the text file that contains your custom medical vocabulary. The URI must be in the same Amazon Web Services Region as the resource you're calling.

    Here's an example URI path: s3://DOC-EXAMPLE-BUCKET/my-vocab-file.txt

  • Tags — (Array<map>)

    Adds one or more custom tags, each in the form of a key:value pair, to a new custom medical vocabulary at the time you create this new custom vocabulary.

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

    • Key — required — (String)

      The first part of a key:value pair that forms a tag associated with a given resource. For example, in the tag Department:Sales, the key is 'Department'.

    • Value — required — (String)

      The second part of a key:value pair that forms a tag associated with a given resource. For example, in the tag Department:Sales, the value is 'Sales'.

      Note that you can set the value of a tag to an empty string, but you can't set the value of a tag to null. Omitting the tag value is the same as using an empty string.

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

    • VocabularyName — (String)

      The name you chose for your custom medical vocabulary.

    • LanguageCode — (String)

      The language code you selected for your custom medical vocabulary. US English (en-US) is the only language supported with Amazon Transcribe Medical.

      Possible values include:
      • "af-ZA"
      • "ar-AE"
      • "ar-SA"
      • "da-DK"
      • "de-CH"
      • "de-DE"
      • "en-AB"
      • "en-AU"
      • "en-GB"
      • "en-IE"
      • "en-IN"
      • "en-US"
      • "en-WL"
      • "es-ES"
      • "es-US"
      • "fa-IR"
      • "fr-CA"
      • "fr-FR"
      • "he-IL"
      • "hi-IN"
      • "id-ID"
      • "it-IT"
      • "ja-JP"
      • "ko-KR"
      • "ms-MY"
      • "nl-NL"
      • "pt-BR"
      • "pt-PT"
      • "ru-RU"
      • "ta-IN"
      • "te-IN"
      • "tr-TR"
      • "zh-CN"
      • "zh-TW"
      • "th-TH"
      • "en-ZA"
      • "en-NZ"
      • "vi-VN"
      • "sv-SE"
      • "ab-GE"
      • "ast-ES"
      • "az-AZ"
      • "ba-RU"
      • "be-BY"
      • "bg-BG"
      • "bn-IN"
      • "bs-BA"
      • "ca-ES"
      • "ckb-IQ"
      • "ckb-IR"
      • "cs-CZ"
      • "cy-WL"
      • "el-GR"
      • "et-ET"
      • "eu-ES"
      • "fi-FI"
      • "gl-ES"
      • "gu-IN"
      • "ha-NG"
      • "hr-HR"
      • "hu-HU"
      • "hy-AM"
      • "is-IS"
      • "ka-GE"
      • "kab-DZ"
      • "kk-KZ"
      • "kn-IN"
      • "ky-KG"
      • "lg-IN"
      • "lt-LT"
      • "lv-LV"
      • "mhr-RU"
      • "mi-NZ"
      • "mk-MK"
      • "ml-IN"
      • "mn-MN"
      • "mr-IN"
      • "mt-MT"
      • "no-NO"
      • "or-IN"
      • "pa-IN"
      • "pl-PL"
      • "ps-AF"
      • "ro-RO"
      • "rw-RW"
      • "si-LK"
      • "sk-SK"
      • "sl-SI"
      • "so-SO"
      • "sr-RS"
      • "su-ID"
      • "sw-BI"
      • "sw-KE"
      • "sw-RW"
      • "sw-TZ"
      • "sw-UG"
      • "tl-PH"
      • "tt-RU"
      • "ug-CN"
      • "uk-UA"
      • "uz-UZ"
      • "wo-SN"
      • "zu-ZA"
    • VocabularyState — (String)

      The processing state of your custom medical vocabulary. If the state is READY, you can use the custom vocabulary in a StartMedicalTranscriptionJob request.

      Possible values include:
      • "PENDING"
      • "READY"
      • "FAILED"
    • LastModifiedTime — (Date)

      The date and time you created your custom medical vocabulary.

      Timestamps are in the format YYYY-MM-DD'T'HH:MM:SS.SSSSSS-UTC. For example, 2022-05-04T12:32:58.761000-07:00 represents 12:32 PM UTC-7 on May 4, 2022.

    • FailureReason — (String)

      If VocabularyState is FAILED, FailureReason contains information about why the medical transcription job request failed. See also: Common Errors.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  LanguageCode: af-ZA | ar-AE | ar-SA | da-DK | de-CH | de-DE | en-AB | en-AU | en-GB | en-IE | en-IN | en-US | en-WL | es-ES | es-US | fa-IR | fr-CA | fr-FR | he-IL | hi-IN | id-ID | it-IT | ja-JP | ko-KR | ms-MY | nl-NL | pt-BR | pt-PT | ru-RU | ta-IN | te-IN | tr-TR | zh-CN | zh-TW | th-TH | en-ZA | en-NZ | vi-VN | sv-SE | ab-GE | ast-ES | az-AZ | ba-RU | be-BY | bg-BG | bn-IN | bs-BA | ca-ES | ckb-IQ | ckb-IR | cs-CZ | cy-WL | el-GR | et-ET | eu-ES | fi-FI | gl-ES | gu-IN | ha-NG | hr-HR | hu-HU | hy-AM | is-IS | ka-GE | kab-DZ | kk-KZ | kn-IN | ky-KG | lg-IN | lt-LT | lv-LV | mhr-RU | mi-NZ | mk-MK | ml-IN | mn-MN | mr-IN | mt-MT | no-NO | or-IN | pa-IN | pl-PL | ps-AF | ro-RO | rw-RW | si-LK | sk-SK | sl-SI | so-SO | sr-RS | su-ID | sw-BI | sw-KE | sw-RW | sw-TZ | sw-UG | tl-PH | tt-RU | ug-CN | uk-UA | uz-UZ | wo-SN | zu-ZA, /* required */
  VocabularyName: 'STRING_VALUE', /* required */
  DataAccessRoleArn: 'STRING_VALUE',
  Phrases: [
    'STRING_VALUE',
    /* more items */
  ],
  Tags: [
    {
      Key: 'STRING_VALUE', /* required */
      Value: 'STRING_VALUE' /* required */
    },
    /* more items */
  ],
  VocabularyFileUri: 'STRING_VALUE'
};
transcribeservice.createVocabulary(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • VocabularyName — (String)

    A unique name, chosen by you, for your new custom vocabulary.

    This name is case sensitive, cannot contain spaces, and must be unique within an Amazon Web Services account. If you try to create a new custom vocabulary with the same name as an existing custom vocabulary, you get a ConflictException error.

  • LanguageCode — (String)

    The language code that represents the language of the entries in your custom vocabulary. Each custom vocabulary must contain terms in only one language.

    A custom vocabulary can only be used to transcribe files in the same language as the custom vocabulary. For example, if you create a custom vocabulary using US English (en-US), you can only apply this custom vocabulary to files that contain English audio.

    For a list of supported languages and their associated language codes, refer to the Supported languages table.

    Possible values include:
    • "af-ZA"
    • "ar-AE"
    • "ar-SA"
    • "da-DK"
    • "de-CH"
    • "de-DE"
    • "en-AB"
    • "en-AU"
    • "en-GB"
    • "en-IE"
    • "en-IN"
    • "en-US"
    • "en-WL"
    • "es-ES"
    • "es-US"
    • "fa-IR"
    • "fr-CA"
    • "fr-FR"
    • "he-IL"
    • "hi-IN"
    • "id-ID"
    • "it-IT"
    • "ja-JP"
    • "ko-KR"
    • "ms-MY"
    • "nl-NL"
    • "pt-BR"
    • "pt-PT"
    • "ru-RU"
    • "ta-IN"
    • "te-IN"
    • "tr-TR"
    • "zh-CN"
    • "zh-TW"
    • "th-TH"
    • "en-ZA"
    • "en-NZ"
    • "vi-VN"
    • "sv-SE"
    • "ab-GE"
    • "ast-ES"
    • "az-AZ"
    • "ba-RU"
    • "be-BY"
    • "bg-BG"
    • "bn-IN"
    • "bs-BA"
    • "ca-ES"
    • "ckb-IQ"
    • "ckb-IR"
    • "cs-CZ"
    • "cy-WL"
    • "el-GR"
    • "et-ET"
    • "eu-ES"
    • "fi-FI"
    • "gl-ES"
    • "gu-IN"
    • "ha-NG"
    • "hr-HR"
    • "hu-HU"
    • "hy-AM"
    • "is-IS"
    • "ka-GE"
    • "kab-DZ"
    • "kk-KZ"
    • "kn-IN"
    • "ky-KG"
    • "lg-IN"
    • "lt-LT"
    • "lv-LV"
    • "mhr-RU"
    • "mi-NZ"
    • "mk-MK"
    • "ml-IN"
    • "mn-MN"
    • "mr-IN"
    • "mt-MT"
    • "no-NO"
    • "or-IN"
    • "pa-IN"
    • "pl-PL"
    • "ps-AF"
    • "ro-RO"
    • "rw-RW"
    • "si-LK"
    • "sk-SK"
    • "sl-SI"
    • "so-SO"
    • "sr-RS"
    • "su-ID"
    • "sw-BI"
    • "sw-KE"
    • "sw-RW"
    • "sw-TZ"
    • "sw-UG"
    • "tl-PH"
    • "tt-RU"
    • "ug-CN"
    • "uk-UA"
    • "uz-UZ"
    • "wo-SN"
    • "zu-ZA"
  • Phrases — (Array<String>)

    Use this parameter if you want to create your custom vocabulary by including all desired terms, as comma-separated values, within your request. The other option for creating your custom vocabulary is to save your entries in a text file and upload them to an Amazon S3 bucket, then specify the location of your file using the VocabularyFileUri parameter.

    Note that if you include Phrases in your request, you cannot use VocabularyFileUri; you must choose one or the other.

    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.

  • VocabularyFileUri — (String)

    The Amazon S3 location of the text file that contains your custom vocabulary. The URI must be located in the same Amazon Web Services Region as the resource you're calling.

    Here's an example URI path: s3://DOC-EXAMPLE-BUCKET/my-vocab-file.txt

    Note that if you include VocabularyFileUri in your request, you cannot use the Phrases flag; you must choose one or the other.

  • Tags — (Array<map>)

    Adds one or more custom tags, each in the form of a key:value pair, to a new custom vocabulary at the time you create this new custom vocabulary.

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

    • Key — required — (String)

      The first part of a key:value pair that forms a tag associated with a given resource. For example, in the tag Department:Sales, the key is 'Department'.

    • Value — required — (String)

      The second part of a key:value pair that forms a tag associated with a given resource. For example, in the tag Department:Sales, the value is 'Sales'.

      Note that you can set the value of a tag to an empty string, but you can't set the value of a tag to null. Omitting the tag value is the same as using an empty string.

  • DataAccessRoleArn — (String)

    The Amazon Resource Name (ARN) of an IAM role that has permissions to access the Amazon S3 bucket that contains your input files (in this case, your custom vocabulary). If the role that you specify doesn’t have the appropriate permissions to access the specified Amazon S3 location, your request fails.

    IAM role ARNs have the format arn:partition:iam::account:role/role-name-with-path. For example: arn:aws:iam::111122223333:role/Admin.

    For more information, see IAM ARNs.

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

    • VocabularyName — (String)

      The name you chose for your custom vocabulary.

    • LanguageCode — (String)

      The language code you selected for your custom vocabulary.

      Possible values include:
      • "af-ZA"
      • "ar-AE"
      • "ar-SA"
      • "da-DK"
      • "de-CH"
      • "de-DE"
      • "en-AB"
      • "en-AU"
      • "en-GB"
      • "en-IE"
      • "en-IN"
      • "en-US"
      • "en-WL"
      • "es-ES"
      • "es-US"
      • "fa-IR"
      • "fr-CA"
      • "fr-FR"
      • "he-IL"
      • "hi-IN"
      • "id-ID"
      • "it-IT"
      • "ja-JP"
      • "ko-KR"
      • "ms-MY"
      • "nl-NL"
      • "pt-BR"
      • "pt-PT"
      • "ru-RU"
      • "ta-IN"
      • "te-IN"
      • "tr-TR"
      • "zh-CN"
      • "zh-TW"
      • "th-TH"
      • "en-ZA"
      • "en-NZ"
      • "vi-VN"
      • "sv-SE"
      • "ab-GE"
      • "ast-ES"
      • "az-AZ"
      • "ba-RU"
      • "be-BY"
      • "bg-BG"
      • "bn-IN"
      • "bs-BA"
      • "ca-ES"
      • "ckb-IQ"
      • "ckb-IR"
      • "cs-CZ"
      • "cy-WL"
      • "el-GR"
      • "et-ET"
      • "eu-ES"
      • "fi-FI"
      • "gl-ES"
      • "gu-IN"
      • "ha-NG"
      • "hr-HR"
      • "hu-HU"
      • "hy-AM"
      • "is-IS"
      • "ka-GE"
      • "kab-DZ"
      • "kk-KZ"
      • "kn-IN"
      • "ky-KG"
      • "lg-IN"
      • "lt-LT"
      • "lv-LV"
      • "mhr-RU"
      • "mi-NZ"
      • "mk-MK"
      • "ml-IN"
      • "mn-MN"
      • "mr-IN"
      • "mt-MT"
      • "no-NO"
      • "or-IN"
      • "pa-IN"
      • "pl-PL"
      • "ps-AF"
      • "ro-RO"
      • "rw-RW"
      • "si-LK"
      • "sk-SK"
      • "sl-SI"
      • "so-SO"
      • "sr-RS"
      • "su-ID"
      • "sw-BI"
      • "sw-KE"
      • "sw-RW"
      • "sw-TZ"
      • "sw-UG"
      • "tl-PH"
      • "tt-RU"
      • "ug-CN"
      • "uk-UA"
      • "uz-UZ"
      • "wo-SN"
      • "zu-ZA"
    • VocabularyState — (String)

      The processing state of your custom vocabulary. If the state is READY, you can use the custom vocabulary in a StartTranscriptionJob request.

      Possible values include:
      • "PENDING"
      • "READY"
      • "FAILED"
    • LastModifiedTime — (Date)

      The date and time you created your custom vocabulary.

      Timestamps are in the format YYYY-MM-DD'T'HH:MM:SS.SSSSSS-UTC. For example, 2022-05-04T12:32:58.761000-07:00 represents 12:32 PM UTC-7 on May 4, 2022.

    • FailureReason — (String)

      If VocabularyState is FAILED, FailureReason contains information about why the custom vocabulary request failed. See also: Common Errors.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  LanguageCode: af-ZA | ar-AE | ar-SA | da-DK | de-CH | de-DE | en-AB | en-AU | en-GB | en-IE | en-IN | en-US | en-WL | es-ES | es-US | fa-IR | fr-CA | fr-FR | he-IL | hi-IN | id-ID | it-IT | ja-JP | ko-KR | ms-MY | nl-NL | pt-BR | pt-PT | ru-RU | ta-IN | te-IN | tr-TR | zh-CN | zh-TW | th-TH | en-ZA | en-NZ | vi-VN | sv-SE | ab-GE | ast-ES | az-AZ | ba-RU | be-BY | bg-BG | bn-IN | bs-BA | ca-ES | ckb-IQ | ckb-IR | cs-CZ | cy-WL | el-GR | et-ET | eu-ES | fi-FI | gl-ES | gu-IN | ha-NG | hr-HR | hu-HU | hy-AM | is-IS | ka-GE | kab-DZ | kk-KZ | kn-IN | ky-KG | lg-IN | lt-LT | lv-LV | mhr-RU | mi-NZ | mk-MK | ml-IN | mn-MN | mr-IN | mt-MT | no-NO | or-IN | pa-IN | pl-PL | ps-AF | ro-RO | rw-RW | si-LK | sk-SK | sl-SI | so-SO | sr-RS | su-ID | sw-BI | sw-KE | sw-RW | sw-TZ | sw-UG | tl-PH | tt-RU | ug-CN | uk-UA | uz-UZ | wo-SN | zu-ZA, /* required */
  VocabularyFilterName: 'STRING_VALUE', /* required */
  DataAccessRoleArn: 'STRING_VALUE',
  Tags: [
    {
      Key: 'STRING_VALUE', /* required */
      Value: 'STRING_VALUE' /* required */
    },
    /* more items */
  ],
  VocabularyFilterFileUri: 'STRING_VALUE',
  Words: [
    'STRING_VALUE',
    /* more items */
  ]
};
transcribeservice.createVocabularyFilter(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • VocabularyFilterName — (String)

    A unique name, chosen by you, for your new custom vocabulary filter.

    This name is case sensitive, cannot contain spaces, and must be unique within an Amazon Web Services account. If you try to create a new custom vocabulary filter with the same name as an existing custom vocabulary filter, you get a ConflictException error.

  • LanguageCode — (String)

    The language code that represents the language of the entries in your vocabulary filter. Each custom vocabulary filter must contain terms in only one language.

    A custom vocabulary filter can only be used to transcribe files in the same language as the filter. For example, if you create a custom vocabulary filter using US English (en-US), you can only apply this filter to files that contain English audio.

    For a list of supported languages and their associated language codes, refer to the Supported languages table.

    Possible values include:
    • "af-ZA"
    • "ar-AE"
    • "ar-SA"
    • "da-DK"
    • "de-CH"
    • "de-DE"
    • "en-AB"
    • "en-AU"
    • "en-GB"
    • "en-IE"
    • "en-IN"
    • "en-US"
    • "en-WL"
    • "es-ES"
    • "es-US"
    • "fa-IR"
    • "fr-CA"
    • "fr-FR"
    • "he-IL"
    • "hi-IN"
    • "id-ID"
    • "it-IT"
    • "ja-JP"
    • "ko-KR"
    • "ms-MY"
    • "nl-NL"
    • "pt-BR"
    • "pt-PT"
    • "ru-RU"
    • "ta-IN"
    • "te-IN"
    • "tr-TR"
    • "zh-CN"
    • "zh-TW"
    • "th-TH"
    • "en-ZA"
    • "en-NZ"
    • "vi-VN"
    • "sv-SE"
    • "ab-GE"
    • "ast-ES"
    • "az-AZ"
    • "ba-RU"
    • "be-BY"
    • "bg-BG"
    • "bn-IN"
    • "bs-BA"
    • "ca-ES"
    • "ckb-IQ"
    • "ckb-IR"
    • "cs-CZ"
    • "cy-WL"
    • "el-GR"
    • "et-ET"
    • "eu-ES"
    • "fi-FI"
    • "gl-ES"
    • "gu-IN"
    • "ha-NG"
    • "hr-HR"
    • "hu-HU"
    • "hy-AM"
    • "is-IS"
    • "ka-GE"
    • "kab-DZ"
    • "kk-KZ"
    • "kn-IN"
    • "ky-KG"
    • "lg-IN"
    • "lt-LT"
    • "lv-LV"
    • "mhr-RU"
    • "mi-NZ"
    • "mk-MK"
    • "ml-IN"
    • "mn-MN"
    • "mr-IN"
    • "mt-MT"
    • "no-NO"
    • "or-IN"
    • "pa-IN"
    • "pl-PL"
    • "ps-AF"
    • "ro-RO"
    • "rw-RW"
    • "si-LK"
    • "sk-SK"
    • "sl-SI"
    • "so-SO"
    • "sr-RS"
    • "su-ID"
    • "sw-BI"
    • "sw-KE"
    • "sw-RW"
    • "sw-TZ"
    • "sw-UG"
    • "tl-PH"
    • "tt-RU"
    • "ug-CN"
    • "uk-UA"
    • "uz-UZ"
    • "wo-SN"
    • "zu-ZA"
  • Words — (Array<String>)

    Use this parameter if you want to create your custom vocabulary filter by including all desired terms, as comma-separated values, within your request. The other option for creating your vocabulary filter is to save your entries in a text file and upload them to an Amazon S3 bucket, then specify the location of your file using the VocabularyFilterFileUri parameter.

    Note that if you include Words in your request, you cannot use VocabularyFilterFileUri; you must choose one or the other.

    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.

  • VocabularyFilterFileUri — (String)

    The Amazon S3 location of the text file that contains your custom vocabulary filter terms. The URI must be located in the same Amazon Web Services Region as the resource you're calling.

    Here's an example URI path: s3://DOC-EXAMPLE-BUCKET/my-vocab-filter-file.txt

    Note that if you include VocabularyFilterFileUri in your request, you cannot use Words; you must choose one or the other.

  • Tags — (Array<map>)

    Adds one or more custom tags, each in the form of a key:value pair, to a new custom vocabulary filter at the time you create this new vocabulary filter.

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

    • Key — required — (String)

      The first part of a key:value pair that forms a tag associated with a given resource. For example, in the tag Department:Sales, the key is 'Department'.

    • Value — required — (String)

      The second part of a key:value pair that forms a tag associated with a given resource. For example, in the tag Department:Sales, the value is 'Sales'.

      Note that you can set the value of a tag to an empty string, but you can't set the value of a tag to null. Omitting the tag value is the same as using an empty string.

  • DataAccessRoleArn — (String)

    The Amazon Resource Name (ARN) of an IAM role that has permissions to access the Amazon S3 bucket that contains your input files (in this case, your custom vocabulary filter). If the role that you specify doesn’t have the appropriate permissions to access the specified Amazon S3 location, your request fails.

    IAM role ARNs have the format arn:partition:iam::account:role/role-name-with-path. For example: arn:aws:iam::111122223333:role/Admin.

    For more information, see IAM ARNs.

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

    • VocabularyFilterName — (String)

      The name you chose for your custom vocabulary filter.

    • LanguageCode — (String)

      The language code you selected for your custom vocabulary filter.

      Possible values include:
      • "af-ZA"
      • "ar-AE"
      • "ar-SA"
      • "da-DK"
      • "de-CH"
      • "de-DE"
      • "en-AB"
      • "en-AU"
      • "en-GB"
      • "en-IE"
      • "en-IN"
      • "en-US"
      • "en-WL"
      • "es-ES"
      • "es-US"
      • "fa-IR"
      • "fr-CA"
      • "fr-FR"
      • "he-IL"
      • "hi-IN"
      • "id-ID"
      • "it-IT"
      • "ja-JP"
      • "ko-KR"
      • "ms-MY"
      • "nl-NL"
      • "pt-BR"
      • "pt-PT"
      • "ru-RU"
      • "ta-IN"
      • "te-IN"
      • "tr-TR"
      • "zh-CN"
      • "zh-TW"
      • "th-TH"
      • "en-ZA"
      • "en-NZ"
      • "vi-VN"
      • "sv-SE"
      • "ab-GE"
      • "ast-ES"
      • "az-AZ"
      • "ba-RU"
      • "be-BY"
      • "bg-BG"
      • "bn-IN"
      • "bs-BA"
      • "ca-ES"
      • "ckb-IQ"
      • "ckb-IR"
      • "cs-CZ"
      • "cy-WL"
      • "el-GR"
      • "et-ET"
      • "eu-ES"
      • "fi-FI"
      • "gl-ES"
      • "gu-IN"
      • "ha-NG"
      • "hr-HR"
      • "hu-HU"
      • "hy-AM"
      • "is-IS"
      • "ka-GE"
      • "kab-DZ"
      • "kk-KZ"
      • "kn-IN"
      • "ky-KG"
      • "lg-IN"
      • "lt-LT"
      • "lv-LV"
      • "mhr-RU"
      • "mi-NZ"
      • "mk-MK"
      • "ml-IN"
      • "mn-MN"
      • "mr-IN"
      • "mt-MT"
      • "no-NO"
      • "or-IN"
      • "pa-IN"
      • "pl-PL"
      • "ps-AF"
      • "ro-RO"
      • "rw-RW"
      • "si-LK"
      • "sk-SK"
      • "sl-SI"
      • "so-SO"
      • "sr-RS"
      • "su-ID"
      • "sw-BI"
      • "sw-KE"
      • "sw-RW"
      • "sw-TZ"
      • "sw-UG"
      • "tl-PH"
      • "tt-RU"
      • "ug-CN"
      • "uk-UA"
      • "uz-UZ"
      • "wo-SN"
      • "zu-ZA"
    • LastModifiedTime — (Date)

      The date and time you created your custom vocabulary filter.

      Timestamps are in the format YYYY-MM-DD'T'HH:MM:SS.SSSSSS-UTC. For example, 2022-05-04T12:32:58.761000-07:00 represents 12:32 PM UTC-7 on May 4, 2022.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  CategoryName: 'STRING_VALUE' /* required */
};
transcribeservice.deleteCallAnalyticsCategory(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • CategoryName — (String)

    The name of the Call Analytics category you want to delete. Category names are case sensitive.

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  CallAnalyticsJobName: 'STRING_VALUE' /* required */
};
transcribeservice.deleteCallAnalyticsJob(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • CallAnalyticsJobName — (String)

    The name of the Call Analytics job you want to delete. Job names are case sensitive.

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  ModelName: 'STRING_VALUE' /* required */
};
transcribeservice.deleteLanguageModel(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • ModelName — (String)

    The name of the custom language model you want to delete. Model names are case sensitive.

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  MedicalScribeJobName: 'STRING_VALUE' /* required */
};
transcribeservice.deleteMedicalScribeJob(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • MedicalScribeJobName — (String)

    The name of the Medical Scribe job you want to delete. Job names are case sensitive.

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  MedicalTranscriptionJobName: 'STRING_VALUE' /* required */
};
transcribeservice.deleteMedicalTranscriptionJob(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • MedicalTranscriptionJobName — (String)

    The name of the medical transcription job you want to delete. Job names are case sensitive.

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  VocabularyName: 'STRING_VALUE' /* required */
};
transcribeservice.deleteMedicalVocabulary(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • VocabularyName — (String)

    The name of the custom medical vocabulary you want to delete. Custom medical vocabulary names are case sensitive.

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  TranscriptionJobName: 'STRING_VALUE' /* required */
};
transcribeservice.deleteTranscriptionJob(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • TranscriptionJobName — (String)

    The name of the transcription job you want to delete. Job names are case sensitive.

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  VocabularyName: 'STRING_VALUE' /* required */
};
transcribeservice.deleteVocabulary(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • VocabularyName — (String)

    The name of the custom vocabulary you want to delete. Custom vocabulary names are case sensitive.

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  VocabularyFilterName: 'STRING_VALUE' /* required */
};
transcribeservice.deleteVocabularyFilter(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • VocabularyFilterName — (String)

    The name of the custom vocabulary filter you want to delete. Custom vocabulary filter names are case sensitive.

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  ModelName: 'STRING_VALUE' /* required */
};
transcribeservice.describeLanguageModel(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • ModelName — (String)

    The name of the custom language model you want information about. Model names are case sensitive.

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

    • LanguageModel — (map)

      Provides information about the specified custom language model.

      This parameter also shows if the base language model 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 this DescribeLanguageModel to help identify the reason for this failure.

      • ModelName — (String)

        A unique name, chosen by you, for your custom language model.

        This name is case sensitive, cannot contain spaces, and must be unique within an Amazon Web Services account.

      • CreateTime — (Date)

        The date and time the specified custom language model was created.

        Timestamps are in the format YYYY-MM-DD'T'HH:MM:SS.SSSSSS-UTC. For example, 2022-05-04T12:32:58.761000-07:00 represents 12:32 PM UTC-7 on May 4, 2022.

      • LastModifiedTime — (Date)

        The date and time the specified custom language model was last modified.

        Timestamps are in the format YYYY-MM-DD'T'HH:MM:SS.SSSSSS-UTC. For example, 2022-05-04T12:32:58.761000-07:00 represents 12:32 PM UTC-7 on May 4, 2022.

      • LanguageCode — (String)

        The language code used to create your custom language model. Each custom language model must contain terms in only one language, and the language you select for your custom language model must match the language of your training and tuning data.

        For a list of supported languages and their associated language codes, refer to the Supported languages table. Note that US English (en-US) is the only language supported with Amazon Transcribe Medical.

        Possible values include:
        • "en-US"
        • "hi-IN"
        • "es-US"
        • "en-GB"
        • "en-AU"
        • "de-DE"
        • "ja-JP"
      • BaseModelName — (String)

        The Amazon Transcribe standard language model, or base model, used to create your custom language model.

        Possible values include:
        • "NarrowBand"
        • "WideBand"
      • ModelStatus — (String)

        The status of the specified custom language model. When the status displays as COMPLETED the model is ready for use.

        Possible values include:
        • "IN_PROGRESS"
        • "FAILED"
        • "COMPLETED"
      • UpgradeAvailability — (Boolean)

        Shows if a more current base model is available for use with the specified custom language model.

        If false, your custom language model is using the most up-to-date base model.

        If true, there is a newer base model available than the one your language model is using.

        Note that to update a base model, you must recreate the custom language model using the new base model. Base model upgrades for existing custom language models are not supported.

      • FailureReason — (String)

        If ModelStatus is FAILED, FailureReason contains information about why the custom language model request failed. See also: Common Errors.

      • InputDataConfig — (map)

        The Amazon S3 location of the input files used to train and tune your custom language model, in addition to the data access role ARN (Amazon Resource Name) that has permissions to access these data.

        • S3Uri — required — (String)

          The Amazon S3 location (URI) of the text files you want to use to train your custom language model.

          Here's an example URI path: s3://DOC-EXAMPLE-BUCKET/my-model-training-data/

        • TuningDataS3Uri — (String)

          The Amazon S3 location (URI) of the text files you want to use to tune your custom language model.

          Here's an example URI path: s3://DOC-EXAMPLE-BUCKET/my-model-tuning-data/

        • DataAccessRoleArn — required — (String)

          The Amazon Resource Name (ARN) of an IAM role that has permissions to access the Amazon S3 bucket that contains your input files. If the role that you specify doesn’t have the appropriate permissions to access the specified Amazon S3 location, your request fails.

          IAM role ARNs have the format arn:partition:iam::account:role/role-name-with-path. For example: arn:aws:iam::111122223333:role/Admin.

          For more information, see IAM ARNs.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  CategoryName: 'STRING_VALUE' /* required */
};
transcribeservice.getCallAnalyticsCategory(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • CategoryName — (String)

    The name of the Call Analytics category you want information about. Category names are case sensitive.

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

    • CategoryProperties — (map)

      Provides you with the properties of the Call Analytics category you specified in your GetCallAnalyticsCategory request.

      • CategoryName — (String)

        The name of the Call Analytics category. Category names are case sensitive and must be unique within an Amazon Web Services account.

      • Rules — (Array<map>)

        The rules used to define a Call Analytics category. Each category can have between 1 and 20 rules.

        • NonTalkTimeFilter — (map)

          Flag the presence or absence of periods of silence in your Call Analytics transcription output. Refer to for more detail.

          • Threshold — (Integer)

            Specify the duration, in milliseconds, of the period of silence that you want to flag. For example, you can flag a silent period that lasts 30,000 milliseconds.

          • AbsoluteTimeRange — (map)

            Makes it possible to specify a time range (in milliseconds) in your audio, during which you want to search for a period of silence. See for more detail.

            • StartTime — (Integer)

              The time, in milliseconds, when Amazon Transcribe starts searching for the specified criteria in your audio. If you include StartTime in your request, you must also include EndTime.

            • EndTime — (Integer)

              The time, in milliseconds, when Amazon Transcribe stops searching for the specified criteria in your audio. If you include EndTime in your request, you must also include StartTime.

            • First — (Integer)

              The time, in milliseconds, from the start of your media file until the specified value. Amazon Transcribe searches for your specified criteria in this time segment.

            • Last — (Integer)

              The time, in milliseconds, from the specified value until the end of your media file. Amazon Transcribe searches for your specified criteria in this time segment.

          • RelativeTimeRange — (map)

            Makes it possible to specify a time range (in percentage) in your media file, during which you want to search for a period of silence. See for more detail.

            • StartPercentage — (Integer)

              The time, in percentage, when Amazon Transcribe starts searching for the specified criteria in your media file. If you include StartPercentage in your request, you must also include EndPercentage.

            • EndPercentage — (Integer)

              The time, in percentage, when Amazon Transcribe stops searching for the specified criteria in your media file. If you include EndPercentage in your request, you must also include StartPercentage.

            • First — (Integer)

              The time, in percentage, from the start of your media file until the specified value. Amazon Transcribe searches for your specified criteria in this time segment.

            • Last — (Integer)

              The time, in percentage, from the specified value until the end of your media file. Amazon Transcribe searches for your specified criteria in this time segment.

          • Negate — (Boolean)

            Set to TRUE to flag periods of speech. Set to FALSE to flag periods of silence

        • InterruptionFilter — (map)

          Flag the presence or absence of interruptions in your Call Analytics transcription output. Refer to for more detail.

          • Threshold — (Integer)

            Specify the duration of the interruptions in milliseconds. For example, you can flag speech that contains more than 10,000 milliseconds of interruptions.

          • ParticipantRole — (String)

            Specify the interrupter that you want to flag. Omitting this parameter is equivalent to specifying both participants.

            Possible values include:
            • "AGENT"
            • "CUSTOMER"
          • AbsoluteTimeRange — (map)

            Makes it possible to specify a time range (in milliseconds) in your audio, during which you want to search for an interruption. See for more detail.

            • StartTime — (Integer)

              The time, in milliseconds, when Amazon Transcribe starts searching for the specified criteria in your audio. If you include StartTime in your request, you must also include EndTime.

            • EndTime — (Integer)

              The time, in milliseconds, when Amazon Transcribe stops searching for the specified criteria in your audio. If you include EndTime in your request, you must also include StartTime.

            • First — (Integer)

              The time, in milliseconds, from the start of your media file until the specified value. Amazon Transcribe searches for your specified criteria in this time segment.

            • Last — (Integer)

              The time, in milliseconds, from the specified value until the end of your media file. Amazon Transcribe searches for your specified criteria in this time segment.

          • RelativeTimeRange — (map)

            Makes it possible to specify a time range (in percentage) in your media file, during which you want to search for an interruption. See for more detail.

            • StartPercentage — (Integer)

              The time, in percentage, when Amazon Transcribe starts searching for the specified criteria in your media file. If you include StartPercentage in your request, you must also include EndPercentage.

            • EndPercentage — (Integer)

              The time, in percentage, when Amazon Transcribe stops searching for the specified criteria in your media file. If you include EndPercentage in your request, you must also include StartPercentage.

            • First — (Integer)

              The time, in percentage, from the start of your media file until the specified value. Amazon Transcribe searches for your specified criteria in this time segment.

            • Last — (Integer)

              The time, in percentage, from the specified value until the end of your media file. Amazon Transcribe searches for your specified criteria in this time segment.

          • Negate — (Boolean)

            Set to TRUE to flag speech that does not contain interruptions. Set to FALSE to flag speech that contains interruptions.

        • TranscriptFilter — (map)

          Flag the presence or absence of specific words or phrases in your Call Analytics transcription output. Refer to for more detail.

          • TranscriptFilterType — required — (String)

            Flag the presence or absence of an exact match to the phrases that you specify. For example, if you specify the phrase "speak to a manager" as your Targets value, only that exact phrase is flagged.

            Note that semantic matching is not supported. For example, if your customer says "speak to the manager", instead of "speak to a manager", your content is not flagged.

            Possible values include:
            • "EXACT"
          • AbsoluteTimeRange — (map)

            Makes it possible to specify a time range (in milliseconds) in your audio, during which you want to search for the specified key words or phrases. See for more detail.

            • StartTime — (Integer)

              The time, in milliseconds, when Amazon Transcribe starts searching for the specified criteria in your audio. If you include StartTime in your request, you must also include EndTime.

            • EndTime — (Integer)

              The time, in milliseconds, when Amazon Transcribe stops searching for the specified criteria in your audio. If you include EndTime in your request, you must also include StartTime.

            • First — (Integer)

              The time, in milliseconds, from the start of your media file until the specified value. Amazon Transcribe searches for your specified criteria in this time segment.

            • Last — (Integer)

              The time, in milliseconds, from the specified value until the end of your media file. Amazon Transcribe searches for your specified criteria in this time segment.

          • RelativeTimeRange — (map)

            Makes it possible to specify a time range (in percentage) in your media file, during which you want to search for the specified key words or phrases. See for more detail.

            • StartPercentage — (Integer)

              The time, in percentage, when Amazon Transcribe starts searching for the specified criteria in your media file. If you include StartPercentage in your request, you must also include EndPercentage.

            • EndPercentage — (Integer)

              The time, in percentage, when Amazon Transcribe stops searching for the specified criteria in your media file. If you include EndPercentage in your request, you must also include StartPercentage.

            • First — (Integer)

              The time, in percentage, from the start of your media file until the specified value. Amazon Transcribe searches for your specified criteria in this time segment.

            • Last — (Integer)

              The time, in percentage, from the specified value until the end of your media file. Amazon Transcribe searches for your specified criteria in this time segment.

          • ParticipantRole — (String)

            Specify the participant that you want to flag. Omitting this parameter is equivalent to specifying both participants.

            Possible values include:
            • "AGENT"
            • "CUSTOMER"
          • Negate — (Boolean)

            Set to TRUE to flag the absence of the phrase that you specified in your request. Set to FALSE to flag the presence of the phrase that you specified in your request.

          • Targets — required — (Array<String>)

            Specify the phrases that you want to flag.

        • SentimentFilter — (map)

          Flag the presence or absence of specific sentiments in your Call Analytics transcription output. Refer to for more detail.

          • Sentiments — required — (Array<String>)

            Specify the sentiments that you want to flag.

          • AbsoluteTimeRange — (map)

            Makes it possible to specify a time range (in milliseconds) in your audio, during which you want to search for the specified sentiments. See for more detail.

            • StartTime — (Integer)

              The time, in milliseconds, when Amazon Transcribe starts searching for the specified criteria in your audio. If you include StartTime in your request, you must also include EndTime.

            • EndTime — (Integer)

              The time, in milliseconds, when Amazon Transcribe stops searching for the specified criteria in your audio. If you include EndTime in your request, you must also include StartTime.

            • First — (Integer)

              The time, in milliseconds, from the start of your media file until the specified value. Amazon Transcribe searches for your specified criteria in this time segment.

            • Last — (Integer)

              The time, in milliseconds, from the specified value until the end of your media file. Amazon Transcribe searches for your specified criteria in this time segment.

          • RelativeTimeRange — (map)

            Makes it possible to specify a time range (in percentage) in your media file, during which you want to search for the specified sentiments. See for more detail.

            • StartPercentage — (Integer)

              The time, in percentage, when Amazon Transcribe starts searching for the specified criteria in your media file. If you include StartPercentage in your request, you must also include EndPercentage.

            • EndPercentage — (Integer)

              The time, in percentage, when Amazon Transcribe stops searching for the specified criteria in your media file. If you include EndPercentage in your request, you must also include StartPercentage.

            • First — (Integer)

              The time, in percentage, from the start of your media file until the specified value. Amazon Transcribe searches for your specified criteria in this time segment.

            • Last — (Integer)

              The time, in percentage, from the specified value until the end of your media file. Amazon Transcribe searches for your specified criteria in this time segment.

          • ParticipantRole — (String)

            Specify the participant that you want to flag. Omitting this parameter is equivalent to specifying both participants.

            Possible values include:
            • "AGENT"
            • "CUSTOMER"
          • Negate — (Boolean)

            Set to TRUE to flag the sentiments that you didn't include in your request. Set to FALSE to flag the sentiments that you specified in your request.

      • CreateTime — (Date)

        The date and time the specified Call Analytics category was created.

        Timestamps are in the format YYYY-MM-DD'T'HH:MM:SS.SSSSSS-UTC. For example, 2022-05-04T12:32:58.761000-07:00 represents 12:32 PM UTC-7 on May 4, 2022.

      • LastUpdateTime — (Date)

        The date and time the specified Call Analytics category was last updated.

        Timestamps are in the format YYYY-MM-DD'T'HH:MM:SS.SSSSSS-UTC. For example, 2022-05-05T12:45:32.691000-07:00 represents 12:45 PM UTC-7 on May 5, 2022.

      • InputType — (String)

        The input type associated with the specified category. POST_CALL refers to a category that is applied to batch transcriptions; REAL_TIME refers to a category that is applied to streaming transcriptions.

        Possible values include:
        • "REAL_TIME"
        • "POST_CALL"

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  CallAnalyticsJobName: 'STRING_VALUE' /* required */
};
transcribeservice.getCallAnalyticsJob(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • CallAnalyticsJobName — (String)

    The name of the Call Analytics job you want information about. Job names are case sensitive.

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

    • CallAnalyticsJob — (map)

      Provides detailed information about the specified Call Analytics job, including job status and, if applicable, failure reason.

      • CallAnalyticsJobName — (String)

        The name of the Call Analytics job. Job names are case sensitive and must be unique within an Amazon Web Services account.

      • CallAnalyticsJobStatus — (String)

        Provides the status of the specified Call Analytics job.

        If the status is COMPLETED, the job is finished and you can find the results at the location specified in TranscriptFileUri (or RedactedTranscriptFileUri, if you requested transcript redaction). If the status is FAILED, FailureReason provides details on why your transcription job failed.

        Possible values include:
        • "QUEUED"
        • "IN_PROGRESS"
        • "FAILED"
        • "COMPLETED"
      • CallAnalyticsJobDetails — (map)

        Provides detailed information about a call analytics job, including information about skipped analytics features.

        • Skipped — (Array<map>)

          Contains information about any skipped analytics features during the analysis of a call analytics job.

          This array lists all the analytics features that were skipped, along with their corresponding reason code and message.

          • Feature — (String)

            Indicates the type of analytics feature that was skipped during the analysis of a call analytics job.

            Possible values include:
            • "GENERATIVE_SUMMARIZATION"
          • ReasonCode — (String)

            Provides a code indicating the reason why a specific analytics feature was skipped during the analysis of a call analytics job.

            Possible values include:
            • "INSUFFICIENT_CONVERSATION_CONTENT"
            • "FAILED_SAFETY_GUIDELINES"
          • Message — (String)

            Contains additional information or a message explaining why a specific analytics feature was skipped during the analysis of a call analytics job.

      • LanguageCode — (String)

        The language code used to create your Call Analytics job. For a list of supported languages and their associated language codes, refer to the Supported languages table.

        If you do not know the language spoken in your media file, you can omit this field and let Amazon Transcribe automatically identify the language of your media. To improve the accuracy of language identification, you can include several language codes and Amazon Transcribe chooses the closest match for your transcription.

        Possible values include:
        • "af-ZA"
        • "ar-AE"
        • "ar-SA"
        • "da-DK"
        • "de-CH"
        • "de-DE"
        • "en-AB"
        • "en-AU"
        • "en-GB"
        • "en-IE"
        • "en-IN"
        • "en-US"
        • "en-WL"
        • "es-ES"
        • "es-US"
        • "fa-IR"
        • "fr-CA"
        • "fr-FR"
        • "he-IL"
        • "hi-IN"
        • "id-ID"
        • "it-IT"
        • "ja-JP"
        • "ko-KR"
        • "ms-MY"
        • "nl-NL"
        • "pt-BR"
        • "pt-PT"
        • "ru-RU"
        • "ta-IN"
        • "te-IN"
        • "tr-TR"
        • "zh-CN"
        • "zh-TW"
        • "th-TH"
        • "en-ZA"
        • "en-NZ"
        • "vi-VN"
        • "sv-SE"
        • "ab-GE"
        • "ast-ES"
        • "az-AZ"
        • "ba-RU"
        • "be-BY"
        • "bg-BG"
        • "bn-IN"
        • "bs-BA"
        • "ca-ES"
        • "ckb-IQ"
        • "ckb-IR"
        • "cs-CZ"
        • "cy-WL"
        • "el-GR"
        • "et-ET"
        • "eu-ES"
        • "fi-FI"
        • "gl-ES"
        • "gu-IN"
        • "ha-NG"
        • "hr-HR"
        • "hu-HU"
        • "hy-AM"
        • "is-IS"
        • "ka-GE"
        • "kab-DZ"
        • "kk-KZ"
        • "kn-IN"
        • "ky-KG"
        • "lg-IN"
        • "lt-LT"
        • "lv-LV"
        • "mhr-RU"
        • "mi-NZ"
        • "mk-MK"
        • "ml-IN"
        • "mn-MN"
        • "mr-IN"
        • "mt-MT"
        • "no-NO"
        • "or-IN"
        • "pa-IN"
        • "pl-PL"
        • "ps-AF"
        • "ro-RO"
        • "rw-RW"
        • "si-LK"
        • "sk-SK"
        • "sl-SI"
        • "so-SO"
        • "sr-RS"
        • "su-ID"
        • "sw-BI"
        • "sw-KE"
        • "sw-RW"
        • "sw-TZ"
        • "sw-UG"
        • "tl-PH"
        • "tt-RU"
        • "ug-CN"
        • "uk-UA"
        • "uz-UZ"
        • "wo-SN"
        • "zu-ZA"
      • MediaSampleRateHertz — (Integer)

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

      • MediaFormat — (String)

        The format of the input media file.

        Possible values include:
        • "mp3"
        • "mp4"
        • "wav"
        • "flac"
        • "ogg"
        • "amr"
        • "webm"
        • "m4a"
      • Media — (map)

        Provides the Amazon S3 location of the media file you used in your Call Analytics request.

        • MediaFileUri — (String)

          The Amazon S3 location of the media file you want to transcribe. For example:

          • s3://DOC-EXAMPLE-BUCKET/my-media-file.flac

          • s3://DOC-EXAMPLE-BUCKET/media-files/my-media-file.flac

          Note that the Amazon S3 bucket that contains your input media must be located in the same Amazon Web Services Region where you're making your transcription request.

        • RedactedMediaFileUri — (String)

          The Amazon S3 location of the media file you want to redact. For example:

          • s3://DOC-EXAMPLE-BUCKET/my-media-file.flac

          • s3://DOC-EXAMPLE-BUCKET/media-files/my-media-file.flac

          Note that the Amazon S3 bucket that contains your input media must be located in the same Amazon Web Services Region where you're making your transcription request.

          RedactedMediaFileUri produces a redacted audio file in addition to a redacted transcript. It is only supported for Call Analytics (StartCallAnalyticsJob) transcription requests.

      • Transcript — (map)

        Provides you with the Amazon S3 URI you can use to access your transcript.

        • TranscriptFileUri — (String)

          The Amazon S3 location of your transcript. You can use this URI to access or download your transcript.

          If you included OutputBucketName in your transcription job request, this is the URI of that bucket. If you also included OutputKey in your request, your output is located in the path you specified in your request.

          If you didn't include OutputBucketName in your transcription job request, your transcript is stored in a service-managed bucket, and TranscriptFileUri provides you with a temporary URI you can use for secure access to your transcript.

          Note: Temporary URIs for service-managed Amazon S3 buckets are only valid for 15 minutes. If you get an AccesDenied error, you can get a new temporary URI by running a GetTranscriptionJob or ListTranscriptionJob request.
        • RedactedTranscriptFileUri — (String)

          The Amazon S3 location of your redacted transcript. You can use this URI to access or download your transcript.

          If you included OutputBucketName in your transcription job request, this is the URI of that bucket. If you also included OutputKey in your request, your output is located in the path you specified in your request.

          If you didn't include OutputBucketName in your transcription job request, your transcript is stored in a service-managed bucket, and RedactedTranscriptFileUri provides you with a temporary URI you can use for secure access to your transcript.

          Note: Temporary URIs for service-managed Amazon S3 buckets are only valid for 15 minutes. If you get an AccesDenied error, you can get a new temporary URI by running a GetTranscriptionJob or ListTranscriptionJob request.
      • StartTime — (Date)

        The date and time the specified Call Analytics job began processing.

        Timestamps are in the format YYYY-MM-DD'T'HH:MM:SS.SSSSSS-UTC. For example, 2022-05-04T12:32:58.789000-07:00 represents a transcription job that started processing at 12:32 PM UTC-7 on May 4, 2022.

      • CreationTime — (Date)

        The date and time the specified Call Analytics job request was made.

        Timestamps are in the format YYYY-MM-DD'T'HH:MM:SS.SSSSSS-UTC. For example, 2022-05-04T12:32:58.761000-07:00 represents a transcription job that started processing at 12:32 PM UTC-7 on May 4, 2022.

      • CompletionTime — (Date)

        The date and time the specified Call Analytics job finished processing.

        Timestamps are in the format YYYY-MM-DD'T'HH:MM:SS.SSSSSS-UTC. For example, 2022-05-04T12:33:13.922000-07:00 represents a transcription job that started processing at 12:33 PM UTC-7 on May 4, 2022.

      • FailureReason — (String)

        If CallAnalyticsJobStatus is FAILED, FailureReason contains information about why the Call Analytics job request failed.

        The FailureReason field contains one of the following values:

        • Unsupported media format.

          The media format specified in MediaFormat isn't valid. Refer to refer to the MediaFormat parameter for a list of supported formats.

        • The media format provided does not match the detected media format.

          The media format specified in MediaFormat doesn't match the format of the input file. Check the media format of your media file and correct the specified value.

        • Invalid sample rate for audio file.

          The sample rate specified in MediaSampleRateHertz isn't valid. The sample rate must be between 8,000 and 48,000 hertz.

        • The sample rate provided does not match the detected sample rate.

          The sample rate specified in MediaSampleRateHertz doesn't match the sample rate detected in your input media file. Check the sample rate of your media file and correct the specified value.

        • Invalid file size: file size too large.

          The size of your media file is larger than what Amazon Transcribe can process. For more information, refer to Service quotas.

        • Invalid number of channels: number of channels too large.

          Your audio contains more channels than Amazon Transcribe is able to process. For more information, refer to Service quotas.

      • DataAccessRoleArn — (String)

        The Amazon Resource Name (ARN) you included in your request.

      • IdentifiedLanguageScore — (Float)

        The confidence score associated with the language identified in your media file.

        Confidence scores are values between 0 and 1; a larger value indicates a higher probability that the identified language correctly matches the language spoken in your media.

      • Settings — (map)

        Provides information on any additional settings that were included in your request. Additional settings include content redaction and language identification settings.

        • VocabularyName — (String)

          The name of the custom vocabulary you want to include in your Call Analytics transcription request. Custom vocabulary names are case sensitive.

        • VocabularyFilterName — (String)

          The name of the custom vocabulary filter you want to include in your Call Analytics transcription request. Custom vocabulary filter names are case sensitive.

          Note that if you include VocabularyFilterName in your request, you must also include VocabularyFilterMethod.

        • VocabularyFilterMethod — (String)

          Specify how you want your custom vocabulary filter applied to your transcript.

          To replace words with ***, choose mask.

          To delete words, choose remove.

          To flag words without changing them, choose tag.

          Possible values include:
          • "remove"
          • "mask"
          • "tag"
        • LanguageModelName — (String)

          The name of the custom language model you want to use when processing your Call Analytics job. Note that custom language model names are case sensitive.

          The language of the specified custom language model must match the language code that you specify in your transcription request. If the languages do not match, the custom language model isn't applied. There are no errors or warnings associated with a language mismatch.

        • ContentRedaction — (map)

          Makes it possible to redact or flag specified personally identifiable information (PII) in your transcript. If you use ContentRedaction, you must also include the sub-parameters: RedactionOutput and RedactionType. You can optionally include PiiEntityTypes to choose which types of PII you want to redact.

          • RedactionType — required — (String)

            Specify the category of information you want to redact; PII (personally identifiable information) is the only valid value. You can use PiiEntityTypes to choose which types of PII you want to redact. If you do not include PiiEntityTypes in your request, all PII is redacted.

            Possible values include:
            • "PII"
          • RedactionOutput — required — (String)

            Specify if you want only a redacted transcript, or if you want a redacted and an unredacted transcript.

            When you choose redacted Amazon Transcribe creates only a redacted transcript.

            When you choose redacted_and_unredacted Amazon Transcribe creates a redacted and an unredacted transcript (as two separate files).

            Possible values include:
            • "redacted"
            • "redacted_and_unredacted"
          • PiiEntityTypes — (Array<String>)

            Specify which types of personally identifiable information (PII) you want to redact in your transcript. You can include as many types as you'd like, or you can select ALL. If you do not include PiiEntityTypes in your request, all PII is redacted.

        • LanguageOptions — (Array<String>)

          You can specify two or more language codes that represent the languages you think may be present in your media. Including more than five is not recommended. If you're unsure what languages are present, do not include this parameter.

          Including language options can improve the accuracy of language identification.

          For a list of languages supported with Call Analytics, refer to the Supported languages table.

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

        • LanguageIdSettings — (map<map>)

          If using automatic language identification in your request and you want to apply a custom language model, a custom vocabulary, or a custom vocabulary filter, include LanguageIdSettings with the relevant sub-parameters (VocabularyName, LanguageModelName, and VocabularyFilterName).

          LanguageIdSettings supports two to five language codes. Each language code you include can have an associated custom language model, custom vocabulary, and custom vocabulary filter. The language codes that you specify must match the languages of the associated custom language models, custom vocabularies, and custom vocabulary filters.

          It's recommended that you include LanguageOptions when using LanguageIdSettings to ensure that the correct language dialect is identified. For example, if you specify a custom vocabulary that is in en-US but Amazon Transcribe determines that the language spoken in your media is en-AU, your custom vocabulary is not applied to your transcription. If you include LanguageOptions and include en-US as the only English language dialect, your custom vocabulary is applied to your transcription.

          If you want to include a custom language model, custom vocabulary, or custom vocabulary filter with your request but do not want to use automatic language identification, use instead the parameter with the LanguageModelName, VocabularyName, or VocabularyFilterName sub-parameters.

          For a list of languages supported with Call Analytics, refer to Supported languages and language-specific features.

          • VocabularyName — (String)

            The name of the custom vocabulary you want to use when processing your transcription job. Custom vocabulary names are case sensitive.

            The language of the specified custom vocabulary must match the language code that you specify in your transcription request. If the languages do not match, the custom vocabulary isn't applied. There are no errors or warnings associated with a language mismatch.

          • VocabularyFilterName — (String)

            The name of the custom vocabulary filter you want to use when processing your transcription job. Custom vocabulary filter names are case sensitive.

            The language of the specified custom vocabulary filter must match the language code that you specify in your transcription request. If the languages do not match, the custom vocabulary filter isn't applied. There are no errors or warnings associated with a language mismatch.

            Note that if you include VocabularyFilterName in your request, you must also include VocabularyFilterMethod.

          • LanguageModelName — (String)

            The name of the custom language model you want to use when processing your transcription job. Note that custom language model names are case sensitive.

            The language of the specified custom language model must match the language code that you specify in your transcription request. If the languages do not match, the custom language model isn't applied. There are no errors or warnings associated with a language mismatch.

        • Summarization — (map)

          Contains GenerateAbstractiveSummary, which is a required parameter if you want to enable Generative call summarization in your Call Analytics request.

          • GenerateAbstractiveSummary — required — (Boolean)

            Enables Generative call summarization in your Call Analytics request

            Generative call summarization provides a summary of the transcript including important components discussed in the conversation.

            For more information, see Enabling generative call summarization.

      • ChannelDefinitions — (Array<map>)

        Indicates which speaker is on which channel.

        • ChannelId — (Integer)

          Specify the audio channel you want to define.

        • ParticipantRole — (String)

          Specify the speaker you want to define. Omitting this parameter is equivalent to specifying both participants.

          Possible values include:
          • "AGENT"
          • "CUSTOMER"