aws-sdk-transcribeservice 1.57.0 → 1.61.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -10,6 +10,67 @@
10
10
  module Aws::TranscribeService
11
11
  module Types
12
12
 
13
+ # A time range, set in seconds, between two points in the call.
14
+ #
15
+ # @note When making an API call, you may pass AbsoluteTimeRange
16
+ # data as a hash:
17
+ #
18
+ # {
19
+ # start_time: 1,
20
+ # end_time: 1,
21
+ # first: 1,
22
+ # last: 1,
23
+ # }
24
+ #
25
+ # @!attribute [rw] start_time
26
+ # A value that indicates the beginning of the time range in seconds.
27
+ # To set absolute time range, you must specify a start time and an end
28
+ # time. For example, if you specify the following values:
29
+ #
30
+ # * StartTime - 10000
31
+ #
32
+ # * Endtime - 50000
33
+ #
34
+ # The time range is set between 10,000 milliseconds and 50,000
35
+ # milliseconds into the call.
36
+ # @return [Integer]
37
+ #
38
+ # @!attribute [rw] end_time
39
+ # A value that indicates the end of the time range in milliseconds. To
40
+ # set absolute time range, you must specify a start time and an end
41
+ # time. For example, if you specify the following values:
42
+ #
43
+ # * StartTime - 10000
44
+ #
45
+ # * Endtime - 50000
46
+ #
47
+ # The time range is set between 10,000 milliseconds and 50,000
48
+ # milliseconds into the call.
49
+ # @return [Integer]
50
+ #
51
+ # @!attribute [rw] first
52
+ # A time range from the beginning of the call to the value that
53
+ # you've specified. For example, if you specify 100000, the time
54
+ # range is set to the first 100,000 milliseconds of the call.
55
+ # @return [Integer]
56
+ #
57
+ # @!attribute [rw] last
58
+ # A time range from the value that you've specified to the end of the
59
+ # call. For example, if you specify 100000, the time range is set to
60
+ # the last 100,000 milliseconds of the call.
61
+ # @return [Integer]
62
+ #
63
+ # @see http://docs.aws.amazon.com/goto/WebAPI/transcribe-2017-10-26/AbsoluteTimeRange AWS API Documentation
64
+ #
65
+ class AbsoluteTimeRange < Struct.new(
66
+ :start_time,
67
+ :end_time,
68
+ :first,
69
+ :last)
70
+ SENSITIVE = []
71
+ include Aws::Structure
72
+ end
73
+
13
74
  # Your request didn't pass one or more validation tests. For example,
14
75
  # if the entity that you're trying to delete doesn't exist or if it is
15
76
  # in a non-terminal state (for example, it's "in progress"). See the
@@ -26,6 +87,334 @@ module Aws::TranscribeService
26
87
  include Aws::Structure
27
88
  end
28
89
 
90
+ # Describes an asynchronous analytics job that was created with the
91
+ # `StartAnalyticsJob` operation.
92
+ #
93
+ # @!attribute [rw] call_analytics_job_name
94
+ # The name of the call analytics job.
95
+ # @return [String]
96
+ #
97
+ # @!attribute [rw] call_analytics_job_status
98
+ # The status of the analytics job.
99
+ # @return [String]
100
+ #
101
+ # @!attribute [rw] language_code
102
+ # If you know the language spoken between the customer and the agent,
103
+ # specify a language code for this field.
104
+ #
105
+ # If you don't know the language, you can leave this field blank, and
106
+ # Amazon Transcribe will use machine learning to automatically
107
+ # identify the language. To improve the accuracy of language
108
+ # identification, you can provide an array containing the possible
109
+ # language codes for the language spoken in your audio. Refer to
110
+ # [Supported languages and language-specific features][1] for
111
+ # additional information.
112
+ #
113
+ #
114
+ #
115
+ # [1]: https://docs.aws.amazon.com/transcribe/latest/dg/how-it-works.html
116
+ # @return [String]
117
+ #
118
+ # @!attribute [rw] media_sample_rate_hertz
119
+ # The sample rate, in Hertz, of the audio.
120
+ # @return [Integer]
121
+ #
122
+ # @!attribute [rw] media_format
123
+ # The format of the input audio file. Note: for call analytics jobs,
124
+ # only the following media formats are supported: MP3, MP4, WAV, FLAC,
125
+ # OGG, and WebM.
126
+ # @return [String]
127
+ #
128
+ # @!attribute [rw] media
129
+ # Describes the input media file in a transcription request.
130
+ # @return [Types::Media]
131
+ #
132
+ # @!attribute [rw] transcript
133
+ # Identifies the location of a transcription.
134
+ # @return [Types::Transcript]
135
+ #
136
+ # @!attribute [rw] start_time
137
+ # A timestamp that shows when the analytics job started processing.
138
+ # @return [Time]
139
+ #
140
+ # @!attribute [rw] creation_time
141
+ # A timestamp that shows when the analytics job was created.
142
+ # @return [Time]
143
+ #
144
+ # @!attribute [rw] completion_time
145
+ # A timestamp that shows when the analytics job was completed.
146
+ # @return [Time]
147
+ #
148
+ # @!attribute [rw] failure_reason
149
+ # If the `AnalyticsJobStatus` is `FAILED`, this field contains
150
+ # information about why the job failed.
151
+ #
152
+ # The `FailureReason` field can contain one of the following values:
153
+ #
154
+ # * `Unsupported media format`\: The media format specified in the
155
+ # `MediaFormat` field of the request isn't valid. See the
156
+ # description of the `MediaFormat` field for a list of valid values.
157
+ #
158
+ # * `The media format provided does not match the detected media
159
+ # format`\: The media format of the audio file doesn't match the
160
+ # format specified in the `MediaFormat` field in the request. Check
161
+ # the media format of your media file and make sure the two values
162
+ # match.
163
+ #
164
+ # * `Invalid sample rate for audio file`\: The sample rate specified
165
+ # in the `MediaSampleRateHertz` of the request isn't valid. The
166
+ # sample rate must be between 8,000 and 48,000 Hertz.
167
+ #
168
+ # * `The sample rate provided does not match the detected sample
169
+ # rate`\: The sample rate in the audio file doesn't match the
170
+ # sample rate specified in the `MediaSampleRateHertz` field in the
171
+ # request. Check the sample rate of your media file and make sure
172
+ # that the two values match.
173
+ #
174
+ # * `Invalid file size: file size too large`\: The size of your audio
175
+ # file is larger than what Amazon Transcribe Medical can process.
176
+ # For more information, see *Guidelines and Quotas* in the Amazon
177
+ # Transcribe Medical Guide.
178
+ #
179
+ # * `Invalid number of channels: number of channels too large`\: Your
180
+ # audio contains more channels than Amazon Transcribe Medical is
181
+ # configured to process. To request additional channels, see Amazon
182
+ # Transcribe Medical Endpoints and Quotas in the [Amazon Web
183
+ # Services General Reference][1].
184
+ #
185
+ #
186
+ #
187
+ # [1]: https://docs.aws.amazon.com/general/latest/gr/Welcome.html
188
+ # @return [String]
189
+ #
190
+ # @!attribute [rw] data_access_role_arn
191
+ # The Amazon Resource Number (ARN) that you use to get access to the
192
+ # analytics job.
193
+ # @return [String]
194
+ #
195
+ # @!attribute [rw] identified_language_score
196
+ # A value between zero and one that Amazon Transcribe assigned to the
197
+ # language that it identified in the source audio. This value appears
198
+ # only when you don't provide a single language code. Larger values
199
+ # indicate that Amazon Transcribe has higher confidence in the
200
+ # language that it identified
201
+ # @return [Float]
202
+ #
203
+ # @!attribute [rw] settings
204
+ # Provides information about the settings used to run a transcription
205
+ # job.
206
+ # @return [Types::CallAnalyticsJobSettings]
207
+ #
208
+ # @!attribute [rw] channel_definitions
209
+ # Shows numeric values to indicate the channel assigned to the
210
+ # agent's audio and the channel assigned to the customer's audio.
211
+ # @return [Array<Types::ChannelDefinition>]
212
+ #
213
+ # @see http://docs.aws.amazon.com/goto/WebAPI/transcribe-2017-10-26/CallAnalyticsJob AWS API Documentation
214
+ #
215
+ class CallAnalyticsJob < Struct.new(
216
+ :call_analytics_job_name,
217
+ :call_analytics_job_status,
218
+ :language_code,
219
+ :media_sample_rate_hertz,
220
+ :media_format,
221
+ :media,
222
+ :transcript,
223
+ :start_time,
224
+ :creation_time,
225
+ :completion_time,
226
+ :failure_reason,
227
+ :data_access_role_arn,
228
+ :identified_language_score,
229
+ :settings,
230
+ :channel_definitions)
231
+ SENSITIVE = []
232
+ include Aws::Structure
233
+ end
234
+
235
+ # Provides optional settings for the `CallAnalyticsJob` operation.
236
+ #
237
+ # @note When making an API call, you may pass CallAnalyticsJobSettings
238
+ # data as a hash:
239
+ #
240
+ # {
241
+ # vocabulary_name: "VocabularyName",
242
+ # vocabulary_filter_name: "VocabularyFilterName",
243
+ # vocabulary_filter_method: "remove", # accepts remove, mask, tag
244
+ # language_model_name: "ModelName",
245
+ # content_redaction: {
246
+ # redaction_type: "PII", # required, accepts PII
247
+ # redaction_output: "redacted", # required, accepts redacted, redacted_and_unredacted
248
+ # },
249
+ # language_options: ["af-ZA"], # accepts af-ZA, ar-AE, ar-SA, cy-GB, da-DK, de-CH, de-DE, en-AB, en-AU, en-GB, en-IE, en-IN, en-US, en-WL, es-ES, es-US, fa-IR, fr-CA, fr-FR, ga-IE, gd-GB, he-IL, hi-IN, id-ID, it-IT, ja-JP, ko-KR, ms-MY, nl-NL, pt-BR, pt-PT, ru-RU, ta-IN, te-IN, tr-TR, zh-CN, zh-TW, th-TH, en-ZA, en-NZ
250
+ # }
251
+ #
252
+ # @!attribute [rw] vocabulary_name
253
+ # The name of a vocabulary to use when processing the call analytics
254
+ # job.
255
+ # @return [String]
256
+ #
257
+ # @!attribute [rw] vocabulary_filter_name
258
+ # The name of the vocabulary filter to use when running a call
259
+ # analytics job. The filter that you specify must have the same
260
+ # language code as the analytics job.
261
+ # @return [String]
262
+ #
263
+ # @!attribute [rw] vocabulary_filter_method
264
+ # Set to mask to remove filtered text from the transcript and replace
265
+ # it with three asterisks ("***") as placeholder text. Set to
266
+ # `remove` to remove filtered text from the transcript without using
267
+ # placeholder text. Set to `tag` to mark the word in the transcription
268
+ # output that matches the vocabulary filter. When you set the filter
269
+ # method to `tag`, the words matching your vocabulary filter are not
270
+ # masked or removed.
271
+ # @return [String]
272
+ #
273
+ # @!attribute [rw] language_model_name
274
+ # The structure used to describe a custom language model.
275
+ # @return [String]
276
+ #
277
+ # @!attribute [rw] content_redaction
278
+ # Settings for content redaction within a transcription job.
279
+ # @return [Types::ContentRedaction]
280
+ #
281
+ # @!attribute [rw] language_options
282
+ # When you run a call analytics job, you can specify the language
283
+ # spoken in the audio, or you can have Amazon Transcribe identify the
284
+ # language for you.
285
+ #
286
+ # To specify a language, specify an array with one language code. If
287
+ # you don't know the language, you can leave this field blank and
288
+ # Amazon Transcribe will use machine learning to identify the language
289
+ # for you. To improve the ability of Amazon Transcribe to correctly
290
+ # identify the language, you can provide an array of the languages
291
+ # that can be present in the audio. Refer to [Supported languages and
292
+ # language-specific features][1] for additional information.
293
+ #
294
+ #
295
+ #
296
+ # [1]: https://docs.aws.amazon.com/transcribe/latest/dg/how-it-works.html
297
+ # @return [Array<String>]
298
+ #
299
+ # @see http://docs.aws.amazon.com/goto/WebAPI/transcribe-2017-10-26/CallAnalyticsJobSettings AWS API Documentation
300
+ #
301
+ class CallAnalyticsJobSettings < Struct.new(
302
+ :vocabulary_name,
303
+ :vocabulary_filter_name,
304
+ :vocabulary_filter_method,
305
+ :language_model_name,
306
+ :content_redaction,
307
+ :language_options)
308
+ SENSITIVE = []
309
+ include Aws::Structure
310
+ end
311
+
312
+ # Provides summary information about a call analytics job.
313
+ #
314
+ # @!attribute [rw] call_analytics_job_name
315
+ # The name of the call analytics job.
316
+ # @return [String]
317
+ #
318
+ # @!attribute [rw] creation_time
319
+ # A timestamp that shows when the call analytics job was created.
320
+ # @return [Time]
321
+ #
322
+ # @!attribute [rw] start_time
323
+ # A timestamp that shows when the job began processing.
324
+ # @return [Time]
325
+ #
326
+ # @!attribute [rw] completion_time
327
+ # A timestamp that shows when the job was completed.
328
+ # @return [Time]
329
+ #
330
+ # @!attribute [rw] language_code
331
+ # The language of the transcript in the source audio file.
332
+ # @return [String]
333
+ #
334
+ # @!attribute [rw] call_analytics_job_status
335
+ # The status of the call analytics job.
336
+ # @return [String]
337
+ #
338
+ # @!attribute [rw] failure_reason
339
+ # If the `CallAnalyticsJobStatus` is `FAILED`, a description of the
340
+ # error.
341
+ # @return [String]
342
+ #
343
+ # @see http://docs.aws.amazon.com/goto/WebAPI/transcribe-2017-10-26/CallAnalyticsJobSummary AWS API Documentation
344
+ #
345
+ class CallAnalyticsJobSummary < Struct.new(
346
+ :call_analytics_job_name,
347
+ :creation_time,
348
+ :start_time,
349
+ :completion_time,
350
+ :language_code,
351
+ :call_analytics_job_status,
352
+ :failure_reason)
353
+ SENSITIVE = []
354
+ include Aws::Structure
355
+ end
356
+
357
+ # An object that contains the rules and additional information about a
358
+ # call analytics category.
359
+ #
360
+ # @!attribute [rw] category_name
361
+ # The name of the call analytics category.
362
+ # @return [String]
363
+ #
364
+ # @!attribute [rw] rules
365
+ # The rules used to create a call analytics category.
366
+ # @return [Array<Types::Rule>]
367
+ #
368
+ # @!attribute [rw] create_time
369
+ # A timestamp that shows when the call analytics category was created.
370
+ # @return [Time]
371
+ #
372
+ # @!attribute [rw] last_update_time
373
+ # A timestamp that shows when the call analytics category was most
374
+ # recently updated.
375
+ # @return [Time]
376
+ #
377
+ # @see http://docs.aws.amazon.com/goto/WebAPI/transcribe-2017-10-26/CategoryProperties AWS API Documentation
378
+ #
379
+ class CategoryProperties < Struct.new(
380
+ :category_name,
381
+ :rules,
382
+ :create_time,
383
+ :last_update_time)
384
+ SENSITIVE = []
385
+ include Aws::Structure
386
+ end
387
+
388
+ # For a call analytics job, an object that indicates the audio channel
389
+ # that belongs to the agent and the audio channel that belongs to the
390
+ # customer.
391
+ #
392
+ # @note When making an API call, you may pass ChannelDefinition
393
+ # data as a hash:
394
+ #
395
+ # {
396
+ # channel_id: 1,
397
+ # participant_role: "AGENT", # accepts AGENT, CUSTOMER
398
+ # }
399
+ #
400
+ # @!attribute [rw] channel_id
401
+ # A value that indicates the audio channel.
402
+ # @return [Integer]
403
+ #
404
+ # @!attribute [rw] participant_role
405
+ # Indicates whether the person speaking on the audio channel is the
406
+ # agent or customer.
407
+ # @return [String]
408
+ #
409
+ # @see http://docs.aws.amazon.com/goto/WebAPI/transcribe-2017-10-26/ChannelDefinition AWS API Documentation
410
+ #
411
+ class ChannelDefinition < Struct.new(
412
+ :channel_id,
413
+ :participant_role)
414
+ SENSITIVE = []
415
+ include Aws::Structure
416
+ end
417
+
29
418
  # There is already a resource with that name.
