aws-sdk-kinesisvideo 1.43.0 → 1.44.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.
@@ -101,14 +101,6 @@ module Aws::KinesisVideo
101
101
  # the API returns only the channels that satisfy a condition specified
102
102
  # in `ChannelNameCondition`.
103
103
  #
104
- # @note When making an API call, you may pass ChannelNameCondition
105
- # data as a hash:
106
- #
107
- # {
108
- # comparison_operator: "BEGINS_WITH", # accepts BEGINS_WITH
109
- # comparison_value: "ChannelName",
110
- # }
111
- #
112
104
  # @!attribute [rw] comparison_operator
113
105
  # A comparison operator. Currently, you can only specify the
114
106
  # `BEGINS_WITH` operator, which finds signaling channels whose names
@@ -142,23 +134,6 @@ module Aws::KinesisVideo
142
134
  include Aws::Structure
143
135
  end
144
136
 
145
- # @note When making an API call, you may pass CreateSignalingChannelInput
146
- # data as a hash:
147
- #
148
- # {
149
- # channel_name: "ChannelName", # required
150
- # channel_type: "SINGLE_MASTER", # accepts SINGLE_MASTER, FULL_MESH
151
- # single_master_configuration: {
152
- # message_ttl_seconds: 1,
153
- # },
154
- # tags: [
155
- # {
156
- # key: "TagKey", # required
157
- # value: "TagValue", # required
158
- # },
159
- # ],
160
- # }
161
- #
162
137
  # @!attribute [rw] channel_name
163
138
  # A name for the signaling channel that you are creating. It must be
164
139
  # unique for each Amazon Web Services account and Amazon Web Services
@@ -203,20 +178,6 @@ module Aws::KinesisVideo
203
178
  include Aws::Structure
204
179
  end
205
180
 
206
- # @note When making an API call, you may pass CreateStreamInput
207
- # data as a hash:
208
- #
209
- # {
210
- # device_name: "DeviceName",
211
- # stream_name: "StreamName", # required
212
- # media_type: "MediaType",
213
- # kms_key_id: "KmsKeyId",
214
- # data_retention_in_hours: 1,
215
- # tags: {
216
- # "TagKey" => "TagValue",
217
- # },
218
- # }
219
- #
220
181
  # @!attribute [rw] device_name
221
182
  # The name of the device that is writing to the stream.
222
183
  #
@@ -310,14 +271,6 @@ module Aws::KinesisVideo
310
271
  include Aws::Structure
311
272
  end
312
273
 
313
- # @note When making an API call, you may pass DeleteSignalingChannelInput
314
- # data as a hash:
315
- #
316
- # {
317
- # channel_arn: "ResourceARN", # required
318
- # current_version: "Version",
319
- # }
320
- #
321
274
  # @!attribute [rw] channel_arn
322
275
  # The Amazon Resource Name (ARN) of the signaling channel that you
323
276
  # want to delete.
@@ -343,14 +296,6 @@ module Aws::KinesisVideo
343
296
  #
344
297
  class DeleteSignalingChannelOutput < Aws::EmptyStructure; end
345
298
 
346
- # @note When making an API call, you may pass DeleteStreamInput
347
- # data as a hash:
348
- #
349
- # {
350
- # stream_arn: "ResourceARN", # required
351
- # current_version: "Version",
352
- # }
353
- #
354
299
  # @!attribute [rw] stream_arn
355
300
  # The Amazon Resource Name (ARN) of the stream that you want to
356
301
  # delete.
@@ -380,14 +325,109 @@ module Aws::KinesisVideo
380
325
  #
381
326
  class DeleteStreamOutput < Aws::EmptyStructure; end
382
327
 
383
- # @note When making an API call, you may pass DescribeImageGenerationConfigurationInput
384
- # data as a hash:
328
+ # The configuration details required to delete the connection of the
329
+ # stream from the Edge Agent.
330
+ #
331
+ # @!attribute [rw] edge_retention_in_hours
332
+ # The number of hours that you want to retain the data in the stream
333
+ # on the Edge Agent. The default value of the retention time is 720
334
+ # hours, which translates to 30 days.
335
+ # @return [Integer]
336
+ #
337
+ # @!attribute [rw] local_size_config
338
+ # The value of the local size required in order to delete the edge
339
+ # configuration.
340
+ # @return [Types::LocalSizeConfig]
341
+ #
342
+ # @!attribute [rw] delete_after_upload
343
+ # The `boolean` value used to indicate whether or not you want to mark
344
+ # the media for deletion, once it has been uploaded to the Kinesis
345
+ # Video Stream cloud. The media files can be deleted if any of the
346
+ # deletion configuration values are set to `true`, such as when the
347
+ # limit for the `EdgeRetentionInHours`, or the
348
+ # `MaxLocalMediaSizeInMB`, has been reached.
349
+ #
350
+ # Since the default value is set to `true`, configure the uploader
351
+ # schedule such that the media files are not being deleted before they
352
+ # are initially uploaded to AWS cloud.
353
+ # @return [Boolean]
354
+ #
355
+ # @see http://docs.aws.amazon.com/goto/WebAPI/kinesisvideo-2017-09-30/DeletionConfig AWS API Documentation
356
+ #
357
+ class DeletionConfig < Struct.new(
358
+ :edge_retention_in_hours,
359
+ :local_size_config,
360
+ :delete_after_upload)
361
+ SENSITIVE = []
362
+ include Aws::Structure
363
+ end
364
+
365
+ # @!attribute [rw] stream_name
366
+ # The name of the stream whose edge configuration you want to update.
367
+ # Specify either the `StreamName` or the `StreamARN`.
368
+ # @return [String]
385
369
  #
