Class: Aws::TranscribeService::Types::StartCallAnalyticsJobRequest
- Inherits:
-
Struct
- Object
- Struct
- Aws::TranscribeService::Types::StartCallAnalyticsJobRequest
- Defined in:
- gems/aws-sdk-transcribeservice/lib/aws-sdk-transcribeservice/types.rb
Overview
Constant Summary collapse
- SENSITIVE =
[]
Instance Attribute Summary collapse
-
#call_analytics_job_name ⇒ String
A unique name, chosen by you, for your Call Analytics job.
-
#channel_definitions ⇒ Array<Types::ChannelDefinition>
Makes it possible to specify which speaker is on which channel.
-
#data_access_role_arn ⇒ String
The Amazon Resource Name (ARN) of an IAM role that has permissions to access the Amazon S3 bucket that contains your input files.
-
#media ⇒ Types::Media
Describes the Amazon S3 location of the media file you want to use in your Call Analytics request.
-
#output_encryption_kms_key_id ⇒ String
The KMS key you want to use to encrypt your Call Analytics output.
-
#output_location ⇒ String
The Amazon S3 location where you want your Call Analytics transcription output stored.
-
#settings ⇒ Types::CallAnalyticsJobSettings
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.
Instance Attribute Details
#call_analytics_job_name ⇒ String
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.
3953 3954 3955 3956 3957 3958 3959 3960 3961 3962 3963 |
# File 'gems/aws-sdk-transcribeservice/lib/aws-sdk-transcribeservice/types.rb', line 3953 class StartCallAnalyticsJobRequest < Struct.new( :call_analytics_job_name, :media, :output_location, :output_encryption_kms_key_id, :data_access_role_arn, :settings, :channel_definitions) SENSITIVE = [] include Aws::Structure end |
#channel_definitions ⇒ Array<Types::ChannelDefinition>
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).
3953 3954 3955 3956 3957 3958 3959 3960 3961 3962 3963 |
# File 'gems/aws-sdk-transcribeservice/lib/aws-sdk-transcribeservice/types.rb', line 3953 class StartCallAnalyticsJobRequest < Struct.new( :call_analytics_job_name, :media, :output_location, :output_encryption_kms_key_id, :data_access_role_arn, :settings, :channel_definitions) SENSITIVE = [] include Aws::Structure end |
#data_access_role_arn ⇒ String
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.
3953 3954 3955 3956 3957 3958 3959 3960 3961 3962 3963 |
# File 'gems/aws-sdk-transcribeservice/lib/aws-sdk-transcribeservice/types.rb', line 3953 class StartCallAnalyticsJobRequest < Struct.new( :call_analytics_job_name, :media, :output_location, :output_encryption_kms_key_id, :data_access_role_arn, :settings, :channel_definitions) SENSITIVE = [] include Aws::Structure end |
#media ⇒ Types::Media
Describes the Amazon S3 location of the media file you want to use in your Call Analytics request.
3953 3954 3955 3956 3957 3958 3959 3960 3961 3962 3963 |
# File 'gems/aws-sdk-transcribeservice/lib/aws-sdk-transcribeservice/types.rb', line 3953 class StartCallAnalyticsJobRequest < Struct.new( :call_analytics_job_name, :media, :output_location, :output_encryption_kms_key_id, :data_access_role_arn, :settings, :channel_definitions) SENSITIVE = [] include Aws::Structure end |
#output_encryption_kms_key_id ⇒ String
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 do not 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 role making the request must have permission to use the specified KMS key.
3953 3954 3955 3956 3957 3958 3959 3960 3961 3962 3963 |
# File 'gems/aws-sdk-transcribeservice/lib/aws-sdk-transcribeservice/types.rb', line 3953 class StartCallAnalyticsJobRequest < Struct.new( :call_analytics_job_name, :media, :output_location, :output_encryption_kms_key_id, :data_access_role_arn, :settings, :channel_definitions) SENSITIVE = [] include Aws::Structure end |
#output_location ⇒ String
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 do not specify a KMS
key, Amazon Transcribe uses the default Amazon S3 key for
server-side encryption.
If you do not specify OutputLocation
, your transcript is placed in
a service-managed Amazon S3 bucket and you are provided with a URI
to access your transcript.
3953 3954 3955 3956 3957 3958 3959 3960 3961 3962 3963 |
# File 'gems/aws-sdk-transcribeservice/lib/aws-sdk-transcribeservice/types.rb', line 3953 class StartCallAnalyticsJobRequest < Struct.new( :call_analytics_job_name, :media, :output_location, :output_encryption_kms_key_id, :data_access_role_arn, :settings, :channel_definitions) SENSITIVE = [] include Aws::Structure end |
#settings ⇒ Types::CallAnalyticsJobSettings
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.
3953 3954 3955 3956 3957 3958 3959 3960 3961 3962 3963 |
# File 'gems/aws-sdk-transcribeservice/lib/aws-sdk-transcribeservice/types.rb', line 3953 class StartCallAnalyticsJobRequest < Struct.new( :call_analytics_job_name, :media, :output_location, :output_encryption_kms_key_id, :data_access_role_arn, :settings, :channel_definitions) SENSITIVE = [] include Aws::Structure end |