| Copyright | (c) 2013-2023 Brendan Hay |
|---|---|
| License | Mozilla Public License, v. 2.0. |
| Maintainer | Brendan Hay |
| Stability | auto-generated |
| Portability | non-portable (GHC extensions) |
| Safe Haskell | Safe-Inferred |
| Language | Haskell2010 |
Amazonka.Transcribe.StartCallAnalyticsJob
Description
Transcribes the audio from a customer service call and applies any additional Request Parameters you choose to include in your request.
In addition to many standard transcription features, Call Analytics provides you with call characteristics, call summarization, speaker sentiment, and optional redaction of your text transcript and your audio file. You can also apply custom categories to flag specified conditions. To learn more about these features and insights, refer to Analyzing call center audio with Call Analytics.
If you want to apply categories to your Call Analytics job, you must create them before submitting your job request. Categories cannot be retroactively applied to a job. To create a new category, use the operation. To learn more about Call Analytics categories, see Creating categories for batch transcriptions and Creating categories for streaming transcriptions.
To make a StartCallAnalyticsJob request, you must first upload your
media file into an Amazon S3 bucket; you can then specify the Amazon S3
location of the file using the Media parameter.
You must include the following parameters in your
StartCallAnalyticsJob request:
region: The Amazon Web Services Region where you are making your request. For a list of Amazon Web Services Regions supported with Amazon Transcribe, refer to Amazon Transcribe endpoints and quotas.CallAnalyticsJobName: A custom name that you create for your transcription job that's unique within your Amazon Web Services account.DataAccessRoleArn: The Amazon Resource Name (ARN) of an IAM role that has permissions to access the Amazon S3 bucket that contains your input files.Media(MediaFileUriorRedactedMediaFileUri): The Amazon S3 location of your media file.
With Call Analytics, you can redact the audio contained in your media
file by including RedactedMediaFileUri, instead of MediaFileUri, to
specify the location of your input audio. If you choose to redact your
audio, you can find your redacted media at the location specified in the
RedactedMediaFileUri field of your response.
Synopsis
- data StartCallAnalyticsJob = StartCallAnalyticsJob' {}
- newStartCallAnalyticsJob :: Text -> Media -> StartCallAnalyticsJob
- startCallAnalyticsJob_channelDefinitions :: Lens' StartCallAnalyticsJob (Maybe (NonEmpty ChannelDefinition))
- startCallAnalyticsJob_dataAccessRoleArn :: Lens' StartCallAnalyticsJob (Maybe Text)
- startCallAnalyticsJob_outputEncryptionKMSKeyId :: Lens' StartCallAnalyticsJob (Maybe Text)
- startCallAnalyticsJob_outputLocation :: Lens' StartCallAnalyticsJob (Maybe Text)
- startCallAnalyticsJob_settings :: Lens' StartCallAnalyticsJob (Maybe CallAnalyticsJobSettings)
- startCallAnalyticsJob_callAnalyticsJobName :: Lens' StartCallAnalyticsJob Text
- startCallAnalyticsJob_media :: Lens' StartCallAnalyticsJob Media
- data StartCallAnalyticsJobResponse = StartCallAnalyticsJobResponse' {}
- newStartCallAnalyticsJobResponse :: Int -> StartCallAnalyticsJobResponse
- startCallAnalyticsJobResponse_callAnalyticsJob :: Lens' StartCallAnalyticsJobResponse (Maybe CallAnalyticsJob)
- startCallAnalyticsJobResponse_httpStatus :: Lens' StartCallAnalyticsJobResponse Int
Creating a Request
data StartCallAnalyticsJob Source #
See: newStartCallAnalyticsJob smart constructor.
Constructors
| StartCallAnalyticsJob' | |
Fields
| |
Instances
newStartCallAnalyticsJob Source #
Arguments
| :: Text | |
| -> Media | |
| -> 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:
StartCallAnalyticsJob, startCallAnalyticsJob_channelDefinitions - Makes it possible to specify which speaker is on which channel. For
example, if your agent is the first participant to speak, you would set
ChannelId to 0 (to indicate the first channel) and ParticipantRole
to AGENT (to indicate that it's the agent speaking).
StartCallAnalyticsJob, startCallAnalyticsJob_dataAccessRoleArn - The Amazon Resource Name (ARN) of an IAM role that has permissions to
access the Amazon S3 bucket that contains your input files. If the role
that you specify doesn’t have the appropriate permissions to access the
specified Amazon S3 location, your request fails.
IAM role ARNs have the format
arn:partition:iam::account:role/role-name-with-path. For example:
arn:aws:iam::111122223333:role/Admin.
For more information, see IAM ARNs.
$sel:outputEncryptionKMSKeyId:StartCallAnalyticsJob', startCallAnalyticsJob_outputEncryptionKMSKeyId - The KMS key you want to use to encrypt your Call Analytics output.
If using a key located in the current Amazon Web Services account, you can specify your KMS key in one of four ways:
- Use the KMS key ID itself. For example,
1234abcd-12ab-34cd-56ef-1234567890ab. - Use an alias for the KMS key ID. For example,
alias/ExampleAlias. - Use the Amazon Resource Name (ARN) for the KMS key ID. For example,
arn:aws:kms:region:account-ID:key/1234abcd-12ab-34cd-56ef-1234567890ab. - Use the ARN for the KMS key alias. For example,
arn:aws:kms:region:account-ID:alias/ExampleAlias.
If using a key located in a different Amazon Web Services account than the current Amazon Web Services account, you can specify your KMS key in one of two ways:
- Use the ARN for the KMS key ID. For example,
arn:aws:kms:region:account-ID:key/1234abcd-12ab-34cd-56ef-1234567890ab. - Use the ARN for the KMS key alias. For example,
arn:aws:kms:region:account-ID:alias/ExampleAlias.
If you don't specify an encryption key, your output is encrypted with the default Amazon S3 key (SSE-S3).
If you specify a KMS key to encrypt your output, you must also specify
an output location using the OutputLocation parameter.
Note that the user making the request must have permission to use the specified KMS key.
$sel:outputLocation:StartCallAnalyticsJob', startCallAnalyticsJob_outputLocation - The Amazon S3 location where you want your Call Analytics transcription
output stored. You can use any of the following formats to specify the
output location:
- s3://DOC-EXAMPLE-BUCKET
- s3://DOC-EXAMPLE-BUCKET/my-output-folder/
- s3://DOC-EXAMPLE-BUCKET/my-output-folder/my-call-analytics-job.json
Unless you specify a file name (option 3), the name of your output file
has a default value that matches the name you specified for your
transcription job using the CallAnalyticsJobName parameter.
You can specify a KMS key to encrypt your output using the
OutputEncryptionKMSKeyId parameter. If you don't specify a KMS key,
Amazon Transcribe uses the default Amazon S3 key for server-side
encryption.
If you don't specify OutputLocation, your transcript is placed in a
service-managed Amazon S3 bucket and you are provided with a URI to
access your transcript.
StartCallAnalyticsJob, startCallAnalyticsJob_settings - Specify additional optional settings in your request, including content
redaction; allows you to apply custom language models, vocabulary
filters, and custom vocabularies to your Call Analytics job.
StartCallAnalyticsJob, startCallAnalyticsJob_callAnalyticsJobName - A unique name, chosen by you, for your Call Analytics job.
This name is case sensitive, cannot contain spaces, and must be unique
within an Amazon Web Services account. If you try to create a new job
with the same name as an existing job, you get a ConflictException
error.
StartCallAnalyticsJob, startCallAnalyticsJob_media - Describes the Amazon S3 location of the media file you want to use in
your Call Analytics request.
Request Lenses
startCallAnalyticsJob_channelDefinitions :: Lens' StartCallAnalyticsJob (Maybe (NonEmpty ChannelDefinition)) Source #
Makes it possible to specify which speaker is on which channel. For
example, if your agent is the first participant to speak, you would set
ChannelId to 0 (to indicate the first channel) and ParticipantRole
to AGENT (to indicate that it's the agent speaking).
startCallAnalyticsJob_dataAccessRoleArn :: Lens' StartCallAnalyticsJob (Maybe Text) Source #
The Amazon Resource Name (ARN) of an IAM role that has permissions to access the Amazon S3 bucket that contains your input files. If the role that you specify doesn’t have the appropriate permissions to access the specified Amazon S3 location, your request fails.
IAM role ARNs have the format
arn:partition:iam::account:role/role-name-with-path. For example:
arn:aws:iam::111122223333:role/Admin.
For more information, see IAM ARNs.
startCallAnalyticsJob_outputEncryptionKMSKeyId :: Lens' StartCallAnalyticsJob (Maybe Text) Source #
The KMS key you want to use to encrypt your Call Analytics output.
If using a key located in the current Amazon Web Services account, you can specify your KMS key in one of four ways:
- Use the KMS key ID itself. For example,
1234abcd-12ab-34cd-56ef-1234567890ab. - Use an alias for the KMS key ID. For example,
alias/ExampleAlias. - Use the Amazon Resource Name (ARN) for the KMS key ID. For example,
arn:aws:kms:region:account-ID:key/1234abcd-12ab-34cd-56ef-1234567890ab. - Use the ARN for the KMS key alias. For example,
arn:aws:kms:region:account-ID:alias/ExampleAlias.
If using a key located in a different Amazon Web Services account than the current Amazon Web Services account, you can specify your KMS key in one of two ways:
- Use the ARN for the KMS key ID. For example,
arn:aws:kms:region:account-ID:key/1234abcd-12ab-34cd-56ef-1234567890ab. - Use the ARN for the KMS key alias. For example,
arn:aws:kms:region:account-ID:alias/ExampleAlias.
If you don't specify an encryption key, your output is encrypted with the default Amazon S3 key (SSE-S3).
If you specify a KMS key to encrypt your output, you must also specify
an output location using the OutputLocation parameter.
Note that the user making the request must have permission to use the specified KMS key.
startCallAnalyticsJob_outputLocation :: Lens' StartCallAnalyticsJob (Maybe Text) Source #
The Amazon S3 location where you want your Call Analytics transcription output stored. You can use any of the following formats to specify the output location:
- s3://DOC-EXAMPLE-BUCKET
- s3://DOC-EXAMPLE-BUCKET/my-output-folder/
- s3://DOC-EXAMPLE-BUCKET/my-output-folder/my-call-analytics-job.json
Unless you specify a file name (option 3), the name of your output file
has a default value that matches the name you specified for your
transcription job using the CallAnalyticsJobName parameter.
You can specify a KMS key to encrypt your output using the
OutputEncryptionKMSKeyId parameter. If you don't specify a KMS key,
Amazon Transcribe uses the default Amazon S3 key for server-side
encryption.
If you don't specify OutputLocation, your transcript is placed in a
service-managed Amazon S3 bucket and you are provided with a URI to
access your transcript.
startCallAnalyticsJob_settings :: Lens' StartCallAnalyticsJob (Maybe CallAnalyticsJobSettings) Source #
Specify additional optional settings in your request, including content redaction; allows you to apply custom language models, vocabulary filters, and custom vocabularies to your Call Analytics job.
startCallAnalyticsJob_callAnalyticsJobName :: Lens' StartCallAnalyticsJob Text Source #
A unique name, chosen by you, for your Call Analytics job.
This name is case sensitive, cannot contain spaces, and must be unique
within an Amazon Web Services account. If you try to create a new job
with the same name as an existing job, you get a ConflictException
error.
startCallAnalyticsJob_media :: Lens' StartCallAnalyticsJob Media Source #
Describes the Amazon S3 location of the media file you want to use in your Call Analytics request.
Destructuring the Response
data StartCallAnalyticsJobResponse Source #
See: newStartCallAnalyticsJobResponse smart constructor.
Constructors
| StartCallAnalyticsJobResponse' | |
Fields
| |
Instances
newStartCallAnalyticsJobResponse Source #
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 - Provides detailed information about the current Call Analytics job,
including job status and, if applicable, failure reason.
$sel:httpStatus:StartCallAnalyticsJobResponse', startCallAnalyticsJobResponse_httpStatus - The response's http status code.
Response Lenses
startCallAnalyticsJobResponse_callAnalyticsJob :: Lens' StartCallAnalyticsJobResponse (Maybe CallAnalyticsJob) Source #
Provides detailed information about the current Call Analytics job, including job status and, if applicable, failure reason.
startCallAnalyticsJobResponse_httpStatus :: Lens' StartCallAnalyticsJobResponse Int Source #
The response's http status code.