386
- # {
387
- # stream_name: "StreamName",
388
- # stream_arn: "ResourceARN",
389
- # }
370
+ # @!attribute [rw] stream_arn
371
+ # The Amazon Resource Name (ARN) of the stream. Specify either the
372
+ # `StreamName`or the `StreamARN`.
373
+ # @return [String]
374
+ #
375
+ # @see http://docs.aws.amazon.com/goto/WebAPI/kinesisvideo-2017-09-30/DescribeEdgeConfigurationInput AWS API Documentation
390
376
  #
377
+ class DescribeEdgeConfigurationInput < Struct.new(
378
+ :stream_name,
379
+ :stream_arn)
380
+ SENSITIVE = []
381
+ include Aws::Structure
382
+ end
383
+
384
+ # @!attribute [rw] stream_name
385
+ # The name of the stream from which the edge configuration was
386
+ # updated.
387
+ # @return [String]
388
+ #
389
+ # @!attribute [rw] stream_arn
390
+ # The Amazon Resource Name (ARN) of the stream.
391
+ # @return [String]
392
+ #
393
+ # @!attribute [rw] creation_time
394
+ # The timestamp at which a stream’s edge configuration was first
395
+ # created.
396
+ # @return [Time]
397
+ #
398
+ # @!attribute [rw] last_updated_time
399
+ # The timestamp at which a stream’s edge configuration was last
400
+ # updated.
401
+ # @return [Time]
402
+ #
403
+ # @!attribute [rw] sync_status
404
+ # The latest status of the edge configuration update.
405
+ # @return [String]
406
+ #
407
+ # @!attribute [rw] failed_status_details
408
+ # A description of the generated failure status.
409
+ # @return [String]
410
+ #
411
+ # @!attribute [rw] edge_config
412
+ # A description of the stream's edge configuration that will be used
413
+ # to sync with the Edge Agent IoT Greengrass component. The Edge Agent
414
+ # component will run on an IoT Hub Device setup at your premise.
415
+ # @return [Types::EdgeConfig]
416
+ #
417
+ # @see http://docs.aws.amazon.com/goto/WebAPI/kinesisvideo-2017-09-30/DescribeEdgeConfigurationOutput AWS API Documentation
418
+ #
419
+ class DescribeEdgeConfigurationOutput < Struct.new(
420
+ :stream_name,
421
+ :stream_arn,
422
+ :creation_time,
423
+ :last_updated_time,
424
+ :sync_status,
425
+ :failed_status_details,
426
+ :edge_config)
427
+ SENSITIVE = []
428
+ include Aws::Structure
429
+ end
430
+
391
431
  # @!attribute [rw] stream_name
392
432
  # The name of the stream from which to retrieve the image generation
393
433
  # configuration. You must specify either the `StreamName` or the
@@ -423,14 +463,6 @@ module Aws::KinesisVideo
423
463
  include Aws::Structure
424
464
  end
425
465
 
426
- # @note When making an API call, you may pass DescribeNotificationConfigurationInput
427
- # data as a hash:
428
- #
429
- # {
430
- # stream_name: "StreamName",
431
- # stream_arn: "ResourceARN",
432
- # }
433
- #
434
466
  # @!attribute [rw] stream_name
435
467
  # The name of the stream from which to retrieve the notification
436
468
  # configuration. You must specify either the `StreamName` or the
@@ -466,14 +498,6 @@ module Aws::KinesisVideo
466
498
  include Aws::Structure
467
499
  end
468
500
 
469
- # @note When making an API call, you may pass DescribeSignalingChannelInput
470
- # data as a hash:
471
- #
472
- # {
473
- # channel_name: "ChannelName",
474
- # channel_arn: "ResourceARN",
475
- # }
476
- #
477
501
  # @!attribute [rw] channel_name
478
502
  # The name of the signaling channel that you want to describe.
479
503
  # @return [String]
@@ -504,14 +528,6 @@ module Aws::KinesisVideo
504
528
  include Aws::Structure
505
529
  end
506
530
 
507
- # @note When making an API call, you may pass DescribeStreamInput
508
- # data as a hash:
509
- #
510
- # {
511
- # stream_name: "StreamName",
512
- # stream_arn: "ResourceARN",
513
- # }
514
- #
515
531
  # @!attribute [rw] stream_name
516
532
  # The name of the stream.
517
533
  # @return [String]
@@ -554,15 +570,43 @@ module Aws::KinesisVideo
554
570
  include Aws::Structure
555
571
  end
556
572
 
