TranscribeService

public struct TranscribeService

Client object for interacting with AWS TranscribeService service.

Operations and objects for transcribing speech to text.

Member variables

client
Undocumented
Declaration
Swift

public let client: AWSClient

Initialization


                    
                    
                    init(accessKeyId:secretAccessKey:sessionToken:region:endpoint:middlewares:eventLoopGroupProvider:)

Initialize the TranscribeService client

Declaration

Swift

public init(accessKeyId: String? = nil, secretAccessKey: String? = nil, sessionToken: String? = nil, region: AWSSDKSwiftCore.Region? = nil, endpoint: String? = nil, middlewares: [AWSServiceMiddleware] = [], eventLoopGroupProvider: AWSClient.EventLoopGroupProvider = .useAWSClientShared)

Parameters

`accessKeyId`	Public access key provided by AWS
`secretAccessKey`	Private access key provided by AWS
`sessionToken`	Token provided by STS.AssumeRole() which allows access to another AWS account
`region`	Region of server you want to communicate with
`endpoint`	Custom endpoint URL to use instead of standard AWS servers
`middlewares`	Array of middlewares to apply to requests and responses
`eventLoopGroupProvider`	EventLoopGroup to use. Use `useAWSClientShared` if the client shall manage its own EventLoopGroup.

API Calls

createLanguageModel(_:)
Creates a new custom language model. Use Amazon S3 prefixes to provide the location of your input files. The time it takes to create your model depends on the size of your training data.
Declaration
Swift

public func createLanguageModel(_ input: CreateLanguageModelRequest) -> EventLoopFuture<CreateLanguageModelResponse>
createMedicalVocabulary(_:)
Creates a new custom vocabulary that you can use to change how Amazon Transcribe Medical transcribes your audio file.
Declaration
Swift

public func createMedicalVocabulary(_ input: CreateMedicalVocabularyRequest) -> EventLoopFuture<CreateMedicalVocabularyResponse>
createVocabulary(_:)
Creates a new custom vocabulary that you can use to change the way Amazon Transcribe handles transcription of an audio file.
Declaration
Swift

public func createVocabulary(_ input: CreateVocabularyRequest) -> EventLoopFuture<CreateVocabularyResponse>
createVocabularyFilter(_:)
Creates a new vocabulary filter that you can use to filter words, such as profane words, from the output of a transcription job.
Declaration
Swift

public func createVocabularyFilter(_ input: CreateVocabularyFilterRequest) -> EventLoopFuture<CreateVocabularyFilterResponse>


                    
                    
                    deleteLanguageModel(_:)

Deletes a custom language model using its name.

Declaration

Swift

@discardableResult
public func deleteLanguageModel(_ input: DeleteLanguageModelRequest) -> EventLoopFuture<Void>

deleteMedicalTranscriptionJob(_:)
Deletes a transcription job generated by Amazon Transcribe Medical and any related information.
Declaration
Swift

@discardableResult public func deleteMedicalTranscriptionJob(_ input: DeleteMedicalTranscriptionJobRequest) -> EventLoopFuture<Void>


                    
                    
                    deleteMedicalVocabulary(_:)

Deletes a vocabulary from Amazon Transcribe Medical.

Declaration

Swift

@discardableResult
public func deleteMedicalVocabulary(_ input: DeleteMedicalVocabularyRequest) -> EventLoopFuture<Void>

deleteTranscriptionJob(_:)
Deletes a previously submitted transcription job along with any other generated results such as the transcription, models, and so on.
Declaration
Swift

@discardableResult public func deleteTranscriptionJob(_ input: DeleteTranscriptionJobRequest) -> EventLoopFuture<Void>


                    
                    
                    deleteVocabulary(_:)

Deletes a vocabulary from Amazon Transcribe.

Declaration

Swift

@discardableResult
public func deleteVocabulary(_ input: DeleteVocabularyRequest) -> EventLoopFuture<Void>


                    
                    
                    deleteVocabularyFilter(_:)

