AWS SDK for C++  1.9.160
AWS SDK for C++
Public Member Functions | List of all members
Aws::TranscribeService::Model::StartCallAnalyticsJobRequest Class Reference

#include <StartCallAnalyticsJobRequest.h>

+ Inheritance diagram for Aws::TranscribeService::Model::StartCallAnalyticsJobRequest:

Public Member Functions

 StartCallAnalyticsJobRequest ()
 
virtual const char * GetServiceRequestName () const override
 
Aws::String SerializePayload () const override
 
Aws::Http::HeaderValueCollection GetRequestSpecificHeaders () const override
 
const Aws::StringGetCallAnalyticsJobName () const
 
bool CallAnalyticsJobNameHasBeenSet () const
 
void SetCallAnalyticsJobName (const Aws::String &value)
 
void SetCallAnalyticsJobName (Aws::String &&value)
 
void SetCallAnalyticsJobName (const char *value)
 
StartCallAnalyticsJobRequestWithCallAnalyticsJobName (const Aws::String &value)
 
StartCallAnalyticsJobRequestWithCallAnalyticsJobName (Aws::String &&value)
 
StartCallAnalyticsJobRequestWithCallAnalyticsJobName (const char *value)
 
const MediaGetMedia () const
 
bool MediaHasBeenSet () const
 
void SetMedia (const Media &value)
 
void SetMedia (Media &&value)
 
StartCallAnalyticsJobRequestWithMedia (const Media &value)
 
StartCallAnalyticsJobRequestWithMedia (Media &&value)
 
const Aws::StringGetOutputLocation () const
 
bool OutputLocationHasBeenSet () const
 
void SetOutputLocation (const Aws::String &value)
 
void SetOutputLocation (Aws::String &&value)
 
void SetOutputLocation (const char *value)
 
StartCallAnalyticsJobRequestWithOutputLocation (const Aws::String &value)
 
StartCallAnalyticsJobRequestWithOutputLocation (Aws::String &&value)
 
StartCallAnalyticsJobRequestWithOutputLocation (const char *value)
 
const Aws::StringGetOutputEncryptionKMSKeyId () const
 
bool OutputEncryptionKMSKeyIdHasBeenSet () const
 
void SetOutputEncryptionKMSKeyId (const Aws::String &value)
 
void SetOutputEncryptionKMSKeyId (Aws::String &&value)
 
void SetOutputEncryptionKMSKeyId (const char *value)
 
StartCallAnalyticsJobRequestWithOutputEncryptionKMSKeyId (const Aws::String &value)
 
StartCallAnalyticsJobRequestWithOutputEncryptionKMSKeyId (Aws::String &&value)
 
StartCallAnalyticsJobRequestWithOutputEncryptionKMSKeyId (const char *value)
 
const Aws::StringGetDataAccessRoleArn () const
 
bool DataAccessRoleArnHasBeenSet () const
 
void SetDataAccessRoleArn (const Aws::String &value)
 
void SetDataAccessRoleArn (Aws::String &&value)
 
void SetDataAccessRoleArn (const char *value)
 
StartCallAnalyticsJobRequestWithDataAccessRoleArn (const Aws::String &value)
 
StartCallAnalyticsJobRequestWithDataAccessRoleArn (Aws::String &&value)
 
StartCallAnalyticsJobRequestWithDataAccessRoleArn (const char *value)
 
const CallAnalyticsJobSettingsGetSettings () const
 
bool SettingsHasBeenSet () const
 
void SetSettings (const CallAnalyticsJobSettings &value)
 
void SetSettings (CallAnalyticsJobSettings &&value)
 
StartCallAnalyticsJobRequestWithSettings (const CallAnalyticsJobSettings &value)
 
StartCallAnalyticsJobRequestWithSettings (CallAnalyticsJobSettings &&value)
 
const Aws::Vector< ChannelDefinition > & GetChannelDefinitions () const
 
bool ChannelDefinitionsHasBeenSet () const
 
void SetChannelDefinitions (const Aws::Vector< ChannelDefinition > &value)
 
void SetChannelDefinitions (Aws::Vector< ChannelDefinition > &&value)
 
StartCallAnalyticsJobRequestWithChannelDefinitions (const Aws::Vector< ChannelDefinition > &value)
 
StartCallAnalyticsJobRequestWithChannelDefinitions (Aws::Vector< ChannelDefinition > &&value)
 
StartCallAnalyticsJobRequestAddChannelDefinitions (const ChannelDefinition &value)
 
StartCallAnalyticsJobRequestAddChannelDefinitions (ChannelDefinition &&value)
 
- Public Member Functions inherited from Aws::TranscribeService::TranscribeServiceRequest
virtual ~TranscribeServiceRequest ()
 
void AddParametersToRequest (Aws::Http::HttpRequest &httpRequest) const
 
Aws::Http::HeaderValueCollection GetHeaders () const override
 
- Public Member Functions inherited from Aws::AmazonSerializableWebServiceRequest
 AmazonSerializableWebServiceRequest ()
 
virtual ~AmazonSerializableWebServiceRequest ()
 
std::shared_ptr< Aws::IOStreamGetBody () const override
 
- Public Member Functions inherited from Aws::AmazonWebServiceRequest
 AmazonWebServiceRequest ()
 
virtual ~AmazonWebServiceRequest ()=default
 
virtual void AddQueryStringParameters (Aws::Http::URI &uri) const
 
virtual void PutToPresignedUrl (Aws::Http::URI &uri) const
 
virtual bool IsStreaming () const
 
virtual bool IsEventStreamRequest () const
 