557
- # @note When making an API call, you may pass GetDataEndpointInput
558
- # data as a hash:
573
+ # A description of the stream's edge configuration that will be used to
574
+ # sync with the Edge Agent IoT Greengrass component. The Edge Agent
575
+ # component will run on an IoT Hub Device setup at your premise.
576
+ #
577
+ # @!attribute [rw] hub_device_arn
578
+ # The "**Internet of Things (IoT) Thing**" Arn of the stream.
579
+ # @return [String]
580
+ #
581
+ # @!attribute [rw] recorder_config
582
+ # The recorder configuration consists of the local `MediaSourceConfig`
583
+ # details, that are used as credentials to access the local media
584
+ # files streamed on the camera.
585
+ # @return [Types::RecorderConfig]
586
+ #
587
+ # @!attribute [rw] uploader_config
588
+ # The uploader configuration contains the `ScheduleExpression` details
589
+ # that are used, to schedule upload jobs for the recorded media files
590
+ # from the Edge Agent, to a Kinesis Video Stream.
591
+ # @return [Types::UploaderConfig]
592
+ #
593
+ # @!attribute [rw] deletion_config
594
+ # The deletion configuration is made up of the retention time
595
+ # (`EdgeRetentionInHours`) and local size configuration
596
+ # (`LocalSizeConfig`) details that are used to make the deletion.
597
+ # @return [Types::DeletionConfig]
559
598
  #
560
- # {
561
- # stream_name: "StreamName",
562
- # stream_arn: "ResourceARN",
563
- # api_name: "PUT_MEDIA", # required, accepts PUT_MEDIA, GET_MEDIA, LIST_FRAGMENTS, GET_MEDIA_FOR_FRAGMENT_LIST, GET_HLS_STREAMING_SESSION_URL, GET_DASH_STREAMING_SESSION_URL, GET_CLIP, GET_IMAGES
564
- # }
599
+ # @see http://docs.aws.amazon.com/goto/WebAPI/kinesisvideo-2017-09-30/EdgeConfig AWS API Documentation
565
600
  #
601
+ class EdgeConfig < Struct.new(
602
+ :hub_device_arn,
603
+ :recorder_config,
604
+ :uploader_config,
605
+ :deletion_config)
606
+ SENSITIVE = []
607
+ include Aws::Structure
608
+ end
609
+
566
610
  # @!attribute [rw] stream_name
567
611
  # The name of the stream that you want to get the endpoint for. You
568
612
  # must specify either this parameter or a `StreamARN` in the request.
@@ -601,17 +645,6 @@ module Aws::KinesisVideo
601
645
  include Aws::Structure
602
646
  end
603
647
 
604
- # @note When making an API call, you may pass GetSignalingChannelEndpointInput
605
- # data as a hash:
606
- #
607
- # {
608
- # channel_arn: "ResourceARN", # required
609
- # single_master_channel_endpoint_configuration: {
610
- # protocols: ["WSS"], # accepts WSS, HTTPS
611
- # role: "MASTER", # accepts MASTER, VIEWER
612
- # },
613
- # }
614
- #
615
648
  # @!attribute [rw] channel_arn
616
649
  # The Amazon Resource Name (ARN) of the signalling channel for which
617
650
  # you want to get an endpoint.
@@ -647,25 +680,6 @@ module Aws::KinesisVideo
647
680
  # images delivery. If null, the configuration will be deleted from the
648
681
  # stream.
649
682
  #
650
- # @note When making an API call, you may pass ImageGenerationConfiguration
651
- # data as a hash:
652
- #
653
- # {
654
- # status: "ENABLED", # required, accepts ENABLED, DISABLED
655
- # image_selector_type: "SERVER_TIMESTAMP", # required, accepts SERVER_TIMESTAMP, PRODUCER_TIMESTAMP
656
- # destination_config: { # required
657
- # uri: "DestinationUri", # required
658
- # destination_region: "DestinationRegion", # required
659
- # },
660
- # sampling_interval: 1, # required
661
- # format: "JPEG", # required, accepts JPEG, PNG
662
- # format_config: {
663
- # "JPEGQuality" => "FormatConfigValue",
664
- # },
665
- # width_pixels: 1,
666
- # height_pixels: 1,
667
- # }
668
- #
669
683
  # @!attribute [rw] status
670
684
  # Indicates whether the `ContinuousImageGenerationConfigurations` API
671
685
  # is enabled or disabled.
@@ -744,16 +758,8 @@ module Aws::KinesisVideo
744
758
  # The structure that contains the information required to deliver images
745
759
  # to a customer.
746
760
  #
747
- # @note When making an API call, you may pass ImageGenerationDestinationConfig
748
- # data as a hash:
749
- #
750
- # {
751
- # uri: "DestinationUri", # required
752
- # destination_region: "DestinationRegion", # required
753
- # }
754
- #
755
761
  # @!attribute [rw] uri
756
- # The Uniform Resource Idenifier (URI) that identifies where the
762
+ # The Uniform Resource Identifier (URI) that identifies where the
757
763
  # images will be delivered.
758
764
  # @return [String]
759
765
  #
@@ -811,18 +817,6 @@ module Aws::KinesisVideo
811
817
  include Aws::Structure
812
818
  end
813
819
 