Removes a vocabulary filter.

Declaration

Swift

@discardableResult
public func deleteVocabularyFilter(_ input: DeleteVocabularyFilterRequest) -> EventLoopFuture<Void>

describeLanguageModel(_:)
Gets information about a single custom language model. Use this information to see details about the language model in your AWS account. You can also see whether the base language model 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 the language model wasn’t created, you can use this operation to understand why Amazon Transcribe couldn’t create it.
Declaration
Swift

public func describeLanguageModel(_ input: DescribeLanguageModelRequest) -> EventLoopFuture<DescribeLanguageModelResponse>
getMedicalTranscriptionJob(_:)
Returns information about a transcription job from Amazon Transcribe Medical. To see the status of the job, check the TranscriptionJobStatus field. If the status is COMPLETED, the job is finished. You find the results of the completed job in the TranscriptFileUri field.
Declaration
Swift

public func getMedicalTranscriptionJob(_ input: GetMedicalTranscriptionJobRequest) -> EventLoopFuture<GetMedicalTranscriptionJobResponse>


                    
                    
                    getMedicalVocabulary(_:)

Retrieves information about a medical vocabulary.

Declaration

Swift

public func getMedicalVocabulary(_ input: GetMedicalVocabularyRequest) -> EventLoopFuture<GetMedicalVocabularyResponse>

getTranscriptionJob(_:)
Returns information about a transcription job. To see the status of the 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 the TranscriptFileUri field. If you enable content redaction, the redacted transcript appears in RedactedTranscriptFileUri.
Declaration
Swift

public func getTranscriptionJob(_ input: GetTranscriptionJobRequest) -> EventLoopFuture<GetTranscriptionJobResponse>


                    
                    
                    getVocabulary(_:)

Gets information about a vocabulary.

Declaration

Swift

public func getVocabulary(_ input: GetVocabularyRequest) -> EventLoopFuture<GetVocabularyResponse>


                    
                    
                    getVocabularyFilter(_:)

Returns information about a vocabulary filter.

Declaration

Swift

public func getVocabularyFilter(_ input: GetVocabularyFilterRequest) -> EventLoopFuture<GetVocabularyFilterResponse>

listLanguageModels(_:)
Provides more information about the custom language models you’ve created. You can use the information in this list to find a specific custom language model. You can then use the operation to get more information about it.
Declaration
Swift

public func listLanguageModels(_ input: ListLanguageModelsRequest) -> EventLoopFuture<ListLanguageModelsResponse>


                    
                    
                    listMedicalTranscriptionJobs(_:)

Lists medical transcription jobs with a specified status or substring that matches their names.

Declaration

Swift

public func listMedicalTranscriptionJobs(_ input: ListMedicalTranscriptionJobsRequest) -> EventLoopFuture<ListMedicalTranscriptionJobsResponse>

listMedicalVocabularies(_:)
Returns a list of vocabularies that match the specified criteria. If you don’t enter a value in any of the request parameters, returns the entire list of vocabularies.
Declaration
Swift

public func listMedicalVocabularies(_ input: ListMedicalVocabulariesRequest) -> EventLoopFuture<ListMedicalVocabulariesResponse>


                    
                    
                    listTranscriptionJobs(_:)

Lists transcription jobs with the specified status.

Declaration

Swift

public func listTranscriptionJobs(_ input: ListTranscriptionJobsRequest) -> EventLoopFuture<ListTranscriptionJobsResponse>

listVocabularies(_:)
Returns a list of vocabularies that match the specified criteria. If no criteria are specified, returns the entire list of vocabularies.
Declaration
Swift

public func listVocabularies(_ input: ListVocabulariesRequest) -> EventLoopFuture<ListVocabulariesResponse>


                    
                    
                    listVocabularyFilters(_:)

Gets information about vocabulary filters.

