aws-sdk-elementalinference 1.3.0 → 1.5.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.
@@ -23,29 +23,59 @@ module Aws::ElementalInference
23
23
  include Aws::Structure
24
24
  end
25
25
 
26
+ # The width and height of the output video. Used in SubtitlingConfig to
27
+ # determine subtitle layout.
28
+ #
29
+ # @!attribute [rw] width
30
+ # The width component of the aspect ratio (for example, 16 in a 16:9
31
+ # ratio).
32
+ # @return [Integer]
33
+ #
34
+ # @!attribute [rw] height
35
+ # The height component of the aspect ratio (for example, 9 in a 16:9
36
+ # ratio).
37
+ # @return [Integer]
38
+ #
39
+ # @see http://docs.aws.amazon.com/goto/WebAPI/elementalinference-2018-11-14/AspectRatio AWS API Documentation
40
+ #
41
+ class AspectRatio < Struct.new(
42
+ :width,
43
+ :height)
44
+ SENSITIVE = []
45
+ include Aws::Structure
46
+ end
47
+
26
48
  # @!attribute [rw] id
27
49
  # The ID of the feed.
28
50
  # @return [String]
29
51
  #
30
52
  # @!attribute [rw] associated_resource_name
31
- # An identifier for the resource. If the resource is from an AWS
32
- # service, this identifier must be the full ARN of that resource.
33
- # Otherwise, the identifier is a name that you assign and that is
34
- # appropriate for the application that owns the resource. This name
35
- # must not resemble an ARN.
53
+ # An identifier for the resource. This name must not resemble an ARN.
54
+ #
55
+ # The resource is the source media that the feed will process. The
56
+ # name you assign should help you to later identify the source media
57
+ # that belongs to the feed. In this way, you will know which source
58
+ # media to push to the feed (using PutMedia).
36
59
  #
37
60
  # **A suitable default value is auto-generated.** You should normally
38
61
  # not need to pass this option.
39
62
  # @return [String]
40
63
  #
41
64
  # @!attribute [rw] outputs
42
- # The outputs to add to this feed. You must specify at least one
43
- # output. You can later use the UpdateFeed action to change the list
44
- # of outputs.
65
+ # An array of one or more outputs that you want to add to this feed
66
+ # now, to supplement any outputs that you specified when you created
67
+ # or updated the feed.
45
68
  # @return [Array<Types::CreateOutput>]
46
69
  #
47
70
  # @!attribute [rw] dry_run
48
71
  # Set to true if you want to do a dry run of the associate action.
72
+ #
73
+ # Elemental Inference will validate that the real request would
74
+ # succeed without actually making any changes. A dry run catches
75
+ # errors such as missing IAM permissions, quota limits exceeded,
76
+ # conflicting outputs, and so on. If the dry run fails, the action
77
+ # returns a 4xx error code. After you've fixed the errors, resubmit
78
+ # the request.
49
79
  # @return [Boolean]
50
80
  #
51
81
  # @see http://docs.aws.amazon.com/goto/WebAPI/elementalinference-2018-11-14/AssociateFeedRequest AWS API Documentation
@@ -60,12 +90,11 @@ module Aws::ElementalInference
60
90
  end
61
91
 
62
92
  # @!attribute [rw] arn
63
- # The AWS ARN for this association.
93
+ # The ARN of the feed.
64
94
  # @return [String]
65
95
  #
66
96
  # @!attribute [rw] id
67
- # An ID for this response. It is unique in Elemental Inference for
68
- # this AWS account.
97
+ # The ID of the feed.
69
98
  # @return [String]
70
99
  #
71
100
  # @see http://docs.aws.amazon.com/goto/WebAPI/elementalinference-2018-11-14/AssociateFeedResponse AWS API Documentation
@@ -81,8 +110,9 @@ module Aws::ElementalInference
81
110
  # feature.
82
111
  #
83
112
  # @!attribute [rw] callback_metadata
84
- # The metadata that is the result of the clip request to Elemental
85
- # Inference.
113
+ # A string that you want Elemental Inference to always include in the
114
+ # event clipping metadata for this output. The string might identify
115
+ # the sports event in the source media, for example.
86
116
  # @return [String]
87
117
  #
88
118
  # @see http://docs.aws.amazon.com/goto/WebAPI/elementalinference-2018-11-14/ClippingConfig AWS API Documentation