30
419
  #
31
420
  # @!attribute [rw] message
@@ -74,6 +463,117 @@ module Aws::TranscribeService
74
463
  include Aws::Structure
75
464
  end
76
465
 
466
+ # @note When making an API call, you may pass CreateCallAnalyticsCategoryRequest
467
+ # data as a hash:
468
+ #
469
+ # {
470
+ # category_name: "CategoryName", # required
471
+ # rules: [ # required
472
+ # {
473
+ # non_talk_time_filter: {
474
+ # threshold: 1,
475
+ # absolute_time_range: {
476
+ # start_time: 1,
477
+ # end_time: 1,
478
+ # first: 1,
479
+ # last: 1,
480
+ # },
481
+ # relative_time_range: {
482
+ # start_percentage: 1,
483
+ # end_percentage: 1,
484
+ # first: 1,
485
+ # last: 1,
486
+ # },
487
+ # negate: false,
488
+ # },
489
+ # interruption_filter: {
490
+ # threshold: 1,
491
+ # participant_role: "AGENT", # accepts AGENT, CUSTOMER
492
+ # absolute_time_range: {
493
+ # start_time: 1,
494
+ # end_time: 1,
495
+ # first: 1,
496
+ # last: 1,
497
+ # },
498
+ # relative_time_range: {
499
+ # start_percentage: 1,
500
+ # end_percentage: 1,
501
+ # first: 1,
502
+ # last: 1,
503
+ # },
504
+ # negate: false,
505
+ # },
506
+ # transcript_filter: {
507
+ # transcript_filter_type: "EXACT", # required, accepts EXACT
508
+ # absolute_time_range: {
509
+ # start_time: 1,
510
+ # end_time: 1,
511
+ # first: 1,
512
+ # last: 1,
513
+ # },
514
+ # relative_time_range: {
515
+ # start_percentage: 1,
516
+ # end_percentage: 1,
517
+ # first: 1,
518
+ # last: 1,
519
+ # },
520
+ # participant_role: "AGENT", # accepts AGENT, CUSTOMER
521
+ # negate: false,
522
+ # targets: ["NonEmptyString"], # required
523
+ # },
524
+ # sentiment_filter: {
525
+ # sentiments: ["POSITIVE"], # required, accepts POSITIVE, NEGATIVE, NEUTRAL, MIXED
526
+ # absolute_time_range: {
527
+ # start_time: 1,
528
+ # end_time: 1,
529
+ # first: 1,
530
+ # last: 1,
531
+ # },
532
+ # relative_time_range: {
533
+ # start_percentage: 1,
534
+ # end_percentage: 1,
535
+ # first: 1,
536
+ # last: 1,
537
+ # },
538
+ # participant_role: "AGENT", # accepts AGENT, CUSTOMER
539
+ # negate: false,
540
+ # },
541
+ # },
542
+ # ],
543
+ # }
544
+ #
545
+ # @!attribute [rw] category_name
546
+ # The name that you choose for your category when you create it.
547
+ # @return [String]
548
+ #
549
+ # @!attribute [rw] rules
550
+ # To create a category, you must specify between 1 and 20 rules. For
551
+ # each rule, you specify a filter to be applied to the attributes of
552
+ # the call. For example, you can specify a sentiment filter to detect
553
+ # if the customer's sentiment was negative or neutral.
554
+ # @return [Array<Types::Rule>]
555
+ #
556
+ # @see http://docs.aws.amazon.com/goto/WebAPI/transcribe-2017-10-26/CreateCallAnalyticsCategoryRequest AWS API Documentation
557
+ #
558
+ class CreateCallAnalyticsCategoryRequest < Struct.new(
559
+ :category_name,
560
+ :rules)
561
+ SENSITIVE = []
562
+ include Aws::Structure
563
+ end
564
+
565
+ # @!attribute [rw] category_properties
566
+ # The rules and associated metadata used to create a category.
567
+ # @return [Types::CategoryProperties]
568
+ #
569
+ # @see http://docs.aws.amazon.com/goto/WebAPI/transcribe-2017-10-26/CreateCallAnalyticsCategoryResponse AWS API Documentation
570
+ #
571
+ class CreateCallAnalyticsCategoryResponse < Struct.new(
572
+ :category_properties)
573
+ SENSITIVE = []
574
+ include Aws::Structure
575
+ end
576
+
77
577
  # @note When making an API call, you may pass CreateLanguageModelRequest
78
578
  # data as a hash:
79
579
  #
@@ -86,6 +586,12 @@ module Aws::TranscribeService
86
586
  # tuning_data_s3_uri: "Uri",
87
587
  # data_access_role_arn: "DataAccessRoleArn", # required
88
588
  # },
589
+ # tags: [
590
+ # {
591
+ # key: "TagKey", # required
592
+ # value: "TagValue", # required
593
+ # },
594
+ # ],
89
595
  # }
90
596
  #
91
597
  # @!attribute [rw] language_code
@@ -98,10 +604,10 @@ module Aws::TranscribeService
98
604
  # create your custom language model.
99
605
  #
100
606
  # If you want to use your custom language model to transcribe audio
101
- # with a sample rate of 16 kHz or greater, choose `Wideband`.
607
+ # with a sample rate of 16,000 Hz or greater, choose `Wideband`.
102
608
  #
103
609
  # If you want to use your custom language model to transcribe audio
104
- # with a sample rate that is less than 16 kHz, choose `Narrowband`.
610
+ # with a sample rate that is less than 16,000 Hz, choose `Narrowband`.
105
611
  # @return [String]
106
612
  #
107
613
  # @!attribute [rw] model_name
@@ -114,13 +620,19 @@ module Aws::TranscribeService
114
620
  # required input files to create a custom language model.
115
621
  # @return [Types::InputDataConfig]
116
622
  #
623
+ # @!attribute [rw] tags
624
+ # Adds one or more tags, each in the form of a key:value pair, to a
625
+ # new language model at the time you create this new model.
626
+ # @return [Array<Types::Tag>]
627
+ #
117
628
  # @see http://docs.aws.amazon.com/goto/WebAPI/transcribe-2017-10-26/CreateLanguageModelRequest AWS API Documentation
118
629
  #
119
630
  class CreateLanguageModelRequest < Struct.new(
120
631
  :language_code,
121
632
  :base_model_name,
122
633
  :model_name,
123
- :input_data_config)
634
+ :input_data_config,
635
+ :tags)
124
636
  SENSITIVE = []
125
637
  include Aws::Structure
126
638
  end
@@ -166,14 +678,20 @@ module Aws::TranscribeService
166
678
  #
167
679
  # {
168
680
  # vocabulary_name: "VocabularyName", # required
169
- # language_code: "af-ZA", # required, accepts af-ZA, ar-AE, ar-SA, cy-GB, da-DK, de-CH, de-DE, en-AB, en-AU, en-GB, en-IE, en-IN, en-US, en-WL, es-ES, es-US, fa-IR, fr-CA, fr-FR, ga-IE, gd-GB, he-IL, hi-IN, id-ID, it-IT, ja-JP, ko-KR, ms-MY, nl-NL, pt-BR, pt-PT, ru-RU, ta-IN, te-IN, tr-TR, zh-CN
681
+ # language_code: "af-ZA", # required, accepts af-ZA, ar-AE, ar-SA, cy-GB, da-DK, de-CH, de-DE, en-AB, en-AU, en-GB, en-IE, en-IN, en-US, en-WL, es-ES, es-US, fa-IR, fr-CA, fr-FR, ga-IE, gd-GB, he-IL, hi-IN, id-ID, it-IT, ja-JP, ko-KR, ms-MY, nl-NL, pt-BR, pt-PT, ru-RU, ta-IN, te-IN, tr-TR, zh-CN, zh-TW, th-TH, en-ZA, en-NZ
170
682
  # vocabulary_file_uri: "Uri", # required
683
+ # tags: [
684
+ # {
685
+ # key: "TagKey", # required
686
+ # value: "TagValue", # required
687
+ # },
688
+ # ],
171
689
  # }
172
690
  #
173
691
  # @!attribute [rw] vocabulary_name
174
692
  # The name of the custom vocabulary. This case-sensitive name must be
175
- # unique within an AWS account. If you try to create a vocabulary with
176
- # the same name as a previous vocabulary, you get a
693
+ # unique within an Amazon Web Services account. If you try to create a
694
+ # vocabulary with the same name as a previous vocabulary, you get a
177
695
  # `ConflictException` error.
178
696
  # @return [String]
179
697
  #
@@ -187,9 +705,9 @@ module Aws::TranscribeService
187
705
  #
188
706
  # @!attribute [rw] vocabulary_file_uri
189
707
  # The location in Amazon S3 of the text file you use to define your
190
- # custom vocabulary. The URI must be in the same AWS Region as the
191
- # resource that you're calling. Enter information about your
192
- # `VocabularyFileUri` in the following format:
708
+ # custom vocabulary. The URI must be in the same Amazon Web Services
709
+ # Region as the resource that you're calling. Enter information about
710
+ # your `VocabularyFileUri` in the following format:
193
711
  #
194
712
  # `
195
713
  # https://s3.<aws-region>.amazonaws.com/<bucket-name>/<keyprefix>/<objectkey>
@@ -208,23 +726,29 @@ module Aws::TranscribeService
208
726
  #
209
727
  #
210
728
  #
211
- # [1]: http://docs.aws.amazon.com/AmazonS3/latest/dev/UsingMetadata.html#object-keys
212
- # [2]: http://docs.aws.amazon.com/transcribe/latest/dg/how-it-works.html#how-vocabulary-med
729
+ # [1]: https://docs.aws.amazon.com/AmazonS3/latest/dev/UsingMetadata.html#object-keys
730
+ # [2]: https://docs.aws.amazon.com/transcribe/latest/dg/how-it-works.html#how-vocabulary-med
213
731
  # @return [String]
214
732
  #
733
+ # @!attribute [rw] tags
734
+ # Adds one or more tags, each in the form of a key:value pair, to a
735
+ # new medical vocabulary at the time you create this new vocabulary.
736
+ # @return [Array<Types::Tag>]
737
+ #
215
738
  # @see http://docs.aws.amazon.com/goto/WebAPI/transcribe-2017-10-26/CreateMedicalVocabularyRequest AWS API Documentation
216
739
  #
217
740
  class CreateMedicalVocabularyRequest < Struct.new(
218
741
  :vocabulary_name,
219
742
  :language_code,
220
- :vocabulary_file_uri)
743
+ :vocabulary_file_uri,
744
+ :tags)
221
745
  SENSITIVE = []
222
746
  include Aws::Structure
223
747
  end
224
748
 
225
749
  # @!attribute [rw] vocabulary_name
226
- # The name of the vocabulary. The name must be unique within an AWS
227
- # account and is case sensitive.
750
+ # The name of the vocabulary. The name must be unique within an Amazon
751
+ # Web Services account and is case sensitive.
228
752
  # @return [String]
229
753
  #
230
754
  # @!attribute [rw] language_code
@@ -265,9 +789,15 @@ module Aws::TranscribeService
265
789
  #
266
790
  # {
267
791
  # vocabulary_filter_name: "VocabularyFilterName", # required
268
- # language_code: "af-ZA", # required, accepts af-ZA, ar-AE, ar-SA, cy-GB, da-DK, de-CH, de-DE, en-AB, en-AU, en-GB, en-IE, en-IN, en-US, en-WL, es-ES, es-US, fa-IR, fr-CA, fr-FR, ga-IE, gd-GB, he-IL, hi-IN, id-ID, it-IT, ja-JP, ko-KR, ms-MY, nl-NL, pt-BR, pt-PT, ru-RU, ta-IN, te-IN, tr-TR, zh-CN
792
+ # language_code: "af-ZA", # required, accepts af-ZA, ar-AE, ar-SA, cy-GB, da-DK, de-CH, de-DE, en-AB, en-AU, en-GB, en-IE, en-IN, en-US, en-WL, es-ES, es-US, fa-IR, fr-CA, fr-FR, ga-IE, gd-GB, he-IL, hi-IN, id-ID, it-IT, ja-JP, ko-KR, ms-MY, nl-NL, pt-BR, pt-PT, ru-RU, ta-IN, te-IN, tr-TR, zh-CN, zh-TW, th-TH, en-ZA, en-NZ
269
793
  # words: ["Word"],
