This repository has been archived on 2025-09-14. You can view files and clone it, but cannot push or open issues or pull requests.
Files
pxz-hos-client-cpp-module/support/aws-sdk-cpp-master/aws-cpp-sdk-transcribe/include/aws/transcribe/model/StartTranscriptionJobRequest.h

789 lines
43 KiB
C
Raw Normal View History

/**
* Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
* SPDX-License-Identifier: Apache-2.0.
*/
#pragma once
#include <aws/transcribe/TranscribeService_EXPORTS.h>
#include <aws/transcribe/TranscribeServiceRequest.h>
#include <aws/core/utils/memory/stl/AWSString.h>
#include <aws/transcribe/model/LanguageCode.h>
#include <aws/transcribe/model/MediaFormat.h>
#include <aws/transcribe/model/Media.h>
#include <aws/transcribe/model/Settings.h>
#include <aws/transcribe/model/ModelSettings.h>
#include <aws/transcribe/model/JobExecutionSettings.h>
#include <aws/transcribe/model/ContentRedaction.h>
#include <utility>
namespace Aws
{
namespace TranscribeService
{
namespace Model
{
/**
*/
class AWS_TRANSCRIBESERVICE_API StartTranscriptionJobRequest : public TranscribeServiceRequest
{
public:
StartTranscriptionJobRequest();
// Service request name is the Operation name which will send this request out,
// each operation should has unique request name, so that we can get operation's name from this request.
// Note: this is not true for response, multiple operations may have the same response name,
// so we can not get operation's name from response.
inline virtual const char* GetServiceRequestName() const override { return "StartTranscriptionJob"; }
Aws::String SerializePayload() const override;
Aws::Http::HeaderValueCollection GetRequestSpecificHeaders() const override;
/**
* <p>The name of the job. You can't use the strings "<code>.</code>" or
* "<code>..</code>" by themselves as the job name. The name must also be unique
* within an AWS account. If you try to create a transcription job with the same
* name as a previous transcription job, you get a <code>ConflictException</code>
* error.</p>
*/
inline const Aws::String& GetTranscriptionJobName() const{ return m_transcriptionJobName; }
/**
* <p>The name of the job. You can't use the strings "<code>.</code>" or
* "<code>..</code>" by themselves as the job name. The name must also be unique
* within an AWS account. If you try to create a transcription job with the same
* name as a previous transcription job, you get a <code>ConflictException</code>
* error.</p>
*/
inline bool TranscriptionJobNameHasBeenSet() const { return m_transcriptionJobNameHasBeenSet; }
/**
* <p>The name of the job. You can't use the strings "<code>.</code>" or
* "<code>..</code>" by themselves as the job name. The name must also be unique
* within an AWS account. If you try to create a transcription job with the same
* name as a previous transcription job, you get a <code>ConflictException</code>
* error.</p>
*/
inline void SetTranscriptionJobName(const Aws::String& value) { m_transcriptionJobNameHasBeenSet = true; m_transcriptionJobName = value; }
/**
* <p>The name of the job. You can't use the strings "<code>.</code>" or
* "<code>..</code>" by themselves as the job name. The name must also be unique
* within an AWS account. If you try to create a transcription job with the same
* name as a previous transcription job, you get a <code>ConflictException</code>
* error.</p>
*/
inline void SetTranscriptionJobName(Aws::String&& value) { m_transcriptionJobNameHasBeenSet = true; m_transcriptionJobName = std::move(value); }
/**
* <p>The name of the job. You can't use the strings "<code>.</code>" or
* "<code>..</code>" by themselves as the job name. The name must also be unique
* within an AWS account. If you try to create a transcription job with the same
* name as a previous transcription job, you get a <code>ConflictException</code>
* error.</p>
*/
inline void SetTranscriptionJobName(const char* value) { m_transcriptionJobNameHasBeenSet = true; m_transcriptionJobName.assign(value); }
/**
* <p>The name of the job. You can't use the strings "<code>.</code>" or
* "<code>..</code>" by themselves as the job name. The name must also be unique
* within an AWS account. If you try to create a transcription job with the same
* name as a previous transcription job, you get a <code>ConflictException</code>
* error.</p>
*/
inline StartTranscriptionJobRequest& WithTranscriptionJobName(const Aws::String& value) { SetTranscriptionJobName(value); return *this;}
/**
* <p>The name of the job. You can't use the strings "<code>.</code>" or
* "<code>..</code>" by themselves as the job name. The name must also be unique
* within an AWS account. If you try to create a transcription job with the same
* name as a previous transcription job, you get a <code>ConflictException</code>
* error.</p>
*/
inline StartTranscriptionJobRequest& WithTranscriptionJobName(Aws::String&& value) { SetTranscriptionJobName(std::move(value)); return *this;}
/**
* <p>The name of the job. You can't use the strings "<code>.</code>" or
* "<code>..</code>" by themselves as the job name. The name must also be unique
* within an AWS account. If you try to create a transcription job with the same
* name as a previous transcription job, you get a <code>ConflictException</code>
* error.</p>
*/
inline StartTranscriptionJobRequest& WithTranscriptionJobName(const char* value) { SetTranscriptionJobName(value); return *this;}
/**
* <p>The language code for the language used in the input media file.</p>
*/
inline const LanguageCode& GetLanguageCode() const{ return m_languageCode; }
/**
* <p>The language code for the language used in the input media file.</p>
*/
inline bool LanguageCodeHasBeenSet() const { return m_languageCodeHasBeenSet; }
/**
* <p>The language code for the language used in the input media file.</p>
*/
inline void SetLanguageCode(const LanguageCode& value) { m_languageCodeHasBeenSet = true; m_languageCode = value; }
/**
* <p>The language code for the language used in the input media file.</p>
*/
inline void SetLanguageCode(LanguageCode&& value) { m_languageCodeHasBeenSet = true; m_languageCode = std::move(value); }
/**
* <p>The language code for the language used in the input media file.</p>
*/
inline StartTranscriptionJobRequest& WithLanguageCode(const LanguageCode& value) { SetLanguageCode(value); return *this;}
/**
* <p>The language code for the language used in the input media file.</p>
*/
inline StartTranscriptionJobRequest& WithLanguageCode(LanguageCode&& value) { SetLanguageCode(std::move(value)); return *this;}
/**
* <p>The sample rate, in Hertz, of the audio track in the input media file. </p>
* <p>If you do not specify the media sample rate, Amazon Transcribe determines the
* sample rate. If you specify the sample rate, it must match the sample rate
* detected by Amazon Transcribe. In most cases, you should leave the
* <code>MediaSampleRateHertz</code> field blank and let Amazon Transcribe
* determine the sample rate.</p>
*/
inline int GetMediaSampleRateHertz() const{ return m_mediaSampleRateHertz; }
/**
* <p>The sample rate, in Hertz, of the audio track in the input media file. </p>
* <p>If you do not specify the media sample rate, Amazon Transcribe determines the
* sample rate. If you specify the sample rate, it must match the sample rate
* detected by Amazon Transcribe. In most cases, you should leave the
* <code>MediaSampleRateHertz</code> field blank and let Amazon Transcribe
* determine the sample rate.</p>
*/
inline bool MediaSampleRateHertzHasBeenSet() const { return m_mediaSampleRateHertzHasBeenSet; }
/**
* <p>The sample rate, in Hertz, of the audio track in the input media file. </p>
* <p>If you do not specify the media sample rate, Amazon Transcribe determines the
* sample rate. If you specify the sample rate, it must match the sample rate
* detected by Amazon Transcribe. In most cases, you should leave the
* <code>MediaSampleRateHertz</code> field blank and let Amazon Transcribe
* determine the sample rate.</p>
*/
inline void SetMediaSampleRateHertz(int value) { m_mediaSampleRateHertzHasBeenSet = true; m_mediaSampleRateHertz = value; }
/**
* <p>The sample rate, in Hertz, of the audio track in the input media file. </p>
* <p>If you do not specify the media sample rate, Amazon Transcribe determines the
* sample rate. If you specify the sample rate, it must match the sample rate
* detected by Amazon Transcribe. In most cases, you should leave the
* <code>MediaSampleRateHertz</code> field blank and let Amazon Transcribe
* determine the sample rate.</p>
*/
inline StartTranscriptionJobRequest& WithMediaSampleRateHertz(int value) { SetMediaSampleRateHertz(value); return *this;}
/**
* <p>The format of the input media file.</p>
*/
inline const MediaFormat& GetMediaFormat() const{ return m_mediaFormat; }
/**
* <p>The format of the input media file.</p>
*/
inline bool MediaFormatHasBeenSet() const { return m_mediaFormatHasBeenSet; }
/**
* <p>The format of the input media file.</p>
*/
inline void SetMediaFormat(const MediaFormat& value) { m_mediaFormatHasBeenSet = true; m_mediaFormat = value; }
/**
* <p>The format of the input media file.</p>
*/
inline void SetMediaFormat(MediaFormat&& value) { m_mediaFormatHasBeenSet = true; m_mediaFormat = std::move(value); }
/**
* <p>The format of the input media file.</p>
*/
inline StartTranscriptionJobRequest& WithMediaFormat(const MediaFormat& value) { SetMediaFormat(value); return *this;}
/**
* <p>The format of the input media file.</p>
*/
inline StartTranscriptionJobRequest& WithMediaFormat(MediaFormat&& value) { SetMediaFormat(std::move(value)); return *this;}
/**
* <p>An object that describes the input media for a transcription job.</p>
*/
inline const Media& GetMedia() const{ return m_media; }
/**
* <p>An object that describes the input media for a transcription job.</p>
*/
inline bool MediaHasBeenSet() const { return m_mediaHasBeenSet; }
/**
* <p>An object that describes the input media for a transcription job.</p>
*/
inline void SetMedia(const Media& value) { m_mediaHasBeenSet = true; m_media = value; }
/**
* <p>An object that describes the input media for a transcription job.</p>
*/
inline void SetMedia(Media&& value) { m_mediaHasBeenSet = true; m_media = std::move(value); }
/**
* <p>An object that describes the input media for a transcription job.</p>
*/
inline StartTranscriptionJobRequest& WithMedia(const Media& value) { SetMedia(value); return *this;}
/**
* <p>An object that describes the input media for a transcription job.</p>
*/
inline StartTranscriptionJobRequest& WithMedia(Media&& value) { SetMedia(std::move(value)); return *this;}
/**
* <p>The location where the transcription is stored.</p> <p>If you set the
* <code>OutputBucketName</code>, Amazon Transcribe puts the transcript in the
* specified S3 bucket. When you call the <a>GetTranscriptionJob</a> operation, the
* operation returns this location in the <code>TranscriptFileUri</code> field. If
* you enable content redaction, the redacted transcript appears in
* <code>RedactedTranscriptFileUri</code>. If you enable content redaction and
* choose to output an unredacted transcript, that transcript's location still
* appears in the <code>TranscriptFileUri</code>. The S3 bucket must have
* permissions that allow Amazon Transcribe to put files in the bucket. For more
* information, see <a
* href="https://docs.aws.amazon.com/transcribe/latest/dg/security_iam_id-based-policy-examples.html#auth-role-iam-user">Permissions
* Required for IAM User Roles</a>.</p> <p>You can specify an AWS Key Management
* Service (KMS) key to encrypt the output of your transcription using the
* <code>OutputEncryptionKMSKeyId</code> parameter. If you don't specify a KMS key,
* Amazon Transcribe uses the default Amazon S3 key for server-side encryption of
* transcripts that are placed in your S3 bucket.</p> <p>If you don't set the
* <code>OutputBucketName</code>, Amazon Transcribe generates a pre-signed URL, a
* shareable URL that provides secure access to your transcription, and returns it
* in the <code>TranscriptFileUri</code> field. Use this URL to download the
* transcription.</p>
*/
inline const Aws::String& GetOutputBucketName() const{ return m_outputBucketName; }
/**
* <p>The location where the transcription is stored.</p> <p>If you set the
* <code>OutputBucketName</code>, Amazon Transcribe puts the transcript in the
* specified S3 bucket. When you call the <a>GetTranscriptionJob</a> operation, the
* operation returns this location in the <code>TranscriptFileUri</code> field. If
* you enable content redaction, the redacted transcript appears in
* <code>RedactedTranscriptFileUri</code>. If you enable content redaction and
* choose to output an unredacted transcript, that transcript's location still
* appears in the <code>TranscriptFileUri</code>. The S3 bucket must have
* permissions that allow Amazon Transcribe to put files in the bucket. For more
* information, see <a
* href="https://docs.aws.amazon.com/transcribe/latest/dg/security_iam_id-based-policy-examples.html#auth-role-iam-user">Permissions
* Required for IAM User Roles</a>.</p> <p>You can specify an AWS Key Management
* Service (KMS) key to encrypt the output of your transcription using the
* <code>OutputEncryptionKMSKeyId</code> parameter. If you don't specify a KMS key,
* Amazon Transcribe uses the default Amazon S3 key for server-side encryption of
* transcripts that are placed in your S3 bucket.</p> <p>If you don't set the
* <code>OutputBucketName</code>, Amazon Transcribe generates a pre-signed URL, a
* shareable URL that provides secure access to your transcription, and returns it
* in the <code>TranscriptFileUri</code> field. Use this URL to download the
* transcription.</p>
*/
inline bool OutputBucketNameHasBeenSet() const { return m_outputBucketNameHasBeenSet; }
/**
* <p>The location where the transcription is stored.</p> <p>If you set the
* <code>OutputBucketName</code>, Amazon Transcribe puts the transcript in the
* specified S3 bucket. When you call the <a>GetTranscriptionJob</a> operation, the
* operation returns this location in the <code>TranscriptFileUri</code> field. If
* you enable content redaction, the redacted transcript appears in
* <code>RedactedTranscriptFileUri</code>. If you enable content redaction and
* choose to output an unredacted transcript, that transcript's location still
* appears in the <code>TranscriptFileUri</code>. The S3 bucket must have
* permissions that allow Amazon Transcribe to put files in the bucket. For more
* information, see <a
* href="https://docs.aws.amazon.com/transcribe/latest/dg/security_iam_id-based-policy-examples.html#auth-role-iam-user">Permissions
* Required for IAM User Roles</a>.</p> <p>You can specify an AWS Key Management
* Service (KMS) key to encrypt the output of your transcription using the
* <code>OutputEncryptionKMSKeyId</code> parameter. If you don't specify a KMS key,
* Amazon Transcribe uses the default Amazon S3 key for server-side encryption of
* transcripts that are placed in your S3 bucket.</p> <p>If you don't set the
* <code>OutputBucketName</code>, Amazon Transcribe generates a pre-signed URL, a
* shareable URL that provides secure access to your transcription, and returns it
* in the <code>TranscriptFileUri</code> field. Use this URL to download the
* transcription.</p>
*/
inline void SetOutputBucketName(const Aws::String& value) { m_outputBucketNameHasBeenSet = true; m_outputBucketName = value; }
/**
* <p>The location where the transcription is stored.</p> <p>If you set the
* <code>OutputBucketName</code>, Amazon Transcribe puts the transcript in the
* specified S3 bucket. When you call the <a>GetTranscriptionJob</a> operation, the
* operation returns this location in the <code>TranscriptFileUri</code> field. If
* you enable content redaction, the redacted transcript appears in
* <code>RedactedTranscriptFileUri</code>. If you enable content redaction and
* choose to output an unredacted transcript, that transcript's location still
* appears in the <code>TranscriptFileUri</code>. The S3 bucket must have
* permissions that allow Amazon Transcribe to put files in the bucket. For more
* information, see <a
* href="https://docs.aws.amazon.com/transcribe/latest/dg/security_iam_id-based-policy-examples.html#auth-role-iam-user">Permissions
* Required for IAM User Roles</a>.</p> <p>You can specify an AWS Key Management
* Service (KMS) key to encrypt the output of your transcription using the
* <code>OutputEncryptionKMSKeyId</code> parameter. If you don't specify a KMS key,
* Amazon Transcribe uses the default Amazon S3 key for server-side encryption of
* transcripts that are placed in your S3 bucket.</p> <p>If you don't set the
* <code>OutputBucketName</code>, Amazon Transcribe generates a pre-signed URL, a
* shareable URL that provides secure access to your transcription, and returns it
* in the <code>TranscriptFileUri</code> field. Use this URL to download the
* transcription.</p>
*/
inline void SetOutputBucketName(Aws::String&& value) { m_outputBucketNameHasBeenSet = true; m_outputBucketName = std::move(value); }
/**
* <p>The location where the transcription is stored.</p> <p>If you set the
* <code>OutputBucketName</code>, Amazon Transcribe puts the transcript in the
* specified S3 bucket. When you call the <a>GetTranscriptionJob</a> operation, the
* operation returns this location in the <code>TranscriptFileUri</code> field. If
* you enable content redaction, the redacted transcript appears in
* <code>RedactedTranscriptFileUri</code>. If you enable content redaction and
* choose to output an unredacted transcript, that transcript's location still
* appears in the <code>TranscriptFileUri</code>. The S3 bucket must have
* permissions that allow Amazon Transcribe to put files in the bucket. For more
* information, see <a
* href="https://docs.aws.amazon.com/transcribe/latest/dg/security_iam_id-based-policy-examples.html#auth-role-iam-user">Permissions
* Required for IAM User Roles</a>.</p> <p>You can specify an AWS Key Management
* Service (KMS) key to encrypt the output of your transcription using the
* <code>OutputEncryptionKMSKeyId</code> parameter. If you don't specify a KMS key,
* Amazon Transcribe uses the default Amazon S3 key for server-side encryption of
* transcripts that are placed in your S3 bucket.</p> <p>If you don't set the
* <code>OutputBucketName</code>, Amazon Transcribe generates a pre-signed URL, a
* shareable URL that provides secure access to your transcription, and returns it
* in the <code>TranscriptFileUri</code> field. Use this URL to download the
* transcription.</p>
*/
inline void SetOutputBucketName(const char* value) { m_outputBucketNameHasBeenSet = true; m_outputBucketName.assign(value); }
/**
* <p>The location where the transcription is stored.</p> <p>If you set the
* <code>OutputBucketName</code>, Amazon Transcribe puts the transcript in the
* specified S3 bucket. When you call the <a>GetTranscriptionJob</a> operation, the
* operation returns this location in the <code>TranscriptFileUri</code> field. If
* you enable content redaction, the redacted transcript appears in
* <code>RedactedTranscriptFileUri</code>. If you enable content redaction and
* choose to output an unredacted transcript, that transcript's location still
* appears in the <code>TranscriptFileUri</code>. The S3 bucket must have
* permissions that allow Amazon Transcribe to put files in the bucket. For more
* information, see <a
* href="https://docs.aws.amazon.com/transcribe/latest/dg/security_iam_id-based-policy-examples.html#auth-role-iam-user">Permissions
* Required for IAM User Roles</a>.</p> <p>You can specify an AWS Key Management
* Service (KMS) key to encrypt the output of your transcription using the
* <code>OutputEncryptionKMSKeyId</code> parameter. If you don't specify a KMS key,
* Amazon Transcribe uses the default Amazon S3 key for server-side encryption of
* transcripts that are placed in your S3 bucket.</p> <p>If you don't set the
* <code>OutputBucketName</code>, Amazon Transcribe generates a pre-signed URL, a
* shareable URL that provides secure access to your transcription, and returns it
* in the <code>TranscriptFileUri</code> field. Use this URL to download the
* transcription.</p>
*/
inline StartTranscriptionJobRequest& WithOutputBucketName(const Aws::String& value) { SetOutputBucketName(value); return *this;}
/**
* <p>The location where the transcription is stored.</p> <p>If you set the
* <code>OutputBucketName</code>, Amazon Transcribe puts the transcript in the
* specified S3 bucket. When you call the <a>GetTranscriptionJob</a> operation, the
* operation returns this location in the <code>TranscriptFileUri</code> field. If
* you enable content redaction, the redacted transcript appears in
* <code>RedactedTranscriptFileUri</code>. If you enable content redaction and
* choose to output an unredacted transcript, that transcript's location still
* appears in the <code>TranscriptFileUri</code>. The S3 bucket must have
* permissions that allow Amazon Transcribe to put files in the bucket. For more
* information, see <a
* href="https://docs.aws.amazon.com/transcribe/latest/dg/security_iam_id-based-policy-examples.html#auth-role-iam-user">Permissions
* Required for IAM User Roles</a>.</p> <p>You can specify an AWS Key Management
* Service (KMS) key to encrypt the output of your transcription using the
* <code>OutputEncryptionKMSKeyId</code> parameter. If you don't specify a KMS key,
* Amazon Transcribe uses the default Amazon S3 key for server-side encryption of
* transcripts that are placed in your S3 bucket.</p> <p>If you don't set the
* <code>OutputBucketName</code>, Amazon Transcribe generates a pre-signed URL, a
* shareable URL that provides secure access to your transcription, and returns it
* in the <code>TranscriptFileUri</code> field. Use this URL to download the
* transcription.</p>
*/
inline StartTranscriptionJobRequest& WithOutputBucketName(Aws::String&& value) { SetOutputBucketName(std::move(value)); return *this;}
/**
* <p>The location where the transcription is stored.</p> <p>If you set the
* <code>OutputBucketName</code>, Amazon Transcribe puts the transcript in the
* specified S3 bucket. When you call the <a>GetTranscriptionJob</a> operation, the
* operation returns this location in the <code>TranscriptFileUri</code> field. If
* you enable content redaction, the redacted transcript appears in
* <code>RedactedTranscriptFileUri</code>. If you enable content redaction and
* choose to output an unredacted transcript, that transcript's location still
* appears in the <code>TranscriptFileUri</code>. The S3 bucket must have
* permissions that allow Amazon Transcribe to put files in the bucket. For more
* information, see <a
* href="https://docs.aws.amazon.com/transcribe/latest/dg/security_iam_id-based-policy-examples.html#auth-role-iam-user">Permissions
* Required for IAM User Roles</a>.</p> <p>You can specify an AWS Key Management
* Service (KMS) key to encrypt the output of your transcription using the
* <code>OutputEncryptionKMSKeyId</code> parameter. If you don't specify a KMS key,
* Amazon Transcribe uses the default Amazon S3 key for server-side encryption of
* transcripts that are placed in your S3 bucket.</p> <p>If you don't set the
* <code>OutputBucketName</code>, Amazon Transcribe generates a pre-signed URL, a
* shareable URL that provides secure access to your transcription, and returns it
* in the <code>TranscriptFileUri</code> field. Use this URL to download the
* transcription.</p>
*/
inline StartTranscriptionJobRequest& WithOutputBucketName(const char* value) { SetOutputBucketName(value); return *this;}
/**
* <p>The Amazon Resource Name (ARN) of the AWS Key Management Service (KMS) key
* used to encrypt the output of the transcription job. The user calling the
* <code>StartTranscriptionJob</code> operation must have permission to use the
* specified KMS key.</p> <p>You can use either of the following to identify a KMS
* key in the current account:</p> <ul> <li> <p>KMS Key ID:
* "1234abcd-12ab-34cd-56ef-1234567890ab"</p> </li> <li> <p>KMS Key Alias:
* "alias/ExampleAlias"</p> </li> </ul> <p>You can use either of the following to
* identify a KMS key in the current account or another account:</p> <ul> <li>
* <p>Amazon Resource Name (ARN) of a KMS Key: "arn:aws:kms:region:account
* ID:key/1234abcd-12ab-34cd-56ef-1234567890ab"</p> </li> <li> <p>ARN of a KMS Key
* Alias: "arn:aws:kms:region:account ID:alias/ExampleAlias"</p> </li> </ul> <p>If
* you don't specify an encryption key, the output of the transcription job is
* encrypted with the default Amazon S3 key (SSE-S3). </p> <p>If you specify a KMS
* key to encrypt your output, you must also specify an output location in the
* <code>OutputBucketName</code> parameter.</p>
*/
inline const Aws::String& GetOutputEncryptionKMSKeyId() const{ return m_outputEncryptionKMSKeyId; }
/**
* <p>The Amazon Resource Name (ARN) of the AWS Key Management Service (KMS) key
* used to encrypt the output of the transcription job. The user calling the
* <code>StartTranscriptionJob</code> operation must have permission to use the
* specified KMS key.</p> <p>You can use either of the following to identify a KMS
* key in the current account:</p> <ul> <li> <p>KMS Key ID:
* "1234abcd-12ab-34cd-56ef-1234567890ab"</p> </li> <li> <p>KMS Key Alias:
* "alias/ExampleAlias"</p> </li> </ul> <p>You can use either of the following to
* identify a KMS key in the current account or another account:</p> <ul> <li>
* <p>Amazon Resource Name (ARN) of a KMS Key: "arn:aws:kms:region:account
* ID:key/1234abcd-12ab-34cd-56ef-1234567890ab"</p> </li> <li> <p>ARN of a KMS Key
* Alias: "arn:aws:kms:region:account ID:alias/ExampleAlias"</p> </li> </ul> <p>If
* you don't specify an encryption key, the output of the transcription job is
* encrypted with the default Amazon S3 key (SSE-S3). </p> <p>If you specify a KMS
* key to encrypt your output, you must also specify an output location in the
* <code>OutputBucketName</code> parameter.</p>
*/
inline bool OutputEncryptionKMSKeyIdHasBeenSet() const { return m_outputEncryptionKMSKeyIdHasBeenSet; }
/**
* <p>The Amazon Resource Name (ARN) of the AWS Key Management Service (KMS) key
* used to encrypt the output of the transcription job. The user calling the
* <code>StartTranscriptionJob</code> operation must have permission to use the
* specified KMS key.</p> <p>You can use either of the following to identify a KMS
* key in the current account:</p> <ul> <li> <p>KMS Key ID:
* "1234abcd-12ab-34cd-56ef-1234567890ab"</p> </li> <li> <p>KMS Key Alias:
* "alias/ExampleAlias"</p> </li> </ul> <p>You can use either of the following to
* identify a KMS key in the current account or another account:</p> <ul> <li>
* <p>Amazon Resource Name (ARN) of a KMS Key: "arn:aws:kms:region:account
* ID:key/1234abcd-12ab-34cd-56ef-1234567890ab"</p> </li> <li> <p>ARN of a KMS Key
* Alias: "arn:aws:kms:region:account ID:alias/ExampleAlias"</p> </li> </ul> <p>If
* you don't specify an encryption key, the output of the transcription job is
* encrypted with the default Amazon S3 key (SSE-S3). </p> <p>If you specify a KMS
* key to encrypt your output, you must also specify an output location in the
* <code>OutputBucketName</code> parameter.</p>
*/
inline void SetOutputEncryptionKMSKeyId(const Aws::String& value) { m_outputEncryptionKMSKeyIdHasBeenSet = true; m_outputEncryptionKMSKeyId = value; }
/**
* <p>The Amazon Resource Name (ARN) of the AWS Key Management Service (KMS) key
* used to encrypt the output of the transcription job. The user calling the
* <code>StartTranscriptionJob</code> operation must have permission to use the
* specified KMS key.</p> <p>You can use either of the following to identify a KMS
* key in the current account:</p> <ul> <li> <p>KMS Key ID:
* "1234abcd-12ab-34cd-56ef-1234567890ab"</p> </li> <li> <p>KMS Key Alias:
* "alias/ExampleAlias"</p> </li> </ul> <p>You can use either of the following to
* identify a KMS key in the current account or another account:</p> <ul> <li>
* <p>Amazon Resource Name (ARN) of a KMS Key: "arn:aws:kms:region:account
* ID:key/1234abcd-12ab-34cd-56ef-1234567890ab"</p> </li> <li> <p>ARN of a KMS Key
* Alias: "arn:aws:kms:region:account ID:alias/ExampleAlias"</p> </li> </ul> <p>If
* you don't specify an encryption key, the output of the transcription job is
* encrypted with the default Amazon S3 key (SSE-S3). </p> <p>If you specify a KMS
* key to encrypt your output, you must also specify an output location in the
* <code>OutputBucketName</code> parameter.</p>
*/
inline void SetOutputEncryptionKMSKeyId(Aws::String&& value) { m_outputEncryptionKMSKeyIdHasBeenSet = true; m_outputEncryptionKMSKeyId = std::move(value); }
/**
* <p>The Amazon Resource Name (ARN) of the AWS Key Management Service (KMS) key
* used to encrypt the output of the transcription job. The user calling the
* <code>StartTranscriptionJob</code> operation must have permission to use the
* specified KMS key.</p> <p>You can use either of the following to identify a KMS
* key in the current account:</p> <ul> <li> <p>KMS Key ID:
* "1234abcd-12ab-34cd-56ef-1234567890ab"</p> </li> <li> <p>KMS Key Alias:
* "alias/ExampleAlias"</p> </li> </ul> <p>You can use either of the following to
* identify a KMS key in the current account or another account:</p> <ul> <li>
* <p>Amazon Resource Name (ARN) of a KMS Key: "arn:aws:kms:region:account
* ID:key/1234abcd-12ab-34cd-56ef-1234567890ab"</p> </li> <li> <p>ARN of a KMS Key
* Alias: "arn:aws:kms:region:account ID:alias/ExampleAlias"</p> </li> </ul> <p>If
* you don't specify an encryption key, the output of the transcription job is
* encrypted with the default Amazon S3 key (SSE-S3). </p> <p>If you specify a KMS
* key to encrypt your output, you must also specify an output location in the
* <code>OutputBucketName</code> parameter.</p>
*/
inline void SetOutputEncryptionKMSKeyId(const char* value) { m_outputEncryptionKMSKeyIdHasBeenSet = true; m_outputEncryptionKMSKeyId.assign(value); }
/**
* <p>The Amazon Resource Name (ARN) of the AWS Key Management Service (KMS) key
* used to encrypt the output of the transcription job. The user calling the
* <code>StartTranscriptionJob</code> operation must have permission to use the
* specified KMS key.</p> <p>You can use either of the following to identify a KMS
* key in the current account:</p> <ul> <li> <p>KMS Key ID:
* "1234abcd-12ab-34cd-56ef-1234567890ab"</p> </li> <li> <p>KMS Key Alias:
* "alias/ExampleAlias"</p> </li> </ul> <p>You can use either of the following to
* identify a KMS key in the current account or another account:</p> <ul> <li>
* <p>Amazon Resource Name (ARN) of a KMS Key: "arn:aws:kms:region:account
* ID:key/1234abcd-12ab-34cd-56ef-1234567890ab"</p> </li> <li> <p>ARN of a KMS Key
* Alias: "arn:aws:kms:region:account ID:alias/ExampleAlias"</p> </li> </ul> <p>If
* you don't specify an encryption key, the output of the transcription job is
* encrypted with the default Amazon S3 key (SSE-S3). </p> <p>If you specify a KMS
* key to encrypt your output, you must also specify an output location in the
* <code>OutputBucketName</code> parameter.</p>
*/
inline StartTranscriptionJobRequest& WithOutputEncryptionKMSKeyId(const Aws::String& value) { SetOutputEncryptionKMSKeyId(value); return *this;}
/**
* <p>The Amazon Resource Name (ARN) of the AWS Key Management Service (KMS) key
* used to encrypt the output of the transcription job. The user calling the
* <code>StartTranscriptionJob</code> operation must have permission to use the
* specified KMS key.</p> <p>You can use either of the following to identify a KMS
* key in the current account:</p> <ul> <li> <p>KMS Key ID:
* "1234abcd-12ab-34cd-56ef-1234567890ab"</p> </li> <li> <p>KMS Key Alias:
* "alias/ExampleAlias"</p> </li> </ul> <p>You can use either of the following to
* identify a KMS key in the current account or another account:</p> <ul> <li>
* <p>Amazon Resource Name (ARN) of a KMS Key: "arn:aws:kms:region:account
* ID:key/1234abcd-12ab-34cd-56ef-1234567890ab"</p> </li> <li> <p>ARN of a KMS Key
* Alias: "arn:aws:kms:region:account ID:alias/ExampleAlias"</p> </li> </ul> <p>If
* you don't specify an encryption key, the output of the transcription job is
* encrypted with the default Amazon S3 key (SSE-S3). </p> <p>If you specify a KMS
* key to encrypt your output, you must also specify an output location in the
* <code>OutputBucketName</code> parameter.</p>
*/
inline StartTranscriptionJobRequest& WithOutputEncryptionKMSKeyId(Aws::String&& value) { SetOutputEncryptionKMSKeyId(std::move(value)); return *this;}
/**
* <p>The Amazon Resource Name (ARN) of the AWS Key Management Service (KMS) key
* used to encrypt the output of the transcription job. The user calling the
* <code>StartTranscriptionJob</code> operation must have permission to use the
* specified KMS key.</p> <p>You can use either of the following to identify a KMS
* key in the current account:</p> <ul> <li> <p>KMS Key ID:
* "1234abcd-12ab-34cd-56ef-1234567890ab"</p> </li> <li> <p>KMS Key Alias:
* "alias/ExampleAlias"</p> </li> </ul> <p>You can use either of the following to
* identify a KMS key in the current account or another account:</p> <ul> <li>
* <p>Amazon Resource Name (ARN) of a KMS Key: "arn:aws:kms:region:account
* ID:key/1234abcd-12ab-34cd-56ef-1234567890ab"</p> </li> <li> <p>ARN of a KMS Key
* Alias: "arn:aws:kms:region:account ID:alias/ExampleAlias"</p> </li> </ul> <p>If
* you don't specify an encryption key, the output of the transcription job is
* encrypted with the default Amazon S3 key (SSE-S3). </p> <p>If you specify a KMS
* key to encrypt your output, you must also specify an output location in the
* <code>OutputBucketName</code> parameter.</p>
*/
inline StartTranscriptionJobRequest& WithOutputEncryptionKMSKeyId(const char* value) { SetOutputEncryptionKMSKeyId(value); return *this;}
/**
* <p>A <code>Settings</code> object that provides optional settings for a
* transcription job.</p>
*/
inline const Settings& GetSettings() const{ return m_settings; }
/**
* <p>A <code>Settings</code> object that provides optional settings for a
* transcription job.</p>
*/
inline bool SettingsHasBeenSet() const { return m_settingsHasBeenSet; }
/**
* <p>A <code>Settings</code> object that provides optional settings for a
* transcription job.</p>
*/
inline void SetSettings(const Settings& value) { m_settingsHasBeenSet = true; m_settings = value; }
/**
* <p>A <code>Settings</code> object that provides optional settings for a
* transcription job.</p>
*/
inline void SetSettings(Settings&& value) { m_settingsHasBeenSet = true; m_settings = std::move(value); }
/**
* <p>A <code>Settings</code> object that provides optional settings for a
* transcription job.</p>
*/
inline StartTranscriptionJobRequest& WithSettings(const Settings& value) { SetSettings(value); return *this;}
/**
* <p>A <code>Settings</code> object that provides optional settings for a
* transcription job.</p>
*/
inline StartTranscriptionJobRequest& WithSettings(Settings&& value) { SetSettings(std::move(value)); return *this;}
/**
* <p>Choose the custom language model you use for your transcription job in this
* parameter.</p>
*/
inline const ModelSettings& GetModelSettings() const{ return m_modelSettings; }
/**
* <p>Choose the custom language model you use for your transcription job in this
* parameter.</p>
*/
inline bool ModelSettingsHasBeenSet() const { return m_modelSettingsHasBeenSet; }
/**
* <p>Choose the custom language model you use for your transcription job in this
* parameter.</p>
*/
inline void SetModelSettings(const ModelSettings& value) { m_modelSettingsHasBeenSet = true; m_modelSettings = value; }
/**
* <p>Choose the custom language model you use for your transcription job in this
* parameter.</p>
*/
inline void SetModelSettings(ModelSettings&& value) { m_modelSettingsHasBeenSet = true; m_modelSettings = std::move(value); }
/**
* <p>Choose the custom language model you use for your transcription job in this
* parameter.</p>
*/
inline StartTranscriptionJobRequest& WithModelSettings(const ModelSettings& value) { SetModelSettings(value); return *this;}
/**
* <p>Choose the custom language model you use for your transcription job in this
* parameter.</p>
*/
inline StartTranscriptionJobRequest& WithModelSettings(ModelSettings&& value) { SetModelSettings(std::move(value)); return *this;}
/**
* <p>Provides information about how a transcription job is executed. Use this
* field to indicate that the job can be queued for deferred execution if the
* concurrency limit is reached and there are no slots available to immediately run
* the job.</p>
*/
inline const JobExecutionSettings& GetJobExecutionSettings() const{ return m_jobExecutionSettings; }
/**
* <p>Provides information about how a transcription job is executed. Use this
* field to indicate that the job can be queued for deferred execution if the
* concurrency limit is reached and there are no slots available to immediately run
* the job.</p>
*/
inline bool JobExecutionSettingsHasBeenSet() const { return m_jobExecutionSettingsHasBeenSet; }
/**
* <p>Provides information about how a transcription job is executed. Use this
* field to indicate that the job can be queued for deferred execution if the
* concurrency limit is reached and there are no slots available to immediately run
* the job.</p>
*/
inline void SetJobExecutionSettings(const JobExecutionSettings& value) { m_jobExecutionSettingsHasBeenSet = true; m_jobExecutionSettings = value; }
/**
* <p>Provides information about how a transcription job is executed. Use this
* field to indicate that the job can be queued for deferred execution if the
* concurrency limit is reached and there are no slots available to immediately run
* the job.</p>
*/
inline void SetJobExecutionSettings(JobExecutionSettings&& value) { m_jobExecutionSettingsHasBeenSet = true; m_jobExecutionSettings = std::move(value); }
/**
* <p>Provides information about how a transcription job is executed. Use this
* field to indicate that the job can be queued for deferred execution if the
* concurrency limit is reached and there are no slots available to immediately run
* the job.</p>
*/
inline StartTranscriptionJobRequest& WithJobExecutionSettings(const JobExecutionSettings& value) { SetJobExecutionSettings(value); return *this;}
/**
* <p>Provides information about how a transcription job is executed. Use this
* field to indicate that the job can be queued for deferred execution if the
* concurrency limit is reached and there are no slots available to immediately run
* the job.</p>
*/
inline StartTranscriptionJobRequest& WithJobExecutionSettings(JobExecutionSettings&& value) { SetJobExecutionSettings(std::move(value)); return *this;}
/**
* <p>An object that contains the request parameters for content redaction.</p>
*/
inline const ContentRedaction& GetContentRedaction() const{ return m_contentRedaction; }
/**
* <p>An object that contains the request parameters for content redaction.</p>
*/
inline bool ContentRedactionHasBeenSet() const { return m_contentRedactionHasBeenSet; }
/**
* <p>An object that contains the request parameters for content redaction.</p>
*/
inline void SetContentRedaction(const ContentRedaction& value) { m_contentRedactionHasBeenSet = true; m_contentRedaction = value; }
/**
* <p>An object that contains the request parameters for content redaction.</p>
*/
inline void SetContentRedaction(ContentRedaction&& value) { m_contentRedactionHasBeenSet = true; m_contentRedaction = std::move(value); }
/**
* <p>An object that contains the request parameters for content redaction.</p>
*/
inline StartTranscriptionJobRequest& WithContentRedaction(const ContentRedaction& value) { SetContentRedaction(value); return *this;}
/**
* <p>An object that contains the request parameters for content redaction.</p>
*/
inline StartTranscriptionJobRequest& WithContentRedaction(ContentRedaction&& value) { SetContentRedaction(std::move(value)); return *this;}
private:
Aws::String m_transcriptionJobName;
bool m_transcriptionJobNameHasBeenSet;
LanguageCode m_languageCode;
bool m_languageCodeHasBeenSet;
int m_mediaSampleRateHertz;
bool m_mediaSampleRateHertzHasBeenSet;
MediaFormat m_mediaFormat;
bool m_mediaFormatHasBeenSet;
Media m_media;
bool m_mediaHasBeenSet;
Aws::String m_outputBucketName;
bool m_outputBucketNameHasBeenSet;
Aws::String m_outputEncryptionKMSKeyId;
bool m_outputEncryptionKMSKeyIdHasBeenSet;
Settings m_settings;
bool m_settingsHasBeenSet;
ModelSettings m_modelSettings;
bool m_modelSettingsHasBeenSet;
JobExecutionSettings m_jobExecutionSettings;
bool m_jobExecutionSettingsHasBeenSet;
ContentRedaction m_contentRedaction;
bool m_contentRedactionHasBeenSet;
};
} // namespace Model
} // namespace TranscribeService
} // namespace Aws