Copyright	(c) 2013-2021 Brendan Hay
License	Mozilla Public License, v. 2.0.
Maintainer	Brendan Hay <brendan.g.hay+amazonka@gmail.com>
Stability	auto-generated
Portability	non-portable (GHC extensions)
Safe Haskell	None

Amazonka.Transcribe.StartCallAnalyticsJob

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Starts an asynchronous analytics job that not only transcribes the audio recording of a caller and agent, but also returns additional insights. These insights include how quickly or loudly the caller or agent was speaking. To retrieve additional insights with your analytics jobs, create categories. A category is a way to classify analytics jobs based on attributes, such as a customer's sentiment or a particular phrase being used during the call. For more information, see the operation.

Synopsis

Creating a Request

data StartCallAnalyticsJob Source #

See: newStartCallAnalyticsJob smart constructor.

Constructors

StartCallAnalyticsJob'

Fields

settings :: Maybe CallAnalyticsJobSettings
A Settings object that provides optional settings for a call analytics job.
outputEncryptionKMSKeyId :: Maybe Text
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.
outputLocation :: Maybe Text
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.
channelDefinitions :: Maybe (NonEmpty ChannelDefinition)
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.
callAnalyticsJobName :: Text
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.
media :: Media
dataAccessRoleArn :: Text
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.

Instances

Instances details