virtual bool SignBody () const
 
virtual bool IsChunked () const
 
virtual void SetRequestSignedHandler (const RequestSignedHandler &handler)
 
virtual const RequestSignedHandlerGetRequestSignedHandler () const
 
const Aws::IOStreamFactoryGetResponseStreamFactory () const
 
void SetResponseStreamFactory (const Aws::IOStreamFactory &factory)
 
virtual void SetDataReceivedEventHandler (const Aws::Http::DataReceivedEventHandler &dataReceivedEventHandler)
 
virtual void SetDataSentEventHandler (const Aws::Http::DataSentEventHandler &dataSentEventHandler)
 
virtual void SetContinueRequestHandler (const Aws::Http::ContinueRequestHandler &continueRequestHandler)
 
virtual void SetDataReceivedEventHandler (Aws::Http::DataReceivedEventHandler &&dataReceivedEventHandler)
 
virtual void SetDataSentEventHandler (Aws::Http::DataSentEventHandler &&dataSentEventHandler)
 
virtual void SetContinueRequestHandler (Aws::Http::ContinueRequestHandler &&continueRequestHandler)
 
virtual void SetRequestRetryHandler (const RequestRetryHandler &handler)
 
virtual void SetRequestRetryHandler (RequestRetryHandler &&handler)
 
virtual const Aws::Http::DataReceivedEventHandlerGetDataReceivedEventHandler () const
 
virtual const Aws::Http::DataSentEventHandlerGetDataSentEventHandler () const
 
virtual const Aws::Http::ContinueRequestHandlerGetContinueRequestHandler () const
 
virtual const RequestRetryHandlerGetRequestRetryHandler () const
 
virtual bool ShouldComputeContentMd5 () const
 

Additional Inherited Members

- Protected Member Functions inherited from Aws::AmazonWebServiceRequest
virtual void DumpBodyToUrl (Aws::Http::URI &uri) const
 

Detailed Description

Definition at line 25 of file StartCallAnalyticsJobRequest.h.

Constructor & Destructor Documentation

◆ StartCallAnalyticsJobRequest()

Aws::TranscribeService::Model::StartCallAnalyticsJobRequest::StartCallAnalyticsJobRequest ( )

Member Function Documentation

◆ AddChannelDefinitions() [1/2]

StartCallAnalyticsJobRequest& Aws::TranscribeService::Model::StartCallAnalyticsJobRequest::AddChannelDefinitions ( ChannelDefinition &&  value)
inline

When you start a call analytics job, you must pass an array that maps the agent and the customer to specific audio channels. The values you can assign to a channel are 0 and 1. The agent and the customer must each have their own channel. You can't assign more than one channel to an agent or customer.

Definition at line 635 of file StartCallAnalyticsJobRequest.h.

◆ AddChannelDefinitions() [2/2]

StartCallAnalyticsJobRequest& Aws::TranscribeService::Model::StartCallAnalyticsJobRequest::AddChannelDefinitions ( const ChannelDefinition value)
inline

When you start a call analytics job, you must pass an array that maps the agent and the customer to specific audio channels. The values you can assign to a channel are 0 and 1. The agent and the customer must each have their own channel. You can't assign more than one channel to an agent or customer.

Definition at line 627 of file StartCallAnalyticsJobRequest.h.

◆ CallAnalyticsJobNameHasBeenSet()

bool Aws::TranscribeService::Model::StartCallAnalyticsJobRequest::CallAnalyticsJobNameHasBeenSet ( ) const
inline

The name of the call analytics job. You can't use the string "." or ".." by themselves as the job name. The name must also be unique within an Amazon Web Services account. If you try to create a call analytics job with the same name as a previous call analytics job, you get a ConflictException error.

Definition at line 57 of file StartCallAnalyticsJobRequest.h.

◆ ChannelDefinitionsHasBeenSet()

bool Aws::TranscribeService::Model::StartCallAnalyticsJobRequest::ChannelDefinitionsHasBeenSet ( ) const
inline

When you start a call analytics job, you must pass an array that maps the agent and the customer to specific audio channels. The values you can assign to a channel are 0 and 1. The agent and the customer must each have their own channel. You can't assign more than one channel to an agent or customer.

Definition at line 587 of file StartCallAnalyticsJobRequest.h.

◆ DataAccessRoleArnHasBeenSet()

bool Aws::TranscribeService::Model::StartCallAnalyticsJobRequest::DataAccessRoleArnHasBeenSet ( ) const
inline

The Amazon Resource Name (ARN) of a role that has access to the S3 bucket that contains your input files. Amazon Transcribe assumes this role to read queued audio files. If you have specified an output S3 bucket for your transcription results, this role should have access to the output bucket as well.

Definition at line 479 of file StartCallAnalyticsJobRequest.h.

◆ GetCallAnalyticsJobName()

const Aws::String& Aws::TranscribeService::Model::StartCallAnalyticsJobRequest::GetCallAnalyticsJobName ( ) const
inline

The name of the call analytics job. You can't use the string "." or ".." by themselves as the job name. The name must also be unique within an Amazon Web Services account. If you try to create a call analytics job with the same name as a previous call analytics job, you get a ConflictException error.

Definition at line 48 of file StartCallAnalyticsJobRequest.h.

◆ GetChannelDefinitions()

const Aws::Vector<ChannelDefinition>& Aws::TranscribeService::Model::StartCallAnalyticsJobRequest::GetChannelDefinitions ( ) const
inline

When you start a call analytics job, you must pass an array that maps the agent and the customer to specific audio channels. The values you can assign to a channel are 0 and 1. The agent and the customer must each have their own channel. You can't assign more than one channel to an agent or customer.