Declaration

Swift

public func listVocabularyFilters(_ input: ListVocabularyFiltersRequest) -> EventLoopFuture<ListVocabularyFiltersResponse>


                    
                    
                    startMedicalTranscriptionJob(_:)

Starts a batch job to transcribe medical speech to text.

Declaration

Swift

public func startMedicalTranscriptionJob(_ input: StartMedicalTranscriptionJobRequest) -> EventLoopFuture<StartMedicalTranscriptionJobResponse>


                    
                    
                    startTranscriptionJob(_:)

Starts an asynchronous job to transcribe speech to text.

Declaration

Swift

public func startTranscriptionJob(_ input: StartTranscriptionJobRequest) -> EventLoopFuture<StartTranscriptionJobResponse>

updateMedicalVocabulary(_:)
Updates a vocabulary with new values that you provide in a different text file from the one you used to create the vocabulary. The UpdateMedicalVocabulary operation overwrites all of the existing information with the values that you provide in the request.
Declaration
Swift

public func updateMedicalVocabulary(_ input: UpdateMedicalVocabularyRequest) -> EventLoopFuture<UpdateMedicalVocabularyResponse>
updateVocabulary(_:)
Updates an existing vocabulary with new values. The UpdateVocabulary operation overwrites all of the existing information with the values that you provide in the request.
Declaration
Swift

public func updateVocabulary(_ input: UpdateVocabularyRequest) -> EventLoopFuture<UpdateVocabularyResponse>


                    
                    
                    updateVocabularyFilter(_:)

Updates a vocabulary filter with a new list of filtered words.

Declaration

Swift

public func updateVocabularyFilter(_ input: UpdateVocabularyFilterRequest) -> EventLoopFuture<UpdateVocabularyFilterResponse>

Paginators

listLanguageModelsPaginator(_:onPage:)
Provides more information about the custom language models you’ve created. You can use the information in this list to find a specific custom language model. You can then use the operation to get more information about it.
Declaration
Swift

public func listLanguageModelsPaginator(_ input: ListLanguageModelsRequest, onPage: @escaping (ListLanguageModelsResponse, EventLoop) -> EventLoopFuture<Bool>) -> EventLoopFuture<Void>


                    
                    
                    listMedicalTranscriptionJobsPaginator(_:onPage:)

Lists medical transcription jobs with a specified status or substring that matches their names.

Declaration

Swift

public func listMedicalTranscriptionJobsPaginator(_ input: ListMedicalTranscriptionJobsRequest, onPage: @escaping (ListMedicalTranscriptionJobsResponse, EventLoop) -> EventLoopFuture<Bool>) -> EventLoopFuture<Void>

listMedicalVocabulariesPaginator(_:onPage:)
Returns a list of vocabularies that match the specified criteria. If you don’t enter a value in any of the request parameters, returns the entire list of vocabularies.
Declaration
Swift

public func listMedicalVocabulariesPaginator(_ input: ListMedicalVocabulariesRequest, onPage: @escaping (ListMedicalVocabulariesResponse, EventLoop) -> EventLoopFuture<Bool>) -> EventLoopFuture<Void>


                    
                    
                    listTranscriptionJobsPaginator(_:onPage:)

Lists transcription jobs with the specified status.

Declaration

Swift

public func listTranscriptionJobsPaginator(_ input: ListTranscriptionJobsRequest, onPage: @escaping (ListTranscriptionJobsResponse, EventLoop) -> EventLoopFuture<Bool>) -> EventLoopFuture<Void>


                    
                    
                    listVocabulariesPaginator(_:onPage:)

Returns a list of vocabularies that match the specified criteria. If no criteria are specified, returns the entire list of vocabularies.

Declaration

Swift

public func listVocabulariesPaginator(_ input: ListVocabulariesRequest, onPage: @escaping (ListVocabulariesResponse, EventLoop) -> EventLoopFuture<Bool>) -> EventLoopFuture<Void>


                    
                    
                    listVocabularyFiltersPaginator(_:onPage:)