270
794
  # vocabulary_filter_file_uri: "Uri",
795
+ # tags: [
796
+ # {
797
+ # key: "TagKey", # required
798
+ # value: "TagValue", # required
799
+ # },
800
+ # ],
271
801
  # }
272
802
  #
273
803
  # @!attribute [rw] vocabulary_filter_name
@@ -313,13 +843,20 @@ module Aws::TranscribeService
313
843
  # [1]: https://docs.aws.amazon.com/transcribe/latest/dg/how-vocabulary.html#charsets
314
844
  # @return [String]
315
845
  #
846
+ # @!attribute [rw] tags
847
+ # Adds one or more tags, each in the form of a key:value pair, to a
848
+ # new Amazon Transcribe vocabulary filter at the time you create this
849
+ # new vocabulary filter.
850
+ # @return [Array<Types::Tag>]
851
+ #
316
852
  # @see http://docs.aws.amazon.com/goto/WebAPI/transcribe-2017-10-26/CreateVocabularyFilterRequest AWS API Documentation
317
853
  #
318
854
  class CreateVocabularyFilterRequest < Struct.new(
319
855
  :vocabulary_filter_name,
320
856
  :language_code,
321
857
  :words,
322
- :vocabulary_filter_file_uri)
858
+ :vocabulary_filter_file_uri,
859
+ :tags)
323
860
  SENSITIVE = []
324
861
  include Aws::Structure
325
862
  end
@@ -351,21 +888,27 @@ module Aws::TranscribeService
351
888
  #
352
889
  # {
353
890
  # vocabulary_name: "VocabularyName", # required
354
- # language_code: "af-ZA", # required, accepts af-ZA, ar-AE, ar-SA, cy-GB, da-DK, de-CH, de-DE, en-AB, en-AU, en-GB, en-IE, en-IN, en-US, en-WL, es-ES, es-US, fa-IR, fr-CA, fr-FR, ga-IE, gd-GB, he-IL, hi-IN, id-ID, it-IT, ja-JP, ko-KR, ms-MY, nl-NL, pt-BR, pt-PT, ru-RU, ta-IN, te-IN, tr-TR, zh-CN
891
+ # language_code: "af-ZA", # required, accepts af-ZA, ar-AE, ar-SA, cy-GB, da-DK, de-CH, de-DE, en-AB, en-AU, en-GB, en-IE, en-IN, en-US, en-WL, es-ES, es-US, fa-IR, fr-CA, fr-FR, ga-IE, gd-GB, he-IL, hi-IN, id-ID, it-IT, ja-JP, ko-KR, ms-MY, nl-NL, pt-BR, pt-PT, ru-RU, ta-IN, te-IN, tr-TR, zh-CN, zh-TW, th-TH, en-ZA, en-NZ
355
892
  # phrases: ["Phrase"],
356
893
  # vocabulary_file_uri: "Uri",
894
+ # tags: [
895
+ # {
896
+ # key: "TagKey", # required
897
+ # value: "TagValue", # required
898
+ # },
899
+ # ],
357
900
  # }
358
901
  #
359
902
  # @!attribute [rw] vocabulary_name
360
- # The name of the vocabulary. The name must be unique within an AWS
361
- # account. The name is case sensitive. If you try to create a
362
- # vocabulary with the same name as a previous vocabulary you will
363
- # receive a `ConflictException` error.
903
+ # The name of the vocabulary. The name must be unique within an Amazon
904
+ # Web Services account. The name is case sensitive. If you try to
905
+ # create a vocabulary with the same name as a previous vocabulary you
906
+ # will receive a `ConflictException` error.
364
907
  # @return [String]
365
908
  #
366
909
  # @!attribute [rw] language_code
367
910
  # The language code of the vocabulary entries. For a list of languages
368
- # and their corresponding language codes, see what-is-transcribe.
911
+ # and their corresponding language codes, see transcribe-whatis.
369
912
  # @return [String]
370
913
  #
371
914
  # @!attribute [rw] phrases
@@ -375,27 +918,34 @@ module Aws::TranscribeService
375
918
  # @!attribute [rw] vocabulary_file_uri
376
919
  # The S3 location of the text file that contains the definition of the
377
920
  # custom vocabulary. The URI must be in the same region as the API
378
- # endpoint that you are calling. The general form is
921
+ # endpoint that you are calling. The general form is:
379
922
  #
380
923
  # For more information about S3 object names, see [Object Keys][1] in
381
924
  # the *Amazon S3 Developer Guide*.
382
925
  #
383
926
  # For more information about custom vocabularies, see [Custom
384
- # Vocabularies][2].
927
+ # vocabularies][2].
385
928
  #
386
929
  #
387
930
  #
388
- # [1]: http://docs.aws.amazon.com/AmazonS3/latest/dev/UsingMetadata.html#object-keys
389
- # [2]: http://docs.aws.amazon.com/transcribe/latest/dg/how-vocabulary
931
+ # [1]: https://docs.aws.amazon.com/AmazonS3/latest/dev/UsingMetadata.html#object-keys
932
+ # [2]: https://docs.aws.amazon.com/transcribe/latest/dg/how-vocabulary
390
933
  # @return [String]
391
934
  #
935
+ # @!attribute [rw] tags
936
+ # Adds one or more tags, each in the form of a key:value pair, to a
937
+ # new Amazon Transcribe vocabulary at the time you create this new
938
+ # vocabulary.
939
+ # @return [Array<Types::Tag>]
940
+ #
392
941
  # @see http://docs.aws.amazon.com/goto/WebAPI/transcribe-2017-10-26/CreateVocabularyRequest AWS API Documentation
393
942
  #
394
943
  class CreateVocabularyRequest < Struct.new(
395
944
  :vocabulary_name,
396
945
  :language_code,
397
946
  :phrases,
398
- :vocabulary_file_uri)
947
+ :vocabulary_file_uri,
948
+ :tags)
399
949
  SENSITIVE = []
400
950
  include Aws::Structure
401
951
  end
@@ -435,6 +985,53 @@ module Aws::TranscribeService
435
985
  include Aws::Structure
436
986
  end
437
987
 
988
+ # @note When making an API call, you may pass DeleteCallAnalyticsCategoryRequest
989
+ # data as a hash:
990
+ #
991
+ # {
992
+ # category_name: "CategoryName", # required
993
+ # }
994
+ #
995
+ # @!attribute [rw] category_name
996
+ # The name of the call analytics category that you're choosing to
997
+ # delete. The value is case sensitive.
998
+ # @return [String]
999
+ #
1000
+ # @see http://docs.aws.amazon.com/goto/WebAPI/transcribe-2017-10-26/DeleteCallAnalyticsCategoryRequest AWS API Documentation
1001
+ #
1002
+ class DeleteCallAnalyticsCategoryRequest < Struct.new(
1003
+ :category_name)
1004
+ SENSITIVE = []
1005
+ include Aws::Structure
1006
+ end
1007
+
1008
+ # @see http://docs.aws.amazon.com/goto/WebAPI/transcribe-2017-10-26/DeleteCallAnalyticsCategoryResponse AWS API Documentation
1009
+ #
1010
+ class DeleteCallAnalyticsCategoryResponse < Aws::EmptyStructure; end
1011
+
1012
+ # @note When making an API call, you may pass DeleteCallAnalyticsJobRequest
1013
+ # data as a hash:
1014
+ #
1015
+ # {
1016
+ # call_analytics_job_name: "CallAnalyticsJobName", # required
1017
+ # }
1018
+ #
1019
+ # @!attribute [rw] call_analytics_job_name
1020
+ # The name of the call analytics job you want to delete.
1021
+ # @return [String]
1022
+ #
1023
+ # @see http://docs.aws.amazon.com/goto/WebAPI/transcribe-2017-10-26/DeleteCallAnalyticsJobRequest AWS API Documentation
1024
+ #
1025
+ class DeleteCallAnalyticsJobRequest < Struct.new(
1026
+ :call_analytics_job_name)
1027
+ SENSITIVE = []
1028
+ include Aws::Structure
1029
+ end
1030
+
1031
+ # @see http://docs.aws.amazon.com/goto/WebAPI/transcribe-2017-10-26/DeleteCallAnalyticsJobResponse AWS API Documentation
1032
+ #
1033
+ class DeleteCallAnalyticsJobResponse < Aws::EmptyStructure; end
1034
+
438
1035
  # @note When making an API call, you may pass DeleteLanguageModelRequest
439
1036
  # data as a hash:
440
1037
  #
@@ -583,6 +1180,70 @@ module Aws::TranscribeService
583
1180
  include Aws::Structure
584
1181
  end
585
1182
 
1183
+ # @note When making an API call, you may pass GetCallAnalyticsCategoryRequest
1184
+ # data as a hash:
1185
+ #
1186
+ # {
1187
+ # category_name: "CategoryName", # required
1188
+ # }
1189
+ #
1190
+ # @!attribute [rw] category_name
1191
+ # The name of the category you want information about. This value is
1192
+ # case sensitive.
1193
+ # @return [String]
1194
+ #
1195
+ # @see http://docs.aws.amazon.com/goto/WebAPI/transcribe-2017-10-26/GetCallAnalyticsCategoryRequest AWS API Documentation
1196
+ #
1197
+ class GetCallAnalyticsCategoryRequest < Struct.new(
1198
+ :category_name)
1199
+ SENSITIVE = []
1200
+ include Aws::Structure
1201
+ end
1202
+
1203
+ # @!attribute [rw] category_properties
1204
+ # The rules you've defined for a category.
1205
+ # @return [Types::CategoryProperties]
1206
+ #
1207
+ # @see http://docs.aws.amazon.com/goto/WebAPI/transcribe-2017-10-26/GetCallAnalyticsCategoryResponse AWS API Documentation
1208
+ #
1209
+ class GetCallAnalyticsCategoryResponse < Struct.new(
1210
+ :category_properties)
1211
+ SENSITIVE = []
1212
+ include Aws::Structure
1213
+ end
1214
+
1215
+ # @note When making an API call, you may pass GetCallAnalyticsJobRequest
1216
+ # data as a hash:
1217
+ #
1218
+ # {
1219
+ # call_analytics_job_name: "CallAnalyticsJobName", # required
1220
+ # }
1221
+ #
1222
+ # @!attribute [rw] call_analytics_job_name
1223
+ # The name of the analytics job you want information about. This value
1224
+ # is case sensitive.
1225
+ # @return [String]
1226
+ #
1227
+ # @see http://docs.aws.amazon.com/goto/WebAPI/transcribe-2017-10-26/GetCallAnalyticsJobRequest AWS API Documentation
1228
+ #
1229
+ class GetCallAnalyticsJobRequest < Struct.new(
1230
+ :call_analytics_job_name)
1231
+ SENSITIVE = []
1232
+ include Aws::Structure
1233
+ end
1234
+
1235
+ # @!attribute [rw] call_analytics_job
1236
+ # An object that contains the results of your call analytics job.
1237
+ # @return [Types::CallAnalyticsJob]
1238
+ #
1239
+ # @see http://docs.aws.amazon.com/goto/WebAPI/transcribe-2017-10-26/GetCallAnalyticsJobResponse AWS API Documentation
1240
+ #
1241
+ class GetCallAnalyticsJobResponse < Struct.new(
1242
+ :call_analytics_job)
1243
+ SENSITIVE = []
1244
+ include Aws::Structure
1245
+ end
1246
+
586
1247
  # @note When making an API call, you may pass GetMedicalTranscriptionJobRequest
587
1248
  # data as a hash:
588
1249
  #
@@ -869,6 +1530,73 @@ module Aws::TranscribeService
869
1530
  include Aws::Structure
870
1531
  end
871
1532
 
1533
+ # An object that enables you to configure your category to be applied to
1534
+ # call analytics jobs where either the customer or agent was
1535
+ # interrupted.
1536
+ #
1537
+ # @note When making an API call, you may pass InterruptionFilter
1538
+ # data as a hash:
1539
+ #
1540
+ # {
1541
+ # threshold: 1,
1542
+ # participant_role: "AGENT", # accepts AGENT, CUSTOMER
1543
+ # absolute_time_range: {
1544
+ # start_time: 1,
1545
+ # end_time: 1,
1546
+ # first: 1,
1547
+ # last: 1,
1548
+ # },
1549
+ # relative_time_range: {
1550
+ # start_percentage: 1,
1551
+ # end_percentage: 1,
1552
+ # first: 1,
1553
+ # last: 1,
1554
+ # },
1555
+ # negate: false,
1556
+ # }
1557
+ #
1558
+ # @!attribute [rw] threshold
1559
+ # The duration of the interruption.
1560
+ # @return [Integer]
1561
+ #
1562
+ # @!attribute [rw] participant_role
1563
+ # Indicates whether the caller or customer was interrupting.
1564
+ # @return [String]
1565
+ #
1566
+ # @!attribute [rw] absolute_time_range
1567
+ # An object you can use to specify a time range (in milliseconds) for
1568
+ # when you'd want to find the interruption. For example, you could
1569
+ # search for an interruption between the 30,000 millisecond mark and
1570
+ # the 45,000 millisecond mark. You could also specify the time period
1571
+ # as the first 15,000 milliseconds or the last 15,000 milliseconds.
1572
+ # @return [Types::AbsoluteTimeRange]
1573
+ #
1574
+ # @!attribute [rw] relative_time_range
1575
+ # An object that allows percentages to specify the proportion of the
1576
+ # call where there was a interruption. For example, you can specify
1577
+ # the first half of the call. You can also specify the period of time
1578
+ # between halfway through to three-quarters of the way through the
1579
+ # call. Because the length of conversation can vary between calls, you
1580
+ # can apply relative time ranges across all calls.
1581
+ # @return [Types::RelativeTimeRange]
1582
+ #
1583
+ # @!attribute [rw] negate
1584
+ # Set to `TRUE` to look for a time period where there was no
1585
+ # interruption.
1586
+ # @return [Boolean]
1587
+ #
1588
+ # @see http://docs.aws.amazon.com/goto/WebAPI/transcribe-2017-10-26/InterruptionFilter AWS API Documentation
1589
+ #
1590
+ class InterruptionFilter < Struct.new(
1591
+ :threshold,
1592
+ :participant_role,
1593
+ :absolute_time_range,
1594
+ :relative_time_range,
1595
+ :negate)
1596
+ SENSITIVE = []
1597
+ include Aws::Structure
1598
+ end
1599
+
872
1600
  # Provides information about when a transcription job should be