Definition at line 579 of file StartCallAnalyticsJobRequest.h.

◆ GetDataAccessRoleArn()

const Aws::String& Aws::TranscribeService::Model::StartCallAnalyticsJobRequest::GetDataAccessRoleArn ( ) const
inline

The Amazon Resource Name (ARN) of a role that has access to the S3 bucket that contains your input files. Amazon Transcribe assumes this role to read queued audio files. If you have specified an output S3 bucket for your transcription results, this role should have access to the output bucket as well.

Definition at line 470 of file StartCallAnalyticsJobRequest.h.

◆ GetMedia()

const Media& Aws::TranscribeService::Model::StartCallAnalyticsJobRequest::GetMedia ( ) const
inline

Definition at line 115 of file StartCallAnalyticsJobRequest.h.

◆ GetOutputEncryptionKMSKeyId()

const Aws::String& Aws::TranscribeService::Model::StartCallAnalyticsJobRequest::GetOutputEncryptionKMSKeyId ( ) const
inline

The Amazon Resource Name (ARN) of the Amazon Web Services Key Management Service key used to encrypt the output of the call analytics job. The user calling the operation must have permission to use the specified KMS key.

You use either of the following to identify an Amazon Web Services KMS key in the current account:

  • KMS Key ID: "1234abcd-12ab-34cd-56ef-1234567890ab"

  • KMS Key Alias: "alias/ExampleAlias"

You can use either of the following to identify a KMS key in the current account or another account:

  • Amazon Resource Name (ARN) of a KMS key in the current account or another account: "arn:aws:kms:region:account ID:key/1234abcd-12ab-34cd-56ef1234567890ab"

  • ARN of a KMS Key Alias: "arn:aws:kms:region:account ID:alias/ExampleAlias"

If you don't specify an encryption key, the output of the call analytics job 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 in the OutputLocation parameter.

Definition at line 320 of file StartCallAnalyticsJobRequest.h.

◆ GetOutputLocation()

const Aws::String& Aws::TranscribeService::Model::StartCallAnalyticsJobRequest::GetOutputLocation ( ) const
inline

The Amazon S3 location where the output of the call analytics job is stored. You can provide the following location types to store the output of call analytics job:

  • s3://DOC-EXAMPLE-BUCKET1

    If you specify a bucket, Amazon Transcribe saves the output of the analytics job as a JSON file at the root level of the bucket.

  • s3://DOC-EXAMPLE-BUCKET1/folder/

    f you specify a path, Amazon Transcribe saves the output of the analytics job as s3://DOC-EXAMPLE-BUCKET1/folder/your-transcription-job-name.json

    If you specify a folder, you must provide a trailing slash.

  • s3://DOC-EXAMPLE-BUCKET1/folder/filename.json

    If you provide a path that has the filename specified, Amazon Transcribe saves the output of the analytics job as s3://DOC-EXAMPLEBUCKET1/folder/filename.json

You can specify an Amazon Web Services Key Management Service (KMS) key to encrypt the output of our analytics job using the OutputEncryptionKMSKeyId parameter. If you don't specify a KMS key, Amazon Transcribe uses the default Amazon S3 key for server-side encryption of the analytics job output that is placed in your S3 bucket.

Definition at line 152 of file StartCallAnalyticsJobRequest.h.

◆ GetRequestSpecificHeaders()

Aws::Http::HeaderValueCollection Aws::TranscribeService::Model::StartCallAnalyticsJobRequest::GetRequestSpecificHeaders ( ) const
overridevirtual

◆ GetServiceRequestName()

virtual const char* Aws::TranscribeService::Model::StartCallAnalyticsJobRequest::GetServiceRequestName ( ) const
inlineoverridevirtual

Implements Aws::AmazonWebServiceRequest.

Definition at line 34 of file StartCallAnalyticsJobRequest.h.

◆ GetSettings()

const CallAnalyticsJobSettings& Aws::TranscribeService::Model::StartCallAnalyticsJobRequest::GetSettings ( ) const
inline

A Settings object that provides optional settings for a call analytics job.

Definition at line 540 of file StartCallAnalyticsJobRequest.h.

◆ MediaHasBeenSet()

bool Aws::TranscribeService::Model::StartCallAnalyticsJobRequest::MediaHasBeenSet ( ) const
inline

Definition at line 118 of file StartCallAnalyticsJobRequest.h.

◆ OutputEncryptionKMSKeyIdHasBeenSet()

bool Aws::TranscribeService::Model::StartCallAnalyticsJobRequest::OutputEncryptionKMSKeyIdHasBeenSet ( ) const
inline

The Amazon Resource Name (ARN) of the Amazon Web Services Key Management Service key used to encrypt the output of the call analytics job. The user calling the operation must have permission to use the specified KMS key.

You use either of the following to identify an Amazon Web Services KMS key in the current account:

  • KMS Key ID: "1234abcd-12ab-34cd-56ef-1234567890ab"

  • KMS Key Alias: "alias/ExampleAlias"

You can use either of the following to identify a KMS key in the current account or another account:

  • Amazon Resource Name (ARN) of a KMS key in the current account or another account: "arn:aws:kms:region:account ID:key/1234abcd-12ab-34cd-56ef1234567890ab"

  • ARN of a KMS Key Alias: "arn:aws:kms:region:account ID:alias/ExampleAlias"

If you don't specify an encryption key, the output of the call analytics job 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 in the OutputLocation parameter.

Definition at line 340 of file StartCallAnalyticsJobRequest.h.