@@ -107,18 +137,92 @@ module Aws::ElementalInference
107
137
  end
108
138
 
109
139
  # @!attribute [rw] name
110
- # A name for this feed.
140
+ # A user-friendly name for this dictionary.
141
+ # @return [String]
142
+ #
143
+ # @!attribute [rw] language
144
+ # The language of the dictionary entries. Specify the language using
145
+ # an ISO 639-2/T three-letter code. Supported values: eng, fra, ita,
146
+ # deu, spa, por.
147
+ # @return [String]
148
+ #
149
+ # @!attribute [rw] entries
150
+ # The dictionary entries payload. Contains the custom words and
151
+ # phrases for the dictionary. Maximum size is 40,960 characters.
152
+ # @return [String]
153
+ #
154
+ # @!attribute [rw] tags
155
+ # Optional tags to associate with the dictionary.
156
+ # @return [Hash<String,String>]
157
+ #
158
+ # @see http://docs.aws.amazon.com/goto/WebAPI/elementalinference-2018-11-14/CreateDictionaryRequest AWS API Documentation
159
+ #
160
+ class CreateDictionaryRequest < Struct.new(
161
+ :name,
162
+ :language,
163
+ :entries,
164
+ :tags)
165
+ SENSITIVE = []
166
+ include Aws::Structure
167
+ end
168
+
169
+ # @!attribute [rw] name
170
+ # The name that you specified in the request.
171
+ # @return [String]
172
+ #
173
+ # @!attribute [rw] arn
174
+ # The ARN of the dictionary.
175
+ # @return [String]
176
+ #
177
+ # @!attribute [rw] id
178
+ # A unique ID that Elemental Inference assigns to the dictionary.
179
+ # @return [String]
180
+ #
181
+ # @!attribute [rw] language
182
+ # The language of the dictionary.
183
+ # @return [String]
184
+ #
185
+ # @!attribute [rw] status
186
+ # The current status of the dictionary. After creation succeeds, the
187
+ # status will be AVAILABLE.
188
+ # @return [String]
189
+ #
190
+ # @!attribute [rw] references
191
+ # A list of feed IDs that reference this dictionary.
192
+ # @return [Array<String>]
193
+ #
194
+ # @!attribute [rw] tags
195
+ # Any tags that you included when you created the dictionary.
196
+ # @return [Hash<String,String>]
197
+ #
198
+ # @see http://docs.aws.amazon.com/goto/WebAPI/elementalinference-2018-11-14/CreateDictionaryResponse AWS API Documentation
199
+ #
200
+ class CreateDictionaryResponse < Struct.new(
201
+ :name,
202
+ :arn,
203
+ :id,
204
+ :language,
205
+ :status,
206
+ :references,
207
+ :tags)
208
+ SENSITIVE = []
209
+ include Aws::Structure
210
+ end
211
+
212
+ # @!attribute [rw] name
213
+ # A user-friendly name for this feed.
111
214
  # @return [String]
112
215
  #
113
216
  # @!attribute [rw] outputs
114
217
  # An array of outputs for this feed. Each output represents a specific
115
- # Elemental Inference feature. For example, an output might represent
116
- # the crop feature.
218
+ # Elemental Inference feature. For example, there is one output type
219
+ # for the smart crop feature. You must specify at least one output,
220
+ # but you can later add outputs using AssociateFeed, or add, modify,
221
+ # and delete outputs using UpdateFeed.
117
222
  # @return [Array<Types::CreateOutput>]
118
223
  #
119
224
  # @!attribute [rw] tags
120
- # If you want to include tags, add them now. You won't be able to add
121
- # them later.
225
+ # Optional tags. You can also add tags later, using TagResource.
122
226
  # @return [Hash<String,String>]
123
227
  #
124
228
  # @see http://docs.aws.amazon.com/goto/WebAPI/elementalinference-2018-11-14/CreateFeedRequest AWS API Documentation
@@ -136,7 +240,7 @@ module Aws::ElementalInference
136
240
  # @return [String]
137
241
  #
138
242
  # @!attribute [rw] name
139
- # The name that you specified.
243
+ # The name that you specified in the request.
140
244
  # @return [String]
141
245
  #
142
246
  # @!attribute [rw] id
@@ -144,11 +248,15 @@ module Aws::ElementalInference
144
248
  # @return [String]
145
249
  #
146
250
  # @!attribute [rw] data_endpoints
