/** * Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved. * SPDX-License-Identifier: Apache-2.0. */ #pragma once #include #include #include #include #include #include #include #include #include #include #include #include namespace Aws { namespace Utils { namespace Json { class JsonValue; class JsonView; } // namespace Json } // namespace Utils namespace TranscribeService { namespace Model { /** *

Provides detailed information about a specific transcription * job.

*/ class TranscriptionJobSummary { public: AWS_TRANSCRIBESERVICE_API TranscriptionJobSummary(); AWS_TRANSCRIBESERVICE_API TranscriptionJobSummary(Aws::Utils::Json::JsonView jsonValue); AWS_TRANSCRIBESERVICE_API TranscriptionJobSummary& operator=(Aws::Utils::Json::JsonView jsonValue); AWS_TRANSCRIBESERVICE_API Aws::Utils::Json::JsonValue Jsonize() const; /** *

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

*/ inline const Aws::String& GetTranscriptionJobName() const{ return m_transcriptionJobName; } /** *

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

*/ inline bool TranscriptionJobNameHasBeenSet() const { return m_transcriptionJobNameHasBeenSet; } /** *

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

*/ inline void SetTranscriptionJobName(const Aws::String& value) { m_transcriptionJobNameHasBeenSet = true; m_transcriptionJobName = value; } /** *

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

*/ inline void SetTranscriptionJobName(Aws::String&& value) { m_transcriptionJobNameHasBeenSet = true; m_transcriptionJobName = std::move(value); } /** *

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

*/ inline void SetTranscriptionJobName(const char* value) { m_transcriptionJobNameHasBeenSet = true; m_transcriptionJobName.assign(value); } /** *

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

*/ inline TranscriptionJobSummary& WithTranscriptionJobName(const Aws::String& value) { SetTranscriptionJobName(value); return *this;} /** *

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

*/ inline TranscriptionJobSummary& WithTranscriptionJobName(Aws::String&& value) { SetTranscriptionJobName(std::move(value)); return *this;} /** *

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

*/ inline TranscriptionJobSummary& WithTranscriptionJobName(const char* value) { SetTranscriptionJobName(value); return *this;} /** *

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.

*/ inline const Aws::Utils::DateTime& GetCreationTime() const{ return m_creationTime; } /** *

The date and time the specified transcription job request was made.

*/ inline bool CreationTimeHasBeenSet() const { return m_creationTimeHasBeenSet; } /** *

The date and time the specified transcription job request was made.

*/ inline void SetCreationTime(const Aws::Utils::DateTime& value) { m_creationTimeHasBeenSet = true; m_creationTime = value; } /** *

The date and time the specified transcription job request was made.

*/ inline void SetCreationTime(Aws::Utils::DateTime&& value) { m_creationTimeHasBeenSet = true; m_creationTime = std::move(value); } /** *

The date and time the specified transcription job request was made.

*/ inline TranscriptionJobSummary& WithCreationTime(const Aws::Utils::DateTime& value) { SetCreationTime(value); return *this;} /** *

The date and time the specified transcription job request was made.

*/ inline TranscriptionJobSummary& WithCreationTime(Aws::Utils::DateTime&& value) { SetCreationTime(std::move(value)); return *this;} /** *

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.

*/ inline const Aws::Utils::DateTime& GetStartTime() const{ return m_startTime; } /** *

The date and time your transcription job began processing.

*/ inline bool StartTimeHasBeenSet() const { return m_startTimeHasBeenSet; } /** *

The date and time your transcription job began processing.

*/ inline void SetStartTime(const Aws::Utils::DateTime& value) { m_startTimeHasBeenSet = true; m_startTime = value; } /** *

The date and time your transcription job began processing.

*/ inline void SetStartTime(Aws::Utils::DateTime&& value) { m_startTimeHasBeenSet = true; m_startTime = std::move(value); } /** *

The date and time your transcription job began processing.

*/ inline TranscriptionJobSummary& WithStartTime(const Aws::Utils::DateTime& value) { SetStartTime(value); return *this;} /** *

The date and time your transcription job began processing.

*/ inline TranscriptionJobSummary& WithStartTime(Aws::Utils::DateTime&& value) { SetStartTime(std::move(value)); return *this;} /** *

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.

*/ inline const Aws::Utils::DateTime& GetCompletionTime() const{ return m_completionTime; } /** *

The date and time the specified transcription job finished processing.

*/ inline bool CompletionTimeHasBeenSet() const { return m_completionTimeHasBeenSet; } /** *

The date and time the specified transcription job finished processing.

*/ inline void SetCompletionTime(const Aws::Utils::DateTime& value) { m_completionTimeHasBeenSet = true; m_completionTime = value; } /** *

The date and time the specified transcription job finished processing.

*/ inline void SetCompletionTime(Aws::Utils::DateTime&& value) { m_completionTimeHasBeenSet = true; m_completionTime = std::move(value); } /** *

The date and time the specified transcription job finished processing.

*/ inline TranscriptionJobSummary& WithCompletionTime(const Aws::Utils::DateTime& value) { SetCompletionTime(value); return *this;} /** *

The date and time the specified transcription job finished processing.

*/ inline TranscriptionJobSummary& WithCompletionTime(Aws::Utils::DateTime&& value) { SetCompletionTime(std::move(value)); return *this;} /** *

The language code used to create your transcription.

*/ inline const LanguageCode& GetLanguageCode() const{ return m_languageCode; } /** *

The language code used to create your transcription.

*/ inline bool LanguageCodeHasBeenSet() const { return m_languageCodeHasBeenSet; } /** *

The language code used to create your transcription.

*/ inline void SetLanguageCode(const LanguageCode& value) { m_languageCodeHasBeenSet = true; m_languageCode = value; } /** *

The language code used to create your transcription.

*/ inline void SetLanguageCode(LanguageCode&& value) { m_languageCodeHasBeenSet = true; m_languageCode = std::move(value); } /** *

The language code used to create your transcription.

*/ inline TranscriptionJobSummary& WithLanguageCode(const LanguageCode& value) { SetLanguageCode(value); return *this;} /** *

The language code used to create your transcription.

*/ inline TranscriptionJobSummary& WithLanguageCode(LanguageCode&& value) { SetLanguageCode(std::move(value)); return *this;} /** *

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.

*/ inline const TranscriptionJobStatus& GetTranscriptionJobStatus() const{ return m_transcriptionJobStatus; } /** *

Provides the status of your transcription job.

*/ inline bool TranscriptionJobStatusHasBeenSet() const { return m_transcriptionJobStatusHasBeenSet; } /** *

Provides the status of your transcription job.

*/ inline void SetTranscriptionJobStatus(const TranscriptionJobStatus& value) { m_transcriptionJobStatusHasBeenSet = true; m_transcriptionJobStatus = value; } /** *

Provides the status of your transcription job.

*/ inline void SetTranscriptionJobStatus(TranscriptionJobStatus&& value) { m_transcriptionJobStatusHasBeenSet = true; m_transcriptionJobStatus = std::move(value); } /** *

Provides the status of your transcription job.

*/ inline TranscriptionJobSummary& WithTranscriptionJobStatus(const TranscriptionJobStatus& value) { SetTranscriptionJobStatus(value); return *this;} /** *

Provides the status of your transcription job.

*/ inline TranscriptionJobSummary& WithTranscriptionJobStatus(TranscriptionJobStatus&& value) { SetTranscriptionJobStatus(std::move(value)); return *this;} /** *

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

*/ inline const Aws::String& GetFailureReason() const{ return m_failureReason; } /** *

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

*/ inline bool FailureReasonHasBeenSet() const { return m_failureReasonHasBeenSet; } /** *

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

*/ inline void SetFailureReason(const Aws::String& value) { m_failureReasonHasBeenSet = true; m_failureReason = value; } /** *

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

*/ inline void SetFailureReason(Aws::String&& value) { m_failureReasonHasBeenSet = true; m_failureReason = std::move(value); } /** *

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

*/ inline void SetFailureReason(const char* value) { m_failureReasonHasBeenSet = true; m_failureReason.assign(value); } /** *

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

*/ inline TranscriptionJobSummary& WithFailureReason(const Aws::String& value) { SetFailureReason(value); return *this;} /** *

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

*/ inline TranscriptionJobSummary& WithFailureReason(Aws::String&& value) { SetFailureReason(std::move(value)); return *this;} /** *

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

*/ inline TranscriptionJobSummary& WithFailureReason(const char* value) { SetFailureReason(value); return *this;} /** *

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.

*/ inline const OutputLocationType& GetOutputLocationType() const{ return m_outputLocationType; } /** *

Indicates where the specified transcription output is stored.

*/ inline bool OutputLocationTypeHasBeenSet() const { return m_outputLocationTypeHasBeenSet; } /** *

Indicates where the specified transcription output is stored.

*/ inline void SetOutputLocationType(const OutputLocationType& value) { m_outputLocationTypeHasBeenSet = true; m_outputLocationType = value; } /** *

Indicates where the specified transcription output is stored.

*/ inline void SetOutputLocationType(OutputLocationType&& value) { m_outputLocationTypeHasBeenSet = true; m_outputLocationType = std::move(value); } /** *

Indicates where the specified transcription output is stored.

*/ inline TranscriptionJobSummary& WithOutputLocationType(const OutputLocationType& value) { SetOutputLocationType(value); return *this;} /** *

Indicates where the specified transcription output is stored.

*/ inline TranscriptionJobSummary& WithOutputLocationType(OutputLocationType&& value) { SetOutputLocationType(std::move(value)); return *this;} /** *

The content redaction settings of the transcription job.

*/ inline const ContentRedaction& GetContentRedaction() const{ return m_contentRedaction; } /** *

The content redaction settings of the transcription job.

*/ inline bool ContentRedactionHasBeenSet() const { return m_contentRedactionHasBeenSet; } /** *

The content redaction settings of the transcription job.

*/ inline void SetContentRedaction(const ContentRedaction& value) { m_contentRedactionHasBeenSet = true; m_contentRedaction = value; } /** *

The content redaction settings of the transcription job.

*/ inline void SetContentRedaction(ContentRedaction&& value) { m_contentRedactionHasBeenSet = true; m_contentRedaction = std::move(value); } /** *

The content redaction settings of the transcription job.

*/ inline TranscriptionJobSummary& WithContentRedaction(const ContentRedaction& value) { SetContentRedaction(value); return *this;} /** *

The content redaction settings of the transcription job.

*/ inline TranscriptionJobSummary& WithContentRedaction(ContentRedaction&& value) { SetContentRedaction(std::move(value)); return *this;} inline const ModelSettings& GetModelSettings() const{ return m_modelSettings; } inline bool ModelSettingsHasBeenSet() const { return m_modelSettingsHasBeenSet; } inline void SetModelSettings(const ModelSettings& value) { m_modelSettingsHasBeenSet = true; m_modelSettings = value; } inline void SetModelSettings(ModelSettings&& value) { m_modelSettingsHasBeenSet = true; m_modelSettings = std::move(value); } inline TranscriptionJobSummary& WithModelSettings(const ModelSettings& value) { SetModelSettings(value); return *this;} inline TranscriptionJobSummary& WithModelSettings(ModelSettings&& value) { SetModelSettings(std::move(value)); return *this;} /** *

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

*/ inline bool GetIdentifyLanguage() const{ return m_identifyLanguage; } /** *

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

*/ inline bool IdentifyLanguageHasBeenSet() const { return m_identifyLanguageHasBeenSet; } /** *

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

*/ inline void SetIdentifyLanguage(bool value) { m_identifyLanguageHasBeenSet = true; m_identifyLanguage = value; } /** *

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

*/ inline TranscriptionJobSummary& WithIdentifyLanguage(bool value) { SetIdentifyLanguage(value); return *this;} /** *

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

*/ inline bool GetIdentifyMultipleLanguages() const{ return m_identifyMultipleLanguages; } /** *

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

*/ inline bool IdentifyMultipleLanguagesHasBeenSet() const { return m_identifyMultipleLanguagesHasBeenSet; } /** *

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

*/ inline void SetIdentifyMultipleLanguages(bool value) { m_identifyMultipleLanguagesHasBeenSet = true; m_identifyMultipleLanguages = value; } /** *

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

*/ inline TranscriptionJobSummary& WithIdentifyMultipleLanguages(bool value) { SetIdentifyMultipleLanguages(value); return *this;} /** *

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.

*/ inline double GetIdentifiedLanguageScore() const{ return m_identifiedLanguageScore; } /** *

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.

*/ inline bool IdentifiedLanguageScoreHasBeenSet() const { return m_identifiedLanguageScoreHasBeenSet; } /** *

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.

*/ inline void SetIdentifiedLanguageScore(double value) { m_identifiedLanguageScoreHasBeenSet = true; m_identifiedLanguageScore = value; } /** *

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.

*/ inline TranscriptionJobSummary& WithIdentifiedLanguageScore(double value) { SetIdentifiedLanguageScore(value); return *this;} /** *

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.

*/ inline const Aws::Vector& GetLanguageCodes() const{ return m_languageCodes; } /** *

*/ inline bool LanguageCodesHasBeenSet() const { return m_languageCodesHasBeenSet; } /** *

*/ inline void SetLanguageCodes(const Aws::Vector& value) { m_languageCodesHasBeenSet = true; m_languageCodes = value; } /** *

*/ inline void SetLanguageCodes(Aws::Vector&& value) { m_languageCodesHasBeenSet = true; m_languageCodes = std::move(value); } /** *

*/ inline TranscriptionJobSummary& WithLanguageCodes(const Aws::Vector& value) { SetLanguageCodes(value); return *this;} /** *

*/ inline TranscriptionJobSummary& WithLanguageCodes(Aws::Vector&& value) { SetLanguageCodes(std::move(value)); return *this;} /** *

*/ inline TranscriptionJobSummary& AddLanguageCodes(const LanguageCodeItem& value) { m_languageCodesHasBeenSet = true; m_languageCodes.push_back(value); return *this; } /** *

*/ inline TranscriptionJobSummary& AddLanguageCodes(LanguageCodeItem&& value) { m_languageCodesHasBeenSet = true; m_languageCodes.push_back(std::move(value)); return *this; } /** *