Eq StartCallAnalyticsJob Source #
Instance details Defined in Amazonka.Transcribe.StartCallAnalyticsJob Methods (==) :: StartCallAnalyticsJob -> StartCallAnalyticsJob -> Bool # (/=) :: StartCallAnalyticsJob -> StartCallAnalyticsJob -> Bool #
Read StartCallAnalyticsJob Source #
Instance details Defined in Amazonka.Transcribe.StartCallAnalyticsJob Methods readsPrec :: Int -> ReadS StartCallAnalyticsJob # readList :: ReadS [StartCallAnalyticsJob] # readPrec :: ReadPrec StartCallAnalyticsJob # readListPrec :: ReadPrec [StartCallAnalyticsJob] #
Show StartCallAnalyticsJob Source #
Instance details Defined in Amazonka.Transcribe.StartCallAnalyticsJob Methods showsPrec :: Int -> StartCallAnalyticsJob -> ShowS # show :: StartCallAnalyticsJob -> String # showList :: [StartCallAnalyticsJob] -> ShowS #
Generic StartCallAnalyticsJob Source #
Instance details Defined in Amazonka.Transcribe.StartCallAnalyticsJob Associated Types type Rep StartCallAnalyticsJob :: Type -> Type # Methods from :: StartCallAnalyticsJob -> Rep StartCallAnalyticsJob x # to :: Rep StartCallAnalyticsJob x -> StartCallAnalyticsJob #
NFData StartCallAnalyticsJob Source #
Instance details Defined in Amazonka.Transcribe.StartCallAnalyticsJob Methods rnf :: StartCallAnalyticsJob -> () #
Hashable StartCallAnalyticsJob Source #
Instance details Defined in Amazonka.Transcribe.StartCallAnalyticsJob Methods hashWithSalt :: Int -> StartCallAnalyticsJob -> Int # hash :: StartCallAnalyticsJob -> Int #
ToJSON StartCallAnalyticsJob Source #
Instance details Defined in Amazonka.Transcribe.StartCallAnalyticsJob Methods toJSON :: StartCallAnalyticsJob -> Value # toEncoding :: StartCallAnalyticsJob -> Encoding # toJSONList :: [StartCallAnalyticsJob] -> Value # toEncodingList :: [StartCallAnalyticsJob] -> Encoding #
AWSRequest StartCallAnalyticsJob Source #
Instance details Defined in Amazonka.Transcribe.StartCallAnalyticsJob Associated Types type AWSResponse StartCallAnalyticsJob # Methods request :: StartCallAnalyticsJob -> Request StartCallAnalyticsJob # response :: MonadResource m => Logger -> Service -> Proxy StartCallAnalyticsJob -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse StartCallAnalyticsJob))) #
ToHeaders StartCallAnalyticsJob Source #
Instance details Defined in Amazonka.Transcribe.StartCallAnalyticsJob Methods toHeaders :: StartCallAnalyticsJob -> [Header] #
ToPath StartCallAnalyticsJob Source #
Instance details Defined in Amazonka.Transcribe.StartCallAnalyticsJob Methods toPath :: StartCallAnalyticsJob -> ByteString #
ToQuery StartCallAnalyticsJob Source #
Instance details Defined in Amazonka.Transcribe.StartCallAnalyticsJob Methods toQuery :: StartCallAnalyticsJob -> QueryString #
type Rep StartCallAnalyticsJob Source #
Instance details Defined in Amazonka.Transcribe.StartCallAnalyticsJob type Rep StartCallAnalyticsJob = D1 ('MetaData "StartCallAnalyticsJob" "Amazonka.Transcribe.StartCallAnalyticsJob" "libZSservicesZSamazonka-transcribeZSamazonka-transcribe" 'False) (C1 ('MetaCons "StartCallAnalyticsJob'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "settings") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe CallAnalyticsJobSettings)) :: (S1 ('MetaSel ('Just "outputEncryptionKMSKeyId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "outputLocation") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))) :: ((S1 ('MetaSel ('Just "channelDefinitions") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (NonEmpty ChannelDefinition))) :: S1 ('MetaSel ('Just "callAnalyticsJobName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)) :: (S1 ('MetaSel ('Just "media") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Media) :: S1 ('MetaSel ('Just "dataAccessRoleArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))))
type AWSResponse StartCallAnalyticsJob Source #
Instance details Defined in Amazonka.Transcribe.StartCallAnalyticsJob type AWSResponse StartCallAnalyticsJob = StartCallAnalyticsJobResponse

newStartCallAnalyticsJob Source #

Arguments

:: Text	`$sel:callAnalyticsJobName:StartCallAnalyticsJob'`
-> Media	`$sel:media:StartCallAnalyticsJob'`
-> Text	`$sel:dataAccessRoleArn:StartCallAnalyticsJob'`
-> StartCallAnalyticsJob

Create a value of StartCallAnalyticsJob with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:settings:StartCallAnalyticsJob', startCallAnalyticsJob_settings - A Settings object that provides optional settings for a call analytics job.

$sel:outputEncryptionKMSKeyId:StartCallAnalyticsJob', startCallAnalyticsJob_outputEncryptionKMSKeyId - 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.

$sel:outputLocation:StartCallAnalyticsJob', startCallAnalyticsJob_outputLocation - 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.

$sel:channelDefinitions:StartCallAnalyticsJob', startCallAnalyticsJob_channelDefinitions - 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.

$sel:callAnalyticsJobName:StartCallAnalyticsJob', startCallAnalyticsJob_callAnalyticsJobName - 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.

$sel:media:StartCallAnalyticsJob', startCallAnalyticsJob_media - Undocumented member.

$sel:dataAccessRoleArn:StartCallAnalyticsJob', startCallAnalyticsJob_dataAccessRoleArn - 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.

Request Lenses

startCallAnalyticsJob_settings :: Lens' StartCallAnalyticsJob (Maybe CallAnalyticsJobSettings) Source #

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

startCallAnalyticsJob_outputEncryptionKMSKeyId :: Lens' StartCallAnalyticsJob (Maybe Text) Source #

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.

startCallAnalyticsJob_outputLocation :: Lens' StartCallAnalyticsJob (Maybe Text) Source #

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.

startCallAnalyticsJob_channelDefinitions :: Lens' StartCallAnalyticsJob (Maybe (NonEmpty ChannelDefinition)) Source #

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.

startCallAnalyticsJob_callAnalyticsJobName :: Lens' StartCallAnalyticsJob Text Source #

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.

startCallAnalyticsJob_media :: Lens' StartCallAnalyticsJob Media Source #

Undocumented member.

startCallAnalyticsJob_dataAccessRoleArn :: Lens' StartCallAnalyticsJob Text Source #

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.

Destructuring the Response

data StartCallAnalyticsJobResponse Source #

See: newStartCallAnalyticsJobResponse smart constructor.

Constructors

StartCallAnalyticsJobResponse'
Fields callAnalyticsJob :: Maybe CallAnalyticsJob An object containing the details of the asynchronous call analytics job. httpStatus :: Int The response's http status code.

Instances

Instances details

Eq StartCallAnalyticsJobResponse Source #
Instance details Defined in Amazonka.Transcribe.StartCallAnalyticsJob Methods (==) :: StartCallAnalyticsJobResponse -> StartCallAnalyticsJobResponse -> Bool # (/=) :: StartCallAnalyticsJobResponse -> StartCallAnalyticsJobResponse -> Bool #
Read StartCallAnalyticsJobResponse Source #
Instance details Defined in Amazonka.Transcribe.StartCallAnalyticsJob Methods readsPrec :: Int -> ReadS StartCallAnalyticsJobResponse # readList :: ReadS [StartCallAnalyticsJobResponse] # readPrec :: ReadPrec StartCallAnalyticsJobResponse # readListPrec :: ReadPrec [StartCallAnalyticsJobResponse] #
Show StartCallAnalyticsJobResponse Source #
Instance details Defined in Amazonka.Transcribe.StartCallAnalyticsJob Methods showsPrec :: Int -> StartCallAnalyticsJobResponse -> ShowS # show :: StartCallAnalyticsJobResponse -> String # showList :: [StartCallAnalyticsJobResponse] -> ShowS #
Generic StartCallAnalyticsJobResponse Source #
Instance details Defined in Amazonka.Transcribe.StartCallAnalyticsJob Associated Types type Rep StartCallAnalyticsJobResponse :: Type -> Type # Methods from :: StartCallAnalyticsJobResponse -> Rep StartCallAnalyticsJobResponse x # to :: Rep StartCallAnalyticsJobResponse x -> StartCallAnalyticsJobResponse #
NFData StartCallAnalyticsJobResponse Source #
Instance details Defined in Amazonka.Transcribe.StartCallAnalyticsJob Methods rnf :: StartCallAnalyticsJobResponse -> () #
type Rep StartCallAnalyticsJobResponse Source #
Instance details Defined in Amazonka.Transcribe.StartCallAnalyticsJob type Rep StartCallAnalyticsJobResponse = D1 ('MetaData "StartCallAnalyticsJobResponse" "Amazonka.Transcribe.StartCallAnalyticsJob" "libZSservicesZSamazonka-transcribeZSamazonka-transcribe" 'False) (C1 ('MetaCons "StartCallAnalyticsJobResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "callAnalyticsJob") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe CallAnalyticsJob)) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int)))

newStartCallAnalyticsJobResponse Source #

Arguments

:: Int	`$sel:httpStatus:StartCallAnalyticsJobResponse'`
-> StartCallAnalyticsJobResponse

Create a value of StartCallAnalyticsJobResponse with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:callAnalyticsJob:StartCallAnalyticsJobResponse', startCallAnalyticsJobResponse_callAnalyticsJob - An object containing the details of the asynchronous call analytics job.

$sel:httpStatus:StartCallAnalyticsJobResponse', startCallAnalyticsJobResponse_httpStatus - The response's http status code.

Response Lenses

startCallAnalyticsJobResponse_callAnalyticsJob :: Lens' StartCallAnalyticsJobResponse (Maybe CallAnalyticsJob) Source #

An object containing the details of the asynchronous call analytics job.

startCallAnalyticsJobResponse_httpStatus :: Lens' StartCallAnalyticsJobResponse Int Source #

The response's http status code.