Transcribe
Service object for interacting with AWS Transcribe service.
public struct Transcribe: AWSService
Operations and objects for transcribing speech to text.
Inheritance
AWSService
Initializers
init(client:region:partition:endpoint:timeout:byteBufferAllocator:options:)
Initialize the Transcribe client
public init(
client: AWSClient,
region: SotoCore.Region? = nil,
partition: AWSPartition = .aws,
endpoint: String? = nil,
timeout: TimeAmount? = nil,
byteBufferAllocator: ByteBufferAllocator = ByteBufferAllocator(),
options: AWSServiceConfig.Options = []
)
Parameters
- client: AWSClient used to process requests
- region: Region of server you want to communicate with. This will override the partition parameter.
- partition: AWS partition where service resides, standard (.aws), china (.awscn), government (.awsusgov).
- endpoint: Custom endpoint URL to use instead of standard AWS servers
- timeout: Timeout value for HTTP requests
init(from:patch:)
Initializer required by AWSService.with(middlewares:timeout:byteBufferAllocator:options)
. You are not able to use this initializer directly as there are no public initializers for AWSServiceConfig.Patch
. Please use AWSService.with(middlewares:timeout:byteBufferAllocator:options)
instead.
public init(from: Transcribe, patch: AWSServiceConfig.Patch)
Properties
client
Client used for communication with AWS
public let client: AWSClient
config
Service configuration
public let config: AWSServiceConfig
Methods
createCallAnalyticsCategory(_:logger:on:)
public func createCallAnalyticsCategory(_ input: CreateCallAnalyticsCategoryRequest, logger: Logger = AWSClient.loggingDisabled, on eventLoop: EventLoop? = nil) -> EventLoopFuture<CreateCallAnalyticsCategoryResponse>
Creates a call analytics category. Amazon Transcribe applies the conditions specified by your call analytics categories to your call analytics jobs. For each analytics category, you must create between 1 and 20 rules. For example, you can create a 'greeting' category with a rule that flags calls in which your agent does not use a specified phrase (for example: "Please note this call may be recorded.") in the first 15 seconds of the call. When you start a call analytics job, Amazon Transcribe applies all your existing call analytics categories to that job.
createLanguageModel(_:logger:on:)
public func createLanguageModel(_ input: CreateLanguageModelRequest, logger: Logger = AWSClient.loggingDisabled, on eventLoop: EventLoop? = nil) -> EventLoopFuture<CreateLanguageModelResponse>
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. You then include the S3 URI location of your training and tuning files, the language for the model, a unique name, and any tags you want associated with your model.
createMedicalVocabulary(_:logger:on:)
public func createMedicalVocabulary(_ input: CreateMedicalVocabularyRequest, logger: Logger = AWSClient.loggingDisabled, on eventLoop: EventLoop? = nil) -> EventLoopFuture<CreateMedicalVocabularyResponse>
Creates a new custom medical vocabulary.
When creating a new medical vocabulary, you must upload a text file that contains
your new entries, phrases, and terms into an S3 bucket. Note that this differs from
, where you can include a list of terms within
your request using the Phrases
flag, as
CreateMedicalVocabulary
does not support the Phrases
flag.
For more information on creating a custom vocabulary text file, see Creating a custom vocabulary.
createVocabulary(_:logger:on:)
public func createVocabulary(_ input: CreateVocabularyRequest, logger: Logger = AWSClient.loggingDisabled, on eventLoop: EventLoop? = nil) -> EventLoopFuture<CreateVocabularyResponse>
Creates a new custom vocabulary.
When creating a new medical vocabulary, you can either upload a text file that
contains your new entries, phrases, and terms into an S3 bucket or include a list of
terms directly in your request using the Phrases
flag.
For more information on creating a custom vocabulary, see Creating a custom vocabulary.
createVocabularyFilter(_:logger:on:)
public func createVocabularyFilter(_ input: CreateVocabularyFilterRequest, logger: Logger = AWSClient.loggingDisabled, on eventLoop: EventLoop? = nil) -> EventLoopFuture<CreateVocabularyFilterResponse>
Creates a new vocabulary filter that you can use to filter words from your transcription output. For example, you can use this operation to remove profanity from your transcript.
deleteCallAnalyticsCategory(_:logger:on:)
public func deleteCallAnalyticsCategory(_ input: DeleteCallAnalyticsCategoryRequest, logger: Logger = AWSClient.loggingDisabled, on eventLoop: EventLoop? = nil) -> EventLoopFuture<DeleteCallAnalyticsCategoryResponse>
Deletes a call analytics category. To use this operation, specify the name of the
category you want to delete using CategoryName
.
deleteCallAnalyticsJob(_:logger:on:)
public func deleteCallAnalyticsJob(_ input: DeleteCallAnalyticsJobRequest, logger: Logger = AWSClient.loggingDisabled, on eventLoop: EventLoop? = nil) -> EventLoopFuture<DeleteCallAnalyticsJobResponse>
Deletes a call analytics job. To use this operation, specify the name of the
job you want to delete using CallAnalyticsJobName
.
deleteLanguageModel(_:logger:on:)
@discardableResult public func deleteLanguageModel(_ input: DeleteLanguageModelRequest, logger: Logger = AWSClient.loggingDisabled, on eventLoop: EventLoop? = nil) -> EventLoopFuture<Void>
Deletes a custom language model. To use this operation, specify the name of the
language model you want to delete using ModelName
.
deleteMedicalTranscriptionJob(_:logger:on:)
@discardableResult public func deleteMedicalTranscriptionJob(_ input: DeleteMedicalTranscriptionJobRequest, logger: Logger = AWSClient.loggingDisabled, on eventLoop: EventLoop? = nil) -> EventLoopFuture<Void>
Deletes a medical transcription job, along with any related information. To use this
operation, specify the name of the job you want to delete using
MedicalTranscriptionJobName
.
deleteMedicalVocabulary(_:logger:on:)
@discardableResult public func deleteMedicalVocabulary(_ input: DeleteMedicalVocabularyRequest, logger: Logger = AWSClient.loggingDisabled, on eventLoop: EventLoop? = nil) -> EventLoopFuture<Void>
Deletes a custom medical vocabulary. To use this operation, specify the name of the
vocabulary you want to delete using VocabularyName
.
deleteTranscriptionJob(_:logger:on:)
@discardableResult public func deleteTranscriptionJob(_ input: DeleteTranscriptionJobRequest, logger: Logger = AWSClient.loggingDisabled, on eventLoop: EventLoop? = nil) -> EventLoopFuture<Void>
Deletes a transcription job, along with any related information. To use this operation,
specify the name of the job you want to delete using
TranscriptionJobName
.
deleteVocabulary(_:logger:on:)
@discardableResult public func deleteVocabulary(_ input: DeleteVocabularyRequest, logger: Logger = AWSClient.loggingDisabled, on eventLoop: EventLoop? = nil) -> EventLoopFuture<Void>
Deletes a custom vocabulary. To use this operation, specify the name of the vocabulary
you want to delete using VocabularyName
.
deleteVocabularyFilter(_:logger:on:)
@discardableResult public func deleteVocabularyFilter(_ input: DeleteVocabularyFilterRequest, logger: Logger = AWSClient.loggingDisabled, on eventLoop: EventLoop? = nil) -> EventLoopFuture<Void>
Deletes a vocabulary filter. To use this operation, specify the name of the vocabulary
filter you want to delete using VocabularyFilterName
.
describeLanguageModel(_:logger:on:)
public func describeLanguageModel(_ input: DescribeLanguageModelRequest, logger: Logger = AWSClient.loggingDisabled, on eventLoop: EventLoop? = nil) -> EventLoopFuture<DescribeLanguageModelResponse>
Provides information about a specific custom language model in your Amazon Web Services account.
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 this operation to help identify the reason.
getCallAnalyticsCategory(_:logger:on:)
public func getCallAnalyticsCategory(_ input: GetCallAnalyticsCategoryRequest, logger: Logger = AWSClient.loggingDisabled, on eventLoop: EventLoop? = nil) -> EventLoopFuture<GetCallAnalyticsCategoryResponse>
Retrieves information about a call analytics category.
getCallAnalyticsJob(_:logger:on:)
public func getCallAnalyticsJob(_ input: GetCallAnalyticsJobRequest, logger: Logger = AWSClient.loggingDisabled, on eventLoop: EventLoop? = nil) -> EventLoopFuture<GetCallAnalyticsJobResponse>
Retrieves information about a call analytics job.
To view the job's status, refer to the CallAnalyticsJobStatus
field. If the
status is COMPLETED
, the job is finished. You can then find your transcript at
the URI specified in the TranscriptFileUri
field. If you enabled personally
identifiable information (PII) redaction, the redacted transcript appears in the
RedactedTranscriptFileUri
field.
getMedicalTranscriptionJob(_:logger:on:)
public func getMedicalTranscriptionJob(_ input: GetMedicalTranscriptionJobRequest, logger: Logger = AWSClient.loggingDisabled, on eventLoop: EventLoop? = nil) -> EventLoopFuture<GetMedicalTranscriptionJobResponse>
Retrieves information about a medical transcription job.
To view the job's status, refer to the TranscriptionJobStatus
field. If the
status is COMPLETED
, the job is finished. You can then find your transcript at
the URI specified in the TranscriptFileUri
field.
getMedicalVocabulary(_:logger:on:)
public func getMedicalVocabulary(_ input: GetMedicalVocabularyRequest, logger: Logger = AWSClient.loggingDisabled, on eventLoop: EventLoop? = nil) -> EventLoopFuture<GetMedicalVocabularyResponse>
Retrieves information about a medical vocabulary.
getTranscriptionJob(_:logger:on:)
public func getTranscriptionJob(_ input: GetTranscriptionJobRequest, logger: Logger = AWSClient.loggingDisabled, on eventLoop: EventLoop? = nil) -> EventLoopFuture<GetTranscriptionJobResponse>
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
.
getVocabulary(_:logger:on:)
public func getVocabulary(_ input: GetVocabularyRequest, logger: Logger = AWSClient.loggingDisabled, on eventLoop: EventLoop? = nil) -> EventLoopFuture<GetVocabularyResponse>
Gets information about a vocabulary.
getVocabularyFilter(_:logger:on:)
public func getVocabularyFilter(_ input: GetVocabularyFilterRequest, logger: Logger = AWSClient.loggingDisabled, on eventLoop: EventLoop? = nil) -> EventLoopFuture<GetVocabularyFilterResponse>
Returns information about a vocabulary filter.
listCallAnalyticsCategories(_:logger:on:)
public func listCallAnalyticsCategories(_ input: ListCallAnalyticsCategoriesRequest, logger: Logger = AWSClient.loggingDisabled, on eventLoop: EventLoop? = nil) -> EventLoopFuture<ListCallAnalyticsCategoriesResponse>
Provides more information about the call analytics categories that you've created. You can use the information in this list to find a specific category. You can then use the operation to get more information about it.
listCallAnalyticsJobs(_:logger:on:)
public func listCallAnalyticsJobs(_ input: ListCallAnalyticsJobsRequest, logger: Logger = AWSClient.loggingDisabled, on eventLoop: EventLoop? = nil) -> EventLoopFuture<ListCallAnalyticsJobsResponse>
List call analytics jobs with a specified status or substring that matches their names.
listLanguageModels(_:logger:on:)
public func listLanguageModels(_ input: ListLanguageModelsRequest, logger: Logger = AWSClient.loggingDisabled, on eventLoop: EventLoop? = nil) -> EventLoopFuture<ListLanguageModelsResponse>
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.
listMedicalTranscriptionJobs(_:logger:on:)
public func listMedicalTranscriptionJobs(_ input: ListMedicalTranscriptionJobsRequest, logger: Logger = AWSClient.loggingDisabled, on eventLoop: EventLoop? = nil) -> EventLoopFuture<ListMedicalTranscriptionJobsResponse>
Lists medical transcription jobs with a specified status or substring that matches their names.
listMedicalVocabularies(_:logger:on:)
public func listMedicalVocabularies(_ input: ListMedicalVocabulariesRequest, logger: Logger = AWSClient.loggingDisabled, on eventLoop: EventLoop? = nil) -> EventLoopFuture<ListMedicalVocabulariesResponse>
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.
listTagsForResource(_:logger:on:)
public func listTagsForResource(_ input: ListTagsForResourceRequest, logger: Logger = AWSClient.loggingDisabled, on eventLoop: EventLoop? = nil) -> EventLoopFuture<ListTagsForResourceResponse>
Lists all tags associated with a given transcription job, vocabulary, or resource.
listTranscriptionJobs(_:logger:on:)
public func listTranscriptionJobs(_ input: ListTranscriptionJobsRequest, logger: Logger = AWSClient.loggingDisabled, on eventLoop: EventLoop? = nil) -> EventLoopFuture<ListTranscriptionJobsResponse>
Lists transcription jobs with the specified status.
listVocabularies(_:logger:on:)
public func listVocabularies(_ input: ListVocabulariesRequest, logger: Logger = AWSClient.loggingDisabled, on eventLoop: EventLoop? = nil) -> EventLoopFuture<ListVocabulariesResponse>
Returns a list of vocabularies that match the specified criteria. If no criteria are specified, returns the entire list of vocabularies.
listVocabularyFilters(_:logger:on:)
public func listVocabularyFilters(_ input: ListVocabularyFiltersRequest, logger: Logger = AWSClient.loggingDisabled, on eventLoop: EventLoop? = nil) -> EventLoopFuture<ListVocabularyFiltersResponse>
Gets information about vocabulary filters.
startCallAnalyticsJob(_:logger:on:)
public func startCallAnalyticsJob(_ input: StartCallAnalyticsJobRequest, logger: Logger = AWSClient.loggingDisabled, on eventLoop: EventLoop? = nil) -> EventLoopFuture<StartCallAnalyticsJobResponse>
Starts an asynchronous analytics job that not only transcribes the audio recording of a caller and agent, but also returns additional insights. These insights include how quickly or loudly the caller or agent was speaking. To retrieve additional insights with your analytics jobs, create categories. A category is a way to classify analytics jobs based on attributes, such as a customer's sentiment or a particular phrase being used during the call. For more information, see the operation.
startMedicalTranscriptionJob(_:logger:on:)
public func startMedicalTranscriptionJob(_ input: StartMedicalTranscriptionJobRequest, logger: Logger = AWSClient.loggingDisabled, on eventLoop: EventLoop? = nil) -> EventLoopFuture<StartMedicalTranscriptionJobResponse>
Starts a batch job to transcribe medical speech to text.
startTranscriptionJob(_:logger:on:)
public func startTranscriptionJob(_ input: StartTranscriptionJobRequest, logger: Logger = AWSClient.loggingDisabled, on eventLoop: EventLoop? = nil) -> EventLoopFuture<StartTranscriptionJobResponse>
Starts an asynchronous job to transcribe speech to text.
tagResource(_:logger:on:)
public func tagResource(_ input: TagResourceRequest, logger: Logger = AWSClient.loggingDisabled, on eventLoop: EventLoop? = nil) -> EventLoopFuture<TagResourceResponse>
Tags an Amazon Transcribe resource with the given list of tags.
untagResource(_:logger:on:)
public func untagResource(_ input: UntagResourceRequest, logger: Logger = AWSClient.loggingDisabled, on eventLoop: EventLoop? = nil) -> EventLoopFuture<UntagResourceResponse>
Removes specified tags from a specified Amazon Transcribe resource.
updateCallAnalyticsCategory(_:logger:on:)
public func updateCallAnalyticsCategory(_ input: UpdateCallAnalyticsCategoryRequest, logger: Logger = AWSClient.loggingDisabled, on eventLoop: EventLoop? = nil) -> EventLoopFuture<UpdateCallAnalyticsCategoryResponse>
Updates the call analytics category with new values. The
UpdateCallAnalyticsCategory
operation overwrites all of the existing
information with the values that you provide in the request.
updateMedicalVocabulary(_:logger:on:)
public func updateMedicalVocabulary(_ input: UpdateMedicalVocabularyRequest, logger: Logger = AWSClient.loggingDisabled, on eventLoop: EventLoop? = nil) -> EventLoopFuture<UpdateMedicalVocabularyResponse>
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.
updateVocabulary(_:logger:on:)
public func updateVocabulary(_ input: UpdateVocabularyRequest, logger: Logger = AWSClient.loggingDisabled, on eventLoop: EventLoop? = nil) -> EventLoopFuture<UpdateVocabularyResponse>
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.
updateVocabularyFilter(_:logger:on:)
public func updateVocabularyFilter(_ input: UpdateVocabularyFilterRequest, logger: Logger = AWSClient.loggingDisabled, on eventLoop: EventLoop? = nil) -> EventLoopFuture<UpdateVocabularyFilterResponse>
Updates a vocabulary filter with a new list of filtered words.
listCallAnalyticsCategoriesPaginator(_:logger:on:)
compiler(>=5.5.2) && canImport(_Concurrency)
public func listCallAnalyticsCategoriesPaginator( _ input: ListCallAnalyticsCategoriesRequest, logger: Logger = AWSClient.loggingDisabled, on eventLoop: EventLoop? = nil ) -> AWSClient.PaginatorSequence<ListCallAnalyticsCategoriesRequest, ListCallAnalyticsCategoriesResponse>
Provides more information about the call analytics categories that you've created. You can use the information in this list to find a specific category. You can then use the operation to get more information about it.
Return PaginatorSequence for operation. - Parameters: - input: Input for request - logger: Logger used flot logging - eventLoop: EventLoop to run this process on
listCallAnalyticsJobsPaginator(_:logger:on:)
compiler(>=5.5.2) && canImport(_Concurrency)
public func listCallAnalyticsJobsPaginator( _ input: ListCallAnalyticsJobsRequest, logger: Logger = AWSClient.loggingDisabled, on eventLoop: EventLoop? = nil ) -> AWSClient.PaginatorSequence<ListCallAnalyticsJobsRequest, ListCallAnalyticsJobsResponse>
List call analytics jobs with a specified status or substring that matches their names.
Return PaginatorSequence for operation. - Parameters: - input: Input for request - logger: Logger used flot logging - eventLoop: EventLoop to run this process on
listLanguageModelsPaginator(_:logger:on:)
compiler(>=5.5.2) && canImport(_Concurrency)
public func listLanguageModelsPaginator( _ input: ListLanguageModelsRequest, logger: Logger = AWSClient.loggingDisabled, on eventLoop: EventLoop? = nil ) -> AWSClient.PaginatorSequence<ListLanguageModelsRequest, ListLanguageModelsResponse>
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.
Return PaginatorSequence for operation. - Parameters: - input: Input for request - logger: Logger used flot logging - eventLoop: EventLoop to run this process on
listMedicalTranscriptionJobsPaginator(_:logger:on:)
compiler(>=5.5.2) && canImport(_Concurrency)
public func listMedicalTranscriptionJobsPaginator( _ input: ListMedicalTranscriptionJobsRequest, logger: Logger = AWSClient.loggingDisabled, on eventLoop: EventLoop? = nil ) -> AWSClient.PaginatorSequence<ListMedicalTranscriptionJobsRequest, ListMedicalTranscriptionJobsResponse>
Lists medical transcription jobs with a specified status or substring that matches their names.
Return PaginatorSequence for operation. - Parameters: - input: Input for request - logger: Logger used flot logging - eventLoop: EventLoop to run this process on
listMedicalVocabulariesPaginator(_:logger:on:)
compiler(>=5.5.2) && canImport(_Concurrency)
public func listMedicalVocabulariesPaginator( _ input: ListMedicalVocabulariesRequest, logger: Logger = AWSClient.loggingDisabled, on eventLoop: EventLoop? = nil ) -> AWSClient.PaginatorSequence<ListMedicalVocabulariesRequest, ListMedicalVocabulariesResponse>
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.
Return PaginatorSequence for operation. - Parameters: - input: Input for request - logger: Logger used flot logging - eventLoop: EventLoop to run this process on
listTranscriptionJobsPaginator(_:logger:on:)
compiler(>=5.5.2) && canImport(_Concurrency)
public func listTranscriptionJobsPaginator( _ input: ListTranscriptionJobsRequest, logger: Logger = AWSClient.loggingDisabled, on eventLoop: EventLoop? = nil ) -> AWSClient.PaginatorSequence<ListTranscriptionJobsRequest, ListTranscriptionJobsResponse>
Lists transcription jobs with the specified status.
Return PaginatorSequence for operation. - Parameters: - input: Input for request - logger: Logger used flot logging - eventLoop: EventLoop to run this process on
listVocabulariesPaginator(_:logger:on:)
compiler(>=5.5.2) && canImport(_Concurrency)
public func listVocabulariesPaginator( _ input: ListVocabulariesRequest, logger: Logger = AWSClient.loggingDisabled, on eventLoop: EventLoop? = nil ) -> AWSClient.PaginatorSequence<ListVocabulariesRequest, ListVocabulariesResponse>
Returns a list of vocabularies that match the specified criteria. If no criteria are specified, returns the entire list of vocabularies.
Return PaginatorSequence for operation. - Parameters: - input: Input for request - logger: Logger used flot logging - eventLoop: EventLoop to run this process on
listVocabularyFiltersPaginator(_:logger:on:)
compiler(>=5.5.2) && canImport(_Concurrency)
public func listVocabularyFiltersPaginator( _ input: ListVocabularyFiltersRequest, logger: Logger = AWSClient.loggingDisabled, on eventLoop: EventLoop? = nil ) -> AWSClient.PaginatorSequence<ListVocabularyFiltersRequest, ListVocabularyFiltersResponse>
Gets information about vocabulary filters.
Return PaginatorSequence for operation. - Parameters: - input: Input for request - logger: Logger used flot logging - eventLoop: EventLoop to run this process on
listCallAnalyticsCategoriesPaginator(_:_:logger:on:onPage:)
Provide paginated results to closure onPage
for it to combine them into one result. This works in a similar manner to Array.reduce<Result>(_:_:) -> Result
.
public func listCallAnalyticsCategoriesPaginator<Result>(
_ input: ListCallAnalyticsCategoriesRequest,
_ initialValue: Result,
logger: Logger = AWSClient.loggingDisabled,
on eventLoop: EventLoop? = nil,
onPage: @escaping (Result, ListCallAnalyticsCategoriesResponse, EventLoop) -> EventLoopFuture<(Bool, Result)>
) -> EventLoopFuture<Result>
Provides more information about the call analytics categories that you've created. You can use the information in this list to find a specific category. You can then use the operation to get more information about it.
Parameters:
- input: Input for request
- initialValue: The value to use as the initial accumulating value.
initialValue
is passed toonPage
the first time it is called.
- logger: Logger used flot logging
- eventLoop: EventLoop to run this process on
- onPage: closure called with each paginated response. It combines an accumulating result with the contents of response. This combined result is then returned along with a boolean indicating if the paginate operation should continue.
listCallAnalyticsCategoriesPaginator(_:logger:on:onPage:)
Provide paginated results to closure onPage
.
public func listCallAnalyticsCategoriesPaginator(
_ input: ListCallAnalyticsCategoriesRequest,
logger: Logger = AWSClient.loggingDisabled,
on eventLoop: EventLoop? = nil,
onPage: @escaping (ListCallAnalyticsCategoriesResponse, EventLoop) -> EventLoopFuture<Bool>
) -> EventLoopFuture<Void>
Parameters
- input: Input for request
- logger: Logger used flot logging
- eventLoop: EventLoop to run this process on
- onPage: closure called with each block of entries. Returns boolean indicating whether we should continue.
listCallAnalyticsJobsPaginator(_:_:logger:on:onPage:)
Provide paginated results to closure onPage
for it to combine them into one result. This works in a similar manner to Array.reduce<Result>(_:_:) -> Result
.
public func listCallAnalyticsJobsPaginator<Result>(
_ input: ListCallAnalyticsJobsRequest,
_ initialValue: Result,
logger: Logger = AWSClient.loggingDisabled,
on eventLoop: EventLoop? = nil,
onPage: @escaping (Result, ListCallAnalyticsJobsResponse, EventLoop) -> EventLoopFuture<(Bool, Result)>
) -> EventLoopFuture<Result>
List call analytics jobs with a specified status or substring that matches their names.
Parameters:
- input: Input for request
- initialValue: The value to use as the initial accumulating value.
initialValue
is passed toonPage
the first time it is called.
- logger: Logger used flot logging
- eventLoop: EventLoop to run this process on
- onPage: closure called with each paginated response. It combines an accumulating result with the contents of response. This combined result is then returned along with a boolean indicating if the paginate operation should continue.
listCallAnalyticsJobsPaginator(_:logger:on:onPage:)
Provide paginated results to closure onPage
.
public func listCallAnalyticsJobsPaginator(
_ input: ListCallAnalyticsJobsRequest,
logger: Logger = AWSClient.loggingDisabled,
on eventLoop: EventLoop? = nil,
onPage: @escaping (ListCallAnalyticsJobsResponse, EventLoop) -> EventLoopFuture<Bool>
) -> EventLoopFuture<Void>
Parameters
- input: Input for request
- logger: Logger used flot logging
- eventLoop: EventLoop to run this process on
- onPage: closure called with each block of entries. Returns boolean indicating whether we should continue.
listLanguageModelsPaginator(_:_:logger:on:onPage:)
Provide paginated results to closure onPage
for it to combine them into one result. This works in a similar manner to Array.reduce<Result>(_:_:) -> Result
.
public func listLanguageModelsPaginator<Result>(
_ input: ListLanguageModelsRequest,
_ initialValue: Result,
logger: Logger = AWSClient.loggingDisabled,
on eventLoop: EventLoop? = nil,
onPage: @escaping (Result, ListLanguageModelsResponse, EventLoop) -> EventLoopFuture<(Bool, Result)>
) -> EventLoopFuture<Result>
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.
Parameters:
- input: Input for request
- initialValue: The value to use as the initial accumulating value.
initialValue
is passed toonPage
the first time it is called.
- logger: Logger used flot logging
- eventLoop: EventLoop to run this process on
- onPage: closure called with each paginated response. It combines an accumulating result with the contents of response. This combined result is then returned along with a boolean indicating if the paginate operation should continue.
listLanguageModelsPaginator(_:logger:on:onPage:)
Provide paginated results to closure onPage
.
public func listLanguageModelsPaginator(
_ input: ListLanguageModelsRequest,
logger: Logger = AWSClient.loggingDisabled,
on eventLoop: EventLoop? = nil,
onPage: @escaping (ListLanguageModelsResponse, EventLoop) -> EventLoopFuture<Bool>
) -> EventLoopFuture<Void>
Parameters
- input: Input for request
- logger: Logger used flot logging
- eventLoop: EventLoop to run this process on
- onPage: closure called with each block of entries. Returns boolean indicating whether we should continue.
listMedicalTranscriptionJobsPaginator(_:_:logger:on:onPage:)
Provide paginated results to closure onPage
for it to combine them into one result. This works in a similar manner to Array.reduce<Result>(_:_:) -> Result
.
public func listMedicalTranscriptionJobsPaginator<Result>(
_ input: ListMedicalTranscriptionJobsRequest,
_ initialValue: Result,
logger: Logger = AWSClient.loggingDisabled,
on eventLoop: EventLoop? = nil,
onPage: @escaping (Result, ListMedicalTranscriptionJobsResponse, EventLoop) -> EventLoopFuture<(Bool, Result)>
) -> EventLoopFuture<Result>
Lists medical transcription jobs with a specified status or substring that matches their names.
Parameters:
- input: Input for request
- initialValue: The value to use as the initial accumulating value.
initialValue
is passed toonPage
the first time it is called.
- logger: Logger used flot logging
- eventLoop: EventLoop to run this process on
- onPage: closure called with each paginated response. It combines an accumulating result with the contents of response. This combined result is then returned along with a boolean indicating if the paginate operation should continue.
listMedicalTranscriptionJobsPaginator(_:logger:on:onPage:)
Provide paginated results to closure onPage
.
public func listMedicalTranscriptionJobsPaginator(
_ input: ListMedicalTranscriptionJobsRequest,
logger: Logger = AWSClient.loggingDisabled,
on eventLoop: EventLoop? = nil,
onPage: @escaping (ListMedicalTranscriptionJobsResponse, EventLoop) -> EventLoopFuture<Bool>
) -> EventLoopFuture<Void>
Parameters
- input: Input for request
- logger: Logger used flot logging
- eventLoop: EventLoop to run this process on
- onPage: closure called with each block of entries. Returns boolean indicating whether we should continue.
listMedicalVocabulariesPaginator(_:_:logger:on:onPage:)
Provide paginated results to closure onPage
for it to combine them into one result. This works in a similar manner to Array.reduce<Result>(_:_:) -> Result
.
public func listMedicalVocabulariesPaginator<Result>(
_ input: ListMedicalVocabulariesRequest,
_ initialValue: Result,
logger: Logger = AWSClient.loggingDisabled,
on eventLoop: EventLoop? = nil,
onPage: @escaping (Result, ListMedicalVocabulariesResponse, EventLoop) -> EventLoopFuture<(Bool, Result)>
) -> EventLoopFuture<Result>
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.
Parameters:
- input: Input for request
- initialValue: The value to use as the initial accumulating value.
initialValue
is passed toonPage
the first time it is called.
- logger: Logger used flot logging
- eventLoop: EventLoop to run this process on
- onPage: closure called with each paginated response. It combines an accumulating result with the contents of response. This combined result is then returned along with a boolean indicating if the paginate operation should continue.
listMedicalVocabulariesPaginator(_:logger:on:onPage:)
Provide paginated results to closure onPage
.
public func listMedicalVocabulariesPaginator(
_ input: ListMedicalVocabulariesRequest,
logger: Logger = AWSClient.loggingDisabled,
on eventLoop: EventLoop? = nil,
onPage: @escaping (ListMedicalVocabulariesResponse, EventLoop) -> EventLoopFuture<Bool>
) -> EventLoopFuture<Void>
Parameters
- input: Input for request
- logger: Logger used flot logging
- eventLoop: EventLoop to run this process on
- onPage: closure called with each block of entries. Returns boolean indicating whether we should continue.
listTranscriptionJobsPaginator(_:_:logger:on:onPage:)
Provide paginated results to closure onPage
for it to combine them into one result. This works in a similar manner to Array.reduce<Result>(_:_:) -> Result
.
public func listTranscriptionJobsPaginator<Result>(
_ input: ListTranscriptionJobsRequest,
_ initialValue: Result,
logger: Logger = AWSClient.loggingDisabled,
on eventLoop: EventLoop? = nil,
onPage: @escaping (Result, ListTranscriptionJobsResponse, EventLoop) -> EventLoopFuture<(Bool, Result)>
) -> EventLoopFuture<Result>
Lists transcription jobs with the specified status.
Parameters:
- input: Input for request
- initialValue: The value to use as the initial accumulating value.
initialValue
is passed toonPage
the first time it is called.
- logger: Logger used flot logging
- eventLoop: EventLoop to run this process on
- onPage: closure called with each paginated response. It combines an accumulating result with the contents of response. This combined result is then returned along with a boolean indicating if the paginate operation should continue.
listTranscriptionJobsPaginator(_:logger:on:onPage:)
Provide paginated results to closure onPage
.
public func listTranscriptionJobsPaginator(
_ input: ListTranscriptionJobsRequest,
logger: Logger = AWSClient.loggingDisabled,
on eventLoop: EventLoop? = nil,
onPage: @escaping (ListTranscriptionJobsResponse, EventLoop) -> EventLoopFuture<Bool>
) -> EventLoopFuture<Void>
Parameters
- input: Input for request
- logger: Logger used flot logging
- eventLoop: EventLoop to run this process on
- onPage: closure called with each block of entries. Returns boolean indicating whether we should continue.
listVocabulariesPaginator(_:_:logger:on:onPage:)
Provide paginated results to closure onPage
for it to combine them into one result. This works in a similar manner to Array.reduce<Result>(_:_:) -> Result
.
public func listVocabulariesPaginator<Result>(
_ input: ListVocabulariesRequest,
_ initialValue: Result,
logger: Logger = AWSClient.loggingDisabled,
on eventLoop: EventLoop? = nil,
onPage: @escaping (Result, ListVocabulariesResponse, EventLoop) -> EventLoopFuture<(Bool, Result)>
) -> EventLoopFuture<Result>
Returns a list of vocabularies that match the specified criteria. If no criteria are specified, returns the entire list of vocabularies.
Parameters:
- input: Input for request
- initialValue: The value to use as the initial accumulating value.
initialValue
is passed toonPage
the first time it is called.
- logger: Logger used flot logging
- eventLoop: EventLoop to run this process on
- onPage: closure called with each paginated response. It combines an accumulating result with the contents of response. This combined result is then returned along with a boolean indicating if the paginate operation should continue.
listVocabulariesPaginator(_:logger:on:onPage:)
Provide paginated results to closure onPage
.
public func listVocabulariesPaginator(
_ input: ListVocabulariesRequest,
logger: Logger = AWSClient.loggingDisabled,
on eventLoop: EventLoop? = nil,
onPage: @escaping (ListVocabulariesResponse, EventLoop) -> EventLoopFuture<Bool>
) -> EventLoopFuture<Void>
Parameters
- input: Input for request
- logger: Logger used flot logging
- eventLoop: EventLoop to run this process on
- onPage: closure called with each block of entries. Returns boolean indicating whether we should continue.
listVocabularyFiltersPaginator(_:_:logger:on:onPage:)
Provide paginated results to closure onPage
for it to combine them into one result. This works in a similar manner to Array.reduce<Result>(_:_:) -> Result
.
public func listVocabularyFiltersPaginator<Result>(
_ input: ListVocabularyFiltersRequest,
_ initialValue: Result,
logger: Logger = AWSClient.loggingDisabled,
on eventLoop: EventLoop? = nil,
onPage: @escaping (Result, ListVocabularyFiltersResponse, EventLoop) -> EventLoopFuture<(Bool, Result)>
) -> EventLoopFuture<Result>
Gets information about vocabulary filters.
Parameters:
- input: Input for request
- initialValue: The value to use as the initial accumulating value.
initialValue
is passed toonPage
the first time it is called.
- logger: Logger used flot logging
- eventLoop: EventLoop to run this process on
- onPage: closure called with each paginated response. It combines an accumulating result with the contents of response. This combined result is then returned along with a boolean indicating if the paginate operation should continue.
listVocabularyFiltersPaginator(_:logger:on:onPage:)
Provide paginated results to closure onPage
.
public func listVocabularyFiltersPaginator(
_ input: ListVocabularyFiltersRequest,
logger: Logger = AWSClient.loggingDisabled,
on eventLoop: EventLoop? = nil,
onPage: @escaping (ListVocabularyFiltersResponse, EventLoop) -> EventLoopFuture<Bool>
) -> EventLoopFuture<Void>
Parameters
- input: Input for request
- logger: Logger used flot logging
- eventLoop: EventLoop to run this process on
- onPage: closure called with each block of entries. Returns boolean indicating whether we should continue.