◆ OutputLocationHasBeenSet()

bool Aws::TranscribeService::Model::StartCallAnalyticsJobRequest::OutputLocationHasBeenSet ( ) const
inline

The Amazon S3 location where the output of the call analytics job is stored. You can provide the following location types to store the output of call analytics job:

  • s3://DOC-EXAMPLE-BUCKET1

    If you specify a bucket, Amazon Transcribe saves the output of the analytics job as a JSON file at the root level of the bucket.

  • s3://DOC-EXAMPLE-BUCKET1/folder/

    f you specify a path, Amazon Transcribe saves the output of the analytics job as s3://DOC-EXAMPLE-BUCKET1/folder/your-transcription-job-name.json

    If you specify a folder, you must provide a trailing slash.

  • s3://DOC-EXAMPLE-BUCKET1/folder/filename.json

    If you provide a path that has the filename specified, Amazon Transcribe saves the output of the analytics job as s3://DOC-EXAMPLEBUCKET1/folder/filename.json

You can specify an Amazon Web Services Key Management Service (KMS) key to encrypt the output of our analytics job using the OutputEncryptionKMSKeyId parameter. If you don't specify a KMS key, Amazon Transcribe uses the default Amazon S3 key for server-side encryption of the analytics job output that is placed in your S3 bucket.

Definition at line 173 of file StartCallAnalyticsJobRequest.h.

◆ SerializePayload()

Aws::String Aws::TranscribeService::Model::StartCallAnalyticsJobRequest::SerializePayload ( ) const
overridevirtual

Convert payload into String.

Implements Aws::AmazonSerializableWebServiceRequest.

◆ SetCallAnalyticsJobName() [1/3]

void Aws::TranscribeService::Model::StartCallAnalyticsJobRequest::SetCallAnalyticsJobName ( Aws::String &&  value)
inline

The name of the call analytics job. You can't use the string "." or ".." by themselves as the job name. The name must also be unique within an Amazon Web Services account. If you try to create a call analytics job with the same name as a previous call analytics job, you get a ConflictException error.

Definition at line 75 of file StartCallAnalyticsJobRequest.h.

◆ SetCallAnalyticsJobName() [2/3]

void Aws::TranscribeService::Model::StartCallAnalyticsJobRequest::SetCallAnalyticsJobName ( const Aws::String value)
inline

The name of the call analytics job. You can't use the string "." or ".." by themselves as the job name. The name must also be unique within an Amazon Web Services account. If you try to create a call analytics job with the same name as a previous call analytics job, you get a ConflictException error.

Definition at line 66 of file StartCallAnalyticsJobRequest.h.

◆ SetCallAnalyticsJobName() [3/3]

void Aws::TranscribeService::Model::StartCallAnalyticsJobRequest::SetCallAnalyticsJobName ( const char *  value)
inline

The name of the call analytics job. You can't use the string "." or ".." by themselves as the job name. The name must also be unique within an Amazon Web Services account. If you try to create a call analytics job with the same name as a previous call analytics job, you get a ConflictException error.

Definition at line 84 of file StartCallAnalyticsJobRequest.h.

◆ SetChannelDefinitions() [1/2]

void Aws::TranscribeService::Model::StartCallAnalyticsJobRequest::SetChannelDefinitions ( Aws::Vector< ChannelDefinition > &&  value)
inline

When you start a call analytics job, you must pass an array that maps the agent and the customer to specific audio channels. The values you can assign to a channel are 0 and 1. The agent and the customer must each have their own channel. You can't assign more than one channel to an agent or customer.

Definition at line 603 of file StartCallAnalyticsJobRequest.h.

◆ SetChannelDefinitions() [2/2]

void Aws::TranscribeService::Model::StartCallAnalyticsJobRequest::SetChannelDefinitions ( const Aws::Vector< ChannelDefinition > &  value)
inline

When you start a call analytics job, you must pass an array that maps the agent and the customer to specific audio channels. The values you can assign to a channel are 0 and 1. The agent and the customer must each have their own channel. You can't assign more than one channel to an agent or customer.

Definition at line 595 of file StartCallAnalyticsJobRequest.h.

◆ SetDataAccessRoleArn() [1/3]

void Aws::TranscribeService::Model::StartCallAnalyticsJobRequest::SetDataAccessRoleArn ( Aws::String &&  value)
inline

The Amazon Resource Name (ARN) of a role that has access to the S3 bucket that contains your input files. Amazon Transcribe assumes this role to read queued audio files. If you have specified an output S3 bucket for your transcription results, this role should have access to the output bucket as well.

Definition at line 497 of file StartCallAnalyticsJobRequest.h.

◆ SetDataAccessRoleArn() [2/3]

void Aws::TranscribeService::Model::StartCallAnalyticsJobRequest::SetDataAccessRoleArn ( const Aws::String value)
inline

The Amazon Resource Name (ARN) of a role that has access to the S3 bucket that contains your input files. Amazon Transcribe assumes this role to read queued audio files. If you have specified an output S3 bucket for your transcription results, this role should have access to the output bucket as well.

Definition at line 488 of file StartCallAnalyticsJobRequest.h.

◆ SetDataAccessRoleArn() [3/3]

void Aws::TranscribeService::Model::StartCallAnalyticsJobRequest::SetDataAccessRoleArn ( const char *  value)
inline

The Amazon Resource Name (ARN) of a role that has access to the S3 bucket that contains your input files. Amazon Transcribe assumes this role to read queued audio files. If you have specified an output S3 bucket for your transcription results, this role should have access to the output bucket as well.

