aws-sdk-kinesisvideo 1.20.0 → 1.21.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/lib/aws-sdk-kinesisvideo.rb +1 -1
- data/lib/aws-sdk-kinesisvideo/client.rb +380 -1
- data/lib/aws-sdk-kinesisvideo/client_api.rb +266 -0
- data/lib/aws-sdk-kinesisvideo/errors.rb +32 -0
- data/lib/aws-sdk-kinesisvideo/types.rb +578 -0
- metadata +2 -2
@@ -8,6 +8,31 @@
|
|
8
8
|
module Aws::KinesisVideo
|
9
9
|
module Types
|
10
10
|
|
11
|
+
# You do not have required permissions to perform this operation.
|
12
|
+
#
|
13
|
+
# @!attribute [rw] message
|
14
|
+
# @return [String]
|
15
|
+
#
|
16
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/kinesisvideo-2017-09-30/AccessDeniedException AWS API Documentation
|
17
|
+
#
|
18
|
+
class AccessDeniedException < Struct.new(
|
19
|
+
:message)
|
20
|
+
include Aws::Structure
|
21
|
+
end
|
22
|
+
|
23
|
+
# You have reached the maximum limit of active signaling channels for
|
24
|
+
# this AWS account in this region.
|
25
|
+
#
|
26
|
+
# @!attribute [rw] message
|
27
|
+
# @return [String]
|
28
|
+
#
|
29
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/kinesisvideo-2017-09-30/AccountChannelLimitExceededException AWS API Documentation
|
30
|
+
#
|
31
|
+
class AccountChannelLimitExceededException < Struct.new(
|
32
|
+
:message)
|
33
|
+
include Aws::Structure
|
34
|
+
end
|
35
|
+
|
11
36
|
# The number of streams created for the account is too high.
|
12
37
|
#
|
13
38
|
# @!attribute [rw] message
|
@@ -20,6 +45,82 @@ module Aws::KinesisVideo
|
|
20
45
|
include Aws::Structure
|
21
46
|
end
|
22
47
|
|
48
|
+
# A structure that encapsulates a signaling channel's metadata and
|
49
|
+
# properties.
|
50
|
+
#
|
51
|
+
# @!attribute [rw] channel_name
|
52
|
+
# The name of the signaling channel.
|
53
|
+
# @return [String]
|
54
|
+
#
|
55
|
+
# @!attribute [rw] channel_arn
|
56
|
+
# The ARN of the signaling channel.
|
57
|
+
# @return [String]
|
58
|
+
#
|
59
|
+
# @!attribute [rw] channel_type
|
60
|
+
# The type of the signaling channel.
|
61
|
+
# @return [String]
|
62
|
+
#
|
63
|
+
# @!attribute [rw] channel_status
|
64
|
+
# Current status of the signaling channel.
|
65
|
+
# @return [String]
|
66
|
+
#
|
67
|
+
# @!attribute [rw] creation_time
|
68
|
+
# The time at which the signaling channel was created.
|
69
|
+
# @return [Time]
|
70
|
+
#
|
71
|
+
# @!attribute [rw] single_master_configuration
|
72
|
+
# A structure that contains the configuration for the `SINGLE_MASTER`
|
73
|
+
# channel type.
|
74
|
+
# @return [Types::SingleMasterConfiguration]
|
75
|
+
#
|
76
|
+
# @!attribute [rw] version
|
77
|
+
# The current version of the signaling channel.
|
78
|
+
# @return [String]
|
79
|
+
#
|
80
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/kinesisvideo-2017-09-30/ChannelInfo AWS API Documentation
|
81
|
+
#
|
82
|
+
class ChannelInfo < Struct.new(
|
83
|
+
:channel_name,
|
84
|
+
:channel_arn,
|
85
|
+
:channel_type,
|
86
|
+
:channel_status,
|
87
|
+
:creation_time,
|
88
|
+
:single_master_configuration,
|
89
|
+
:version)
|
90
|
+
include Aws::Structure
|
91
|
+
end
|
92
|
+
|
93
|
+
# An optional input parameter for the `ListSignalingChannels` API. When
|
94
|
+
# this parameter is specified while invoking `ListSignalingChannels`,
|
95
|
+
# the API returns only the channels that satisfy a condition specified
|
96
|
+
# in `ChannelNameCondition`.
|
97
|
+
#
|
98
|
+
# @note When making an API call, you may pass ChannelNameCondition
|
99
|
+
# data as a hash:
|
100
|
+
#
|
101
|
+
# {
|
102
|
+
# comparison_operator: "BEGINS_WITH", # accepts BEGINS_WITH
|
103
|
+
# comparison_value: "ChannelName",
|
104
|
+
# }
|
105
|
+
#
|
106
|
+
# @!attribute [rw] comparison_operator
|
107
|
+
# A comparison operator. Currently, you can only specify the
|
108
|
+
# `BEGINS_WITH` operator, which finds signaling channels whose names
|
109
|
+
# begin with a given prefix.
|
110
|
+
# @return [String]
|
111
|
+
#
|
112
|
+
# @!attribute [rw] comparison_value
|
113
|
+
# A value to compare.
|
114
|
+
# @return [String]
|
115
|
+
#
|
116
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/kinesisvideo-2017-09-30/ChannelNameCondition AWS API Documentation
|
117
|
+
#
|
118
|
+
class ChannelNameCondition < Struct.new(
|
119
|
+
:comparison_operator,
|
120
|
+
:comparison_value)
|
121
|
+
include Aws::Structure
|
122
|
+
end
|
123
|
+
|
23
124
|
# Kinesis Video Streams has throttled the request because you have
|
24
125
|
# exceeded the limit of allowed client calls. Try making the call later.
|
25
126
|
#
|
@@ -33,6 +134,64 @@ module Aws::KinesisVideo
|
|
33
134
|
include Aws::Structure
|
34
135
|
end
|
35
136
|
|
137
|
+
# @note When making an API call, you may pass CreateSignalingChannelInput
|
138
|
+
# data as a hash:
|
139
|
+
#
|
140
|
+
# {
|
141
|
+
# channel_name: "ChannelName", # required
|
142
|
+
# channel_type: "SINGLE_MASTER", # accepts SINGLE_MASTER
|
143
|
+
# single_master_configuration: {
|
144
|
+
# message_ttl_seconds: 1,
|
145
|
+
# },
|
146
|
+
# tags: [
|
147
|
+
# {
|
148
|
+
# key: "TagKey", # required
|
149
|
+
# value: "TagValue", # required
|
150
|
+
# },
|
151
|
+
# ],
|
152
|
+
# }
|
153
|
+
#
|
154
|
+
# @!attribute [rw] channel_name
|
155
|
+
# A name for the signaling channel that you are creating. It must be
|
156
|
+
# unique for each account and region.
|
157
|
+
# @return [String]
|
158
|
+
#
|
159
|
+
# @!attribute [rw] channel_type
|
160
|
+
# A type of the signaling channel that you are creating. Currently,
|
161
|
+
# `SINGLE_MASTER` is the only supported channel type.
|
162
|
+
# @return [String]
|
163
|
+
#
|
164
|
+
# @!attribute [rw] single_master_configuration
|
165
|
+
# A structure containing the configuration for the `SINGLE_MASTER`
|
166
|
+
# channel type.
|
167
|
+
# @return [Types::SingleMasterConfiguration]
|
168
|
+
#
|
169
|
+
# @!attribute [rw] tags
|
170
|
+
# A set of tags (key/value pairs) that you want to associate with this
|
171
|
+
# channel.
|
172
|
+
# @return [Array<Types::Tag>]
|
173
|
+
#
|
174
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/kinesisvideo-2017-09-30/CreateSignalingChannelInput AWS API Documentation
|
175
|
+
#
|
176
|
+
class CreateSignalingChannelInput < Struct.new(
|
177
|
+
:channel_name,
|
178
|
+
:channel_type,
|
179
|
+
:single_master_configuration,
|
180
|
+
:tags)
|
181
|
+
include Aws::Structure
|
182
|
+
end
|
183
|
+
|
184
|
+
# @!attribute [rw] channel_arn
|
185
|
+
# The ARN of the created channel.
|
186
|
+
# @return [String]
|
187
|
+
#
|
188
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/kinesisvideo-2017-09-30/CreateSignalingChannelOutput AWS API Documentation
|
189
|
+
#
|
190
|
+
class CreateSignalingChannelOutput < Struct.new(
|
191
|
+
:channel_arn)
|
192
|
+
include Aws::Structure
|
193
|
+
end
|
194
|
+
|
36
195
|
# @note When making an API call, you may pass CreateStreamInput
|
37
196
|
# data as a hash:
|
38
197
|
#
|
@@ -69,6 +228,9 @@ module Aws::KinesisVideo
|
|
69
228
|
# media types, see [Media Types][1]. If you choose to specify the
|
70
229
|
# `MediaType`, see [Naming Requirements][2] for guidelines.
|
71
230
|
#
|
231
|
+
# Example valid values include "video/h264" and
|
232
|
+
# "video/h264,audio/aac".
|
233
|
+
#
|
72
234
|
# This parameter is optional; the default value is `null` (or empty in
|
73
235
|
# JSON).
|
74
236
|
#
|
@@ -135,6 +297,36 @@ module Aws::KinesisVideo
|
|
135
297
|
include Aws::Structure
|
136
298
|
end
|
137
299
|
|
300
|
+
# @note When making an API call, you may pass DeleteSignalingChannelInput
|
301
|
+
# data as a hash:
|
302
|
+
#
|
303
|
+
# {
|
304
|
+
# channel_arn: "ResourceARN", # required
|
305
|
+
# current_version: "Version",
|
306
|
+
# }
|
307
|
+
#
|
308
|
+
# @!attribute [rw] channel_arn
|
309
|
+
# The ARN of the signaling channel that you want to delete.
|
310
|
+
# @return [String]
|
311
|
+
#
|
312
|
+
# @!attribute [rw] current_version
|
313
|
+
# The current version of the signaling channel that you want to
|
314
|
+
# delete. You can obtain the current version by invoking the
|
315
|
+
# `DescribeSignalingChannel` or `ListSignalingChannels` APIs.
|
316
|
+
# @return [String]
|
317
|
+
#
|
318
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/kinesisvideo-2017-09-30/DeleteSignalingChannelInput AWS API Documentation
|
319
|
+
#
|
320
|
+
class DeleteSignalingChannelInput < Struct.new(
|
321
|
+
:channel_arn,
|
322
|
+
:current_version)
|
323
|
+
include Aws::Structure
|
324
|
+
end
|
325
|
+
|
326
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/kinesisvideo-2017-09-30/DeleteSignalingChannelOutput AWS API Documentation
|
327
|
+
#
|
328
|
+
class DeleteSignalingChannelOutput < Aws::EmptyStructure; end
|
329
|
+
|
138
330
|
# @note When making an API call, you may pass DeleteStreamInput
|
139
331
|
# data as a hash:
|
140
332
|
#
|
@@ -171,6 +363,42 @@ module Aws::KinesisVideo
|
|
171
363
|
#
|
172
364
|
class DeleteStreamOutput < Aws::EmptyStructure; end
|
173
365
|
|
366
|
+
# @note When making an API call, you may pass DescribeSignalingChannelInput
|
367
|
+
# data as a hash:
|
368
|
+
#
|
369
|
+
# {
|
370
|
+
# channel_name: "ChannelName",
|
371
|
+
# channel_arn: "ResourceARN",
|
372
|
+
# }
|
373
|
+
#
|
374
|
+
# @!attribute [rw] channel_name
|
375
|
+
# The name of the signaling channel that you want to describe.
|
376
|
+
# @return [String]
|
377
|
+
#
|
378
|
+
# @!attribute [rw] channel_arn
|
379
|
+
# The ARN of the signaling channel that you want to describe.
|
380
|
+
# @return [String]
|
381
|
+
#
|
382
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/kinesisvideo-2017-09-30/DescribeSignalingChannelInput AWS API Documentation
|
383
|
+
#
|
384
|
+
class DescribeSignalingChannelInput < Struct.new(
|
385
|
+
:channel_name,
|
386
|
+
:channel_arn)
|
387
|
+
include Aws::Structure
|
388
|
+
end
|
389
|
+
|
390
|
+
# @!attribute [rw] channel_info
|
391
|
+
# A structure that encapsulates the specified signaling channel's
|
392
|
+
# metadata and properties.
|
393
|
+
# @return [Types::ChannelInfo]
|
394
|
+
#
|
395
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/kinesisvideo-2017-09-30/DescribeSignalingChannelOutput AWS API Documentation
|
396
|
+
#
|
397
|
+
class DescribeSignalingChannelOutput < Struct.new(
|
398
|
+
:channel_info)
|
399
|
+
include Aws::Structure
|
400
|
+
end
|
401
|
+
|
174
402
|
# @note When making an API call, you may pass DescribeStreamInput
|
175
403
|
# data as a hash:
|
176
404
|
#
|
@@ -263,6 +491,46 @@ module Aws::KinesisVideo
|
|
263
491
|
include Aws::Structure
|
264
492
|
end
|
265
493
|
|
494
|
+
# @note When making an API call, you may pass GetSignalingChannelEndpointInput
|
495
|
+
# data as a hash:
|
496
|
+
#
|
497
|
+
# {
|
498
|
+
# channel_arn: "ResourceARN", # required
|
499
|
+
# single_master_channel_endpoint_configuration: {
|
500
|
+
# protocols: ["WSS"], # accepts WSS, HTTPS
|
501
|
+
# role: "MASTER", # accepts MASTER, VIEWER
|
502
|
+
# },
|
503
|
+
# }
|
504
|
+
#
|
505
|
+
# @!attribute [rw] channel_arn
|
506
|
+
# The ARN of the signalling channel for which you want to get an
|
507
|
+
# endpoint.
|
508
|
+
# @return [String]
|
509
|
+
#
|
510
|
+
# @!attribute [rw] single_master_channel_endpoint_configuration
|
511
|
+
# A structure containing the endpoint configuration for the
|
512
|
+
# `SINGLE_MASTER` channel type.
|
513
|
+
# @return [Types::SingleMasterChannelEndpointConfiguration]
|
514
|
+
#
|
515
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/kinesisvideo-2017-09-30/GetSignalingChannelEndpointInput AWS API Documentation
|
516
|
+
#
|
517
|
+
class GetSignalingChannelEndpointInput < Struct.new(
|
518
|
+
:channel_arn,
|
519
|
+
:single_master_channel_endpoint_configuration)
|
520
|
+
include Aws::Structure
|
521
|
+
end
|
522
|
+
|
523
|
+
# @!attribute [rw] resource_endpoint_list
|
524
|
+
# A list of endpoints for the specified signaling channel.
|
525
|
+
# @return [Array<Types::ResourceEndpointListItem>]
|
526
|
+
#
|
527
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/kinesisvideo-2017-09-30/GetSignalingChannelEndpointOutput AWS API Documentation
|
528
|
+
#
|
529
|
+
class GetSignalingChannelEndpointOutput < Struct.new(
|
530
|
+
:resource_endpoint_list)
|
531
|
+
include Aws::Structure
|
532
|
+
end
|
533
|
+
|
266
534
|
# The value for this input parameter is invalid.
|
267
535
|
#
|
268
536
|
# @!attribute [rw] message
|
@@ -299,6 +567,62 @@ module Aws::KinesisVideo
|
|
299
567
|
include Aws::Structure
|
300
568
|
end
|
301
569
|
|
570
|
+
# @note When making an API call, you may pass ListSignalingChannelsInput
|
571
|
+
# data as a hash:
|
572
|
+
#
|
573
|
+
# {
|
574
|
+
# max_results: 1,
|
575
|
+
# next_token: "NextToken",
|
576
|
+
# channel_name_condition: {
|
577
|
+
# comparison_operator: "BEGINS_WITH", # accepts BEGINS_WITH
|
578
|
+
# comparison_value: "ChannelName",
|
579
|
+
# },
|
580
|
+
# }
|
581
|
+
#
|
582
|
+
# @!attribute [rw] max_results
|
583
|
+
# The maximum number of channels to return in the response. The
|
584
|
+
# default is 500.
|
585
|
+
# @return [Integer]
|
586
|
+
#
|
587
|
+
# @!attribute [rw] next_token
|
588
|
+
# If you specify this parameter, when the result of a
|
589
|
+
# `ListSignalingChannels` operation is truncated, the call returns the
|
590
|
+
# `NextToken` in the response. To get another batch of channels,
|
591
|
+
# provide this token in your next request.
|
592
|
+
# @return [String]
|
593
|
+
#
|
594
|
+
# @!attribute [rw] channel_name_condition
|
595
|
+
# Optional: Returns only the channels that satisfy a specific
|
596
|
+
# condition.
|
597
|
+
# @return [Types::ChannelNameCondition]
|
598
|
+
#
|
599
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/kinesisvideo-2017-09-30/ListSignalingChannelsInput AWS API Documentation
|
600
|
+
#
|
601
|
+
class ListSignalingChannelsInput < Struct.new(
|
602
|
+
:max_results,
|
603
|
+
:next_token,
|
604
|
+
:channel_name_condition)
|
605
|
+
include Aws::Structure
|
606
|
+
end
|
607
|
+
|
608
|
+
# @!attribute [rw] channel_info_list
|
609
|
+
# An array of `ChannelInfo` objects.
|
610
|
+
# @return [Array<Types::ChannelInfo>]
|
611
|
+
#
|
612
|
+
# @!attribute [rw] next_token
|
613
|
+
# If the response is truncated, the call returns this element with a
|
614
|
+
# token. To get the next batch of streams, use this token in your next
|
615
|
+
# request.
|
616
|
+
# @return [String]
|
617
|
+
#
|
618
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/kinesisvideo-2017-09-30/ListSignalingChannelsOutput AWS API Documentation
|
619
|
+
#
|
620
|
+
class ListSignalingChannelsOutput < Struct.new(
|
621
|
+
:channel_info_list,
|
622
|
+
:next_token)
|
623
|
+
include Aws::Structure
|
624
|
+
end
|
625
|
+
|
302
626
|
# @note When making an API call, you may pass ListStreamsInput
|
303
627
|
# data as a hash:
|
304
628
|
#
|
@@ -356,6 +680,52 @@ module Aws::KinesisVideo
|
|
356
680
|
include Aws::Structure
|
357
681
|
end
|
358
682
|
|
683
|
+
# @note When making an API call, you may pass ListTagsForResourceInput
|
684
|
+
# data as a hash:
|
685
|
+
#
|
686
|
+
# {
|
687
|
+
# next_token: "NextToken",
|
688
|
+
# resource_arn: "ResourceARN", # required
|
689
|
+
# }
|
690
|
+
#
|
691
|
+
# @!attribute [rw] next_token
|
692
|
+
# If you specify this parameter and the result of a
|
693
|
+
# ListTagsForResource call is truncated, the response includes a token
|
694
|
+
# that you can use in the next request to fetch the next batch of
|
695
|
+
# tags.
|
696
|
+
# @return [String]
|
697
|
+
#
|
698
|
+
# @!attribute [rw] resource_arn
|
699
|
+
# The ARN of the signaling channel for which you want to list tags.
|
700
|
+
# @return [String]
|
701
|
+
#
|
702
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/kinesisvideo-2017-09-30/ListTagsForResourceInput AWS API Documentation
|
703
|
+
#
|
704
|
+
class ListTagsForResourceInput < Struct.new(
|
705
|
+
:next_token,
|
706
|
+
:resource_arn)
|
707
|
+
include Aws::Structure
|
708
|
+
end
|
709
|
+
|
710
|
+
# @!attribute [rw] next_token
|
711
|
+
# If you specify this parameter and the result of a
|
712
|
+
# ListTagsForResource call is truncated, the response includes a token
|
713
|
+
# that you can use in the next request to fetch the next set of tags.
|
714
|
+
# @return [String]
|
715
|
+
#
|
716
|
+
# @!attribute [rw] tags
|
717
|
+
# A map of tag keys and values associated with the specified signaling
|
718
|
+
# channel.
|
719
|
+
# @return [Hash<String,String>]
|
720
|
+
#
|
721
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/kinesisvideo-2017-09-30/ListTagsForResourceOutput AWS API Documentation
|
722
|
+
#
|
723
|
+
class ListTagsForResourceOutput < Struct.new(
|
724
|
+
:next_token,
|
725
|
+
:tags)
|
726
|
+
include Aws::Structure
|
727
|
+
end
|
728
|
+
|
359
729
|
# @note When making an API call, you may pass ListTagsForStreamInput
|
360
730
|
# data as a hash:
|
361
731
|
#
|
@@ -420,6 +790,27 @@ module Aws::KinesisVideo
|
|
420
790
|
include Aws::Structure
|
421
791
|
end
|
422
792
|
|
793
|
+
# An object that describes the endpoint of the signaling channel
|
794
|
+
# returned by the `GetSignalingChannelEndpoint` API.
|
795
|
+
#
|
796
|
+
# @!attribute [rw] protocol
|
797
|
+
# The protocol of the signaling channel returned by the
|
798
|
+
# `GetSignalingChannelEndpoint` API.
|
799
|
+
# @return [String]
|
800
|
+
#
|
801
|
+
# @!attribute [rw] resource_endpoint
|
802
|
+
# The endpoint of the signaling channel returned by the
|
803
|
+
# `GetSignalingChannelEndpoint` API.
|
804
|
+
# @return [String]
|
805
|
+
#
|
806
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/kinesisvideo-2017-09-30/ResourceEndpointListItem AWS API Documentation
|
807
|
+
#
|
808
|
+
class ResourceEndpointListItem < Struct.new(
|
809
|
+
:protocol,
|
810
|
+
:resource_endpoint)
|
811
|
+
include Aws::Structure
|
812
|
+
end
|
813
|
+
|
423
814
|
# The stream is currently not available for this operation.
|
424
815
|
#
|
425
816
|
# @!attribute [rw] message
|
@@ -445,6 +836,64 @@ module Aws::KinesisVideo
|
|
445
836
|
include Aws::Structure
|
446
837
|
end
|
447
838
|
|
839
|
+
# An object that contains the endpoint configuration for the
|
840
|
+
# `SINGLE_MASTER` channel type.
|
841
|
+
#
|
842
|
+
# @note When making an API call, you may pass SingleMasterChannelEndpointConfiguration
|
843
|
+
# data as a hash:
|
844
|
+
#
|
845
|
+
# {
|
846
|
+
# protocols: ["WSS"], # accepts WSS, HTTPS
|
847
|
+
# role: "MASTER", # accepts MASTER, VIEWER
|
848
|
+
# }
|
849
|
+
#
|
850
|
+
# @!attribute [rw] protocols
|
851
|
+
# This property is used to determine the nature of communication over
|
852
|
+
# this `SINGLE_MASTER` signaling channel. If `WSS` is specified, this
|
853
|
+
# API returns a websocket endpoint. If `HTTPS` is specified, this API
|
854
|
+
# returns an `HTTPS` endpoint.
|
855
|
+
# @return [Array<String>]
|
856
|
+
#
|
857
|
+
# @!attribute [rw] role
|
858
|
+
# This property is used to determine messaging permissions in this
|
859
|
+
# `SINGLE_MASTER` signaling channel. If `MASTER` is specified, this
|
860
|
+
# API returns an endpoint that a client can use to receive offers from
|
861
|
+
# and send answers to any of the viewers on this signaling channel. If
|
862
|
+
# `VIEWER` is specified, this API returns an endpoint that a client
|
863
|
+
# can use only to send offers to another `MASTER` client on this
|
864
|
+
# signaling channel.
|
865
|
+
# @return [String]
|
866
|
+
#
|
867
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/kinesisvideo-2017-09-30/SingleMasterChannelEndpointConfiguration AWS API Documentation
|
868
|
+
#
|
869
|
+
class SingleMasterChannelEndpointConfiguration < Struct.new(
|
870
|
+
:protocols,
|
871
|
+
:role)
|
872
|
+
include Aws::Structure
|
873
|
+
end
|
874
|
+
|
875
|
+
# A structure that contains the configuration for the `SINGLE_MASTER`
|
876
|
+
# channel type.
|
877
|
+
#
|
878
|
+
# @note When making an API call, you may pass SingleMasterConfiguration
|
879
|
+
# data as a hash:
|
880
|
+
#
|
881
|
+
# {
|
882
|
+
# message_ttl_seconds: 1,
|
883
|
+
# }
|
884
|
+
#
|
885
|
+
# @!attribute [rw] message_ttl_seconds
|
886
|
+
# The period of time a signaling channel retains underlivered messages
|
887
|
+
# before they are discarded.
|
888
|
+
# @return [Integer]
|
889
|
+
#
|
890
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/kinesisvideo-2017-09-30/SingleMasterConfiguration AWS API Documentation
|
891
|
+
#
|
892
|
+
class SingleMasterConfiguration < Struct.new(
|
893
|
+
:message_ttl_seconds)
|
894
|
+
include Aws::Structure
|
895
|
+
end
|
896
|
+
|
448
897
|
# An object describing a Kinesis video stream.
|
449
898
|
#
|
450
899
|
# @!attribute [rw] device_name
|
@@ -531,6 +980,69 @@ module Aws::KinesisVideo
|
|
531
980
|
include Aws::Structure
|
532
981
|
end
|
533
982
|
|
983
|
+
# A key and value pair that is associated with the specified signaling
|
984
|
+
# channel.
|
985
|
+
#
|
986
|
+
# @note When making an API call, you may pass Tag
|
987
|
+
# data as a hash:
|
988
|
+
#
|
989
|
+
# {
|
990
|
+
# key: "TagKey", # required
|
991
|
+
# value: "TagValue", # required
|
992
|
+
# }
|
993
|
+
#
|
994
|
+
# @!attribute [rw] key
|
995
|
+
# The key of the tag that is associated with the specified signaling
|
996
|
+
# channel.
|
997
|
+
# @return [String]
|
998
|
+
#
|
999
|
+
# @!attribute [rw] value
|
1000
|
+
# The value of the tag that is associated with the specified signaling
|
1001
|
+
# channel.
|
1002
|
+
# @return [String]
|
1003
|
+
#
|
1004
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/kinesisvideo-2017-09-30/Tag AWS API Documentation
|
1005
|
+
#
|
1006
|
+
class Tag < Struct.new(
|
1007
|
+
:key,
|
1008
|
+
:value)
|
1009
|
+
include Aws::Structure
|
1010
|
+
end
|
1011
|
+
|
1012
|
+
# @note When making an API call, you may pass TagResourceInput
|
1013
|
+
# data as a hash:
|
1014
|
+
#
|
1015
|
+
# {
|
1016
|
+
# resource_arn: "ResourceARN", # required
|
1017
|
+
# tags: [ # required
|
1018
|
+
# {
|
1019
|
+
# key: "TagKey", # required
|
1020
|
+
# value: "TagValue", # required
|
1021
|
+
# },
|
1022
|
+
# ],
|
1023
|
+
# }
|
1024
|
+
#
|
1025
|
+
# @!attribute [rw] resource_arn
|
1026
|
+
# The ARN of the signaling channel to which you want to add tags.
|
1027
|
+
# @return [String]
|
1028
|
+
#
|
1029
|
+
# @!attribute [rw] tags
|
1030
|
+
# A list of tags to associate with the specified signaling channel.
|
1031
|
+
# Each tag is a key-value pair.
|
1032
|
+
# @return [Array<Types::Tag>]
|
1033
|
+
#
|
1034
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/kinesisvideo-2017-09-30/TagResourceInput AWS API Documentation
|
1035
|
+
#
|
1036
|
+
class TagResourceInput < Struct.new(
|
1037
|
+
:resource_arn,
|
1038
|
+
:tags)
|
1039
|
+
include Aws::Structure
|
1040
|
+
end
|
1041
|
+
|
1042
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/kinesisvideo-2017-09-30/TagResourceOutput AWS API Documentation
|
1043
|
+
#
|
1044
|
+
class TagResourceOutput < Aws::EmptyStructure; end
|
1045
|
+
|
534
1046
|
# @note When making an API call, you may pass TagStreamInput
|
535
1047
|
# data as a hash:
|
536
1048
|
#
|
@@ -582,6 +1094,34 @@ module Aws::KinesisVideo
|
|
582
1094
|
include Aws::Structure
|
583
1095
|
end
|
584
1096
|
|
1097
|
+
# @note When making an API call, you may pass UntagResourceInput
|
1098
|
+
# data as a hash:
|
1099
|
+
#
|
1100
|
+
# {
|
1101
|
+
# resource_arn: "ResourceARN", # required
|
1102
|
+
# tag_key_list: ["TagKey"], # required
|
1103
|
+
# }
|
1104
|
+
#
|
1105
|
+
# @!attribute [rw] resource_arn
|
1106
|
+
# The ARN of the signaling channel from which you want to remove tags.
|
1107
|
+
# @return [String]
|
1108
|
+
#
|
1109
|
+
# @!attribute [rw] tag_key_list
|
1110
|
+
# A list of the keys of the tags that you want to remove.
|
1111
|
+
# @return [Array<String>]
|
1112
|
+
#
|
1113
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/kinesisvideo-2017-09-30/UntagResourceInput AWS API Documentation
|
1114
|
+
#
|
1115
|
+
class UntagResourceInput < Struct.new(
|
1116
|
+
:resource_arn,
|
1117
|
+
:tag_key_list)
|
1118
|
+
include Aws::Structure
|
1119
|
+
end
|
1120
|
+
|
1121
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/kinesisvideo-2017-09-30/UntagResourceOutput AWS API Documentation
|
1122
|
+
#
|
1123
|
+
class UntagResourceOutput < Aws::EmptyStructure; end
|
1124
|
+
|
585
1125
|
# @note When making an API call, you may pass UntagStreamInput
|
586
1126
|
# data as a hash:
|
587
1127
|
#
|
@@ -669,6 +1209,44 @@ module Aws::KinesisVideo
|
|
669
1209
|
#
|
670
1210
|
class UpdateDataRetentionOutput < Aws::EmptyStructure; end
|
671
1211
|
|
1212
|
+
# @note When making an API call, you may pass UpdateSignalingChannelInput
|
1213
|
+
# data as a hash:
|
1214
|
+
#
|
1215
|
+
# {
|
1216
|
+
# channel_arn: "ResourceARN", # required
|
1217
|
+
# current_version: "Version", # required
|
1218
|
+
# single_master_configuration: {
|
1219
|
+
# message_ttl_seconds: 1,
|
1220
|
+
# },
|
1221
|
+
# }
|
1222
|
+
#
|
1223
|
+
# @!attribute [rw] channel_arn
|
1224
|
+
# The ARN of the signaling channel that you want to update.
|
1225
|
+
# @return [String]
|
1226
|
+
#
|
1227
|
+
# @!attribute [rw] current_version
|
1228
|
+
# The current version of the signaling channel that you want to
|
1229
|
+
# update.
|
1230
|
+
# @return [String]
|
1231
|
+
#
|
1232
|
+
# @!attribute [rw] single_master_configuration
|
1233
|
+
# The structure containing the configuration for the `SINGLE_MASTER`
|
1234
|
+
# type of the signaling channel that you want to update.
|
1235
|
+
# @return [Types::SingleMasterConfiguration]
|
1236
|
+
#
|
1237
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/kinesisvideo-2017-09-30/UpdateSignalingChannelInput AWS API Documentation
|
1238
|
+
#
|
1239
|
+
class UpdateSignalingChannelInput < Struct.new(
|
1240
|
+
:channel_arn,
|
1241
|
+
:current_version,
|
1242
|
+
:single_master_configuration)
|
1243
|
+
include Aws::Structure
|
1244
|
+
end
|
1245
|
+
|
1246
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/kinesisvideo-2017-09-30/UpdateSignalingChannelOutput AWS API Documentation
|
1247
|
+
#
|
1248
|
+
class UpdateSignalingChannelOutput < Aws::EmptyStructure; end
|
1249
|
+
|
672
1250
|
# @note When making an API call, you may pass UpdateStreamInput
|
673
1251
|
# data as a hash:
|
674
1252
|
#
|