814
- # @note When making an API call, you may pass ListSignalingChannelsInput
815
- # data as a hash:
816
- #
817
- # {
818
- # max_results: 1,
819
- # next_token: "NextToken",
820
- # channel_name_condition: {
821
- # comparison_operator: "BEGINS_WITH", # accepts BEGINS_WITH
822
- # comparison_value: "ChannelName",
823
- # },
824
- # }
825
- #
826
820
  # @!attribute [rw] max_results
827
821
  # The maximum number of channels to return in the response. The
828
822
  # default is 500.
@@ -869,18 +863,6 @@ module Aws::KinesisVideo
869
863
  include Aws::Structure
870
864
  end
871
865
 
872
- # @note When making an API call, you may pass ListStreamsInput
873
- # data as a hash:
874
- #
875
- # {
876
- # max_results: 1,
877
- # next_token: "NextToken",
878
- # stream_name_condition: {
879
- # comparison_operator: "BEGINS_WITH", # accepts BEGINS_WITH
880
- # comparison_value: "StreamName",
881
- # },
882
- # }
883
- #
884
866
  # @!attribute [rw] max_results
885
867
  # The maximum number of streams to return in the response. The default
886
868
  # is 10,000.
@@ -928,14 +910,6 @@ module Aws::KinesisVideo
928
910
  include Aws::Structure
929
911
  end
930
912
 
931
- # @note When making an API call, you may pass ListTagsForResourceInput
932
- # data as a hash:
933
- #
934
- # {
935
- # next_token: "NextToken",
936
- # resource_arn: "ResourceARN", # required
937
- # }
938
- #
939
913
  # @!attribute [rw] next_token
940
914
  # If you specify this parameter and the result of a
941
915
  # `ListTagsForResource` call is truncated, the response includes a
@@ -978,15 +952,6 @@ module Aws::KinesisVideo
978
952
  include Aws::Structure
979
953
  end
980
954
 
981
- # @note When making an API call, you may pass ListTagsForStreamInput
982
- # data as a hash:
983
- #
984
- # {
985
- # next_token: "NextToken",
986
- # stream_arn: "ResourceARN",
987
- # stream_name: "StreamName",
988
- # }
989
- #
990
955
  # @!attribute [rw] next_token
991
956
  # If you specify this parameter and the result of a
992
957
  # `ListTagsForStream` call is truncated, the response includes a token
@@ -1032,6 +997,53 @@ module Aws::KinesisVideo
1032
997
  include Aws::Structure
1033
998
  end
1034
999
 
1000
+ # The configuration details that include the maximum size of the media
1001
+ # (`MaxLocalMediaSizeInMB`) that you want to store for a stream on the
1002
+ # Edge Agent, as well as the strategy that should be used
1003
+ # (`StrategyOnFullSize`) when a stream's maximum size has been reached.
1004
+ #
1005
+ # @!attribute [rw] max_local_media_size_in_mb
1006
+ # The overall maximum size of the media that you want to store for a
1007
+ # stream on the Edge Agent.
1008
+ # @return [Integer]
1009
+ #
1010
+ # @!attribute [rw] strategy_on_full_size
1011
+ # The strategy to perform when a stream’s `MaxLocalMediaSizeInMB`
1012
+ # limit is reached.
1013
+ # @return [String]
1014
+ #
1015
+ # @see http://docs.aws.amazon.com/goto/WebAPI/kinesisvideo-2017-09-30/LocalSizeConfig AWS API Documentation
1016
+ #
1017
+ class LocalSizeConfig < Struct.new(
1018
+ :max_local_media_size_in_mb,
1019
+ :strategy_on_full_size)
1020
+ SENSITIVE = []
1021
+ include Aws::Structure
1022
+ end
1023
+
1024
+ # The configuration details that consist of the credentials required
1025
+ # (`MediaUriSecretArn` and `MediaUriType`) to access the media files
1026
+ # that are streamed to the camera.
1027
+ #
1028
+ # @!attribute [rw] media_uri_secret_arn
1029
+ # The AWS Secrets Manager ARN for the username and password of the
1030
+ # camera, or a local media file location.
1031
+ # @return [String]
1032
+ #
1033
+ # @!attribute [rw] media_uri_type
1034
+ # The Uniform Resource Identifier (Uri) type. The `FILE_URI` value can
1035
+ # be used to stream local media files.
1036
+ # @return [String]
1037
+ #
1038
+ # @see http://docs.aws.amazon.com/goto/WebAPI/kinesisvideo-2017-09-30/MediaSourceConfig AWS API Documentation
1039
+ #
1040
+ class MediaSourceConfig < Struct.new(
1041
+ :media_uri_secret_arn,
1042
+ :media_uri_type)
1043
+ SENSITIVE = [:media_uri_secret_arn]
1044
+ include Aws::Structure
1045
+ end
1046
+
1035
1047
  # The Stream data retention in hours is equal to zero.
1036
1048
  #
1037
1049
  # @!attribute [rw] message
@@ -1062,16 +1074,6 @@ module Aws::KinesisVideo
1062
1074
  # images delivery. If this parameter is null, the configuration will be
1063
1075
  # deleted from the stream.
1064
1076
  #
