@lap v0.3
# Machine-readable API spec. Each @endpoint block is one API call.
@api Amazon Transcribe Service
@version 2017-10-26
@auth AWS SigV4
@endpoints 43
@hint download_for_search
@toc root(43)

@endpoint POST /
@required {CategoryName: str, Rules: [Rule]}
@optional {InputType: str}
@returns(200) {CategoryProperties: CategoryProperties?{CategoryName: str?, Rules: [Rule]?, CreateTime: str(timestamp)?, LastUpdateTime: str(timestamp)?, InputType: str?}}

@endpoint POST /
@required {LanguageCode: str, BaseModelName: str, ModelName: str, InputDataConfig: InputDataConfig}
@optional {Tags: [Tag]}
@returns(200) {LanguageCode: str?, BaseModelName: str?, ModelName: str?, InputDataConfig: InputDataConfig?{S3Uri: str, TuningDataS3Uri: str?, DataAccessRoleArn: str}, ModelStatus: str?}

@endpoint POST /
@required {VocabularyName: str, LanguageCode: str, VocabularyFileUri: str}
@optional {Tags: [Tag]}
@returns(200) {VocabularyName: str?, LanguageCode: str?, VocabularyState: str?, LastModifiedTime: str(timestamp)?, FailureReason: str?}

@endpoint POST /
@required {VocabularyName: str, LanguageCode: str}
@optional {Phrases: [str], VocabularyFileUri: str, Tags: [Tag], DataAccessRoleArn: str}
@returns(200) {VocabularyName: str?, LanguageCode: str?, VocabularyState: str?, LastModifiedTime: str(timestamp)?, FailureReason: str?}

@endpoint POST /
@required {VocabularyFilterName: str, LanguageCode: str}
@optional {Words: [str], VocabularyFilterFileUri: str, Tags: [Tag], DataAccessRoleArn: str}
@returns(200) {VocabularyFilterName: str?, LanguageCode: str?, LastModifiedTime: str(timestamp)?}

@endpoint POST /
@required {CategoryName: str}

@endpoint POST /
@required {CallAnalyticsJobName: str}

@endpoint POST /
@required {ModelName: str}

@endpoint POST /
@required {MedicalScribeJobName: str}

@endpoint POST /
@required {MedicalTranscriptionJobName: str}

@endpoint POST /
@required {VocabularyName: str}

@endpoint POST /
@required {TranscriptionJobName: str}

@endpoint POST /
@required {VocabularyName: str}

@endpoint POST /
@required {VocabularyFilterName: str}

@endpoint POST /
@required {ModelName: str}
@returns(200) {LanguageModel: LanguageModel?{ModelName: str?, CreateTime: str(timestamp)?, LastModifiedTime: str(timestamp)?, LanguageCode: str?, BaseModelName: str?, ModelStatus: str?, UpgradeAvailability: bool?, FailureReason: str?, InputDataConfig: InputDataConfig?{S3Uri: str, TuningDataS3Uri: str?, DataAccessRoleArn: str}}}

@endpoint POST /
@required {CategoryName: str}
@returns(200) {CategoryProperties: CategoryProperties?{CategoryName: str?, Rules: [Rule]?, CreateTime: str(timestamp)?, LastUpdateTime: str(timestamp)?, InputType: str?}}

@endpoint POST /
@required {CallAnalyticsJobName: str}
@returns(200) {CallAnalyticsJob: CallAnalyticsJob?{CallAnalyticsJobName: str?, CallAnalyticsJobStatus: str?, CallAnalyticsJobDetails: CallAnalyticsJobDetails?{Skipped: [CallAnalyticsSkippedFeature]?}, LanguageCode: str?, MediaSampleRateHertz: int?, MediaFormat: str?, Media: Media?{MediaFileUri: str?, RedactedMediaFileUri: str?}, Transcript: Transcript?{TranscriptFileUri: str?, RedactedTranscriptFileUri: str?}, StartTime: str(timestamp)?, CreationTime: str(timestamp)?, CompletionTime: str(timestamp)?, FailureReason: str?, DataAccessRoleArn: str?, IdentifiedLanguageScore: num(f32)?, Settings: CallAnalyticsJobSettings?{VocabularyName: str?, VocabularyFilterName: str?, VocabularyFilterMethod: str?, LanguageModelName: str?, ContentRedaction: ContentRedaction?{RedactionType: str, RedactionOutput: str, PiiEntityTypes: [str]?}, LanguageOptions: [str]?, LanguageIdSettings: map<str,LanguageIdSettings>?, Summarization: Summarization?{GenerateAbstractiveSummary: bool}}, ChannelDefinitions: [ChannelDefinition]?}}