147
- # A unique ARN that Elemental Inference assigns to the feed.
251
+ # An array of endpoints for the feed. Typically, there is only one
252
+ # endpoint. The feed receives source media at this endpoint (when the
253
+ # calling application calls PutMedia) and returns the resulting
254
+ # metadata to this endpoint (when the calling application calls
255
+ # GetMetadata).
148
256
  # @return [Array<String>]
149
257
  #
150
258
  # @!attribute [rw] outputs
151
- # Data endpoints that Elemental Inference assigns to the feed.
259
+ # Repeats the outputs that you specified in the request.
152
260
  # @return [Array<Types::GetOutput>]
153
261
  #
154
262
  # @!attribute [rw] status
@@ -159,7 +267,7 @@ module Aws::ElementalInference
159
267
  # @!attribute [rw] association
160
268
  # The association for this feed. When you create the feed, this
161
269
  # property is empty. You must associate a resource with the feed using
162
- # AssociateFeed.
270
+ # AssociateFeed or UpdateFeed.
163
271
  # @return [Types::FeedAssociation]
164
272
  #
165
273
  # @!attribute [rw] tags
@@ -189,11 +297,10 @@ module Aws::ElementalInference
189
297
  # @return [String]
190
298
  #
191
299
  # @!attribute [rw] output_config
192
- # A typed property for an output in a feed. It is used in the
193
- # CreateFeed and AssociateFeed actions. It identifies the action for
194
- # Elemental Inference to perform. It also provides a repository for
195
- # the results of that action. For example, CroppingConfig output will
196
- # contain the metadata for the crop feature.
300
+ # A typed property for an output in a feed. It identifies the action
301
+ # for Elemental Inference to perform. It also provides a repository
302
+ # for the results of that action. For example, CroppingConfig output
303
+ # will contain the metadata for the crop feature.
197
304
  # @return [Types::OutputConfig]
198
305
  #
199
306
  # @!attribute [rw] status
@@ -224,6 +331,40 @@ module Aws::ElementalInference
224
331
  #
225
332
  class CroppingConfig < Aws::EmptyStructure; end
226
333
 
334
+ # @!attribute [rw] id
335
+ # The ID of the dictionary to delete.
336
+ # @return [String]
337
+ #
338
+ # @see http://docs.aws.amazon.com/goto/WebAPI/elementalinference-2018-11-14/DeleteDictionaryRequest AWS API Documentation
339
+ #
340
+ class DeleteDictionaryRequest < Struct.new(
341
+ :id)
342
+ SENSITIVE = []
343
+ include Aws::Structure
344
+ end
345
+
346
+ # @!attribute [rw] arn
347
+ # The ARN of the deleted dictionary.
348
+ # @return [String]
349
+ #
350
+ # @!attribute [rw] id
351
+ # The ID of the deleted dictionary.
352
+ # @return [String]
353
+ #
354
+ # @!attribute [rw] status
355
+ # The status of the dictionary after deletion.
356
+ # @return [String]
357
+ #
358
+ # @see http://docs.aws.amazon.com/goto/WebAPI/elementalinference-2018-11-14/DeleteDictionaryResponse AWS API Documentation
359
+ #
360
+ class DeleteDictionaryResponse < Struct.new(
361
+ :arn,
362
+ :id,
363
+ :status)
364
+ SENSITIVE = []
365
+ include Aws::Structure
366
+ end
367
+
227
368
  # @!attribute [rw] id
228
369
  # The ID of the feed.
229
370
  # @return [String]
@@ -259,12 +400,47 @@ module Aws::ElementalInference
259
400
  include Aws::Structure
260
401
  end
261
402
 
403
+ # Contains summary information about a dictionary. Used in the
404
+ # ListDictionaries response.
405
+ #
406
+ # @!attribute [rw] arn
407
+ # The ARN of the dictionary.
408
+ # @return [String]
409
+ #
410
+ # @!attribute [rw] id
411
+ # The ID of the dictionary.
412
+ # @return [String]
413
+ #
414
+ # @!attribute [rw] name
415
+ # The name of the dictionary.
416
+ # @return [String]
417
+ #
418
+ # @!attribute [rw] language
419
+ # The language of the dictionary.
420
+ # @return [String]
421
+ #
422
+ # @!attribute [rw] status
423
+ # The status of the dictionary.
424
+ # @return [String]
425
+ #
426
+ # @see http://docs.aws.amazon.com/goto/WebAPI/elementalinference-2018-11-14/DictionarySummary AWS API Documentation
427
+ #
428
+ class DictionarySummary < Struct.new(
429
+ :arn,
430
+ :id,
431
+ :name,
432
+ :language,
433
+ :status)
434
+ SENSITIVE = []
435
+ include Aws::Structure
436
+ end
437
+
262
438
  # @!attribute [rw] id