873
1601
  # executed.
874
1602
  #
@@ -986,6 +1714,131 @@ module Aws::TranscribeService
986
1714
  include Aws::Structure
987
1715
  end
988
1716
 
1717
+ # @note When making an API call, you may pass ListCallAnalyticsCategoriesRequest
1718
+ # data as a hash:
1719
+ #
1720
+ # {
1721
+ # next_token: "NextToken",
1722
+ # max_results: 1,
1723
+ # }
1724
+ #
1725
+ # @!attribute [rw] next_token
1726
+ # When included, `NextToken`fetches the next set of categories if the
1727
+ # result of the previous request was truncated.
1728
+ # @return [String]
1729
+ #
1730
+ # @!attribute [rw] max_results
1731
+ # The maximum number of categories to return in each page of results.
1732
+ # If there are fewer results than the value you specify, only the
1733
+ # actual results are returned. If you do not specify a value, the
1734
+ # default of 5 is used.
1735
+ # @return [Integer]
1736
+ #
1737
+ # @see http://docs.aws.amazon.com/goto/WebAPI/transcribe-2017-10-26/ListCallAnalyticsCategoriesRequest AWS API Documentation
1738
+ #
1739
+ class ListCallAnalyticsCategoriesRequest < Struct.new(
1740
+ :next_token,
1741
+ :max_results)
1742
+ SENSITIVE = []
1743
+ include Aws::Structure
1744
+ end
1745
+
1746
+ # @!attribute [rw] next_token
1747
+ # The operation returns a page of jobs at a time. The maximum size of
1748
+ # the list is set by the `MaxResults` parameter. If there are more
1749
+ # categories in the list than the page size, Amazon Transcribe returns
1750
+ # the `NextPage` token. Include the token in the next request to the
1751
+ # operation to return the next page of analytics categories.
1752
+ # @return [String]
1753
+ #
1754
+ # @!attribute [rw] categories
1755
+ # A list of objects containing information about analytics categories.
1756
+ # @return [Array<Types::CategoryProperties>]
1757
+ #
1758
+ # @see http://docs.aws.amazon.com/goto/WebAPI/transcribe-2017-10-26/ListCallAnalyticsCategoriesResponse AWS API Documentation
1759
+ #
1760
+ class ListCallAnalyticsCategoriesResponse < Struct.new(
1761
+ :next_token,
1762
+ :categories)
1763
+ SENSITIVE = []
1764
+ include Aws::Structure
1765
+ end
1766
+
1767
+ # @note When making an API call, you may pass ListCallAnalyticsJobsRequest
1768
+ # data as a hash:
1769
+ #
1770
+ # {
1771
+ # status: "QUEUED", # accepts QUEUED, IN_PROGRESS, FAILED, COMPLETED
1772
+ # job_name_contains: "CallAnalyticsJobName",
1773
+ # next_token: "NextToken",
1774
+ # max_results: 1,
1775
+ # }
1776
+ #
1777
+ # @!attribute [rw] status
1778
+ # When specified, returns only call analytics jobs with the specified
1779
+ # status. Jobs are ordered by creation date, with the most recent jobs
1780
+ # returned first. If you don't specify a status, Amazon Transcribe
1781
+ # returns all analytics jobs ordered by creation date.
1782
+ # @return [String]
1783
+ #
1784
+ # @!attribute [rw] job_name_contains
1785
+ # When specified, the jobs returned in the list are limited to jobs
1786
+ # whose name contains the specified string.
1787
+ # @return [String]
1788
+ #
1789
+ # @!attribute [rw] next_token
1790
+ # If you receive a truncated result in the previous request of ,
1791
+ # include `NextToken` to fetch the next set of jobs.
1792
+ # @return [String]
1793
+ #
1794
+ # @!attribute [rw] max_results
1795
+ # The maximum number of call analytics jobs to return in each page of
1796
+ # results. If there are fewer results than the value you specify, only
1797
+ # the actual results are returned. If you do not specify a value, the
1798
+ # default of 5 is used.
1799
+ # @return [Integer]
1800
+ #
1801
+ # @see http://docs.aws.amazon.com/goto/WebAPI/transcribe-2017-10-26/ListCallAnalyticsJobsRequest AWS API Documentation
1802
+ #
1803
+ class ListCallAnalyticsJobsRequest < Struct.new(
1804
+ :status,
1805
+ :job_name_contains,
1806
+ :next_token,
1807
+ :max_results)
1808
+ SENSITIVE = []
1809
+ include Aws::Structure
1810
+ end
1811
+
1812
+ # @!attribute [rw] status
1813
+ # When specified, returns only call analytics jobs with that status.
1814
+ # Jobs are ordered by creation date, with the most recent jobs
1815
+ # returned first. If you don't specify a status, Amazon Transcribe
1816
+ # returns all transcription jobs ordered by creation date.
1817
+ # @return [String]
1818
+ #
1819
+ # @!attribute [rw] next_token
1820
+ # The operation returns a page of jobs at a time. The maximum size of
1821
+ # the page is set by the `MaxResults` parameter. If there are more
1822
+ # jobs in the list than the page size, Amazon Transcribe returns the
1823
+ # `NextPage` token. Include the token in your next request to the
1824
+ # operation to return next page of jobs.
1825
+ # @return [String]
1826
+ #
1827
+ # @!attribute [rw] call_analytics_job_summaries
1828
+ # A list of objects containing summary information for a transcription
1829
+ # job.
1830
+ # @return [Array<Types::CallAnalyticsJobSummary>]
1831
+ #
1832
+ # @see http://docs.aws.amazon.com/goto/WebAPI/transcribe-2017-10-26/ListCallAnalyticsJobsResponse AWS API Documentation
1833
+ #
1834
+ class ListCallAnalyticsJobsResponse < Struct.new(
1835
+ :status,
1836
+ :next_token,
1837
+ :call_analytics_job_summaries)
1838
+ SENSITIVE = []
1839
+ include Aws::Structure
1840
+ end
1841
+
989
1842
  # @note When making an API call, you may pass ListLanguageModelsRequest
990
1843
  # data as a hash:
991
1844
  #
@@ -1014,9 +1867,10 @@ module Aws::TranscribeService
1014
1867
  # @return [String]
1015
1868
  #
1016
1869
  # @!attribute [rw] max_results
1017
- # The maximum number of language models to return in the response. If
1018
- # there are fewer results in the list, the response contains only the
1019
- # actual results.
1870
+ # The maximum number of language models to return in each page of
1871
+ # results. If there are fewer results than the value you specify, only
1872
+ # the actual results are returned. If you do not specify a value, the
1873
+ # default of 5 is used.
1020
1874
  # @return [Integer]
1021
1875
  #
1022
1876
  # @see http://docs.aws.amazon.com/goto/WebAPI/transcribe-2017-10-26/ListLanguageModelsRequest AWS API Documentation
@@ -1082,9 +1936,10 @@ module Aws::TranscribeService
1082
1936
  # @return [String]
1083
1937
  #
1084
1938
  # @!attribute [rw] max_results
1085
- # The maximum number of medical transcription jobs to return in the
1086
- # response. IF there are fewer results in the list, this response
1087
- # contains only the actual results.
1939
+ # The maximum number of medical transcription jobs to return in each
1940
+ # page of results. If there are fewer results than the value you
1941
+ # specify, only the actual results are returned. If you do not specify
1942
+ # a value, the default of 5 is used.
1088
1943
  # @return [Integer]
1089
1944
  #
1090
1945
  # @see http://docs.aws.amazon.com/goto/WebAPI/transcribe-2017-10-26/ListMedicalTranscriptionJobsRequest AWS API Documentation
@@ -1143,7 +1998,10 @@ module Aws::TranscribeService
1143
1998
  # @return [String]
1144
1999
  #
1145
2000
  # @!attribute [rw] max_results
1146
- # The maximum number of vocabularies to return in the response.
2001
+ # The maximum number of vocabularies to return in each page of
2002
+ # results. If there are fewer results than the value you specify, only
2003
+ # the actual results are returned. If you do not specify a value, the
2004
+ # default of 5 is used.
1147
2005
  # @return [Integer]
1148
2006
  #
1149
2007
  # @!attribute [rw] state_equals
@@ -1198,6 +2056,43 @@ module Aws::TranscribeService
1198
2056
  include Aws::Structure
1199
2057
  end
1200
2058
 
2059
+ # @note When making an API call, you may pass ListTagsForResourceRequest
2060
+ # data as a hash:
2061
+ #
2062
+ # {
2063
+ # resource_arn: "TranscribeArn", # required
2064
+ # }
2065
+ #
2066
+ # @!attribute [rw] resource_arn
2067
+ # Lists all tags associated with a given Amazon Resource Name (ARN).
2068
+ # @return [String]
2069
+ #
2070
+ # @see http://docs.aws.amazon.com/goto/WebAPI/transcribe-2017-10-26/ListTagsForResourceRequest AWS API Documentation
2071
+ #
2072
+ class ListTagsForResourceRequest < Struct.new(
2073
+ :resource_arn)
2074
+ SENSITIVE = []
2075
+ include Aws::Structure
2076
+ end
2077
+
2078
+ # @!attribute [rw] resource_arn
2079
+ # Lists all tags associated with the given Amazon Resource Name (ARN).
2080
+ # @return [String]
2081
+ #
2082
+ # @!attribute [rw] tags
2083
+ # Lists all tags associated with the given transcription job,
2084
+ # vocabulary, or resource.
2085
+ # @return [Array<Types::Tag>]
2086
+ #
2087
+ # @see http://docs.aws.amazon.com/goto/WebAPI/transcribe-2017-10-26/ListTagsForResourceResponse AWS API Documentation
2088
+ #
2089
+ class ListTagsForResourceResponse < Struct.new(
2090
+ :resource_arn,
2091
+ :tags)
2092
+ SENSITIVE = []
2093
+ include Aws::Structure
2094
+ end
2095
+
1201
2096
  # @note When making an API call, you may pass ListTranscriptionJobsRequest
1202
2097
  # data as a hash:
1203
2098
  #
@@ -1221,14 +2116,15 @@ module Aws::TranscribeService
1221
2116
  # @return [String]
1222
2117
  #
1223
2118
  # @!attribute [rw] next_token
1224
- # If the result of the previous request to `ListTranscriptionJobs` was
2119
+ # If the result of the previous request to `ListTranscriptionJobs` is
1225
2120
  # truncated, include the `NextToken` to fetch the next set of jobs.
1226
2121
  # @return [String]
1227
2122
  #
1228
2123
  # @!attribute [rw] max_results
1229
- # The maximum number of jobs to return in the response. If there are
1230
- # fewer results in the list, this response contains only the actual
1231
- # results.
2124
+ # The maximum number of jobs to return in each page of results. If
2125
+ # there are fewer results than the value you specify, only the actual
2126
+ # results are returned. If you do not specify a value, the default of
2127
+ # 5 is used.
1232
2128
  # @return [Integer]
1233
2129
  #
1234
2130
  # @see http://docs.aws.amazon.com/goto/WebAPI/transcribe-2017-10-26/ListTranscriptionJobsRequest AWS API Documentation
@@ -1286,9 +2182,10 @@ module Aws::TranscribeService
1286
2182
  # @return [String]
1287
2183
  #
1288
2184
  # @!attribute [rw] max_results
1289
- # The maximum number of vocabularies to return in the response. If
1290
- # there are fewer results in the list, this response contains only the
1291
- # actual results.
2185
+ # The maximum number of vocabularies to return in each page of
2186
+ # results. If there are fewer results than the value you specify, only
2187
+ # the actual results are returned. If you do not specify a value, the
2188
+ # default of 5 is used.
1292
2189
  # @return [Integer]
1293
2190
  #
1294
2191
  # @!attribute [rw] state_equals
@@ -1358,9 +2255,10 @@ module Aws::TranscribeService
1358
2255
  # @return [String]
1359
2256
  #
1360
2257
  # @!attribute [rw] max_results
1361
- # The maximum number of filters to return in the response. If there
1362
- # are fewer results in the list, this response contains only the
1363
- # actual results.
2258
+ # The maximum number of filters to return in each page of results. If
2259
+ # there are fewer results than the value you specify, only the actual
2260
+ # results are returned. If you do not specify a value, the default of
2261
+ # 5 is used.
1364
2262
  # @return [Integer]
1365
2263
  #
1366
2264
  # @!attribute [rw] name_contains
@@ -1411,6 +2309,7 @@ module Aws::TranscribeService
1411
2309
  #
1412
2310
  # {
1413
2311
  # media_file_uri: "Uri",
2312
+ # redacted_media_file_uri: "Uri",
1414
2313
  # }
1415
2314
  #
1416
2315
  # @!attribute [rw] media_file_uri
@@ -1425,13 +2324,19 @@ module Aws::TranscribeService
1425
2324
  #
1426
2325
  #
1427
2326
  #
1428
- # [1]: http://docs.aws.amazon.com/AmazonS3/latest/dev/UsingMetadata.html#object-keys
2327
+ # [1]: https://docs.aws.amazon.com/AmazonS3/latest/dev/UsingMetadata.html#object-keys
2328
+ # @return [String]
2329
+ #
2330
+ # @!attribute [rw] redacted_media_file_uri
2331
+ # The S3 object location for your redacted output media file. This is
2332
+ # only supported for call analytics jobs.
1429
2333
  # @return [String]
1430
2334
  #
1431
2335
  # @see http://docs.aws.amazon.com/goto/WebAPI/transcribe-2017-10-26/Media AWS API Documentation
1432
2336
  #
1433
2337
  class Media < Struct.new(
1434
- :media_file_uri)
2338
+ :media_file_uri,
2339
+ :redacted_media_file_uri)
1435
2340
  SENSITIVE = []
1436
2341
  include Aws::Structure
1437
2342
  end
@@ -1478,8 +2383,8 @@ module Aws::TranscribeService
1478
2383
  # If you don't specify the sample rate, Amazon Transcribe Medical