@endpoint POST /
@required {MedicalScribeJobName: str}
@returns(200) {MedicalScribeJob: MedicalScribeJob?{MedicalScribeJobName: str?, MedicalScribeJobStatus: str?, LanguageCode: str?, Media: Media?{MediaFileUri: str?, RedactedMediaFileUri: str?}, MedicalScribeOutput: MedicalScribeOutput?{TranscriptFileUri: str, ClinicalDocumentUri: str}, StartTime: str(timestamp)?, CreationTime: str(timestamp)?, CompletionTime: str(timestamp)?, FailureReason: str?, Settings: MedicalScribeSettings?{ShowSpeakerLabels: bool?, MaxSpeakerLabels: int?, ChannelIdentification: bool?, VocabularyName: str?, VocabularyFilterName: str?, VocabularyFilterMethod: str?}, DataAccessRoleArn: str?, ChannelDefinitions: [MedicalScribeChannelDefinition]?, Tags: [Tag]?}}

@endpoint POST /
@required {MedicalTranscriptionJobName: str}
@returns(200) {MedicalTranscriptionJob: MedicalTranscriptionJob?{MedicalTranscriptionJobName: str?, TranscriptionJobStatus: str?, LanguageCode: str?, MediaSampleRateHertz: int?, MediaFormat: str?, Media: Media?{MediaFileUri: str?, RedactedMediaFileUri: str?}, Transcript: MedicalTranscript?{TranscriptFileUri: str?}, StartTime: str(timestamp)?, CreationTime: str(timestamp)?, CompletionTime: str(timestamp)?, FailureReason: str?, Settings: MedicalTranscriptionSetting?{ShowSpeakerLabels: bool?, MaxSpeakerLabels: int?, ChannelIdentification: bool?, ShowAlternatives: bool?, MaxAlternatives: int?, VocabularyName: str?}, ContentIdentificationType: str?, Specialty: str?, Type: str?, Tags: [Tag]?}}

@endpoint POST /
@required {VocabularyName: str}
@returns(200) {VocabularyName: str?, LanguageCode: str?, VocabularyState: str?, LastModifiedTime: str(timestamp)?, FailureReason: str?, DownloadUri: str?}

@endpoint POST /
@required {TranscriptionJobName: str}
@returns(200) {TranscriptionJob: TranscriptionJob?{TranscriptionJobName: str?, TranscriptionJobStatus: str?, LanguageCode: str?, MediaSampleRateHertz: int?, MediaFormat: str?, Media: Media?{MediaFileUri: str?, RedactedMediaFileUri: str?}, Transcript: Transcript?{TranscriptFileUri: str?, RedactedTranscriptFileUri: str?}, StartTime: str(timestamp)?, CreationTime: str(timestamp)?, CompletionTime: str(timestamp)?, FailureReason: str?, Settings: Settings?{VocabularyName: str?, ShowSpeakerLabels: bool?, MaxSpeakerLabels: int?, ChannelIdentification: bool?, ShowAlternatives: bool?, MaxAlternatives: int?, VocabularyFilterName: str?, VocabularyFilterMethod: str?}, ModelSettings: ModelSettings?{LanguageModelName: str?}, JobExecutionSettings: JobExecutionSettings?{AllowDeferredExecution: bool?, DataAccessRoleArn: str?}, ContentRedaction: ContentRedaction?{RedactionType: str, RedactionOutput: str, PiiEntityTypes: [str]?}, IdentifyLanguage: bool?, IdentifyMultipleLanguages: bool?, LanguageOptions: [str]?, IdentifiedLanguageScore: num(f32)?, LanguageCodes: [LanguageCodeItem]?, Tags: [Tag]?, Subtitles: SubtitlesOutput?{Formats: [str]?, SubtitleFileUris: [str]?, OutputStartIndex: int?}, LanguageIdSettings: map<str,LanguageIdSettings>?, ToxicityDetection: [ToxicityDetectionSettings]?}}

@endpoint POST /
@required {VocabularyName: str}
@returns(200) {VocabularyName: str?, LanguageCode: str?, VocabularyState: str?, LastModifiedTime: str(timestamp)?, FailureReason: str?, DownloadUri: str?}

@endpoint POST /
@required {VocabularyFilterName: str}
@returns(200) {VocabularyFilterName: str?, LanguageCode: str?, LastModifiedTime: str(timestamp)?, DownloadUri: str?}

@endpoint POST /
@optional {NextToken: str, MaxResults: int}
@returns(200) {NextToken: str?, Categories: [CategoryProperties]?}

@endpoint POST /
@optional {Status: str, JobNameContains: str, NextToken: str, MaxResults: int}
@returns(200) {Status: str?, NextToken: str?, CallAnalyticsJobSummaries: [CallAnalyticsJobSummary]?}

@endpoint POST /
@optional {StatusEquals: str, NameContains: str, NextToken: str, MaxResults: int}
@returns(200) {NextToken: str?, Models: [LanguageModel]?}