1065
- # @note When making an API call, you may pass NotificationConfiguration
1066
- # data as a hash:
1067
- #
1068
- # {
1069
- # status: "ENABLED", # required, accepts ENABLED, DISABLED
1070
- # destination_config: { # required
1071
- # uri: "DestinationUri", # required
1072
- # },
1073
- # }
1074
- #
1075
1077
  # @!attribute [rw] status
1076
1078
  # Indicates if a notification configuration is enabled or disabled.
1077
1079
  # @return [String]
@@ -1093,15 +1095,8 @@ module Aws::KinesisVideo
1093
1095
  # The structure that contains the information required to deliver a
1094
1096
  # notification to a customer.
1095
1097
  #
1096
- # @note When making an API call, you may pass NotificationDestinationConfig
1097
- # data as a hash:
1098
- #
1099
- # {
1100
- # uri: "DestinationUri", # required
1101
- # }
1102
- #
1103
1098
  # @!attribute [rw] uri
1104
- # The Uniform Resource Idenifier (URI) that identifies where the
1099
+ # The Uniform Resource Identifier (URI) that identifies where the
1105
1100
  # images will be delivered.
1106
1101
  # @return [String]
1107
1102
  #
@@ -1113,6 +1108,33 @@ module Aws::KinesisVideo
1113
1108
  include Aws::Structure
1114
1109
  end
1115
1110
 
1111
+ # The recorder configuration consists of the local `MediaSourceConfig`
1112
+ # details that are used as credentials to accesss the local media files
1113
+ # streamed on the camera.
1114
+ #
1115
+ # @!attribute [rw] media_source_config
1116
+ # The configuration details that consist of the credentials required
1117
+ # (`MediaUriSecretArn` and `MediaUriType`) to access the media files
1118
+ # streamed to the camera.
1119
+ # @return [Types::MediaSourceConfig]
1120
+ #
1121
+ # @!attribute [rw] schedule_config
1122
+ # The configuration that consists of the `ScheduleExpression` and the
1123
+ # `DurationInMinutes` details that specify the scheduling to record
1124
+ # from a camera, or local media file, onto the Edge Agent. If the
1125
+ # `ScheduleExpression` attribute is not provided, then the Edge Agent
1126
+ # will always be set to recording mode.
1127
+ # @return [Types::ScheduleConfig]
1128
+ #
1129
+ # @see http://docs.aws.amazon.com/goto/WebAPI/kinesisvideo-2017-09-30/RecorderConfig AWS API Documentation
1130
+ #
1131
+ class RecorderConfig < Struct.new(
1132
+ :media_source_config,
1133
+ :schedule_config)
1134
+ SENSITIVE = []
1135
+ include Aws::Structure
1136
+ end
1137
+
1116
1138
  # An object that describes the endpoint of the signaling channel
1117
1139
  # returned by the `GetSignalingChannelEndpoint` API.
1118
1140
  #
@@ -1170,16 +1192,45 @@ module Aws::KinesisVideo
1170
1192
  include Aws::Structure
1171
1193
  end
1172
1194
 
1173
- # An object that contains the endpoint configuration for the
1174
- # `SINGLE_MASTER` channel type.
1195
+ # This API enables you to specify the duration that the camera, or local
1196
+ # media file, should record onto the Edge Agent. The `ScheduleConfig`
1197
+ # consists of the `ScheduleExpression` and the `DurationInMinutes`
1198
+ # attributes.
1199
+ #
1200
+ # If the `ScheduleExpression` is not provided, then the Edge Agent will
1201
+ # always be set to recording mode.
1202
+ #
1203
+ # @!attribute [rw] schedule_expression
1204
+ # The Quartz cron expression that takes care of scheduling jobs to
1205
+ # record from the camera, or local media file, onto the Edge Agent. If
1206
+ # the `ScheduleExpression` is not provided for the `RecorderConfig`,
1207
+ # then the Edge Agent will always be set to recording mode.
1208
+ #
1209
+ # For more information about Quartz, refer to the [ *Cron Trigger
1210
+ # Tutorial* ][1] page to understand the valid expressions and its use.
1211
+ #
1212
+ #
1175
1213
  #
1176
- # @note When making an API call, you may pass SingleMasterChannelEndpointConfiguration
1177
- # data as a hash:
1214
+ # [1]: http://www.quartz-scheduler.org/documentation/quartz-2.3.0/tutorials/crontrigger.html
1215
+ # @return [String]
1216
+ #
1217
+ # @!attribute [rw] duration_in_seconds
1218
+ # The total duration to record the media. If the `ScheduleExpression`
1219
+ # attribute is provided, then the `DurationInSeconds` attribute should
1220
+ # also be specified.
1221
+ # @return [Integer]
1178
1222
  #
1179
- # {
1180
- # protocols: ["WSS"], # accepts WSS, HTTPS
1181
- # role: "MASTER", # accepts MASTER, VIEWER
1182
- # }
1223
+ # @see http://docs.aws.amazon.com/goto/WebAPI/kinesisvideo-2017-09-30/ScheduleConfig AWS API Documentation
1224
+ #
1225
+ class ScheduleConfig < Struct.new(
1226
+ :schedule_expression,
1227
+ :duration_in_seconds)
1228
+ SENSITIVE = []
1229
+ include Aws::Structure
1230
+ end
1231
+
1232
+ # An object that contains the endpoint configuration for the
1233
+ # `SINGLE_MASTER` channel type.
1183
1234
  #