Definition at line 506 of file StartCallAnalyticsJobRequest.h.

◆ SetMedia() [1/2]

void Aws::TranscribeService::Model::StartCallAnalyticsJobRequest::SetMedia ( const Media value)
inline

Definition at line 121 of file StartCallAnalyticsJobRequest.h.

◆ SetMedia() [2/2]

void Aws::TranscribeService::Model::StartCallAnalyticsJobRequest::SetMedia ( Media &&  value)
inline

Definition at line 124 of file StartCallAnalyticsJobRequest.h.

◆ SetOutputEncryptionKMSKeyId() [1/3]

void Aws::TranscribeService::Model::StartCallAnalyticsJobRequest::SetOutputEncryptionKMSKeyId ( Aws::String &&  value)
inline

The Amazon Resource Name (ARN) of the Amazon Web Services Key Management Service key used to encrypt the output of the call analytics job. The user calling the operation must have permission to use the specified KMS key.

You use either of the following to identify an Amazon Web Services KMS key in the current account:

  • KMS Key ID: "1234abcd-12ab-34cd-56ef-1234567890ab"

  • KMS Key Alias: "alias/ExampleAlias"

You can use either of the following to identify a KMS key in the current account or another account:

  • Amazon Resource Name (ARN) of a KMS key in the current account or another account: "arn:aws:kms:region:account ID:key/1234abcd-12ab-34cd-56ef1234567890ab"

  • ARN of a KMS Key Alias: "arn:aws:kms:region:account ID:alias/ExampleAlias"

If you don't specify an encryption key, the output of the call analytics job 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 in the OutputLocation parameter.

Definition at line 380 of file StartCallAnalyticsJobRequest.h.

◆ SetOutputEncryptionKMSKeyId() [2/3]

void Aws::TranscribeService::Model::StartCallAnalyticsJobRequest::SetOutputEncryptionKMSKeyId ( const Aws::String value)
inline

The Amazon Resource Name (ARN) of the Amazon Web Services Key Management Service key used to encrypt the output of the call analytics job. The user calling the operation must have permission to use the specified KMS key.

You use either of the following to identify an Amazon Web Services KMS key in the current account:

  • KMS Key ID: "1234abcd-12ab-34cd-56ef-1234567890ab"

  • KMS Key Alias: "alias/ExampleAlias"

You can use either of the following to identify a KMS key in the current account or another account:

  • Amazon Resource Name (ARN) of a KMS key in the current account or another account: "arn:aws:kms:region:account ID:key/1234abcd-12ab-34cd-56ef1234567890ab"

  • ARN of a KMS Key Alias: "arn:aws:kms:region:account ID:alias/ExampleAlias"

If you don't specify an encryption key, the output of the call analytics job 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 in the OutputLocation parameter.

Definition at line 360 of file StartCallAnalyticsJobRequest.h.

◆ SetOutputEncryptionKMSKeyId() [3/3]

void Aws::TranscribeService::Model::StartCallAnalyticsJobRequest::SetOutputEncryptionKMSKeyId ( const char *  value)
inline

The Amazon Resource Name (ARN) of the Amazon Web Services Key Management Service key used to encrypt the output of the call analytics job. The user calling the operation must have permission to use the specified KMS key.

You use either of the following to identify an Amazon Web Services KMS key in the current account:

  • KMS Key ID: "1234abcd-12ab-34cd-56ef-1234567890ab"

  • KMS Key Alias: "alias/ExampleAlias"

You can use either of the following to identify a KMS key in the current account or another account:

  • Amazon Resource Name (ARN) of a KMS key in the current account or another account: "arn:aws:kms:region:account ID:key/1234abcd-12ab-34cd-56ef1234567890ab"

  • ARN of a KMS Key Alias: "arn:aws:kms:region:account ID:alias/ExampleAlias"

If you don't specify an encryption key, the output of the call analytics job 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 in the OutputLocation parameter.

Definition at line 400 of file StartCallAnalyticsJobRequest.h.

◆ SetOutputLocation() [1/3]

void Aws::TranscribeService::Model::StartCallAnalyticsJobRequest::SetOutputLocation ( Aws::String &&  value)
inline

The Amazon S3 location where the output of the call analytics job is stored. You can provide the following location types to store the output of call analytics job:

  • s3://DOC-EXAMPLE-BUCKET1

    If you specify a bucket, Amazon Transcribe saves the output of the analytics job as a JSON file at the root level of the bucket.

  • s3://DOC-EXAMPLE-BUCKET1/folder/

    f you specify a path, Amazon Transcribe saves the output of the analytics job as s3://DOC-EXAMPLE-BUCKET1/folder/your-transcription-job-name.json

    If you specify a folder, you must provide a trailing slash.

  • s3://DOC-EXAMPLE-BUCKET1/folder/filename.json

    If you provide a path that has the filename specified, Amazon Transcribe saves the output of the analytics job as s3://DOC-EXAMPLEBUCKET1/folder/filename.json

You can specify an Amazon Web Services Key Management Service (KMS) key to encrypt the output of our analytics job using the OutputEncryptionKMSKeyId parameter. If you don't specify a KMS key, Amazon Transcribe uses the default Amazon S3 key for server-side encryption of the analytics job output that is placed in your S3 bucket.

Definition at line 215 of file StartCallAnalyticsJobRequest.h.

◆ SetOutputLocation() [2/3]

void Aws::TranscribeService::Model::StartCallAnalyticsJobRequest::SetOutputLocation ( const Aws::String value)
inline