1479
2384
  # determines it for you. If you choose to specify the sample rate, it
1480
2385
  # must match the rate detected by Amazon Transcribe Medical. In most
1481
- # cases, you should leave the `MediaSampleHertz` blank and let Amazon
1482
- # Transcribe Medical determine the sample rate.
2386
+ # cases, you should leave the `MedicalMediaSampleHertz` blank and let
2387
+ # Amazon Transcribe Medical determine the sample rate.
1483
2388
  # @return [Integer]
1484
2389
  #
1485
2390
  # @!attribute [rw] media_format
@@ -1525,7 +2430,7 @@ module Aws::TranscribeService
1525
2430
  #
1526
2431
  # * `Invalid sample rate for audio file`- The sample rate specified in
1527
2432
  # the `MediaSampleRateHertz` of the request isn't valid. The sample
1528
- # rate must be between 8000 and 48000 Hertz.
2433
+ # rate must be between 8,000 and 48,000 Hertz.
1529
2434
  #
1530
2435
  # * `The sample rate provided does not match the detected sample
1531
2436
  # rate`- The sample rate in the audio file doesn't match the sample
@@ -1563,22 +2468,29 @@ module Aws::TranscribeService
1563
2468
  #
1564
2469
  # @!attribute [rw] specialty
1565
2470
  # The medical specialty of any clinicians providing a dictation or
1566
- # having a conversation. `PRIMARYCARE` is the only available setting
1567
- # for this object. This specialty enables you to generate
1568
- # transcriptions for the following medical fields:
2471
+ # having a conversation. Refer to [Transcribing a medical
2472
+ # conversation][1]for a list of supported specialties.
1569
2473
  #
1570
- # * Family Medicine
1571
2474
  #
1572
- # ^
2475
+ #
2476
+ # [1]: https://docs.aws.amazon.com/transcribe/latest/dg/transcribe-medical-conversation.html
1573
2477
  # @return [String]
1574
2478
  #
1575
2479
  # @!attribute [rw] type
1576
2480
  # The type of speech in the transcription job. `CONVERSATION` is
1577
2481
  # generally used for patient-physician dialogues. `DICTATION` is the
1578
2482
  # setting for physicians speaking their notes after seeing a patient.
1579
- # For more information, see how-it-works-med
2483
+ # For more information, see [What is Amazon Transcribe Medical?][1].
2484
+ #
2485
+ #
2486
+ #
2487
+ # [1]: https://docs.aws.amazon.com/transcribe/latest/dg/what-is-transcribe-med.html
1580
2488
  # @return [String]
1581
2489
  #
2490
+ # @!attribute [rw] tags
2491
+ # A key:value pair assigned to a given medical transcription job.
2492
+ # @return [Array<Types::Tag>]
2493
+ #
1582
2494
  # @see http://docs.aws.amazon.com/goto/WebAPI/transcribe-2017-10-26/MedicalTranscriptionJob AWS API Documentation
1583
2495
  #
1584
2496
  class MedicalTranscriptionJob < Struct.new(
@@ -1596,7 +2508,8 @@ module Aws::TranscribeService
1596
2508
  :settings,
1597
2509
  :content_identification_type,
1598
2510
  :specialty,
1599
- :type)
2511
+ :type,
2512
+ :tags)
1600
2513
  SENSITIVE = []
1601
2514
  include Aws::Structure
1602
2515
  end
@@ -1634,15 +2547,19 @@ module Aws::TranscribeService
1634
2547
  # @return [String]
1635
2548
  #
1636
2549
  # @!attribute [rw] output_location_type
1637
- # Indicates the location of the transcription job's output.
1638
- #
1639
- # The `CUSTOMER_BUCKET` is the S3 location provided in the
1640
- # `OutputBucketName` field when the
2550
+ # Indicates the location of the transcription job's output. This
2551
+ # field must be the path of an S3 bucket; if you don't already have
2552
+ # an S3 bucket, one is created based on the path you add.
1641
2553
  # @return [String]
1642
2554
  #
1643
2555
  # @!attribute [rw] specialty
1644
- # The medical specialty of the transcription job. `Primary care` is
1645
- # the only valid value.
2556
+ # The medical specialty of the transcription job. Refer to
2557
+ # [Transcribing a medical conversation][1]for a list of supported
2558
+ # specialties.
2559
+ #
2560
+ #
2561
+ #
2562
+ # [1]: https://docs.aws.amazon.com/transcribe/latest/dg/transcribe-medical-conversation.html
1646
2563
  # @return [String]
1647
2564
  #
1648
2565
  # @!attribute [rw] content_identification_type
@@ -1777,6 +2694,67 @@ module Aws::TranscribeService
1777
2694
  include Aws::Structure
1778
2695
  end
1779
2696
 
2697
+ # An object that enables you to configure your category to be applied to
2698
+ # call analytics jobs where either the customer or agent was
2699
+ # interrupted.
2700
+ #
2701
+ # @note When making an API call, you may pass NonTalkTimeFilter
2702
+ # data as a hash:
2703
+ #
2704
+ # {
2705
+ # threshold: 1,
2706
+ # absolute_time_range: {
2707
+ # start_time: 1,
2708
+ # end_time: 1,
2709
+ # first: 1,
2710
+ # last: 1,
2711
+ # },
2712
+ # relative_time_range: {
2713
+ # start_percentage: 1,
2714
+ # end_percentage: 1,
2715
+ # first: 1,
2716
+ # last: 1,
2717
+ # },
2718
+ # negate: false,
2719
+ # }
2720
+ #
2721
+ # @!attribute [rw] threshold
2722
+ # The duration of the period when neither the customer nor agent was
2723
+ # talking.
2724
+ # @return [Integer]
2725
+ #
2726
+ # @!attribute [rw] absolute_time_range
2727
+ # An object you can use to specify a time range (in milliseconds) for
2728
+ # when no one is talking. For example, you could specify a time period
2729
+ # between the 30,000 millisecond mark and the 45,000 millisecond mark.
2730
+ # You could also specify the time period as the first 15,000
2731
+ # milliseconds or the last 15,000 milliseconds.
2732
+ # @return [Types::AbsoluteTimeRange]
2733
+ #
2734
+ # @!attribute [rw] relative_time_range
2735
+ # An object that allows percentages to specify the proportion of the
2736
+ # call where there was silence. For example, you can specify the first
2737
+ # half of the call. You can also specify the period of time between
2738
+ # halfway through to three-quarters of the way through the call.
2739
+ # Because the length of conversation can vary between calls, you can
2740
+ # apply relative time ranges across all calls.
2741
+ # @return [Types::RelativeTimeRange]
2742
+ #
2743
+ # @!attribute [rw] negate
2744
+ # Set to `TRUE` to look for a time period when people were talking.
2745
+ # @return [Boolean]
2746
+ #
2747
+ # @see http://docs.aws.amazon.com/goto/WebAPI/transcribe-2017-10-26/NonTalkTimeFilter AWS API Documentation
2748
+ #
2749
+ class NonTalkTimeFilter < Struct.new(
2750
+ :threshold,
2751
+ :absolute_time_range,
2752
+ :relative_time_range,
2753
+ :negate)
2754
+ SENSITIVE = []
2755
+ include Aws::Structure
2756
+ end
2757
+
1780
2758
  # We can't find the requested resource. Check the name and try your
1781
2759
  # request again.
1782
2760
  #
@@ -1791,6 +2769,189 @@ module Aws::TranscribeService
1791
2769
  include Aws::Structure
1792
2770
  end
1793
2771
 
2772
+ # An object that allows percentages to specify the proportion of the
2773
+ # call where you would like to apply a filter. For example, you can
2774
+ # specify the first half of the call. You can also specify the period of
2775
+ # time between halfway through to three-quarters of the way through the
2776
+ # call. Because the length of conversation can vary between calls, you
2777
+ # can apply relative time ranges across all calls.
2778
+ #
2779
+ # @note When making an API call, you may pass RelativeTimeRange
2780
+ # data as a hash:
2781
+ #
2782
+ # {
2783
+ # start_percentage: 1,
2784
+ # end_percentage: 1,
2785
+ # first: 1,
2786
+ # last: 1,
2787
+ # }
2788
+ #
2789
+ # @!attribute [rw] start_percentage
2790
+ # A value that indicates the percentage of the beginning of the time
2791
+ # range. To set a relative time range, you must specify a start
2792
+ # percentage and an end percentage. For example, if you specify the
2793
+ # following values:
2794
+ #
2795
+ # * StartPercentage - 10
2796
+ #
2797
+ # * EndPercentage - 50
2798
+ #
2799
+ # This looks at the time range starting from 10% of the way into the
2800
+ # call to 50% of the way through the call. For a call that lasts
2801
+ # 100,000 milliseconds, this example range would apply from the 10,000
2802
+ # millisecond mark to the 50,000 millisecond mark.
2803
+ # @return [Integer]
2804
+ #
2805
+ # @!attribute [rw] end_percentage
2806
+ # A value that indicates the percentage of the end of the time range.
2807
+ # To set a relative time range, you must specify a start percentage
2808
+ # and an end percentage. For example, if you specify the following
2809
+ # values:
2810
+ #
2811
+ # * StartPercentage - 10
2812
+ #
2813
+ # * EndPercentage - 50
2814
+ #
2815
+ # This looks at the time range starting from 10% of the way into the
2816
+ # call to 50% of the way through the call. For a call that lasts
2817
+ # 100,000 milliseconds, this example range would apply from the 10,000
2818
+ # millisecond mark to the 50,000 millisecond mark.
2819
+ # @return [Integer]
2820
+ #
2821
+ # @!attribute [rw] first
2822
+ # A range that takes the portion of the call up to the time in
2823
+ # milliseconds set by the value that you've specified. For example,
2824
+ # if you specify `120000`, the time range is set for the first 120,000
2825
+ # milliseconds of the call.
2826
+ # @return [Integer]
2827
+ #
2828
+ # @!attribute [rw] last
2829
+ # A range that takes the portion of the call from the time in
2830
+ # milliseconds set by the value that you've specified to the end of
2831
+ # the call. For example, if you specify `120000`, the time range is
2832
+ # set for the last 120,000 milliseconds of the call.
2833
+ # @return [Integer]
2834
+ #
2835
+ # @see http://docs.aws.amazon.com/goto/WebAPI/transcribe-2017-10-26/RelativeTimeRange AWS API Documentation
2836
+ #
2837
+ class RelativeTimeRange < Struct.new(
2838
+ :start_percentage,
2839
+ :end_percentage,
2840
+ :first,
2841
+ :last)
2842
+ SENSITIVE = []
2843
+ include Aws::Structure
2844
+ end
2845
+
2846
+ # A condition in the call between the customer and the agent that you
2847
+ # want to filter for.
2848
+ #
2849
+ # @note Rule is a union - when making an API calls you must set exactly one of the members.
2850
+ #
2851
+ # @note Rule is a union - when returned from an API call exactly one value will be set and the returned type will be a subclass of Rule corresponding to the set member.
2852
+ #
2853
+ # @!attribute [rw] non_talk_time_filter
2854
+ # A condition for a time period when neither the customer nor the
2855
+ # agent was talking.
2856
+ # @return [Types::NonTalkTimeFilter]
2857
+ #
2858
+ # @!attribute [rw] interruption_filter
2859
+ # A condition for a time period when either the customer or agent was
2860
+ # interrupting the other person.
2861
+ # @return [Types::InterruptionFilter]
2862
+ #
2863
+ # @!attribute [rw] transcript_filter
2864
+ # A condition that catches particular words or phrases based on a
2865
+ # exact match. For example, if you set the phrase "I want to speak to
2866
+ # the manager", only that exact phrase will be returned.
2867
+ # @return [Types::TranscriptFilter]
2868
+ #
2869
+ # @!attribute [rw] sentiment_filter
2870
+ # A condition that is applied to a particular customer sentiment.
2871
+ # @return [Types::SentimentFilter]
2872
+ #
2873
+ # @see http://docs.aws.amazon.com/goto/WebAPI/transcribe-2017-10-26/Rule AWS API Documentation
2874
+ #
2875
+ class Rule < Struct.new(
2876
+ :non_talk_time_filter,
2877
+ :interruption_filter,
2878
+ :transcript_filter,
2879
+ :sentiment_filter,
2880
+ :unknown)
2881
+ SENSITIVE = []
2882
+ include Aws::Structure
2883
+ include Aws::Structure::Union
2884
+
2885
+ class NonTalkTimeFilter < Rule; end
2886
+ class InterruptionFilter < Rule; end
2887
+ class TranscriptFilter < Rule; end
2888
+ class SentimentFilter < Rule; end
2889
+ class Unknown < Rule; end
2890
+ end
2891
+
2892
+ # An object that enables you to specify a particular customer or agent
2893
+ # sentiment. If at least 50 percent of the conversation turns (the
2894
+ # back-and-forth between two speakers) in a specified time period match
2895
+ # the specified sentiment, Amazon Transcribe will consider the sentiment
2896
+ # a match.
2897
+ #
2898
+ # @note When making an API call, you may pass SentimentFilter
2899
+ # data as a hash:
2900
+ #
2901
+ # {
2902
+ # sentiments: ["POSITIVE"], # required, accepts POSITIVE, NEGATIVE, NEUTRAL, MIXED
2903
+ # absolute_time_range: {
2904
+ # start_time: 1,
2905
+ # end_time: 1,
2906
+ # first: 1,
2907
+ # last: 1,
2908
+ # },
2909
+ # relative_time_range: {
2910
+ # start_percentage: 1,
2911
+ # end_percentage: 1,
2912
+ # first: 1,
2913
+ # last: 1,
2914
+ # },
2915
+ # participant_role: "AGENT", # accepts AGENT, CUSTOMER
2916
+ # negate: false,
2917
+ # }
2918
+ #
2919
+ # @!attribute [rw] sentiments
2920
+ # An array that enables you to specify sentiments for the customer or
2921
+ # agent. You can specify one or more values.
2922
+ # @return [Array<String>]
2923
+ #
2924
+ # @!attribute [rw] absolute_time_range
2925
+ # The time range, measured in seconds, of the sentiment.
2926
+ # @return [Types::AbsoluteTimeRange]
2927
+ #
2928
+ # @!attribute [rw] relative_time_range
2929
+ # The time range, set in percentages, that correspond to proportion of
2930
+ # the call.
2931
+ # @return [Types::RelativeTimeRange]
2932
+ #
2933
+ # @!attribute [rw] participant_role
2934
+ # A value that determines whether the sentiment belongs to the
2935
+ # customer or the agent.
2936
+ # @return [String]
2937
+ #
2938
+ # @!attribute [rw] negate
2939
+ # Set to `TRUE` to look for sentiments that weren't specified in the
2940
+ # request.
2941
+ # @return [Boolean]
2942
+ #
2943
+ # @see http://docs.aws.amazon.com/goto/WebAPI/transcribe-2017-10-26/SentimentFilter AWS API Documentation
2944
+ #
2945
+ class SentimentFilter < Struct.new(
2946
+ :sentiments,
2947
+ :absolute_time_range,
2948
+ :relative_time_range,
2949
+ :participant_role,
2950
+ :negate)
2951
+ SENSITIVE = []
2952
+ include Aws::Structure
2953
+ end
2954
+
1794
2955
  # Provides optional settings for the `StartTranscriptionJob` operation.