Gets information about vocabulary filters.

Declaration

Swift

public func listVocabularyFiltersPaginator(_ input: ListVocabularyFiltersRequest, onPage: @escaping (ListVocabularyFiltersResponse, EventLoop) -> EventLoopFuture<Bool>) -> EventLoopFuture<Void>

Shapes


                    
                    
                    ListLanguageModelsRequest

Undocumented

Declaration

Swift

public struct ListLanguageModelsRequest : AWSShape

extension TranscribeService.ListLanguageModelsRequest: AWSPaginateStringToken


                    
                    
                    ListMedicalTranscriptionJobsRequest

Undocumented

Declaration

Swift

public struct ListMedicalTranscriptionJobsRequest : AWSShape

extension TranscribeService.ListMedicalTranscriptionJobsRequest: AWSPaginateStringToken


                    
                    
                    ListMedicalVocabulariesRequest

Undocumented

Declaration

Swift

public struct ListMedicalVocabulariesRequest : AWSShape

extension TranscribeService.ListMedicalVocabulariesRequest: AWSPaginateStringToken


                    
                    
                    ListTranscriptionJobsRequest

Undocumented

Declaration

Swift

public struct ListTranscriptionJobsRequest : AWSShape

extension TranscribeService.ListTranscriptionJobsRequest: AWSPaginateStringToken


                    
                    
                    ListVocabulariesRequest

Undocumented

Declaration

Swift

public struct ListVocabulariesRequest : AWSShape

extension TranscribeService.ListVocabulariesRequest: AWSPaginateStringToken


                    
                    
                    ListVocabularyFiltersRequest

Undocumented

Declaration

Swift

public struct ListVocabularyFiltersRequest : AWSShape

extension TranscribeService.ListVocabularyFiltersRequest: AWSPaginateStringToken

ContentRedaction
Undocumented
See more
Declaration
Swift

public struct ContentRedaction : AWSShape
CreateLanguageModelRequest
Undocumented
See more
Declaration
Swift

public struct CreateLanguageModelRequest : AWSShape
CreateLanguageModelResponse
Undocumented
See more
Declaration
Swift

public struct CreateLanguageModelResponse : AWSShape
CreateMedicalVocabularyRequest
Undocumented
See more
Declaration
Swift

public struct CreateMedicalVocabularyRequest : AWSShape
CreateMedicalVocabularyResponse
Undocumented
See more
Declaration
Swift

public struct CreateMedicalVocabularyResponse : AWSShape
CreateVocabularyFilterRequest
Undocumented
See more
Declaration
Swift

public struct CreateVocabularyFilterRequest : AWSShape
CreateVocabularyFilterResponse
Undocumented
See more
Declaration
Swift

public struct CreateVocabularyFilterResponse : AWSShape
CreateVocabularyRequest
Undocumented
See more
Declaration
Swift

public struct CreateVocabularyRequest : AWSShape
CreateVocabularyResponse
Undocumented
See more
Declaration
Swift

public struct CreateVocabularyResponse : AWSShape
DeleteLanguageModelRequest
Undocumented
See more
Declaration
Swift

public struct DeleteLanguageModelRequest : AWSShape
DeleteMedicalTranscriptionJobRequest
Undocumented
See more
Declaration
Swift

public struct DeleteMedicalTranscriptionJobRequest : AWSShape
DeleteMedicalVocabularyRequest
Undocumented
See more
Declaration
Swift

public struct DeleteMedicalVocabularyRequest : AWSShape
DeleteTranscriptionJobRequest
Undocumented
See more
Declaration
Swift

public struct DeleteTranscriptionJobRequest : AWSShape
DeleteVocabularyFilterRequest
Undocumented
See more
Declaration
Swift