The Amazon S3 location where the output of the call analytics job is stored. You can provide the following location types to store the output of call analytics job:

  • s3://DOC-EXAMPLE-BUCKET1

    If you specify a bucket, Amazon Transcribe saves the output of the analytics job as a JSON file at the root level of the bucket.

  • s3://DOC-EXAMPLE-BUCKET1/folder/

    f you specify a path, Amazon Transcribe saves the output of the analytics job as s3://DOC-EXAMPLE-BUCKET1/folder/your-transcription-job-name.json

    If you specify a folder, you must provide a trailing slash.

  • s3://DOC-EXAMPLE-BUCKET1/folder/filename.json

    If you provide a path that has the filename specified, Amazon Transcribe saves the output of the analytics job as s3://DOC-EXAMPLEBUCKET1/folder/filename.json

You can specify an Amazon Web Services Key Management Service (KMS) key to encrypt the output of our analytics job using the OutputEncryptionKMSKeyId parameter. If you don't specify a KMS key, Amazon Transcribe uses the default Amazon S3 key for server-side encryption of the analytics job output that is placed in your S3 bucket.

Definition at line 194 of file StartCallAnalyticsJobRequest.h.

◆ SetOutputLocation() [3/3]

void Aws::TranscribeService::Model::StartCallAnalyticsJobRequest::SetOutputLocation ( const char *  value)
inline

The Amazon S3 location where the output of the call analytics job is stored. You can provide the following location types to store the output of call analytics job:

  • s3://DOC-EXAMPLE-BUCKET1

    If you specify a bucket, Amazon Transcribe saves the output of the analytics job as a JSON file at the root level of the bucket.

  • s3://DOC-EXAMPLE-BUCKET1/folder/

    f you specify a path, Amazon Transcribe saves the output of the analytics job as s3://DOC-EXAMPLE-BUCKET1/folder/your-transcription-job-name.json

    If you specify a folder, you must provide a trailing slash.

  • s3://DOC-EXAMPLE-BUCKET1/folder/filename.json

    If you provide a path that has the filename specified, Amazon Transcribe saves the output of the analytics job as s3://DOC-EXAMPLEBUCKET1/folder/filename.json

You can specify an Amazon Web Services Key Management Service (KMS) key to encrypt the output of our analytics job using the OutputEncryptionKMSKeyId parameter. If you don't specify a KMS key, Amazon Transcribe uses the default Amazon S3 key for server-side encryption of the analytics job output that is placed in your S3 bucket.

Definition at line 236 of file StartCallAnalyticsJobRequest.h.

◆ SetSettings() [1/2]

void Aws::TranscribeService::Model::StartCallAnalyticsJobRequest::SetSettings ( CallAnalyticsJobSettings &&  value)
inline

A Settings object that provides optional settings for a call analytics job.

Definition at line 558 of file StartCallAnalyticsJobRequest.h.

◆ SetSettings() [2/2]

void Aws::TranscribeService::Model::StartCallAnalyticsJobRequest::SetSettings ( const CallAnalyticsJobSettings value)
inline

A Settings object that provides optional settings for a call analytics job.

Definition at line 552 of file StartCallAnalyticsJobRequest.h.

◆ SettingsHasBeenSet()

bool Aws::TranscribeService::Model::StartCallAnalyticsJobRequest::SettingsHasBeenSet ( ) const
inline

A Settings object that provides optional settings for a call analytics job.

Definition at line 546 of file StartCallAnalyticsJobRequest.h.

◆ WithCallAnalyticsJobName() [1/3]

StartCallAnalyticsJobRequest& Aws::TranscribeService::Model::StartCallAnalyticsJobRequest::WithCallAnalyticsJobName ( Aws::String &&  value)
inline

The name of the call analytics job. You can't use the string "." or ".." by themselves as the job name. The name must also be unique within an Amazon Web Services account. If you try to create a call analytics job with the same name as a previous call analytics job, you get a ConflictException error.

Definition at line 102 of file StartCallAnalyticsJobRequest.h.

◆ WithCallAnalyticsJobName() [2/3]

StartCallAnalyticsJobRequest& Aws::TranscribeService::Model::StartCallAnalyticsJobRequest::WithCallAnalyticsJobName ( const Aws::String value)
inline

The name of the call analytics job. You can't use the string "." or ".." by themselves as the job name. The name must also be unique within an Amazon Web Services account. If you try to create a call analytics job with the same name as a previous call analytics job, you get a ConflictException error.

Definition at line 93 of file StartCallAnalyticsJobRequest.h.

◆ WithCallAnalyticsJobName() [3/3]

StartCallAnalyticsJobRequest& Aws::TranscribeService::Model::StartCallAnalyticsJobRequest::WithCallAnalyticsJobName ( const char *  value)
inline

The name of the call analytics job. You can't use the string "." or ".." by themselves as the job name. The name must also be unique within an Amazon Web Services account. If you try to create a call analytics job with the same name as a previous call analytics job, you get a ConflictException error.

Definition at line 111 of file StartCallAnalyticsJobRequest.h.

◆ WithChannelDefinitions() [1/2]

StartCallAnalyticsJobRequest& Aws::TranscribeService::Model::StartCallAnalyticsJobRequest::WithChannelDefinitions ( Aws::Vector< ChannelDefinition > &&  value)
inline

When you start a call analytics job, you must pass an array that maps the agent and the customer to specific audio channels. The values you can assign to a channel are 0 and 1. The agent and the customer must each have their own channel. You can't assign more than one channel to an agent or customer.

Definition at line 619 of file StartCallAnalyticsJobRequest.h.

◆ WithChannelDefinitions() [2/2]