1795
2956
  #
1796
2957
  # @note When making an API call, you may pass Settings
@@ -1891,16 +3052,170 @@ module Aws::TranscribeService
1891
3052
  include Aws::Structure
1892
3053
  end
1893
3054
 
3055
+ # @note When making an API call, you may pass StartCallAnalyticsJobRequest
3056
+ # data as a hash:
3057
+ #
3058
+ # {
3059
+ # call_analytics_job_name: "CallAnalyticsJobName", # required
3060
+ # media: { # required
3061
+ # media_file_uri: "Uri",
3062
+ # redacted_media_file_uri: "Uri",
3063
+ # },
3064
+ # output_location: "Uri",
3065
+ # output_encryption_kms_key_id: "KMSKeyId",
3066
+ # data_access_role_arn: "DataAccessRoleArn", # required
3067
+ # settings: {
3068
+ # vocabulary_name: "VocabularyName",
3069
+ # vocabulary_filter_name: "VocabularyFilterName",
3070
+ # vocabulary_filter_method: "remove", # accepts remove, mask, tag
3071
+ # language_model_name: "ModelName",
3072
+ # content_redaction: {
3073
+ # redaction_type: "PII", # required, accepts PII
3074
+ # redaction_output: "redacted", # required, accepts redacted, redacted_and_unredacted
3075
+ # },
3076
+ # language_options: ["af-ZA"], # accepts af-ZA, ar-AE, ar-SA, cy-GB, da-DK, de-CH, de-DE, en-AB, en-AU, en-GB, en-IE, en-IN, en-US, en-WL, es-ES, es-US, fa-IR, fr-CA, fr-FR, ga-IE, gd-GB, he-IL, hi-IN, id-ID, it-IT, ja-JP, ko-KR, ms-MY, nl-NL, pt-BR, pt-PT, ru-RU, ta-IN, te-IN, tr-TR, zh-CN, zh-TW, th-TH, en-ZA, en-NZ
3077
+ # },
3078
+ # channel_definitions: [
3079
+ # {
3080
+ # channel_id: 1,
3081
+ # participant_role: "AGENT", # accepts AGENT, CUSTOMER
3082
+ # },
3083
+ # ],
3084
+ # }
3085
+ #
3086
+ # @!attribute [rw] call_analytics_job_name
3087
+ # The name of the call analytics job. You can't use the string "."
3088
+ # or ".." by themselves as the job name. The name must also be
3089
+ # unique within an Amazon Web Services account. If you try to create a
3090
+ # call analytics job with the same name as a previous call analytics
3091
+ # job, you get a `ConflictException` error.
3092
+ # @return [String]
3093
+ #
3094
+ # @!attribute [rw] media
3095
+ # Describes the input media file in a transcription request.
3096
+ # @return [Types::Media]
3097
+ #
3098
+ # @!attribute [rw] output_location
3099
+ # The Amazon S3 location where the output of the call analytics job is
3100
+ # stored. You can provide the following location types to store the
3101
+ # output of call analytics job:
3102
+ #
3103
+ # * s3://DOC-EXAMPLE-BUCKET1
3104
+ #
3105
+ # If you specify a bucket, Amazon Transcribe saves the output of the
3106
+ # analytics job as a JSON file at the root level of the bucket.
3107
+ #
3108
+ # * s3://DOC-EXAMPLE-BUCKET1/folder/
3109
+ #
3110
+ # f you specify a path, Amazon Transcribe saves the output of the
3111
+ # analytics job as
3112
+ # s3://DOC-EXAMPLE-BUCKET1/folder/your-transcription-job-name.json
3113
+ #
3114
+ # If you specify a folder, you must provide a trailing slash.
3115
+ #
3116
+ # * s3://DOC-EXAMPLE-BUCKET1/folder/filename.json
3117
+ #
3118
+ # If you provide a path that has the filename specified, Amazon
3119
+ # Transcribe saves the output of the analytics job as
3120
+ # s3://DOC-EXAMPLEBUCKET1/folder/filename.json
3121
+ #
3122
+ # You can specify an Amazon Web Services Key Management Service (KMS)
3123
+ # key to encrypt the output of our analytics job using the
3124
+ # `OutputEncryptionKMSKeyId` parameter. If you don't specify a KMS
3125
+ # key, Amazon Transcribe uses the default Amazon S3 key for
3126
+ # server-side encryption of the analytics job output that is placed in
3127
+ # your S3 bucket.
3128
+ # @return [String]
3129
+ #
3130
+ # @!attribute [rw] output_encryption_kms_key_id
3131
+ # The Amazon Resource Name (ARN) of the Amazon Web Services Key
3132
+ # Management Service key used to encrypt the output of the call
3133
+ # analytics job. The user calling the operation must have permission
3134
+ # to use the specified KMS key.
3135
+ #
3136
+ # You use either of the following to identify an Amazon Web Services
3137
+ # KMS key in the current account:
3138
+ #
3139
+ # * KMS Key ID: "1234abcd-12ab-34cd-56ef-1234567890ab"
3140
+ #
3141
+ # * KMS Key Alias: "alias/ExampleAlias"
3142
+ #
3143
+ # You can use either of the following to identify a KMS key in the
3144
+ # current account or another account:
3145
+ #
3146
+ # * Amazon Resource Name (ARN) of a KMS key in the current account or
3147
+ # another account: "arn:aws:kms:region:account
3148
+ # ID:key/1234abcd-12ab-34cd-56ef1234567890ab"
3149
+ #
3150
+ # * ARN of a KMS Key Alias: "arn:aws:kms:region:account
3151
+ # ID:alias/ExampleAlias"
3152
+ #
3153
+ # If you don't specify an encryption key, the output of the call
3154
+ # analytics job is encrypted with the default Amazon S3 key (SSE-S3).
3155
+ #
3156
+ # If you specify a KMS key to encrypt your output, you must also
3157
+ # specify an output location in the `OutputLocation` parameter.
3158
+ # @return [String]
3159
+ #
3160
+ # @!attribute [rw] data_access_role_arn
3161
+ # The Amazon Resource Name (ARN) of a role that has access to the S3
3162
+ # bucket that contains your input files. Amazon Transcribe assumes
3163
+ # this role to read queued audio files. If you have specified an
3164
+ # output S3 bucket for your transcription results, this role should
3165
+ # have access to the output bucket as well.
3166
+ # @return [String]
3167
+ #
3168
+ # @!attribute [rw] settings
3169
+ # A `Settings` object that provides optional settings for a call
3170
+ # analytics job.
3171
+ # @return [Types::CallAnalyticsJobSettings]
3172
+ #
3173
+ # @!attribute [rw] channel_definitions
3174
+ # When you start a call analytics job, you must pass an array that
3175
+ # maps the agent and the customer to specific audio channels. The
3176
+ # values you can assign to a channel are 0 and 1. The agent and the
3177
+ # customer must each have their own channel. You can't assign more
3178
+ # than one channel to an agent or customer.
3179
+ # @return [Array<Types::ChannelDefinition>]
3180
+ #
3181
+ # @see http://docs.aws.amazon.com/goto/WebAPI/transcribe-2017-10-26/StartCallAnalyticsJobRequest AWS API Documentation
3182
+ #
3183
+ class StartCallAnalyticsJobRequest < Struct.new(
3184
+ :call_analytics_job_name,
3185
+ :media,
3186
+ :output_location,
3187
+ :output_encryption_kms_key_id,
3188
+ :data_access_role_arn,
3189
+ :settings,
3190
+ :channel_definitions)
3191
+ SENSITIVE = []
3192
+ include Aws::Structure
3193
+ end
3194
+
3195
+ # @!attribute [rw] call_analytics_job
3196
+ # An object containing the details of the asynchronous call analytics
3197
+ # job.
3198
+ # @return [Types::CallAnalyticsJob]
3199
+ #
3200
+ # @see http://docs.aws.amazon.com/goto/WebAPI/transcribe-2017-10-26/StartCallAnalyticsJobResponse AWS API Documentation
3201
+ #
3202
+ class StartCallAnalyticsJobResponse < Struct.new(
3203
+ :call_analytics_job)
3204
+ SENSITIVE = []
3205
+ include Aws::Structure
3206
+ end
3207
+
1894
3208
  # @note When making an API call, you may pass StartMedicalTranscriptionJobRequest
1895
3209
  # data as a hash:
1896
3210
  #
1897
3211
  # {
1898
3212
  # medical_transcription_job_name: "TranscriptionJobName", # required
1899
- # language_code: "af-ZA", # required, accepts af-ZA, ar-AE, ar-SA, cy-GB, da-DK, de-CH, de-DE, en-AB, en-AU, en-GB, en-IE, en-IN, en-US, en-WL, es-ES, es-US, fa-IR, fr-CA, fr-FR, ga-IE, gd-GB, he-IL, hi-IN, id-ID, it-IT, ja-JP, ko-KR, ms-MY, nl-NL, pt-BR, pt-PT, ru-RU, ta-IN, te-IN, tr-TR, zh-CN
3213
+ # language_code: "af-ZA", # required, accepts af-ZA, ar-AE, ar-SA, cy-GB, da-DK, de-CH, de-DE, en-AB, en-AU, en-GB, en-IE, en-IN, en-US, en-WL, es-ES, es-US, fa-IR, fr-CA, fr-FR, ga-IE, gd-GB, he-IL, hi-IN, id-ID, it-IT, ja-JP, ko-KR, ms-MY, nl-NL, pt-BR, pt-PT, ru-RU, ta-IN, te-IN, tr-TR, zh-CN, zh-TW, th-TH, en-ZA, en-NZ
1900
3214
  # media_sample_rate_hertz: 1,
1901
3215
  # media_format: "mp3", # accepts mp3, mp4, wav, flac, ogg, amr, webm
1902
3216
  # media: { # required
1903
3217
  # media_file_uri: "Uri",
3218
+ # redacted_media_file_uri: "Uri",
1904
3219
  # },
1905
3220
  # output_bucket_name: "OutputBucketName", # required
1906
3221
  # output_key: "OutputKey",
@@ -1916,14 +3231,21 @@ module Aws::TranscribeService
1916
3231
  # content_identification_type: "PHI", # accepts PHI
1917
3232
  # specialty: "PRIMARYCARE", # required, accepts PRIMARYCARE
1918
3233
  # type: "CONVERSATION", # required, accepts CONVERSATION, DICTATION
3234
+ # tags: [
3235
+ # {
3236
+ # key: "TagKey", # required
3237
+ # value: "TagValue", # required
3238
+ # },
3239
+ # ],
1919
3240
  # }
1920
3241
  #
1921
3242
  # @!attribute [rw] medical_transcription_job_name
1922
3243
  # The name of the medical transcription job. You can't use the
1923
3244
  # strings "`.`" or "`..`" by themselves as the job name. The name
1924
- # must also be unique within an AWS account. If you try to create a
1925
- # medical transcription job with the same name as a previous medical
1926
- # transcription job, you get a `ConflictException` error.
3245
+ # must also be unique within an Amazon Web Services account. If you
3246
+ # try to create a medical transcription job with the same name as a
3247
+ # previous medical transcription job, you get a `ConflictException`
3248
+ # error.
1927
3249
  # @return [String]
1928
3250
  #
1929
3251
  # @!attribute [rw] language_code
@@ -1963,8 +3285,8 @@ module Aws::TranscribeService
1963
3285
  # Transcribe Medical to put files in the bucket. For more information,
1964
3286
  # see [Permissions Required for IAM User Roles][1].
1965
3287
  #
1966
- # You can specify an AWS Key Management Service (KMS) key to encrypt
1967
- # the output of your transcription using the
3288
+ # You can specify an Amazon Web Services Key Management Service (KMS)
3289
+ # key to encrypt the output of your transcription using the
1968
3290
  # `OutputEncryptionKMSKeyId` parameter. If you don't specify a KMS
1969
3291
  # key, Amazon Transcribe Medical uses the default Amazon S3 key for
1970
3292
  # server-side encryption of transcripts that are placed in your S3
@@ -1999,10 +3321,10 @@ module Aws::TranscribeService
1999
3321
  # @return [String]
2000
3322
  #
2001
3323
  # @!attribute [rw] output_encryption_kms_key_id
2002
- # The Amazon Resource Name (ARN) of the AWS Key Management Service
2003
- # (KMS) key used to encrypt the output of the transcription job. The
2004
- # user calling the StartMedicalTranscriptionJob operation must have
2005
- # permission to use the specified KMS key.
3324
+ # The Amazon Resource Name (ARN) of the Amazon Web Services Key
3325
+ # Management Service (KMS) key used to encrypt the output of the
3326
+ # transcription job. The user calling the StartMedicalTranscriptionJob
3327
+ # operation must have permission to use the specified KMS key.
2006
3328
  #
2007
3329
  # You use either of the following to identify a KMS key in the current
2008
3330
  # account:
@@ -2048,9 +3370,13 @@ module Aws::TranscribeService
2048
3370
  # The type of speech in the input audio. `CONVERSATION` refers to
2049
3371
  # conversations between two or more speakers, e.g., a conversations
2050
3372
  # between doctors and patients. `DICTATION` refers to single-speaker
2051
- # dictated speech, e.g., for clinical notes.
3373
+ # dictated speech, such as clinical notes.
2052
3374
  # @return [String]