263
439
  # The ID of the feed where you want to release the resource.
264
440
  # @return [String]
265
441
  #
266
442
  # @!attribute [rw] associated_resource_name
267
- # The name of the resource currently associated with the feed'.
443
+ # The name of the resource currently associated with the feed.
268
444
  #
269
445
  # **A suitable default value is auto-generated.** You should normally
270
446
  # not need to pass this option.
@@ -272,6 +448,11 @@ module Aws::ElementalInference
272
448
  #
273
449
  # @!attribute [rw] dry_run
274
450
  # Set to true if you want to do a dry run of the disassociate action.
451
+ #
452
+ # Elemental Inference will validate that the real request would
453
+ # succeed without actually making any changes. A dry run catches
454
+ # errors such as missing IAM permissions. If the dry run fails, the
455
+ # action returns a 4xx error code.
275
456
  # @return [Boolean]
276
457
  #
277
458
  # @see http://docs.aws.amazon.com/goto/WebAPI/elementalinference-2018-11-14/DisassociateFeedRequest AWS API Documentation
@@ -285,11 +466,11 @@ module Aws::ElementalInference
285
466
  end
286
467
 
287
468
  # @!attribute [rw] arn
288
- # The ID of the feed where you deleted the associated resource.
469
+ # The ARN of the feed.
289
470
  # @return [String]
290
471
  #
291
472
  # @!attribute [rw] id
292
- # The ARN of the resource that you deleted.
473
+ # The ID of the feed.
293
474
  # @return [String]
294
475
  #
295
476
  # @see http://docs.aws.amazon.com/goto/WebAPI/elementalinference-2018-11-14/DisassociateFeedResponse AWS API Documentation
@@ -301,6 +482,30 @@ module Aws::ElementalInference
301
482
  include Aws::Structure
302
483
  end
303
484
 
485
+ # @!attribute [rw] id
486
+ # The ID of the dictionary whose entries you want to export.
487
+ # @return [String]
488
+ #
489
+ # @see http://docs.aws.amazon.com/goto/WebAPI/elementalinference-2018-11-14/ExportDictionaryEntriesRequest AWS API Documentation
490
+ #
491
+ class ExportDictionaryEntriesRequest < Struct.new(
492
+ :id)
493
+ SENSITIVE = []
494
+ include Aws::Structure
495
+ end
496
+
497
+ # @!attribute [rw] entries
498
+ # The dictionary entries payload.
499
+ # @return [String]
500
+ #
501
+ # @see http://docs.aws.amazon.com/goto/WebAPI/elementalinference-2018-11-14/ExportDictionaryEntriesResponse AWS API Documentation
502
+ #
503
+ class ExportDictionaryEntriesResponse < Struct.new(
504
+ :entries)
505
+ SENSITIVE = []
506
+ include Aws::Structure
507
+ end
508
+
304
509
  # Contains information about the resource that is associated with a
305
510
  # feed. It is used in the FeedSummary that is used in the response of a
306
511
  # ListFeeds action.
@@ -318,7 +523,7 @@ module Aws::ElementalInference
318
523
  end
319
524
 
320
525
  # Contains configuration information about a feed. It is used in the
321
- # ListFeeds action.
526
+ # ListFeeds response.
322
527
  #
323
528
  # @!attribute [rw] arn
324
529
  # The ARN of the feed.
@@ -352,6 +557,60 @@ module Aws::ElementalInference
352
557
  include Aws::Structure
353
558
  end
354
559
 