1184
1235
  # @!attribute [rw] protocols
1185
1236
  # This property is used to determine the nature of communication over
@@ -1210,13 +1261,6 @@ module Aws::KinesisVideo
1210
1261
  # A structure that contains the configuration for the `SINGLE_MASTER`
1211
1262
  # channel type.
1212
1263
  #
1213
- # @note When making an API call, you may pass SingleMasterConfiguration
1214
- # data as a hash:
1215
- #
1216
- # {
1217
- # message_ttl_seconds: 1,
1218
- # }
1219
- #
1220
1264
  # @!attribute [rw] message_ttl_seconds
1221
1265
  # The period of time a signaling channel retains undelivered messages
1222
1266
  # before they are discarded.
@@ -1230,6 +1274,95 @@ module Aws::KinesisVideo
1230
1274
  include Aws::Structure
1231
1275
  end
1232
1276
 
1277
+ # @!attribute [rw] stream_name
1278
+ # The name of the stream whose edge configuration you want to update.
1279
+ # Specify either the `StreamName` or the `StreamARN`.
1280
+ # @return [String]
1281
+ #
1282
+ # @!attribute [rw] stream_arn
1283
+ # The Amazon Resource Name (ARN) of the stream. Specify either the
1284
+ # `StreamName` or the `StreamARN`.
1285
+ # @return [String]
1286
+ #
1287
+ # @!attribute [rw] edge_config
1288
+ # The edge configuration details required to invoke the update
1289
+ # process.
1290
+ # @return [Types::EdgeConfig]
1291
+ #
1292
+ # @see http://docs.aws.amazon.com/goto/WebAPI/kinesisvideo-2017-09-30/StartEdgeConfigurationUpdateInput AWS API Documentation
1293
+ #
1294
+ class StartEdgeConfigurationUpdateInput < Struct.new(
1295
+ :stream_name,
1296
+ :stream_arn,
1297
+ :edge_config)
1298
+ SENSITIVE = []
1299
+ include Aws::Structure
1300
+ end
1301
+
1302
+ # @!attribute [rw] stream_name
1303
+ # The name of the stream from which the edge configuration was
1304
+ # updated.
1305
+ # @return [String]
1306
+ #
1307
+ # @!attribute [rw] stream_arn
1308
+ # The Amazon Resource Name (ARN) of the stream.
1309
+ # @return [String]
1310
+ #
1311
+ # @!attribute [rw] creation_time
1312
+ # The timestamp at which a stream’s edge configuration was first
1313
+ # created.
1314
+ # @return [Time]
1315
+ #
1316
+ # @!attribute [rw] last_updated_time
1317
+ # The timestamp at which a stream’s edge configuration was last
1318
+ # updated.
1319
+ # @return [Time]
1320
+ #
1321
+ # @!attribute [rw] sync_status
1322
+ # The current sync status of the stream's edge configuration. When
1323
+ # you invoke this API, the sync status will be set to the `SYNCING`
1324
+ # state. Use the `DescribeEdgeConfiguration` API to get the latest
1325
+ # status of the edge configuration.
1326
+ # @return [String]
1327
+ #
1328
+ # @!attribute [rw] failed_status_details
1329
+ # A description of the generated failure status.
1330
+ # @return [String]
1331
+ #
1332
+ # @!attribute [rw] edge_config
1333
+ # A description of the stream's edge configuration that will be used
1334
+ # to sync with the Edge Agent IoT Greengrass component. The Edge Agent
1335
+ # component will run on an IoT Hub Device setup at your premise.
1336
+ # @return [Types::EdgeConfig]
1337
+ #
1338
+ # @see http://docs.aws.amazon.com/goto/WebAPI/kinesisvideo-2017-09-30/StartEdgeConfigurationUpdateOutput AWS API Documentation
1339
+ #
1340
+ class StartEdgeConfigurationUpdateOutput < Struct.new(
1341
+ :stream_name,
1342
+ :stream_arn,
1343
+ :creation_time,
1344
+ :last_updated_time,
1345
+ :sync_status,
1346
+ :failed_status_details,
1347
+ :edge_config)
1348
+ SENSITIVE = []
1349
+ include Aws::Structure
1350
+ end
1351
+
1352
+ # The Exception rendered when the Amazon Kinesis Video Stream can't
1353
+ # find a stream's edge configuration that you specified.
1354
+ #
1355
+ # @!attribute [rw] message
1356
+ # @return [String]
1357
+ #
1358
+ # @see http://docs.aws.amazon.com/goto/WebAPI/kinesisvideo-2017-09-30/StreamEdgeConfigurationNotFoundException AWS API Documentation
1359
+ #
1360
+ class StreamEdgeConfigurationNotFoundException < Struct.new(
1361
+ :message)
1362
+ SENSITIVE = []
1363
+ include Aws::Structure
1364
+ end
1365
+
1233
1366
  # An object describing a Kinesis video stream.