@endpoint POST /
@optional {Status: str, JobNameContains: str, NextToken: str, MaxResults: int}
@returns(200) {Status: str?, NextToken: str?, MedicalScribeJobSummaries: [MedicalScribeJobSummary]?}

@endpoint POST /
@optional {Status: str, JobNameContains: str, NextToken: str, MaxResults: int}
@returns(200) {Status: str?, NextToken: str?, MedicalTranscriptionJobSummaries: [MedicalTranscriptionJobSummary]?}

@endpoint POST /
@optional {NextToken: str, MaxResults: int, StateEquals: str, NameContains: str}
@returns(200) {Status: str?, NextToken: str?, Vocabularies: [VocabularyInfo]?}

@endpoint POST /
@required {ResourceArn: str}
@returns(200) {ResourceArn: str?, Tags: [Tag]?}

@endpoint POST /
@optional {Status: str, JobNameContains: str, NextToken: str, MaxResults: int}
@returns(200) {Status: str?, NextToken: str?, TranscriptionJobSummaries: [TranscriptionJobSummary]?}

@endpoint POST /
@optional {NextToken: str, MaxResults: int, StateEquals: str, NameContains: str}
@returns(200) {Status: str?, NextToken: str?, Vocabularies: [VocabularyInfo]?}

@endpoint POST /
@optional {NextToken: str, MaxResults: int, NameContains: str}
@returns(200) {NextToken: str?, VocabularyFilters: [VocabularyFilterInfo]?}

@endpoint POST /
@required {CallAnalyticsJobName: str, Media: Media}
@optional {OutputLocation: str, OutputEncryptionKMSKeyId: str, DataAccessRoleArn: str, Settings: CallAnalyticsJobSettings, ChannelDefinitions: [ChannelDefinition]}
@returns(200) {CallAnalyticsJob: CallAnalyticsJob?{CallAnalyticsJobName: str?, CallAnalyticsJobStatus: str?, CallAnalyticsJobDetails: CallAnalyticsJobDetails?{Skipped: [CallAnalyticsSkippedFeature]?}, LanguageCode: str?, MediaSampleRateHertz: int?, MediaFormat: str?, Media: Media?{MediaFileUri: str?, RedactedMediaFileUri: str?}, Transcript: Transcript?{TranscriptFileUri: str?, RedactedTranscriptFileUri: str?}, StartTime: str(timestamp)?, CreationTime: str(timestamp)?, CompletionTime: str(timestamp)?, FailureReason: str?, DataAccessRoleArn: str?, IdentifiedLanguageScore: num(f32)?, Settings: CallAnalyticsJobSettings?{VocabularyName: str?, VocabularyFilterName: str?, VocabularyFilterMethod: str?, LanguageModelName: str?, ContentRedaction: ContentRedaction?{RedactionType: str, RedactionOutput: str, PiiEntityTypes: [str]?}, LanguageOptions: [str]?, LanguageIdSettings: map<str,LanguageIdSettings>?, Summarization: Summarization?{GenerateAbstractiveSummary: bool}}, ChannelDefinitions: [ChannelDefinition]?}}

@endpoint POST /
@required {MedicalScribeJobName: str, Media: Media, OutputBucketName: str, DataAccessRoleArn: str, Settings: MedicalScribeSettings}
@optional {OutputEncryptionKMSKeyId: str, KMSEncryptionContext: map<str,str>, ChannelDefinitions: [MedicalScribeChannelDefinition], Tags: [Tag]}
@returns(200) {MedicalScribeJob: MedicalScribeJob?{MedicalScribeJobName: str?, MedicalScribeJobStatus: str?, LanguageCode: str?, Media: Media?{MediaFileUri: str?, RedactedMediaFileUri: str?}, MedicalScribeOutput: MedicalScribeOutput?{TranscriptFileUri: str, ClinicalDocumentUri: str}, StartTime: str(timestamp)?, CreationTime: str(timestamp)?, CompletionTime: str(timestamp)?, FailureReason: str?, Settings: MedicalScribeSettings?{ShowSpeakerLabels: bool?, MaxSpeakerLabels: int?, ChannelIdentification: bool?, VocabularyName: str?, VocabularyFilterName: str?, VocabularyFilterMethod: str?}, DataAccessRoleArn: str?, ChannelDefinitions: [MedicalScribeChannelDefinition]?, Tags: [Tag]?}}