2053
3375
  #
3376
+ # @!attribute [rw] tags
3377
+ # Add tags to an Amazon Transcribe medical transcription job.
3378
+ # @return [Array<Types::Tag>]
3379
+ #
2054
3380
  # @see http://docs.aws.amazon.com/goto/WebAPI/transcribe-2017-10-26/StartMedicalTranscriptionJobRequest AWS API Documentation
2055
3381
  #
2056
3382
  class StartMedicalTranscriptionJobRequest < Struct.new(
@@ -2065,7 +3391,8 @@ module Aws::TranscribeService
2065
3391
  :settings,
2066
3392
  :content_identification_type,
2067
3393
  :specialty,
2068
- :type)
3394
+ :type,
3395
+ :tags)
2069
3396
  SENSITIVE = []
2070
3397
  include Aws::Structure
2071
3398
  end
@@ -2087,11 +3414,12 @@ module Aws::TranscribeService
2087
3414
  #
2088
3415
  # {
2089
3416
  # transcription_job_name: "TranscriptionJobName", # required
2090
- # language_code: "af-ZA", # accepts af-ZA, ar-AE, ar-SA, cy-GB, da-DK, de-CH, de-DE, en-AB, en-AU, en-GB, en-IE, en-IN, en-US, en-WL, es-ES, es-US, fa-IR, fr-CA, fr-FR, ga-IE, gd-GB, he-IL, hi-IN, id-ID, it-IT, ja-JP, ko-KR, ms-MY, nl-NL, pt-BR, pt-PT, ru-RU, ta-IN, te-IN, tr-TR, zh-CN
3417
+ # language_code: "af-ZA", # accepts af-ZA, ar-AE, ar-SA, cy-GB, da-DK, de-CH, de-DE, en-AB, en-AU, en-GB, en-IE, en-IN, en-US, en-WL, es-ES, es-US, fa-IR, fr-CA, fr-FR, ga-IE, gd-GB, he-IL, hi-IN, id-ID, it-IT, ja-JP, ko-KR, ms-MY, nl-NL, pt-BR, pt-PT, ru-RU, ta-IN, te-IN, tr-TR, zh-CN, zh-TW, th-TH, en-ZA, en-NZ
2091
3418
  # media_sample_rate_hertz: 1,
2092
3419
  # media_format: "mp3", # accepts mp3, mp4, wav, flac, ogg, amr, webm
2093
3420
  # media: { # required
2094
3421
  # media_file_uri: "Uri",
3422
+ # redacted_media_file_uri: "Uri",
2095
3423
  # },
2096
3424
  # output_bucket_name: "OutputBucketName",
2097
3425
  # output_key: "OutputKey",
@@ -2118,14 +3446,20 @@ module Aws::TranscribeService
2118
3446
  # redaction_output: "redacted", # required, accepts redacted, redacted_and_unredacted
2119
3447
  # },
2120
3448
  # identify_language: false,
2121
- # language_options: ["af-ZA"], # accepts af-ZA, ar-AE, ar-SA, cy-GB, da-DK, de-CH, de-DE, en-AB, en-AU, en-GB, en-IE, en-IN, en-US, en-WL, es-ES, es-US, fa-IR, fr-CA, fr-FR, ga-IE, gd-GB, he-IL, hi-IN, id-ID, it-IT, ja-JP, ko-KR, ms-MY, nl-NL, pt-BR, pt-PT, ru-RU, ta-IN, te-IN, tr-TR, zh-CN
3449
+ # language_options: ["af-ZA"], # accepts af-ZA, ar-AE, ar-SA, cy-GB, da-DK, de-CH, de-DE, en-AB, en-AU, en-GB, en-IE, en-IN, en-US, en-WL, es-ES, es-US, fa-IR, fr-CA, fr-FR, ga-IE, gd-GB, he-IL, hi-IN, id-ID, it-IT, ja-JP, ko-KR, ms-MY, nl-NL, pt-BR, pt-PT, ru-RU, ta-IN, te-IN, tr-TR, zh-CN, zh-TW, th-TH, en-ZA, en-NZ
3450
+ # tags: [
3451
+ # {
3452
+ # key: "TagKey", # required
3453
+ # value: "TagValue", # required
3454
+ # },
3455
+ # ],
2122
3456
  # }
2123
3457
  #
2124
3458
  # @!attribute [rw] transcription_job_name
2125
3459
  # The name of the job. You can't use the strings "`.`" or "`..`"
2126
3460
  # by themselves as the job name. The name must also be unique within
2127
- # an AWS account. If you try to create a transcription job with the
2128
- # same name as a previous transcription job, you get a
3461
+ # an Amazon Web Services account. If you try to create a transcription
3462
+ # job with the same name as a previous transcription job, you get a
2129
3463
  # `ConflictException` error.
2130
3464
  # @return [String]
2131
3465
  #
@@ -2133,7 +3467,7 @@ module Aws::TranscribeService
2133
3467
  # The language code for the language used in the input media file.
2134
3468
  #
2135
3469
  # To transcribe speech in Modern Standard Arabic (ar-SA), your audio
2136
- # or video file must be encoded at a sample rate of 16000 Hz or
3470
+ # or video file must be encoded at a sample rate of 16,000 Hz or
2137
3471
  # higher.
2138
3472
  # @return [String]
2139
3473
  #
@@ -2170,8 +3504,8 @@ module Aws::TranscribeService
2170
3504
  # Amazon Transcribe to put files in the bucket. For more information,
2171
3505
  # see [Permissions Required for IAM User Roles][1].
2172
3506
  #
2173
- # You can specify an AWS Key Management Service (KMS) key to encrypt
2174
- # the output of your transcription using the
3507
+ # You can specify an Amazon Web Services Key Management Service (KMS)
3508
+ # key to encrypt the output of your transcription using the
2175
3509
  # `OutputEncryptionKMSKeyId` parameter. If you don't specify a KMS
2176
3510
  # key, Amazon Transcribe uses the default Amazon S3 key for
2177
3511
  # server-side encryption of transcripts that are placed in your S3
@@ -2212,10 +3546,10 @@ module Aws::TranscribeService
2212
3546
  # @return [String]
2213
3547
  #
2214
3548
  # @!attribute [rw] output_encryption_kms_key_id
2215
- # The Amazon Resource Name (ARN) of the AWS Key Management Service
2216
- # (KMS) key used to encrypt the output of the transcription job. The
2217
- # user calling the `StartTranscriptionJob` operation must have
2218
- # permission to use the specified KMS key.
3549
+ # The Amazon Resource Name (ARN) of the Amazon Web Services Key
3550
+ # Management Service (KMS) key used to encrypt the output of the
3551
+ # transcription job. The user calling the `StartTranscriptionJob`
3552
+ # operation must have permission to use the specified KMS key.
2219
3553
  #
2220
3554
  # You can use either of the following to identify a KMS key in the
2221
3555
  # current account:
@@ -2276,8 +3610,16 @@ module Aws::TranscribeService
2276
3610
  # your collection of audio files. Automatic language identification
2277
3611
  # chooses a language that best matches the source audio from that
2278
3612
  # list.
3613
+ #
3614
+ # To transcribe speech in Modern Standard Arabic (ar-SA), your audio
3615
+ # or video file must be encoded at a sample rate of 16,000 Hz or
3616
+ # higher.
2279
3617
  # @return [Array<String>]
2280
3618
  #
3619
+ # @!attribute [rw] tags
3620
+ # Add tags to an Amazon Transcribe transcription job.
3621
+ # @return [Array<Types::Tag>]
3622
+ #
2281
3623
  # @see http://docs.aws.amazon.com/goto/WebAPI/transcribe-2017-10-26/StartTranscriptionJobRequest AWS API Documentation
2282
3624
  #
2283
3625
  class StartTranscriptionJobRequest < Struct.new(
@@ -2294,7 +3636,8 @@ module Aws::TranscribeService
2294
3636
  :job_execution_settings,
2295
3637
  :content_redaction,
2296
3638
  :identify_language,
2297
- :language_options)
3639
+ :language_options,
3640
+ :tags)
2298
3641
  SENSITIVE = []
2299
3642
  include Aws::Structure
2300
3643
  end
@@ -2311,6 +3654,75 @@ module Aws::TranscribeService
2311
3654
  include Aws::Structure
2312
3655
  end
2313
3656
 
3657
+ # A key:value pair that adds metadata to a resource used by Amazon
3658
+ # Transcribe. For example, a tag with the key:value pair
3659
+ # ‘Department’:’Sales’ might be added to a resource to indicate its use
3660
+ # by your organization's sales department.
3661
+ #
3662
+ # @note When making an API call, you may pass Tag
3663
+ # data as a hash:
3664
+ #
3665
+ # {
3666
+ # key: "TagKey", # required
3667
+ # value: "TagValue", # required
3668
+ # }
3669
+ #
3670
+ # @!attribute [rw] key
3671
+ # The first part of a key:value pair that forms a tag associated with
3672
+ # a given resource. For example, in the tag ‘Department’:’Sales’, the
3673
+ # key is 'Department'.
3674
+ # @return [String]
3675
+ #
3676
+ # @!attribute [rw] value
3677
+ # The second part of a key:value pair that forms a tag associated with
3678
+ # a given resource. For example, in the tag ‘Department’:’Sales’, the
3679
+ # value is 'Sales'.
3680
+ # @return [String]
3681
+ #
3682
+ # @see http://docs.aws.amazon.com/goto/WebAPI/transcribe-2017-10-26/Tag AWS API Documentation
3683
+ #
3684
+ class Tag < Struct.new(
3685
+ :key,
3686
+ :value)
3687
+ SENSITIVE = []
3688
+ include Aws::Structure
3689
+ end
3690
+
3691
+ # @note When making an API call, you may pass TagResourceRequest
3692
+ # data as a hash:
3693
+ #
3694
+ # {
3695
+ # resource_arn: "TranscribeArn", # required
3696
+ # tags: [ # required
3697
+ # {
3698
+ # key: "TagKey", # required
3699
+ # value: "TagValue", # required
3700
+ # },
3701
+ # ],
3702
+ # }
3703
+ #
3704
+ # @!attribute [rw] resource_arn
3705
+ # The Amazon Resource Name (ARN) of the Amazon Transcribe resource you
3706
+ # want to tag.
3707
+ # @return [String]
3708
+ #
3709
+ # @!attribute [rw] tags
3710
+ # The tags you are assigning to a given Amazon Transcribe resource.
3711
+ # @return [Array<Types::Tag>]
3712
+ #
3713
+ # @see http://docs.aws.amazon.com/goto/WebAPI/transcribe-2017-10-26/TagResourceRequest AWS API Documentation
3714
+ #
3715
+ class TagResourceRequest < Struct.new(
3716
+ :resource_arn,
3717
+ :tags)
3718
+ SENSITIVE = []
3719
+ include Aws::Structure
3720
+ end
3721
+
3722
+ # @see http://docs.aws.amazon.com/goto/WebAPI/transcribe-2017-10-26/TagResourceResponse AWS API Documentation
3723
+ #
3724
+ class TagResourceResponse < Aws::EmptyStructure; end
3725
+
2314
3726
  # Identifies the location of a transcription.
2315
3727
  #
2316
3728
  # @!attribute [rw] transcript_file_uri
@@ -2342,6 +3754,79 @@ module Aws::TranscribeService
2342
3754
  include Aws::Structure
2343
3755
  end
2344
3756
 
3757
+ # Matches the output of the transcription to either the specific phrases
3758
+ # that you specify, or the intent of the phrases that you specify.
3759
+ #
3760
+ # @note When making an API call, you may pass TranscriptFilter
3761
+ # data as a hash:
3762
+ #
3763
+ # {
3764
+ # transcript_filter_type: "EXACT", # required, accepts EXACT
3765
+ # absolute_time_range: {
3766
+ # start_time: 1,
3767
+ # end_time: 1,
3768
+ # first: 1,
3769
+ # last: 1,
3770
+ # },
3771
+ # relative_time_range: {
3772
+ # start_percentage: 1,
3773
+ # end_percentage: 1,
3774
+ # first: 1,
3775
+ # last: 1,
3776
+ # },
3777
+ # participant_role: "AGENT", # accepts AGENT, CUSTOMER
3778
+ # negate: false,
3779
+ # targets: ["NonEmptyString"], # required
3780
+ # }
3781
+ #
3782
+ # @!attribute [rw] transcript_filter_type
3783
+ # Matches the phrase to the transcription output in a word for word
3784
+ # fashion. For example, if you specify the phrase "I want to speak to
3785
+ # the manager." Amazon Transcribe attempts to match that specific
3786
+ # phrase to the transcription.
3787
+ # @return [String]
3788
+ #
3789
+ # @!attribute [rw] absolute_time_range
3790
+ # A time range, set in seconds, between two points in the call.
3791
+ # @return [Types::AbsoluteTimeRange]
3792
+ #
3793
+ # @!attribute [rw] relative_time_range
3794
+ # An object that allows percentages to specify the proportion of the
3795
+ # call where you would like to apply a filter. For example, you can
3796
+ # specify the first half of the call. You can also specify the period
3797
+ # of time between halfway through to three-quarters of the way through
3798
+ # the call. Because the length of conversation can vary between calls,
3799
+ # you can apply relative time ranges across all calls.
3800
+ # @return [Types::RelativeTimeRange]
3801
+ #
3802
+ # @!attribute [rw] participant_role
3803
+ # Determines whether the customer or the agent is speaking the phrases
3804
+ # that you've specified.
3805
+ # @return [String]
3806
+ #
3807
+ # @!attribute [rw] negate
3808
+ # If `TRUE`, the rule that you specify is applied to everything except
3809
+ # for the phrases that you specify.
3810
+ # @return [Boolean]
3811
+ #
3812
+ # @!attribute [rw] targets
3813
+ # The phrases that you're specifying for the transcript filter to
3814
+ # match.
3815
+ # @return [Array<String>]
3816
+ #
3817
+ # @see http://docs.aws.amazon.com/goto/WebAPI/transcribe-2017-10-26/TranscriptFilter AWS API Documentation
3818
+ #
3819
+ class TranscriptFilter < Struct.new(
3820
+ :transcript_filter_type,
3821
+ :absolute_time_range,
3822
+ :relative_time_range,
3823
+ :participant_role,
3824
+ :negate,
3825
+ :targets)
3826
+ SENSITIVE = []
3827
+ include Aws::Structure
3828
+ end
3829
+
2345
3830
  # Describes an asynchronous transcription job that was created with the
