aws-sdk-chimesdkmediapipelines 1.3.0 → 1.4.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,379 @@
10
10
  module Aws::ChimeSDKMediaPipelines
11
11
  module Types
12
12
 
13
+ # A structure that contains the configuration settings for an Amazon
14
+ # Transcribe call analytics processor.
15
+ #
16
+ # @!attribute [rw] language_code
17
+ # The language code in the configuration.
18
+ # @return [String]
19
+ #
20
+ # @!attribute [rw] vocabulary_name
21
+ # Specifies the name of the custom vocabulary to use when processing a
22
+ # transcription. Note that vocabulary names are case sensitive.
23
+ #
24
+ # If the language of the specified custom vocabulary doesn't match
25
+ # the language identified in your media, the custom vocabulary is not
26
+ # applied to your transcription.
27
+ #
28
+ # For more information, see [Custom vocabularies][1] in the *Amazon
29
+ # Transcribe Developer Guide*.
30
+ #
31
+ # Length Constraints: Minimum length of 1. Maximum length of 200.
32
+ #
33
+ #
34
+ #
35
+ # [1]: https://docs.aws.amazon.com/transcribe/latest/dg/custom-vocabulary.html
36
+ # @return [String]
37
+ #
38
+ # @!attribute [rw] vocabulary_filter_name
39
+ # Specifies the name of the custom vocabulary filter to use when
40
+ # processing a transcription. Note that vocabulary filter names are
41
+ # case sensitive.
42
+ #
43
+ # If the language of the specified custom vocabulary filter doesn't
44
+ # match the language identified in your media, the vocabulary filter
45
+ # is not applied to your transcription.
46
+ #
47
+ # For more information, see [Using vocabulary filtering with unwanted
48
+ # words][1] in the *Amazon Transcribe Developer Guide*.
49
+ #
50
+ # Length Constraints: Minimum length of 1. Maximum length of 200.
51
+ #
52
+ #
53
+ #
54
+ # [1]: https://docs.aws.amazon.com/transcribe/latest/dg/vocabulary-filtering.html
55
+ # @return [String]
56
+ #
57
+ # @!attribute [rw] vocabulary_filter_method
58
+ # Specifies how to apply a vocabulary filter to a transcript.
59
+ #
60
+ # To replace words with *******, choose `mask`.
61
+ #
62
+ # To delete words, choose `remove`.
63
+ #
64
+ # To flag words without changing them, choose `tag`.
65
+ # @return [String]
66
+ #
67
+ # @!attribute [rw] language_model_name
68
+ # Specifies the name of the custom language model to use when
69
+ # processing a transcription. Note that language model names are case
70
+ # sensitive.
71
+ #
72
+ # The language of the specified language model must match the language
73
+ # code specified in the transcription request. If the languages don't
74
+ # match, the custom language model isn't applied. Language mismatches
75
+ # don't generate errors or warnings.
76
+ #
77
+ # For more information, see [Custom language models][1] in the *Amazon
78
+ # Transcribe Developer Guide*.
79
+ #
80
+ #
81
+ #
82
+ # [1]: https://docs.aws.amazon.com/transcribe/latest/dg/custom-language-models.html
83
+ # @return [String]
84
+ #
85
+ # @!attribute [rw] enable_partial_results_stabilization
86
+ # Enables partial result stabilization for your transcription. Partial
87
+ # result stabilization can reduce latency in your output, but may
88
+ # impact accuracy. For more information, see [Partial-result
89
+ # stabilization][1] in the *Amazon Transcribe Developer Guide*.
90
+ #
91
+ #
92
+ #
93
+ # [1]: https://docs.aws.amazon.com/transcribe/latest/dg/streaming.html#streaming-partial-result-stabilization
94
+ # @return [Boolean]
95
+ #
96
+ # @!attribute [rw] partial_results_stability
97
+ # Specifies the level of stability to use when you enable partial
98
+ # results stabilization (`EnablePartialResultsStabilization`).
99
+ #
100
+ # Low stability provides the highest accuracy. High stability
101
+ # transcribes faster, but with slightly lower accuracy.
102
+ #
103
+ # For more information, see [Partial-result stabilization][1] in the
104
+ # *Amazon Transcribe Developer Guide*.
105
+ #
106
+ #
107
+ #
108
+ # [1]: https://docs.aws.amazon.com/transcribe/latest/dg/streaming.html#streaming-partial-result-stabilization
109
+ # @return [String]
110
+ #
111
+ # @!attribute [rw] content_identification_type
112
+ # Labels all personally identifiable information (PII) identified in
113
+ # your transcript.
114
+ #
115
+ # Content identification is performed at the segment level; PII
116
+ # specified in `PiiEntityTypes` is flagged upon complete transcription
117
+ # of an audio segment.
118
+ #
119
+ # You can’t set `ContentIdentificationType` and `ContentRedactionType`
120
+ # in the same request. If you do, your request returns a
121
+ # `BadRequestException`.
122
+ #
123
+ # For more information, see [Redacting or identifying personally
124
+ # identifiable information][1] in the *Amazon Transcribe Developer
125
+ # Guide*.
126
+ #
127
+ #
128
+ #
129
+ # [1]: https://docs.aws.amazon.com/transcribe/latest/dg/pii-redaction.html
130
+ # @return [String]
131
+ #
132
+ # @!attribute [rw] content_redaction_type
133
+ # Redacts all personally identifiable information (PII) identified in
134
+ # your transcript.
135
+ #
136
+ # Content redaction is performed at the segment level; PII specified
137
+ # in `PiiEntityTypes` is redacted upon complete transcription of an
138
+ # audio segment.
139
+ #
140
+ # You can’t set `ContentRedactionType` and `ContentIdentificationType`
141
+ # in the same request. If you do, your request returns a
142
+ # `BadRequestException`.
143
+ #
144
+ # For more information, see [Redacting or identifying personally
145
+ # identifiable information][1] in the *Amazon Transcribe Developer
146
+ # Guide*.
147
+ #
148
+ #
149
+ #
150
+ # [1]: https://docs.aws.amazon.com/transcribe/latest/dg/pii-redaction.html
151
+ # @return [String]
152
+ #
153
+ # @!attribute [rw] pii_entity_types
154
+ # Specifies the types of personally identifiable information (PII) to
155
+ # redact from a transcript. You can include as many types as you'd
156
+ # like, or you can select `ALL`.
157
+ #
158
+ # To include `PiiEntityTypes` in your Call Analytics request, you must
159
+ # also include `ContentIdentificationType` or `ContentRedactionType`,
160
+ # but you can't include both.
161
+ #
162
+ # Values must be comma-separated and can include: `ADDRESS`,
163
+ # `BANK_ACCOUNT_NUMBER`, `BANK_ROUTING`, `CREDIT_DEBIT_CVV`,
164
+ # `CREDIT_DEBIT_EXPIRY`, `CREDIT_DEBIT_NUMBER`, `EMAIL`, `NAME`,
165
+ # `PHONE`, `PIN`, `SSN`, or `ALL`.
166
+ #
167
+ # Length Constraints: Minimum length of 1. Maximum length of 300.
168
+ # @return [String]
169
+ #
170
+ # @!attribute [rw] filter_partial_results
171
+ # If true, `UtteranceEvents` with `IsPartial: true` are filtered out
172
+ # of the insights target.
173
+ # @return [Boolean]
174
+ #
175
+ # @!attribute [rw] post_call_analytics_settings
176
+ # The settings for a post-call analysis task in an analytics
177
+ # configuration.
178
+ # @return [Types::PostCallAnalyticsSettings]
179
+ #
180
+ # @!attribute [rw] call_analytics_stream_categories
181
+ # By default, all `CategoryEvents` will be sent to the insights
182
+ # target. If this parameter is specified, only included categories
183
+ # will be sent to the insights target.
184
+ # @return [Array<String>]
185
+ #
186
+ # @see http://docs.aws.amazon.com/goto/WebAPI/chime-sdk-media-pipelines-2021-07-15/AmazonTranscribeCallAnalyticsProcessorConfiguration AWS API Documentation
187
+ #
188
+ class AmazonTranscribeCallAnalyticsProcessorConfiguration < Struct.new(
189
+ :language_code,
190
+ :vocabulary_name,
191
+ :vocabulary_filter_name,
192
+ :vocabulary_filter_method,
193
+ :language_model_name,
194
+ :enable_partial_results_stabilization,
195
+ :partial_results_stability,
196
+ :content_identification_type,
197
+ :content_redaction_type,
198
+ :pii_entity_types,
199
+ :filter_partial_results,
200
+ :post_call_analytics_settings,
201
+ :call_analytics_stream_categories)
202
+ SENSITIVE = []
203
+ include Aws::Structure
204
+ end
205
+
206
+ # A structure that contains the configuration settings for an Amazon
207
+ # Transcribe processor.
208
+ #
209
+ # @!attribute [rw] language_code
210
+ # The language code that represents the language spoken in your audio.
211
+ #
212
+ # If you're unsure of the language spoken in your audio, consider
213
+ # using `IdentifyLanguage` to enable automatic language
214
+ # identification.
215
+ #
216
+ # For a list of languages that real-time Call Analytics supports, see
217
+ # the [Supported languages table][1] in the *Amazon Transcribe
218
+ # Developer Guide*.
219
+ #
220
+ #
221
+ #
222
+ # [1]: https://docs.aws.amazon.com/transcribe/latest/dg/supported-languages.html
223
+ # @return [String]
224
+ #
225
+ # @!attribute [rw] vocabulary_name
226
+ # The name of the custom vocabulary that you specified in your Call
227
+ # Analytics request.
228
+ #
229
+ # Length Constraints: Minimum length of 1. Maximum length of 200.
230
+ # @return [String]
231
+ #
232
+ # @!attribute [rw] vocabulary_filter_name
233
+ # The name of the custom vocabulary filter that you specified in your
234
+ # Call Analytics request.
235
+ #
236
+ # Length Constraints: Minimum length of 1. Maximum length of 200.
237
+ # @return [String]
238
+ #
239
+ # @!attribute [rw] vocabulary_filter_method
240
+ # The vocabulary filtering method used in your Call Analytics
241
+ # transcription.
242
+ # @return [String]
243
+ #
244
+ # @!attribute [rw] show_speaker_label
245
+ # Enables speaker partitioning (diarization) in your transcription
246
+ # output. Speaker partitioning labels the speech from individual
247
+ # speakers in your media file.
248
+ #
249
+ # For more information, see [Partitioning speakers (diarization)][1]
250
+ # in the *Amazon Transcribe Developer Guide*.
251
+ #
252
+ #
253
+ #
254
+ # [1]: https://docs.aws.amazon.com/transcribe/latest/dg/diarization.html
255
+ # @return [Boolean]
256
+ #
257
+ # @!attribute [rw] enable_partial_results_stabilization
258
+ # Enables partial result stabilization for your transcription. Partial
259
+ # result stabilization can reduce latency in your output, but may
260
+ # impact accuracy.
261
+ #
262
+ # For more information, see [Partial-result stabilization][1] in the
263
+ # *Amazon Transcribe Developer Guide*.
264
+ #
265
+ #
266
+ #
267
+ # [1]: https://docs.aws.amazon.com/transcribe/latest/dg/streaming.html#streaming-partial-result-stabilization
268
+ # @return [Boolean]
269
+ #
270
+ # @!attribute [rw] partial_results_stability
271
+ # The level of stability to use when you enable partial results
272
+ # stabilization (`EnablePartialResultsStabilization`).
273
+ #
274
+ # Low stability provides the highest accuracy. High stability
275
+ # transcribes faster, but with slightly lower accuracy.
276
+ #
277
+ # For more information, see [Partial-result stabilization][1] in the
278
+ # *Amazon Transcribe Developer Guide*.
279
+ #
280
+ #
281
+ #
282
+ # [1]: https://docs.aws.amazon.com/transcribe/latest/dg/streaming.html#streaming-partial-result-stabilization
283
+ # @return [String]
284
+ #
285
+ # @!attribute [rw] content_identification_type
286
+ # Labels all personally identifiable information (PII) identified in
287
+ # your transcript.
288
+ #
289
+ # Content identification is performed at the segment level; PII
290
+ # specified in `PiiEntityTypes` is flagged upon complete transcription
291
+ # of an audio segment.
292
+ #
293
+ # You can’t set `ContentIdentificationType` and `ContentRedactionType`
294
+ # in the same request. If you set both, your request returns a
295
+ # `BadRequestException`.
296
+ #
297
+ # For more information, see [Redacting or identifying personally
298
+ # identifiable information][1] in the *Amazon Transcribe Developer
299
+ # Guide*.
300
+ #
301
+ #
302
+ #
303
+ # [1]: https://docs.aws.amazon.com/transcribe/latest/dg/pii-redaction.html
304
+ # @return [String]
305
+ #
306
+ # @!attribute [rw] content_redaction_type
307
+ # Redacts all personally identifiable information (PII) identified in
308
+ # your transcript.
309
+ #
310
+ # Content redaction is performed at the segment level; PII specified
311
+ # in PiiEntityTypes is redacted upon complete transcription of an
312
+ # audio segment.
313
+ #
314
+ # You can’t set ContentRedactionType and ContentIdentificationType in
315
+ # the same request. If you set both, your request returns a
316
+ # `BadRequestException`.
317
+ #
318
+ # For more information, see [Redacting or identifying personally
319
+ # identifiable information][1] in the *Amazon Transcribe Developer
320
+ # Guide*.
321
+ #
322
+ #
323
+ #
324
+ # [1]: https://docs.aws.amazon.com/transcribe/latest/dg/pii-redaction.html
325
+ # @return [String]
326
+ #
327
+ # @!attribute [rw] pii_entity_types
328
+ # The types of personally identifiable information (PII) to redact
329
+ # from a transcript. You can include as many types as you'd like, or
330
+ # you can select `ALL`.
331
+ #
332
+ # To include `PiiEntityTypes` in your Call Analytics request, you must
333
+ # also include `ContentIdentificationType` or `ContentRedactionType`,
334
+ # but you can't include both.
335
+ #
336
+ # Values must be comma-separated and can include: `ADDRESS`,
337
+ # `BANK_ACCOUNT_NUMBER`, `BANK_ROUTING`, `CREDIT_DEBIT_CVV`,
338
+ # `CREDIT_DEBIT_EXPIRY`, `CREDIT_DEBIT_NUMBER`, `EMAIL`, `NAME`,
339
+ # `PHONE`, `PIN`, `SSN`, or `ALL`.
340
+ #
341
+ # Length Constraints: Minimum length of 1. Maximum length of 300.
342
+ # @return [String]
343
+ #
344
+ # @!attribute [rw] language_model_name
345
+ # The name of the custom language model that you want to use when
346
+ # processing your transcription. Note that language model names are
347
+ # case sensitive.
348
+ #
349
+ # The language of the specified language model must match the language
350
+ # code you specify in your transcription request. If the languages
351
+ # don't match, the custom language model isn't applied. There are no
352
+ # errors or warnings associated with a language mismatch.
353
+ #
354
+ # For more information, see [Custom language models][1] in the *Amazon
355
+ # Transcribe Developer Guide*.
356
+ #
357
+ #
358
+ #
359
+ # [1]: https://docs.aws.amazon.com/transcribe/latest/dg/custom-language-models.html
360
+ # @return [String]
361
+ #
362
+ # @!attribute [rw] filter_partial_results
363
+ # If true, `TranscriptEvents` with `IsPartial: true` are filtered out
364
+ # of the insights target.
365
+ # @return [Boolean]
366
+ #
367
+ # @see http://docs.aws.amazon.com/goto/WebAPI/chime-sdk-media-pipelines-2021-07-15/AmazonTranscribeProcessorConfiguration AWS API Documentation
368
+ #
369
+ class AmazonTranscribeProcessorConfiguration < Struct.new(
370
+ :language_code,
371
+ :vocabulary_name,
372
+ :vocabulary_filter_name,
373
+ :vocabulary_filter_method,
374
+ :show_speaker_label,
375
+ :enable_partial_results_stabilization,
376
+ :partial_results_stability,
377
+ :content_identification_type,
378
+ :content_redaction_type,
379
+ :pii_entity_types,
380
+ :language_model_name,
381
+ :filter_partial_results)
382
+ SENSITIVE = []
383
+ include Aws::Structure
384
+ end
385
+
13
386
  # The configuration for the artifacts concatenation.
