You are viewing the documentation for an older major version of the AWS SDK for JavaScript.
The modular AWS SDK for JavaScript (v3), the latest major version of AWS SDK for JavaScript, is now stable and recommended for general use. For more information, see the Migration Guide and API Reference.

Class: AWS.TranscribeService

Inherits:
AWS.Service show all
Identifier:
transcribeservice
API Version:
2017-10-26
Defined in:
(unknown)

Overview

Constructs a service interface object. Each API operation is exposed as a function on service.

Service Description

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.

Sending a Request Using TranscribeService

var transcribeservice = new AWS.TranscribeService();
transcribeservice.createCallAnalyticsCategory(params, function (err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Locking the API Version

In order to ensure that the TranscribeService object uses this specific API, you can construct the object by passing the apiVersion option to the constructor:

var transcribeservice = new AWS.TranscribeService({apiVersion: '2017-10-26'});

You can also set the API version globally in AWS.config.apiVersions using the transcribeservice service identifier:

AWS.config.apiVersions = {
  transcribeservice: '2017-10-26',
  // other service API versions
};

var transcribeservice = new AWS.TranscribeService();

Version:

  • 2017-10-26

Constructor Summary collapse

Property Summary collapse

Properties inherited from AWS.Service

apiVersions

Method Summary collapse

Methods inherited from AWS.Service

makeRequest, makeUnauthenticatedRequest, waitFor, setupRequestListeners, defineService

Constructor Details

new AWS.TranscribeService(options = {}) ⇒ Object

Constructs a service object. This object has one method for each API operation.

Examples:

Constructing a TranscribeService object

var transcribeservice = new AWS.TranscribeService({apiVersion: '2017-10-26'});

Options Hash (options):

  • params (map)

    An optional map of parameters to bind to every request sent by this service object. For more information on bound parameters, see "Working with Services" in the Getting Started Guide.

  • endpoint (String|AWS.Endpoint)

    The endpoint URI to send requests to. The default endpoint is built from the configured region. The endpoint should be a string like 'https://{service}.{region}.amazonaws.com' or an Endpoint object.

  • accessKeyId (String)

    your AWS access key ID.

  • secretAccessKey (String)

    your AWS secret access key.

  • sessionToken (AWS.Credentials)

    the optional AWS session token to sign requests with.

  • credentials (AWS.Credentials)

    the AWS credentials to sign requests with. You can either specify this object, or specify the accessKeyId and secretAccessKey options directly.

  • credentialProvider (AWS.CredentialProviderChain)

    the provider chain used to resolve credentials if no static credentials property is set.

  • region (String)

    the region to send service requests to. See AWS.TranscribeService.region for more information.

  • maxRetries (Integer)

    the maximum amount of retries to attempt with a request. See AWS.TranscribeService.maxRetries for more information.

  • maxRedirects (Integer)

    the maximum amount of redirects to follow with a request. See AWS.TranscribeService.maxRedirects for more information.

  • sslEnabled (Boolean)

    whether to enable SSL for requests.

  • paramValidation (Boolean|map)

    whether input parameters should be validated against the operation description before sending the request. Defaults to true. Pass a map to enable any of the following specific validation features:

    • min [Boolean] — Validates that a value meets the min constraint. This is enabled by default when paramValidation is set to true.
    • max [Boolean] — Validates that a value meets the max constraint.
    • pattern [Boolean] — Validates that a string value matches a regular expression.
    • enum [Boolean] — Validates that a string value matches one of the allowable enum values.
  • computeChecksums (Boolean)

    whether to compute checksums for payload bodies when the service accepts it (currently supported in S3 only)

  • convertResponseTypes (Boolean)

    whether types are converted when parsing response data. Currently only supported for JSON based services. Turning this off may improve performance on large response payloads. Defaults to true.

  • correctClockSkew (Boolean)

    whether to apply a clock skew correction and retry requests that fail because of an skewed client clock. Defaults to false.

  • s3ForcePathStyle (Boolean)

    whether to force path style URLs for S3 objects.

  • s3BucketEndpoint (Boolean)

    whether the provided endpoint addresses an individual bucket (false if it addresses the root API endpoint). Note that setting this configuration option requires an endpoint to be provided explicitly to the service constructor.

  • s3DisableBodySigning (Boolean)

    whether S3 body signing should be disabled when using signature version v4. Body signing can only be disabled when using https. Defaults to true.

  • s3UsEast1RegionalEndpoint ('legacy'|'regional')

    when region is set to 'us-east-1', whether to send s3 request to global endpoints or 'us-east-1' regional endpoints. This config is only applicable to S3 client. Defaults to legacy

  • s3UseArnRegion (Boolean)

    whether to override the request region with the region inferred from requested resource's ARN. Only available for S3 buckets Defaults to true

  • retryDelayOptions (map)

    A set of options to configure the retry delay on retryable errors. Currently supported options are:

    • base [Integer] — The base number of milliseconds to use in the exponential backoff for operation retries. Defaults to 100 ms for all services except DynamoDB, where it defaults to 50ms.
    • customBackoff [function] — A custom function that accepts a retry count and error and returns the amount of time to delay in milliseconds. If the result is a non-zero negative value, no further retry attempts will be made. The base option will be ignored if this option is supplied. The function is only called for retryable errors.
  • httpOptions (map)

    A set of options to pass to the low-level HTTP request. Currently supported options are:

    • proxy [String] — the URL to proxy requests through
    • agent [http.Agent, https.Agent] — the Agent object to perform HTTP requests with. Used for connection pooling. Defaults to the global agent (http.globalAgent) for non-SSL connections. Note that for SSL connections, a special Agent object is used in order to enable peer certificate verification. This feature is only available in the Node.js environment.
    • connectTimeout [Integer] — Sets the socket to timeout after failing to establish a connection with the server after connectTimeout milliseconds. This timeout has no effect once a socket connection has been established.
    • timeout [Integer] — Sets the socket to timeout after timeout milliseconds of inactivity on the socket. Defaults to two minutes (120000).
    • xhrAsync [Boolean] — Whether the SDK will send asynchronous HTTP requests. Used in the browser environment only. Set to false to send requests synchronously. Defaults to true (async on).
    • xhrWithCredentials [Boolean] — Sets the "withCredentials" property of an XMLHttpRequest object. Used in the browser environment only. Defaults to false.
  • apiVersion (String, Date)

    a String in YYYY-MM-DD format (or a date) that represents the latest possible API version that can be used in all services (unless overridden by apiVersions). Specify 'latest' to use the latest possible version.

  • apiVersions (map<String, String|Date>)

    a map of service identifiers (the lowercase service class name) with the API version to use when instantiating a service. Specify 'latest' for each individual that can use the latest available version.

  • logger (#write, #log)

    an object that responds to .write() (like a stream) or .log() (like the console object) in order to log information about requests

  • systemClockOffset (Number)

    an offset value in milliseconds to apply to all signing times. Use this to compensate for clock skew when your system may be out of sync with the service time. Note that this configuration option can only be applied to the global AWS.config object and cannot be overridden in service-specific configuration. Defaults to 0 milliseconds.

  • signatureVersion (String)

    the signature version to sign requests with (overriding the API configuration). Possible values are: 'v2', 'v3', 'v4'.

  • signatureCache (Boolean)

    whether the signature to sign requests with (overriding the API configuration) is cached. Only applies to the signature version 'v4'. Defaults to true.

  • dynamoDbCrc32 (Boolean)

    whether to validate the CRC32 checksum of HTTP response bodies returned by DynamoDB. Default: true.

  • useAccelerateEndpoint (Boolean)

    Whether to use the S3 Transfer Acceleration endpoint with the S3 service. Default: false.

  • clientSideMonitoring (Boolean)

    whether to collect and publish this client's performance metrics of all its API requests.

  • endpointDiscoveryEnabled (Boolean|undefined)

    whether to call operations with endpoints given by service dynamically. Setting this

  • endpointCacheSize (Number)

    the size of the global cache storing endpoints from endpoint discovery operations. Once endpoint cache is created, updating this setting cannot change existing cache size. Defaults to 1000

  • hostPrefixEnabled (Boolean)

    whether to marshal request parameters to the prefix of hostname. Defaults to true.

  • stsRegionalEndpoints ('legacy'|'regional')

    whether to send sts request to global endpoints or regional endpoints. Defaults to 'legacy'.

  • useFipsEndpoint (Boolean)

    Enables FIPS compatible endpoints. Defaults to false.

  • useDualstackEndpoint (Boolean)

    Enables IPv6 dualstack endpoint. Defaults to false.

Property Details

endpointAWS.Endpoint (readwrite)

Returns an Endpoint object representing the endpoint URL for service requests.

Returns:

  • (AWS.Endpoint)

    an Endpoint object representing the endpoint URL for service requests.

Method Details

createCallAnalyticsCategory(params = {}, callback) ⇒ AWS.Request

Creates a new Call Analytics category.

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

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:

Service Reference:

Examples:

Calling the createCallAnalyticsCategory operation

var params = {
  CategoryName: 'STRING_VALUE', /* required */
  Rules: [ /* required */
    {
      InterruptionFilter: {
        AbsoluteTimeRange: {
          EndTime: 'NUMBER_VALUE',
          First: 'NUMBER_VALUE',
          Last: 'NUMBER_VALUE',
          StartTime: 'NUMBER_VALUE'
        },
        Negate: true || false,
        ParticipantRole: AGENT | CUSTOMER,
        RelativeTimeRange: {
          EndPercentage: 'NUMBER_VALUE',
          First: 'NUMBER_VALUE',
          Last: 'NUMBER_VALUE',
          StartPercentage: 'NUMBER_VALUE'
        },
        Threshold: 'NUMBER_VALUE'
      },
      NonTalkTimeFilter: {
        AbsoluteTimeRange: {
          EndTime: 'NUMBER_VALUE',
          First: 'NUMBER_VALUE',
          Last: 'NUMBER_VALUE',
          StartTime: 'NUMBER_VALUE'
        },
        Negate: true || false,
        RelativeTimeRange: {
          EndPercentage: 'NUMBER_VALUE',
          First: 'NUMBER_VALUE',
          Last: 'NUMBER_VALUE',
          StartPercentage: 'NUMBER_VALUE'
        },
        Threshold: 'NUMBER_VALUE'
      },
      SentimentFilter: {
        Sentiments: [ /* required */
          POSITIVE | NEGATIVE | NEUTRAL | MIXED,
          /* more items */
        ],
        AbsoluteTimeRange: {
          EndTime: 'NUMBER_VALUE',
          First: 'NUMBER_VALUE',
          Last: 'NUMBER_VALUE',
          StartTime: 'NUMBER_VALUE'
        },
        Negate: true || false,
        ParticipantRole: AGENT | CUSTOMER,
        RelativeTimeRange: {
          EndPercentage: 'NUMBER_VALUE',
          First: 'NUMBER_VALUE',
          Last: 'NUMBER_VALUE',
          StartPercentage: 'NUMBER_VALUE'
        }
      },
      TranscriptFilter: {
        Targets: [ /* required */
          'STRING_VALUE',
          /* more items */
        ],
        TranscriptFilterType: EXACT, /* required */
        AbsoluteTimeRange: {
          EndTime: 'NUMBER_VALUE',
          First: 'NUMBER_VALUE',
          Last: 'NUMBER_VALUE',
          StartTime: 'NUMBER_VALUE'
        },
        Negate: true || false,
        ParticipantRole: AGENT | CUSTOMER,
        RelativeTimeRange: {
          EndPercentage: 'NUMBER_VALUE',
          First: 'NUMBER_VALUE',
          Last: 'NUMBER_VALUE',
          StartPercentage: 'NUMBER_VALUE'
        }
      }
    },
    /* more items */
  ]
};
transcribeservice.createCallAnalyticsCategory(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)

      A unique name, chosen by you, for your Call Analytics category. It's helpful to use a detailed naming system that will make sense to you in the future. For example, it's better to use sentiment-positive-last30seconds for a category over a generic name like test-category.

      Category names are case sensitive.

    • Rules — (Array<map>)

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

      • 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 you want to flag. For example, you can flag a silent period that lasts 30000 milliseconds.

        • AbsoluteTimeRange — (map)

          Allows you 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 value you specify in which Amazon Transcribe searches for your specified criteria.

          • Last — (Integer)

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

        • RelativeTimeRange — (map)

          Allows you 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 value you specify in which Amazon Transcribe searches for your specified criteria.

          • Last — (Integer)

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

        • 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 10000 milliseconds of interruptions.

        • ParticipantRole — (String)

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

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

          Allows you 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 value you specify in which Amazon Transcribe searches for your specified criteria.

          • Last — (Integer)

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

        • RelativeTimeRange — (map)

          Allows you 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 value you specify in which Amazon Transcribe searches for your specified criteria.

          • Last — (Integer)

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

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

        • TranscriptFilterTyperequired — (String)

          Flag the presence or absence of an exact match to the phrases 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)

          Allows you 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 value you specify in which Amazon Transcribe searches for your specified criteria.

          • Last — (Integer)

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

        • RelativeTimeRange — (map)

          Allows you 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 value you specify in which Amazon Transcribe searches for your specified criteria.

          • Last — (Integer)

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

        • ParticipantRole — (String)

          Specify the participant 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 you specified in your request. Set to FALSE to flag the presence of the phrase you specified in your request.

        • Targetsrequired — (Array<String>)

          Specify the phrases 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.

        • Sentimentsrequired — (Array<String>)

          Specify the sentiments you want to flag.

        • AbsoluteTimeRange — (map)

          Allows you 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 value you specify in which Amazon Transcribe searches for your specified criteria.

          • Last — (Integer)

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

        • RelativeTimeRange — (map)

          Allows you 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 value you specify in which Amazon Transcribe searches for your specified criteria.

          • Last — (Integer)

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

        • ParticipantRole — (String)

          Specify the participant 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 you didn't include in your request. Set to FALSE to flag the sentiments you specified in your request.

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 your new category, including its associated rules.

        • 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 you want to flag. For example, you can flag a silent period that lasts 30000 milliseconds.

            • AbsoluteTimeRange — (map)

              Allows you 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 value you specify in which Amazon Transcribe searches for your specified criteria.

              • Last — (Integer)

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

            • RelativeTimeRange — (map)

              Allows you 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 value you specify in which Amazon Transcribe searches for your specified criteria.

              • Last — (Integer)

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

            • 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 10000 milliseconds of interruptions.

            • ParticipantRole — (String)

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

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

              Allows you 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 value you specify in which Amazon Transcribe searches for your specified criteria.

              • Last — (Integer)

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

            • RelativeTimeRange — (map)

              Allows you 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 value you specify in which Amazon Transcribe searches for your specified criteria.

              • Last — (Integer)

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

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

            • TranscriptFilterTyperequired — (String)

              Flag the presence or absence of an exact match to the phrases 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)

              Allows you 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 value you specify in which Amazon Transcribe searches for your specified criteria.

              • Last — (Integer)

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

            • RelativeTimeRange — (map)

              Allows you 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 value you specify in which Amazon Transcribe searches for your specified criteria.

              • Last — (Integer)

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

            • ParticipantRole — (String)

              Specify the participant 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 you specified in your request. Set to FALSE to flag the presence of the phrase you specified in your request.

            • Targetsrequired — (Array<String>)

              Specify the phrases 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.

            • Sentimentsrequired — (Array<String>)

              Specify the sentiments you want to flag.

            • AbsoluteTimeRange — (map)

              Allows you 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 value you specify in which Amazon Transcribe searches for your specified criteria.

              • Last — (Integer)

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

            • RelativeTimeRange — (map)

              Allows you 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 value you specify in which Amazon Transcribe searches for your specified criteria.

              • Last — (Integer)

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

            • ParticipantRole — (String)

              Specify the participant 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 you didn't include in your request. Set to FALSE to flag the sentiments 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.

Returns:

  • (AWS.Request)

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

createLanguageModel(params = {}, callback) ⇒ AWS.Request

Creates a new custom language model.

When creating a new 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

For more information, see Custom language models.

Service Reference:

Examples:

Calling the createLanguageModel operation

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, /* 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 language model must contain terms in only one language, and the language you select for your 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 U.S. 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 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"
    • 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 language model with the same name as an existing 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.

      • S3Urirequired — (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/

      • DataAccessRoleArnrequired — (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 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.

      • Keyrequired — (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'.

      • Valuerequired — (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"
      • 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.

        • S3Urirequired — (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/

        • DataAccessRoleArnrequired — (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 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.

createMedicalVocabulary(params = {}, callback) ⇒ AWS.Request

Creates a new custom medical vocabulary.

Prior to creating a new medical vocabulary, you must first upload a text file that contains your new entries, phrases, and terms 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.

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

For more information, see Creating a custom vocabulary.

Service Reference:

Examples:

Calling the createMedicalVocabulary operation

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, /* 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 medical vocabulary with the same name as an existing 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"
    • 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 medical vocabulary at the time you create this new vocabulary.

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

      • Keyrequired — (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'.

      • Valuerequired — (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 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"
      • VocabularyState — (String)

        The processing state of your custom medical vocabulary. If the state is READY, you can use the 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.

createVocabulary(params = {}, callback) ⇒ AWS.Request

Creates a new custom vocabulary.

When creating a new 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 vocabulary request fails. Refer to Character Sets for Custom Vocabularies to get the character set for your language.

For more information, see Creating a custom vocabulary.

Service Reference:

Examples:

Calling the createVocabulary operation

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, /* required */
  VocabularyName: 'STRING_VALUE', /* required */
  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 vocabulary with the same name as an existing vocabulary, you get a ConflictException error.

    • LanguageCode — (String)

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

      A custom vocabulary can only be used to transcribe files in the same language as the vocabulary. For example, if you create a vocabulary using US English (en-US), you can only apply this 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"
    • Phrases — (Array<String>)

      Use this parameter if you want to create your vocabulary by including all desired terms, as comma-separated values, within your request. The other option for creating your 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 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 vocabulary.

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

      • Keyrequired — (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'.

      • Valuerequired — (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 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"
      • VocabularyState — (String)

        The processing state of your custom vocabulary. If the state is READY, you can use the 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 vocabulary request failed. See also: Common Errors.

Returns:

  • (AWS.Request)

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

createVocabularyFilter(params = {}, callback) ⇒ AWS.Request

Creates a new custom vocabulary filter.

You can use vocabulary filters to mask, delete, or flag specific words from your transcript. 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 vocabulary filter request fails. Refer to Character Sets for Custom Vocabularies to get the character set for your language.

For more information, see Using vocabulary filtering with unwanted words.

Service Reference:

Examples:

Calling the createVocabularyFilter operation

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, /* required */
  VocabularyFilterName: 'STRING_VALUE', /* required */
  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 vocabulary filter with the same name as an existing vocabulary filter, you get a ConflictException error.

    • LanguageCode — (String)

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

      A vocabulary filter can only be used to transcribe files in the same language as the filter. For example, if you create a 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"
    • Words — (Array<String>)

      Use this parameter if you want to create your 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 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 filter.

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

      • Keyrequired — (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'.

      • Valuerequired — (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:

      • VocabularyFilterName — (String)

        The name you chose for your custom vocabulary filter.

      • LanguageCode — (String)

        The language code you selected for your 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"
      • LastModifiedTime — (Date)

        The date and time you created your 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.

deleteCallAnalyticsCategory(params = {}, callback) ⇒ AWS.Request

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.

Service Reference:

Examples:

Calling the deleteCallAnalyticsCategory operation

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.

deleteCallAnalyticsJob(params = {}, callback) ⇒ AWS.Request

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.

Service Reference:

Examples:

Calling the deleteCallAnalyticsJob operation

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.

deleteLanguageModel(params = {}, callback) ⇒ AWS.Request

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

Service Reference:

Examples:

Calling the deleteLanguageModel operation

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.

deleteMedicalTranscriptionJob(params = {}, callback) ⇒ AWS.Request

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.

Service Reference:

Examples:

Calling the deleteMedicalTranscriptionJob operation

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.

deleteMedicalVocabulary(params = {}, callback) ⇒ AWS.Request

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

Service Reference:

Examples:

Calling the deleteMedicalVocabulary operation

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

deleteTranscriptionJob(params = {}, callback) ⇒ AWS.Request

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.

Service Reference:

Examples:

Calling the deleteTranscriptionJob operation

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.

deleteVocabulary(params = {}, callback) ⇒ AWS.Request

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

Service Reference:

Examples:

Calling the deleteVocabulary operation

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

deleteVocabularyFilter(params = {}, callback) ⇒ AWS.Request

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

Service Reference:

Examples:

Calling the deleteVocabularyFilter operation

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

describeLanguageModel(params = {}, callback) ⇒ AWS.Request

Provides information about the specified custom language model.

This operation 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 DescribeLanguageModel to help identify the reason for this failure.

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

Service Reference:

Examples:

Calling the describeLanguageModel operation

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 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 language model must contain terms in only one language, and the language you select for your 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 U.S. 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"
        • 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 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.

          • S3Urirequired — (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/

          • DataAccessRoleArnrequired — (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 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.

getCallAnalyticsCategory(params = {}, callback) ⇒ AWS.Request

Provides information about the specified Call Analytics category.

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

Service Reference:

Examples:

Calling the getCallAnalyticsCategory operation

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 you want to flag. For example, you can flag a silent period that lasts 30000 milliseconds.

            • AbsoluteTimeRange — (map)

              Allows you 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 value you specify in which Amazon Transcribe searches for your specified criteria.

              • Last — (Integer)

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

            • RelativeTimeRange — (map)

              Allows you 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 value you specify in which Amazon Transcribe searches for your specified criteria.

              • Last — (Integer)

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

            • 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 10000 milliseconds of interruptions.

            • ParticipantRole — (String)

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

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

              Allows you 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 value you specify in which Amazon Transcribe searches for your specified criteria.

              • Last — (Integer)

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

            • RelativeTimeRange — (map)

              Allows you 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 value you specify in which Amazon Transcribe searches for your specified criteria.

              • Last — (Integer)

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

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

            • TranscriptFilterTyperequired — (String)

              Flag the presence or absence of an exact match to the phrases 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)

              Allows you 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 value you specify in which Amazon Transcribe searches for your specified criteria.

              • Last — (Integer)

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

            • RelativeTimeRange — (map)

              Allows you 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 value you specify in which Amazon Transcribe searches for your specified criteria.

              • Last — (Integer)

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

            • ParticipantRole — (String)

              Specify the participant 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 you specified in your request. Set to FALSE to flag the presence of the phrase you specified in your request.

            • Targetsrequired — (Array<String>)

              Specify the phrases 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.

            • Sentimentsrequired — (Array<String>)

              Specify the sentiments you want to flag.

            • AbsoluteTimeRange — (map)

              Allows you 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 value you specify in which Amazon Transcribe searches for your specified criteria.

              • Last — (Integer)

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

            • RelativeTimeRange — (map)

              Allows you 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 value you specify in which Amazon Transcribe searches for your specified criteria.

              • Last — (Integer)

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

            • ParticipantRole — (String)

              Specify the participant 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 you didn't include in your request. Set to FALSE to flag the sentiments 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.

Returns:

  • (AWS.Request)

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

getCallAnalyticsJob(params = {}, callback) ⇒ AWS.Request

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.

Service Reference:

Examples:

Calling the getCallAnalyticsJob operation

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"
        • 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 don't 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"
        • 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"
        • Media — (map)

          Describes the Amazon S3 location of the media file you want to use in your 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 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 MediaFormat 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 Guidelines and 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 Guidelines and quotas.

        • 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. If the role 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.

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

          Allows additional optional settings in your request, including content redaction; allows you to apply custom language models, vocabulary filters, and custom vocabularies to your Call Analytics job.

          • VocabularyName — (String)

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

          • VocabularyFilterName — (String)

            The name of the custom vocabulary filter you want to include in your Call Analytics transcription request. 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 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 language model names are case sensitive.

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

          • ContentRedaction — (map)

            Allows you to redact or flag specified personally identifiable information (PII) in your transcript. If you use ContentRedaction, you must also include the sub-parameters: PiiEntityTypes, RedactionOutput, and RedactionType.

            • RedactionTyperequired — (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.

              Possible values include:
              • "PII"
            • RedactionOutputrequired — (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.

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

          • LanguageIdSettings — (map<map>)

            If using automatic language identification (IdentifyLanguage) 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).

            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. Each language code you include can have an associated custom language model, custom vocabulary, and custom vocabulary filter. The languages you specify must match the languages of the specified custom language models, custom vocabularies, and custom vocabulary filters.

            To include language options using IdentifyLanguage without including a custom language model, a custom vocabulary, or a custom vocabulary filter, use LanguageOptions instead of LanguageIdSettings. Including language options can improve the accuracy of automatic language identification.

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

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

            • VocabularyName — (String)

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

              The language of the specified vocabulary must match the language code you specify in your transcription request. If the languages don't match, the 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. Vocabulary filter names are case sensitive.

              The language of the specified vocabulary filter must match the language code you specify in your transcription request. If the languages don't match, the 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 language model names are case sensitive.

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

        • ChannelDefinitions — (Array<map>)

          Allows you to specify which speaker is on which channel in your Call Analytics job request. For example, if your agent is the first participant to speak, you would set ChannelId to 0 (to indicate the first channel) and ParticipantRole to AGENT (to indicate that it's the agent speaking).

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

Returns:

  • (AWS.Request)

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

getMedicalTranscriptionJob(params = {}, callback) ⇒ AWS.Request

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 and 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.

Service Reference:

Examples:

Calling the getMedicalTranscriptionJob operation

var params = {
  MedicalTranscriptionJobName: 'STRING_VALUE' /* required */
};
transcribeservice.getMedicalTranscriptionJob(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 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:

      • MedicalTranscriptionJob — (map)

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

        • MedicalTranscriptionJobName — (String)

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

        • TranscriptionJobStatus — (String)

          Provides the status of the specified medical transcription job.

          If the status is COMPLETED, the job is finished and 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.

          Possible values include:
          • "QUEUED"
          • "IN_PROGRESS"
          • "FAILED"
          • "COMPLETED"
        • LanguageCode — (String)

          The language code used to create your medical transcription job. US English (en-US) is the only supported language for medical transcriptions.

          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"
        • 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"
        • Media — (map)

          Describes the Amazon S3 location of the media file you want to use in your 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 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.
        • StartTime — (Date)

          The date and time the specified medical transcription 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 medical transcription 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 medical transcription 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 TranscriptionJobStatus is FAILED, FailureReason contains information about why the transcription 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 MediaFormat 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 16,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 Guidelines and 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 Guidelines and quotas.

        • Settings — (map)

          Specify additional optional settings in your request, including channel identification, alternative transcriptions, and speaker labeling; allows you to apply custom vocabularies to your medical transcription job.

          • ShowSpeakerLabels — (Boolean)

            Enables speaker identification (diarization) in your transcription output. Speaker identification labels the speech from individual speakers in your media file.

            If you enable ShowSpeakerLabels in your request, you must also include MaxSpeakerLabels.

            You can't include both ShowSpeakerLabels and ChannelIdentification in the same request. Including both parameters returns a BadRequestException.

            For more information, see Identifying speakers (diarization).

          • MaxSpeakerLabels — (Integer)

            Specify the maximum number of speakers you want to identify in your media.

            Note that if your media contains more speakers than the specified number, multiple speakers will be identified as a single speaker.

            If you specify the MaxSpeakerLabels field, you must set the ShowSpeakerLabels field to true.

          • ChannelIdentification — (Boolean)

            Enables channel identification in multi-channel audio.

            Channel identification transcribes the audio on each channel independently, then appends the output for each channel into one transcript.

            If you have multi-channel audio and do not enable channel identification, your audio is transcribed in a continuous manner and your transcript does not separate the speech by channel.

            You can't include both ShowSpeakerLabels and ChannelIdentification in the same request. Including both parameters returns a BadRequestException.

            For more information, see Transcribing multi-channel audio.

          • ShowAlternatives — (Boolean)

            To include alternative transcriptions within your transcription output, include ShowAlternatives in your transcription request.

            If you include ShowAlternatives, you must also include MaxAlternatives, which is the maximum number of alternative transcriptions you want Amazon Transcribe Medical to generate.

            For more information, see Alternative transcriptions.

          • MaxAlternatives — (Integer)

            Indicate the maximum number of alternative transcriptions you want Amazon Transcribe Medical to include in your transcript.

            If you select a number greater than the number of alternative transcriptions generated by Amazon Transcribe Medical, only the actual number of alternative transcriptions are included.

            If you include MaxAlternatives in your request, you must also include ShowAlternatives with a value of true.

            For more information, see Alternative transcriptions.

          • VocabularyName — (String)

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

            The language of the specified vocabulary must match the language code you specify in your transcription request. If the languages don't match, the vocabulary isn't applied. There are no errors or warnings associated with a language mismatch. US English (en-US) is the only valid language for Amazon Transcribe Medical.

        • ContentIdentificationType — (String)

          Labels all personal health information (PHI) identified in your transcript. For more information, see Identifying personal health information (PHI) in a transcription.

          Possible values include:
          • "PHI"
        • Specialty — (String)

          Describes the medical specialty represented in your media.

          Possible values include:
          • "PRIMARYCARE"
        • Type — (String)

          Indicates whether the input media is a dictation or a conversation, as specified in the StartMedicalTranscriptionJob request.

          Possible values include:
          • "CONVERSATION"
          • "DICTATION"
        • Tags — (Array<map>)

          The tags, each in the form of a key:value pair, assigned to the specified medical transcription job.

          • Keyrequired — (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'.

          • Valuerequired — (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.

Returns:

  • (AWS.Request)

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

getMedicalVocabulary(params = {}, callback) ⇒ AWS.Request

Provides information about the specified custom medical vocabulary.

To view the status of the specified medical vocabulary, check the VocabularyState field. If the status is READY, your 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.

Service Reference:

Examples:

Calling the getMedicalVocabulary operation

var params = {
  VocabularyName: 'STRING_VALUE' /* required */
};
transcribeservice.getMedicalVocabulary(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 information about. 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. The data object has the following properties:

      • VocabularyName — (String)

        The name of the custom medical vocabulary you requested information about.

      • LanguageCode — (String)

        The language code you selected for your 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"
      • VocabularyState — (String)

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

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

        The date and time the specified custom medical vocabulary 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.

      • FailureReason — (String)

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

      • DownloadUri — (String)

        The S3 location where the specified medical vocabulary is stored; use this URI to view or download the vocabulary.

Returns:

  • (AWS.Request)

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

getTranscriptionJob(params = {}, callback) ⇒ AWS.Request

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 and 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.

Service Reference:

Examples:

Calling the getTranscriptionJob operation

var params = {
  TranscriptionJobName: 'STRING_VALUE' /* required */
};
transcribeservice.getTranscriptionJob(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 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:

      • TranscriptionJob — (map)

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

        • TranscriptionJobName — (String)

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

        • TranscriptionJobStatus — (String)

          Provides the status of the specified transcription 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"
        • LanguageCode — (String)

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

          Note that you must include one of LanguageCode, IdentifyLanguage, or IdentifyMultipleLanguages in your request. If you include more than one of these parameters, your transcription job fails.

          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"
        • 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"
        • Media — (map)

          Describes the Amazon S3 location of the media file you want to use in your 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 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 transcription 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 transcription 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 transcription 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 TranscriptionJobStatus is FAILED, FailureReason contains information about why the transcription 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 MediaFormat 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 Guidelines and 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 Guidelines and quotas.

        • Settings — (map)

          Specify additional optional settings in your request, including channel identification, alternative transcriptions, speaker labeling; allows you to apply custom vocabularies and vocabulary filters.

          If you want to include a custom vocabulary or a custom vocabulary filter (or both) with your request but do not want to use automatic language identification, use Settings with the VocabularyName or VocabularyFilterName (or both) sub-parameter.

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

          • VocabularyName — (String)

            The name of the custom vocabulary you want to use in your transcription job request. This name is case sensitive, cannot contain spaces, and must be unique within an Amazon Web Services account.

          • ShowSpeakerLabels — (Boolean)

            Enables speaker identification (diarization) in your transcription output. Speaker identification labels the speech from individual speakers in your media file.

            If you enable ShowSpeakerLabels in your request, you must also include MaxSpeakerLabels.

            You can't include both ShowSpeakerLabels and ChannelIdentification in the same request. Including both parameters returns a BadRequestException.

            For more information, see Identifying speakers (diarization).

          • MaxSpeakerLabels — (Integer)

            Specify the maximum number of speakers you want to identify in your media.

            Note that if your media contains more speakers than the specified number, multiple speakers will be identified as a single speaker.

            If you specify the MaxSpeakerLabels field, you must set the ShowSpeakerLabels field to true.

          • ChannelIdentification — (Boolean)

            Enables channel identification in multi-channel audio.

            Channel identification transcribes the audio on each channel independently, then appends the output for each channel into one transcript.

            You can't include both ShowSpeakerLabels and ChannelIdentification in the same request. Including both parameters returns a BadRequestException.

            For more information, see Transcribing multi-channel audio.

          • ShowAlternatives — (Boolean)

            To include alternative transcriptions within your transcription output, include ShowAlternatives in your transcription request.

            If you have multi-channel audio and do not enable channel identification, your audio is transcribed in a continuous manner and your transcript does not separate the speech by channel.

            If you include ShowAlternatives, you must also include MaxAlternatives, which is the maximum number of alternative transcriptions you want Amazon Transcribe to generate.

            For more information, see Alternative transcriptions.

          • MaxAlternatives — (Integer)

            Indicate the maximum number of alternative transcriptions you want Amazon Transcribe to include in your transcript.

            If you select a number greater than the number of alternative transcriptions generated by Amazon Transcribe, only the actual number of alternative transcriptions are included.

            If you include MaxAlternatives in your request, you must also include ShowAlternatives with a value of true.

            For more information, see Alternative transcriptions.

          • VocabularyFilterName — (String)

            The name of the custom vocabulary filter you want to use in your transcription job request. This name is case sensitive, cannot contain spaces, and must be unique within an Amazon Web Services account.

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

          • VocabularyFilterMethod — (String)

            Specify how you want your 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"
        • ModelSettings — (map)

          The custom language model you want to include with your transcription job. If you include ModelSettings in your request, you must include the LanguageModelName sub-parameter.

          • LanguageModelName — (String)

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

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

        • JobExecutionSettings — (map)

          Provides information about how your transcription job is being processed. This parameter shows if your request is queued and what data access role is being used.

          • AllowDeferredExecution — (Boolean)

            Allows you to enable job queuing when your concurrent request limit is exceeded. When AllowDeferredExecution is set to true, transcription job requests are placed in a queue until the number of jobs falls below the concurrent request limit. If AllowDeferredExecution is set to false and the number of transcription job requests exceed the concurrent request limit, you get a LimitExceededException error.

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

            If you include AllowDeferredExecution in your request, you must also include DataAccessRoleArn.

          • 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. If the role 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.

            Note that if you include DataAccessRoleArn in your request, you must also include AllowDeferredExecution.

        • ContentRedaction — (map)

          Redacts or flags specified personally identifiable information (PII) in your transcript.

          • RedactionTyperequired — (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.

            Possible values include:
            • "PII"
          • RedactionOutputrequired — (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.

        • IdentifyLanguage — (Boolean)

          Indicates whether automatic language identification was enabled (TRUE) for the specified transcription job.

        • IdentifyMultipleLanguages — (Boolean)

          Indicates whether automatic multi-language identification was enabled (TRUE) for the specified transcription job.

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

          If you include LanguageOptions in your request, you must also include IdentifyLanguage.

          For more information, refer to Supported languages.

          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.

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

        • LanguageCodes — (Array<map>)

          The language codes used to create your transcription job. This parameter is used with multi-language identification. For single-language identification requests, refer to the singular version of this parameter, LanguageCode.

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

          • LanguageCode — (String)

            Provides the language code for each language identified in your media.

            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"
          • DurationInSeconds — (Float)

            Provides the total time, in seconds, each identified language is spoken in your media.

        • Tags — (Array<map>)

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

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

          • Keyrequired — (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'.

          • Valuerequired — (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.

        • Subtitles — (map)

          Generate subtitles for your media file with your transcription request.

          • Formats — (Array<String>)

            Provides the format of your subtitle files. If your request included both WebVTT (vtt) and SubRip (srt) formats, both formats are shown.

          • SubtitleFileUris — (Array<String>)

            The Amazon S3 location of your transcript. You can use this URI to access or download your subtitle file. Your subtitle file is stored in the same location as your transcript. If you specified both WebVTT and SubRip subtitle formats, two URIs are provided.

            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 subtitle file is stored in a service-managed bucket, and TranscriptFileUri provides you with a temporary URI you can use for secure access to your subtitle file.

            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.
          • OutputStartIndex — (Integer)

            Provides the start index value for your subtitle files. If you did not specify a value in your request, the default value of 0 is used.

        • LanguageIdSettings — (map<map>)

          If using automatic language identification (IdentifyLanguage) 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).

          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. Each language code you include can have an associated custom language model, custom vocabulary, and custom vocabulary filter. The languages you specify must match the languages of the specified custom language models, custom vocabularies, and custom vocabulary filters.

          To include language options using IdentifyLanguage without including a custom language model, a custom vocabulary, or a custom vocabulary filter, use LanguageOptions instead of LanguageIdSettings. Including language options can improve the accuracy of automatic language identification.

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

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

          • VocabularyName — (String)

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

            The language of the specified vocabulary must match the language code you specify in your transcription request. If the languages don't match, the 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. Vocabulary filter names are case sensitive.

            The language of the specified vocabulary filter must match the language code you specify in your transcription request. If the languages don't match, the 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 language model names are case sensitive.

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

Returns:

  • (AWS.Request)

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

getVocabulary(params = {}, callback) ⇒ AWS.Request

Provides information about the specified custom vocabulary.

To view the status of the specified vocabulary, check the VocabularyState field. If the status is READY, your 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 vocabularies, use the operation.

Service Reference:

Examples:

Calling the getVocabulary operation

var params = {
  VocabularyName: 'STRING_VALUE' /* required */
};
transcribeservice.getVocabulary(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 information about. 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. The data object has the following properties:

      • VocabularyName — (String)

        The name of the custom vocabulary you requested information about.

      • 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"
      • VocabularyState — (String)

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

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

        The date and time the specified vocabulary 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.

      • FailureReason — (String)

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

      • DownloadUri — (String)

        The S3 location where the vocabulary is stored; use this URI to view or download the vocabulary.

Returns:

  • (AWS.Request)

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

getVocabularyFilter(params = {}, callback) ⇒ AWS.Request

Provides information about the specified custom vocabulary filter.

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

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

Service Reference:

Examples:

Calling the getVocabularyFilter operation

var params = {
  VocabularyFilterName: 'STRING_VALUE' /* required */
};
transcribeservice.getVocabularyFilter(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 information about. 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. The data object has the following properties:

      • VocabularyFilterName — (String)

        The name of the custom vocabulary filter you requested information about.

      • LanguageCode — (String)

        The language code you selected for your 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"
      • LastModifiedTime — (Date)

        The date and time the specified vocabulary filter 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.

      • DownloadUri — (String)

        The Amazon S3 location where the vocabulary filter is stored; use this URI to view or download the vocabulary filter.

Returns:

  • (AWS.Request)

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

listCallAnalyticsCategories(params = {}, callback) ⇒ AWS.Request

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.

Service Reference:

Examples:

Calling the listCallAnalyticsCategories operation

var params = {
  MaxResults: 'NUMBER_VALUE',
  NextToken: 'STRING_VALUE'
};
transcribeservice.listCallAnalyticsCategories(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: {})
    • NextToken — (String)

      If your ListCallAnalyticsCategories request returns more results than can be displayed, NextToken is displayed in the response with an associated string. To get the next page of results, copy this string and repeat your request, including NextToken with the value of the copied string. Repeat as needed to view all your results.

    • MaxResults — (Integer)

      The maximum number of Call Analytics categories to return in each page of results. If there are fewer results than the value you specify, only the actual results are returned. If you don't specify a value, a default of 5 is used.

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:

      • NextToken — (String)

        If NextToken is present in your response, it indicates that not all results are displayed. To view the next set of results, copy the string associated with the NextToken parameter in your results output, then run your request again including NextToken with the value of the copied string. Repeat as needed to view all your results.

      • Categories — (Array<map>)

        Provides detailed information about your Call Analytics categories, including all the rules associated with each category.

        • 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 you want to flag. For example, you can flag a silent period that lasts 30000 milliseconds.

            • AbsoluteTimeRange — (map)

              Allows you 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 value you specify in which Amazon Transcribe searches for your specified criteria.

              • Last — (Integer)

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

            • RelativeTimeRange — (map)

              Allows you 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 value you specify in which Amazon Transcribe searches for your specified criteria.

              • Last — (Integer)

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

            • 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 10000 milliseconds of interruptions.

            • ParticipantRole — (String)

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

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

              Allows you 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 value you specify in which Amazon Transcribe searches for your specified criteria.

              • Last — (Integer)

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

            • RelativeTimeRange — (map)

              Allows you 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 value you specify in which Amazon Transcribe searches for your specified criteria.

              • Last — (Integer)

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

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

            • TranscriptFilterTyperequired — (String)

              Flag the presence or absence of an exact match to the phrases 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)

              Allows you 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 value you specify in which Amazon Transcribe searches for your specified criteria.

              • Last — (Integer)

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

            • RelativeTimeRange — (map)

              Allows you 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 value you specify in which Amazon Transcribe searches for your specified criteria.

              • Last — (Integer)

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

            • ParticipantRole — (String)

              Specify the participant 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 you specified in your request. Set to FALSE to flag the presence of the phrase you specified in your request.

            • Targetsrequired — (Array<String>)

              Specify the phrases 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.

            • Sentimentsrequired — (Array<String>)

              Specify the sentiments you want to flag.

            • AbsoluteTimeRange — (map)

              Allows you 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 value you specify in which Amazon Transcribe searches for your specified criteria.

              • Last — (Integer)

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

            • RelativeTimeRange — (map)

              Allows you 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 value you specify in which Amazon Transcribe searches for your specified criteria.

              • Last — (Integer)

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

            • ParticipantRole — (String)

              Specify the participant 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 you didn't include in your request. Set to FALSE to flag the sentiments 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.

Returns:

  • (AWS.Request)

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

listCallAnalyticsJobs(params = {}, callback) ⇒ AWS.Request

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.

Service Reference:

Examples:

Calling the listCallAnalyticsJobs operation

var params = {
  JobNameContains: 'STRING_VALUE',
  MaxResults: 'NUMBER_VALUE',
  NextToken: 'STRING_VALUE',
  Status: QUEUED | IN_PROGRESS | FAILED | COMPLETED
};
transcribeservice.listCallAnalyticsJobs(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: {})
    • Status — (String)

      Returns only Call Analytics jobs with the specified status. Jobs are ordered by creation date, with the newest job first. If you don't include Status, all Call Analytics jobs are returned.

      Possible values include:
      • "QUEUED"
      • "IN_PROGRESS"
      • "FAILED"
      • "COMPLETED"
    • JobNameContains — (String)

      Returns only the Call Analytics jobs that contain the specified string. The search is not case sensitive.

    • NextToken — (String)

      If your ListCallAnalyticsJobs request returns more results than can be displayed, NextToken is displayed in the response with an associated string. To get the next page of results, copy this string and repeat your request, including NextToken with the value of the copied string. Repeat as needed to view all your results.

    • MaxResults — (Integer)

      The maximum number of Call Analytics jobs to return in each page of results. If there are fewer results than the value you specify, only the actual results are returned. If you don't specify a value, a default of 5 is used.

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:

      • Status — (String)

        Lists all Call Analytics jobs that have the status specified in your request. Jobs are ordered by creation date, with the newest job first.

        Possible values include:
        • "QUEUED"
        • "IN_PROGRESS"
        • "FAILED"
        • "COMPLETED"
      • NextToken — (String)

        If NextToken is present in your response, it indicates that not all results are displayed. To view the next set of results, copy the string associated with the NextToken parameter in your results output, then run your request again including NextToken with the value of the copied string. Repeat as needed to view all your results.

      • CallAnalyticsJobSummaries — (Array<map>)

        Provides a summary of information about each result.

        • CallAnalyticsJobName — (String)

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

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

        • StartTime — (Date)

          The date and time your 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.

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

        • LanguageCode — (String)

          The language code used to create your Call Analytics 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"
        • CallAnalyticsJobStatus — (String)

          Provides the status of your 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"
        • FailureReason — (String)

          If CallAnalyticsJobStatus is FAILED, FailureReason contains information about why the Call Analytics job failed. See also: Common Errors.

Returns:

  • (AWS.Request)

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

listLanguageModels(params = {}, callback) ⇒ AWS.Request

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

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

Service Reference:

Examples:

Calling the listLanguageModels operation

var params = {
  MaxResults: 'NUMBER_VALUE',
  NameContains: 'STRING_VALUE',
  NextToken: 'STRING_VALUE',
  StatusEquals: IN_PROGRESS | FAILED | COMPLETED
};
transcribeservice.listLanguageModels(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: {})
    • StatusEquals — (String)

      Returns only custom language models with the specified status. Language models are ordered by creation date, with the newest model first. If you don't include StatusEquals, all custom language models are returned.

      Possible values include:
      • "IN_PROGRESS"
      • "FAILED"
      • "COMPLETED"
    • NameContains — (String)

      Returns only the custom language models that contain the specified string. The search is not case sensitive.

    • NextToken — (String)

      If your ListLanguageModels request returns more results than can be displayed, NextToken is displayed in the response with an associated string. To get the next page of results, copy this string and repeat your request, including NextToken with the value of the copied string. Repeat as needed to view all your results.

    • MaxResults — (Integer)

      The maximum number of custom language models to return in each page of results. If there are fewer results than the value you specify, only the actual results are returned. If you don't specify a value, a default of 5 is used.

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:

      • NextToken — (String)

        If NextToken is present in your response, it indicates that not all results are displayed. To view the next set of results, copy the string associated with the NextToken parameter in your results output, then run your request again including NextToken with the value of the copied string. Repeat as needed to view all your results.

      • Models — (Array<map>)

        Provides information about the custom language models that match the criteria specified in your request.

        • 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 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 language model must contain terms in only one language, and the language you select for your 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 U.S. 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"
        • 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 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.

          • S3Urirequired — (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/

          • DataAccessRoleArnrequired — (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 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.

listMedicalTranscriptionJobs(params = {}, callback) ⇒ AWS.Request

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.

Service Reference:

Examples:

Calling the listMedicalTranscriptionJobs operation

var params = {
  JobNameContains: 'STRING_VALUE',
  MaxResults: 'NUMBER_VALUE',
  NextToken: 'STRING_VALUE',
  Status: QUEUED | IN_PROGRESS | FAILED | COMPLETED
};
transcribeservice.listMedicalTranscriptionJobs(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: {})
    • Status — (String)

      Returns only medical transcription jobs with the specified status. Jobs are ordered by creation date, with the newest job first. If you don't include Status, all medical transcription jobs are returned.

      Possible values include:
      • "QUEUED"
      • "IN_PROGRESS"
      • "FAILED"
      • "COMPLETED"
    • JobNameContains — (String)

      Returns only the medical transcription jobs that contain the specified string. The search is not case sensitive.

    • NextToken — (String)

      If your ListMedicalTranscriptionJobs request returns more results than can be displayed, NextToken is displayed in the response with an associated string. To get the next page of results, copy this string and repeat your request, including NextToken with the value of the copied string. Repeat as needed to view all your results.

    • MaxResults — (Integer)

      The maximum number of medical transcription jobs to return in each page of results. If there are fewer results than the value you specify, only the actual results are returned. If you don't specify a value, a default of 5 is used.

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:

      • Status — (String)

        Lists all medical transcription jobs that have the status specified in your request. Jobs are ordered by creation date, with the newest job first.

        Possible values include:
        • "QUEUED"
        • "IN_PROGRESS"
        • "FAILED"
        • "COMPLETED"
      • NextToken — (String)

        If NextToken is present in your response, it indicates that not all results are displayed. To view the next set of results, copy the string associated with the NextToken parameter in your results output, then run your request again including NextToken with the value of the copied string. Repeat as needed to view all your results.

      • MedicalTranscriptionJobSummaries — (Array<map>)

        Provides a summary of information about each result.

        • MedicalTranscriptionJobName — (String)

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

        • CreationTime — (Date)

          The date and time the specified medical transcription 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.

        • StartTime — (Date)

          The date and time your medical transcription 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.

        • CompletionTime — (Date)

          The date and time the specified medical transcription 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.

        • LanguageCode — (String)

          The language code used to create your medical transcription. US English (en-US) is the only supported language for medical transcriptions.

          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"
        • TranscriptionJobStatus — (String)

          Provides the status of your medical transcription job.

          If the status is COMPLETED, the job is finished and 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.

          Possible values include:
          • "QUEUED"
          • "IN_PROGRESS"
          • "FAILED"
          • "COMPLETED"
        • FailureReason — (String)

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

        • OutputLocationType — (String)

          Indicates where the specified medical transcription output is stored.

          If the value is CUSTOMER_BUCKET, the location is the Amazon S3 bucket you specified using the OutputBucketName parameter in your request. If you also included OutputKey in your request, your output is located in the path you specified in your request.

          If the value is SERVICE_BUCKET, the location is a service-managed Amazon S3 bucket. To access a transcript stored in a service-managed bucket, use the URI shown in the TranscriptFileUri field.

          Possible values include:
          • "CUSTOMER_BUCKET"
          • "SERVICE_BUCKET"
        • Specialty — (String)

          Provides the medical specialty represented in your media.

          Possible values include:
          • "PRIMARYCARE"
        • ContentIdentificationType — (String)

          Labels all personal health information (PHI) identified in your transcript. For more information, see Identifying personal health information (PHI) in a transcription.

          Possible values include:
          • "PHI"
        • Type — (String)

          Indicates whether the input media is a dictation or a conversation, as specified in the StartMedicalTranscriptionJob request.

          Possible values include:
          • "CONVERSATION"
          • "DICTATION"

Returns:

  • (AWS.Request)

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

listMedicalVocabularies(params = {}, callback) ⇒ AWS.Request

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.

Service Reference:

Examples:

Calling the listMedicalVocabularies operation

var params = {
  MaxResults: 'NUMBER_VALUE',
  NameContains: 'STRING_VALUE',
  NextToken: 'STRING_VALUE',
  StateEquals: PENDING | READY | FAILED
};
transcribeservice.listMedicalVocabularies(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: {})
    • NextToken — (String)

      If your ListMedicalVocabularies request returns more results than can be displayed, NextToken is displayed in the response with an associated string. To get the next page of results, copy this string and repeat your request, including NextToken with the value of the copied string. Repeat as needed to view all your results.

    • MaxResults — (Integer)

      The maximum number of custom medical vocabularies to return in each page of results. If there are fewer results than the value you specify, only the actual results are returned. If you don't specify a value, a default of 5 is used.

    • StateEquals — (String)

      Returns only custom medical vocabularies with the specified state. Vocabularies are ordered by creation date, with the newest vocabulary first. If you don't include StateEquals, all custom medical vocabularies are returned.

      Possible values include:
      • "PENDING"
      • "READY"
      • "FAILED"
    • NameContains — (String)

      Returns only the custom medical vocabularies that contain the specified string. The search is not 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:

      • Status — (String)

        Lists all custom medical vocabularies that have the status specified in your request. Vocabularies are ordered by creation date, with the newest vocabulary first.

        Possible values include:
        • "PENDING"
        • "READY"
        • "FAILED"
      • NextToken — (String)

        If NextToken is present in your response, it indicates that not all results are displayed. To view the next set of results, copy the string associated with the NextToken parameter in your results output, then run your request again including NextToken with the value of the copied string. Repeat as needed to view all your results.

      • Vocabularies — (Array<map>)

        Provides information about the custom medical vocabularies that match the criteria specified in your request.

        • VocabularyName — (String)

          A unique name, chosen by you, for your custom vocabulary. This name is case sensitive, cannot contain spaces, and must be unique within an Amazon Web Services account.

        • LanguageCode — (String)

          The language code used to create your custom vocabulary. Each vocabulary must contain terms in only one language.

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

          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"
        • LastModifiedTime — (Date)

          The date and time the specified vocabulary 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.

        • VocabularyState — (String)

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

          Possible values include:
          • "PENDING"
          • "READY"
          • "FAILED"

Returns:

  • (AWS.Request)

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

listTagsForResource(params = {}, callback) ⇒ AWS.Request

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.

Service Reference:

Examples:

Calling the listTagsForResource operation

var params = {
  ResourceArn: 'STRING_VALUE' /* required */
};
transcribeservice.listTagsForResource(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: {})
    • ResourceArn — (String)

      Returns a list of all tags associated with the specified Amazon Resource Name (ARN). ARNs have the format arn:partition:service:region:account-id:resource-type/resource-id.

      For example, arn:aws:transcribe:us-west-2:account-id:transcription-job/transcription-job-name.

      Valid values for resource-type are: transcription-job, medical-transcription-job, vocabulary, medical-vocabulary, vocabulary-filter, and language-model.

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:

      • ResourceArn — (String)

        The Amazon Resource Name (ARN) specified in your request.

      • Tags — (Array<map>)

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

        • Keyrequired — (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'.

        • Valuerequired — (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.

Returns:

  • (AWS.Request)

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

listTranscriptionJobs(params = {}, callback) ⇒ AWS.Request

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.

Service Reference:

Examples:

Calling the listTranscriptionJobs operation

var params = {
  JobNameContains: 'STRING_VALUE',
  MaxResults: 'NUMBER_VALUE',
  NextToken: 'STRING_VALUE',
  Status: QUEUED | IN_PROGRESS | FAILED | COMPLETED
};
transcribeservice.listTranscriptionJobs(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: {})
    • Status — (String)

      Returns only transcription jobs with the specified status. Jobs are ordered by creation date, with the newest job first. If you don't include Status, all transcription jobs are returned.

      Possible values include:
      • "QUEUED"
      • "IN_PROGRESS"
      • "FAILED"
      • "COMPLETED"
    • JobNameContains — (String)

      Returns only the transcription jobs that contain the specified string. The search is not case sensitive.

    • NextToken — (String)

      If your ListTranscriptionJobs request returns more results than can be displayed, NextToken is displayed in the response with an associated string. To get the next page of results, copy this string and repeat your request, including NextToken with the value of the copied string. Repeat as needed to view all your results.

    • MaxResults — (Integer)

      The maximum number of transcription jobs to return in each page of results. If there are fewer results than the value you specify, only the actual results are returned. If you don't specify a value, a default of 5 is used.

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:

      • Status — (String)

        Lists all transcription jobs that have the status specified in your request. Jobs are ordered by creation date, with the newest job first.

        Possible values include:
        • "QUEUED"
        • "IN_PROGRESS"
        • "FAILED"
        • "COMPLETED"
      • NextToken — (String)

        If NextToken is present in your response, it indicates that not all results are displayed. To view the next set of results, copy the string associated with the NextToken parameter in your results output, then run your request again including NextToken with the value of the copied string. Repeat as needed to view all your results.

      • TranscriptionJobSummaries — (Array<map>)

        Provides a summary of information about each result.

        • TranscriptionJobName — (String)

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

        • CreationTime — (Date)

          The date and time the specified transcription 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.

        • StartTime — (Date)

          The date and time your transcription 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.

        • CompletionTime — (Date)

          The date and time the specified transcription 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.

        • LanguageCode — (String)

          The language code used to create 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"
        • TranscriptionJobStatus — (String)

          Provides the status of your transcription 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"
        • FailureReason — (String)

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

        • OutputLocationType — (String)

          Indicates where the specified transcription output is stored.

          If the value is CUSTOMER_BUCKET, the location is the Amazon S3 bucket you specified using the OutputBucketName parameter in your request. If you also included OutputKey in your request, your output is located in the path you specified in your request.

          If the value is SERVICE_BUCKET, the location is a service-managed Amazon S3 bucket. To access a transcript stored in a service-managed bucket, use the URI shown in the TranscriptFileUri or RedactedTranscriptFileUri field.

          Possible values include:
          • "CUSTOMER_BUCKET"
          • "SERVICE_BUCKET"
        • ContentRedaction — (map)

          The content redaction settings of the transcription job.

          • RedactionTyperequired — (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.

            Possible values include:
            • "PII"
          • RedactionOutputrequired — (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.

        • ModelSettings — (map)

          Provides the name of the custom language model that was included in the specified transcription job.

          Only use ModelSettings with the LanguageModelName sub-parameter if you're not using automatic language identification (). If using LanguageIdSettings in your request, this parameter contains a LanguageModelName sub-parameter.

          • LanguageModelName — (String)

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

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

        • IdentifyLanguage — (Boolean)

          Indicates whether automatic language identification was enabled (TRUE) for the specified transcription job.

        • IdentifyMultipleLanguages — (Boolean)

          Indicates whether automatic multi-language identification was enabled (TRUE) for the specified transcription job.

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

        • LanguageCodes — (Array<map>)

          The language codes used to create your transcription job. This parameter is used with multi-language identification. For single-language identification, the singular version of this parameter, LanguageCode, is present.

          • LanguageCode — (String)

            Provides the language code for each language identified in your media.

            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"
          • DurationInSeconds — (Float)

            Provides the total time, in seconds, each identified language is spoken in your media.

Returns:

  • (AWS.Request)

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

listVocabularies(params = {}, callback) ⇒ AWS.Request

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.

Service Reference:

Examples:

Calling the listVocabularies operation

var params = {
  MaxResults: 'NUMBER_VALUE',
  NameContains: 'STRING_VALUE',
  NextToken: 'STRING_VALUE',
  StateEquals: PENDING | READY | FAILED
};
transcribeservice.listVocabularies(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: {})
    • NextToken — (String)

      If your ListVocabularies request returns more results than can be displayed, NextToken is displayed in the response with an associated string. To get the next page of results, copy this string and repeat your request, including NextToken with the value of the copied string. Repeat as needed to view all your results.

    • MaxResults — (Integer)

      The maximum number of custom vocabularies to return in each page of results. If there are fewer results than the value you specify, only the actual results are returned. If you don't specify a value, a default of 5 is used.

    • StateEquals — (String)

      Returns only custom vocabularies with the specified state. Vocabularies are ordered by creation date, with the newest vocabulary first. If you don't include StateEquals, all custom medical vocabularies are returned.

      Possible values include:
      • "PENDING"
      • "READY"
      • "FAILED"
    • NameContains — (String)

      Returns only the custom vocabularies that contain the specified string. The search is not 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:

      • Status — (String)

        Lists all custom vocabularies that have the status specified in your request. Vocabularies are ordered by creation date, with the newest vocabulary first.

        Possible values include:
        • "PENDING"
        • "READY"
        • "FAILED"
      • NextToken — (String)

        If NextToken is present in your response, it indicates that not all results are displayed. To view the next set of results, copy the string associated with the NextToken parameter in your results output, then run your request again including NextToken with the value of the copied string. Repeat as needed to view all your results.

      • Vocabularies — (Array<map>)

        Provides information about the custom vocabularies that match the criteria specified in your request.

        • VocabularyName — (String)

          A unique name, chosen by you, for your custom vocabulary. This name is case sensitive, cannot contain spaces, and must be unique within an Amazon Web Services account.

        • LanguageCode — (String)

          The language code used to create your custom vocabulary. Each vocabulary must contain terms in only one language.

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

          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"
        • LastModifiedTime — (Date)

          The date and time the specified vocabulary 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.

        • VocabularyState — (String)

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

          Possible values include:
          • "PENDING"
          • "READY"
          • "FAILED"

Returns:

  • (AWS.Request)

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

listVocabularyFilters(params = {}, callback) ⇒ AWS.Request

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.

Service Reference:

Examples:

Calling the listVocabularyFilters operation

var params = {
  MaxResults: 'NUMBER_VALUE',
  NameContains: 'STRING_VALUE',
  NextToken: 'STRING_VALUE'
};
transcribeservice.listVocabularyFilters(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: {})
    • NextToken — (String)

      If your ListVocabularyFilters request returns more results than can be displayed, NextToken is displayed in the response with an associated string. To get the next page of results, copy this string and repeat your request, including NextToken with the value of the copied string. Repeat as needed to view all your results.

    • MaxResults — (Integer)

      The maximum number of custom vocabulary filters to return in each page of results. If there are fewer results than the value you specify, only the actual results are returned. If you don't specify a value, a default of 5 is used.

    • NameContains — (String)

      Returns only the custom vocabulary filters that contain the specified string. The search is not 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:

      • NextToken — (String)

        If NextToken is present in your response, it indicates that not all results are displayed. To view the next set of results, copy the string associated with the NextToken parameter in your results output, then run your request again including NextToken with the value of the copied string. Repeat as needed to view all your results.

      • VocabularyFilters — (Array<map>)

        Provides information about the custom vocabulary filters that match the criteria specified in your request.

        • VocabularyFilterName — (String)

          A unique name, chosen by you, for your custom vocabulary filter. This name is case sensitive, cannot contain spaces, and must be unique within an Amazon Web Services account.

        • LanguageCode — (String)

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

          A vocabulary filter can only be used to transcribe files in the same language as the filter. For example, if you create a 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"
        • LastModifiedTime — (Date)

          The date and time the specified vocabulary filter 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.

Returns:

  • (AWS.Request)

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

startCallAnalyticsJob(params = {}, callback) ⇒ AWS.Request

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 of the 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.

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.

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 you create for your transcription job that is 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.

Note: 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.

Service Reference:

Examples:

Calling the startCallAnalyticsJob operation

var params = {
  CallAnalyticsJobName: 'STRING_VALUE', /* required */
  Media: { /* required */
    MediaFileUri: 'STRING_VALUE',
    RedactedMediaFileUri: 'STRING_VALUE'
  },
  ChannelDefinitions: [
    {
      ChannelId: 'NUMBER_VALUE',
      ParticipantRole: AGENT | CUSTOMER
    },
    /* more items */
  ],
  DataAccessRoleArn: 'STRING_VALUE',
  OutputEncryptionKMSKeyId: 'STRING_VALUE',
  OutputLocation: 'STRING_VALUE',
  Settings: {
    ContentRedaction: {
      RedactionOutput: redacted | redacted_and_unredacted, /* required */
      RedactionType: PII, /* required */
      PiiEntityTypes: [
        BANK_ACCOUNT_NUMBER | BANK_ROUTING | CREDIT_DEBIT_NUMBER | CREDIT_DEBIT_CVV | CREDIT_DEBIT_EXPIRY | PIN | EMAIL | ADDRESS | NAME | PHONE | SSN | ALL,
        /* more items */
      ]
    },
    LanguageIdSettings: {
      '<LanguageCode>': {
        LanguageModelName: 'STRING_VALUE',
        VocabularyFilterName: 'STRING_VALUE',
        VocabularyName: 'STRING_VALUE'
      },
      /* '<LanguageCode>': ... */
    },
    LanguageModelName: 'STRING_VALUE',
    LanguageOptions: [
      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,
      /* more items */
    ],
    VocabularyFilterMethod: remove | mask | tag,
    VocabularyFilterName: 'STRING_VALUE',
    VocabularyName: 'STRING_VALUE'
  }
};
transcribeservice.startCallAnalyticsJob(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)

      A unique name, chosen by you, for your Call Analytics job.

      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 job with the same name as an existing job, you get a ConflictException error.

    • Media — (map)

      Describes the Amazon S3 location of the media file you want to use in your 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 is only supported for Call Analytics (StartCallAnalyticsJob) transcription requests.

    • OutputLocation — (String)

      The Amazon S3 location where you want your Call Analytics transcription output stored. You can use any of the following formats to specify the output location:

      1. s3://DOC-EXAMPLE-BUCKET

      2. s3://DOC-EXAMPLE-BUCKET/my-output-folder/

      3. s3://DOC-EXAMPLE-BUCKET/my-output-folder/my-call-analytics-job.json

      Unless you specify a file name (option 3), the name of your output file has a default value that matches the name you specified for your transcription job using the CallAnalyticsJobName parameter.

      You can specify a KMS key to encrypt your output using the OutputEncryptionKMSKeyId parameter. If you don't specify a KMS key, Amazon Transcribe uses the default Amazon S3 key for server-side encryption.

      If you don't specify OutputLocation, your transcript is placed in a service-managed Amazon S3 bucket and you are provided with a URI to access your transcript.

    • OutputEncryptionKMSKeyId — (String)

      The KMS key you want to use to encrypt your Call Analytics output.

      If using a key located in the current Amazon Web Services account, you can specify your KMS key in one of four ways:

      1. Use the KMS key ID itself. For example, 1234abcd-12ab-34cd-56ef-1234567890ab.

      2. Use an alias for the KMS key ID. For example, alias/ExampleAlias.

      3. Use the Amazon Resource Name (ARN) for the KMS key ID. For example, arn:aws:kms:region:account-ID:key/1234abcd-12ab-34cd-56ef-1234567890ab.

      4. Use the ARN for the KMS key alias. For example, arn:aws:kms:region:account-ID:alias/ExampleAlias.

      If using a key located in a different Amazon Web Services account than the current Amazon Web Services account, you can specify your KMS key in one of two ways:

      1. Use the ARN for the KMS key ID. For example, arn:aws:kms:region:account-ID:key/1234abcd-12ab-34cd-56ef-1234567890ab.

      2. Use the ARN for the KMS key alias. For example, arn:aws:kms:region:account-ID:alias/ExampleAlias.

      If you don't specify an encryption key, your output is encrypted with the default Amazon S3 key (SSE-S3).

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

      Note that the user making the request must have permission to use the specified KMS key.

    • 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. If the role 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.

    • Settings — (map)

      Specify additional optional settings in your request, including content redaction; allows you to apply custom language models, vocabulary filters, and custom vocabularies to your Call Analytics job.

      • VocabularyName — (String)

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

      • VocabularyFilterName — (String)

        The name of the custom vocabulary filter you want to include in your Call Analytics transcription request. 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 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 language model names are case sensitive.

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

      • ContentRedaction — (map)

        Allows you to redact or flag specified personally identifiable information (PII) in your transcript. If you use ContentRedaction, you must also include the sub-parameters: PiiEntityTypes, RedactionOutput, and RedactionType.

        • RedactionTyperequired — (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.

          Possible values include:
          • "PII"
        • RedactionOutputrequired — (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.

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

      • LanguageIdSettings — (map<map>)

        If using automatic language identification (IdentifyLanguage) 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).

        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. Each language code you include can have an associated custom language model, custom vocabulary, and custom vocabulary filter. The languages you specify must match the languages of the specified custom language models, custom vocabularies, and custom vocabulary filters.

        To include language options using IdentifyLanguage without including a custom language model, a custom vocabulary, or a custom vocabulary filter, use LanguageOptions instead of LanguageIdSettings. Including language options can improve the accuracy of automatic language identification.

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

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

        • VocabularyName — (String)

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

          The language of the specified vocabulary must match the language code you specify in your transcription request. If the languages don't match, the 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. Vocabulary filter names are case sensitive.

          The language of the specified vocabulary filter must match the language code you specify in your transcription request. If the languages don't match, the 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 language model names are case sensitive.

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

    • ChannelDefinitions — (Array<map>)

      Allows you to specify which speaker is on which channel. For example, if your agent is the first participant to speak, you would set ChannelId to 0 (to indicate the first channel) and ParticipantRole to AGENT (to indicate that it's the agent speaking).

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

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 current 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"
        • 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 don't 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"
        • 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"
        • Media — (map)

          Describes the Amazon S3 location of the media file you want to use in your 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 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 MediaFormat 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 Guidelines and 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 Guidelines and quotas.

        • 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. If the role 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.

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

          Allows additional optional settings in your request, including content redaction; allows you to apply custom language models, vocabulary filters, and custom vocabularies to your Call Analytics job.

          • VocabularyName — (String)

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

          • VocabularyFilterName — (String)

            The name of the custom vocabulary filter you want to include in your Call Analytics transcription request. 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 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 language model names are case sensitive.

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

          • ContentRedaction — (map)

            Allows you to redact or flag specified personally identifiable information (PII) in your transcript. If you use ContentRedaction, you must also include the sub-parameters: PiiEntityTypes, RedactionOutput, and RedactionType.

            • RedactionTyperequired — (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.

              Possible values include:
              • "PII"
            • RedactionOutputrequired — (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.

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

          • LanguageIdSettings — (map<map>)

            If using automatic language identification (IdentifyLanguage) 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).

            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. Each language code you include can have an associated custom language model, custom vocabulary, and custom vocabulary filter. The languages you specify must match the languages of the specified custom language models, custom vocabularies, and custom vocabulary filters.

            To include language options using IdentifyLanguage without including a custom language model, a custom vocabulary, or a custom vocabulary filter, use LanguageOptions instead of LanguageIdSettings. Including language options can improve the accuracy of automatic language identification.

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

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

            • VocabularyName — (String)

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

              The language of the specified vocabulary must match the language code you specify in your transcription request. If the languages don't match, the 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. Vocabulary filter names are case sensitive.

              The language of the specified vocabulary filter must match the language code you specify in your transcription request. If the languages don't match, the 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 language model names are case sensitive.

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

        • ChannelDefinitions — (Array<map>)

          Allows you to specify which speaker is on which channel in your Call Analytics job request. For example, if your agent is the first participant to speak, you would set ChannelId to 0 (to indicate the first channel) and ParticipantRole to AGENT (to indicate that it's the agent speaking).

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

Returns:

  • (AWS.Request)

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

startMedicalTranscriptionJob(params = {}, callback) ⇒ AWS.Request

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 of the 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 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.

Service Reference:

Examples:

Calling the startMedicalTranscriptionJob operation

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, /* required */
  Media: { /* required */
    MediaFileUri: 'STRING_VALUE',
    RedactedMediaFileUri: 'STRING_VALUE'
  },
  MedicalTranscriptionJobName: 'STRING_VALUE', /* required */
  OutputBucketName: 'STRING_VALUE', /* required */
  Specialty: PRIMARYCARE, /* required */
  Type: CONVERSATION | DICTATION, /* required */
  ContentIdentificationType: PHI,
  KMSEncryptionContext: {
    '<NonEmptyString>': 'STRING_VALUE',
    /* '<NonEmptyString>': ... */
  },
  MediaFormat: mp3 | mp4 | wav | flac | ogg | amr | webm,
  MediaSampleRateHertz: 'NUMBER_VALUE',
  OutputEncryptionKMSKeyId: 'STRING_VALUE',
  OutputKey: 'STRING_VALUE',
  Settings: {
    ChannelIdentification: true || false,
    MaxAlternatives: 'NUMBER_VALUE',
    MaxSpeakerLabels: 'NUMBER_VALUE',
    ShowAlternatives: true || false,
    ShowSpeakerLabels: true || false,
    VocabularyName: 'STRING_VALUE'
  },
  Tags: [
    {
      Key: 'STRING_VALUE', /* required */
      Value: 'STRING_VALUE' /* required */
    },
    /* more items */
  ]
};
transcribeservice.startMedicalTranscriptionJob(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)

      A unique name, chosen by you, for your medical transcription job. The name you specify is also used as the default name of your transcription output file. If you want to specify a different name for your transcription output, use the OutputKey parameter.

      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 job with the same name as an existing job, you get a ConflictException error.

    • LanguageCode — (String)

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

      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"
    • MediaSampleRateHertz — (Integer)

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

      If you don't specify the media sample rate, Amazon Transcribe Medical determines it for you. If you specify the sample rate, it must match the rate detected by Amazon Transcribe Medical; if there's a mismatch between the value you specify and the value detected, your job fails. Therefore, in most cases, it's advised to omit MediaSampleRateHertz and let Amazon Transcribe Medical determine the sample rate.

    • MediaFormat — (String)

      Specify the format of your input media file.

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

      Describes the Amazon S3 location of the media file you want to use in your 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 is only supported for Call Analytics (StartCallAnalyticsJob) transcription requests.

    • OutputBucketName — (String)

      The name of the Amazon S3 bucket where you want your medical transcription output stored. Do not include the S3:// prefix of the specified bucket.

      If you want your output to go to a sub-folder of this bucket, specify it using the OutputKey parameter; OutputBucketName only accepts the name of a bucket.

      For example, if you want your output stored in S3://DOC-EXAMPLE-BUCKET, set OutputBucketName to DOC-EXAMPLE-BUCKET. However, if you want your output stored in S3://DOC-EXAMPLE-BUCKET/test-files/, set OutputBucketName to DOC-EXAMPLE-BUCKET and OutputKey to test-files/.

      Note that Amazon Transcribe must have permission to use the specified location. You can change Amazon S3 permissions using the Amazon Web Services Management Console. See also Permissions Required for IAM User Roles.

      If you don't specify OutputBucketName, your transcript is placed in a service-managed Amazon S3 bucket and you are provided with a URI to access your transcript.

    • OutputKey — (String)

      Use in combination with OutputBucketName to specify the output location of your transcript and, optionally, a unique name for your output file. The default name for your transcription output is the same as the name you specified for your medical transcription job (MedicalTranscriptionJobName).

      Here are some examples of how you can use OutputKey:

      • If you specify 'DOC-EXAMPLE-BUCKET' as the OutputBucketName and 'my-transcript.json' as the OutputKey, your transcription output path is s3://DOC-EXAMPLE-BUCKET/my-transcript.json.

      • If you specify 'my-first-transcription' as the MedicalTranscriptionJobName, 'DOC-EXAMPLE-BUCKET' as the OutputBucketName, and 'my-transcript' as the OutputKey, your transcription output path is s3://DOC-EXAMPLE-BUCKET/my-transcript/my-first-transcription.json.

      • If you specify 'DOC-EXAMPLE-BUCKET' as the OutputBucketName and 'test-files/my-transcript.json' as the OutputKey, your transcription output path is s3://DOC-EXAMPLE-BUCKET/test-files/my-transcript.json.

      • If you specify 'my-first-transcription' as the MedicalTranscriptionJobName, 'DOC-EXAMPLE-BUCKET' as the OutputBucketName, and 'test-files/my-transcript' as the OutputKey, your transcription output path is s3://DOC-EXAMPLE-BUCKET/test-files/my-transcript/my-first-transcription.json.

      If you specify the name of an Amazon S3 bucket sub-folder that doesn't exist, one is created for you.

    • OutputEncryptionKMSKeyId — (String)

      The KMS key you want to use to encrypt your medical transcription output.

      If using a key located in the current Amazon Web Services account, you can specify your KMS key in one of four ways:

      1. Use the KMS key ID itself. For example, 1234abcd-12ab-34cd-56ef-1234567890ab.

      2. Use an alias for the KMS key ID. For example, alias/ExampleAlias.

      3. Use the Amazon Resource Name (ARN) for the KMS key ID. For example, arn:aws:kms:region:account-ID:key/1234abcd-12ab-34cd-56ef-1234567890ab.

      4. Use the ARN for the KMS key alias. For example, arn:aws:kms:region:account-ID:alias/ExampleAlias.

      If using a key located in a different Amazon Web Services account than the current Amazon Web Services account, you can specify your KMS key in one of two ways:

      1. Use the ARN for the KMS key ID. For example, arn:aws:kms:region:account-ID:key/1234abcd-12ab-34cd-56ef-1234567890ab.

      2. Use the ARN for the KMS key alias. For example, arn:aws:kms:region:account-ID:alias/ExampleAlias.

      If you don't specify an encryption key, your output is encrypted with the default Amazon S3 key (SSE-S3).

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

      Note that the user making the request must have permission to use the specified KMS key.

    • KMSEncryptionContext — (map<String>)

      A map of plain text, non-secret key:value pairs, known as encryption context pairs, that provide an added layer of security for your data. For more information, see KMS encryption context and Asymmetric keys in KMS.

    • Settings — (map)

      Specify additional optional settings in your request, including channel identification, alternative transcriptions, and speaker labeling; allows you to apply custom vocabularies to your transcription job.

      • ShowSpeakerLabels — (Boolean)

        Enables speaker identification (diarization) in your transcription output. Speaker identification labels the speech from individual speakers in your media file.

        If you enable ShowSpeakerLabels in your request, you must also include MaxSpeakerLabels.

        You can't include both ShowSpeakerLabels and ChannelIdentification in the same request. Including both parameters returns a BadRequestException.

        For more information, see Identifying speakers (diarization).

      • MaxSpeakerLabels — (Integer)

        Specify the maximum number of speakers you want to identify in your media.

        Note that if your media contains more speakers than the specified number, multiple speakers will be identified as a single speaker.

        If you specify the MaxSpeakerLabels field, you must set the ShowSpeakerLabels field to true.

      • ChannelIdentification — (Boolean)

        Enables channel identification in multi-channel audio.

        Channel identification transcribes the audio on each channel independently, then appends the output for each channel into one transcript.

        If you have multi-channel audio and do not enable channel identification, your audio is transcribed in a continuous manner and your transcript does not separate the speech by channel.

        You can't include both ShowSpeakerLabels and ChannelIdentification in the same request. Including both parameters returns a BadRequestException.

        For more information, see Transcribing multi-channel audio.

      • ShowAlternatives — (Boolean)

        To include alternative transcriptions within your transcription output, include ShowAlternatives in your transcription request.

        If you include ShowAlternatives, you must also include MaxAlternatives, which is the maximum number of alternative transcriptions you want Amazon Transcribe Medical to generate.

        For more information, see Alternative transcriptions.

      • MaxAlternatives — (Integer)

        Indicate the maximum number of alternative transcriptions you want Amazon Transcribe Medical to include in your transcript.

        If you select a number greater than the number of alternative transcriptions generated by Amazon Transcribe Medical, only the actual number of alternative transcriptions are included.

        If you include MaxAlternatives in your request, you must also include ShowAlternatives with a value of true.

        For more information, see Alternative transcriptions.

      • VocabularyName — (String)

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

        The language of the specified vocabulary must match the language code you specify in your transcription request. If the languages don't match, the vocabulary isn't applied. There are no errors or warnings associated with a language mismatch. US English (en-US) is the only valid language for Amazon Transcribe Medical.

    • ContentIdentificationType — (String)

      Labels all personal health information (PHI) identified in your transcript. For more information, see Identifying personal health information (PHI) in a transcription.

      Possible values include:
      • "PHI"
    • Specialty — (String)

      Specify the predominant medical specialty represented in your media. For batch transcriptions, PRIMARYCARE is the only valid value. If you require additional specialties, refer to .

      Possible values include:
      • "PRIMARYCARE"
    • Type — (String)

      Specify whether your input media contains only one person (DICTATION) or contains a conversation between two people (CONVERSATION).

      For example, DICTATION could be used for a medical professional wanting to transcribe voice memos; CONVERSATION could be used for transcribing the doctor-patient dialogue during the patient's office visit.

      Possible values include:
      • "CONVERSATION"
      • "DICTATION"
    • Tags — (Array<map>)

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

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

      • Keyrequired — (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'.

      • Valuerequired — (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:

      • MedicalTranscriptionJob — (map)

        Provides detailed information about the current medical transcription job, including job status and, if applicable, failure reason.

        • MedicalTranscriptionJobName — (String)

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

        • TranscriptionJobStatus — (String)

          Provides the status of the specified medical transcription job.

          If the status is COMPLETED, the job is finished and 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.

          Possible values include:
          • "QUEUED"
          • "IN_PROGRESS"
          • "FAILED"
          • "COMPLETED"
        • LanguageCode — (String)

          The language code used to create your medical transcription job. US English (en-US) is the only supported language for medical transcriptions.

          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"
        • 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"
        • Media — (map)

          Describes the Amazon S3 location of the media file you want to use in your 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 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.
        • StartTime — (Date)

          The date and time the specified medical transcription 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 medical transcription 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 medical transcription 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 TranscriptionJobStatus is FAILED, FailureReason contains information about why the transcription 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 MediaFormat 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 16,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 Guidelines and 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 Guidelines and quotas.

        • Settings — (map)

          Specify additional optional settings in your request, including channel identification, alternative transcriptions, and speaker labeling; allows you to apply custom vocabularies to your medical transcription job.

          • ShowSpeakerLabels — (Boolean)

            Enables speaker identification (diarization) in your transcription output. Speaker identification labels the speech from individual speakers in your media file.

            If you enable ShowSpeakerLabels in your request, you must also include MaxSpeakerLabels.

            You can't include both ShowSpeakerLabels and ChannelIdentification in the same request. Including both parameters returns a BadRequestException.

            For more information, see Identifying speakers (diarization).

          • MaxSpeakerLabels — (Integer)

            Specify the maximum number of speakers you want to identify in your media.

            Note that if your media contains more speakers than the specified number, multiple speakers will be identified as a single speaker.

            If you specify the MaxSpeakerLabels field, you must set the ShowSpeakerLabels field to true.

          • ChannelIdentification — (Boolean)

            Enables channel identification in multi-channel audio.

            Channel identification transcribes the audio on each channel independently, then appends the output for each channel into one transcript.

            If you have multi-channel audio and do not enable channel identification, your audio is transcribed in a continuous manner and your transcript does not separate the speech by channel.

            You can't include both ShowSpeakerLabels and ChannelIdentification in the same request. Including both parameters returns a BadRequestException.

            For more information, see Transcribing multi-channel audio.

          • ShowAlternatives — (Boolean)

            To include alternative transcriptions within your transcription output, include ShowAlternatives in your transcription request.

            If you include ShowAlternatives, you must also include MaxAlternatives, which is the maximum number of alternative transcriptions you want Amazon Transcribe Medical to generate.

            For more information, see Alternative transcriptions.

          • MaxAlternatives — (Integer)

            Indicate the maximum number of alternative transcriptions you want Amazon Transcribe Medical to include in your transcript.

            If you select a number greater than the number of alternative transcriptions generated by Amazon Transcribe Medical, only the actual number of alternative transcriptions are included.

            If you include MaxAlternatives in your request, you must also include ShowAlternatives with a value of true.

            For more information, see Alternative transcriptions.

          • VocabularyName — (String)

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

            The language of the specified vocabulary must match the language code you specify in your transcription request. If the languages don't match, the vocabulary isn't applied. There are no errors or warnings associated with a language mismatch. US English (en-US) is the only valid language for Amazon Transcribe Medical.

        • ContentIdentificationType — (String)

          Labels all personal health information (PHI) identified in your transcript. For more information, see Identifying personal health information (PHI) in a transcription.

          Possible values include:
          • "PHI"
        • Specialty — (String)

          Describes the medical specialty represented in your media.

          Possible values include:
          • "PRIMARYCARE"
        • Type — (String)

          Indicates whether the input media is a dictation or a conversation, as specified in the StartMedicalTranscriptionJob request.

          Possible values include:
          • "CONVERSATION"
          • "DICTATION"
        • Tags — (Array<map>)

          The tags, each in the form of a key:value pair, assigned to the specified medical transcription job.

          • Keyrequired — (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'.

          • Valuerequired — (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.

Returns:

  • (AWS.Request)

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

startTranscriptionJob(params = {}, callback) ⇒ AWS.Request

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 don't know the languages spoken in your media, use either IdentifyLanguage or IdentifyMultipleLanguages and let Amazon Transcribe identify the languages for you.

Service Reference:

Examples:

Calling the startTranscriptionJob operation

var params = {
  Media: { /* required */
    MediaFileUri: 'STRING_VALUE',
    RedactedMediaFileUri: 'STRING_VALUE'
  },
  TranscriptionJobName: 'STRING_VALUE', /* required */
  ContentRedaction: {
    RedactionOutput: redacted | redacted_and_unredacted, /* required */
    RedactionType: PII, /* required */
    PiiEntityTypes: [
      BANK_ACCOUNT_NUMBER | BANK_ROUTING | CREDIT_DEBIT_NUMBER | CREDIT_DEBIT_CVV | CREDIT_DEBIT_EXPIRY | PIN | EMAIL | ADDRESS | NAME | PHONE | SSN | ALL,
      /* more items */
    ]
  },
  IdentifyLanguage: true || false,
  IdentifyMultipleLanguages: true || false,
  JobExecutionSettings: {
    AllowDeferredExecution: true || false,
    DataAccessRoleArn: 'STRING_VALUE'
  },
  KMSEncryptionContext: {
    '<NonEmptyString>': 'STRING_VALUE',
    /* '<NonEmptyString>': ... */
  },
  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,
  LanguageIdSettings: {
    '<LanguageCode>': {
      LanguageModelName: 'STRING_VALUE',
      VocabularyFilterName: 'STRING_VALUE',
      VocabularyName: 'STRING_VALUE'
    },
    /* '<LanguageCode>': ... */
  },
  LanguageOptions: [
    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,
    /* more items */
  ],
  MediaFormat: mp3 | mp4 | wav | flac | ogg | amr | webm,
  MediaSampleRateHertz: 'NUMBER_VALUE',
  ModelSettings: {
    LanguageModelName: 'STRING_VALUE'
  },
  OutputBucketName: 'STRING_VALUE',
  OutputEncryptionKMSKeyId: 'STRING_VALUE',
  OutputKey: 'STRING_VALUE',
  Settings: {
    ChannelIdentification: true || false,
    MaxAlternatives: 'NUMBER_VALUE',
    MaxSpeakerLabels: 'NUMBER_VALUE',
    ShowAlternatives: true || false,
    ShowSpeakerLabels: true || false,
    VocabularyFilterMethod: remove | mask | tag,
    VocabularyFilterName: 'STRING_VALUE',
    VocabularyName: 'STRING_VALUE'
  },
  Subtitles: {
    Formats: [
      vtt | srt,
      /* more items */
    ],
    OutputStartIndex: 'NUMBER_VALUE'
  },
  Tags: [
    {
      Key: 'STRING_VALUE', /* required */
      Value: 'STRING_VALUE' /* required */
    },
    /* more items */
  ]
};
transcribeservice.startTranscriptionJob(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)

      A unique name, chosen by you, for your transcription job. The name you specify is also used as the default name of your transcription output file. If you want to specify a different name for your transcription output, use the OutputKey parameter.

      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 job with the same name as an existing job, you get a ConflictException error.

    • LanguageCode — (String)

      The language code that represents the language spoken in the input media file.

      If you're unsure of the language spoken in your media file, consider using IdentifyLanguage or IdentifyMultipleLanguages to enable automatic language identification.

      Note that you must include one of LanguageCode, IdentifyLanguage, or IdentifyMultipleLanguages in your request. If you include more than one of these parameters, your transcription job fails.

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

      Note: 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.
      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"
    • MediaSampleRateHertz — (Integer)

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

      If you don't specify the media sample rate, Amazon Transcribe determines it for you. If you specify the sample rate, it must match the rate detected by Amazon Transcribe; if there's a mismatch between the value you specify and the value detected, your job fails. Therefore, in most cases, it's advised to omit MediaSampleRateHertz and let Amazon Transcribe determine the sample rate.

    • MediaFormat — (String)

      Specify the format of your input media file.

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

      Describes the Amazon S3 location of the media file you want to use in your 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 is only supported for Call Analytics (StartCallAnalyticsJob) transcription requests.

    • OutputBucketName — (String)

      The name of the Amazon S3 bucket where you want your transcription output stored. Do not include the S3:// prefix of the specified bucket.

      If you want your output to go to a sub-folder of this bucket, specify it using the OutputKey parameter; OutputBucketName only accepts the name of a bucket.

      For example, if you want your output stored in S3://DOC-EXAMPLE-BUCKET, set OutputBucketName to DOC-EXAMPLE-BUCKET. However, if you want your output stored in S3://DOC-EXAMPLE-BUCKET/test-files/, set OutputBucketName to DOC-EXAMPLE-BUCKET and OutputKey to test-files/.

      Note that Amazon Transcribe must have permission to use the specified location. You can change Amazon S3 permissions using the Amazon Web Services Management Console. See also Permissions Required for IAM User Roles.

      If you don't specify OutputBucketName, your transcript is placed in a service-managed Amazon S3 bucket and you are provided with a URI to access your transcript.

    • OutputKey — (String)

      Use in combination with OutputBucketName to specify the output location of your transcript and, optionally, a unique name for your output file. The default name for your transcription output is the same as the name you specified for your transcription job (TranscriptionJobName).

      Here are some examples of how you can use OutputKey:

      • If you specify 'DOC-EXAMPLE-BUCKET' as the OutputBucketName and 'my-transcript.json' as the OutputKey, your transcription output path is s3://DOC-EXAMPLE-BUCKET/my-transcript.json.

      • If you specify 'my-first-transcription' as the TranscriptionJobName, 'DOC-EXAMPLE-BUCKET' as the OutputBucketName, and 'my-transcript' as the OutputKey, your transcription output path is s3://DOC-EXAMPLE-BUCKET/my-transcript/my-first-transcription.json.

      • If you specify 'DOC-EXAMPLE-BUCKET' as the OutputBucketName and 'test-files/my-transcript.json' as the OutputKey, your transcription output path is s3://DOC-EXAMPLE-BUCKET/test-files/my-transcript.json.

      • If you specify 'my-first-transcription' as the TranscriptionJobName, 'DOC-EXAMPLE-BUCKET' as the OutputBucketName, and 'test-files/my-transcript' as the OutputKey, your transcription output path is s3://DOC-EXAMPLE-BUCKET/test-files/my-transcript/my-first-transcription.json.

      If you specify the name of an Amazon S3 bucket sub-folder that doesn't exist, one is created for you.

    • OutputEncryptionKMSKeyId — (String)

      The KMS key you want to use to encrypt your transcription output.

      If using a key located in the current Amazon Web Services account, you can specify your KMS key in one of four ways:

      1. Use the KMS key ID itself. For example, 1234abcd-12ab-34cd-56ef-1234567890ab.

      2. Use an alias for the KMS key ID. For example, alias/ExampleAlias.

      3. Use the Amazon Resource Name (ARN) for the KMS key ID. For example, arn:aws:kms:region:account-ID:key/1234abcd-12ab-34cd-56ef-1234567890ab.

      4. Use the ARN for the KMS key alias. For example, arn:aws:kms:region:account-ID:alias/ExampleAlias.

      If using a key located in a different Amazon Web Services account than the current Amazon Web Services account, you can specify your KMS key in one of two ways:

      1. Use the ARN for the KMS key ID. For example, arn:aws:kms:region:account-ID:key/1234abcd-12ab-34cd-56ef-1234567890ab.

      2. Use the ARN for the KMS key alias. For example, arn:aws:kms:region:account-ID:alias/ExampleAlias.

      If you don't specify an encryption key, your output is encrypted with the default Amazon S3 key (SSE-S3).

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

      Note that the user making the request must have permission to use the specified KMS key.

    • KMSEncryptionContext — (map<String>)

      A map of plain text, non-secret key:value pairs, known as encryption context pairs, that provide an added layer of security for your data. For more information, see KMS encryption context and Asymmetric keys in KMS.

    • Settings — (map)

      Specify additional optional settings in your request, including channel identification, alternative transcriptions, speaker labeling; allows you to apply custom vocabularies and vocabulary filters.

      If you want to include a custom vocabulary or a custom vocabulary filter (or both) with your request but do not want to use automatic language identification, use Settings with the VocabularyName or VocabularyFilterName (or both) sub-parameter.

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

      • VocabularyName — (String)

        The name of the custom vocabulary you want to use in your transcription job request. This name is case sensitive, cannot contain spaces, and must be unique within an Amazon Web Services account.

      • ShowSpeakerLabels — (Boolean)

        Enables speaker identification (diarization) in your transcription output. Speaker identification labels the speech from individual speakers in your media file.

        If you enable ShowSpeakerLabels in your request, you must also include MaxSpeakerLabels.

        You can't include both ShowSpeakerLabels and ChannelIdentification in the same request. Including both parameters returns a BadRequestException.

        For more information, see Identifying speakers (diarization).

      • MaxSpeakerLabels — (Integer)

        Specify the maximum number of speakers you want to identify in your media.

        Note that if your media contains more speakers than the specified number, multiple speakers will be identified as a single speaker.

        If you specify the MaxSpeakerLabels field, you must set the ShowSpeakerLabels field to true.

      • ChannelIdentification — (Boolean)

        Enables channel identification in multi-channel audio.

        Channel identification transcribes the audio on each channel independently, then appends the output for each channel into one transcript.

        You can't include both ShowSpeakerLabels and ChannelIdentification in the same request. Including both parameters returns a BadRequestException.

        For more information, see Transcribing multi-channel audio.

      • ShowAlternatives — (Boolean)

        To include alternative transcriptions within your transcription output, include ShowAlternatives in your transcription request.

        If you have multi-channel audio and do not enable channel identification, your audio is transcribed in a continuous manner and your transcript does not separate the speech by channel.

        If you include ShowAlternatives, you must also include MaxAlternatives, which is the maximum number of alternative transcriptions you want Amazon Transcribe to generate.

        For more information, see Alternative transcriptions.

      • MaxAlternatives — (Integer)

        Indicate the maximum number of alternative transcriptions you want Amazon Transcribe to include in your transcript.

        If you select a number greater than the number of alternative transcriptions generated by Amazon Transcribe, only the actual number of alternative transcriptions are included.

        If you include MaxAlternatives in your request, you must also include ShowAlternatives with a value of true.

        For more information, see Alternative transcriptions.

      • VocabularyFilterName — (String)

        The name of the custom vocabulary filter you want to use in your transcription job request. This name is case sensitive, cannot contain spaces, and must be unique within an Amazon Web Services account.

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

      • VocabularyFilterMethod — (String)

        Specify how you want your 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"
    • ModelSettings — (map)

      Specify the custom language model you want to include with your transcription job. If you include ModelSettings in your request, you must include the LanguageModelName sub-parameter.

      For more information, see Custom language models.

      • LanguageModelName — (String)

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

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

    • JobExecutionSettings — (map)

      Allows you to control how your transcription job is processed. Currently, the only JobExecutionSettings modification you can choose is enabling job queueing using the AllowDeferredExecution sub-parameter.

      If you include JobExecutionSettings in your request, you must also include the sub-parameters: AllowDeferredExecution and DataAccessRoleArn.

      • AllowDeferredExecution — (Boolean)

        Allows you to enable job queuing when your concurrent request limit is exceeded. When AllowDeferredExecution is set to true, transcription job requests are placed in a queue until the number of jobs falls below the concurrent request limit. If AllowDeferredExecution is set to false and the number of transcription job requests exceed the concurrent request limit, you get a LimitExceededException error.

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

        If you include AllowDeferredExecution in your request, you must also include DataAccessRoleArn.

      • 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. If the role 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.

        Note that if you include DataAccessRoleArn in your request, you must also include AllowDeferredExecution.

    • ContentRedaction — (map)

      Allows you to redact or flag specified personally identifiable information (PII) in your transcript. If you use ContentRedaction, you must also include the sub-parameters: PiiEntityTypes, RedactionOutput, and RedactionType.

      • RedactionTyperequired — (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.

        Possible values include:
        • "PII"
      • RedactionOutputrequired — (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.

    • IdentifyLanguage — (Boolean)

      Enables automatic language identification in your transcription job request.

      If you include IdentifyLanguage, you can optionally include a list of language codes, using LanguageOptions, that you think may be present in your media file. Including language options can improve transcription accuracy.

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

      Note that you must include one of LanguageCode, IdentifyLanguage, or IdentifyMultipleLanguages in your request. If you include more than one of these parameters, your transcription job fails.

    • IdentifyMultipleLanguages — (Boolean)

      Enables automatic multi-language identification in your transcription job request. Use this parameter if your media file contains more than one language.

      If you include IdentifyMultipleLanguages, you can optionally include a list of language codes, using LanguageOptions, that you think may be present in your media file. Including language options can improve transcription accuracy.

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

      Note that you must include one of LanguageCode, IdentifyLanguage, or IdentifyMultipleLanguages in your request. If you include more than one of these parameters, your transcription job fails.

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

      If you include LanguageOptions in your request, you must also include IdentifyLanguage.

      For more information, refer to Supported languages.

      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.

    • Subtitles — (map)

      Produces subtitle files for your input media. You can specify WebVTT (.vtt) and SubRip (.srt) formats.

      • Formats — (Array<String>)

        Specify the output format for your subtitle file; if you select both WebVTT (vtt) and SubRip (srt) formats, two output files are generated.

      • OutputStartIndex — (Integer)

        Specify the starting value that is assigned to the first subtitle segment.

        The default start index for Amazon Transcribe is 0, which differs from the more widely used standard of 1. If you're uncertain which value to use, we recommend choosing 1, as this may improve compatibility with other services.

    • Tags — (Array<map>)

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

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

      • Keyrequired — (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'.

      • Valuerequired — (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.

    • LanguageIdSettings — (map<map>)

      If using automatic language identification (IdentifyLanguage) 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).

      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. Each language code you include can have an associated custom language model, custom vocabulary, and custom vocabulary filter. The languages you specify must match the languages of the specified custom language models, custom vocabularies, and custom vocabulary filters.

      To include language options using IdentifyLanguage without including a custom language model, a custom vocabulary, or a custom vocabulary filter, use LanguageOptions instead of LanguageIdSettings. Including language options can improve the accuracy of automatic language identification.

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

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

      • VocabularyName — (String)

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

        The language of the specified vocabulary must match the language code you specify in your transcription request. If the languages don't match, the 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. Vocabulary filter names are case sensitive.

        The language of the specified vocabulary filter must match the language code you specify in your transcription request. If the languages don't match, the 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 language model names are case sensitive.

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

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:

      • TranscriptionJob — (map)

        Provides detailed information about the current transcription job, including job status and, if applicable, failure reason.

        • TranscriptionJobName — (String)

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

        • TranscriptionJobStatus — (String)

          Provides the status of the specified transcription 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"
        • LanguageCode — (String)

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

          Note that you must include one of LanguageCode, IdentifyLanguage, or IdentifyMultipleLanguages in your request. If you include more than one of these parameters, your transcription job fails.

          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"
        • 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"
        • Media — (map)

          Describes the Amazon S3 location of the media file you want to use in your 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 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 transcription 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 transcription 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 transcription 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 TranscriptionJobStatus is FAILED, FailureReason contains information about why the transcription 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 MediaFormat 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 Guidelines and 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 Guidelines and quotas.

        • Settings — (map)

          Specify additional optional settings in your request, including channel identification, alternative transcriptions, speaker labeling; allows you to apply custom vocabularies and vocabulary filters.

          If you want to include a custom vocabulary or a custom vocabulary filter (or both) with your request but do not want to use automatic language identification, use Settings with the VocabularyName or VocabularyFilterName (or both) sub-parameter.

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

          • VocabularyName — (String)

            The name of the custom vocabulary you want to use in your transcription job request. This name is case sensitive, cannot contain spaces, and must be unique within an Amazon Web Services account.

          • ShowSpeakerLabels — (Boolean)

            Enables speaker identification (diarization) in your transcription output. Speaker identification labels the speech from individual speakers in your media file.

            If you enable ShowSpeakerLabels in your request, you must also include MaxSpeakerLabels.

            You can't include both ShowSpeakerLabels and ChannelIdentification in the same request. Including both parameters returns a BadRequestException.

            For more information, see Identifying speakers (diarization).

          • MaxSpeakerLabels — (Integer)

            Specify the maximum number of speakers you want to identify in your media.

            Note that if your media contains more speakers than the specified number, multiple speakers will be identified as a single speaker.

            If you specify the MaxSpeakerLabels field, you must set the ShowSpeakerLabels field to true.

          • ChannelIdentification — (Boolean)

            Enables channel identification in multi-channel audio.

            Channel identification transcribes the audio on each channel independently, then appends the output for each channel into one transcript.

            You can't include both ShowSpeakerLabels and ChannelIdentification in the same request. Including both parameters returns a BadRequestException.

            For more information, see Transcribing multi-channel audio.

          • ShowAlternatives — (Boolean)

            To include alternative transcriptions within your transcription output, include ShowAlternatives in your transcription request.

            If you have multi-channel audio and do not enable channel identification, your audio is transcribed in a continuous manner and your transcript does not separate the speech by channel.

            If you include ShowAlternatives, you must also include MaxAlternatives, which is the maximum number of alternative transcriptions you want Amazon Transcribe to generate.

            For more information, see Alternative transcriptions.

          • MaxAlternatives — (Integer)

            Indicate the maximum number of alternative transcriptions you want Amazon Transcribe to include in your transcript.

            If you select a number greater than the number of alternative transcriptions generated by Amazon Transcribe, only the actual number of alternative transcriptions are included.

            If you include MaxAlternatives in your request, you must also include ShowAlternatives with a value of true.

            For more information, see Alternative transcriptions.

          • VocabularyFilterName — (String)

            The name of the custom vocabulary filter you want to use in your transcription job request. This name is case sensitive, cannot contain spaces, and must be unique within an Amazon Web Services account.

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

          • VocabularyFilterMethod — (String)

            Specify how you want your 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"
        • ModelSettings — (map)

          The custom language model you want to include with your transcription job. If you include ModelSettings in your request, you must include the LanguageModelName sub-parameter.

          • LanguageModelName — (String)

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

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

        • JobExecutionSettings — (map)

          Provides information about how your transcription job is being processed. This parameter shows if your request is queued and what data access role is being used.

          • AllowDeferredExecution — (Boolean)

            Allows you to enable job queuing when your concurrent request limit is exceeded. When AllowDeferredExecution is set to true, transcription job requests are placed in a queue until the number of jobs falls below the concurrent request limit. If AllowDeferredExecution is set to false and the number of transcription job requests exceed the concurrent request limit, you get a LimitExceededException error.

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

            If you include AllowDeferredExecution in your request, you must also include DataAccessRoleArn.

          • 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. If the role 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.

            Note that if you include DataAccessRoleArn in your request, you must also include AllowDeferredExecution.

        • ContentRedaction — (map)

          Redacts or flags specified personally identifiable information (PII) in your transcript.

          • RedactionTyperequired — (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.

            Possible values include:
            • "PII"
          • RedactionOutputrequired — (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.

        • IdentifyLanguage — (Boolean)

          Indicates whether automatic language identification was enabled (TRUE) for the specified transcription job.

        • IdentifyMultipleLanguages — (Boolean)

          Indicates whether automatic multi-language identification was enabled (TRUE) for the specified transcription job.

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

          If you include LanguageOptions in your request, you must also include IdentifyLanguage.

          For more information, refer to Supported languages.

          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.

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

        • LanguageCodes — (Array<map>)

          The language codes used to create your transcription job. This parameter is used with multi-language identification. For single-language identification requests, refer to the singular version of this parameter, LanguageCode.

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

          • LanguageCode — (String)

            Provides the language code for each language identified in your media.

            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"
          • DurationInSeconds — (Float)

            Provides the total time, in seconds, each identified language is spoken in your media.

        • Tags — (Array<map>)

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

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

          • Keyrequired — (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'.

          • Valuerequired — (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.

        • Subtitles — (map)

          Generate subtitles for your media file with your transcription request.

          • Formats — (Array<String>)

            Provides the format of your subtitle files. If your request included both WebVTT (vtt) and SubRip (srt) formats, both formats are shown.

          • SubtitleFileUris — (Array<String>)

            The Amazon S3 location of your transcript. You can use this URI to access or download your subtitle file. Your subtitle file is stored in the same location as your transcript. If you specified both WebVTT and SubRip subtitle formats, two URIs are provided.

            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 subtitle file is stored in a service-managed bucket, and TranscriptFileUri provides you with a temporary URI you can use for secure access to your subtitle file.

            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.
          • OutputStartIndex — (Integer)

            Provides the start index value for your subtitle files. If you did not specify a value in your request, the default value of 0 is used.

        • LanguageIdSettings — (map<map>)

          If using automatic language identification (IdentifyLanguage) 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).

          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. Each language code you include can have an associated custom language model, custom vocabulary, and custom vocabulary filter. The languages you specify must match the languages of the specified custom language models, custom vocabularies, and custom vocabulary filters.

          To include language options using IdentifyLanguage without including a custom language model, a custom vocabulary, or a custom vocabulary filter, use LanguageOptions instead of LanguageIdSettings. Including language options can improve the accuracy of automatic language identification.

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

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

          • VocabularyName — (String)

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

            The language of the specified vocabulary must match the language code you specify in your transcription request. If the languages don't match, the 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. Vocabulary filter names are case sensitive.

            The language of the specified vocabulary filter must match the language code you specify in your transcription request. If the languages don't match, the 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 language model names are case sensitive.

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

Returns:

  • (AWS.Request)

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

tagResource(params = {}, callback) ⇒ AWS.Request

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.

Service Reference:

Examples:

Calling the tagResource operation

var params = {
  ResourceArn: 'STRING_VALUE', /* required */
  Tags: [ /* required */
    {
      Key: 'STRING_VALUE', /* required */
      Value: 'STRING_VALUE' /* required */
    },
    /* more items */
  ]
};
transcribeservice.tagResource(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: {})
    • ResourceArn — (String)

      The Amazon Resource Name (ARN) of the resource you want to tag. ARNs have the format arn:partition:service:region:account-id:resource-type/resource-id.

      For example, arn:aws:transcribe:us-west-2:account-id:transcription-job/transcription-job-name.

      Valid values for resource-type are: transcription-job, medical-transcription-job, vocabulary, medical-vocabulary, vocabulary-filter, and language-model.

    • Tags — (Array<map>)

      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.

      • Keyrequired — (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'.

      • Valuerequired — (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.

Returns:

  • (AWS.Request)

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

untagResource(params = {}, callback) ⇒ AWS.Request

Removes the specified tags from the specified Amazon Transcribe resource.

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

Service Reference:

Examples:

Calling the untagResource operation

var params = {
  ResourceArn: 'STRING_VALUE', /* required */
  TagKeys: [ /* required */
    'STRING_VALUE',
    /* more items */
  ]
};
transcribeservice.untagResource(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: {})
    • ResourceArn — (String)

      The Amazon Resource Name (ARN) of the Amazon Transcribe resource you want to remove tags from. ARNs have the format arn:partition:service:region:account-id:resource-type/resource-id.

      For example, arn:aws:transcribe:us-west-2:account-id:transcription-job/transcription-job-name.

      Valid values for resource-type are: transcription-job, medical-transcription-job, vocabulary, medical-vocabulary, vocabulary-filter, and language-model.

    • TagKeys — (Array<String>)

      Removes the specified tag keys from the specified Amazon Transcribe resource.

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.

updateCallAnalyticsCategory(params = {}, callback) ⇒ AWS.Request

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 .

Service Reference:

Examples:

Calling the updateCallAnalyticsCategory operation

var params = {
  CategoryName: 'STRING_VALUE', /* required */
  Rules: [ /* required */
    {
      InterruptionFilter: {
        AbsoluteTimeRange: {
          EndTime: 'NUMBER_VALUE',
          First: 'NUMBER_VALUE',
          Last: 'NUMBER_VALUE',
          StartTime: 'NUMBER_VALUE'
        },
        Negate: true || false,
        ParticipantRole: AGENT | CUSTOMER,
        RelativeTimeRange: {
          EndPercentage: 'NUMBER_VALUE',
          First: 'NUMBER_VALUE',
          Last: 'NUMBER_VALUE',
          StartPercentage: 'NUMBER_VALUE'
        },
        Threshold: 'NUMBER_VALUE'
      },
      NonTalkTimeFilter: {
        AbsoluteTimeRange: {
          EndTime: 'NUMBER_VALUE',
          First: 'NUMBER_VALUE',
          Last: 'NUMBER_VALUE',
          StartTime: 'NUMBER_VALUE'
        },
        Negate: true || false,
        RelativeTimeRange: {
          EndPercentage: 'NUMBER_VALUE',
          First: 'NUMBER_VALUE',
          Last: 'NUMBER_VALUE',
          StartPercentage: 'NUMBER_VALUE'
        },
        Threshold: 'NUMBER_VALUE'
      },
      SentimentFilter: {
        Sentiments: [ /* required */
          POSITIVE | NEGATIVE | NEUTRAL | MIXED,
          /* more items */
        ],
        AbsoluteTimeRange: {
          EndTime: 'NUMBER_VALUE',
          First: 'NUMBER_VALUE',
          Last: 'NUMBER_VALUE',
          StartTime: 'NUMBER_VALUE'
        },
        Negate: true || false,
        ParticipantRole: AGENT | CUSTOMER,
        RelativeTimeRange: {
          EndPercentage: 'NUMBER_VALUE',
          First: 'NUMBER_VALUE',
          Last: 'NUMBER_VALUE',
          StartPercentage: 'NUMBER_VALUE'
        }
      },
      TranscriptFilter: {
        Targets: [ /* required */
          'STRING_VALUE',
          /* more items */
        ],
        TranscriptFilterType: EXACT, /* required */
        AbsoluteTimeRange: {
          EndTime: 'NUMBER_VALUE',
          First: 'NUMBER_VALUE',
          Last: 'NUMBER_VALUE',
          StartTime: 'NUMBER_VALUE'
        },
        Negate: true || false,
        ParticipantRole: AGENT | CUSTOMER,
        RelativeTimeRange: {
          EndPercentage: 'NUMBER_VALUE',
          First: 'NUMBER_VALUE',
          Last: 'NUMBER_VALUE',
          StartPercentage: 'NUMBER_VALUE'
        }
      }
    },
    /* more items */
  ]
};
transcribeservice.updateCallAnalyticsCategory(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 update. Category names are case sensitive.

    • Rules — (Array<map>)

      The rules used for the updated Call Analytics category. The rules you provide in this field replace the ones that are currently being used in the specified category.

      • 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 you want to flag. For example, you can flag a silent period that lasts 30000 milliseconds.

        • AbsoluteTimeRange — (map)

          Allows you 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 value you specify in which Amazon Transcribe searches for your specified criteria.

          • Last — (Integer)

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

        • RelativeTimeRange — (map)

          Allows you 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 value you specify in which Amazon Transcribe searches for your specified criteria.

          • Last — (Integer)

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

        • 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 10000 milliseconds of interruptions.

        • ParticipantRole — (String)

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

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

          Allows you 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 value you specify in which Amazon Transcribe searches for your specified criteria.

          • Last — (Integer)

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

        • RelativeTimeRange — (map)

          Allows you 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 value you specify in which Amazon Transcribe searches for your specified criteria.

          • Last — (Integer)

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

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

        • TranscriptFilterTyperequired — (String)

          Flag the presence or absence of an exact match to the phrases 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)

          Allows you 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 value you specify in which Amazon Transcribe searches for your specified criteria.

          • Last — (Integer)

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

        • RelativeTimeRange — (map)

          Allows you 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 value you specify in which Amazon Transcribe searches for your specified criteria.

          • Last — (Integer)

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

        • ParticipantRole — (String)

          Specify the participant 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 you specified in your request. Set to FALSE to flag the presence of the phrase you specified in your request.

        • Targetsrequired — (Array<String>)

          Specify the phrases 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.

        • Sentimentsrequired — (Array<String>)

          Specify the sentiments you want to flag.

        • AbsoluteTimeRange — (map)

          Allows you 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 value you specify in which Amazon Transcribe searches for your specified criteria.

          • Last — (Integer)

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

        • RelativeTimeRange — (map)

          Allows you 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 value you specify in which Amazon Transcribe searches for your specified criteria.

          • Last — (Integer)

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

        • ParticipantRole — (String)

          Specify the participant 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 you didn't include in your request. Set to FALSE to flag the sentiments you specified in your request.

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 UpdateCallAnalyticsCategory 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 you want to flag. For example, you can flag a silent period that lasts 30000 milliseconds.

            • AbsoluteTimeRange — (map)

              Allows you 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 value you specify in which Amazon Transcribe searches for your specified criteria.

              • Last — (Integer)

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

            • RelativeTimeRange — (map)

              Allows you 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 value you specify in which Amazon Transcribe searches for your specified criteria.

              • Last — (Integer)

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

            • 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 10000 milliseconds of interruptions.

            • ParticipantRole — (String)

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

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

              Allows you 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 value you specify in which Amazon Transcribe searches for your specified criteria.

              • Last — (Integer)

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

            • RelativeTimeRange — (map)

              Allows you 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 value you specify in which Amazon Transcribe searches for your specified criteria.

              • Last — (Integer)

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

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

            • TranscriptFilterTyperequired — (String)

              Flag the presence or absence of an exact match to the phrases 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)

              Allows you 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 value you specify in which Amazon Transcribe searches for your specified criteria.

              • Last — (Integer)

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

            • RelativeTimeRange — (map)

              Allows you 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 value you specify in which Amazon Transcribe searches for your specified criteria.

              • Last — (Integer)

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

            • ParticipantRole — (String)

              Specify the participant 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 you specified in your request. Set to FALSE to flag the presence of the phrase you specified in your request.

            • Targetsrequired — (Array<String>)

              Specify the phrases 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.

            • Sentimentsrequired — (Array<String>)

              Specify the sentiments you want to flag.

            • AbsoluteTimeRange — (map)

              Allows you 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 value you specify in which Amazon Transcribe searches for your specified criteria.

              • Last — (Integer)

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

            • RelativeTimeRange — (map)

              Allows you 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 value you specify in which Amazon Transcribe searches for your specified criteria.

              • Last — (Integer)

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

            • ParticipantRole — (String)

              Specify the participant 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 you didn't include in your request. Set to FALSE to flag the sentiments 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.

Returns:

  • (AWS.Request)

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

updateMedicalVocabulary(params = {}, callback) ⇒ AWS.Request

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 vocabulary.

Service Reference:

Examples:

Calling the updateMedicalVocabulary operation

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, /* required */
  VocabularyFileUri: 'STRING_VALUE', /* required */
  VocabularyName: 'STRING_VALUE' /* required */
};
transcribeservice.updateMedicalVocabulary(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 update. Vocabulary names are case sensitive.

    • LanguageCode — (String)

      The language code that represents the language of the entries in the custom vocabulary you want to update. 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"
    • VocabularyFileUri — (String)

      The Amazon S3 location of the text file that contains your custom medical 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

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 of the updated custom medical vocabulary.

      • LanguageCode — (String)

        The language code you selected for your 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"
      • LastModifiedTime — (Date)

        The date and time the specified custom medical vocabulary was last updated.

        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.

      • VocabularyState — (String)

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

        Possible values include:
        • "PENDING"
        • "READY"
        • "FAILED"

Returns:

  • (AWS.Request)

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

updateVocabulary(params = {}, callback) ⇒ AWS.Request

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 vocabulary.

Service Reference:

Examples:

Calling the updateVocabulary operation

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, /* required */
  VocabularyName: 'STRING_VALUE', /* required */
  Phrases: [
    'STRING_VALUE',
    /* more items */
  ],
  VocabularyFileUri: 'STRING_VALUE'
};
transcribeservice.updateVocabulary(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 update. Vocabulary names are case sensitive.

    • LanguageCode — (String)

      The language code that represents the language of the entries in the custom vocabulary you want to update. Each vocabulary must contain terms in only one language.

      A custom vocabulary can only be used to transcribe files in the same language as the vocabulary. For example, if you create a vocabulary using US English (en-US), you can only apply this 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"
    • Phrases — (Array<String>)

      Use this parameter if you want to update your vocabulary by including all desired terms, as comma-separated values, within your request. The other option for updating your 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 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.

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 of the updated 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"
      • LastModifiedTime — (Date)

        The date and time the specified vocabulary was last updated.

        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.

      • VocabularyState — (String)

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

        Possible values include:
        • "PENDING"
        • "READY"
        • "FAILED"

Returns:

  • (AWS.Request)

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

updateVocabularyFilter(params = {}, callback) ⇒ AWS.Request

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 vocabulary filter.

Service Reference:

Examples:

Calling the updateVocabularyFilter operation

var params = {
  VocabularyFilterName: 'STRING_VALUE', /* required */
  VocabularyFilterFileUri: 'STRING_VALUE',
  Words: [
    'STRING_VALUE',
    /* more items */
  ]
};
transcribeservice.updateVocabularyFilter(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 update. Vocabulary filter names are case sensitive.

    • Words — (Array<String>)

      Use this parameter if you want to update your vocabulary filter by including all desired terms, as comma-separated values, within your request. The other option for updating 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 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.

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 of the updated custom vocabulary filter.

      • LanguageCode — (String)

        The language code you selected for your 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"
      • LastModifiedTime — (Date)

        The date and time the specified vocabulary filter was last updated.

        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.