2346
3831
  # `StartTranscriptionJob` operation.
2347
3832
  #
@@ -2375,7 +3860,7 @@ module Aws::TranscribeService
2375
3860
  # @return [Types::Transcript]
2376
3861
  #
2377
3862
  # @!attribute [rw] start_time
2378
- # A timestamp that shows with the job was started processing.
3863
+ # A timestamp that shows when the job started processing.
2379
3864
  # @return [Time]
2380
3865
  #
2381
3866
  # @!attribute [rw] creation_time
@@ -2383,7 +3868,7 @@ module Aws::TranscribeService
2383
3868
  # @return [Time]
2384
3869
  #
2385
3870
  # @!attribute [rw] completion_time
2386
- # A timestamp that shows when the job was completed.
3871
+ # A timestamp that shows when the job completed.
2387
3872
  # @return [Time]
2388
3873
  #
2389
3874
  # @!attribute [rw] failure_reason
@@ -2404,7 +3889,7 @@ module Aws::TranscribeService
2404
3889
  #
2405
3890
  # * `Invalid sample rate for audio file` - The sample rate specified
2406
3891
  # in the `MediaSampleRateHertz` of the request isn't valid. The
2407
- # sample rate must be between 8000 and 48000 Hertz.
3892
+ # sample rate must be between 8,000 and 48,000 Hertz.
2408
3893
  #
2409
3894
  # * `The sample rate provided does not match the detected sample rate`
2410
3895
  # - The sample rate in the audio file doesn't match the sample rate
@@ -2465,6 +3950,10 @@ module Aws::TranscribeService
2465
3950
  # language it identified.
2466
3951
  # @return [Float]
2467
3952
  #
3953
+ # @!attribute [rw] tags
3954
+ # A key:value pair assigned to a given transcription job.
3955
+ # @return [Array<Types::Tag>]
3956
+ #
2468
3957
  # @see http://docs.aws.amazon.com/goto/WebAPI/transcribe-2017-10-26/TranscriptionJob AWS API Documentation
2469
3958
  #
2470
3959
  class TranscriptionJob < Struct.new(
@@ -2485,7 +3974,8 @@ module Aws::TranscribeService
2485
3974
  :content_redaction,
2486
3975
  :identify_language,
2487
3976
  :language_options,
2488
- :identified_language_score)
3977
+ :identified_language_score,
3978
+ :tags)
2489
3979
  SENSITIVE = []
2490
3980
  include Aws::Structure
2491
3981
  end
@@ -2575,12 +4065,158 @@ module Aws::TranscribeService
2575
4065
  include Aws::Structure
2576
4066
  end
2577
4067
 
4068
+ # @note When making an API call, you may pass UntagResourceRequest
4069
+ # data as a hash:
4070
+ #
4071
+ # {
4072
+ # resource_arn: "TranscribeArn", # required
4073
+ # tag_keys: ["TagKey"], # required
4074
+ # }
4075
+ #
4076
+ # @!attribute [rw] resource_arn
4077
+ # The Amazon Resource Name (ARN) of the Amazon Transcribe resource you
4078
+ # want to remove tags from.
4079
+ # @return [String]
4080
+ #
4081
+ # @!attribute [rw] tag_keys
4082
+ # A list of tag keys you want to remove from a specified Amazon
4083
+ # Transcribe resource.
4084
+ # @return [Array<String>]
4085
+ #
4086
+ # @see http://docs.aws.amazon.com/goto/WebAPI/transcribe-2017-10-26/UntagResourceRequest AWS API Documentation
4087
+ #
4088
+ class UntagResourceRequest < Struct.new(
4089
+ :resource_arn,
4090
+ :tag_keys)
4091
+ SENSITIVE = []
4092
+ include Aws::Structure
4093
+ end
4094
+
4095
+ # @see http://docs.aws.amazon.com/goto/WebAPI/transcribe-2017-10-26/UntagResourceResponse AWS API Documentation
4096
+ #
4097
+ class UntagResourceResponse < Aws::EmptyStructure; end
4098
+
4099
+ # @note When making an API call, you may pass UpdateCallAnalyticsCategoryRequest
4100
+ # data as a hash:
4101
+ #
4102
+ # {
4103
+ # category_name: "CategoryName", # required
4104
+ # rules: [ # required
4105
+ # {
4106
+ # non_talk_time_filter: {
4107
+ # threshold: 1,
4108
+ # absolute_time_range: {
4109
+ # start_time: 1,
4110
+ # end_time: 1,
4111
+ # first: 1,
4112
+ # last: 1,
4113
+ # },
4114
+ # relative_time_range: {
4115
+ # start_percentage: 1,
4116
+ # end_percentage: 1,
4117
+ # first: 1,
4118
+ # last: 1,
4119
+ # },
4120
+ # negate: false,
4121
+ # },
4122
+ # interruption_filter: {
4123
+ # threshold: 1,
4124
+ # participant_role: "AGENT", # accepts AGENT, CUSTOMER
4125
+ # absolute_time_range: {
4126
+ # start_time: 1,
4127
+ # end_time: 1,
4128
+ # first: 1,
4129
+ # last: 1,
4130
+ # },
4131
+ # relative_time_range: {
4132
+ # start_percentage: 1,
4133
+ # end_percentage: 1,
4134
+ # first: 1,
4135
+ # last: 1,
4136
+ # },
4137
+ # negate: false,
4138
+ # },
4139
+ # transcript_filter: {
4140
+ # transcript_filter_type: "EXACT", # required, accepts EXACT
4141
+ # absolute_time_range: {
4142
+ # start_time: 1,
4143
+ # end_time: 1,
4144
+ # first: 1,
4145
+ # last: 1,
4146
+ # },
4147
+ # relative_time_range: {
4148
+ # start_percentage: 1,
4149
+ # end_percentage: 1,
4150
+ # first: 1,
4151
+ # last: 1,
4152
+ # },
4153
+ # participant_role: "AGENT", # accepts AGENT, CUSTOMER
4154
+ # negate: false,
4155
+ # targets: ["NonEmptyString"], # required
4156
+ # },
4157
+ # sentiment_filter: {
4158
+ # sentiments: ["POSITIVE"], # required, accepts POSITIVE, NEGATIVE, NEUTRAL, MIXED
4159
+ # absolute_time_range: {
4160
+ # start_time: 1,
4161
+ # end_time: 1,
4162
+ # first: 1,
4163
+ # last: 1,
4164
+ # },
4165
+ # relative_time_range: {
4166
+ # start_percentage: 1,
4167
+ # end_percentage: 1,
4168
+ # first: 1,
4169
+ # last: 1,
4170
+ # },
4171
+ # participant_role: "AGENT", # accepts AGENT, CUSTOMER
4172
+ # negate: false,
4173
+ # },
4174
+ # },
4175
+ # ],
4176
+ # }
4177
+ #
4178
+ # @!attribute [rw] category_name
4179
+ # The name of the analytics category to update. The name is case
4180
+ # sensitive. If you try to update a call analytics category with the
4181
+ # same name as a previous category you will receive a
4182
+ # `ConflictException` error.
4183
+ # @return [String]
4184
+ #
4185
+ # @!attribute [rw] rules
4186
+ # The rules used for the updated analytics category. The rules that
4187
+ # you provide in this field replace the ones that are currently being
4188
+ # used.
4189
+ # @return [Array<Types::Rule>]
4190
+ #
4191
+ # @see http://docs.aws.amazon.com/goto/WebAPI/transcribe-2017-10-26/UpdateCallAnalyticsCategoryRequest AWS API Documentation
4192
+ #
4193
+ class UpdateCallAnalyticsCategoryRequest < Struct.new(
4194
+ :category_name,
4195
+ :rules)
4196
+ SENSITIVE = []
4197
+ include Aws::Structure
4198
+ end
4199
+
4200
+ # @!attribute [rw] category_properties
4201
+ # The attributes describing the analytics category. You can see
4202
+ # information such as the rules that you've used to update the
4203
+ # category and when the category was originally created.
4204
+ # @return [Types::CategoryProperties]
4205
+ #
4206
+ # @see http://docs.aws.amazon.com/goto/WebAPI/transcribe-2017-10-26/UpdateCallAnalyticsCategoryResponse AWS API Documentation
4207
+ #
4208
+ class UpdateCallAnalyticsCategoryResponse < Struct.new(
4209
+ :category_properties)
4210
+ SENSITIVE = []
4211
+ include Aws::Structure
4212
+ end
4213
+
2578
4214
  # @note When making an API call, you may pass UpdateMedicalVocabularyRequest
2579
4215
  # data as a hash:
2580
4216
  #
2581
4217
  # {
2582
4218
  # vocabulary_name: "VocabularyName", # required
2583
- # language_code: "af-ZA", # required, accepts af-ZA, ar-AE, ar-SA, cy-GB, da-DK, de-CH, de-DE, en-AB, en-AU, en-GB, en-IE, en-IN, en-US, en-WL, es-ES, es-US, fa-IR, fr-CA, fr-FR, ga-IE, gd-GB, he-IL, hi-IN, id-ID, it-IT, ja-JP, ko-KR, ms-MY, nl-NL, pt-BR, pt-PT, ru-RU, ta-IN, te-IN, tr-TR, zh-CN
4219
+ # language_code: "af-ZA", # required, accepts af-ZA, ar-AE, ar-SA, cy-GB, da-DK, de-CH, de-DE, en-AB, en-AU, en-GB, en-IE, en-IN, en-US, en-WL, es-ES, es-US, fa-IR, fr-CA, fr-FR, ga-IE, gd-GB, he-IL, hi-IN, id-ID, it-IT, ja-JP, ko-KR, ms-MY, nl-NL, pt-BR, pt-PT, ru-RU, ta-IN, te-IN, tr-TR, zh-CN, zh-TW, th-TH, en-ZA, en-NZ
2584
4220
  # vocabulary_file_uri: "Uri",
2585
4221
  # }
2586
4222
  #
@@ -2597,8 +4233,8 @@ module Aws::TranscribeService
2597
4233
  # @return [String]
2598
4234
  #
2599
4235
  # @!attribute [rw] vocabulary_file_uri
2600
- # The location in Amazon S3 of the text file that contains the you use
2601
- # for your custom vocabulary. The URI must be in the same AWS Region
4236
+ # The location in Amazon S3 of the text file that contains your custom
4237
+ # vocabulary. The URI must be in the same Amazon Web Services Region
2602
4238
  # as the resource that you are calling. The following is the format
2603
4239
  # for a URI:
2604
4240
  #
@@ -2618,8 +4254,8 @@ module Aws::TranscribeService
2618
4254
  #
2619
4255
  #
2620
4256
  #
2621
- # [1]: http://docs.aws.amazon.com/AmazonS3/latest/dev/UsingMetadata.html#object-keys
2622
- # [2]: http://docs.aws.amazon.com/transcribe/latest/dg/how-it-works.html#how-vocabulary
4257
+ # [1]: https://docs.aws.amazon.com/AmazonS3/latest/dev/UsingMetadata.html#object-keys
4258
+ # [2]: https://docs.aws.amazon.com/transcribe/latest/dg/how-it-works.html#how-vocabulary
2623
4259
  # @return [String]
2624
4260
  #
2625
4261
  # @see http://docs.aws.amazon.com/goto/WebAPI/transcribe-2017-10-26/UpdateMedicalVocabularyRequest AWS API Documentation
@@ -2745,7 +4381,7 @@ module Aws::TranscribeService
2745
4381
  #
2746
4382
  # {
2747
4383
  # vocabulary_name: "VocabularyName", # required
2748
- # language_code: "af-ZA", # required, accepts af-ZA, ar-AE, ar-SA, cy-GB, da-DK, de-CH, de-DE, en-AB, en-AU, en-GB, en-IE, en-IN, en-US, en-WL, es-ES, es-US, fa-IR, fr-CA, fr-FR, ga-IE, gd-GB, he-IL, hi-IN, id-ID, it-IT, ja-JP, ko-KR, ms-MY, nl-NL, pt-BR, pt-PT, ru-RU, ta-IN, te-IN, tr-TR, zh-CN
4384
+ # language_code: "af-ZA", # required, accepts af-ZA, ar-AE, ar-SA, cy-GB, da-DK, de-CH, de-DE, en-AB, en-AU, en-GB, en-IE, en-IN, en-US, en-WL, es-ES, es-US, fa-IR, fr-CA, fr-FR, ga-IE, gd-GB, he-IL, hi-IN, id-ID, it-IT, ja-JP, ko-KR, ms-MY, nl-NL, pt-BR, pt-PT, ru-RU, ta-IN, te-IN, tr-TR, zh-CN, zh-TW, th-TH, en-ZA, en-NZ
2749
4385
  # phrases: ["Phrase"],
2750
4386
  # vocabulary_file_uri: "Uri",
2751
4387
  # }
@@ -2758,7 +4394,7 @@ module Aws::TranscribeService
2758
4394
  #
2759
4395
  # @!attribute [rw] language_code
2760
4396
  # The language code of the vocabulary entries. For a list of languages
2761
- # and their corresponding language codes, see what-is-transcribe.
4397
+ # and their corresponding language codes, see transcribe-whatis.
2762
4398
  # @return [String]
2763
4399
  #
2764
4400
  # @!attribute [rw] phrases
@@ -2780,8 +4416,8 @@ module Aws::TranscribeService
2780
4416
  #
2781
4417
  #
2782
4418
  #
2783
- # [1]: http://docs.aws.amazon.com/AmazonS3/latest/dev/UsingMetadata.html#object-keys
2784
- # [2]: http://docs.aws.amazon.com/transcribe/latest/dg/how-it-works.html#how-vocabulary
4419
+ # [1]: https://docs.aws.amazon.com/AmazonS3/latest/dev/UsingMetadata.html#object-keys
4420
+ # [2]: https://docs.aws.amazon.com/transcribe/latest/dg/how-it-works.html#how-vocabulary
2785
4421
  # @return [String]
2786
4422
  #
2787
4423
  # @see http://docs.aws.amazon.com/goto/WebAPI/transcribe-2017-10-26/UpdateVocabularyRequest AWS API Documentation