560
+ # @!attribute [rw] id
561
+ # The ID of the dictionary to retrieve.
562
+ # @return [String]
563
+ #
564
+ # @see http://docs.aws.amazon.com/goto/WebAPI/elementalinference-2018-11-14/GetDictionaryRequest AWS API Documentation
565
+ #
566
+ class GetDictionaryRequest < Struct.new(
567
+ :id)
568
+ SENSITIVE = []
569
+ include Aws::Structure
570
+ end
571
+
572
+ # @!attribute [rw] name
573
+ # The name of the dictionary.
574
+ # @return [String]
575
+ #
576
+ # @!attribute [rw] arn
577
+ # The ARN of the dictionary.
578
+ # @return [String]
579
+ #
580
+ # @!attribute [rw] id
581
+ # The ID of the dictionary.
582
+ # @return [String]
583
+ #
584
+ # @!attribute [rw] language
585
+ # The language of the dictionary.
586
+ # @return [String]
587
+ #
588
+ # @!attribute [rw] status
589
+ # The current status of the dictionary.
590
+ # @return [String]
591
+ #
592
+ # @!attribute [rw] references
593
+ # A list of feed IDs that reference this dictionary.
594
+ # @return [Array<String>]
595
+ #
596
+ # @!attribute [rw] tags
597
+ # The tags associated with the dictionary.
598
+ # @return [Hash<String,String>]
599
+ #
600
+ # @see http://docs.aws.amazon.com/goto/WebAPI/elementalinference-2018-11-14/GetDictionaryResponse AWS API Documentation
601
+ #
602
+ class GetDictionaryResponse < Struct.new(
603
+ :name,
604
+ :arn,
605
+ :id,
606
+ :language,
607
+ :status,
608
+ :references,
609
+ :tags)
610
+ SENSITIVE = []
611
+ include Aws::Structure
612
+ end
613
+
355
614
  # @!attribute [rw] id
356
615
  # The ID of the feed to query.
357
616
  # @return [String]
@@ -369,32 +628,33 @@ module Aws::ElementalInference
369
628
  # @return [String]
370
629
  #
371
630
  # @!attribute [rw] name
372
- # The name of the feed being queried.
631
+ # The name of the feed.
373
632
  # @return [String]
374
633
  #
375
634
  # @!attribute [rw] id
376
- # The ID of the feed being queried.
635
+ # The ID of the feed.
377
636
  # @return [String]
378
637
  #
379
638
  # @!attribute [rw] data_endpoints
380
- # The dataEndpoints of the feed being queried.
639
+ # The dataEndpoints of the feed.
381
640
  # @return [Array<String>]
382
641
  #
383
642
  # @!attribute [rw] outputs
384
- # An array of the outputs in the feed being queried.
643
+ # An array of the outputs in the feed.
385
644
  # @return [Array<Types::GetOutput>]
386
645
  #
387
646
  # @!attribute [rw] status
388
- # The status of the feed being queried.
647
+ # The status of the feed.
389
648
  # @return [String]
390
649
  #
391
650
  # @!attribute [rw] association
392
- # Information about the resource, if any, associated with the feed
393
- # being queried.
651
+ # Information about the resource that is associated with the feed.
652
+ # It's possible that there is no associated resource. This is not an
653
+ # error.
394
654
  # @return [Types::FeedAssociation]
395
655
  #
396
656
  # @!attribute [rw] tags
397
- # A list of the tags, if any, for the feed being queried.
657
+ # A list of the tags, if any, for the feed.
398
658
  # @return [Hash<String,String>]
399
659
  #
400
660
  # @see http://docs.aws.amazon.com/goto/WebAPI/elementalinference-2018-11-14/GetFeedResponse AWS API Documentation
@@ -413,18 +673,17 @@ module Aws::ElementalInference
413
673
  end
414
674
 
415
675
  # Contains configuration information about one output in a feed. It is
416
- # used in the GetFeed action.
676
+ # used in the GetFeed response.
417
677
  #
418
678
  # @!attribute [rw] name
419
- # The ARN of the output.
679
+ # The name of the output.
420
680
  # @return [String]
421
681
  #
422
682
  # @!attribute [rw] output_config
423
- # A typed property for an output in a feed. It is used in the GetFeed
424
- # action. It identifies the action for Elemental Inference to perform.
425
- # It also provides a repository for the results of that action. For
426
- # example, CroppingConfig output will contain the metadata for the
427
- # crop feature.
683
+ # A typed property for an output in a feed. It identifies the action
684
+ # for Elemental Inference to perform. It also provides a repository
685
+ # for the results of that action. For example, CroppingConfig output
686
+ # will contain the metadata for the crop feature.
428
687
  # @return [Types::OutputConfig]
429
688
  #
430
689
  # @!attribute [rw] status
@@ -436,10 +695,12 @@ module Aws::ElementalInference
436
695
  # @return [String]
437
696
  #
438
697
  # @!attribute [rw] from_association