14
387
  #
15
388
  # @!attribute [rw] audio
@@ -101,8 +474,7 @@ module Aws::ChimeSDKMediaPipelines
101
474
  # The audio artifact concatenation configuration object.
102
475
  #
103
476
  # @!attribute [rw] state
104
- # Enables the *name* object, where *name* is the name of the
105
- # configuration object, such as `AudioConcatenation`.
477
+ # Enables or disables the configuration object.
106
478
  # @return [String]
107
479
  #
108
480
  # @see http://docs.aws.amazon.com/goto/WebAPI/chime-sdk-media-pipelines-2021-07-15/AudioConcatenationConfiguration AWS API Documentation
@@ -122,7 +494,7 @@ module Aws::ChimeSDKMediaPipelines
122
494
  # @return [String]
123
495
  #
124
496
  # @!attribute [rw] request_id
125
- # The request id associated with the call responsible for the
497
+ # The request ID associated with the call responsible for the
126
498
  # exception.
127
499
  # @return [String]
128
500
  #
@@ -136,6 +508,26 @@ module Aws::ChimeSDKMediaPipelines
136
508
  include Aws::Structure
137
509
  end
138
510
 
511
+ # Defines an audio channel in a Kinesis video stream.
512
+ #
513
+ # @!attribute [rw] channel_id
514
+ # The channel ID.
515
+ # @return [Integer]
516
+ #
517
+ # @!attribute [rw] participant_role
518
+ # Specifies whether the audio in a channel belongs to the `AGENT` or
519
+ # `CUSTOMER`.
520
+ # @return [String]
521
+ #
522
+ # @see http://docs.aws.amazon.com/goto/WebAPI/chime-sdk-media-pipelines-2021-07-15/ChannelDefinition AWS API Documentation
523
+ #
524
+ class ChannelDefinition < Struct.new(
525
+ :channel_id,
526
+ :participant_role)
527
+ SENSITIVE = []
528
+ include Aws::Structure
529
+ end
530
+
139
531
  # The configuration object of the Amazon Chime SDK meeting concatenation
140
532
  # for a specified media pipeline.
141
533
  #
@@ -156,7 +548,7 @@ module Aws::ChimeSDKMediaPipelines
156
548
  # specified media pipeline. `SourceType` must be `ChimeSdkMeeting`.
157
549
  #
158
550
  # @!attribute [rw] source_configuration
159
- # The source configuration for a specified media pipline.
551
+ # The source configuration for a specified media pipeline.
160
552
  # @return [Types::SourceConfiguration]
161
553
  #
162
554
  # @!attribute [rw] artifacts_configuration
@@ -202,7 +594,7 @@ module Aws::ChimeSDKMediaPipelines
202
594
  include Aws::Structure
203
595
  end
204
596
 
205
- # Describes the configuration for the composited video artifacts.
597
+ # Specifies the configuration for compositing video artifacts.
206
598
  #
207
599
  # @!attribute [rw] layout
208
600
  # The layout setting, such as `GridView` in the configuration object.
@@ -282,6 +674,30 @@ module Aws::ChimeSDKMediaPipelines
282
674
  include Aws::Structure
283
675
  end
284
676
 
677
+ # The request could not be processed because of conflict in the current
678
+ # state of the resource.
679
+ #
680
+ # @!attribute [rw] code
681
+ # @return [String]
682
+ #
683
+ # @!attribute [rw] message
684
+ # @return [String]
685
+ #
686
+ # @!attribute [rw] request_id
687
+ # The request ID associated with the call responsible for the
688
+ # exception.
689
+ # @return [String]
690
+ #
691
+ # @see http://docs.aws.amazon.com/goto/WebAPI/chime-sdk-media-pipelines-2021-07-15/ConflictException AWS API Documentation
692
+ #
693
+ class ConflictException < Struct.new(
694
+ :code,
695
+ :message,
696
+ :request_id)
697
+ SENSITIVE = []
698
+ include Aws::Structure
699
+ end
700
+
285
701
  # The content artifact object.
286
702
  #
287
703
  # @!attribute [rw] state
@@ -427,12 +843,129 @@ module Aws::ChimeSDKMediaPipelines
427
843
  include Aws::Structure
428
844
  end
429
845
 
846
+ # @!attribute [rw] media_insights_pipeline_configuration_name
847
+ # The name of the media insights pipeline configuration.
848
+ # @return [String]
849
+ #
850
+ # @!attribute [rw] resource_access_role_arn
851
+ # The ARN of the role used by the service to access Amazon Web
852
+ # Services resources, including `Transcribe` and `Transcribe Call
853
+ # Analytics`, on the caller’s behalf.
854
+ # @return [String]
855
+ #
856
+ # @!attribute [rw] real_time_alert_configuration
857
+ # The configuration settings for the real-time alerts in a media
858
+ # insights pipeline configuration.
859
+ # @return [Types::RealTimeAlertConfiguration]
860
+ #
861
+ # @!attribute [rw] elements
862
+ # The elements in the request, such as a processor for Amazon
863
+ # Transcribe or a sink for a Kinesis Data Stream.
864
+ # @return [Array<Types::MediaInsightsPipelineConfigurationElement>]
865
+ #
866
+ # @!attribute [rw] tags
867
+ # The tags assigned to the media insights pipeline configuration.
868
+ # @return [Array<Types::Tag>]
869
+ #
870
+ # @!attribute [rw] client_request_token
871
+ # The unique identifier for the media insights pipeline configuration
872
+ # request.
873
+ #
874
+ # **A suitable default value is auto-generated.** You should normally
875
+ # not need to pass this option.
876
+ # @return [String]
877
+ #
878
+ # @see http://docs.aws.amazon.com/goto/WebAPI/chime-sdk-media-pipelines-2021-07-15/CreateMediaInsightsPipelineConfigurationRequest AWS API Documentation
879
+ #
880
+ class CreateMediaInsightsPipelineConfigurationRequest < Struct.new(
881
+ :media_insights_pipeline_configuration_name,
882
+ :resource_access_role_arn,
883
+ :real_time_alert_configuration,
884
+ :elements,
885
+ :tags,
886
+ :client_request_token)
887
+ SENSITIVE = [:resource_access_role_arn, :client_request_token]
888
+ include Aws::Structure
889
+ end
890
+
891
+ # @!attribute [rw] media_insights_pipeline_configuration
892
+ # The configuration settings for the media insights pipeline.
893
+ # @return [Types::MediaInsightsPipelineConfiguration]
894
+ #
895
+ # @see http://docs.aws.amazon.com/goto/WebAPI/chime-sdk-media-pipelines-2021-07-15/CreateMediaInsightsPipelineConfigurationResponse AWS API Documentation
896
+ #
897
+ class CreateMediaInsightsPipelineConfigurationResponse < Struct.new(
898
+ :media_insights_pipeline_configuration)
899
+ SENSITIVE = []
900
+ include Aws::Structure
901
+ end
902
+
903
+ # @!attribute [rw] media_insights_pipeline_configuration_arn
904
+ # The ARN of the pipeline's configuration.
905
+ # @return [String]
906
+ #
907
+ # @!attribute [rw] kinesis_video_stream_source_runtime_configuration
908
+ # The runtime configuration for the Kinesis video stream source of the
909
+ # media insights pipeline.
910
+ # @return [Types::KinesisVideoStreamSourceRuntimeConfiguration]
911
+ #
912
+ # @!attribute [rw] media_insights_runtime_metadata
913
+ # The runtime metadata for the media insights pipeline. Consists of a
914
+ # key-value map of strings.
915
+ # @return [Hash<String,String>]
916
+ #
917
+ # @!attribute [rw] kinesis_video_stream_recording_source_runtime_configuration
918
+ # The runtime configuration for the Kinesis video recording stream
919
+ # source.
920
+ # @return [Types::KinesisVideoStreamRecordingSourceRuntimeConfiguration]
921
+ #
922
+ # @!attribute [rw] s3_recording_sink_runtime_configuration
923
+ # The runtime configuration for the S3 recording sink.
924
+ # @return [Types::S3RecordingSinkRuntimeConfiguration]
925
+ #
926
+ # @!attribute [rw] tags
927
+ # The tags assigned to the media insights pipeline.
928
+ # @return [Array<Types::Tag>]
929
+ #
930
+ # @!attribute [rw] client_request_token
931
+ # The unique identifier for the media insights pipeline request.
932
+ #
933
+ # **A suitable default value is auto-generated.** You should normally
934
+ # not need to pass this option.
935
+ # @return [String]
936
+ #
937
+ # @see http://docs.aws.amazon.com/goto/WebAPI/chime-sdk-media-pipelines-2021-07-15/CreateMediaInsightsPipelineRequest AWS API Documentation
938
+ #
939
+ class CreateMediaInsightsPipelineRequest < Struct.new(
940
+ :media_insights_pipeline_configuration_arn,
941
+ :kinesis_video_stream_source_runtime_configuration,
942
+ :media_insights_runtime_metadata,
943
+ :kinesis_video_stream_recording_source_runtime_configuration,
944
+ :s3_recording_sink_runtime_configuration,
945
+ :tags,
946
+ :client_request_token)
947
+ SENSITIVE = [:media_insights_pipeline_configuration_arn, :media_insights_runtime_metadata, :client_request_token]
948
+ include Aws::Structure
949
+ end
950
+
951
+ # @!attribute [rw] media_insights_pipeline
952
+ # The media insights pipeline object.
953
+ # @return [Types::MediaInsightsPipeline]
954
+ #
955
+ # @see http://docs.aws.amazon.com/goto/WebAPI/chime-sdk-media-pipelines-2021-07-15/CreateMediaInsightsPipelineResponse AWS API Documentation
956
+ #
957
+ class CreateMediaInsightsPipelineResponse < Struct.new(
958
+ :media_insights_pipeline)
959
+ SENSITIVE = []
960
+ include Aws::Structure
961
+ end
962
+
430
963
  # @!attribute [rw] sources
431
- # The media pipeline's data sources.
964
+ # The media live connector pipeline's data sources.
432
965
  # @return [Array<Types::LiveConnectorSourceConfiguration>]
433
966
  #
434
967
  # @!attribute [rw] sinks
435
- # The media pipeline's data sinks.
968
+ # The media live connector pipeline's data sinks.
436
969
  # @return [Array<Types::LiveConnectorSinkConfiguration>]
437
970
  #
438
971
  # @!attribute [rw] client_request_token
@@ -443,7 +976,7 @@ module Aws::ChimeSDKMediaPipelines
443
976
  # @return [String]
444
977
  #
445
978
  # @!attribute [rw] tags
446
- # The tags associated with the media pipeline.
979
+ # The tags associated with the media live connector pipeline.
447
980
  # @return [Array<Types::Tag>]
448
981
  #
449
982
  # @see http://docs.aws.amazon.com/goto/WebAPI/chime-sdk-media-pipelines-2021-07-15/CreateMediaLiveConnectorPipelineRequest AWS API Documentation
@@ -458,7 +991,7 @@ module Aws::ChimeSDKMediaPipelines
458
991
  end
459
992
 
460
993
  # @!attribute [rw] media_live_connector_pipeline
461
- # The new media pipeline.
994
+ # The new media live connector pipeline.
462
995
  # @return [Types::MediaLiveConnectorPipeline]
463
996
  #
464
997
  # @see http://docs.aws.amazon.com/goto/WebAPI/chime-sdk-media-pipelines-2021-07-15/CreateMediaLiveConnectorPipelineResponse AWS API Documentation
@@ -495,6 +1028,20 @@ module Aws::ChimeSDKMediaPipelines
495
1028
  include Aws::Structure
496
1029
  end
497
1030
 
1031
+ # @!attribute [rw] identifier
1032
+ # The unique identifier of the resource to be deleted. Valid values
1033
+ # include the name and ARN of the media insights pipeline
1034
+ # configuration.
1035
+ # @return [String]
1036
+ #
1037
+ # @see http://docs.aws.amazon.com/goto/WebAPI/chime-sdk-media-pipelines-2021-07-15/DeleteMediaInsightsPipelineConfigurationRequest AWS API Documentation
1038
+ #
1039
+ class DeleteMediaInsightsPipelineConfigurationRequest < Struct.new(
1040
+ :identifier)
1041
+ SENSITIVE = []
1042
+ include Aws::Structure
1043
+ end
1044
+
498
1045
  # @!attribute [rw] media_pipeline_id
499
1046
  # The ID of the media pipeline to delete.
500
1047
  # @return [String]
@@ -530,6 +1077,46 @@ module Aws::ChimeSDKMediaPipelines
530
1077
  include Aws::Structure
531
1078
  end
532
1079
 
1080
+ # Describes the timestamp range and timestamp origin of a range of
1081
+ # fragments.
1082
+ #
1083
+ # Only fragments with a start timestamp greater than or equal to the
1084
+ # given start time and less than or equal to the end time are returned.
1085
+ # For example, say a stream contains fragments with the following start
1086
+ # timestamps:
1087
+ #
1088
+ # * 00:00:00
1089
+ #
1090
+ # * 00:00:02
1091
+ #
1092
+ # * 00:00:04
1093
+ #
1094
+ # * 00:00:06
1095
+ #
1096
+ # A fragment selector range with a start time of 00:00:01 and end time
1097
+ # of 00:00:04 would return the fragments with start times of 00:00:02
1098
+ # and 00:00:04.
1099
+ #
1100
+ # @!attribute [rw] fragment_selector_type
1101
+ # The origin of the timestamps to use, `Server` or `Producer`. For
1102
+ # more information, see
1103
+ # [StartSelectorType](kinesisvideostreams/latest/dg/API_dataplane_StartSelector.html#KinesisVideo-Type-dataplane_StartSelector-StartSelectorType)
1104
+ # in the *Amazon Kinesis Video Streams Developer Guide*.
1105
+ # @return [String]
1106
+ #
1107
+ # @!attribute [rw] timestamp_range
1108
+ # The range of timestamps to return.
1109
+ # @return [Types::TimestampRange]
1110
+ #
1111
+ # @see http://docs.aws.amazon.com/goto/WebAPI/chime-sdk-media-pipelines-2021-07-15/FragmentSelector AWS API Documentation
1112
+ #
1113
+ class FragmentSelector < Struct.new(
1114
+ :fragment_selector_type,
1115
+ :timestamp_range)
1116
+ SENSITIVE = []
1117
+ include Aws::Structure
1118
+ end
1119
+
533
1120
  # @!attribute [rw] media_pipeline_id
534
1121
  # The ID of the pipeline that you want to get.
535
1122
  # @return [String]
@@ -554,6 +1141,32 @@ module Aws::ChimeSDKMediaPipelines
554
1141
  include Aws::Structure
555
1142
  end
556
1143
 
1144
+ # @!attribute [rw] identifier
1145
+ # The unique identifier of the requested resource. Valid values
1146
+ # include the name and ARN of the media insights pipeline
1147
+ # configuration.
1148
+ # @return [String]
1149
+ #
1150
+ # @see http://docs.aws.amazon.com/goto/WebAPI/chime-sdk-media-pipelines-2021-07-15/GetMediaInsightsPipelineConfigurationRequest AWS API Documentation
1151
+ #
1152
+ class GetMediaInsightsPipelineConfigurationRequest < Struct.new(
1153
+ :identifier)
1154
+ SENSITIVE = []
1155
+ include Aws::Structure
1156
+ end
1157
+
1158
+ # @!attribute [rw] media_insights_pipeline_configuration
1159
+ # The requested media insights pipeline configuration.
1160
+ # @return [Types::MediaInsightsPipelineConfiguration]
1161
+ #
1162
+ # @see http://docs.aws.amazon.com/goto/WebAPI/chime-sdk-media-pipelines-2021-07-15/GetMediaInsightsPipelineConfigurationResponse AWS API Documentation
1163
+ #
1164
+ class GetMediaInsightsPipelineConfigurationResponse < Struct.new(
1165
+ :media_insights_pipeline_configuration)
1166
+ SENSITIVE = []
1167
+ include Aws::Structure
1168
+ end
1169
+
557
1170
  # @!attribute [rw] media_pipeline_id
558
1171
  # The ID of the pipeline that you want to get.
559
1172
  # @return [String]
@@ -598,6 +1211,148 @@ module Aws::ChimeSDKMediaPipelines
598
1211
  include Aws::Structure
599
1212
  end
600
1213
 
1214
+ # A structure that contains the configuration settings for an issue
1215
+ # detection task.
1216
+ #
1217
+ # @!attribute [rw] rule_name
1218
+ # The name of the issue detection rule.
1219
+ # @return [String]
1220
+ #
1221
+ # @see http://docs.aws.amazon.com/goto/WebAPI/chime-sdk-media-pipelines-2021-07-15/IssueDetectionConfiguration AWS API Documentation
1222
+ #
1223
+ class IssueDetectionConfiguration < Struct.new(
1224
+ :rule_name)
1225
+ SENSITIVE = []
1226
+ include Aws::Structure
1227
+ end
1228
+
1229
+ # A structure that contains the settings for a keyword match task.
1230
+ #
1231
+ # @!attribute [rw] rule_name
1232
+ # The name of the keyword match rule.
1233
+ # @return [String]
1234
+ #
1235
+ # @!attribute [rw] keywords
1236
+ # The keywords or phrases that you want to match.
1237
+ # @return [Array<String>]
1238
+ #
1239
+ # @!attribute [rw] negate
1240
+ # Matches keywords or phrases on their presence or absence. If set to
1241
+ # `TRUE`, the rule matches when all the specified keywords or phrases
1242
+ # are absent. Default: `FALSE`.
1243
+ # @return [Boolean]
1244
+ #
1245
+ # @see http://docs.aws.amazon.com/goto/WebAPI/chime-sdk-media-pipelines-2021-07-15/KeywordMatchConfiguration AWS API Documentation
1246
+ #
1247
+ class KeywordMatchConfiguration < Struct.new(
1248
+ :rule_name,
1249
+ :keywords,
1250
+ :negate)
1251
+ SENSITIVE = []
1252
+ include Aws::Structure
1253
+ end
1254
+
1255
+ # A structure that contains the configuration settings for a Kinesis
1256
+ # Data Stream sink.
1257
+ #
1258
+ # @!attribute [rw] insights_target
1259
+ # The URL of the sink,
1260
+ # [https://aws.amazon.com/kinesis/data-streams/][1].
1261
+ #
1262
+ #
1263
+ #
1264
+ # [1]: https://aws.amazon.com/kinesis/data-streams/
1265
+ # @return [String]
1266
+ #
1267
+ # @see http://docs.aws.amazon.com/goto/WebAPI/chime-sdk-media-pipelines-2021-07-15/KinesisDataStreamSinkConfiguration AWS API Documentation
1268
+ #
1269
+ class KinesisDataStreamSinkConfiguration < Struct.new(
1270
+ :insights_target)
1271
+ SENSITIVE = [:insights_target]
1272
+ include Aws::Structure
1273
+ end
1274
+
1275
+ # A structure that contains the runtime settings for recording a Kinesis
1276
+ # video stream.
1277
+ #
1278
+ # @!attribute [rw] streams
1279
+ # The stream or streams to be recorded.
1280
+ # @return [Array<Types::RecordingStreamConfiguration>]
1281
+ #
1282
+ # @!attribute [rw] fragment_selector
1283
+ # Describes the timestamp range and timestamp origin of a range of
1284
+ # fragments in the Kinesis video stream.
1285
+ # @return [Types::FragmentSelector]
1286
+ #
1287
+ # @see http://docs.aws.amazon.com/goto/WebAPI/chime-sdk-media-pipelines-2021-07-15/KinesisVideoStreamRecordingSourceRuntimeConfiguration AWS API Documentation
1288
+ #
1289
+ class KinesisVideoStreamRecordingSourceRuntimeConfiguration < Struct.new(
1290
+ :streams,
1291
+ :fragment_selector)
1292
+ SENSITIVE = []
1293
+ include Aws::Structure
1294
+ end
1295
+
1296
+ # The runtime configuration settings for the Kinesis video stream
1297
+ # source.
1298
+ #
1299
+ # @!attribute [rw] streams
1300
+ # The streams in the source runtime configuration of a Kinesis video
1301
+ # stream.
1302
+ # @return [Array<Types::StreamConfiguration>]
1303
+ #
1304
+ # @!attribute [rw] media_encoding
1305
+ # Specifies the encoding of your input audio. Supported format: PCM
1306
+ # (only signed 16-bit little-endian audio formats, which does not
1307
+ # include WAV)
1308
+ #
1309
+ # For more information, see [Media formats][1] in the *Amazon
1310
+ # Transcribe Developer Guide*.
1311
+ #
1312
+ #
1313
+ #
1314
+ # [1]: https://docs.aws.amazon.com/transcribe/latest/dg/how-input.html#how-input-audio
1315
+ # @return [String]
1316
+ #
1317
+ # @!attribute [rw] media_sample_rate
1318
+ # The sample rate of the input audio (in hertz). Low-quality audio,
1319
+ # such as telephone audio, is typically around 8,000 Hz. High-quality
1320
+ # audio typically ranges from 16,000 Hz to 48,000 Hz. Note that the
1321
+ # sample rate you specify must match that of your audio.
1322
+ #
1323
+ # Valid Range: Minimum value of 8000. Maximum value of 48000.
1324
+ # @return [Integer]
1325
+ #
1326
+ # @see http://docs.aws.amazon.com/goto/WebAPI/chime-sdk-media-pipelines-2021-07-15/KinesisVideoStreamSourceRuntimeConfiguration AWS API Documentation
1327
+ #
1328
+ class KinesisVideoStreamSourceRuntimeConfiguration < Struct.new(
1329
+ :streams,
1330
+ :media_encoding,
1331
+ :media_sample_rate)
1332
+ SENSITIVE = []
1333
+ include Aws::Structure
1334
+ end
1335
+
1336
+ # A structure that contains the configuration settings for an AWS Lambda
1337
+ # function's data sink.
1338
+ #
1339
+ # @!attribute [rw] insights_target
1340
+ # The URL of the sink,
1341
+ # [https://aws.amazon.com/kinesis/data-streams/][1].
1342
+ #
1343
+ #
1344
+ #
1345
+ # [1]: https://aws.amazon.com/kinesis/data-streams/
1346
+ # @return [String]
1347
+ #
1348
+ # @see http://docs.aws.amazon.com/goto/WebAPI/chime-sdk-media-pipelines-2021-07-15/LambdaFunctionSinkConfiguration AWS API Documentation
1349
+ #
1350
+ class LambdaFunctionSinkConfiguration < Struct.new(
1351
+ :insights_target)
1352
+ SENSITIVE = [:insights_target]
1353
+ include Aws::Structure
1354
+ end
1355
+
601
1356
  # @!attribute [rw] next_token
602
1357
  # The token used to retrieve the next page of results.
603
1358
  # @return [String]
@@ -621,13 +1376,47 @@ module Aws::ChimeSDKMediaPipelines
621
1376
  # @return [Array<Types::MediaCapturePipelineSummary>]
622
1377
  #
623
1378
  # @!attribute [rw] next_token
624
- # The token used to retrieve the next page of results.
1379
+ # The token used to retrieve the next page of results.
1380
+ # @return [String]
1381
+ #
1382
+ # @see http://docs.aws.amazon.com/goto/WebAPI/chime-sdk-media-pipelines-2021-07-15/ListMediaCapturePipelinesResponse AWS API Documentation
1383
+ #
1384
+ class ListMediaCapturePipelinesResponse < Struct.new(
1385
+ :media_capture_pipelines,
1386
+ :next_token)
1387
+ SENSITIVE = []
1388
+ include Aws::Structure
1389
+ end
1390
+
1391
+ # @!attribute [rw] next_token
1392
+ # The token used to return the next page of results.
1393
+ # @return [String]
1394
+ #
1395
+ # @!attribute [rw] max_results
1396
+ # The maximum number of results to return in a single call.
1397
+ # @return [Integer]
1398
+ #
1399
+ # @see http://docs.aws.amazon.com/goto/WebAPI/chime-sdk-media-pipelines-2021-07-15/ListMediaInsightsPipelineConfigurationsRequest AWS API Documentation
1400
+ #
1401
+ class ListMediaInsightsPipelineConfigurationsRequest < Struct.new(
1402
+ :next_token,
1403
+ :max_results)
1404
+ SENSITIVE = []
1405
+ include Aws::Structure
1406
+ end
1407
+
1408
+ # @!attribute [rw] media_insights_pipeline_configurations
1409
+ # The requested list of media insights pipeline configurations.
1410
+ # @return [Array<Types::MediaInsightsPipelineConfigurationSummary>]
1411
+ #
1412
+ # @!attribute [rw] next_token
1413
+ # The token used to return the next page of results.
625
1414
  # @return [String]
626
1415
  #
627
- # @see http://docs.aws.amazon.com/goto/WebAPI/chime-sdk-media-pipelines-2021-07-15/ListMediaCapturePipelinesResponse AWS API Documentation
1416
+ # @see http://docs.aws.amazon.com/goto/WebAPI/chime-sdk-media-pipelines-2021-07-15/ListMediaInsightsPipelineConfigurationsResponse AWS API Documentation
628
1417
  #
629
- class ListMediaCapturePipelinesResponse < Struct.new(
630
- :media_capture_pipelines,
1418
+ class ListMediaInsightsPipelineConfigurationsResponse < Struct.new(
1419
+ :media_insights_pipeline_configurations,
631
1420
  :next_token)
632
1421
  SENSITIVE = []
633
1422
  include Aws::Structure
@@ -725,7 +1514,7 @@ module Aws::ChimeSDKMediaPipelines
725
1514
  # @return [String]
726
1515
  #
727
1516
  # @!attribute [rw] rtmp_configuration
728
- # The sink configuration's RTMP configuration setttings.
1517
+ # The sink configuration's RTMP configuration settings.
729
1518
  # @return [Types::LiveConnectorRTMPConfiguration]
730
1519
  #
731
1520
  # @see http://docs.aws.amazon.com/goto/WebAPI/chime-sdk-media-pipelines-2021-07-15/LiveConnectorSinkConfiguration AWS API Documentation
@@ -871,7 +1660,7 @@ module Aws::ChimeSDKMediaPipelines
871
1660
  # @return [String]
872
1661
  #
873
1662
  # @!attribute [rw] sources
874
- # The data sources being concatnated.
1663
+ # The data sources being concatenated.
875
1664
  # @return [Array<Types::ConcatenationSource>]
876
1665
  #
877
1666
  # @!attribute [rw] sinks
@@ -904,6 +1693,200 @@ module Aws::ChimeSDKMediaPipelines
904
1693
  include Aws::Structure
905
1694
  end
906
1695
 
1696
+ # A media pipeline that streams call analytics data.
1697
+ #
1698
+ # @!attribute [rw] media_pipeline_id
1699
+ # The ID of a media insights pipeline.
1700
+ # @return [String]
1701
+ #
1702
+ # @!attribute [rw] media_pipeline_arn
1703
+ # The ARN of a media insights pipeline.
1704
+ # @return [String]
1705
+ #
1706
+ # @!attribute [rw] media_insights_pipeline_configuration_arn
1707
+ # The ARN of a media insight pipeline's configuration settings.
1708
+ # @return [String]
1709
+ #
1710
+ # @!attribute [rw] status
1711
+ # The status of a media insights pipeline.
1712
+ # @return [String]
1713
+ #
1714
+ # @!attribute [rw] kinesis_video_stream_source_runtime_configuration
1715
+ # The configuration settings for a Kinesis runtime video stream in a
1716
+ # media insights pipeline.
1717
+ # @return [Types::KinesisVideoStreamSourceRuntimeConfiguration]
1718
+ #
1719
+ # @!attribute [rw] media_insights_runtime_metadata
1720
+ # The runtime metadata of a media insights pipeline.
1721
+ # @return [Hash<String,String>]
1722
+ #
1723
+ # @!attribute [rw] kinesis_video_stream_recording_source_runtime_configuration
1724
+ # The runtime configuration settings for a Kinesis recording video
1725
+ # stream in a media insights pipeline.
1726
+ # @return [Types::KinesisVideoStreamRecordingSourceRuntimeConfiguration]
1727
+ #
1728
+ # @!attribute [rw] s3_recording_sink_runtime_configuration
1729
+ # The runtime configuration of the Amazon S3 bucket that stores
1730
+ # recordings in a media insights pipeline.
1731
+ # @return [Types::S3RecordingSinkRuntimeConfiguration]
1732
+ #
1733
+ # @!attribute [rw] created_timestamp
1734
+ # The time at which the media insights pipeline was created.
1735
+ # @return [Time]
1736
+ #
1737
+ # @see http://docs.aws.amazon.com/goto/WebAPI/chime-sdk-media-pipelines-2021-07-15/MediaInsightsPipeline AWS API Documentation
1738
+ #
1739
+ class MediaInsightsPipeline < Struct.new(
1740
+ :media_pipeline_id,
1741
+ :media_pipeline_arn,
1742
+ :media_insights_pipeline_configuration_arn,
1743
+ :status,
1744
+ :kinesis_video_stream_source_runtime_configuration,
1745
+ :media_insights_runtime_metadata,
1746
+ :kinesis_video_stream_recording_source_runtime_configuration,
1747
+ :s3_recording_sink_runtime_configuration,
1748
+ :created_timestamp)
1749
+ SENSITIVE = [:media_pipeline_arn, :media_insights_pipeline_configuration_arn, :media_insights_runtime_metadata]
1750
+ include Aws::Structure
1751
+ end
1752
+
1753
+ # A structure that contains the configuration settings for a media
1754
+ # insights pipeline.
1755
+ #
1756
+ # @!attribute [rw] media_insights_pipeline_configuration_name
1757
+ # The name of the configuration.
1758
+ # @return [String]
1759
+ #
1760
+ # @!attribute [rw] media_insights_pipeline_configuration_arn
1761
+ # The ARN of the configuration.
1762
+ # @return [String]
1763
+ #
1764
+ # @!attribute [rw] resource_access_role_arn
1765
+ # The ARN of the role used by the service to access Amazon Web
1766
+ # Services resources.
1767
+ # @return [String]
1768
+ #
1769
+ # @!attribute [rw] real_time_alert_configuration
1770
+ # Lists the rules that trigger a real-time alert.
1771
+ # @return [Types::RealTimeAlertConfiguration]
1772
+ #
1773
+ # @!attribute [rw] elements
1774
+ # The elements in the configuration.
1775
+ # @return [Array<Types::MediaInsightsPipelineConfigurationElement>]
1776
+ #
1777
+ # @!attribute [rw] media_insights_pipeline_configuration_id
1778
+ # The ID of the configuration.
1779
+ # @return [String]
1780
+ #
1781
+ # @!attribute [rw] created_timestamp
1782
+ # The time at which the configuration was created.
1783
+ # @return [Time]
1784
+ #
1785
+ # @!attribute [rw] updated_timestamp
1786
+ # The time at which the configuration was last updated.
1787
+ # @return [Time]
1788
+ #
1789
+ # @see http://docs.aws.amazon.com/goto/WebAPI/chime-sdk-media-pipelines-2021-07-15/MediaInsightsPipelineConfiguration AWS API Documentation
1790
+ #
1791
+ class MediaInsightsPipelineConfiguration < Struct.new(
1792
+ :media_insights_pipeline_configuration_name,
1793
+ :media_insights_pipeline_configuration_arn,
1794
+ :resource_access_role_arn,
1795
+ :real_time_alert_configuration,
1796
+ :elements,
1797
+ :media_insights_pipeline_configuration_id,
1798
+ :created_timestamp,
1799
+ :updated_timestamp)
1800
+ SENSITIVE = [:media_insights_pipeline_configuration_arn, :resource_access_role_arn]
1801
+ include Aws::Structure
1802
+ end
1803
+
1804
+ # An element in a media insights pipeline configuration.
1805
+ #
1806
+ # @!attribute [rw] type
1807
+ # The element type.
1808
+ # @return [String]
1809
+ #
1810
+ # @!attribute [rw] amazon_transcribe_call_analytics_processor_configuration
1811
+ # The analytics configuration settings for transcribing audio in a
1812
+ # media insights pipeline configuration element.
1813
+ # @return [Types::AmazonTranscribeCallAnalyticsProcessorConfiguration]
1814
+ #
1815
+ # @!attribute [rw] amazon_transcribe_processor_configuration
1816
+ # The transcription processor configuration settings in a media
1817
+ # insights pipeline configuration element.
1818
+ # @return [Types::AmazonTranscribeProcessorConfiguration]
1819
+ #
1820
+ # @!attribute [rw] kinesis_data_stream_sink_configuration
1821
+ # The configuration settings for the Kinesis Data Stream Sink in a
1822
+ # media insights pipeline configuration element.
1823
+ # @return [Types::KinesisDataStreamSinkConfiguration]
1824
+ #
1825
+ # @!attribute [rw] s3_recording_sink_configuration
1826
+ # The configuration settings for the Amazon S3 recording bucket in a
1827
+ # media insights pipeline configuration element.
1828
+ # @return [Types::S3RecordingSinkConfiguration]
1829
+ #
1830
+ # @!attribute [rw] voice_analytics_processor_configuration
1831
+ # The voice analytics configuration settings in a media insights
1832
+ # pipeline configuration element.
1833
+ # @return [Types::VoiceAnalyticsProcessorConfiguration]
1834
+ #
1835
+ # @!attribute [rw] lambda_function_sink_configuration
1836
+ # The configuration settings for the Amazon Web Services Lambda sink
1837
+ # in a media insights pipeline configuration element.
1838
+ # @return [Types::LambdaFunctionSinkConfiguration]
1839
+ #
1840
+ # @!attribute [rw] sqs_queue_sink_configuration
1841
+ # The configuration settings for an SQS queue sink in a media insights
1842
+ # pipeline configuration element.
1843
+ # @return [Types::SqsQueueSinkConfiguration]
1844
+ #
1845
+ # @!attribute [rw] sns_topic_sink_configuration
1846
+ # The configuration settings for an SNS topic sink in a media insights
1847
+ # pipeline configuration element.
1848
+ # @return [Types::SnsTopicSinkConfiguration]
1849
+ #
1850
+ # @see http://docs.aws.amazon.com/goto/WebAPI/chime-sdk-media-pipelines-2021-07-15/MediaInsightsPipelineConfigurationElement AWS API Documentation
1851
+ #
1852
+ class MediaInsightsPipelineConfigurationElement < Struct.new(
1853
+ :type,
1854
+ :amazon_transcribe_call_analytics_processor_configuration,
1855
+ :amazon_transcribe_processor_configuration,
1856
+ :kinesis_data_stream_sink_configuration,
1857
+ :s3_recording_sink_configuration,
1858
+ :voice_analytics_processor_configuration,
1859
+ :lambda_function_sink_configuration,
1860
+ :sqs_queue_sink_configuration,
1861
+ :sns_topic_sink_configuration)
1862
+ SENSITIVE = []
1863
+ include Aws::Structure
1864
+ end
1865
+
1866
+ # A summary of the media insights pipeline configuration.
1867
+ #
1868
+ # @!attribute [rw] media_insights_pipeline_configuration_name
1869
+ # The name of the media insights pipeline configuration.
1870
+ # @return [String]
1871
+ #
1872
+ # @!attribute [rw] media_insights_pipeline_configuration_id
1873
+ # The ID of the media insights pipeline configuration.
1874
+ # @return [String]
1875
+ #
1876
+ # @!attribute [rw] media_insights_pipeline_configuration_arn
1877
+ # The ARN of the media insights pipeline configuration.
1878
+ # @return [String]
1879
+ #
1880
+ # @see http://docs.aws.amazon.com/goto/WebAPI/chime-sdk-media-pipelines-2021-07-15/MediaInsightsPipelineConfigurationSummary AWS API Documentation
1881
+ #
1882
+ class MediaInsightsPipelineConfigurationSummary < Struct.new(
1883
+ :media_insights_pipeline_configuration_name,
1884
+ :media_insights_pipeline_configuration_id,
1885
+ :media_insights_pipeline_configuration_arn)
1886
+ SENSITIVE = [:media_insights_pipeline_configuration_arn]
1887
+ include Aws::Structure
1888
+ end
1889
+
907
1890
  # The connector pipeline.
908
1891
  #
909
1892
  # @!attribute [rw] sources
@@ -927,7 +1910,7 @@ module Aws::ChimeSDKMediaPipelines
927
1910
  # @return [String]
928
1911
  #
929
1912
  # @!attribute [rw] created_timestamp
930
- # Thetime at which the connector pipeline was created.
1913
+ # The time at which the connector pipeline was created.
931
1914
  # @return [Time]
932
1915
  #
933
1916
  # @!attribute [rw] updated_timestamp
@@ -963,12 +1946,17 @@ module Aws::ChimeSDKMediaPipelines
963
1946
  # The media concatenation pipeline in a media pipeline.
964
1947
  # @return [Types::MediaConcatenationPipeline]
965
1948
  #
1949
+ # @!attribute [rw] media_insights_pipeline
1950
+ # The media insights pipeline of a media pipeline.
1951
+ # @return [Types::MediaInsightsPipeline]
1952
+ #
966
1953
  # @see http://docs.aws.amazon.com/goto/WebAPI/chime-sdk-media-pipelines-2021-07-15/MediaPipeline AWS API Documentation
967
1954
  #
968
1955
  class MediaPipeline < Struct.new(
969
1956
  :media_capture_pipeline,
970
1957
  :media_live_connector_pipeline,
971
- :media_concatenation_pipeline)
1958
+ :media_concatenation_pipeline,
1959
+ :media_insights_pipeline)
972
1960
  SENSITIVE = []
973
1961
  include Aws::Structure
974
1962
  end
@@ -1016,7 +2004,7 @@ module Aws::ChimeSDKMediaPipelines
1016
2004
  # @return [String]
1017
2005
  #
1018
2006
  # @!attribute [rw] request_id
1019
- # The request id associated with the call responsible for the
2007
+ # The request ID associated with the call responsible for the
1020
2008
  # exception.
1021
2009
  # @return [String]
1022
2010
  #
@@ -1030,6 +2018,43 @@ module Aws::ChimeSDKMediaPipelines
1030
2018
  include Aws::Structure
1031
2019
  end
1032
2020
 
2021
+ # The settings for a post-call voice analytics task.
2022
+ #
2023
+ # @!attribute [rw] output_location
2024
+ # The URL of the Amazon S3 bucket that contains the post-call data.
2025
+ # @return [String]
2026
+ #
2027
+ # @!attribute [rw] data_access_role_arn
2028
+ # The ARN of the role used by Amazon Web Services Transcribe to upload
2029
+ # your post call analysis. For more information, see [Post-call
2030
+ # analytics with real-time transcriptions][1] in the *Amazon
2031
+ # Transcribe Developer Guide*.
2032
+ #
2033
+ #
2034
+ #
2035
+ # [1]: https://docs.aws.amazon.com/transcribe/latest/dg/tca-post-call.html
2036
+ # @return [String]
2037
+ #
2038
+ # @!attribute [rw] content_redaction_output
2039
+ # The content redaction output settings for a post-call analysis task.
2040
+ # @return [String]
2041
+ #
2042
+ # @!attribute [rw] output_encryption_kms_key_id
2043
+ # The ID of the KMS (Key Management System) key used to encrypt the
2044
+ # output.
2045
+ # @return [String]
2046
+ #
2047
+ # @see http://docs.aws.amazon.com/goto/WebAPI/chime-sdk-media-pipelines-2021-07-15/PostCallAnalyticsSettings AWS API Documentation
2048
+ #
2049
+ class PostCallAnalyticsSettings < Struct.new(
2050
+ :output_location,
2051
+ :data_access_role_arn,
2052
+ :content_redaction_output,
2053
+ :output_encryption_kms_key_id)
2054
+ SENSITIVE = []
2055
+ include Aws::Structure
2056
+ end
2057
+
1033
2058
  # Defines the configuration for a presenter only video tile.
1034
2059
  #
1035
2060
  # @!attribute [rw] presenter_position
@@ -1045,6 +2070,72 @@ module Aws::ChimeSDKMediaPipelines
1045
2070
  include Aws::Structure
1046
2071
  end
1047
2072
 
2073
+ # A structure that contains the configuration settings for real-time
2074
+ # alerts.
2075
+ #
2076
+ # @!attribute [rw] disabled
2077
+ # Turns off real-time alerts.
2078
+ # @return [Boolean]
2079
+ #
2080
+ # @!attribute [rw] rules
2081
+ # The rules in the alert. Rules specify the words or phrases that you
2082
+ # want to be notified about.
2083
+ # @return [Array<Types::RealTimeAlertRule>]
2084
+ #
2085
+ # @see http://docs.aws.amazon.com/goto/WebAPI/chime-sdk-media-pipelines-2021-07-15/RealTimeAlertConfiguration AWS API Documentation
2086
+ #
2087
+ class RealTimeAlertConfiguration < Struct.new(
2088
+ :disabled,
2089
+ :rules)
2090
+ SENSITIVE = []
2091
+ include Aws::Structure
2092
+ end
2093
+
2094
+ # Specifies the words or phrases that trigger an alert.
2095
+ #
2096
+ # @!attribute [rw] type
2097
+ # The type of alert rule.
2098
+ # @return [String]
2099
+ #
2100
+ # @!attribute [rw] keyword_match_configuration
2101
+ # Specifies the settings for matching the keywords in a real-time
2102
+ # alert rule.
2103
+ # @return [Types::KeywordMatchConfiguration]
2104
+ #
2105
+ # @!attribute [rw] sentiment_configuration
2106
+ # Specifies the settings for predicting sentiment in a real-time alert
2107
+ # rule.
2108
+ # @return [Types::SentimentConfiguration]
2109
+ #
2110
+ # @!attribute [rw] issue_detection_configuration
2111
+ # Specifies the issue detection settings for a real-time alert rule.
2112
+ # @return [Types::IssueDetectionConfiguration]
2113
+ #
2114
+ # @see http://docs.aws.amazon.com/goto/WebAPI/chime-sdk-media-pipelines-2021-07-15/RealTimeAlertRule AWS API Documentation
2115
+ #
2116
+ class RealTimeAlertRule < Struct.new(
2117
+ :type,
2118
+ :keyword_match_configuration,
2119
+ :sentiment_configuration,
2120
+ :issue_detection_configuration)
2121
+ SENSITIVE = []
2122
+ include Aws::Structure
2123
+ end
2124
+
2125
+ # A structure the holds the settings for recording audio and video.
2126
+ #
2127
+ # @!attribute [rw] stream_arn
2128
+ # The ARN of the recording stream.
2129
+ # @return [String]
2130
+ #
2131
+ # @see http://docs.aws.amazon.com/goto/WebAPI/chime-sdk-media-pipelines-2021-07-15/RecordingStreamConfiguration AWS API Documentation
2132
+ #
2133
+ class RecordingStreamConfiguration < Struct.new(
2134
+ :stream_arn)
2135
+ SENSITIVE = []
2136
+ include Aws::Structure
2137
+ end
2138
+
1048
2139
  # The request exceeds the resource limit.
1049
2140
  #
1050
2141
  # @!attribute [rw] code
@@ -1054,7 +2145,7 @@ module Aws::ChimeSDKMediaPipelines
1054
2145
  # @return [String]
1055
2146
  #
1056
2147
  # @!attribute [rw] request_id
1057
- # The request id associated with the call responsible for the
2148
+ # The request ID associated with the call responsible for the
1058
2149
  # exception.
1059
2150
  # @return [String]
1060
2151
  #
@@ -1082,6 +2173,42 @@ module Aws::ChimeSDKMediaPipelines
1082
2173
  include Aws::Structure
1083
2174
  end
1084
2175
 
2176
+ # The structure that holds the settings for transmitting audio and video
2177
+ # to the Amazon S3 bucket.
2178
+ #
2179
+ # @!attribute [rw] destination
2180
+ # The URL of the Amazon S3 bucket used as the recording sink.
2181
+ # @return [String]
2182
+ #
2183
+ # @see http://docs.aws.amazon.com/goto/WebAPI/chime-sdk-media-pipelines-2021-07-15/S3RecordingSinkConfiguration AWS API Documentation
2184
+ #
2185
+ class S3RecordingSinkConfiguration < Struct.new(
2186
+ :destination)
2187
+ SENSITIVE = [:destination]
2188
+ include Aws::Structure
2189
+ end
2190
+
2191
+ # A structure that holds the settings for transmitting audio and video
2192
+ # recordings to the runtime Amazon S3 bucket.
2193
+ #
2194
+ # @!attribute [rw] destination
2195
+ # The URL of the S3 bucket used as the runtime sink.
2196
+ # @return [String]
2197
+ #
2198
+ # @!attribute [rw] recording_file_format
2199
+ # The file formats for the audio and video files sent to the Amazon S3
2200
+ # bucket.
2201
+ # @return [String]
2202
+ #
2203
+ # @see http://docs.aws.amazon.com/goto/WebAPI/chime-sdk-media-pipelines-2021-07-15/S3RecordingSinkRuntimeConfiguration AWS API Documentation
2204
+ #
2205
+ class S3RecordingSinkRuntimeConfiguration < Struct.new(
2206
+ :destination,
2207
+ :recording_file_format)
2208
+ SENSITIVE = [:destination]
2209
+ include Aws::Structure
2210
+ end
2211
+
1085
2212
  # The video streams for a specified media pipeline. The total number of
1086
2213
  # video streams can't exceed 25.
1087
2214
  #
@@ -1102,6 +2229,31 @@ module Aws::ChimeSDKMediaPipelines
1102
2229
  include Aws::Structure
1103
2230
  end
1104
2231
 
2232
+ # A structure that contains the configuration settings for a sentiment
2233
+ # analysis task.
2234
+ #
2235
+ # @!attribute [rw] rule_name
2236
+ # The name of the rule in the sentiment configuration.
2237
+ # @return [String]
2238
+ #
2239
+ # @!attribute [rw] sentiment_type
2240
+ # The type of sentiment, `POSITIVE`, `NEGATIVE`, or `NEUTRAL`.
2241
+ # @return [String]
2242
+ #
2243
+ # @!attribute [rw] time_period
2244
+ # Specifies the analysis interval.
2245
+ # @return [Integer]
2246
+ #
2247
+ # @see http://docs.aws.amazon.com/goto/WebAPI/chime-sdk-media-pipelines-2021-07-15/SentimentConfiguration AWS API Documentation
2248
+ #
2249
+ class SentimentConfiguration < Struct.new(
2250
+ :rule_name,
2251
+ :sentiment_type,
2252
+ :time_period)
2253
+ SENSITIVE = []
2254
+ include Aws::Structure
2255
+ end
2256
+
1105
2257
  # The service encountered an unexpected error.
1106
2258
  #
1107
2259
  # @!attribute [rw] code
@@ -1111,7 +2263,7 @@ module Aws::ChimeSDKMediaPipelines
1111
2263
  # @return [String]
1112
2264
  #
1113
2265
  # @!attribute [rw] request_id
1114
- # The request id associated with the call responsible for the
2266
+ # The request ID associated with the call responsible for the
1115
2267
  # exception.
1116
2268
  # @return [String]
1117
2269
  #
@@ -1134,7 +2286,7 @@ module Aws::ChimeSDKMediaPipelines
1134
2286
  # @return [String]
1135
2287
  #
1136
2288
  # @!attribute [rw] request_id
1137
- # The request id associated with the call responsible for the
2289
+ # The request ID associated with the call responsible for the
1138
2290
  # exception.
1139
2291
  # @return [String]
1140
2292
  #
@@ -1148,6 +2300,25 @@ module Aws::ChimeSDKMediaPipelines
1148
2300
  include Aws::Structure
1149
2301
  end
1150
2302
 
2303
+ # The configuration settings for the SNS topic sink.
2304
+ #
2305
+ # @!attribute [rw] insights_target
2306
+ # The URL of the SNS sink,
2307
+ # [https://aws.amazon.com/kinesis/data-streams/][1].
2308
+ #
2309
+ #
2310
+ #
2311
+ # [1]: https://aws.amazon.com/kinesis/data-streams/
2312
+ # @return [String]
2313
+ #
2314
+ # @see http://docs.aws.amazon.com/goto/WebAPI/chime-sdk-media-pipelines-2021-07-15/SnsTopicSinkConfiguration AWS API Documentation
2315
+ #
2316
+ class SnsTopicSinkConfiguration < Struct.new(
2317
+ :insights_target)
2318
+ SENSITIVE = [:insights_target]
2319
+ include Aws::Structure
2320
+ end
2321
+
1151
2322
  # Source configuration for a specified media pipeline.
1152
2323
  #
1153
2324
  # @!attribute [rw] selected_video_streams
@@ -1163,6 +2334,68 @@ module Aws::ChimeSDKMediaPipelines
1163
2334
  include Aws::Structure
1164
2335
  end
1165
2336
 
2337
+ # The URL of the SQS sink.
2338
+ #
2339
+ # @!attribute [rw] insights_target
2340
+ # The URL of the SQS sink,
2341
+ # [https://aws.amazon.com/kinesis/data-streams/][1].
2342
+ #
2343
+ #
2344
+ #
2345
+ # [1]: https://aws.amazon.com/kinesis/data-streams/
2346
+ # @return [String]
2347
+ #
2348
+ # @see http://docs.aws.amazon.com/goto/WebAPI/chime-sdk-media-pipelines-2021-07-15/SqsQueueSinkConfiguration AWS API Documentation
2349
+ #
2350
+ class SqsQueueSinkConfiguration < Struct.new(
2351
+ :insights_target)
2352
+ SENSITIVE = [:insights_target]
2353
+ include Aws::Structure
2354
+ end
2355
+
2356
+ # Defines a streaming channel.
2357
+ #
2358
+ # @!attribute [rw] number_of_channels
2359
+ # The number of channels in a streaming channel.
2360
+ # @return [Integer]
2361
+ #
2362
+ # @!attribute [rw] channel_definitions
2363
+ # The definitions of the channels in a streaming channel.
2364
+ # @return [Array<Types::ChannelDefinition>]
2365
+ #
2366
+ # @see http://docs.aws.amazon.com/goto/WebAPI/chime-sdk-media-pipelines-2021-07-15/StreamChannelDefinition AWS API Documentation
2367
+ #
2368
+ class StreamChannelDefinition < Struct.new(
2369
+ :number_of_channels,
2370
+ :channel_definitions)
2371
+ SENSITIVE = []
2372
+ include Aws::Structure
2373
+ end
2374
+
2375
+ # The configuration settings for a stream.
2376
+ #
2377
+ # @!attribute [rw] stream_arn
2378
+ # The ARN of the stream.
2379
+ # @return [String]
2380
+ #
2381
+ # @!attribute [rw] fragment_number
2382
+ # The unique identifier of the fragment to begin processing.
2383
+ # @return [String]
2384
+ #
2385
+ # @!attribute [rw] stream_channel_definition
2386
+ # The streaming channel definition in the stream configuration.
2387
+ # @return [Types::StreamChannelDefinition]
2388
+ #
2389
+ # @see http://docs.aws.amazon.com/goto/WebAPI/chime-sdk-media-pipelines-2021-07-15/StreamConfiguration AWS API Documentation
2390
+ #
2391
+ class StreamConfiguration < Struct.new(
2392
+ :stream_arn,
2393
+ :fragment_number,
2394
+ :stream_channel_definition)
2395
+ SENSITIVE = []
2396
+ include Aws::Structure
2397
+ end
2398
+
1166
2399
  # A key/value pair that grants users access to meeting resources.
1167
2400
  #
1168
2401
  # @!attribute [rw] key
@@ -1214,7 +2447,7 @@ module Aws::ChimeSDKMediaPipelines
1214
2447
  # @return [String]
1215
2448
  #
1216
2449
  # @!attribute [rw] request_id
1217
- # The request id associated with the call responsible for the
2450
+ # The request ID associated with the call responsible for the
1218
2451
  # exception.
1219
2452
  # @return [String]
1220
2453
  #
@@ -1228,6 +2461,25 @@ module Aws::ChimeSDKMediaPipelines
1228
2461
  include Aws::Structure
1229
2462
  end
1230
2463
 
2464
+ # The range of timestamps to return.
2465
+ #
2466
+ # @!attribute [rw] start_timestamp
2467
+ # The starting timestamp for the specified range.
2468
+ # @return [Time]
2469
+ #
2470
+ # @!attribute [rw] end_timestamp
2471
+ # The ending timestamp for the specified range.
2472
+ # @return [Time]
2473
+ #
2474
+ # @see http://docs.aws.amazon.com/goto/WebAPI/chime-sdk-media-pipelines-2021-07-15/TimestampRange AWS API Documentation
2475
+ #
2476
+ class TimestampRange < Struct.new(
2477
+ :start_timestamp,
2478
+ :end_timestamp)
2479
+ SENSITIVE = []
2480
+ include Aws::Structure
2481
+ end
2482
+
1231
2483
  # The configuration object for concatenating transcription messages.
1232
2484
  #
1233
2485
  # @!attribute [rw] state
@@ -1251,7 +2503,7 @@ module Aws::ChimeSDKMediaPipelines
1251
2503
  # @return [String]
1252
2504
  #
1253
2505
  # @!attribute [rw] request_id
1254
- # The request id associated with the call responsible for the
2506
+ # The request ID associated with the call responsible for the
1255
2507
  # exception.
1256
2508
  # @return [String]
1257
2509
  #
@@ -1286,6 +2538,68 @@ module Aws::ChimeSDKMediaPipelines
1286
2538
  #
1287
2539
  class UntagResourceResponse < Aws::EmptyStructure; end
1288
2540
 
2541
+ # @!attribute [rw] identifier
2542
+ # The unique identifier for the resource to be updated. Valid values
2543
+ # include the name and ARN of the media insights pipeline
2544
+ # configuration.
2545
+ # @return [String]
2546
+ #
2547
+ # @!attribute [rw] resource_access_role_arn
2548
+ # The ARN of the role used by the service to access Amazon Web
2549
+ # Services resources.
2550
+ # @return [String]
2551
+ #
2552
+ # @!attribute [rw] real_time_alert_configuration
2553
+ # The configuration settings for real-time alerts for the media
2554
+ # insights pipeline.
2555
+ # @return [Types::RealTimeAlertConfiguration]
2556
+ #
2557
+ # @!attribute [rw] elements
2558
+ # The elements in the request, such as a processor for Amazon
2559
+ # Transcribe or a sink for a Kinesis Data Stream..
2560
+ # @return [Array<Types::MediaInsightsPipelineConfigurationElement>]
2561
+ #
2562
+ # @see http://docs.aws.amazon.com/goto/WebAPI/chime-sdk-media-pipelines-2021-07-15/UpdateMediaInsightsPipelineConfigurationRequest AWS API Documentation
2563
+ #
2564
+ class UpdateMediaInsightsPipelineConfigurationRequest < Struct.new(
2565
+ :identifier,
2566
+ :resource_access_role_arn,
2567
+ :real_time_alert_configuration,
2568
+ :elements)
2569
+ SENSITIVE = [:resource_access_role_arn]
2570
+ include Aws::Structure
2571
+ end
2572
+
2573
+ # @!attribute [rw] media_insights_pipeline_configuration
2574
+ # The updated configuration settings.
2575
+ # @return [Types::MediaInsightsPipelineConfiguration]
2576
+ #
2577
+ # @see http://docs.aws.amazon.com/goto/WebAPI/chime-sdk-media-pipelines-2021-07-15/UpdateMediaInsightsPipelineConfigurationResponse AWS API Documentation
2578
+ #
2579
+ class UpdateMediaInsightsPipelineConfigurationResponse < Struct.new(
2580
+ :media_insights_pipeline_configuration)
2581
+ SENSITIVE = []
2582
+ include Aws::Structure
2583
+ end
2584
+
2585
+ # @!attribute [rw] identifier
2586
+ # The unique identifier of the resource to be updated. Valid values
2587
+ # include the ID and ARN of the media insights pipeline.
2588
+ # @return [String]
2589
+ #
2590
+ # @!attribute [rw] update_status
2591
+ # The requested status of the media insights pipeline.
2592
+ # @return [String]
2593
+ #
2594
+ # @see http://docs.aws.amazon.com/goto/WebAPI/chime-sdk-media-pipelines-2021-07-15/UpdateMediaInsightsPipelineStatusRequest AWS API Documentation
2595
+ #
2596
+ class UpdateMediaInsightsPipelineStatusRequest < Struct.new(
2597
+ :identifier,
2598
+ :update_status)
2599
+ SENSITIVE = []
2600
+ include Aws::Structure
2601
+ end
2602
+
1289
2603
  # The video artifact configuration object.
1290
2604
  #
1291
2605
  # @!attribute [rw] state
@@ -1305,7 +2619,7 @@ module Aws::ChimeSDKMediaPipelines
1305
2619
  include Aws::Structure
1306
2620
  end
1307
2621
 
1308
- # The configuration object of a video contacatentation pipeline.
2622
+ # The configuration object of a video concatenation pipeline.
1309
2623
  #
1310
2624
  # @!attribute [rw] state
1311
2625
  # Enables or disables the configuration object.
@@ -1319,5 +2633,24 @@ module Aws::ChimeSDKMediaPipelines
1319
2633
  include Aws::Structure
1320
2634
  end
1321
2635
 
2636
+ # The configuration settings for a voice analytics processor.
2637
+ #
2638
+ # @!attribute [rw] speaker_search_status
2639
+ # The status of the speaker search task.
2640
+ # @return [String]
2641
+ #
2642
+ # @!attribute [rw] voice_tone_analysis_status
2643
+ # The status of the voice tone analysis task.
2644
+ # @return [String]
2645
+ #
2646
+ # @see http://docs.aws.amazon.com/goto/WebAPI/chime-sdk-media-pipelines-2021-07-15/VoiceAnalyticsProcessorConfiguration AWS API Documentation
2647
+ #
2648
+ class VoiceAnalyticsProcessorConfiguration < Struct.new(
2649
+ :speaker_search_status,
2650
+ :voice_tone_analysis_status)
2651
+ SENSITIVE = []
2652
+ include Aws::Structure
2653
+ end
2654
+
1322
2655
  end
1323
2656
  end