1234
1367
  #
1235
1368
  # @!attribute [rw] device_name
@@ -1291,14 +1424,6 @@ module Aws::KinesisVideo
1291
1424
  # `BEGINS_WITH` operator, which finds streams whose names start with a
1292
1425
  # given prefix.
1293
1426
  #
1294
- # @note When making an API call, you may pass StreamNameCondition
1295
- # data as a hash:
1296
- #
1297
- # {
1298
- # comparison_operator: "BEGINS_WITH", # accepts BEGINS_WITH
1299
- # comparison_value: "StreamName",
1300
- # }
1301
- #
1302
1427
  # @!attribute [rw] comparison_operator
1303
1428
  # A comparison operator. Currently, you can specify only the
1304
1429
  # `BEGINS_WITH` operator, which finds streams whose names start with a
@@ -1321,14 +1446,6 @@ module Aws::KinesisVideo
1321
1446
  # A key and value pair that is associated with the specified signaling
1322
1447
  # channel.
1323
1448
  #
1324
- # @note When making an API call, you may pass Tag
1325
- # data as a hash:
1326
- #
1327
- # {
1328
- # key: "TagKey", # required
1329
- # value: "TagValue", # required
1330
- # }
1331
- #
1332
1449
  # @!attribute [rw] key
1333
1450
  # The key of the tag that is associated with the specified signaling
1334
1451
  # channel.
@@ -1348,19 +1465,6 @@ module Aws::KinesisVideo
1348
1465
  include Aws::Structure
1349
1466
  end
1350
1467
 
1351
- # @note When making an API call, you may pass TagResourceInput
1352
- # data as a hash:
1353
- #
1354
- # {
1355
- # resource_arn: "ResourceARN", # required
1356
- # tags: [ # required
1357
- # {
1358
- # key: "TagKey", # required
1359
- # value: "TagValue", # required
1360
- # },
1361
- # ],
1362
- # }
1363
- #
1364
1468
  # @!attribute [rw] resource_arn
1365
1469
  # The Amazon Resource Name (ARN) of the signaling channel to which you
1366
1470
  # want to add tags.
@@ -1384,17 +1488,6 @@ module Aws::KinesisVideo
1384
1488
  #
1385
1489
  class TagResourceOutput < Aws::EmptyStructure; end
1386
1490
 
1387
- # @note When making an API call, you may pass TagStreamInput
1388
- # data as a hash:
1389
- #
1390
- # {
1391
- # stream_arn: "ResourceARN",
1392
- # stream_name: "StreamName",
1393
- # tags: { # required
1394
- # "TagKey" => "TagValue",
1395
- # },
1396
- # }
1397
- #
1398
1491
  # @!attribute [rw] stream_arn
1399
1492
  # The Amazon Resource Name (ARN) of the resource that you want to add
1400
1493
  # the tag or tags to.
@@ -1437,14 +1530,6 @@ module Aws::KinesisVideo
1437
1530
  include Aws::Structure
1438
1531
  end
1439
1532
 
1440
- # @note When making an API call, you may pass UntagResourceInput
1441
- # data as a hash:
1442
- #
1443
- # {
1444
- # resource_arn: "ResourceARN", # required
1445
- # tag_key_list: ["TagKey"], # required
1446
- # }
1447
- #
1448
1533
  # @!attribute [rw] resource_arn
1449
1534
  # The Amazon Resource Name (ARN) of the signaling channel from which
1450
1535
  # you want to remove tags.
@@ -1467,15 +1552,6 @@ module Aws::KinesisVideo
1467
1552
  #
1468
1553
  class UntagResourceOutput < Aws::EmptyStructure; end
1469
1554
 
1470
- # @note When making an API call, you may pass UntagStreamInput
1471
- # data as a hash:
1472
- #
1473
- # {
1474
- # stream_arn: "ResourceARN",
1475
- # stream_name: "StreamName",
1476
- # tag_key_list: ["TagKey"], # required
1477
- # }
1478
- #
1479
1555
  # @!attribute [rw] stream_arn
1480
1556
  # The Amazon Resource Name (ARN) of the stream that you want to remove
1481
1557
  # tags from.
@@ -1503,17 +1579,6 @@ module Aws::KinesisVideo
1503
1579
  #
1504
1580
  class UntagStreamOutput < Aws::EmptyStructure; end
1505
1581
 
1506
- # @note When making an API call, you may pass UpdateDataRetentionInput
1507
- # data as a hash:
1508
- #
1509
- # {
1510
- # stream_name: "StreamName",
1511
- # stream_arn: "ResourceARN",
1512
- # current_version: "Version", # required
1513
- # operation: "INCREASE_DATA_RETENTION", # required, accepts INCREASE_DATA_RETENTION, DECREASE_DATA_RETENTION
1514
- # data_retention_change_in_hours: 1, # required
1515
- # }
1516
- #
1517
1582
  # @!attribute [rw] stream_name
1518
1583
  # The name of the stream whose retention period you want to change.
1519
1584
  # @return [String]
@@ -1556,29 +1621,6 @@ module Aws::KinesisVideo
1556
1621
  #