439
- # True means that the output was originally created in the feed by the
440
- # AssociateFeed operation. False means it was created using CreateFeed
441
- # or UpdateFeed. You will need this value if you use the UpdateFeed
442
- # operation to modify the list of outputs in the feed.
698
+ # True means that the output was originally created in the feed using
699
+ # AssociateFeed. False means it was created using CreateFeed or
700
+ # UpdateFeed.
701
+ #
702
+ # You will need this value if you use UpdateFeed to modify the list of
703
+ # outputs in the feed.
443
704
  # @return [Boolean]
444
705
  #
445
706
  # @see http://docs.aws.amazon.com/goto/WebAPI/elementalinference-2018-11-14/GetOutput AWS API Documentation
@@ -469,6 +730,41 @@ module Aws::ElementalInference
469
730
  include Aws::Structure
470
731
  end
471
732
 
733
+ # @!attribute [rw] max_results
734
+ # The maximum number of results to return per API request. Valid
735
+ # range: 1 to 100.
736
+ # @return [Integer]
737
+ #
738
+ # @!attribute [rw] next_token
739
+ # The token that identifies the next batch of results to return.
740
+ # @return [String]
741
+ #
742
+ # @see http://docs.aws.amazon.com/goto/WebAPI/elementalinference-2018-11-14/ListDictionariesRequest AWS API Documentation
743
+ #
744
+ class ListDictionariesRequest < Struct.new(
745
+ :max_results,
746
+ :next_token)
747
+ SENSITIVE = []
748
+ include Aws::Structure
749
+ end
750
+
751
+ # @!attribute [rw] dictionaries
752
+ # A list of DictionarySummary objects.
753
+ # @return [Array<Types::DictionarySummary>]
754
+ #
755
+ # @!attribute [rw] next_token
756
+ # The token to use to retrieve the next batch of results.
757
+ # @return [String]
758
+ #
759
+ # @see http://docs.aws.amazon.com/goto/WebAPI/elementalinference-2018-11-14/ListDictionariesResponse AWS API Documentation
760
+ #
761
+ class ListDictionariesResponse < Struct.new(
762
+ :dictionaries,
763
+ :next_token)
764
+ SENSITIVE = []
765
+ include Aws::Structure
766
+ end
767
+
472
768
  # @!attribute [rw] max_results
473
769
  # The maximum number of results to return per API request.
474
770
  #
@@ -487,11 +783,10 @@ module Aws::ElementalInference
487
783
  # @!attribute [rw] next_token
488
784
  # The token that identifies the batch of results that you want to see.
489
785
  #
490
- # For example, you submit a ListBridges request with MaxResults set at
786
+ # For example, you submit a ListFeeds request with MaxResults set at
491
787
  # 5. The service returns the first batch of results (up to 5) and a
492
788
  # NextToken value. To see the next batch of results, you can submit
493
- # the ListBridges request a second time and specify the NextToken
494
- # value.
789
+ # the ListFeeds request a second time and specify the NextToken value.
495
790
  # @return [String]
496
791
  #
497
792
  # @see http://docs.aws.amazon.com/goto/WebAPI/elementalinference-2018-11-14/ListFeedsRequest AWS API Documentation
@@ -504,7 +799,7 @@ module Aws::ElementalInference
504
799
  end
505
800
 
506
801
  # @!attribute [rw] feeds
507
- # A list of feed summaries.
802
+ # A list of FeedSummary objects.
508
803
  # @return [Array<Types::FeedSummary>]
509
804
  #
510
805
  # @!attribute [rw] next_token
@@ -563,11 +858,16 @@ module Aws::ElementalInference
563
858
  # The output config type that applies to the clipping feature.
564
859
  # @return [Types::ClippingConfig]
565
860
  #
861
+ # @!attribute [rw] subtitling
862
+ # The output config type that applies to the smart subtitling feature.
863
+ # @return [Types::SubtitlingConfig]
864
+ #
566
865
  # @see http://docs.aws.amazon.com/goto/WebAPI/elementalinference-2018-11-14/OutputConfig AWS API Documentation
567
866
  #
568
867
  class OutputConfig < Struct.new(
569
868
  :cropping,
570
869
  :clipping,
870
+ :subtitling,
571
871
  :unknown)
572
872
  SENSITIVE = []
573
873
  include Aws::Structure
@@ -575,6 +875,7 @@ module Aws::ElementalInference
575
875
 