@endpoint POST /
@required {MedicalTranscriptionJobName: str, LanguageCode: str, Media: Media, OutputBucketName: str, Specialty: str, Type: str}
@optional {MediaSampleRateHertz: int, MediaFormat: str, OutputKey: str, OutputEncryptionKMSKeyId: str, KMSEncryptionContext: map<str,str>, Settings: MedicalTranscriptionSetting, ContentIdentificationType: str, Tags: [Tag]}
@returns(200) {MedicalTranscriptionJob: MedicalTranscriptionJob?{MedicalTranscriptionJobName: str?, TranscriptionJobStatus: str?, LanguageCode: str?, MediaSampleRateHertz: int?, MediaFormat: str?, Media: Media?{MediaFileUri: str?, RedactedMediaFileUri: str?}, Transcript: MedicalTranscript?{TranscriptFileUri: str?}, StartTime: str(timestamp)?, CreationTime: str(timestamp)?, CompletionTime: str(timestamp)?, FailureReason: str?, Settings: MedicalTranscriptionSetting?{ShowSpeakerLabels: bool?, MaxSpeakerLabels: int?, ChannelIdentification: bool?, ShowAlternatives: bool?, MaxAlternatives: int?, VocabularyName: str?}, ContentIdentificationType: str?, Specialty: str?, Type: str?, Tags: [Tag]?}}

@endpoint POST /
@required {TranscriptionJobName: str, Media: Media}
@optional {LanguageCode: str, MediaSampleRateHertz: int, MediaFormat: str, OutputBucketName: str, OutputKey: str, OutputEncryptionKMSKeyId: str, KMSEncryptionContext: map<str,str>, Settings: Settings, ModelSettings: ModelSettings, JobExecutionSettings: JobExecutionSettings, ContentRedaction: ContentRedaction, IdentifyLanguage: bool, IdentifyMultipleLanguages: bool, LanguageOptions: [str], Subtitles: Subtitles, Tags: [Tag], LanguageIdSettings: map<str,LanguageIdSettings>, ToxicityDetection: [ToxicityDetectionSettings]}
@returns(200) {TranscriptionJob: TranscriptionJob?{TranscriptionJobName: str?, TranscriptionJobStatus: str?, LanguageCode: str?, MediaSampleRateHertz: int?, MediaFormat: str?, Media: Media?{MediaFileUri: str?, RedactedMediaFileUri: str?}, Transcript: Transcript?{TranscriptFileUri: str?, RedactedTranscriptFileUri: str?}, StartTime: str(timestamp)?, CreationTime: str(timestamp)?, CompletionTime: str(timestamp)?, FailureReason: str?, Settings: Settings?{VocabularyName: str?, ShowSpeakerLabels: bool?, MaxSpeakerLabels: int?, ChannelIdentification: bool?, ShowAlternatives: bool?, MaxAlternatives: int?, VocabularyFilterName: str?, VocabularyFilterMethod: str?}, ModelSettings: ModelSettings?{LanguageModelName: str?}, JobExecutionSettings: JobExecutionSettings?{AllowDeferredExecution: bool?, DataAccessRoleArn: str?}, ContentRedaction: ContentRedaction?{RedactionType: str, RedactionOutput: str, PiiEntityTypes: [str]?}, IdentifyLanguage: bool?, IdentifyMultipleLanguages: bool?, LanguageOptions: [str]?, IdentifiedLanguageScore: num(f32)?, LanguageCodes: [LanguageCodeItem]?, Tags: [Tag]?, Subtitles: SubtitlesOutput?{Formats: [str]?, SubtitleFileUris: [str]?, OutputStartIndex: int?}, LanguageIdSettings: map<str,LanguageIdSettings>?, ToxicityDetection: [ToxicityDetectionSettings]?}}

@endpoint POST /
@required {ResourceArn: str, Tags: [Tag]}

@endpoint POST /
@required {ResourceArn: str, TagKeys: [str]}

@endpoint POST /
@required {CategoryName: str, Rules: [Rule]}
@optional {InputType: str}
@returns(200) {CategoryProperties: CategoryProperties?{CategoryName: str?, Rules: [Rule]?, CreateTime: str(timestamp)?, LastUpdateTime: str(timestamp)?, InputType: str?}}

@endpoint POST /
@required {VocabularyName: str, LanguageCode: str, VocabularyFileUri: str}
@returns(200) {VocabularyName: str?, LanguageCode: str?, LastModifiedTime: str(timestamp)?, VocabularyState: str?}

@endpoint POST /
@required {VocabularyName: str, LanguageCode: str}
@optional {Phrases: [str], VocabularyFileUri: str, DataAccessRoleArn: str}
@returns(200) {VocabularyName: str?, LanguageCode: str?, LastModifiedTime: str(timestamp)?, VocabularyState: str?}

@endpoint POST /
@required {VocabularyFilterName: str}
@optional {Words: [str], VocabularyFilterFileUri: str, DataAccessRoleArn: str}
@returns(200) {VocabularyFilterName: str?, LanguageCode: str?, LastModifiedTime: str(timestamp)?}

@end