1557
1622
  class UpdateDataRetentionOutput < Aws::EmptyStructure; end
1558
1623
 
1559
- # @note When making an API call, you may pass UpdateImageGenerationConfigurationInput
1560
- # data as a hash:
1561
- #
1562
- # {
1563
- # stream_name: "StreamName",
1564
- # stream_arn: "ResourceARN",
1565
- # image_generation_configuration: {
1566
- # status: "ENABLED", # required, accepts ENABLED, DISABLED
1567
- # image_selector_type: "SERVER_TIMESTAMP", # required, accepts SERVER_TIMESTAMP, PRODUCER_TIMESTAMP
1568
- # destination_config: { # required
1569
- # uri: "DestinationUri", # required
1570
- # destination_region: "DestinationRegion", # required
1571
- # },
1572
- # sampling_interval: 1, # required
1573
- # format: "JPEG", # required, accepts JPEG, PNG
1574
- # format_config: {
1575
- # "JPEGQuality" => "FormatConfigValue",
1576
- # },
1577
- # width_pixels: 1,
1578
- # height_pixels: 1,
1579
- # },
1580
- # }
1581
- #
1582
1624
  # @!attribute [rw] stream_name
1583
1625
  # The name of the stream from which to update the image generation
1584
1626
  # configuration. You must specify either the `StreamName` or the
@@ -1611,20 +1653,6 @@ module Aws::KinesisVideo
1611
1653
  #
1612
1654
  class UpdateImageGenerationConfigurationOutput < Aws::EmptyStructure; end
1613
1655
 
1614
- # @note When making an API call, you may pass UpdateNotificationConfigurationInput
1615
- # data as a hash:
1616
- #
1617
- # {
1618
- # stream_name: "StreamName",
1619
- # stream_arn: "ResourceARN",
1620
- # notification_configuration: {
1621
- # status: "ENABLED", # required, accepts ENABLED, DISABLED
1622
- # destination_config: { # required
1623
- # uri: "DestinationUri", # required
1624
- # },
1625
- # },
1626
- # }
1627
- #
1628
1656
  # @!attribute [rw] stream_name
1629
1657
  # The name of the stream from which to update the notification
1630
1658
  # configuration. You must specify either the `StreamName` or the
@@ -1657,17 +1685,6 @@ module Aws::KinesisVideo
1657
1685
  #
1658
1686
  class UpdateNotificationConfigurationOutput < Aws::EmptyStructure; end
1659
1687
 
1660
- # @note When making an API call, you may pass UpdateSignalingChannelInput
1661
- # data as a hash:
1662
- #
1663
- # {
1664
- # channel_arn: "ResourceARN", # required
1665
- # current_version: "Version", # required
1666
- # single_master_configuration: {
1667
- # message_ttl_seconds: 1,
1668
- # },
1669
- # }
1670
- #
1671
1688
  # @!attribute [rw] channel_arn
1672
1689
  # The Amazon Resource Name (ARN) of the signaling channel that you
1673
1690
  # want to update.
@@ -1697,17 +1714,6 @@ module Aws::KinesisVideo
1697
1714
  #
1698
1715
  class UpdateSignalingChannelOutput < Aws::EmptyStructure; end
1699
1716
 
1700
- # @note When making an API call, you may pass UpdateStreamInput
1701
- # data as a hash:
1702
- #
1703
- # {
1704
- # stream_name: "StreamName",
1705
- # stream_arn: "ResourceARN",
1706
- # current_version: "Version", # required
1707
- # device_name: "DeviceName",
1708
- # media_type: "MediaType",
1709
- # }
1710
- #
1711
1717
  # @!attribute [rw] stream_name
1712
1718
  # The name of the stream whose metadata you want to update.
1713
1719
  #
@@ -1764,6 +1770,26 @@ module Aws::KinesisVideo
1764
1770
  #
1765
1771
  class UpdateStreamOutput < Aws::EmptyStructure; end
1766
1772
 
1773
+ # The configuration that consists of the `ScheduleConfig` attribute
1774
+ # that's required, to schedule the jobs to upload the recorded media
1775
+ # files onto the Edge Agent in a Kinesis Video Stream.
1776
+ #
1777
+ # @!attribute [rw] schedule_config
1778
+ # The configuration that consists of the `ScheduleExpression` and the
1779
+ # `DurationInMinutes`details that specify the scheduling to record
1780
+ # from a camera, or local media file, onto the Edge Agent. If the
1781
+ # `ScheduleExpression` is not provided, then the Edge Agent will
1782
+ # always be in recording mode.
1783
+ # @return [Types::ScheduleConfig]
1784
+ #
1785
+ # @see http://docs.aws.amazon.com/goto/WebAPI/kinesisvideo-2017-09-30/UploaderConfig AWS API Documentation
1786
+ #
1787
+ class UploaderConfig < Struct.new(
1788
+ :schedule_config)
1789
+ SENSITIVE = []
1790
+ include Aws::Structure
1791
+ end
1792
+
1767
1793
  # The stream version that you specified is not the latest version. To
1768
1794
  # get the latest version, use the [DescribeStream][1] API.
1769
1795
  #