public struct DeleteVocabularyFilterRequest : AWSShape
DeleteVocabularyRequest
Undocumented
See more
Declaration
Swift

public struct DeleteVocabularyRequest : AWSShape
DescribeLanguageModelRequest
Undocumented
See more
Declaration
Swift

public struct DescribeLanguageModelRequest : AWSShape
DescribeLanguageModelResponse
Undocumented
See more
Declaration
Swift

public struct DescribeLanguageModelResponse : AWSShape
GetMedicalTranscriptionJobRequest
Undocumented
See more
Declaration
Swift

public struct GetMedicalTranscriptionJobRequest : AWSShape
GetMedicalTranscriptionJobResponse
Undocumented
See more
Declaration
Swift

public struct GetMedicalTranscriptionJobResponse : AWSShape
GetMedicalVocabularyRequest
Undocumented
See more
Declaration
Swift

public struct GetMedicalVocabularyRequest : AWSShape
GetMedicalVocabularyResponse
Undocumented
See more
Declaration
Swift

public struct GetMedicalVocabularyResponse : AWSShape
GetTranscriptionJobRequest
Undocumented
See more
Declaration
Swift

public struct GetTranscriptionJobRequest : AWSShape
GetTranscriptionJobResponse
Undocumented
See more
Declaration
Swift

public struct GetTranscriptionJobResponse : AWSShape
GetVocabularyFilterRequest
Undocumented
See more
Declaration
Swift

public struct GetVocabularyFilterRequest : AWSShape
GetVocabularyFilterResponse
Undocumented
See more
Declaration
Swift

public struct GetVocabularyFilterResponse : AWSShape
GetVocabularyRequest
Undocumented
See more
Declaration
Swift

public struct GetVocabularyRequest : AWSShape
GetVocabularyResponse
Undocumented
See more
Declaration
Swift

public struct GetVocabularyResponse : AWSShape
InputDataConfig
Undocumented
See more
Declaration
Swift

public struct InputDataConfig : AWSShape
JobExecutionSettings
Undocumented
See more
Declaration
Swift

public struct JobExecutionSettings : AWSShape
LanguageModel
Undocumented
See more
Declaration
Swift

public struct LanguageModel : AWSShape
ListLanguageModelsResponse
Undocumented
See more
Declaration
Swift

public struct ListLanguageModelsResponse : AWSShape
ListMedicalTranscriptionJobsResponse
Undocumented
See more
Declaration
Swift

public struct ListMedicalTranscriptionJobsResponse : AWSShape
ListMedicalVocabulariesResponse
Undocumented
See more
Declaration
Swift

public struct ListMedicalVocabulariesResponse : AWSShape
ListTranscriptionJobsResponse
Undocumented
See more
Declaration
Swift

public struct ListTranscriptionJobsResponse : AWSShape
ListVocabulariesResponse
Undocumented
See more
Declaration
Swift

public struct ListVocabulariesResponse : AWSShape
ListVocabularyFiltersResponse
Undocumented
See more
Declaration
Swift

public struct ListVocabularyFiltersResponse : AWSShape
Media
Undocumented
See more
Declaration
Swift

public struct Media : AWSShape
MedicalTranscript
Undocumented
See more
Declaration
Swift

public struct MedicalTranscript : AWSShape
MedicalTranscriptionJob
Undocumented
See more
Declaration
Swift

public struct MedicalTranscriptionJob : AWSShape
MedicalTranscriptionJobSummary
Undocumented
See more
Declaration
Swift

public struct MedicalTranscriptionJobSummary : AWSShape
MedicalTranscriptionSetting
Undocumented
See more
Declaration
Swift

public struct MedicalTranscriptionSetting : AWSShape
ModelSettings
Undocumented
See more
Declaration
Swift

public struct ModelSettings : AWSShape
Settings
Undocumented
See more
Declaration
Swift

public struct Settings : AWSShape
StartMedicalTranscriptionJobRequest
Undocumented
See more
Declaration
Swift