StartCallAnalyticsJobRequest& Aws::TranscribeService::Model::StartCallAnalyticsJobRequest::WithChannelDefinitions ( const Aws::Vector< ChannelDefinition > &  value)
inline

When you start a call analytics job, you must pass an array that maps the agent and the customer to specific audio channels. The values you can assign to a channel are 0 and 1. The agent and the customer must each have their own channel. You can't assign more than one channel to an agent or customer.

Definition at line 611 of file StartCallAnalyticsJobRequest.h.

◆ WithDataAccessRoleArn() [1/3]

StartCallAnalyticsJobRequest& Aws::TranscribeService::Model::StartCallAnalyticsJobRequest::WithDataAccessRoleArn ( Aws::String &&  value)
inline

The Amazon Resource Name (ARN) of a role that has access to the S3 bucket that contains your input files. Amazon Transcribe assumes this role to read queued audio files. If you have specified an output S3 bucket for your transcription results, this role should have access to the output bucket as well.

Definition at line 524 of file StartCallAnalyticsJobRequest.h.

◆ WithDataAccessRoleArn() [2/3]

StartCallAnalyticsJobRequest& Aws::TranscribeService::Model::StartCallAnalyticsJobRequest::WithDataAccessRoleArn ( const Aws::String value)
inline

The Amazon Resource Name (ARN) of a role that has access to the S3 bucket that contains your input files. Amazon Transcribe assumes this role to read queued audio files. If you have specified an output S3 bucket for your transcription results, this role should have access to the output bucket as well.

Definition at line 515 of file StartCallAnalyticsJobRequest.h.

◆ WithDataAccessRoleArn() [3/3]

StartCallAnalyticsJobRequest& Aws::TranscribeService::Model::StartCallAnalyticsJobRequest::WithDataAccessRoleArn ( const char *  value)
inline

The Amazon Resource Name (ARN) of a role that has access to the S3 bucket that contains your input files. Amazon Transcribe assumes this role to read queued audio files. If you have specified an output S3 bucket for your transcription results, this role should have access to the output bucket as well.

Definition at line 533 of file StartCallAnalyticsJobRequest.h.

◆ WithMedia() [1/2]

StartCallAnalyticsJobRequest& Aws::TranscribeService::Model::StartCallAnalyticsJobRequest::WithMedia ( const Media value)
inline

Definition at line 127 of file StartCallAnalyticsJobRequest.h.

◆ WithMedia() [2/2]

StartCallAnalyticsJobRequest& Aws::TranscribeService::Model::StartCallAnalyticsJobRequest::WithMedia ( Media &&  value)
inline

Definition at line 130 of file StartCallAnalyticsJobRequest.h.

◆ WithOutputEncryptionKMSKeyId() [1/3]

StartCallAnalyticsJobRequest& Aws::TranscribeService::Model::StartCallAnalyticsJobRequest::WithOutputEncryptionKMSKeyId ( Aws::String &&  value)
inline

The Amazon Resource Name (ARN) of the Amazon Web Services Key Management Service key used to encrypt the output of the call analytics job. The user calling the operation must have permission to use the specified KMS key.

You use either of the following to identify an Amazon Web Services KMS key in the current account:

  • KMS Key ID: "1234abcd-12ab-34cd-56ef-1234567890ab"

  • KMS Key Alias: "alias/ExampleAlias"

You can use either of the following to identify a KMS key in the current account or another account:

  • Amazon Resource Name (ARN) of a KMS key in the current account or another account: "arn:aws:kms:region:account ID:key/1234abcd-12ab-34cd-56ef1234567890ab"

  • ARN of a KMS Key Alias: "arn:aws:kms:region:account ID:alias/ExampleAlias"

If you don't specify an encryption key, the output of the call analytics job 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 in the OutputLocation parameter.

Definition at line 440 of file StartCallAnalyticsJobRequest.h.

◆ WithOutputEncryptionKMSKeyId() [2/3]

StartCallAnalyticsJobRequest& Aws::TranscribeService::Model::StartCallAnalyticsJobRequest::WithOutputEncryptionKMSKeyId ( const Aws::String value)
inline

The Amazon Resource Name (ARN) of the Amazon Web Services Key Management Service key used to encrypt the output of the call analytics job. The user calling the operation must have permission to use the specified KMS key.

You use either of the following to identify an Amazon Web Services KMS key in the current account:

  • KMS Key ID: "1234abcd-12ab-34cd-56ef-1234567890ab"

  • KMS Key Alias: "alias/ExampleAlias"

You can use either of the following to identify a KMS key in the current account or another account:

  • Amazon Resource Name (ARN) of a KMS key in the current account or another account: "arn:aws:kms:region:account ID:key/1234abcd-12ab-34cd-56ef1234567890ab"

  • ARN of a KMS Key Alias: "arn:aws:kms:region:account ID:alias/ExampleAlias"

If you don't specify an encryption key, the output of the call analytics job 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 in the OutputLocation parameter.

Definition at line 420 of file StartCallAnalyticsJobRequest.h.

◆ WithOutputEncryptionKMSKeyId() [3/3]

StartCallAnalyticsJobRequest& Aws::TranscribeService::Model::StartCallAnalyticsJobRequest::WithOutputEncryptionKMSKeyId ( const char *  value)
inline

The Amazon Resource Name (ARN) of the Amazon Web Services Key Management Service key used to encrypt the output of the call analytics job. The user calling the operation must have permission to use the specified KMS key.

