// // Copyright 2010-2023 Amazon.com, Inc. or its affiliates. All Rights Reserved. // // Licensed under the Apache License, Version 2.0 (the "License"). // You may not use this file except in compliance with the License. // A copy of the License is located at // // http://aws.amazon.com/apache2.0 // // or in the "license" file accompanying this file. This file is distributed // on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either // express or implied. See the License for the specific language governing // permissions and limitations under the License. // #import #import #import NS_ASSUME_NONNULL_BEGIN FOUNDATION_EXPORT NSString *const AWSTranscribeErrorDomain; typedef NS_ENUM(NSInteger, AWSTranscribeErrorType) { AWSTranscribeErrorUnknown, AWSTranscribeErrorBadRequest, AWSTranscribeErrorConflict, AWSTranscribeErrorInternalFailure, AWSTranscribeErrorLimitExceeded, AWSTranscribeErrorNotFound, }; typedef NS_ENUM(NSInteger, AWSTranscribeBaseModelName) { AWSTranscribeBaseModelNameUnknown, AWSTranscribeBaseModelNameNarrowBand, AWSTranscribeBaseModelNameWideBand, }; typedef NS_ENUM(NSInteger, AWSTranscribeCLMLanguageCode) { AWSTranscribeCLMLanguageCodeUnknown, AWSTranscribeCLMLanguageCodeEnUS, AWSTranscribeCLMLanguageCodeHiIN, AWSTranscribeCLMLanguageCodeEsUS, AWSTranscribeCLMLanguageCodeEnGB, AWSTranscribeCLMLanguageCodeEnAU, AWSTranscribeCLMLanguageCodeDeDE, AWSTranscribeCLMLanguageCodeJaJP, }; typedef NS_ENUM(NSInteger, AWSTranscribeCallAnalyticsJobStatus) { AWSTranscribeCallAnalyticsJobStatusUnknown, AWSTranscribeCallAnalyticsJobStatusQueued, AWSTranscribeCallAnalyticsJobStatusInProgress, AWSTranscribeCallAnalyticsJobStatusFailed, AWSTranscribeCallAnalyticsJobStatusCompleted, }; typedef NS_ENUM(NSInteger, AWSTranscribeInputType) { AWSTranscribeInputTypeUnknown, AWSTranscribeInputTypeRealTime, AWSTranscribeInputTypePostCall, }; typedef NS_ENUM(NSInteger, AWSTranscribeLanguageCode) { AWSTranscribeLanguageCodeUnknown, AWSTranscribeLanguageCodeAfZA, AWSTranscribeLanguageCodeArAE, AWSTranscribeLanguageCodeArSA, AWSTranscribeLanguageCodeDaDK, AWSTranscribeLanguageCodeDeCH, AWSTranscribeLanguageCodeDeDE, AWSTranscribeLanguageCodeEnAB, AWSTranscribeLanguageCodeEnAU, AWSTranscribeLanguageCodeEnGB, AWSTranscribeLanguageCodeEnIE, AWSTranscribeLanguageCodeEnIN, AWSTranscribeLanguageCodeEnUS, AWSTranscribeLanguageCodeEnWL, AWSTranscribeLanguageCodeEsES, AWSTranscribeLanguageCodeEsUS, AWSTranscribeLanguageCodeFaIR, AWSTranscribeLanguageCodeFrCA, AWSTranscribeLanguageCodeFrFR, AWSTranscribeLanguageCodeHeIL, AWSTranscribeLanguageCodeHiIN, AWSTranscribeLanguageCodeIdID, AWSTranscribeLanguageCodeItIT, AWSTranscribeLanguageCodeJaJP, AWSTranscribeLanguageCodeKoKR, AWSTranscribeLanguageCodeMsMY, AWSTranscribeLanguageCodeNlNL, AWSTranscribeLanguageCodePtBR, AWSTranscribeLanguageCodePtPT, AWSTranscribeLanguageCodeRuRU, AWSTranscribeLanguageCodeTaIN, AWSTranscribeLanguageCodeTeIN, AWSTranscribeLanguageCodeTrTR, AWSTranscribeLanguageCodeZhCN, AWSTranscribeLanguageCodeZhTW, AWSTranscribeLanguageCodeThTH, AWSTranscribeLanguageCodeEnZA, AWSTranscribeLanguageCodeEnNZ, AWSTranscribeLanguageCodeViVN, AWSTranscribeLanguageCodeSvSE, }; typedef NS_ENUM(NSInteger, AWSTranscribeMediaFormat) { AWSTranscribeMediaFormatUnknown, AWSTranscribeMediaFormatMp3, AWSTranscribeMediaFormatMp4, AWSTranscribeMediaFormatWav, AWSTranscribeMediaFormatFlac, AWSTranscribeMediaFormatOgg, AWSTranscribeMediaFormatAmr, AWSTranscribeMediaFormatWebm, }; typedef NS_ENUM(NSInteger, AWSTranscribeMedicalContentIdentificationType) { AWSTranscribeMedicalContentIdentificationTypeUnknown, AWSTranscribeMedicalContentIdentificationTypePhi, }; typedef NS_ENUM(NSInteger, AWSTranscribeModelStatus) { AWSTranscribeModelStatusUnknown, AWSTranscribeModelStatusInProgress, AWSTranscribeModelStatusFailed, AWSTranscribeModelStatusCompleted, }; typedef NS_ENUM(NSInteger, AWSTranscribeOutputLocationType) { AWSTranscribeOutputLocationTypeUnknown, AWSTranscribeOutputLocationTypeCustomerBucket, AWSTranscribeOutputLocationTypeServiceBucket, }; typedef NS_ENUM(NSInteger, AWSTranscribeParticipantRole) { AWSTranscribeParticipantRoleUnknown, AWSTranscribeParticipantRoleAgent, AWSTranscribeParticipantRoleCustomer, }; typedef NS_ENUM(NSInteger, AWSTranscribePiiEntityType) { AWSTranscribePiiEntityTypeUnknown, AWSTranscribePiiEntityTypeBankAccountNumber, AWSTranscribePiiEntityTypeBankRouting, AWSTranscribePiiEntityTypeCreditDebitNumber, AWSTranscribePiiEntityTypeCreditDebitCvv, AWSTranscribePiiEntityTypeCreditDebitExpiry, AWSTranscribePiiEntityTypePin, AWSTranscribePiiEntityTypeEmail, AWSTranscribePiiEntityTypeAddress, AWSTranscribePiiEntityTypeName, AWSTranscribePiiEntityTypePhone, AWSTranscribePiiEntityTypeSsn, AWSTranscribePiiEntityTypeAll, }; typedef NS_ENUM(NSInteger, AWSTranscribeRedactionOutput) { AWSTranscribeRedactionOutputUnknown, AWSTranscribeRedactionOutputRedacted, AWSTranscribeRedactionOutputRedactedAndUnredacted, }; typedef NS_ENUM(NSInteger, AWSTranscribeRedactionType) { AWSTranscribeRedactionTypeUnknown, AWSTranscribeRedactionTypePii, }; typedef NS_ENUM(NSInteger, AWSTranscribeSentimentValue) { AWSTranscribeSentimentValueUnknown, AWSTranscribeSentimentValuePositive, AWSTranscribeSentimentValueNegative, AWSTranscribeSentimentValueNeutral, AWSTranscribeSentimentValueMixed, }; typedef NS_ENUM(NSInteger, AWSTranscribeSpecialty) { AWSTranscribeSpecialtyUnknown, AWSTranscribeSpecialtyPrimarycare, }; typedef NS_ENUM(NSInteger, AWSTranscribeSubtitleFormat) { AWSTranscribeSubtitleFormatUnknown, AWSTranscribeSubtitleFormatVtt, AWSTranscribeSubtitleFormatSrt, }; typedef NS_ENUM(NSInteger, AWSTranscribeToxicityCategory) { AWSTranscribeToxicityCategoryUnknown, AWSTranscribeToxicityCategoryAll, }; typedef NS_ENUM(NSInteger, AWSTranscribeTranscriptFilterType) { AWSTranscribeTranscriptFilterTypeUnknown, AWSTranscribeTranscriptFilterTypeExact, }; typedef NS_ENUM(NSInteger, AWSTranscribeTranscriptionJobStatus) { AWSTranscribeTranscriptionJobStatusUnknown, AWSTranscribeTranscriptionJobStatusQueued, AWSTranscribeTranscriptionJobStatusInProgress, AWSTranscribeTranscriptionJobStatusFailed, AWSTranscribeTranscriptionJobStatusCompleted, }; typedef NS_ENUM(NSInteger, AWSTranscribeTypes) { AWSTranscribeTypesUnknown, AWSTranscribeTypesConversation, AWSTranscribeTypesDictation, }; typedef NS_ENUM(NSInteger, AWSTranscribeVocabularyFilterMethod) { AWSTranscribeVocabularyFilterMethodUnknown, AWSTranscribeVocabularyFilterMethodRemove, AWSTranscribeVocabularyFilterMethodMask, AWSTranscribeVocabularyFilterMethodTag, }; typedef NS_ENUM(NSInteger, AWSTranscribeVocabularyState) { AWSTranscribeVocabularyStateUnknown, AWSTranscribeVocabularyStatePending, AWSTranscribeVocabularyStateReady, AWSTranscribeVocabularyStateFailed, }; @class AWSTranscribeAbsoluteTimeRange; @class AWSTranscribeCallAnalyticsJob; @class AWSTranscribeCallAnalyticsJobSettings; @class AWSTranscribeCallAnalyticsJobSummary; @class AWSTranscribeCategoryProperties; @class AWSTranscribeChannelDefinition; @class AWSTranscribeContentRedaction; @class AWSTranscribeCreateCallAnalyticsCategoryRequest; @class AWSTranscribeCreateCallAnalyticsCategoryResponse; @class AWSTranscribeCreateLanguageModelRequest; @class AWSTranscribeCreateLanguageModelResponse; @class AWSTranscribeCreateMedicalVocabularyRequest; @class AWSTranscribeCreateMedicalVocabularyResponse; @class AWSTranscribeCreateVocabularyFilterRequest; @class AWSTranscribeCreateVocabularyFilterResponse; @class AWSTranscribeCreateVocabularyRequest; @class AWSTranscribeCreateVocabularyResponse; @class AWSTranscribeDeleteCallAnalyticsCategoryRequest; @class AWSTranscribeDeleteCallAnalyticsCategoryResponse; @class AWSTranscribeDeleteCallAnalyticsJobRequest; @class AWSTranscribeDeleteCallAnalyticsJobResponse; @class AWSTranscribeDeleteLanguageModelRequest; @class AWSTranscribeDeleteMedicalTranscriptionJobRequest; @class AWSTranscribeDeleteMedicalVocabularyRequest; @class AWSTranscribeDeleteTranscriptionJobRequest; @class AWSTranscribeDeleteVocabularyFilterRequest; @class AWSTranscribeDeleteVocabularyRequest; @class AWSTranscribeDescribeLanguageModelRequest; @class AWSTranscribeDescribeLanguageModelResponse; @class AWSTranscribeGetCallAnalyticsCategoryRequest; @class AWSTranscribeGetCallAnalyticsCategoryResponse; @class AWSTranscribeGetCallAnalyticsJobRequest; @class AWSTranscribeGetCallAnalyticsJobResponse; @class AWSTranscribeGetMedicalTranscriptionJobRequest; @class AWSTranscribeGetMedicalTranscriptionJobResponse; @class AWSTranscribeGetMedicalVocabularyRequest; @class AWSTranscribeGetMedicalVocabularyResponse; @class AWSTranscribeGetTranscriptionJobRequest; @class AWSTranscribeGetTranscriptionJobResponse; @class AWSTranscribeGetVocabularyFilterRequest; @class AWSTranscribeGetVocabularyFilterResponse; @class AWSTranscribeGetVocabularyRequest; @class AWSTranscribeGetVocabularyResponse; @class AWSTranscribeInputDataConfig; @class AWSTranscribeInterruptionFilter; @class AWSTranscribeJobExecutionSettings; @class AWSTranscribeLanguageCodeItem; @class AWSTranscribeLanguageIdSettings; @class AWSTranscribeLanguageModel; @class AWSTranscribeListCallAnalyticsCategoriesRequest; @class AWSTranscribeListCallAnalyticsCategoriesResponse; @class AWSTranscribeListCallAnalyticsJobsRequest; @class AWSTranscribeListCallAnalyticsJobsResponse; @class AWSTranscribeListLanguageModelsRequest; @class AWSTranscribeListLanguageModelsResponse; @class AWSTranscribeListMedicalTranscriptionJobsRequest; @class AWSTranscribeListMedicalTranscriptionJobsResponse; @class AWSTranscribeListMedicalVocabulariesRequest; @class AWSTranscribeListMedicalVocabulariesResponse; @class AWSTranscribeListTagsForResourceRequest; @class AWSTranscribeListTagsForResourceResponse; @class AWSTranscribeListTranscriptionJobsRequest; @class AWSTranscribeListTranscriptionJobsResponse; @class AWSTranscribeListVocabulariesRequest; @class AWSTranscribeListVocabulariesResponse; @class AWSTranscribeListVocabularyFiltersRequest; @class AWSTranscribeListVocabularyFiltersResponse; @class AWSTranscribeMedia; @class AWSTranscribeMedicalTranscript; @class AWSTranscribeMedicalTranscriptionJob; @class AWSTranscribeMedicalTranscriptionJobSummary; @class AWSTranscribeMedicalTranscriptionSetting; @class AWSTranscribeModelSettings; @class AWSTranscribeNonTalkTimeFilter; @class AWSTranscribeRelativeTimeRange; @class AWSTranscribeRule; @class AWSTranscribeSentimentFilter; @class AWSTranscribeSettings; @class AWSTranscribeStartCallAnalyticsJobRequest; @class AWSTranscribeStartCallAnalyticsJobResponse; @class AWSTranscribeStartMedicalTranscriptionJobRequest; @class AWSTranscribeStartMedicalTranscriptionJobResponse; @class AWSTranscribeStartTranscriptionJobRequest; @class AWSTranscribeStartTranscriptionJobResponse; @class AWSTranscribeSubtitles; @class AWSTranscribeSubtitlesOutput; @class AWSTranscribeTag; @class AWSTranscribeTagResourceRequest; @class AWSTranscribeTagResourceResponse; @class AWSTranscribeToxicityDetectionSettings; @class AWSTranscribeTranscript; @class AWSTranscribeTranscriptFilter; @class AWSTranscribeTranscriptionJob; @class AWSTranscribeTranscriptionJobSummary; @class AWSTranscribeUntagResourceRequest; @class AWSTranscribeUntagResourceResponse; @class AWSTranscribeUpdateCallAnalyticsCategoryRequest; @class AWSTranscribeUpdateCallAnalyticsCategoryResponse; @class AWSTranscribeUpdateMedicalVocabularyRequest; @class AWSTranscribeUpdateMedicalVocabularyResponse; @class AWSTranscribeUpdateVocabularyFilterRequest; @class AWSTranscribeUpdateVocabularyFilterResponse; @class AWSTranscribeUpdateVocabularyRequest; @class AWSTranscribeUpdateVocabularyResponse; @class AWSTranscribeVocabularyFilterInfo; @class AWSTranscribeVocabularyInfo; /**

A time range, in milliseconds, between two points in your media file.

You can use StartTime and EndTime to search a custom segment. For example, setting StartTime to 10000 and EndTime to 50000 only searches for your specified criteria in the audio contained between the 10,000 millisecond mark and the 50,000 millisecond mark of your media file. You must use StartTime and EndTime as a set; that is, if you include one, you must include both.

You can use also First to search from the start of the audio until the time that you specify, or Last to search from the time that you specify until the end of the audio. For example, setting First to 50000 only searches for your specified criteria in the audio contained between the start of the media file to the 50,000 millisecond mark. You can use First and Last independently of each other.

If you prefer to use percentage instead of milliseconds, see .

*/ @interface AWSTranscribeAbsoluteTimeRange : AWSModel /**

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.

*/ @property (nonatomic, strong) NSNumber * _Nullable endTime; /**

The time, in milliseconds, from the start of your media file until the specified value. Amazon Transcribe searches for your specified criteria in this time segment.

*/ @property (nonatomic, strong) NSNumber * _Nullable first; /**

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

*/ @property (nonatomic, strong) NSNumber * _Nullable last; /**

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.

*/ @property (nonatomic, strong) NSNumber * _Nullable startTime; @end /**

Provides detailed information about a 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 the RedactedMediaFileUri field of your response.

*/ @interface AWSTranscribeCallAnalyticsJob : AWSModel /**

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

*/ @property (nonatomic, strong) NSString * _Nullable callAnalyticsJobName; /**

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.

*/ @property (nonatomic, assign) AWSTranscribeCallAnalyticsJobStatus callAnalyticsJobStatus; /**

Indicates which speaker is on which channel.

*/ @property (nonatomic, strong) NSArray * _Nullable channelDefinitions; /**

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.

*/ @property (nonatomic, strong) NSDate * _Nullable completionTime; /**

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.

*/ @property (nonatomic, strong) NSDate * _Nullable creationTime; /**

The Amazon Resource Name (ARN) you included in your request.

*/ @property (nonatomic, strong) NSString * _Nullable dataAccessRoleArn; /**

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.

*/ @property (nonatomic, strong) NSString * _Nullable failureReason; /**

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.

*/ @property (nonatomic, strong) NSNumber * _Nullable identifiedLanguageScore; /**

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.

*/ @property (nonatomic, assign) AWSTranscribeLanguageCode languageCode; /**

Provides the Amazon S3 location of the media file you used in your Call Analytics request.

*/ @property (nonatomic, strong) AWSTranscribeMedia * _Nullable media; /**

The format of the input media file.

*/ @property (nonatomic, assign) AWSTranscribeMediaFormat mediaFormat; /**

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

*/ @property (nonatomic, strong) NSNumber * _Nullable mediaSampleRateHertz; /**

Provides information on any additional settings that were included in your request. Additional settings include content redaction and language identification settings.

*/ @property (nonatomic, strong) AWSTranscribeCallAnalyticsJobSettings * _Nullable settings; /**

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.

*/ @property (nonatomic, strong) NSDate * _Nullable startTime; /**

Provides you with the Amazon S3 URI you can use to access your transcript.

*/ @property (nonatomic, strong) AWSTranscribeTranscript * _Nullable transcript; @end /**

Provides additional optional settings for your request, including content redaction, automatic language identification; allows you to apply custom language models, custom vocabulary filters, and custom vocabularies.

*/ @interface AWSTranscribeCallAnalyticsJobSettings : AWSModel /**

Makes it possible 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.

*/ @property (nonatomic, strong) AWSTranscribeContentRedaction * _Nullable contentRedaction; /**

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

LanguageIdSettings supports two to five language codes. Each language code you include can have an associated custom language model, custom vocabulary, and custom vocabulary filter. The language codes that you specify must match the languages of the associated custom language models, custom vocabularies, and custom vocabulary filters.

It's recommended that you include LanguageOptions when using LanguageIdSettings to ensure that the correct language dialect is identified. For example, if you specify a custom vocabulary that is in en-US but Amazon Transcribe determines that the language spoken in your media is en-AU, your custom vocabulary is not applied to your transcription. If you include LanguageOptions and include en-US as the only English language dialect, your custom vocabulary is applied to your transcription.

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

For a list of languages supported with Call Analytics, refer to Supported languages and language-specific features.

*/ @property (nonatomic, strong) NSDictionary * _Nullable languageIdSettings; /**

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

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

*/ @property (nonatomic, strong) NSString * _Nullable languageModelName; /**

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.

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.

*/ @property (nonatomic, strong) NSArray * _Nullable languageOptions; /**

Specify how you want your custom 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.

*/ @property (nonatomic, assign) AWSTranscribeVocabularyFilterMethod vocabularyFilterMethod; /**

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

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

*/ @property (nonatomic, strong) NSString * _Nullable vocabularyFilterName; /**

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

*/ @property (nonatomic, strong) NSString * _Nullable vocabularyName; @end /**

Provides detailed information about a specific Call Analytics job.

*/ @interface AWSTranscribeCallAnalyticsJobSummary : AWSModel /**

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

*/ @property (nonatomic, strong) NSString * _Nullable callAnalyticsJobName; /**

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.

*/ @property (nonatomic, assign) AWSTranscribeCallAnalyticsJobStatus callAnalyticsJobStatus; /**

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.

*/ @property (nonatomic, strong) NSDate * _Nullable completionTime; /**

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.

*/ @property (nonatomic, strong) NSDate * _Nullable creationTime; /**

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

*/ @property (nonatomic, strong) NSString * _Nullable failureReason; /**

The language code used to create your Call Analytics transcription.

*/ @property (nonatomic, assign) AWSTranscribeLanguageCode languageCode; /**

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.

*/ @property (nonatomic, strong) NSDate * _Nullable startTime; @end /**

Provides you with the properties of the Call Analytics category you specified in your request. This includes the list of rules that define the specified category.

*/ @interface AWSTranscribeCategoryProperties : AWSModel /**

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

*/ @property (nonatomic, strong) NSString * _Nullable categoryName; /**

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.

*/ @property (nonatomic, strong) NSDate * _Nullable createTime; /**

The input type associated with the specified category. POST_CALL refers to a category that is applied to batch transcriptions; REAL_TIME refers to a category that is applied to streaming transcriptions.

*/ @property (nonatomic, assign) AWSTranscribeInputType inputType; /**

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.

*/ @property (nonatomic, strong) NSDate * _Nullable lastUpdateTime; /**

The rules used to define a Call Analytics category. Each category can have between 1 and 20 rules.

*/ @property (nonatomic, strong) NSArray * _Nullable rules; @end /**

Makes it possible 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).

*/ @interface AWSTranscribeChannelDefinition : AWSModel /**

Specify the audio channel you want to define.

*/ @property (nonatomic, strong) NSNumber * _Nullable channelId; /**

Specify the speaker you want to define. Omitting this parameter is equivalent to specifying both participants.

*/ @property (nonatomic, assign) AWSTranscribeParticipantRole participantRole; @end /**

Makes it possible 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.

Required parameters: [RedactionType, RedactionOutput] */ @interface AWSTranscribeContentRedaction : AWSModel /**

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.

*/ @property (nonatomic, strong) NSArray * _Nullable piiEntityTypes; /**

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

*/ @property (nonatomic, assign) AWSTranscribeRedactionOutput redactionOutput; /**

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.

*/ @property (nonatomic, assign) AWSTranscribeRedactionType redactionType; @end /** */ @interface AWSTranscribeCreateCallAnalyticsCategoryRequest : AWSRequest /**

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.

*/ @property (nonatomic, strong) NSString * _Nullable categoryName; /**

Choose whether you want to create a real-time or a post-call category for your Call Analytics transcription.

Specifying POST_CALL assigns your category to post-call transcriptions; categories with this input type cannot be applied to streaming (real-time) transcriptions.

Specifying REAL_TIME assigns your category to streaming transcriptions; categories with this input type cannot be applied to post-call transcriptions.

If you do not include InputType, your category is created as a post-call category by default.

*/ @property (nonatomic, assign) AWSTranscribeInputType inputType; /**

Rules define a Call Analytics category. When creating a new 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.

*/ @property (nonatomic, strong) NSArray * _Nullable rules; @end /** */ @interface AWSTranscribeCreateCallAnalyticsCategoryResponse : AWSModel /**

Provides you with the properties of your new category, including its associated rules.

*/ @property (nonatomic, strong) AWSTranscribeCategoryProperties * _Nullable categoryProperties; @end /** */ @interface AWSTranscribeCreateLanguageModelRequest : AWSRequest /**

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.

*/ @property (nonatomic, assign) AWSTranscribeBaseModelName baseModelName; /**

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.

*/ @property (nonatomic, strong) AWSTranscribeInputDataConfig * _Nullable inputDataConfig; /**

The language code that represents the language of your model. Each custom language model must contain terms in only one language, and the language you select for your custom language 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 US 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 custom language model using US English (en-US), you can only apply this model to files that contain English audio.

*/ @property (nonatomic, assign) AWSTranscribeCLMLanguageCode languageCode; /**

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

*/ @property (nonatomic, strong) NSString * _Nullable modelName; /**

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.

*/ @property (nonatomic, strong) NSArray * _Nullable tags; @end /** */ @interface AWSTranscribeCreateLanguageModelResponse : AWSModel /**

The Amazon Transcribe standard language model, or base model, you specified when creating your custom language model.

*/ @property (nonatomic, assign) AWSTranscribeBaseModelName baseModelName; /**

Lists your data access role ARN (Amazon Resource Name) and the Amazon S3 locations you provided for your training (S3Uri) and tuning (TuningDataS3Uri) data.

*/ @property (nonatomic, strong) AWSTranscribeInputDataConfig * _Nullable inputDataConfig; /**

The language code you selected for your custom language model.

*/ @property (nonatomic, assign) AWSTranscribeCLMLanguageCode languageCode; /**

The name of your custom language model.

*/ @property (nonatomic, strong) NSString * _Nullable modelName; /**

The status of your custom language model. When the status displays as COMPLETED, your model is ready to use.

*/ @property (nonatomic, assign) AWSTranscribeModelStatus modelStatus; @end /** */ @interface AWSTranscribeCreateMedicalVocabularyRequest : AWSRequest /**

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.

*/ @property (nonatomic, assign) AWSTranscribeLanguageCode languageCode; /**

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

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

*/ @property (nonatomic, strong) NSArray * _Nullable tags; /**

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

*/ @property (nonatomic, strong) NSString * _Nullable vocabularyFileUri; /**

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

*/ @property (nonatomic, strong) NSString * _Nullable vocabularyName; @end /** */ @interface AWSTranscribeCreateMedicalVocabularyResponse : AWSModel /**

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

*/ @property (nonatomic, strong) NSString * _Nullable failureReason; /**

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

*/ @property (nonatomic, assign) AWSTranscribeLanguageCode languageCode; /**

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.

*/ @property (nonatomic, strong) NSDate * _Nullable lastModifiedTime; /**

The name you chose for your custom medical vocabulary.

*/ @property (nonatomic, strong) NSString * _Nullable vocabularyName; /**

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

*/ @property (nonatomic, assign) AWSTranscribeVocabularyState vocabularyState; @end /** */ @interface AWSTranscribeCreateVocabularyFilterRequest : AWSRequest /**

The Amazon Resource Name (ARN) of an IAM role that has permissions to access the Amazon S3 bucket that contains your input files (in this case, your custom vocabulary filter). If the role that 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.

*/ @property (nonatomic, strong) NSString * _Nullable dataAccessRoleArn; /**

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

A custom vocabulary filter can only be used to transcribe files in the same language as the filter. For example, if you create a custom 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.

*/ @property (nonatomic, assign) AWSTranscribeLanguageCode languageCode; /**

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

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

*/ @property (nonatomic, strong) NSArray * _Nullable tags; /**

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.

*/ @property (nonatomic, strong) NSString * _Nullable vocabularyFilterFileUri; /**

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

*/ @property (nonatomic, strong) NSString * _Nullable vocabularyFilterName; /**

Use this parameter if you want to create your custom 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 custom vocabulary filter request fails. Refer to Character Sets for Custom Vocabularies to get the character set for your language.

*/ @property (nonatomic, strong) NSArray * _Nullable words; @end /** */ @interface AWSTranscribeCreateVocabularyFilterResponse : AWSModel /**

The language code you selected for your custom vocabulary filter.

*/ @property (nonatomic, assign) AWSTranscribeLanguageCode languageCode; /**

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

*/ @property (nonatomic, strong) NSDate * _Nullable lastModifiedTime; /**

The name you chose for your custom vocabulary filter.

*/ @property (nonatomic, strong) NSString * _Nullable vocabularyFilterName; @end /** */ @interface AWSTranscribeCreateVocabularyRequest : AWSRequest /**

The Amazon Resource Name (ARN) of an IAM role that has permissions to access the Amazon S3 bucket that contains your input files (in this case, your custom vocabulary). If the role that 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.

*/ @property (nonatomic, strong) NSString * _Nullable dataAccessRoleArn; /**

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

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

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

*/ @property (nonatomic, assign) AWSTranscribeLanguageCode languageCode; /**

Use this parameter if you want to create your custom vocabulary by including all desired terms, as comma-separated values, within your request. The other option for creating your custom 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 custom vocabulary filter request fails. Refer to Character Sets for Custom Vocabularies to get the character set for your language.

*/ @property (nonatomic, strong) NSArray * _Nullable phrases; /**

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

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

*/ @property (nonatomic, strong) NSArray * _Nullable tags; /**

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.

*/ @property (nonatomic, strong) NSString * _Nullable vocabularyFileUri; /**

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

*/ @property (nonatomic, strong) NSString * _Nullable vocabularyName; @end /** */ @interface AWSTranscribeCreateVocabularyResponse : AWSModel /**

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

*/ @property (nonatomic, strong) NSString * _Nullable failureReason; /**

The language code you selected for your custom vocabulary.

*/ @property (nonatomic, assign) AWSTranscribeLanguageCode languageCode; /**

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.

*/ @property (nonatomic, strong) NSDate * _Nullable lastModifiedTime; /**

The name you chose for your custom vocabulary.

*/ @property (nonatomic, strong) NSString * _Nullable vocabularyName; /**

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

*/ @property (nonatomic, assign) AWSTranscribeVocabularyState vocabularyState; @end /** */ @interface AWSTranscribeDeleteCallAnalyticsCategoryRequest : AWSRequest /**

The name of the Call Analytics category you want to delete. Category names are case sensitive.

*/ @property (nonatomic, strong) NSString * _Nullable categoryName; @end /** */ @interface AWSTranscribeDeleteCallAnalyticsCategoryResponse : AWSModel @end /** */ @interface AWSTranscribeDeleteCallAnalyticsJobRequest : AWSRequest /**

The name of the Call Analytics job you want to delete. Job names are case sensitive.

*/ @property (nonatomic, strong) NSString * _Nullable callAnalyticsJobName; @end /** */ @interface AWSTranscribeDeleteCallAnalyticsJobResponse : AWSModel @end /** */ @interface AWSTranscribeDeleteLanguageModelRequest : AWSRequest /**

The name of the custom language model you want to delete. Model names are case sensitive.

*/ @property (nonatomic, strong) NSString * _Nullable modelName; @end /** */ @interface AWSTranscribeDeleteMedicalTranscriptionJobRequest : AWSRequest /**

The name of the medical transcription job you want to delete. Job names are case sensitive.

*/ @property (nonatomic, strong) NSString * _Nullable medicalTranscriptionJobName; @end /** */ @interface AWSTranscribeDeleteMedicalVocabularyRequest : AWSRequest /**

The name of the custom medical vocabulary you want to delete. Custom medical vocabulary names are case sensitive.

*/ @property (nonatomic, strong) NSString * _Nullable vocabularyName; @end /** */ @interface AWSTranscribeDeleteTranscriptionJobRequest : AWSRequest /**

The name of the transcription job you want to delete. Job names are case sensitive.

*/ @property (nonatomic, strong) NSString * _Nullable transcriptionJobName; @end /** */ @interface AWSTranscribeDeleteVocabularyFilterRequest : AWSRequest /**

The name of the custom vocabulary filter you want to delete. Custom vocabulary filter names are case sensitive.

*/ @property (nonatomic, strong) NSString * _Nullable vocabularyFilterName; @end /** */ @interface AWSTranscribeDeleteVocabularyRequest : AWSRequest /**

The name of the custom vocabulary you want to delete. Custom vocabulary names are case sensitive.

*/ @property (nonatomic, strong) NSString * _Nullable vocabularyName; @end /** */ @interface AWSTranscribeDescribeLanguageModelRequest : AWSRequest /**

The name of the custom language model you want information about. Model names are case sensitive.

*/ @property (nonatomic, strong) NSString * _Nullable modelName; @end /** */ @interface AWSTranscribeDescribeLanguageModelResponse : AWSModel /**

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.

*/ @property (nonatomic, strong) AWSTranscribeLanguageModel * _Nullable languageModel; @end /** */ @interface AWSTranscribeGetCallAnalyticsCategoryRequest : AWSRequest /**

The name of the Call Analytics category you want information about. Category names are case sensitive.

*/ @property (nonatomic, strong) NSString * _Nullable categoryName; @end /** */ @interface AWSTranscribeGetCallAnalyticsCategoryResponse : AWSModel /**

Provides you with the properties of the Call Analytics category you specified in your GetCallAnalyticsCategory request.

*/ @property (nonatomic, strong) AWSTranscribeCategoryProperties * _Nullable categoryProperties; @end /** */ @interface AWSTranscribeGetCallAnalyticsJobRequest : AWSRequest /**

The name of the Call Analytics job you want information about. Job names are case sensitive.

*/ @property (nonatomic, strong) NSString * _Nullable callAnalyticsJobName; @end /** */ @interface AWSTranscribeGetCallAnalyticsJobResponse : AWSModel /**

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

*/ @property (nonatomic, strong) AWSTranscribeCallAnalyticsJob * _Nullable callAnalyticsJob; @end /** */ @interface AWSTranscribeGetMedicalTranscriptionJobRequest : AWSRequest /**

The name of the medical transcription job you want information about. Job names are case sensitive.

*/ @property (nonatomic, strong) NSString * _Nullable medicalTranscriptionJobName; @end /** */ @interface AWSTranscribeGetMedicalTranscriptionJobResponse : AWSModel /**

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

*/ @property (nonatomic, strong) AWSTranscribeMedicalTranscriptionJob * _Nullable medicalTranscriptionJob; @end /** */ @interface AWSTranscribeGetMedicalVocabularyRequest : AWSRequest /**

The name of the custom medical vocabulary you want information about. Custom medical vocabulary names are case sensitive.

*/ @property (nonatomic, strong) NSString * _Nullable vocabularyName; @end /** */ @interface AWSTranscribeGetMedicalVocabularyResponse : AWSModel /**

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

*/ @property (nonatomic, strong) NSString * _Nullable downloadUri; /**

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

*/ @property (nonatomic, strong) NSString * _Nullable failureReason; /**

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

*/ @property (nonatomic, assign) AWSTranscribeLanguageCode languageCode; /**

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.

*/ @property (nonatomic, strong) NSDate * _Nullable lastModifiedTime; /**

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

*/ @property (nonatomic, strong) NSString * _Nullable vocabularyName; /**

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

*/ @property (nonatomic, assign) AWSTranscribeVocabularyState vocabularyState; @end /** */ @interface AWSTranscribeGetTranscriptionJobRequest : AWSRequest /**

The name of the transcription job you want information about. Job names are case sensitive.

*/ @property (nonatomic, strong) NSString * _Nullable transcriptionJobName; @end /** */ @interface AWSTranscribeGetTranscriptionJobResponse : AWSModel /**

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

*/ @property (nonatomic, strong) AWSTranscribeTranscriptionJob * _Nullable transcriptionJob; @end /** */ @interface AWSTranscribeGetVocabularyFilterRequest : AWSRequest /**

The name of the custom vocabulary filter you want information about. Custom vocabulary filter names are case sensitive.

*/ @property (nonatomic, strong) NSString * _Nullable vocabularyFilterName; @end /** */ @interface AWSTranscribeGetVocabularyFilterResponse : AWSModel /**

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

*/ @property (nonatomic, strong) NSString * _Nullable downloadUri; /**

The language code you selected for your custom vocabulary filter.

*/ @property (nonatomic, assign) AWSTranscribeLanguageCode languageCode; /**

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

*/ @property (nonatomic, strong) NSDate * _Nullable lastModifiedTime; /**

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

*/ @property (nonatomic, strong) NSString * _Nullable vocabularyFilterName; @end /** */ @interface AWSTranscribeGetVocabularyRequest : AWSRequest /**

The name of the custom vocabulary you want information about. Custom vocabulary names are case sensitive.

*/ @property (nonatomic, strong) NSString * _Nullable vocabularyName; @end /** */ @interface AWSTranscribeGetVocabularyResponse : AWSModel /**

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

*/ @property (nonatomic, strong) NSString * _Nullable downloadUri; /**

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

*/ @property (nonatomic, strong) NSString * _Nullable failureReason; /**

The language code you selected for your custom vocabulary.

*/ @property (nonatomic, assign) AWSTranscribeLanguageCode languageCode; /**

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

*/ @property (nonatomic, strong) NSDate * _Nullable lastModifiedTime; /**

The name of the custom vocabulary you requested information about.

*/ @property (nonatomic, strong) NSString * _Nullable vocabularyName; /**

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

*/ @property (nonatomic, assign) AWSTranscribeVocabularyState vocabularyState; @end /**

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 and DataAccessRoleArn. You can optionally include TuningDataS3Uri.

Required parameters: [S3Uri, DataAccessRoleArn] */ @interface AWSTranscribeInputDataConfig : AWSModel /**

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

*/ @property (nonatomic, strong) NSString * _Nullable dataAccessRoleArn; /**

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/

*/ @property (nonatomic, strong) NSString * _Nullable s3Uri; /**

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/

*/ @property (nonatomic, strong) NSString * _Nullable tuningDataS3Uri; @end /**

Flag the presence or absence of interruptions in your Call Analytics transcription output.

Rules using InterruptionFilter are designed to match:

  • Instances where an agent interrupts a customer

  • Instances where a customer interrupts an agent

  • Either participant interrupting the other

  • A lack of interruptions

See Rule criteria for post-call categories for usage examples.

*/ @interface AWSTranscribeInterruptionFilter : AWSModel /**

Makes it possible to specify a time range (in milliseconds) in your audio, during which you want to search for an interruption. See for more detail.

*/ @property (nonatomic, strong) AWSTranscribeAbsoluteTimeRange * _Nullable absoluteTimeRange; /**

Set to TRUE to flag speech that does not contain interruptions. Set to FALSE to flag speech that contains interruptions.

*/ @property (nonatomic, strong) NSNumber * _Nullable negate; /**

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

*/ @property (nonatomic, assign) AWSTranscribeParticipantRole participantRole; /**

Makes it possible to specify a time range (in percentage) in your media file, during which you want to search for an interruption. See for more detail.

*/ @property (nonatomic, strong) AWSTranscribeRelativeTimeRange * _Nullable relativeTimeRange; /**

Specify the duration of the interruptions in milliseconds. For example, you can flag speech that contains more than 10,000 milliseconds of interruptions.

*/ @property (nonatomic, strong) NSNumber * _Nullable threshold; @end /**

Makes it possible 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.

*/ @interface AWSTranscribeJobExecutionSettings : AWSModel /**

Makes it possible 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.

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

*/ @property (nonatomic, strong) NSNumber * _Nullable allowDeferredExecution; /**

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

*/ @property (nonatomic, strong) NSString * _Nullable dataAccessRoleArn; @end /**

Provides information on the speech contained in a discreet utterance when multi-language identification is enabled in your request. This utterance represents a block of speech consisting of one language, preceded or followed by a block of speech in a different language.

*/ @interface AWSTranscribeLanguageCodeItem : AWSModel /**

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

*/ @property (nonatomic, strong) NSNumber * _Nullable durationInSeconds; /**

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

*/ @property (nonatomic, assign) AWSTranscribeLanguageCode languageCode; @end /**

If using automatic language identification 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). Note that multi-language identification (IdentifyMultipleLanguages) doesn't support custom language models.

LanguageIdSettings supports two to five language codes. Each language code you include can have an associated custom language model, custom vocabulary, and custom vocabulary filter. The language codes that you specify must match the languages of the associated custom language models, custom vocabularies, and custom vocabulary filters.

It's recommended that you include LanguageOptions when using LanguageIdSettings to ensure that the correct language dialect is identified. For example, if you specify a custom vocabulary that is in en-US but Amazon Transcribe determines that the language spoken in your media is en-AU, your custom vocabulary is not applied to your transcription. If you include LanguageOptions and include en-US as the only English language dialect, your custom vocabulary is applied to your transcription.

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.

*/ @interface AWSTranscribeLanguageIdSettings : AWSModel /**

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

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

*/ @property (nonatomic, strong) NSString * _Nullable languageModelName; /**

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

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

*/ @property (nonatomic, strong) NSString * _Nullable vocabularyFilterName; /**

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

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

*/ @property (nonatomic, strong) NSString * _Nullable vocabularyName; @end /**

Provides information about a custom language model, including:

  • The base model name

  • When the model was created

  • The location of the files used to train the model

  • When the model was last modified

  • The name you chose for the model

  • The model's language

  • The model's processing state

  • Any available upgrades for the base model

*/ @interface AWSTranscribeLanguageModel : AWSModel /**

The Amazon Transcribe standard language model, or base model, used to create your custom language model.

*/ @property (nonatomic, assign) AWSTranscribeBaseModelName baseModelName; /**

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.

*/ @property (nonatomic, strong) NSDate * _Nullable createTime; /**

If ModelStatus is FAILED, FailureReason contains information about why the custom language model request failed. See also: Common Errors.

*/ @property (nonatomic, strong) NSString * _Nullable failureReason; /**

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.

*/ @property (nonatomic, strong) AWSTranscribeInputDataConfig * _Nullable inputDataConfig; /**

The language code used to create your custom language model. Each custom language model must contain terms in only one language, and the language you select for your custom language 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.

*/ @property (nonatomic, assign) AWSTranscribeCLMLanguageCode languageCode; /**

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

*/ @property (nonatomic, strong) NSDate * _Nullable lastModifiedTime; /**

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.

*/ @property (nonatomic, strong) NSString * _Nullable modelName; /**

The status of the specified custom language model. When the status displays as COMPLETED the model is ready for use.

*/ @property (nonatomic, assign) AWSTranscribeModelStatus modelStatus; /**

Shows if a more current base model is available for use with the specified custom language model.

If false, your custom 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.

*/ @property (nonatomic, strong) NSNumber * _Nullable upgradeAvailability; @end /** */ @interface AWSTranscribeListCallAnalyticsCategoriesRequest : AWSRequest /**

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

*/ @property (nonatomic, strong) NSNumber * _Nullable maxResults; /**

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.

*/ @property (nonatomic, strong) NSString * _Nullable nextToken; @end /** */ @interface AWSTranscribeListCallAnalyticsCategoriesResponse : AWSModel /**

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

*/ @property (nonatomic, strong) NSArray * _Nullable categories; /**

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.

*/ @property (nonatomic, strong) NSString * _Nullable nextToken; @end /** */ @interface AWSTranscribeListCallAnalyticsJobsRequest : AWSRequest /**

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

*/ @property (nonatomic, strong) NSString * _Nullable jobNameContains; /**

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

*/ @property (nonatomic, strong) NSNumber * _Nullable maxResults; /**

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.

*/ @property (nonatomic, strong) NSString * _Nullable nextToken; /**

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.

*/ @property (nonatomic, assign) AWSTranscribeCallAnalyticsJobStatus status; @end /** */ @interface AWSTranscribeListCallAnalyticsJobsResponse : AWSModel /**

Provides a summary of information about each result.

*/ @property (nonatomic, strong) NSArray * _Nullable callAnalyticsJobSummaries; /**

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.

*/ @property (nonatomic, strong) NSString * _Nullable nextToken; /**

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

*/ @property (nonatomic, assign) AWSTranscribeCallAnalyticsJobStatus status; @end /** */ @interface AWSTranscribeListLanguageModelsRequest : AWSRequest /**

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

*/ @property (nonatomic, strong) NSNumber * _Nullable maxResults; /**

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

*/ @property (nonatomic, strong) NSString * _Nullable nameContains; /**

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.

*/ @property (nonatomic, strong) NSString * _Nullable nextToken; /**

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.

*/ @property (nonatomic, assign) AWSTranscribeModelStatus statusEquals; @end /** */ @interface AWSTranscribeListLanguageModelsResponse : AWSModel /**

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

*/ @property (nonatomic, strong) NSArray * _Nullable models; /**

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.

*/ @property (nonatomic, strong) NSString * _Nullable nextToken; @end /** */ @interface AWSTranscribeListMedicalTranscriptionJobsRequest : AWSRequest /**

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

*/ @property (nonatomic, strong) NSString * _Nullable jobNameContains; /**

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

*/ @property (nonatomic, strong) NSNumber * _Nullable maxResults; /**

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.

*/ @property (nonatomic, strong) NSString * _Nullable nextToken; /**

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.

*/ @property (nonatomic, assign) AWSTranscribeTranscriptionJobStatus status; @end /** */ @interface AWSTranscribeListMedicalTranscriptionJobsResponse : AWSModel /**

Provides a summary of information about each result.

*/ @property (nonatomic, strong) NSArray * _Nullable medicalTranscriptionJobSummaries; /**

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.

*/ @property (nonatomic, strong) NSString * _Nullable nextToken; /**

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

*/ @property (nonatomic, assign) AWSTranscribeTranscriptionJobStatus status; @end /** */ @interface AWSTranscribeListMedicalVocabulariesRequest : AWSRequest /**

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

*/ @property (nonatomic, strong) NSNumber * _Nullable maxResults; /**

Returns only the custom medical vocabularies that contain the specified string. The search is not case sensitive.

*/ @property (nonatomic, strong) NSString * _Nullable nameContains; /**

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.

*/ @property (nonatomic, strong) NSString * _Nullable nextToken; /**

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

*/ @property (nonatomic, assign) AWSTranscribeVocabularyState stateEquals; @end /** */ @interface AWSTranscribeListMedicalVocabulariesResponse : AWSModel /**

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.

*/ @property (nonatomic, strong) NSString * _Nullable nextToken; /**

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

*/ @property (nonatomic, assign) AWSTranscribeVocabularyState status; /**

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

*/ @property (nonatomic, strong) NSArray * _Nullable vocabularies; @end /** */ @interface AWSTranscribeListTagsForResourceRequest : AWSRequest /**

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:111122223333:transcription-job/transcription-job-name.

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

*/ @property (nonatomic, strong) NSString * _Nullable resourceArn; @end /** */ @interface AWSTranscribeListTagsForResourceResponse : AWSModel /**

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

*/ @property (nonatomic, strong) NSString * _Nullable resourceArn; /**

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

*/ @property (nonatomic, strong) NSArray * _Nullable tags; @end /** */ @interface AWSTranscribeListTranscriptionJobsRequest : AWSRequest /**

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

*/ @property (nonatomic, strong) NSString * _Nullable jobNameContains; /**

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

*/ @property (nonatomic, strong) NSNumber * _Nullable maxResults; /**

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.

*/ @property (nonatomic, strong) NSString * _Nullable nextToken; /**

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.

*/ @property (nonatomic, assign) AWSTranscribeTranscriptionJobStatus status; @end /** */ @interface AWSTranscribeListTranscriptionJobsResponse : AWSModel /**

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.

*/ @property (nonatomic, strong) NSString * _Nullable nextToken; /**

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

*/ @property (nonatomic, assign) AWSTranscribeTranscriptionJobStatus status; /**

Provides a summary of information about each result.

*/ @property (nonatomic, strong) NSArray * _Nullable transcriptionJobSummaries; @end /** */ @interface AWSTranscribeListVocabulariesRequest : AWSRequest /**

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

*/ @property (nonatomic, strong) NSNumber * _Nullable maxResults; /**

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

*/ @property (nonatomic, strong) NSString * _Nullable nameContains; /**

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.

*/ @property (nonatomic, strong) NSString * _Nullable nextToken; /**

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.

*/ @property (nonatomic, assign) AWSTranscribeVocabularyState stateEquals; @end /** */ @interface AWSTranscribeListVocabulariesResponse : AWSModel /**

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.

*/ @property (nonatomic, strong) NSString * _Nullable nextToken; /**

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

*/ @property (nonatomic, assign) AWSTranscribeVocabularyState status; /**

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

*/ @property (nonatomic, strong) NSArray * _Nullable vocabularies; @end /** */ @interface AWSTranscribeListVocabularyFiltersRequest : AWSRequest /**

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

*/ @property (nonatomic, strong) NSNumber * _Nullable maxResults; /**

Returns only the custom vocabulary filters that contain the specified string. The search is not case sensitive.

*/ @property (nonatomic, strong) NSString * _Nullable nameContains; /**

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.

*/ @property (nonatomic, strong) NSString * _Nullable nextToken; @end /** */ @interface AWSTranscribeListVocabularyFiltersResponse : AWSModel /**

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.

*/ @property (nonatomic, strong) NSString * _Nullable nextToken; /**

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

*/ @property (nonatomic, strong) NSArray * _Nullable vocabularyFilters; @end /**

Describes the Amazon S3 location of the media file you want to use in your request.

For information on supported media formats, refer to the MediaFormat parameter or the Media formats section in the Amazon S3 Developer Guide.

*/ @interface AWSTranscribeMedia : AWSModel /**

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.

*/ @property (nonatomic, strong) NSString * _Nullable mediaFileUri; /**

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 produces a redacted audio file in addition to a redacted transcript. It is only supported for Call Analytics (StartCallAnalyticsJob) transcription requests.

 */ @property (nonatomic, strong) NSString * _Nullable redactedMediaFileUri; @end /**

Provides you with the Amazon S3 URI you can use to access your transcript.

*/ @interface AWSTranscribeMedicalTranscript : AWSModel /**

The Amazon S3 location of your transcript. You can use this URI to access or download your transcript.

Note that this is the Amazon S3 location you specified in your request using the OutputBucketName parameter.

*/ @property (nonatomic, strong) NSString * _Nullable transcriptFileUri; @end /**

Provides detailed information about a 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.

*/ @interface AWSTranscribeMedicalTranscriptionJob : AWSModel /**

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.

*/ @property (nonatomic, strong) NSDate * _Nullable completionTime; /**

Indicates whether content identification was enabled for your transcription request.

*/ @property (nonatomic, assign) AWSTranscribeMedicalContentIdentificationType contentIdentificationType; /**

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.

*/ @property (nonatomic, strong) NSDate * _Nullable creationTime; /**

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.

*/ @property (nonatomic, strong) NSString * _Nullable failureReason; /**

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

*/ @property (nonatomic, assign) AWSTranscribeLanguageCode languageCode; /**

Describes the Amazon S3 location of the media file you want to use in your request.

For information on supported media formats, refer to the MediaFormat parameter or the Media formats section in the Amazon S3 Developer Guide.

*/ @property (nonatomic, strong) AWSTranscribeMedia * _Nullable media; /**

The format of the input media file.

*/ @property (nonatomic, assign) AWSTranscribeMediaFormat mediaFormat; /**

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

*/ @property (nonatomic, strong) NSNumber * _Nullable mediaSampleRateHertz; /**

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

*/ @property (nonatomic, strong) NSString * _Nullable medicalTranscriptionJobName; /**

Provides information on any additional settings that were included in your request. Additional settings include channel identification, alternative transcriptions, speaker partitioning, custom vocabularies, and custom vocabulary filters.

*/ @property (nonatomic, strong) AWSTranscribeMedicalTranscriptionSetting * _Nullable settings; /**

Describes the medical specialty represented in your media.

*/ @property (nonatomic, assign) AWSTranscribeSpecialty specialty; /**

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.

*/ @property (nonatomic, strong) NSDate * _Nullable startTime; /**

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

*/ @property (nonatomic, strong) NSArray * _Nullable tags; /**

Provides you with the Amazon S3 URI you can use to access your transcript.

*/ @property (nonatomic, strong) AWSTranscribeMedicalTranscript * _Nullable transcript; /**

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.

*/ @property (nonatomic, assign) AWSTranscribeTranscriptionJobStatus transcriptionJobStatus; /**

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

*/ @property (nonatomic, assign) AWSTranscribeTypes types; @end /**

Provides detailed information about a specific medical transcription job.

*/ @interface AWSTranscribeMedicalTranscriptionJobSummary : AWSModel /**

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.

*/ @property (nonatomic, strong) NSDate * _Nullable completionTime; /**

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

*/ @property (nonatomic, assign) AWSTranscribeMedicalContentIdentificationType contentIdentificationType; /**

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.

*/ @property (nonatomic, strong) NSDate * _Nullable creationTime; /**

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

*/ @property (nonatomic, strong) NSString * _Nullable failureReason; /**

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

*/ @property (nonatomic, assign) AWSTranscribeLanguageCode languageCode; /**

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

*/ @property (nonatomic, strong) NSString * _Nullable medicalTranscriptionJobName; /**

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.

*/ @property (nonatomic, assign) AWSTranscribeOutputLocationType outputLocationType; /**

Provides the medical specialty represented in your media.

*/ @property (nonatomic, assign) AWSTranscribeSpecialty specialty; /**

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.

*/ @property (nonatomic, strong) NSDate * _Nullable startTime; /**

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.

*/ @property (nonatomic, assign) AWSTranscribeTranscriptionJobStatus transcriptionJobStatus; /**

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

*/ @property (nonatomic, assign) AWSTranscribeTypes types; @end /**

Allows additional optional settings in your request, including channel identification, alternative transcriptions, and speaker partitioning. You can use that to apply custom vocabularies to your medical transcription job.

*/ @interface AWSTranscribeMedicalTranscriptionSetting : AWSModel /**

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.

*/ @property (nonatomic, strong) NSNumber * _Nullable channelIdentification; /**

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.

*/ @property (nonatomic, strong) NSNumber * _Nullable maxAlternatives; /**

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

Note that if your media contains more speakers than the specified number, multiple speakers are treated as a single speaker.

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

*/ @property (nonatomic, strong) NSNumber * _Nullable maxSpeakerLabels; /**

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.

*/ @property (nonatomic, strong) NSNumber * _Nullable showAlternatives; /**

Enables speaker partitioning (diarization) in your transcription output. Speaker partitioning 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 ShowSpeakerLabels and ChannelIdentification in the same request. Including both parameters returns a BadRequestException.

For more information, see Partitioning speakers (diarization).

*/ @property (nonatomic, strong) NSNumber * _Nullable showSpeakerLabels; /**

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

The language of the specified custom vocabulary must match the language code that you specify in your transcription request. If the languages don't match, the custom 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.

*/ @property (nonatomic, strong) NSString * _Nullable vocabularyName; @end /**

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.

*/ @interface AWSTranscribeModelSettings : AWSModel /**

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

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

*/ @property (nonatomic, strong) NSString * _Nullable languageModelName; @end /**

Flag the presence or absence of periods of silence in your Call Analytics transcription output.

Rules using NonTalkTimeFilter are designed to match:

  • The presence of silence at specified periods throughout the call

  • The presence of speech at specified periods throughout the call

See Rule criteria for post-call categories for usage examples.

*/ @interface AWSTranscribeNonTalkTimeFilter : AWSModel /**

Makes it possible 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.

*/ @property (nonatomic, strong) AWSTranscribeAbsoluteTimeRange * _Nullable absoluteTimeRange; /**

Set to TRUE to flag periods of speech. Set to FALSE to flag periods of silence

*/ @property (nonatomic, strong) NSNumber * _Nullable negate; /**

Makes it possible 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.

*/ @property (nonatomic, strong) AWSTranscribeRelativeTimeRange * _Nullable relativeTimeRange; /**

Specify the duration, in milliseconds, of the period of silence that you want to flag. For example, you can flag a silent period that lasts 30,000 milliseconds.

*/ @property (nonatomic, strong) NSNumber * _Nullable threshold; @end /**

A time range, in percentage, between two points in your media file.

You can use StartPercentage and EndPercentage to search a custom segment. For example, setting StartPercentage to 10 and EndPercentage to 50 only searches for your specified criteria in the audio contained between the 10 percent mark and the 50 percent mark of your media file.

You can use also First to search from the start of the media file until the time that you specify. Or use Last to search from the time that you specify until the end of the media file. For example, setting First to 10 only searches for your specified criteria in the audio contained in the first 10 percent of the media file.

If you prefer to use milliseconds instead of percentage, see .

*/ @interface AWSTranscribeRelativeTimeRange : AWSModel /**

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.

*/ @property (nonatomic, strong) NSNumber * _Nullable endPercentage; /**

The time, in percentage, from the start of your media file until the specified value. Amazon Transcribe searches for your specified criteria in this time segment.

*/ @property (nonatomic, strong) NSNumber * _Nullable first; /**

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

*/ @property (nonatomic, strong) NSNumber * _Nullable last; /**

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.

*/ @property (nonatomic, strong) NSNumber * _Nullable startPercentage; @end /**

A rule is a set of criteria that you can specify to flag an attribute in your Call Analytics output. Rules define a Call Analytics category.

Rules can include these parameters: , , , and .

To learn more about Call Analytics rules and categories, see Creating categories for post-call transcriptions and Creating categories for real-time transcriptions.

To learn more about Call Analytics, see Analyzing call center audio with Call Analytics.

*/ @interface AWSTranscribeRule : AWSModel /**

Flag the presence or absence of interruptions in your Call Analytics transcription output. Refer to for more detail.

*/ @property (nonatomic, strong) AWSTranscribeInterruptionFilter * _Nullable interruptionFilter; /**

Flag the presence or absence of periods of silence in your Call Analytics transcription output. Refer to for more detail.

*/ @property (nonatomic, strong) AWSTranscribeNonTalkTimeFilter * _Nullable nonTalkTimeFilter; /**

Flag the presence or absence of specific sentiments in your Call Analytics transcription output. Refer to for more detail.

*/ @property (nonatomic, strong) AWSTranscribeSentimentFilter * _Nullable sentimentFilter; /**

Flag the presence or absence of specific words or phrases in your Call Analytics transcription output. Refer to for more detail.

*/ @property (nonatomic, strong) AWSTranscribeTranscriptFilter * _Nullable transcriptFilter; @end /**

Flag the presence or absence of specific sentiments detected in your Call Analytics transcription output.

Rules using SentimentFilter are designed to match:

  • The presence or absence of a positive sentiment felt by the customer, agent, or both at specified points in the call

  • The presence or absence of a negative sentiment felt by the customer, agent, or both at specified points in the call

  • The presence or absence of a neutral sentiment felt by the customer, agent, or both at specified points in the call

  • The presence or absence of a mixed sentiment felt by the customer, the agent, or both at specified points in the call

See Rule criteria for post-call categories for usage examples.

Required parameters: [Sentiments] */ @interface AWSTranscribeSentimentFilter : AWSModel /**

Makes it possible to specify a time range (in milliseconds) in your audio, during which you want to search for the specified sentiments. See for more detail.

*/ @property (nonatomic, strong) AWSTranscribeAbsoluteTimeRange * _Nullable absoluteTimeRange; /**

Set to TRUE to flag the sentiments that you didn't include in your request. Set to FALSE to flag the sentiments that you specified in your request.

*/ @property (nonatomic, strong) NSNumber * _Nullable negate; /**

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

*/ @property (nonatomic, assign) AWSTranscribeParticipantRole participantRole; /**

Makes it possible 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.

*/ @property (nonatomic, strong) AWSTranscribeRelativeTimeRange * _Nullable relativeTimeRange; /**

Specify the sentiments that you want to flag.

*/ @property (nonatomic, strong) NSArray * _Nullable sentiments; @end /**

Allows additional optional settings in your request, including channel identification, alternative transcriptions, and speaker partitioning. You can use that to apply custom vocabularies to your transcription job.

*/ @interface AWSTranscribeSettings : AWSModel /**

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.

*/ @property (nonatomic, strong) NSNumber * _Nullable channelIdentification; /**

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.

*/ @property (nonatomic, strong) NSNumber * _Nullable maxAlternatives; /**

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

Note that if your media contains more speakers than the specified number, multiple speakers are treated as a single speaker.

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

*/ @property (nonatomic, strong) NSNumber * _Nullable maxSpeakerLabels; /**

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.

*/ @property (nonatomic, strong) NSNumber * _Nullable showAlternatives; /**

Enables speaker partitioning (diarization) in your transcription output. Speaker partitioning 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 Partitioning speakers (diarization).

*/ @property (nonatomic, strong) NSNumber * _Nullable showSpeakerLabels; /**

Specify how you want your custom 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.

*/ @property (nonatomic, assign) AWSTranscribeVocabularyFilterMethod vocabularyFilterMethod; /**

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.

*/ @property (nonatomic, strong) NSString * _Nullable vocabularyFilterName; /**

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.

*/ @property (nonatomic, strong) NSString * _Nullable vocabularyName; @end /** */ @interface AWSTranscribeStartCallAnalyticsJobRequest : AWSRequest /**

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.

*/ @property (nonatomic, strong) NSString * _Nullable callAnalyticsJobName; /**

Makes it possible 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).

*/ @property (nonatomic, strong) NSArray * _Nullable channelDefinitions; /**

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

*/ @property (nonatomic, strong) NSString * _Nullable dataAccessRoleArn; /**

Describes the Amazon S3 location of the media file you want to use in your Call Analytics request.

*/ @property (nonatomic, strong) AWSTranscribeMedia * _Nullable media; /**

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 role making the request must have permission to use the specified KMS key.

*/ @property (nonatomic, strong) NSString * _Nullable outputEncryptionKMSKeyId; /**

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.

*/ @property (nonatomic, strong) NSString * _Nullable outputLocation; /**

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.

*/ @property (nonatomic, strong) AWSTranscribeCallAnalyticsJobSettings * _Nullable settings; @end /** */ @interface AWSTranscribeStartCallAnalyticsJobResponse : AWSModel /**

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

*/ @property (nonatomic, strong) AWSTranscribeCallAnalyticsJob * _Nullable callAnalyticsJob; @end /** */ @interface AWSTranscribeStartMedicalTranscriptionJobRequest : AWSRequest /**

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

*/ @property (nonatomic, assign) AWSTranscribeMedicalContentIdentificationType contentIdentificationType; /**

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.

*/ @property (nonatomic, strong) NSDictionary * _Nullable KMSEncryptionContext; /**

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.

*/ @property (nonatomic, assign) AWSTranscribeLanguageCode languageCode; /**

Describes the Amazon S3 location of the media file you want to use in your request.

For information on supported media formats, refer to the MediaFormat parameter or the Media formats section in the Amazon S3 Developer Guide.

*/ @property (nonatomic, strong) AWSTranscribeMedia * _Nullable media; /**

Specify the format of your input media file.

*/ @property (nonatomic, assign) AWSTranscribeMediaFormat mediaFormat; /**

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

*/ @property (nonatomic, strong) NSNumber * _Nullable mediaSampleRateHertz; /**

A unique name, chosen by you, for your medical transcription job. The name that 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.

*/ @property (nonatomic, strong) NSString * _Nullable medicalTranscriptionJobName; /**

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.

*/ @property (nonatomic, strong) NSString * _Nullable outputBucketName; /**

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 role making the request must have permission to use the specified KMS key.

*/ @property (nonatomic, strong) NSString * _Nullable outputEncryptionKMSKeyId; /**

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.

*/ @property (nonatomic, strong) NSString * _Nullable outputKey; /**

Specify additional optional settings in your request, including channel identification, alternative transcriptions, and speaker partitioning. You can use that to apply custom vocabularies to your transcription job.

*/ @property (nonatomic, strong) AWSTranscribeMedicalTranscriptionSetting * _Nullable settings; /**

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 .

*/ @property (nonatomic, assign) AWSTranscribeSpecialty specialty; /**

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.

*/ @property (nonatomic, strong) NSArray * _Nullable tags; /**

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.

*/ @property (nonatomic, assign) AWSTranscribeTypes types; @end /** */ @interface AWSTranscribeStartMedicalTranscriptionJobResponse : AWSModel /**

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

*/ @property (nonatomic, strong) AWSTranscribeMedicalTranscriptionJob * _Nullable medicalTranscriptionJob; @end /** */ @interface AWSTranscribeStartTranscriptionJobRequest : AWSRequest /**

Makes it possible 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.

*/ @property (nonatomic, strong) AWSTranscribeContentRedaction * _Nullable contentRedaction; /**

Enables automatic language identification in your transcription job request. Use this parameter if your media file contains only one language. If your media contains multiple languages, use IdentifyMultipleLanguages instead.

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 LanguageOptions restricts IdentifyLanguage to only the language options that you specify, which 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). If you include LanguageIdSettings, also include LanguageOptions.

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.

*/ @property (nonatomic, strong) NSNumber * _Nullable identifyLanguage; /**

Enables automatic multi-language identification in your transcription job request. Use this parameter if your media file contains more than one language. If your media contains only one language, use IdentifyLanguage instead.

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 LanguageOptions restricts IdentifyLanguage to only the language options that you specify, which 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). If you include LanguageIdSettings, also include LanguageOptions.

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.

*/ @property (nonatomic, strong) NSNumber * _Nullable identifyMultipleLanguages; /**

Makes it possible 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.

*/ @property (nonatomic, strong) AWSTranscribeJobExecutionSettings * _Nullable jobExecutionSettings; /**

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.

*/ @property (nonatomic, strong) NSDictionary * _Nullable KMSEncryptionContext; /**

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.

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.

 */ @property (nonatomic, assign) AWSTranscribeLanguageCode languageCode; /**

If using automatic language identification 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). Note that multi-language identification (IdentifyMultipleLanguages) doesn't support custom language models.

LanguageIdSettings supports two to five language codes. Each language code you include can have an associated custom language model, custom vocabulary, and custom vocabulary filter. The language codes that you specify must match the languages of the associated custom language models, custom vocabularies, and custom vocabulary filters.

It's recommended that you include LanguageOptions when using LanguageIdSettings to ensure that the correct language dialect is identified. For example, if you specify a custom vocabulary that is in en-US but Amazon Transcribe determines that the language spoken in your media is en-AU, your custom vocabulary is not applied to your transcription. If you include LanguageOptions and include en-US as the only English language dialect, your custom vocabulary is applied to your transcription.

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.

*/ @property (nonatomic, strong) NSDictionary * _Nullable languageIdSettings; /**

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.

*/ @property (nonatomic, strong) NSArray * _Nullable languageOptions; /**

Describes the Amazon S3 location of the media file you want to use in your request.

*/ @property (nonatomic, strong) AWSTranscribeMedia * _Nullable media; /**

Specify the format of your input media file.

*/ @property (nonatomic, assign) AWSTranscribeMediaFormat mediaFormat; /**

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 that you specify and the value detected, your job fails. In most cases, you can omit MediaSampleRateHertz and let Amazon Transcribe determine the sample rate.

*/ @property (nonatomic, strong) NSNumber * _Nullable mediaSampleRateHertz; /**

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.

*/ @property (nonatomic, strong) AWSTranscribeModelSettings * _Nullable modelSettings; /**

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.

*/ @property (nonatomic, strong) NSString * _Nullable outputBucketName; /**

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 role making the request must have permission to use the specified KMS key.

*/ @property (nonatomic, strong) NSString * _Nullable outputEncryptionKMSKeyId; /**

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.

*/ @property (nonatomic, strong) NSString * _Nullable outputKey; /**

Specify additional optional settings in your request, including channel identification, alternative transcriptions, speaker partitioning. You can use that 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.

*/ @property (nonatomic, strong) AWSTranscribeSettings * _Nullable settings; /**

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

*/ @property (nonatomic, strong) AWSTranscribeSubtitles * _Nullable subtitles; /**

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.

*/ @property (nonatomic, strong) NSArray * _Nullable tags; /**

Enables toxic speech detection in your transcript. If you include ToxicityDetection in your request, you must also include ToxicityCategories.

For information on the types of toxic speech Amazon Transcribe can detect, see Detecting toxic speech.

*/ @property (nonatomic, strong) NSArray * _Nullable toxicityDetection; /**

A unique name, chosen by you, for your transcription job. The name that 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.

*/ @property (nonatomic, strong) NSString * _Nullable transcriptionJobName; @end /** */ @interface AWSTranscribeStartTranscriptionJobResponse : AWSModel /**

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

*/ @property (nonatomic, strong) AWSTranscribeTranscriptionJob * _Nullable transcriptionJob; @end /**

Generate subtitles for your media file with your transcription request.

You can choose a start index of 0 or 1, and you can specify either WebVTT or SubRip (or both) as your output format.

Note that your subtitle files are placed in the same location as your transcription output.

*/ @interface AWSTranscribeSubtitles : AWSModel /**

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

*/ @property (nonatomic, strong) NSArray * _Nullable formats; /**

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.

*/ @property (nonatomic, strong) NSNumber * _Nullable outputStartIndex; @end /**

Provides information about your subtitle file, including format, start index, and Amazon S3 location.

*/ @interface AWSTranscribeSubtitlesOutput : AWSModel /**

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

*/ @property (nonatomic, strong) NSArray * _Nullable formats; /**

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.

*/ @property (nonatomic, strong) NSNumber * _Nullable outputStartIndex; /**

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.

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.

 */ @property (nonatomic, strong) NSArray * _Nullable subtitleFileUris; @end /**

Adds metadata, in the form of a key:value pair, to the specified resource.

For example, you could add the tag Department:Sales to a resource to indicate that it pertains to your organization's sales department. You can also use tags for tag-based access control.

To learn more about tagging, see Tagging resources.

Required parameters: [Key, Value] */ @interface AWSTranscribeTag : AWSModel /**

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

*/ @property (nonatomic, strong) NSString * _Nullable key; /**

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.

*/ @property (nonatomic, strong) NSString * _Nullable value; @end /** */ @interface AWSTranscribeTagResourceRequest : AWSRequest /**

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:111122223333:transcription-job/transcription-job-name.

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

*/ @property (nonatomic, strong) NSString * _Nullable resourceArn; /**

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.

*/ @property (nonatomic, strong) NSArray * _Nullable tags; @end /** */ @interface AWSTranscribeTagResourceResponse : AWSModel @end /**

Contains ToxicityCategories, which is a required parameter if you want to enable toxicity detection (ToxicityDetection) in your transcription request.

Required parameters: [ToxicityCategories] */ @interface AWSTranscribeToxicityDetectionSettings : AWSModel /**

If you include ToxicityDetection in your transcription request, you must also include ToxicityCategories. The only accepted value for this parameter is ALL.

*/ @property (nonatomic, strong) NSArray * _Nullable toxicityCategories; @end /**

Provides you with the Amazon S3 URI you can use to access your transcript.

*/ @interface AWSTranscribeTranscript : AWSModel /**

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.

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.

 */ @property (nonatomic, strong) NSString * _Nullable redactedTranscriptFileUri; /**

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.

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.

 */ @property (nonatomic, strong) NSString * _Nullable transcriptFileUri; @end /**

Flag the presence or absence of specific words or phrases detected in your Call Analytics transcription output.

Rules using TranscriptFilter are designed to match:

  • Custom words or phrases spoken by the agent, the customer, or both

  • Custom words or phrases not spoken by the agent, the customer, or either

  • Custom words or phrases that occur at a specific time frame

See Rule criteria for post-call categories and Rule criteria for streaming categories for usage examples.

Required parameters: [TranscriptFilterType, Targets] */ @interface AWSTranscribeTranscriptFilter : AWSModel /**

Makes it possible 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.

*/ @property (nonatomic, strong) AWSTranscribeAbsoluteTimeRange * _Nullable absoluteTimeRange; /**

Set to TRUE to flag the absence of the phrase that you specified in your request. Set to FALSE to flag the presence of the phrase that you specified in your request.

*/ @property (nonatomic, strong) NSNumber * _Nullable negate; /**

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

*/ @property (nonatomic, assign) AWSTranscribeParticipantRole participantRole; /**

Makes it possible 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.

*/ @property (nonatomic, strong) AWSTranscribeRelativeTimeRange * _Nullable relativeTimeRange; /**

Specify the phrases that you want to flag.

*/ @property (nonatomic, strong) NSArray * _Nullable targets; /**

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

*/ @property (nonatomic, assign) AWSTranscribeTranscriptFilterType transcriptFilterType; @end /**

Provides detailed information about a 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.

*/ @interface AWSTranscribeTranscriptionJob : AWSModel /**

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.

*/ @property (nonatomic, strong) NSDate * _Nullable completionTime; /**

Indicates whether redaction was enabled in your transcript.

*/ @property (nonatomic, strong) AWSTranscribeContentRedaction * _Nullable contentRedaction; /**

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.

*/ @property (nonatomic, strong) NSDate * _Nullable creationTime; /**

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.

*/ @property (nonatomic, strong) NSString * _Nullable failureReason; /**

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.

*/ @property (nonatomic, strong) NSNumber * _Nullable identifiedLanguageScore; /**

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

*/ @property (nonatomic, strong) NSNumber * _Nullable identifyLanguage; /**

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

*/ @property (nonatomic, strong) NSNumber * _Nullable identifyMultipleLanguages; /**

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

*/ @property (nonatomic, strong) AWSTranscribeJobExecutionSettings * _Nullable jobExecutionSettings; /**

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

*/ @property (nonatomic, assign) AWSTranscribeLanguageCode languageCode; /**

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.

*/ @property (nonatomic, strong) NSArray * _Nullable languageCodes; /**

Provides the name and language of all custom language models, custom vocabularies, and custom vocabulary filters that you included in your request.

*/ @property (nonatomic, strong) NSDictionary * _Nullable languageIdSettings; /**

Provides the language codes you specified in your request.

*/ @property (nonatomic, strong) NSArray * _Nullable languageOptions; /**

Provides the Amazon S3 location of the media file you used in your request.

*/ @property (nonatomic, strong) AWSTranscribeMedia * _Nullable media; /**

The format of the input media file.

*/ @property (nonatomic, assign) AWSTranscribeMediaFormat mediaFormat; /**

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

*/ @property (nonatomic, strong) NSNumber * _Nullable mediaSampleRateHertz; /**

Provides information on the custom language model you included in your request.

*/ @property (nonatomic, strong) AWSTranscribeModelSettings * _Nullable modelSettings; /**

Provides information on any additional settings that were included in your request. Additional settings include channel identification, alternative transcriptions, speaker partitioning, custom vocabularies, and custom vocabulary filters.

*/ @property (nonatomic, strong) AWSTranscribeSettings * _Nullable settings; /**

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.

*/ @property (nonatomic, strong) NSDate * _Nullable startTime; /**

Indicates whether subtitles were generated with your transcription.

*/ @property (nonatomic, strong) AWSTranscribeSubtitlesOutput * _Nullable subtitles; /**

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

*/ @property (nonatomic, strong) NSArray * _Nullable tags; /**

Provides information about the toxicity detection settings applied to your transcription.

*/ @property (nonatomic, strong) NSArray * _Nullable toxicityDetection; /**

Provides you with the Amazon S3 URI you can use to access your transcript.

*/ @property (nonatomic, strong) AWSTranscribeTranscript * _Nullable transcript; /**

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

*/ @property (nonatomic, strong) NSString * _Nullable transcriptionJobName; /**

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.

*/ @property (nonatomic, assign) AWSTranscribeTranscriptionJobStatus transcriptionJobStatus; @end /**

Provides detailed information about a specific transcription job.

*/ @interface AWSTranscribeTranscriptionJobSummary : AWSModel /**

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.

*/ @property (nonatomic, strong) NSDate * _Nullable completionTime; /**

The content redaction settings of the transcription job.

*/ @property (nonatomic, strong) AWSTranscribeContentRedaction * _Nullable contentRedaction; /**

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.

*/ @property (nonatomic, strong) NSDate * _Nullable creationTime; /**

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

*/ @property (nonatomic, strong) NSString * _Nullable failureReason; /**

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.

*/ @property (nonatomic, strong) NSNumber * _Nullable identifiedLanguageScore; /**

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

*/ @property (nonatomic, strong) NSNumber * _Nullable identifyLanguage; /**

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

*/ @property (nonatomic, strong) NSNumber * _Nullable identifyMultipleLanguages; /**

The language code used to create your transcription.

*/ @property (nonatomic, assign) AWSTranscribeLanguageCode languageCode; /**

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.

*/ @property (nonatomic, strong) NSArray * _Nullable languageCodes; /**

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.

*/ @property (nonatomic, strong) AWSTranscribeModelSettings * _Nullable modelSettings; /**

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.

*/ @property (nonatomic, assign) AWSTranscribeOutputLocationType outputLocationType; /**

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.

*/ @property (nonatomic, strong) NSDate * _Nullable startTime; /**

Indicates whether toxicity detection was enabled for the specified transcription job.

*/ @property (nonatomic, strong) NSArray * _Nullable toxicityDetection; /**

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

*/ @property (nonatomic, strong) NSString * _Nullable transcriptionJobName; /**

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.

*/ @property (nonatomic, assign) AWSTranscribeTranscriptionJobStatus transcriptionJobStatus; @end /** */ @interface AWSTranscribeUntagResourceRequest : AWSRequest /**

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:111122223333:transcription-job/transcription-job-name.

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

*/ @property (nonatomic, strong) NSString * _Nullable resourceArn; /**

Removes the specified tag keys from the specified Amazon Transcribe resource.

*/ @property (nonatomic, strong) NSArray * _Nullable tagKeys; @end /** */ @interface AWSTranscribeUntagResourceResponse : AWSModel @end /** */ @interface AWSTranscribeUpdateCallAnalyticsCategoryRequest : AWSRequest /**

The name of the Call Analytics category you want to update. Category names are case sensitive.

*/ @property (nonatomic, strong) NSString * _Nullable categoryName; /**

Choose whether you want to update a real-time or a post-call category. The input type you specify must match the input type specified when the category was created. For example, if you created a category with the POST_CALL input type, you must use POST_CALL as the input type when updating this category.

*/ @property (nonatomic, assign) AWSTranscribeInputType inputType; /**

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.

*/ @property (nonatomic, strong) NSArray * _Nullable rules; @end /** */ @interface AWSTranscribeUpdateCallAnalyticsCategoryResponse : AWSModel /**

Provides you with the properties of the Call Analytics category you specified in your UpdateCallAnalyticsCategory request.

*/ @property (nonatomic, strong) AWSTranscribeCategoryProperties * _Nullable categoryProperties; @end /** */ @interface AWSTranscribeUpdateMedicalVocabularyRequest : AWSRequest /**

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.

*/ @property (nonatomic, assign) AWSTranscribeLanguageCode languageCode; /**

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

*/ @property (nonatomic, strong) NSString * _Nullable vocabularyFileUri; /**

The name of the custom medical vocabulary you want to update. Custom medical vocabulary names are case sensitive.

*/ @property (nonatomic, strong) NSString * _Nullable vocabularyName; @end /** */ @interface AWSTranscribeUpdateMedicalVocabularyResponse : AWSModel /**

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

*/ @property (nonatomic, assign) AWSTranscribeLanguageCode languageCode; /**

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.

*/ @property (nonatomic, strong) NSDate * _Nullable lastModifiedTime; /**

The name of the updated custom medical vocabulary.

*/ @property (nonatomic, strong) NSString * _Nullable vocabularyName; /**

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

*/ @property (nonatomic, assign) AWSTranscribeVocabularyState vocabularyState; @end /** */ @interface AWSTranscribeUpdateVocabularyFilterRequest : AWSRequest /**

The Amazon Resource Name (ARN) of an IAM role that has permissions to access the Amazon S3 bucket that contains your input files (in this case, your custom vocabulary filter). If the role that 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.

*/ @property (nonatomic, strong) NSString * _Nullable dataAccessRoleArn; /**

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.

*/ @property (nonatomic, strong) NSString * _Nullable vocabularyFilterFileUri; /**

The name of the custom vocabulary filter you want to update. Custom vocabulary filter names are case sensitive.

*/ @property (nonatomic, strong) NSString * _Nullable vocabularyFilterName; /**

Use this parameter if you want to update your custom 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 custom vocabulary filter request fails. Refer to Character Sets for Custom Vocabularies to get the character set for your language.

*/ @property (nonatomic, strong) NSArray * _Nullable words; @end /** */ @interface AWSTranscribeUpdateVocabularyFilterResponse : AWSModel /**

The language code you selected for your custom vocabulary filter.

*/ @property (nonatomic, assign) AWSTranscribeLanguageCode languageCode; /**

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

*/ @property (nonatomic, strong) NSDate * _Nullable lastModifiedTime; /**

The name of the updated custom vocabulary filter.

*/ @property (nonatomic, strong) NSString * _Nullable vocabularyFilterName; @end /** */ @interface AWSTranscribeUpdateVocabularyRequest : AWSRequest /**

The Amazon Resource Name (ARN) of an IAM role that has permissions to access the Amazon S3 bucket that contains your input files (in this case, your custom vocabulary). If the role that 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.

*/ @property (nonatomic, strong) NSString * _Nullable dataAccessRoleArn; /**

The language code that represents the language of the entries in the custom vocabulary you want to update. Each custom vocabulary must contain terms in only one language.

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

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

*/ @property (nonatomic, assign) AWSTranscribeLanguageCode languageCode; /**

Use this parameter if you want to update your custom vocabulary by including all desired terms, as comma-separated values, within your request. The other option for updating your custom 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 custom vocabulary filter request fails. Refer to Character Sets for Custom Vocabularies to get the character set for your language.

*/ @property (nonatomic, strong) NSArray * _Nullable phrases; /**

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.

*/ @property (nonatomic, strong) NSString * _Nullable vocabularyFileUri; /**

The name of the custom vocabulary you want to update. Custom vocabulary names are case sensitive.

*/ @property (nonatomic, strong) NSString * _Nullable vocabularyName; @end /** */ @interface AWSTranscribeUpdateVocabularyResponse : AWSModel /**

The language code you selected for your custom vocabulary.

*/ @property (nonatomic, assign) AWSTranscribeLanguageCode languageCode; /**

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

*/ @property (nonatomic, strong) NSDate * _Nullable lastModifiedTime; /**

The name of the updated custom vocabulary.

*/ @property (nonatomic, strong) NSString * _Nullable vocabularyName; /**

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

*/ @property (nonatomic, assign) AWSTranscribeVocabularyState vocabularyState; @end /**

Provides information about a custom vocabulary filter, including the language of the filter, when it was last modified, and its name.

*/ @interface AWSTranscribeVocabularyFilterInfo : AWSModel /**

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

A custom vocabulary filter can only be used to transcribe files in the same language as the filter. For example, if you create a custom 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.

*/ @property (nonatomic, assign) AWSTranscribeLanguageCode languageCode; /**

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

*/ @property (nonatomic, strong) NSDate * _Nullable lastModifiedTime; /**

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.

*/ @property (nonatomic, strong) NSString * _Nullable vocabularyFilterName; @end /**

Provides information about a custom vocabulary, including the language of the custom vocabulary, when it was last modified, its name, and the processing state.

*/ @interface AWSTranscribeVocabularyInfo : AWSModel /**

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

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

*/ @property (nonatomic, assign) AWSTranscribeLanguageCode languageCode; /**

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

*/ @property (nonatomic, strong) NSDate * _Nullable lastModifiedTime; /**

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.

*/ @property (nonatomic, strong) NSString * _Nullable vocabularyName; /**

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

*/ @property (nonatomic, assign) AWSTranscribeVocabularyState vocabularyState; @end NS_ASSUME_NONNULL_END