public struct StartMedicalTranscriptionJobRequest : AWSShape
StartMedicalTranscriptionJobResponse
Undocumented
See more
Declaration
Swift

public struct StartMedicalTranscriptionJobResponse : AWSShape
StartTranscriptionJobRequest
Undocumented
See more
Declaration
Swift

public struct StartTranscriptionJobRequest : AWSShape
StartTranscriptionJobResponse
Undocumented
See more
Declaration
Swift

public struct StartTranscriptionJobResponse : AWSShape
Transcript
Undocumented
See more
Declaration
Swift

public struct Transcript : AWSShape
TranscriptionJob
Undocumented
See more
Declaration
Swift

public struct TranscriptionJob : AWSShape
TranscriptionJobSummary
Undocumented
See more
Declaration
Swift

public struct TranscriptionJobSummary : AWSShape
UpdateMedicalVocabularyRequest
Undocumented
See more
Declaration
Swift

public struct UpdateMedicalVocabularyRequest : AWSShape
UpdateMedicalVocabularyResponse
Undocumented
See more
Declaration
Swift

public struct UpdateMedicalVocabularyResponse : AWSShape
UpdateVocabularyFilterRequest
Undocumented
See more
Declaration
Swift

public struct UpdateVocabularyFilterRequest : AWSShape
UpdateVocabularyFilterResponse
Undocumented
See more
Declaration
Swift

public struct UpdateVocabularyFilterResponse : AWSShape
UpdateVocabularyRequest
Undocumented
See more
Declaration
Swift

public struct UpdateVocabularyRequest : AWSShape
UpdateVocabularyResponse
Undocumented
See more
Declaration
Swift

public struct UpdateVocabularyResponse : AWSShape
VocabularyFilterInfo
Undocumented
See more
Declaration
Swift

public struct VocabularyFilterInfo : AWSShape
VocabularyInfo
Undocumented
See more
Declaration
Swift

public struct VocabularyInfo : AWSShape

Enums


                    
                    
                    BaseModelName

Undocumented

Declaration

Swift

public enum BaseModelName : String, CustomStringConvertible, Codable


                    
                    
                    CLMLanguageCode

Undocumented

Declaration

Swift

public enum CLMLanguageCode : String, CustomStringConvertible, Codable


                    
                    
                    LanguageCode

Undocumented

Declaration

Swift

public enum LanguageCode : String, CustomStringConvertible, Codable


                    
                    
                    MediaFormat

Undocumented

Declaration

Swift

public enum MediaFormat : String, CustomStringConvertible, Codable


                    
                    
                    ModelStatus

Undocumented

Declaration

Swift

public enum ModelStatus : String, CustomStringConvertible, Codable


                    
                    
                    OutputLocationType

Undocumented

Declaration

Swift

public enum OutputLocationType : String, CustomStringConvertible, Codable


                    
                    
                    RedactionOutput

Undocumented

Declaration

Swift

public enum RedactionOutput : String, CustomStringConvertible, Codable


                    
                    
                    RedactionType

Undocumented

Declaration

Swift

public enum RedactionType : String, CustomStringConvertible, Codable


                    
                    
                    Specialty

Undocumented

Declaration

Swift

public enum Specialty : String, CustomStringConvertible, Codable


                    
                    
                    TranscriptionJobStatus

Undocumented

Declaration

Swift

public enum TranscriptionJobStatus : String, CustomStringConvertible, Codable


                    
                    
                    Type

Undocumented

Declaration

Swift

public enum `Type` : String, CustomStringConvertible, Codable


                    
                    
                    VocabularyFilterMethod

Undocumented

Declaration

Swift

public enum VocabularyFilterMethod : String, CustomStringConvertible, Codable


                    
                    
                    VocabularyState

Undocumented

Declaration

Swift

public enum VocabularyState : String, CustomStringConvertible, Codable