Module Values.GetMedicalVocabularyResponseSource

Provides information about the specified custom medical vocabulary. To view the status of the specified custom medical vocabulary, check the VocabularyState field. If the status is READY, your custom vocabulary is available to use. If the status is FAILED, FailureReason provides details on why your vocabulary failed. To get a list of your custom medical vocabularies, use the operation.

Sourcetype nonrec t = {
  1. vocabularyName : VocabularyName.t option;
    (*

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

    *)
  2. languageCode : LanguageCode.t option;
    (*

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

    *)
  3. vocabularyState : VocabularyState.t option;
    (*

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

    *)
  4. lastModifiedTime : DateTime.t option;
    (*

    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.

    *)
  5. failureReason : FailureReason.t option;
    (*

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

    *)
  6. downloadUri : Uri_.t option;
    (*

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

    *)
}
Sourcetype nonrec error = [
  1. | `BadRequestException of BadRequestException.t
  2. | `InternalFailureException of InternalFailureException.t
  3. | `LimitExceededException of LimitExceededException.t
  4. | `NotFoundException of NotFoundException.t
  5. | `Unknown_operation_error of string * string option
]
Sourceval make : ?vocabularyName:??? -> ?languageCode:??? -> ?vocabularyState:??? -> ?lastModifiedTime:??? -> ?failureReason:??? -> ?downloadUri:??? -> unit -> t
Sourceval error_of_json : string -> Yojson.Safe.t -> [> `BadRequestException of BadRequestException.t | `InternalFailureException of InternalFailureException.t | `LimitExceededException of LimitExceededException.t | `NotFoundException of NotFoundException.t | `Unknown_operation_error of string * string option ]
Sourceval error_of_xml : string -> Awso.Xml.t -> [> `BadRequestException of BadRequestException.t | `InternalFailureException of InternalFailureException.t | `LimitExceededException of LimitExceededException.t | `NotFoundException of NotFoundException.t | `Unknown_operation_error of string * string option ]
Sourceval error_to_json : error -> Yojson.Safe.t
Sourceval to_value : t -> [> `Structure of (string * [> `Enum of string | `String of VocabularyName.t | `Timestamp of DateTime.t ]) list ]
Sourceval to_query : t -> Awso.Client.Query.t
Sourceval of_xml : Awso.Xml.t -> t
Sourceval of_string : string -> t
Sourceval of_json : Yojson.Safe.t -> t
Sourceval to_json : t -> Yojson.Safe.t