aws-sdk-kinesisvideo 1.43.0 → 1.45.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.
- checksums.yaml +4 -4
- data/CHANGELOG.md +10 -0
- data/VERSION +1 -1
- data/lib/aws-sdk-kinesisvideo/client.rb +285 -3
- data/lib/aws-sdk-kinesisvideo/client_api.rb +199 -0
- data/lib/aws-sdk-kinesisvideo/endpoint_parameters.rb +3 -0
- data/lib/aws-sdk-kinesisvideo/endpoint_provider.rb +75 -77
- data/lib/aws-sdk-kinesisvideo/endpoints.rb +70 -0
- data/lib/aws-sdk-kinesisvideo/errors.rb +16 -0
- data/lib/aws-sdk-kinesisvideo/plugins/endpoints.rb +10 -0
- data/lib/aws-sdk-kinesisvideo/types.rb +512 -336
- data/lib/aws-sdk-kinesisvideo.rb +1 -1
- metadata +2 -2
@@ -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
|
-
#
|
384
|
-
#
|
328
|
+
# The configuration details required to delete the connection of the
|
329
|
+
# stream from the Edge Agent.
|
385
330
|
#
|
386
|
-
#
|
387
|
-
#
|
388
|
-
#
|
389
|
-
#
|
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]
|
390
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]
|
369
|
+
#
|
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
|
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,83 @@ module Aws::KinesisVideo
|
|
423
463
|
include Aws::Structure
|
424
464
|
end
|
425
465
|
|
426
|
-
#
|
427
|
-
#
|
466
|
+
# @!attribute [rw] stream_name
|
467
|
+
# The name of the stream.
|
468
|
+
# @return [String]
|
469
|
+
#
|
470
|
+
# @!attribute [rw] stream_arn
|
471
|
+
# The Amazon Resource Name (ARN) of the stream.
|
472
|
+
# @return [String]
|
473
|
+
#
|
474
|
+
# @!attribute [rw] max_results
|
475
|
+
# The maximum number of results to return in the response.
|
476
|
+
# @return [Integer]
|
477
|
+
#
|
478
|
+
# @!attribute [rw] next_token
|
479
|
+
# The token to provide in your next request, to get another batch of
|
480
|
+
# results.
|
481
|
+
# @return [String]
|
428
482
|
#
|
429
|
-
#
|
430
|
-
# stream_name: "StreamName",
|
431
|
-
# stream_arn: "ResourceARN",
|
432
|
-
# }
|
483
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/kinesisvideo-2017-09-30/DescribeMappedResourceConfigurationInput AWS API Documentation
|
433
484
|
#
|
485
|
+
class DescribeMappedResourceConfigurationInput < Struct.new(
|
486
|
+
:stream_name,
|
487
|
+
:stream_arn,
|
488
|
+
:max_results,
|
489
|
+
:next_token)
|
490
|
+
SENSITIVE = []
|
491
|
+
include Aws::Structure
|
492
|
+
end
|
493
|
+
|
494
|
+
# @!attribute [rw] mapped_resource_configuration_list
|
495
|
+
# A structure that encapsulates, or contains, the media storage
|
496
|
+
# configuration properties.
|
497
|
+
# @return [Array<Types::MappedResourceConfigurationListItem>]
|
498
|
+
#
|
499
|
+
# @!attribute [rw] next_token
|
500
|
+
# The token that was used in the `NextToken`request to fetch the next
|
501
|
+
# set of results.
|
502
|
+
# @return [String]
|
503
|
+
#
|
504
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/kinesisvideo-2017-09-30/DescribeMappedResourceConfigurationOutput AWS API Documentation
|
505
|
+
#
|
506
|
+
class DescribeMappedResourceConfigurationOutput < Struct.new(
|
507
|
+
:mapped_resource_configuration_list,
|
508
|
+
:next_token)
|
509
|
+
SENSITIVE = []
|
510
|
+
include Aws::Structure
|
511
|
+
end
|
512
|
+
|
513
|
+
# @!attribute [rw] channel_name
|
514
|
+
# The name of the channel.
|
515
|
+
# @return [String]
|
516
|
+
#
|
517
|
+
# @!attribute [rw] channel_arn
|
518
|
+
# The Amazon Resource Name (ARN) of the channel.
|
519
|
+
# @return [String]
|
520
|
+
#
|
521
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/kinesisvideo-2017-09-30/DescribeMediaStorageConfigurationInput AWS API Documentation
|
522
|
+
#
|
523
|
+
class DescribeMediaStorageConfigurationInput < Struct.new(
|
524
|
+
:channel_name,
|
525
|
+
:channel_arn)
|
526
|
+
SENSITIVE = []
|
527
|
+
include Aws::Structure
|
528
|
+
end
|
529
|
+
|
530
|
+
# @!attribute [rw] media_storage_configuration
|
531
|
+
# A structure that encapsulates, or contains, the media storage
|
532
|
+
# configuration properties.
|
533
|
+
# @return [Types::MediaStorageConfiguration]
|
534
|
+
#
|
535
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/kinesisvideo-2017-09-30/DescribeMediaStorageConfigurationOutput AWS API Documentation
|
536
|
+
#
|
537
|
+
class DescribeMediaStorageConfigurationOutput < Struct.new(
|
538
|
+
:media_storage_configuration)
|
539
|
+
SENSITIVE = []
|
540
|
+
include Aws::Structure
|
541
|
+
end
|
542
|
+
|
434
543
|
# @!attribute [rw] stream_name
|
435
544
|
# The name of the stream from which to retrieve the notification
|
436
545
|
# configuration. You must specify either the `StreamName` or the
|
@@ -466,14 +575,6 @@ module Aws::KinesisVideo
|
|
466
575
|
include Aws::Structure
|
467
576
|
end
|
468
577
|
|
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
578
|
# @!attribute [rw] channel_name
|
478
579
|
# The name of the signaling channel that you want to describe.
|
479
580
|
# @return [String]
|
@@ -504,14 +605,6 @@ module Aws::KinesisVideo
|
|
504
605
|
include Aws::Structure
|
505
606
|
end
|
506
607
|
|
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
608
|
# @!attribute [rw] stream_name
|
516
609
|
# The name of the stream.
|
517
610
|
# @return [String]
|
@@ -554,15 +647,43 @@ module Aws::KinesisVideo
|
|
554
647
|
include Aws::Structure
|
555
648
|
end
|
556
649
|
|
557
|
-
#
|
558
|
-
#
|
650
|
+
# A description of the stream's edge configuration that will be used to
|
651
|
+
# sync with the Edge Agent IoT Greengrass component. The Edge Agent
|
652
|
+
# component will run on an IoT Hub Device setup at your premise.
|
653
|
+
#
|
654
|
+
# @!attribute [rw] hub_device_arn
|
655
|
+
# The "**Internet of Things (IoT) Thing**" Arn of the stream.
|
656
|
+
# @return [String]
|
559
657
|
#
|
560
|
-
#
|
561
|
-
#
|
562
|
-
#
|
563
|
-
#
|
564
|
-
#
|
658
|
+
# @!attribute [rw] recorder_config
|
659
|
+
# The recorder configuration consists of the local `MediaSourceConfig`
|
660
|
+
# details, that are used as credentials to access the local media
|
661
|
+
# files streamed on the camera.
|
662
|
+
# @return [Types::RecorderConfig]
|
565
663
|
#
|
664
|
+
# @!attribute [rw] uploader_config
|
665
|
+
# The uploader configuration contains the `ScheduleExpression` details
|
666
|
+
# that are used to schedule upload jobs for the recorded media files
|
667
|
+
# from the Edge Agent to a Kinesis Video Stream.
|
668
|
+
# @return [Types::UploaderConfig]
|
669
|
+
#
|
670
|
+
# @!attribute [rw] deletion_config
|
671
|
+
# The deletion configuration is made up of the retention time
|
672
|
+
# (`EdgeRetentionInHours`) and local size configuration
|
673
|
+
# (`LocalSizeConfig`) details that are used to make the deletion.
|
674
|
+
# @return [Types::DeletionConfig]
|
675
|
+
#
|
676
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/kinesisvideo-2017-09-30/EdgeConfig AWS API Documentation
|
677
|
+
#
|
678
|
+
class EdgeConfig < Struct.new(
|
679
|
+
:hub_device_arn,
|
680
|
+
:recorder_config,
|
681
|
+
:uploader_config,
|
682
|
+
:deletion_config)
|
683
|
+
SENSITIVE = []
|
684
|
+
include Aws::Structure
|
685
|
+
end
|
686
|
+
|
566
687
|
# @!attribute [rw] stream_name
|
567
688
|
# The name of the stream that you want to get the endpoint for. You
|
568
689
|
# must specify either this parameter or a `StreamARN` in the request.
|
@@ -601,17 +722,6 @@ module Aws::KinesisVideo
|
|
601
722
|
include Aws::Structure
|
602
723
|
end
|
603
724
|
|
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
725
|
# @!attribute [rw] channel_arn
|
616
726
|
# The Amazon Resource Name (ARN) of the signalling channel for which
|
617
727
|
# you want to get an endpoint.
|
@@ -647,25 +757,6 @@ module Aws::KinesisVideo
|
|
647
757
|
# images delivery. If null, the configuration will be deleted from the
|
648
758
|
# stream.
|
649
759
|
#
|
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
760
|
# @!attribute [rw] status
|
670
761
|
# Indicates whether the `ContinuousImageGenerationConfigurations` API
|
671
762
|
# is enabled or disabled.
|
@@ -744,16 +835,8 @@ module Aws::KinesisVideo
|
|
744
835
|
# The structure that contains the information required to deliver images
|
745
836
|
# to a customer.
|
746
837
|
#
|
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
838
|
# @!attribute [rw] uri
|
756
|
-
# The Uniform Resource
|
839
|
+
# The Uniform Resource Identifier (URI) that identifies where the
|
757
840
|
# images will be delivered.
|
758
841
|
# @return [String]
|
759
842
|
#
|
@@ -811,18 +894,6 @@ module Aws::KinesisVideo
|
|
811
894
|
include Aws::Structure
|
812
895
|
end
|
813
896
|
|
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
897
|
# @!attribute [rw] max_results
|
827
898
|
# The maximum number of channels to return in the response. The
|
828
899
|
# default is 500.
|
@@ -869,18 +940,6 @@ module Aws::KinesisVideo
|
|
869
940
|
include Aws::Structure
|
870
941
|
end
|
871
942
|
|
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
943
|
# @!attribute [rw] max_results
|
885
944
|
# The maximum number of streams to return in the response. The default
|
886
945
|
# is 10,000.
|
@@ -928,14 +987,6 @@ module Aws::KinesisVideo
|
|
928
987
|
include Aws::Structure
|
929
988
|
end
|
930
989
|
|
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
990
|
# @!attribute [rw] next_token
|
940
991
|
# If you specify this parameter and the result of a
|
941
992
|
# `ListTagsForResource` call is truncated, the response includes a
|
@@ -978,15 +1029,6 @@ module Aws::KinesisVideo
|
|
978
1029
|
include Aws::Structure
|
979
1030
|
end
|
980
1031
|
|
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
1032
|
# @!attribute [rw] next_token
|
991
1033
|
# If you specify this parameter and the result of a
|
992
1034
|
# `ListTagsForStream` call is truncated, the response includes a token
|
@@ -1032,6 +1074,98 @@ module Aws::KinesisVideo
|
|
1032
1074
|
include Aws::Structure
|
1033
1075
|
end
|
1034
1076
|
|
1077
|
+
# The configuration details that include the maximum size of the media
|
1078
|
+
# (`MaxLocalMediaSizeInMB`) that you want to store for a stream on the
|
1079
|
+
# Edge Agent, as well as the strategy that should be used
|
1080
|
+
# (`StrategyOnFullSize`) when a stream's maximum size has been reached.
|
1081
|
+
#
|
1082
|
+
# @!attribute [rw] max_local_media_size_in_mb
|
1083
|
+
# The overall maximum size of the media that you want to store for a
|
1084
|
+
# stream on the Edge Agent.
|
1085
|
+
# @return [Integer]
|
1086
|
+
#
|
1087
|
+
# @!attribute [rw] strategy_on_full_size
|
1088
|
+
# The strategy to perform when a stream’s `MaxLocalMediaSizeInMB`
|
1089
|
+
# limit is reached.
|
1090
|
+
# @return [String]
|
1091
|
+
#
|
1092
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/kinesisvideo-2017-09-30/LocalSizeConfig AWS API Documentation
|
1093
|
+
#
|
1094
|
+
class LocalSizeConfig < Struct.new(
|
1095
|
+
:max_local_media_size_in_mb,
|
1096
|
+
:strategy_on_full_size)
|
1097
|
+
SENSITIVE = []
|
1098
|
+
include Aws::Structure
|
1099
|
+
end
|
1100
|
+
|
1101
|
+
# A structure that encapsulates, or contains, the media storage
|
1102
|
+
# configuration properties.
|
1103
|
+
#
|
1104
|
+
# @!attribute [rw] type
|
1105
|
+
# The type of the associated resource for the kinesis video stream.
|
1106
|
+
# @return [String]
|
1107
|
+
#
|
1108
|
+
# @!attribute [rw] arn
|
1109
|
+
# The Amazon Resource Name (ARN) of the Kinesis Video Stream resource,
|
1110
|
+
# associated with the stream.
|
1111
|
+
# @return [String]
|
1112
|
+
#
|
1113
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/kinesisvideo-2017-09-30/MappedResourceConfigurationListItem AWS API Documentation
|
1114
|
+
#
|
1115
|
+
class MappedResourceConfigurationListItem < Struct.new(
|
1116
|
+
:type,
|
1117
|
+
:arn)
|
1118
|
+
SENSITIVE = []
|
1119
|
+
include Aws::Structure
|
1120
|
+
end
|
1121
|
+
|
1122
|
+
# The configuration details that consist of the credentials required
|
1123
|
+
# (`MediaUriSecretArn` and `MediaUriType`) to access the media files
|
1124
|
+
# that are streamed to the camera.
|
1125
|
+
#
|
1126
|
+
# @!attribute [rw] media_uri_secret_arn
|
1127
|
+
# The AWS Secrets Manager ARN for the username and password of the
|
1128
|
+
# camera, or a local media file location.
|
1129
|
+
# @return [String]
|
1130
|
+
#
|
1131
|
+
# @!attribute [rw] media_uri_type
|
1132
|
+
# The Uniform Resource Identifier (URI) type. The `FILE_URI` value can
|
1133
|
+
# be used to stream local media files.
|
1134
|
+
#
|
1135
|
+
# <note markdown="1"> Preview only supports the `RTSP_URI` media source URI format .
|
1136
|
+
#
|
1137
|
+
# </note>
|
1138
|
+
# @return [String]
|
1139
|
+
#
|
1140
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/kinesisvideo-2017-09-30/MediaSourceConfig AWS API Documentation
|
1141
|
+
#
|
1142
|
+
class MediaSourceConfig < Struct.new(
|
1143
|
+
:media_uri_secret_arn,
|
1144
|
+
:media_uri_type)
|
1145
|
+
SENSITIVE = [:media_uri_secret_arn]
|
1146
|
+
include Aws::Structure
|
1147
|
+
end
|
1148
|
+
|
1149
|
+
# A structure that encapsulates, or contains, the media storage
|
1150
|
+
# configuration properties.
|
1151
|
+
#
|
1152
|
+
# @!attribute [rw] stream_arn
|
1153
|
+
# The Amazon Resource Name (ARN) of the stream
|
1154
|
+
# @return [String]
|
1155
|
+
#
|
1156
|
+
# @!attribute [rw] status
|
1157
|
+
# The status of the media storage configuration.
|
1158
|
+
# @return [String]
|
1159
|
+
#
|
1160
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/kinesisvideo-2017-09-30/MediaStorageConfiguration AWS API Documentation
|
1161
|
+
#
|
1162
|
+
class MediaStorageConfiguration < Struct.new(
|
1163
|
+
:stream_arn,
|
1164
|
+
:status)
|
1165
|
+
SENSITIVE = []
|
1166
|
+
include Aws::Structure
|
1167
|
+
end
|
1168
|
+
|
1035
1169
|
# The Stream data retention in hours is equal to zero.
|
1036
1170
|
#
|
1037
1171
|
# @!attribute [rw] message
|
@@ -1062,16 +1196,6 @@ module Aws::KinesisVideo
|
|
1062
1196
|
# images delivery. If this parameter is null, the configuration will be
|
1063
1197
|
# deleted from the stream.
|
1064
1198
|
#
|
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
1199
|
# @!attribute [rw] status
|
1076
1200
|
# Indicates if a notification configuration is enabled or disabled.
|
1077
1201
|
# @return [String]
|
@@ -1093,15 +1217,8 @@ module Aws::KinesisVideo
|
|
1093
1217
|
# The structure that contains the information required to deliver a
|
1094
1218
|
# notification to a customer.
|
1095
1219
|
#
|
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
1220
|
# @!attribute [rw] uri
|
1104
|
-
# The Uniform Resource
|
1221
|
+
# The Uniform Resource Identifier (URI) that identifies where the
|
1105
1222
|
# images will be delivered.
|
1106
1223
|
# @return [String]
|
1107
1224
|
#
|
@@ -1113,6 +1230,33 @@ module Aws::KinesisVideo
|
|
1113
1230
|
include Aws::Structure
|
1114
1231
|
end
|
1115
1232
|
|
1233
|
+
# The recorder configuration consists of the local `MediaSourceConfig`
|
1234
|
+
# details that are used as credentials to accesss the local media files
|
1235
|
+
# streamed on the camera.
|
1236
|
+
#
|
1237
|
+
# @!attribute [rw] media_source_config
|
1238
|
+
# The configuration details that consist of the credentials required
|
1239
|
+
# (`MediaUriSecretArn` and `MediaUriType`) to access the media files
|
1240
|
+
# streamed to the camera.
|
1241
|
+
# @return [Types::MediaSourceConfig]
|
1242
|
+
#
|
1243
|
+
# @!attribute [rw] schedule_config
|
1244
|
+
# The configuration that consists of the `ScheduleExpression` and the
|
1245
|
+
# `DurationInMinutes` details that specify the scheduling to record
|
1246
|
+
# from a camera, or local media file, onto the Edge Agent. If the
|
1247
|
+
# `ScheduleExpression` attribute is not provided, then the Edge Agent
|
1248
|
+
# will always be set to recording mode.
|
1249
|
+
# @return [Types::ScheduleConfig]
|
1250
|
+
#
|
1251
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/kinesisvideo-2017-09-30/RecorderConfig AWS API Documentation
|
1252
|
+
#
|
1253
|
+
class RecorderConfig < Struct.new(
|
1254
|
+
:media_source_config,
|
1255
|
+
:schedule_config)
|
1256
|
+
SENSITIVE = []
|
1257
|
+
include Aws::Structure
|
1258
|
+
end
|
1259
|
+
|
1116
1260
|
# An object that describes the endpoint of the signaling channel
|
1117
1261
|
# returned by the `GetSignalingChannelEndpoint` API.
|
1118
1262
|
#
|
@@ -1135,15 +1279,19 @@ module Aws::KinesisVideo
|
|
1135
1279
|
include Aws::Structure
|
1136
1280
|
end
|
1137
1281
|
|
1138
|
-
#
|
1139
|
-
#
|
1140
|
-
#
|
1141
|
-
#
|
1282
|
+
# When the input `StreamARN` or `ChannelARN` in `CLOUD_STORAGE_MODE` is
|
1283
|
+
# already mapped to a different Kinesis Video Stream resource, or if the
|
1284
|
+
# provided input `StreamARN` or `ChannelARN` is not in Active status,
|
1285
|
+
# try one of the following :
|
1286
|
+
#
|
1287
|
+
# 1. The `DescribeMediaStorageConfiguration` API to determine what the
|
1288
|
+
# stream given channel is mapped to.
|
1142
1289
|
#
|
1143
|
-
#
|
1144
|
-
#
|
1145
|
-
#
|
1146
|
-
#
|
1290
|
+
# 2. The `DescribeMappedResourceConfiguration` API to determine the
|
1291
|
+
# channel that the given stream is mapped to.
|
1292
|
+
#
|
1293
|
+
# 3. The `DescribeStream` or `DescribeSignalingChannel` API to
|
1294
|
+
# determine the status of the resource.
|
1147
1295
|
#
|
1148
1296
|
# @!attribute [rw] message
|
1149
1297
|
# @return [String]
|
@@ -1170,16 +1318,45 @@ module Aws::KinesisVideo
|
|
1170
1318
|
include Aws::Structure
|
1171
1319
|
end
|
1172
1320
|
|
1173
|
-
#
|
1174
|
-
#
|
1321
|
+
# This API enables you to specify the duration that the camera, or local
|
1322
|
+
# media file, should record onto the Edge Agent. The `ScheduleConfig`
|
1323
|
+
# consists of the `ScheduleExpression` and the `DurationInMinutes`
|
1324
|
+
# attributes.
|
1325
|
+
#
|
1326
|
+
# If the `ScheduleExpression` is not provided, then the Edge Agent will
|
1327
|
+
# always be set to recording mode.
|
1328
|
+
#
|
1329
|
+
# @!attribute [rw] schedule_expression
|
1330
|
+
# The Quartz cron expression that takes care of scheduling jobs to
|
1331
|
+
# record from the camera, or local media file, onto the Edge Agent. If
|
1332
|
+
# the `ScheduleExpression` is not provided for the `RecorderConfig`,
|
1333
|
+
# then the Edge Agent will always be set to recording mode.
|
1334
|
+
#
|
1335
|
+
# For more information about Quartz, refer to the [ *Cron Trigger
|
1336
|
+
# Tutorial* ][1] page to understand the valid expressions and its use.
|
1175
1337
|
#
|
1176
|
-
# @note When making an API call, you may pass SingleMasterChannelEndpointConfiguration
|
1177
|
-
# data as a hash:
|
1178
1338
|
#
|
1179
|
-
#
|
1180
|
-
#
|
1181
|
-
#
|
1182
|
-
#
|
1339
|
+
#
|
1340
|
+
# [1]: http://www.quartz-scheduler.org/documentation/quartz-2.3.0/tutorials/crontrigger.html
|
1341
|
+
# @return [String]
|
1342
|
+
#
|
1343
|
+
# @!attribute [rw] duration_in_seconds
|
1344
|
+
# The total duration to record the media. If the `ScheduleExpression`
|
1345
|
+
# attribute is provided, then the `DurationInSeconds` attribute should
|
1346
|
+
# also be specified.
|
1347
|
+
# @return [Integer]
|
1348
|
+
#
|
1349
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/kinesisvideo-2017-09-30/ScheduleConfig AWS API Documentation
|
1350
|
+
#
|
1351
|
+
class ScheduleConfig < Struct.new(
|
1352
|
+
:schedule_expression,
|
1353
|
+
:duration_in_seconds)
|
1354
|
+
SENSITIVE = []
|
1355
|
+
include Aws::Structure
|
1356
|
+
end
|
1357
|
+
|
1358
|
+
# An object that contains the endpoint configuration for the
|
1359
|
+
# `SINGLE_MASTER` channel type.
|
1183
1360
|
#
|
1184
1361
|
# @!attribute [rw] protocols
|
1185
1362
|
# This property is used to determine the nature of communication over
|
@@ -1210,13 +1387,6 @@ module Aws::KinesisVideo
|
|
1210
1387
|
# A structure that contains the configuration for the `SINGLE_MASTER`
|
1211
1388
|
# channel type.
|
1212
1389
|
#
|
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
1390
|
# @!attribute [rw] message_ttl_seconds
|
1221
1391
|
# The period of time a signaling channel retains undelivered messages
|
1222
1392
|
# before they are discarded.
|
@@ -1230,6 +1400,95 @@ module Aws::KinesisVideo
|
|
1230
1400
|
include Aws::Structure
|
1231
1401
|
end
|
1232
1402
|
|
1403
|
+
# @!attribute [rw] stream_name
|
1404
|
+
# The name of the stream whose edge configuration you want to update.
|
1405
|
+
# Specify either the `StreamName` or the `StreamARN`.
|
1406
|
+
# @return [String]
|
1407
|
+
#
|
1408
|
+
# @!attribute [rw] stream_arn
|
1409
|
+
# The Amazon Resource Name (ARN) of the stream. Specify either the
|
1410
|
+
# `StreamName` or the `StreamARN`.
|
1411
|
+
# @return [String]
|
1412
|
+
#
|
1413
|
+
# @!attribute [rw] edge_config
|
1414
|
+
# The edge configuration details required to invoke the update
|
1415
|
+
# process.
|
1416
|
+
# @return [Types::EdgeConfig]
|
1417
|
+
#
|
1418
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/kinesisvideo-2017-09-30/StartEdgeConfigurationUpdateInput AWS API Documentation
|
1419
|
+
#
|
1420
|
+
class StartEdgeConfigurationUpdateInput < Struct.new(
|
1421
|
+
:stream_name,
|
1422
|
+
:stream_arn,
|
1423
|
+
:edge_config)
|
1424
|
+
SENSITIVE = []
|
1425
|
+
include Aws::Structure
|
1426
|
+
end
|
1427
|
+
|
1428
|
+
# @!attribute [rw] stream_name
|
1429
|
+
# The name of the stream from which the edge configuration was
|
1430
|
+
# updated.
|
1431
|
+
# @return [String]
|
1432
|
+
#
|
1433
|
+
# @!attribute [rw] stream_arn
|
1434
|
+
# The Amazon Resource Name (ARN) of the stream.
|
1435
|
+
# @return [String]
|
1436
|
+
#
|
1437
|
+
# @!attribute [rw] creation_time
|
1438
|
+
# The timestamp at which a stream’s edge configuration was first
|
1439
|
+
# created.
|
1440
|
+
# @return [Time]
|
1441
|
+
#
|
1442
|
+
# @!attribute [rw] last_updated_time
|
1443
|
+
# The timestamp at which a stream’s edge configuration was last
|
1444
|
+
# updated.
|
1445
|
+
# @return [Time]
|
1446
|
+
#
|
1447
|
+
# @!attribute [rw] sync_status
|
1448
|
+
# The current sync status of the stream's edge configuration. When
|
1449
|
+
# you invoke this API, the sync status will be set to the `SYNCING`
|
1450
|
+
# state. Use the `DescribeEdgeConfiguration` API to get the latest
|
1451
|
+
# status of the edge configuration.
|
1452
|
+
# @return [String]
|
1453
|
+
#
|
1454
|
+
# @!attribute [rw] failed_status_details
|
1455
|
+
# A description of the generated failure status.
|
1456
|
+
# @return [String]
|
1457
|
+
#
|
1458
|
+
# @!attribute [rw] edge_config
|
1459
|
+
# A description of the stream's edge configuration that will be used
|
1460
|
+
# to sync with the Edge Agent IoT Greengrass component. The Edge Agent
|
1461
|
+
# component will run on an IoT Hub Device setup at your premise.
|
1462
|
+
# @return [Types::EdgeConfig]
|
1463
|
+
#
|
1464
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/kinesisvideo-2017-09-30/StartEdgeConfigurationUpdateOutput AWS API Documentation
|
1465
|
+
#
|
1466
|
+
class StartEdgeConfigurationUpdateOutput < Struct.new(
|
1467
|
+
:stream_name,
|
1468
|
+
:stream_arn,
|
1469
|
+
:creation_time,
|
1470
|
+
:last_updated_time,
|
1471
|
+
:sync_status,
|
1472
|
+
:failed_status_details,
|
1473
|
+
:edge_config)
|
1474
|
+
SENSITIVE = []
|
1475
|
+
include Aws::Structure
|
1476
|
+
end
|
1477
|
+
|
1478
|
+
# The Exception rendered when the Amazon Kinesis Video Stream can't
|
1479
|
+
# find a stream's edge configuration that you specified.
|
1480
|
+
#
|
1481
|
+
# @!attribute [rw] message
|
1482
|
+
# @return [String]
|
1483
|
+
#
|
1484
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/kinesisvideo-2017-09-30/StreamEdgeConfigurationNotFoundException AWS API Documentation
|
1485
|
+
#
|
1486
|
+
class StreamEdgeConfigurationNotFoundException < Struct.new(
|
1487
|
+
:message)
|
1488
|
+
SENSITIVE = []
|
1489
|
+
include Aws::Structure
|
1490
|
+
end
|
1491
|
+
|
1233
1492
|
# An object describing a Kinesis video stream.
|
1234
1493
|
#
|
1235
1494
|
# @!attribute [rw] device_name
|
@@ -1291,14 +1550,6 @@ module Aws::KinesisVideo
|
|
1291
1550
|
# `BEGINS_WITH` operator, which finds streams whose names start with a
|
1292
1551
|
# given prefix.
|
1293
1552
|
#
|
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
1553
|
# @!attribute [rw] comparison_operator
|
1303
1554
|
# A comparison operator. Currently, you can specify only the
|
1304
1555
|
# `BEGINS_WITH` operator, which finds streams whose names start with a
|
@@ -1321,14 +1572,6 @@ module Aws::KinesisVideo
|
|
1321
1572
|
# A key and value pair that is associated with the specified signaling
|
1322
1573
|
# channel.
|
1323
1574
|
#
|
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
1575
|
# @!attribute [rw] key
|
1333
1576
|
# The key of the tag that is associated with the specified signaling
|
1334
1577
|
# channel.
|
@@ -1348,19 +1591,6 @@ module Aws::KinesisVideo
|
|
1348
1591
|
include Aws::Structure
|
1349
1592
|
end
|
1350
1593
|
|
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
1594
|
# @!attribute [rw] resource_arn
|
1365
1595
|
# The Amazon Resource Name (ARN) of the signaling channel to which you
|
1366
1596
|
# want to add tags.
|
@@ -1384,17 +1614,6 @@ module Aws::KinesisVideo
|
|
1384
1614
|
#
|
1385
1615
|
class TagResourceOutput < Aws::EmptyStructure; end
|
1386
1616
|
|
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
1617
|
# @!attribute [rw] stream_arn
|
1399
1618
|
# The Amazon Resource Name (ARN) of the resource that you want to add
|
1400
1619
|
# the tag or tags to.
|
@@ -1437,14 +1656,6 @@ module Aws::KinesisVideo
|
|
1437
1656
|
include Aws::Structure
|
1438
1657
|
end
|
1439
1658
|
|
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
1659
|
# @!attribute [rw] resource_arn
|
1449
1660
|
# The Amazon Resource Name (ARN) of the signaling channel from which
|
1450
1661
|
# you want to remove tags.
|
@@ -1467,15 +1678,6 @@ module Aws::KinesisVideo
|
|
1467
1678
|
#
|
1468
1679
|
class UntagResourceOutput < Aws::EmptyStructure; end
|
1469
1680
|
|
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
1681
|
# @!attribute [rw] stream_arn
|
1480
1682
|
# The Amazon Resource Name (ARN) of the stream that you want to remove
|
1481
1683
|
# tags from.
|
@@ -1503,17 +1705,6 @@ module Aws::KinesisVideo
|
|
1503
1705
|
#
|
1504
1706
|
class UntagStreamOutput < Aws::EmptyStructure; end
|
1505
1707
|
|
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
1708
|
# @!attribute [rw] stream_name
|
1518
1709
|
# The name of the stream whose retention period you want to change.
|
1519
1710
|
# @return [String]
|
@@ -1556,29 +1747,6 @@ module Aws::KinesisVideo
|
|
1556
1747
|
#
|
1557
1748
|
class UpdateDataRetentionOutput < Aws::EmptyStructure; end
|
1558
1749
|
|
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
1750
|
# @!attribute [rw] stream_name
|
1583
1751
|
# The name of the stream from which to update the image generation
|
1584
1752
|
# configuration. You must specify either the `StreamName` or the
|
@@ -1611,20 +1779,28 @@ module Aws::KinesisVideo
|
|
1611
1779
|
#
|
1612
1780
|
class UpdateImageGenerationConfigurationOutput < Aws::EmptyStructure; end
|
1613
1781
|
|
1614
|
-
#
|
1615
|
-
#
|
1782
|
+
# @!attribute [rw] channel_arn
|
1783
|
+
# The Amazon Resource Name (ARN) of the channel.
|
1784
|
+
# @return [String]
|
1785
|
+
#
|
1786
|
+
# @!attribute [rw] media_storage_configuration
|
1787
|
+
# A structure that encapsulates, or contains, the media storage
|
1788
|
+
# configuration properties.
|
1789
|
+
# @return [Types::MediaStorageConfiguration]
|
1616
1790
|
#
|
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
|
-
# }
|
1791
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/kinesisvideo-2017-09-30/UpdateMediaStorageConfigurationInput AWS API Documentation
|
1627
1792
|
#
|
1793
|
+
class UpdateMediaStorageConfigurationInput < Struct.new(
|
1794
|
+
:channel_arn,
|
1795
|
+
:media_storage_configuration)
|
1796
|
+
SENSITIVE = []
|
1797
|
+
include Aws::Structure
|
1798
|
+
end
|
1799
|
+
|
1800
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/kinesisvideo-2017-09-30/UpdateMediaStorageConfigurationOutput AWS API Documentation
|
1801
|
+
#
|
1802
|
+
class UpdateMediaStorageConfigurationOutput < Aws::EmptyStructure; end
|
1803
|
+
|
1628
1804
|
# @!attribute [rw] stream_name
|
1629
1805
|
# The name of the stream from which to update the notification
|
1630
1806
|
# configuration. You must specify either the `StreamName` or the
|
@@ -1657,17 +1833,6 @@ module Aws::KinesisVideo
|
|
1657
1833
|
#
|
1658
1834
|
class UpdateNotificationConfigurationOutput < Aws::EmptyStructure; end
|
1659
1835
|
|
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
1836
|
# @!attribute [rw] channel_arn
|
1672
1837
|
# The Amazon Resource Name (ARN) of the signaling channel that you
|
1673
1838
|
# want to update.
|
@@ -1697,17 +1862,6 @@ module Aws::KinesisVideo
|
|
1697
1862
|
#
|
1698
1863
|
class UpdateSignalingChannelOutput < Aws::EmptyStructure; end
|
1699
1864
|
|
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
1865
|
# @!attribute [rw] stream_name
|
1712
1866
|
# The name of the stream whose metadata you want to update.
|
1713
1867
|
#
|
@@ -1764,6 +1918,28 @@ module Aws::KinesisVideo
|
|
1764
1918
|
#
|
1765
1919
|
class UpdateStreamOutput < Aws::EmptyStructure; end
|
1766
1920
|
|
1921
|
+
# The configuration that consists of the `ScheduleExpression` and the
|
1922
|
+
# `DurationInMinutesdetails`, that specify the scheduling to record from
|
1923
|
+
# a camera, or local media file, onto the Edge Agent. If the
|
1924
|
+
# `ScheduleExpression` is not provided, then the Edge Agent will always
|
1925
|
+
# be in upload mode.
|
1926
|
+
#
|
1927
|
+
# @!attribute [rw] schedule_config
|
1928
|
+
# The configuration that consists of the `ScheduleExpression` and the
|
1929
|
+
# `DurationInMinutes`details that specify the scheduling to record
|
1930
|
+
# from a camera, or local media file, onto the Edge Agent. If the
|
1931
|
+
# `ScheduleExpression` is not provided, then the Edge Agent will
|
1932
|
+
# always be in recording mode.
|
1933
|
+
# @return [Types::ScheduleConfig]
|
1934
|
+
#
|
1935
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/kinesisvideo-2017-09-30/UploaderConfig AWS API Documentation
|
1936
|
+
#
|
1937
|
+
class UploaderConfig < Struct.new(
|
1938
|
+
:schedule_config)
|
1939
|
+
SENSITIVE = []
|
1940
|
+
include Aws::Structure
|
1941
|
+
end
|
1942
|
+
|
1767
1943
|
# The stream version that you specified is not the latest version. To
|
1768
1944
|
# get the latest version, use the [DescribeStream][1] API.
|
1769
1945
|
#
|