576
876
  class Cropping < OutputConfig; end
577
877
  class Clipping < OutputConfig; end
878
+ class Subtitling < OutputConfig; end
578
879
  class Unknown < OutputConfig; end
579
880
  end
580
881
 
@@ -606,6 +907,48 @@ module Aws::ElementalInference
606
907
  include Aws::Structure
607
908
  end
608
909
 
910
+ # A type of OutputConfig, used when the output in a feed is for the
911
+ # smart subtitling feature. smart subtitling uses automatic speech
912
+ # recognition (ASR) to generate live TTML subtitles from the audio in
913
+ # your source media.
914
+ #
915
+ # @!attribute [rw] language
916
+ # The language of the audio in the source media. Elemental Inference
917
+ # uses this setting to optimize transcription accuracy. Specify the
918
+ # language using an ISO 639-2/T three-letter code, optionally with a
919
+ # region subtag. Supported values: eng, eng-au, eng-gb, eng-us, fra,
920
+ # ita, deu, spa, por.
921
+ # @return [String]
922
+ #
923
+ # @!attribute [rw] aspect_ratio
924
+ # The aspect ratio of the output video, specified as width and height
925
+ # integer values. Elemental Inference uses the aspect ratio to
926
+ # determine subtitle layout and line lengths.
927
+ # @return [Types::AspectRatio]
928
+ #
929
+ # @!attribute [rw] dictionary
930
+ # The ID of a custom dictionary to improve transcription accuracy for
931
+ # domain-specific terminology. Use the CreateDictionary operation to
932
+ # create a dictionary.
933
+ # @return [String]
934
+ #
935
+ # @!attribute [rw] profanity_filter
936
+ # Controls how profanity is handled in the generated subtitles. Valid
937
+ # values: DISABLED (no filtering, default), CENSOR (replace profanity
938
+ # with asterisks), DROP (remove profanity from the transcript).
939
+ # @return [String]
940
+ #
941
+ # @see http://docs.aws.amazon.com/goto/WebAPI/elementalinference-2018-11-14/SubtitlingConfig AWS API Documentation
942
+ #
943
+ class SubtitlingConfig < Struct.new(
944
+ :language,
945
+ :aspect_ratio,
946
+ :dictionary,
947
+ :profanity_filter)
948
+ SENSITIVE = []
949
+ include Aws::Structure
950
+ end
951
+
609
952
  # @!attribute [rw] resource_arn
610
953
  # The ARN of the resource where you want to add tags.
611
954
  # @return [String]
@@ -655,6 +998,78 @@ module Aws::ElementalInference
655
998
  include Aws::Structure
656
999
  end
657
1000
 
1001
+ # @!attribute [rw] id
1002
+ # The ID of the dictionary to update.
1003
+ # @return [String]
1004
+ #
1005
+ # @!attribute [rw] name
1006
+ # A new name for the dictionary. If not specified, the name is not
1007
+ # changed.
1008
+ # @return [String]
1009
+ #
1010
+ # @!attribute [rw] language
1011
+ # A new language for the dictionary. If not specified, the language is
1012
+ # not changed.
1013
+ # @return [String]
1014
+ #
1015
+ # @!attribute [rw] entries
1016
+ # New dictionary entries. If not specified, the entries are not
1017
+ # changed.
1018
+ # @return [String]
1019
+ #
1020
+ # @see http://docs.aws.amazon.com/goto/WebAPI/elementalinference-2018-11-14/UpdateDictionaryRequest AWS API Documentation
1021
+ #
1022
+ class UpdateDictionaryRequest < Struct.new(
1023
+ :id,
1024
+ :name,
1025
+ :language,
1026
+ :entries)
1027
+ SENSITIVE = []
1028
+ include Aws::Structure
1029
+ end
1030
+
1031
+ # @!attribute [rw] name
1032
+ # The updated or original name of the dictionary.
1033
+ # @return [String]
1034
+ #
1035
+ # @!attribute [rw] arn
1036
+ # The ARN of the dictionary.
1037
+ # @return [String]
1038
+ #
1039
+ # @!attribute [rw] id
1040
+ # The ID of the dictionary.
1041
+ # @return [String]
1042
+ #
1043
+ # @!attribute [rw] language
1044
+ # The updated or original language of the dictionary.
1045
+ # @return [String]
1046
+ #
1047
+ # @!attribute [rw] status
1048
+ # The current status of the dictionary.
1049
+ # @return [String]
1050
+ #
1051
+ # @!attribute [rw] references
1052
+ # A list of feed IDs that reference this dictionary.
1053
+ # @return [Array<String>]
1054
+ #
1055
+ # @!attribute [rw] tags
1056
+ # Any tags associated with the dictionary.
1057
+ # @return [Hash<String,String>]
1058
+ #
1059
+ # @see http://docs.aws.amazon.com/goto/WebAPI/elementalinference-2018-11-14/UpdateDictionaryResponse AWS API Documentation
1060
+ #
1061
+ class UpdateDictionaryResponse < Struct.new(
1062
+ :name,
1063
+ :arn,
1064
+ :id,
1065
+ :language,
1066
+ :status,
1067
+ :references,
1068
+ :tags)
1069
+ SENSITIVE = []
1070
+ include Aws::Structure
1071
+ end
1072
+
658
1073
  # @!attribute [rw] name