You use either of the following to identify an Amazon Web Services KMS key in the current account:

  • KMS Key ID: "1234abcd-12ab-34cd-56ef-1234567890ab"

  • KMS Key Alias: "alias/ExampleAlias"

You can use either of the following to identify a KMS key in the current account or another account:

  • Amazon Resource Name (ARN) of a KMS key in the current account or another account: "arn:aws:kms:region:account ID:key/1234abcd-12ab-34cd-56ef1234567890ab"

  • ARN of a KMS Key Alias: "arn:aws:kms:region:account ID:alias/ExampleAlias"

If you don't specify an encryption key, the output of the call analytics job 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 in the OutputLocation parameter.

Definition at line 460 of file StartCallAnalyticsJobRequest.h.

◆ WithOutputLocation() [1/3]

StartCallAnalyticsJobRequest& Aws::TranscribeService::Model::StartCallAnalyticsJobRequest::WithOutputLocation ( Aws::String &&  value)
inline

The Amazon S3 location where the output of the call analytics job is stored. You can provide the following location types to store the output of call analytics job:

  • s3://DOC-EXAMPLE-BUCKET1

    If you specify a bucket, Amazon Transcribe saves the output of the analytics job as a JSON file at the root level of the bucket.

  • s3://DOC-EXAMPLE-BUCKET1/folder/

    f you specify a path, Amazon Transcribe saves the output of the analytics job as s3://DOC-EXAMPLE-BUCKET1/folder/your-transcription-job-name.json

    If you specify a folder, you must provide a trailing slash.

  • s3://DOC-EXAMPLE-BUCKET1/folder/filename.json

    If you provide a path that has the filename specified, Amazon Transcribe saves the output of the analytics job as s3://DOC-EXAMPLEBUCKET1/folder/filename.json

You can specify an Amazon Web Services Key Management Service (KMS) key to encrypt the output of our analytics job using the OutputEncryptionKMSKeyId parameter. If you don't specify a KMS key, Amazon Transcribe uses the default Amazon S3 key for server-side encryption of the analytics job output that is placed in your S3 bucket.

Definition at line 278 of file StartCallAnalyticsJobRequest.h.

◆ WithOutputLocation() [2/3]

StartCallAnalyticsJobRequest& Aws::TranscribeService::Model::StartCallAnalyticsJobRequest::WithOutputLocation ( const Aws::String value)
inline

The Amazon S3 location where the output of the call analytics job is stored. You can provide the following location types to store the output of call analytics job:

  • s3://DOC-EXAMPLE-BUCKET1

    If you specify a bucket, Amazon Transcribe saves the output of the analytics job as a JSON file at the root level of the bucket.

  • s3://DOC-EXAMPLE-BUCKET1/folder/

    f you specify a path, Amazon Transcribe saves the output of the analytics job as s3://DOC-EXAMPLE-BUCKET1/folder/your-transcription-job-name.json

    If you specify a folder, you must provide a trailing slash.

  • s3://DOC-EXAMPLE-BUCKET1/folder/filename.json

    If you provide a path that has the filename specified, Amazon Transcribe saves the output of the analytics job as s3://DOC-EXAMPLEBUCKET1/folder/filename.json

You can specify an Amazon Web Services Key Management Service (KMS) key to encrypt the output of our analytics job using the OutputEncryptionKMSKeyId parameter. If you don't specify a KMS key, Amazon Transcribe uses the default Amazon S3 key for server-side encryption of the analytics job output that is placed in your S3 bucket.

Definition at line 257 of file StartCallAnalyticsJobRequest.h.

◆ WithOutputLocation() [3/3]

StartCallAnalyticsJobRequest& Aws::TranscribeService::Model::StartCallAnalyticsJobRequest::WithOutputLocation ( const char *  value)
inline

The Amazon S3 location where the output of the call analytics job is stored. You can provide the following location types to store the output of call analytics job:

  • s3://DOC-EXAMPLE-BUCKET1

    If you specify a bucket, Amazon Transcribe saves the output of the analytics job as a JSON file at the root level of the bucket.

  • s3://DOC-EXAMPLE-BUCKET1/folder/

    f you specify a path, Amazon Transcribe saves the output of the analytics job as s3://DOC-EXAMPLE-BUCKET1/folder/your-transcription-job-name.json

    If you specify a folder, you must provide a trailing slash.

  • s3://DOC-EXAMPLE-BUCKET1/folder/filename.json

    If you provide a path that has the filename specified, Amazon Transcribe saves the output of the analytics job as s3://DOC-EXAMPLEBUCKET1/folder/filename.json

You can specify an Amazon Web Services Key Management Service (KMS) key to encrypt the output of our analytics job using the OutputEncryptionKMSKeyId parameter. If you don't specify a KMS key, Amazon Transcribe uses the default Amazon S3 key for server-side encryption of the analytics job output that is placed in your S3 bucket.

Definition at line 299 of file StartCallAnalyticsJobRequest.h.

◆ WithSettings() [1/2]

StartCallAnalyticsJobRequest& Aws::TranscribeService::Model::StartCallAnalyticsJobRequest::WithSettings ( CallAnalyticsJobSettings &&  value)
inline

A Settings object that provides optional settings for a call analytics job.

Definition at line 570 of file StartCallAnalyticsJobRequest.h.

◆ WithSettings() [2/2]

StartCallAnalyticsJobRequest& Aws::TranscribeService::Model::StartCallAnalyticsJobRequest::WithSettings ( const CallAnalyticsJobSettings value)
inline

A Settings object that provides optional settings for a call analytics job.

Definition at line 564 of file StartCallAnalyticsJobRequest.h.


The documentation for this class was generated from the following file: