aws-sdk-kinesisvideo 1.20.0 → 1.25.0
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +5 -5
- data/lib/aws-sdk-kinesisvideo.rb +7 -4
- data/lib/aws-sdk-kinesisvideo/client.rb +457 -15
- data/lib/aws-sdk-kinesisvideo/client_api.rb +268 -0
- data/lib/aws-sdk-kinesisvideo/errors.rb +65 -11
- data/lib/aws-sdk-kinesisvideo/resource.rb +1 -0
- data/lib/aws-sdk-kinesisvideo/types.rb +587 -2
- metadata +3 -3
@@ -6,10 +6,75 @@
|
|
6
6
|
# WARNING ABOUT GENERATED CODE
|
7
7
|
|
8
8
|
module Aws::KinesisVideo
|
9
|
+
|
10
|
+
# When KinesisVideo returns an error response, the Ruby SDK constructs and raises an error.
|
11
|
+
# These errors all extend Aws::KinesisVideo::Errors::ServiceError < {Aws::Errors::ServiceError}
|
12
|
+
#
|
13
|
+
# You can rescue all KinesisVideo errors using ServiceError:
|
14
|
+
#
|
15
|
+
# begin
|
16
|
+
# # do stuff
|
17
|
+
# rescue Aws::KinesisVideo::Errors::ServiceError
|
18
|
+
# # rescues all KinesisVideo API errors
|
19
|
+
# end
|
20
|
+
#
|
21
|
+
#
|
22
|
+
# ## Request Context
|
23
|
+
# ServiceError objects have a {Aws::Errors::ServiceError#context #context} method that returns
|
24
|
+
# information about the request that generated the error.
|
25
|
+
# See {Seahorse::Client::RequestContext} for more information.
|
26
|
+
#
|
27
|
+
# ## Error Classes
|
28
|
+
# * {AccessDeniedException}
|
29
|
+
# * {AccountChannelLimitExceededException}
|
30
|
+
# * {AccountStreamLimitExceededException}
|
31
|
+
# * {ClientLimitExceededException}
|
32
|
+
# * {DeviceStreamLimitExceededException}
|
33
|
+
# * {InvalidArgumentException}
|
34
|
+
# * {InvalidDeviceException}
|
35
|
+
# * {InvalidResourceFormatException}
|
36
|
+
# * {NotAuthorizedException}
|
37
|
+
# * {ResourceInUseException}
|
38
|
+
# * {ResourceNotFoundException}
|
39
|
+
# * {TagsPerResourceExceededLimitException}
|
40
|
+
# * {VersionMismatchException}
|
41
|
+
#
|
42
|
+
# Additionally, error classes are dynamically generated for service errors based on the error code
|
43
|
+
# if they are not defined above.
|
9
44
|
module Errors
|
10
45
|
|
11
46
|
extend Aws::Errors::DynamicErrors
|
12
47
|
|
48
|
+
class AccessDeniedException < ServiceError
|
49
|
+
|
50
|
+
# @param [Seahorse::Client::RequestContext] context
|
51
|
+
# @param [String] message
|
52
|
+
# @param [Aws::KinesisVideo::Types::AccessDeniedException] data
|
53
|
+
def initialize(context, message, data = Aws::EmptyStructure.new)
|
54
|
+
super(context, message, data)
|
55
|
+
end
|
56
|
+
|
57
|
+
# @return [String]
|
58
|
+
def message
|
59
|
+
@message || @data[:message]
|
60
|
+
end
|
61
|
+
end
|
62
|
+
|
63
|
+
class AccountChannelLimitExceededException < ServiceError
|
64
|
+
|
65
|
+
# @param [Seahorse::Client::RequestContext] context
|
66
|
+
# @param [String] message
|
67
|
+
# @param [Aws::KinesisVideo::Types::AccountChannelLimitExceededException] data
|
68
|
+
def initialize(context, message, data = Aws::EmptyStructure.new)
|
69
|
+
super(context, message, data)
|
70
|
+
end
|
71
|
+
|
72
|
+
# @return [String]
|
73
|
+
def message
|
74
|
+
@message || @data[:message]
|
75
|
+
end
|
76
|
+
end
|
77
|
+
|
13
78
|
class AccountStreamLimitExceededException < ServiceError
|
14
79
|
|
15
80
|
# @param [Seahorse::Client::RequestContext] context
|
@@ -23,7 +88,6 @@ module Aws::KinesisVideo
|
|
23
88
|
def message
|
24
89
|
@message || @data[:message]
|
25
90
|
end
|
26
|
-
|
27
91
|
end
|
28
92
|
|
29
93
|
class ClientLimitExceededException < ServiceError
|
@@ -39,7 +103,6 @@ module Aws::KinesisVideo
|
|
39
103
|
def message
|
40
104
|
@message || @data[:message]
|
41
105
|
end
|
42
|
-
|
43
106
|
end
|
44
107
|
|
45
108
|
class DeviceStreamLimitExceededException < ServiceError
|
@@ -55,7 +118,6 @@ module Aws::KinesisVideo
|
|
55
118
|
def message
|
56
119
|
@message || @data[:message]
|
57
120
|
end
|
58
|
-
|
59
121
|
end
|
60
122
|
|
61
123
|
class InvalidArgumentException < ServiceError
|
@@ -71,7 +133,6 @@ module Aws::KinesisVideo
|
|
71
133
|
def message
|
72
134
|
@message || @data[:message]
|
73
135
|
end
|
74
|
-
|
75
136
|
end
|
76
137
|
|
77
138
|
class InvalidDeviceException < ServiceError
|
@@ -87,7 +148,6 @@ module Aws::KinesisVideo
|
|
87
148
|
def message
|
88
149
|
@message || @data[:message]
|
89
150
|
end
|
90
|
-
|
91
151
|
end
|
92
152
|
|
93
153
|
class InvalidResourceFormatException < ServiceError
|
@@ -103,7 +163,6 @@ module Aws::KinesisVideo
|
|
103
163
|
def message
|
104
164
|
@message || @data[:message]
|
105
165
|
end
|
106
|
-
|
107
166
|
end
|
108
167
|
|
109
168
|
class NotAuthorizedException < ServiceError
|
@@ -119,7 +178,6 @@ module Aws::KinesisVideo
|
|
119
178
|
def message
|
120
179
|
@message || @data[:message]
|
121
180
|
end
|
122
|
-
|
123
181
|
end
|
124
182
|
|
125
183
|
class ResourceInUseException < ServiceError
|
@@ -135,7 +193,6 @@ module Aws::KinesisVideo
|
|
135
193
|
def message
|
136
194
|
@message || @data[:message]
|
137
195
|
end
|
138
|
-
|
139
196
|
end
|
140
197
|
|
141
198
|
class ResourceNotFoundException < ServiceError
|
@@ -151,7 +208,6 @@ module Aws::KinesisVideo
|
|
151
208
|
def message
|
152
209
|
@message || @data[:message]
|
153
210
|
end
|
154
|
-
|
155
211
|
end
|
156
212
|
|
157
213
|
class TagsPerResourceExceededLimitException < ServiceError
|
@@ -167,7 +223,6 @@ module Aws::KinesisVideo
|
|
167
223
|
def message
|
168
224
|
@message || @data[:message]
|
169
225
|
end
|
170
|
-
|
171
226
|
end
|
172
227
|
|
173
228
|
class VersionMismatchException < ServiceError
|
@@ -183,7 +238,6 @@ module Aws::KinesisVideo
|
|
183
238
|
def message
|
184
239
|
@message || @data[:message]
|
185
240
|
end
|
186
|
-
|
187
241
|
end
|
188
242
|
|
189
243
|
end
|
@@ -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 Amazon Resource Name (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 AWS account and AWS 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 Amazon Resource Name (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,38 @@ 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 Amazon Resource Name (ARN) of the signaling channel that you
|
310
|
+
# want to delete.
|
311
|
+
# @return [String]
|
312
|
+
#
|
313
|
+
# @!attribute [rw] current_version
|
314
|
+
# The current version of the signaling channel that you want to
|
315
|
+
# delete. You can obtain the current version by invoking the
|
316
|
+
# `DescribeSignalingChannel` or `ListSignalingChannels` API
|
317
|
+
# operations.
|
318
|
+
# @return [String]
|
319
|
+
#
|
320
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/kinesisvideo-2017-09-30/DeleteSignalingChannelInput AWS API Documentation
|
321
|
+
#
|
322
|
+
class DeleteSignalingChannelInput < Struct.new(
|
323
|
+
:channel_arn,
|
324
|
+
:current_version)
|
325
|
+
include Aws::Structure
|
326
|
+
end
|
327
|
+
|
328
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/kinesisvideo-2017-09-30/DeleteSignalingChannelOutput AWS API Documentation
|
329
|
+
#
|
330
|
+
class DeleteSignalingChannelOutput < Aws::EmptyStructure; end
|
331
|
+
|
138
332
|
# @note When making an API call, you may pass DeleteStreamInput
|
139
333
|
# data as a hash:
|
140
334
|
#
|
@@ -171,6 +365,42 @@ module Aws::KinesisVideo
|
|
171
365
|
#
|
172
366
|
class DeleteStreamOutput < Aws::EmptyStructure; end
|
173
367
|
|
368
|
+
# @note When making an API call, you may pass DescribeSignalingChannelInput
|
369
|
+
# data as a hash:
|
370
|
+
#
|
371
|
+
# {
|
372
|
+
# channel_name: "ChannelName",
|
373
|
+
# channel_arn: "ResourceARN",
|
374
|
+
# }
|
375
|
+
#
|
376
|
+
# @!attribute [rw] channel_name
|
377
|
+
# The name of the signaling channel that you want to describe.
|
378
|
+
# @return [String]
|
379
|
+
#
|
380
|
+
# @!attribute [rw] channel_arn
|
381
|
+
# The ARN of the signaling channel that you want to describe.
|
382
|
+
# @return [String]
|
383
|
+
#
|
384
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/kinesisvideo-2017-09-30/DescribeSignalingChannelInput AWS API Documentation
|
385
|
+
#
|
386
|
+
class DescribeSignalingChannelInput < Struct.new(
|
387
|
+
:channel_name,
|
388
|
+
:channel_arn)
|
389
|
+
include Aws::Structure
|
390
|
+
end
|
391
|
+
|
392
|
+
# @!attribute [rw] channel_info
|
393
|
+
# A structure that encapsulates the specified signaling channel's
|
394
|
+
# metadata and properties.
|
395
|
+
# @return [Types::ChannelInfo]
|
396
|
+
#
|
397
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/kinesisvideo-2017-09-30/DescribeSignalingChannelOutput AWS API Documentation
|
398
|
+
#
|
399
|
+
class DescribeSignalingChannelOutput < Struct.new(
|
400
|
+
:channel_info)
|
401
|
+
include Aws::Structure
|
402
|
+
end
|
403
|
+
|
174
404
|
# @note When making an API call, you may pass DescribeStreamInput
|
175
405
|
# data as a hash:
|
176
406
|
#
|
@@ -224,7 +454,7 @@ module Aws::KinesisVideo
|
|
224
454
|
# {
|
225
455
|
# stream_name: "StreamName",
|
226
456
|
# stream_arn: "ResourceARN",
|
227
|
-
# 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
|
457
|
+
# 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
|
228
458
|
# }
|
229
459
|
#
|
230
460
|
# @!attribute [rw] stream_name
|
@@ -263,6 +493,46 @@ module Aws::KinesisVideo
|
|
263
493
|
include Aws::Structure
|
264
494
|
end
|
265
495
|
|
496
|
+
# @note When making an API call, you may pass GetSignalingChannelEndpointInput
|
497
|
+
# data as a hash:
|
498
|
+
#
|
499
|
+
# {
|
500
|
+
# channel_arn: "ResourceARN", # required
|
501
|
+
# single_master_channel_endpoint_configuration: {
|
502
|
+
# protocols: ["WSS"], # accepts WSS, HTTPS
|
503
|
+
# role: "MASTER", # accepts MASTER, VIEWER
|
504
|
+
# },
|
505
|
+
# }
|
506
|
+
#
|
507
|
+
# @!attribute [rw] channel_arn
|
508
|
+
# The Amazon Resource Name (ARN) of the signalling channel for which
|
509
|
+
# you want to get an endpoint.
|
510
|
+
# @return [String]
|
511
|
+
#
|
512
|
+
# @!attribute [rw] single_master_channel_endpoint_configuration
|
513
|
+
# A structure containing the endpoint configuration for the
|
514
|
+
# `SINGLE_MASTER` channel type.
|
515
|
+
# @return [Types::SingleMasterChannelEndpointConfiguration]
|
516
|
+
#
|
517
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/kinesisvideo-2017-09-30/GetSignalingChannelEndpointInput AWS API Documentation
|
518
|
+
#
|
519
|
+
class GetSignalingChannelEndpointInput < Struct.new(
|
520
|
+
:channel_arn,
|
521
|
+
:single_master_channel_endpoint_configuration)
|
522
|
+
include Aws::Structure
|
523
|
+
end
|
524
|
+
|
525
|
+
# @!attribute [rw] resource_endpoint_list
|
526
|
+
# A list of endpoints for the specified signaling channel.
|
527
|
+
# @return [Array<Types::ResourceEndpointListItem>]
|
528
|
+
#
|
529
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/kinesisvideo-2017-09-30/GetSignalingChannelEndpointOutput AWS API Documentation
|
530
|
+
#
|
531
|
+
class GetSignalingChannelEndpointOutput < Struct.new(
|
532
|
+
:resource_endpoint_list)
|
533
|
+
include Aws::Structure
|
534
|
+
end
|
535
|
+
|
266
536
|
# The value for this input parameter is invalid.
|
267
537
|
#
|
268
538
|
# @!attribute [rw] message
|
@@ -299,6 +569,62 @@ module Aws::KinesisVideo
|
|
299
569
|
include Aws::Structure
|
300
570
|
end
|
301
571
|
|
572
|
+
# @note When making an API call, you may pass ListSignalingChannelsInput
|
573
|
+
# data as a hash:
|
574
|
+
#
|
575
|
+
# {
|
576
|
+
# max_results: 1,
|
577
|
+
# next_token: "NextToken",
|
578
|
+
# channel_name_condition: {
|
579
|
+
# comparison_operator: "BEGINS_WITH", # accepts BEGINS_WITH
|
580
|
+
# comparison_value: "ChannelName",
|
581
|
+
# },
|
582
|
+
# }
|
583
|
+
#
|
584
|
+
# @!attribute [rw] max_results
|
585
|
+
# The maximum number of channels to return in the response. The
|
586
|
+
# default is 500.
|
587
|
+
# @return [Integer]
|
588
|
+
#
|
589
|
+
# @!attribute [rw] next_token
|
590
|
+
# If you specify this parameter, when the result of a
|
591
|
+
# `ListSignalingChannels` operation is truncated, the call returns the
|
592
|
+
# `NextToken` in the response. To get another batch of channels,
|
593
|
+
# provide this token in your next request.
|
594
|
+
# @return [String]
|
595
|
+
#
|
596
|
+
# @!attribute [rw] channel_name_condition
|
597
|
+
# Optional: Returns only the channels that satisfy a specific
|
598
|
+
# condition.
|
599
|
+
# @return [Types::ChannelNameCondition]
|
600
|
+
#
|
601
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/kinesisvideo-2017-09-30/ListSignalingChannelsInput AWS API Documentation
|
602
|
+
#
|
603
|
+
class ListSignalingChannelsInput < Struct.new(
|
604
|
+
:max_results,
|
605
|
+
:next_token,
|
606
|
+
:channel_name_condition)
|
607
|
+
include Aws::Structure
|
608
|
+
end
|
609
|
+
|
610
|
+
# @!attribute [rw] channel_info_list
|
611
|
+
# An array of `ChannelInfo` objects.
|
612
|
+
# @return [Array<Types::ChannelInfo>]
|
613
|
+
#
|
614
|
+
# @!attribute [rw] next_token
|
615
|
+
# If the response is truncated, the call returns this element with a
|
616
|
+
# token. To get the next batch of streams, use this token in your next
|
617
|
+
# request.
|
618
|
+
# @return [String]
|
619
|
+
#
|
620
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/kinesisvideo-2017-09-30/ListSignalingChannelsOutput AWS API Documentation
|
621
|
+
#
|
622
|
+
class ListSignalingChannelsOutput < Struct.new(
|
623
|
+
:channel_info_list,
|
624
|
+
:next_token)
|
625
|
+
include Aws::Structure
|
626
|
+
end
|
627
|
+
|
302
628
|
# @note When making an API call, you may pass ListStreamsInput
|
303
629
|
# data as a hash:
|
304
630
|
#
|
@@ -356,6 +682,54 @@ module Aws::KinesisVideo
|
|
356
682
|
include Aws::Structure
|
357
683
|
end
|
358
684
|
|
685
|
+
# @note When making an API call, you may pass ListTagsForResourceInput
|
686
|
+
# data as a hash:
|
687
|
+
#
|
688
|
+
# {
|
689
|
+
# next_token: "NextToken",
|
690
|
+
# resource_arn: "ResourceARN", # required
|
691
|
+
# }
|
692
|
+
#
|
693
|
+
# @!attribute [rw] next_token
|
694
|
+
# If you specify this parameter and the result of a
|
695
|
+
# `ListTagsForResource` call is truncated, the response includes a
|
696
|
+
# token that you can use in the next request to fetch the next batch
|
697
|
+
# of tags.
|
698
|
+
# @return [String]
|
699
|
+
#
|
700
|
+
# @!attribute [rw] resource_arn
|
701
|
+
# The Amazon Resource Name (ARN) of the signaling channel for which
|
702
|
+
# you want to list tags.
|
703
|
+
# @return [String]
|
704
|
+
#
|
705
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/kinesisvideo-2017-09-30/ListTagsForResourceInput AWS API Documentation
|
706
|
+
#
|
707
|
+
class ListTagsForResourceInput < Struct.new(
|
708
|
+
:next_token,
|
709
|
+
:resource_arn)
|
710
|
+
include Aws::Structure
|
711
|
+
end
|
712
|
+
|
713
|
+
# @!attribute [rw] next_token
|
714
|
+
# If you specify this parameter and the result of a
|
715
|
+
# `ListTagsForResource` call is truncated, the response includes a
|
716
|
+
# token that you can use in the next request to fetch the next set of
|
717
|
+
# tags.
|
718
|
+
# @return [String]
|
719
|
+
#
|
720
|
+
# @!attribute [rw] tags
|
721
|
+
# A map of tag keys and values associated with the specified signaling
|
722
|
+
# channel.
|
723
|
+
# @return [Hash<String,String>]
|
724
|
+
#
|
725
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/kinesisvideo-2017-09-30/ListTagsForResourceOutput AWS API Documentation
|
726
|
+
#
|
727
|
+
class ListTagsForResourceOutput < Struct.new(
|
728
|
+
:next_token,
|
729
|
+
:tags)
|
730
|
+
include Aws::Structure
|
731
|
+
end
|
732
|
+
|
359
733
|
# @note When making an API call, you may pass ListTagsForStreamInput
|
360
734
|
# data as a hash:
|
361
735
|
#
|
@@ -420,7 +794,28 @@ module Aws::KinesisVideo
|
|
420
794
|
include Aws::Structure
|
421
795
|
end
|
422
796
|
|
423
|
-
#
|
797
|
+
# An object that describes the endpoint of the signaling channel
|
798
|
+
# returned by the `GetSignalingChannelEndpoint` API.
|
799
|
+
#
|
800
|
+
# @!attribute [rw] protocol
|
801
|
+
# The protocol of the signaling channel returned by the
|
802
|
+
# `GetSignalingChannelEndpoint` API.
|
803
|
+
# @return [String]
|
804
|
+
#
|
805
|
+
# @!attribute [rw] resource_endpoint
|
806
|
+
# The endpoint of the signaling channel returned by the
|
807
|
+
# `GetSignalingChannelEndpoint` API.
|
808
|
+
# @return [String]
|
809
|
+
#
|
810
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/kinesisvideo-2017-09-30/ResourceEndpointListItem AWS API Documentation
|
811
|
+
#
|
812
|
+
class ResourceEndpointListItem < Struct.new(
|
813
|
+
:protocol,
|
814
|
+
:resource_endpoint)
|
815
|
+
include Aws::Structure
|
816
|
+
end
|
817
|
+
|
818
|
+
# The signaling channel is currently not available for this operation.
|
424
819
|
#
|
425
820
|
# @!attribute [rw] message
|
426
821
|
# @return [String]
|
@@ -445,6 +840,64 @@ module Aws::KinesisVideo
|
|
445
840
|
include Aws::Structure
|
446
841
|
end
|
447
842
|
|
843
|
+
# An object that contains the endpoint configuration for the
|
844
|
+
# `SINGLE_MASTER` channel type.
|
845
|
+
#
|
846
|
+
# @note When making an API call, you may pass SingleMasterChannelEndpointConfiguration
|
847
|
+
# data as a hash:
|
848
|
+
#
|
849
|
+
# {
|
850
|
+
# protocols: ["WSS"], # accepts WSS, HTTPS
|
851
|
+
# role: "MASTER", # accepts MASTER, VIEWER
|
852
|
+
# }
|
853
|
+
#
|
854
|
+
# @!attribute [rw] protocols
|
855
|
+
# This property is used to determine the nature of communication over
|
856
|
+
# this `SINGLE_MASTER` signaling channel. If `WSS` is specified, this
|
857
|
+
# API returns a websocket endpoint. If `HTTPS` is specified, this API
|
858
|
+
# returns an `HTTPS` endpoint.
|
859
|
+
# @return [Array<String>]
|
860
|
+
#
|
861
|
+
# @!attribute [rw] role
|
862
|
+
# This property is used to determine messaging permissions in this
|
863
|
+
# `SINGLE_MASTER` signaling channel. If `MASTER` is specified, this
|
864
|
+
# API returns an endpoint that a client can use to receive offers from
|
865
|
+
# and send answers to any of the viewers on this signaling channel. If
|
866
|
+
# `VIEWER` is specified, this API returns an endpoint that a client
|
867
|
+
# can use only to send offers to another `MASTER` client on this
|
868
|
+
# signaling channel.
|
869
|
+
# @return [String]
|
870
|
+
#
|
871
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/kinesisvideo-2017-09-30/SingleMasterChannelEndpointConfiguration AWS API Documentation
|
872
|
+
#
|
873
|
+
class SingleMasterChannelEndpointConfiguration < Struct.new(
|
874
|
+
:protocols,
|
875
|
+
:role)
|
876
|
+
include Aws::Structure
|
877
|
+
end
|
878
|
+
|
879
|
+
# A structure that contains the configuration for the `SINGLE_MASTER`
|
880
|
+
# channel type.
|
881
|
+
#
|
882
|
+
# @note When making an API call, you may pass SingleMasterConfiguration
|
883
|
+
# data as a hash:
|
884
|
+
#
|
885
|
+
# {
|
886
|
+
# message_ttl_seconds: 1,
|
887
|
+
# }
|
888
|
+
#
|
889
|
+
# @!attribute [rw] message_ttl_seconds
|
890
|
+
# The period of time a signaling channel retains underlivered messages
|
891
|
+
# before they are discarded.
|
892
|
+
# @return [Integer]
|
893
|
+
#
|
894
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/kinesisvideo-2017-09-30/SingleMasterConfiguration AWS API Documentation
|
895
|
+
#
|
896
|
+
class SingleMasterConfiguration < Struct.new(
|
897
|
+
:message_ttl_seconds)
|
898
|
+
include Aws::Structure
|
899
|
+
end
|
900
|
+
|
448
901
|
# An object describing a Kinesis video stream.
|
449
902
|
#
|
450
903
|
# @!attribute [rw] device_name
|
@@ -531,6 +984,70 @@ module Aws::KinesisVideo
|
|
531
984
|
include Aws::Structure
|
532
985
|
end
|
533
986
|
|
987
|
+
# A key and value pair that is associated with the specified signaling
|
988
|
+
# channel.
|
989
|
+
#
|
990
|
+
# @note When making an API call, you may pass Tag
|
991
|
+
# data as a hash:
|
992
|
+
#
|
993
|
+
# {
|
994
|
+
# key: "TagKey", # required
|
995
|
+
# value: "TagValue", # required
|
996
|
+
# }
|
997
|
+
#
|
998
|
+
# @!attribute [rw] key
|
999
|
+
# The key of the tag that is associated with the specified signaling
|
1000
|
+
# channel.
|
1001
|
+
# @return [String]
|
1002
|
+
#
|
1003
|
+
# @!attribute [rw] value
|
1004
|
+
# The value of the tag that is associated with the specified signaling
|
1005
|
+
# channel.
|
1006
|
+
# @return [String]
|
1007
|
+
#
|
1008
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/kinesisvideo-2017-09-30/Tag AWS API Documentation
|
1009
|
+
#
|
1010
|
+
class Tag < Struct.new(
|
1011
|
+
:key,
|
1012
|
+
:value)
|
1013
|
+
include Aws::Structure
|
1014
|
+
end
|
1015
|
+
|
1016
|
+
# @note When making an API call, you may pass TagResourceInput
|
1017
|
+
# data as a hash:
|
1018
|
+
#
|
1019
|
+
# {
|
1020
|
+
# resource_arn: "ResourceARN", # required
|
1021
|
+
# tags: [ # required
|
1022
|
+
# {
|
1023
|
+
# key: "TagKey", # required
|
1024
|
+
# value: "TagValue", # required
|
1025
|
+
# },
|
1026
|
+
# ],
|
1027
|
+
# }
|
1028
|
+
#
|
1029
|
+
# @!attribute [rw] resource_arn
|
1030
|
+
# The Amazon Resource Name (ARN) of the signaling channel to which you
|
1031
|
+
# want to add tags.
|
1032
|
+
# @return [String]
|
1033
|
+
#
|
1034
|
+
# @!attribute [rw] tags
|
1035
|
+
# A list of tags to associate with the specified signaling channel.
|
1036
|
+
# Each tag is a key-value pair.
|
1037
|
+
# @return [Array<Types::Tag>]
|
1038
|
+
#
|
1039
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/kinesisvideo-2017-09-30/TagResourceInput AWS API Documentation
|
1040
|
+
#
|
1041
|
+
class TagResourceInput < Struct.new(
|
1042
|
+
:resource_arn,
|
1043
|
+
:tags)
|
1044
|
+
include Aws::Structure
|
1045
|
+
end
|
1046
|
+
|
1047
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/kinesisvideo-2017-09-30/TagResourceOutput AWS API Documentation
|
1048
|
+
#
|
1049
|
+
class TagResourceOutput < Aws::EmptyStructure; end
|
1050
|
+
|
534
1051
|
# @note When making an API call, you may pass TagStreamInput
|
535
1052
|
# data as a hash:
|
536
1053
|
#
|
@@ -582,6 +1099,35 @@ module Aws::KinesisVideo
|
|
582
1099
|
include Aws::Structure
|
583
1100
|
end
|
584
1101
|
|
1102
|
+
# @note When making an API call, you may pass UntagResourceInput
|
1103
|
+
# data as a hash:
|
1104
|
+
#
|
1105
|
+
# {
|
1106
|
+
# resource_arn: "ResourceARN", # required
|
1107
|
+
# tag_key_list: ["TagKey"], # required
|
1108
|
+
# }
|
1109
|
+
#
|
1110
|
+
# @!attribute [rw] resource_arn
|
1111
|
+
# The Amazon Resource Name (ARN) of the signaling channel from which
|
1112
|
+
# you want to remove tags.
|
1113
|
+
# @return [String]
|
1114
|
+
#
|
1115
|
+
# @!attribute [rw] tag_key_list
|
1116
|
+
# A list of the keys of the tags that you want to remove.
|
1117
|
+
# @return [Array<String>]
|
1118
|
+
#
|
1119
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/kinesisvideo-2017-09-30/UntagResourceInput AWS API Documentation
|
1120
|
+
#
|
1121
|
+
class UntagResourceInput < Struct.new(
|
1122
|
+
:resource_arn,
|
1123
|
+
:tag_key_list)
|
1124
|
+
include Aws::Structure
|
1125
|
+
end
|
1126
|
+
|
1127
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/kinesisvideo-2017-09-30/UntagResourceOutput AWS API Documentation
|
1128
|
+
#
|
1129
|
+
class UntagResourceOutput < Aws::EmptyStructure; end
|
1130
|
+
|
585
1131
|
# @note When making an API call, you may pass UntagStreamInput
|
586
1132
|
# data as a hash:
|
587
1133
|
#
|
@@ -669,6 +1215,45 @@ module Aws::KinesisVideo
|
|
669
1215
|
#
|
670
1216
|
class UpdateDataRetentionOutput < Aws::EmptyStructure; end
|
671
1217
|
|
1218
|
+
# @note When making an API call, you may pass UpdateSignalingChannelInput
|
1219
|
+
# data as a hash:
|
1220
|
+
#
|
1221
|
+
# {
|
1222
|
+
# channel_arn: "ResourceARN", # required
|
1223
|
+
# current_version: "Version", # required
|
1224
|
+
# single_master_configuration: {
|
1225
|
+
# message_ttl_seconds: 1,
|
1226
|
+
# },
|
1227
|
+
# }
|
1228
|
+
#
|
1229
|
+
# @!attribute [rw] channel_arn
|
1230
|
+
# The Amazon Resource Name (ARN) of the signaling channel that you
|
1231
|
+
# want to update.
|
1232
|
+
# @return [String]
|
1233
|
+
#
|
1234
|
+
# @!attribute [rw] current_version
|
1235
|
+
# The current version of the signaling channel that you want to
|
1236
|
+
# update.
|
1237
|
+
# @return [String]
|
1238
|
+
#
|
1239
|
+
# @!attribute [rw] single_master_configuration
|
1240
|
+
# The structure containing the configuration for the `SINGLE_MASTER`
|
1241
|
+
# type of the signaling channel that you want to update.
|
1242
|
+
# @return [Types::SingleMasterConfiguration]
|
1243
|
+
#
|
1244
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/kinesisvideo-2017-09-30/UpdateSignalingChannelInput AWS API Documentation
|
1245
|
+
#
|
1246
|
+
class UpdateSignalingChannelInput < Struct.new(
|
1247
|
+
:channel_arn,
|
1248
|
+
:current_version,
|
1249
|
+
:single_master_configuration)
|
1250
|
+
include Aws::Structure
|
1251
|
+
end
|
1252
|
+
|
1253
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/kinesisvideo-2017-09-30/UpdateSignalingChannelOutput AWS API Documentation
|
1254
|
+
#
|
1255
|
+
class UpdateSignalingChannelOutput < Aws::EmptyStructure; end
|
1256
|
+
|
672
1257
|
# @note When making an API call, you may pass UpdateStreamInput
|
673
1258
|
# data as a hash:
|
674
1259
|
#
|