659
1074
  # Required. You can specify the existing name (to leave it unchanged)
660
1075
  # or a new name.
@@ -701,18 +1116,16 @@ module Aws::ElementalInference
701
1116
  # @return [Array<Types::GetOutput>]
702
1117
  #
703
1118
  # @!attribute [rw] status
704
- # The status of the output.
1119
+ # The status of the feed.
705
1120
  # @return [String]
706
1121
  #
707
1122
  # @!attribute [rw] association
708
- # True means that the output was originally created in the feed by the
709
- # AssociateFeed operation. False means it was created using CreateFeed
710
- # or UpdateFeed. You will need this value if you use the UpdateFeed
711
- # operation to modify the list of outputs in the feed.
1123
+ # Information about the resource that is associated with the feed, if
1124
+ # any.
712
1125
  # @return [Types::FeedAssociation]
713
1126
  #
714
1127
  # @!attribute [rw] tags
715
- # The name of the resource currently associated with the feed, if any.
1128
+ # The tags associated with the feed.
716
1129
  # @return [Hash<String,String>]
717
1130
  #
718
1131
  # @see http://docs.aws.amazon.com/goto/WebAPI/elementalinference-2018-11-14/UpdateFeedResponse AWS API Documentation
@@ -734,15 +1147,14 @@ module Aws::ElementalInference
734
1147
  # used in the UpdateFeed action.
735
1148
  #
736
1149
  # @!attribute [rw] name
737
- # The name start here
1150
+ # The name of the output.
738
1151
  # @return [String]
739
1152
  #
740
1153
  # @!attribute [rw] output_config
741
- # A typed property for an output in a feed. It is used in the
742
- # UpdateFeed action. It identifies the action for Elemental Inference
743
- # to perform. It also provides a repository for the results of that
744
- # action. For example, CroppingConfig output will contain the metadata
745
- # for the crop feature.
1154
+ # A typed property for an output in a feed. It identifies the action
1155
+ # for Elemental Inference to perform. It also provides a repository
1156
+ # for the results of that action. For example, CroppingConfig output
1157
+ # will contain the metadata for the crop feature.
746
1158
  # @return [Types::OutputConfig]
747
1159
  #
748
1160
  # @!attribute [rw] status
@@ -754,12 +1166,14 @@ module Aws::ElementalInference
754
1166
  # @return [String]
755
1167
  #
756
1168
  # @!attribute [rw] from_association
757
- # This property is set by the service when you add the output to the
758
- # feed, and indicates how you added the output. True means that you
759
- # used the AssociateFeed operation. False means that you used the
760
- # CreateFeed or UpdateFeed operation. Use GetFeed to obtain the value.
761
- # If the value is True, include this field here with a value of True.
762
- # If the value is False, omit the field here.
1169
+ # Elemental Inference originally sets this parameter to True if this
1170
+ # output was created by AssociateFeed or to False if this output was
1171
+ # created by CreateFeed or UpdateFeed.
1172
+ #
1173
+ # You must not change this value. Therefore, use GetFeed to determine
1174
+ # the current value. Then in the UpdateFeed request, if the current
1175
+ # value is True, include this parameter with a value of True. If it's
1176
+ # False, omit the parameter.
763
1177
  # @return [Boolean]
764
1178
  #
765
1179
  # @see http://docs.aws.amazon.com/goto/WebAPI/elementalinference-2018-11-14/UpdateOutput AWS API Documentation