aws-sdk-ivs 1.0.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 +7 -0
- data/lib/aws-sdk-ivs.rb +52 -0
- data/lib/aws-sdk-ivs/client.rb +1025 -0
- data/lib/aws-sdk-ivs/client_api.rb +555 -0
- data/lib/aws-sdk-ivs/customizations.rb +0 -0
- data/lib/aws-sdk-ivs/errors.rb +182 -0
- data/lib/aws-sdk-ivs/resource.rb +26 -0
- data/lib/aws-sdk-ivs/types.rb +1010 -0
- metadata +88 -0
File without changes
|
@@ -0,0 +1,182 @@
|
|
1
|
+
# frozen_string_literal: true
|
2
|
+
|
3
|
+
# WARNING ABOUT GENERATED CODE
|
4
|
+
#
|
5
|
+
# This file is generated. See the contributing guide for more information:
|
6
|
+
# https://github.com/aws/aws-sdk-ruby/blob/master/CONTRIBUTING.md
|
7
|
+
#
|
8
|
+
# WARNING ABOUT GENERATED CODE
|
9
|
+
|
10
|
+
module Aws::IVS
|
11
|
+
|
12
|
+
# When IVS returns an error response, the Ruby SDK constructs and raises an error.
|
13
|
+
# These errors all extend Aws::IVS::Errors::ServiceError < {Aws::Errors::ServiceError}
|
14
|
+
#
|
15
|
+
# You can rescue all IVS errors using ServiceError:
|
16
|
+
#
|
17
|
+
# begin
|
18
|
+
# # do stuff
|
19
|
+
# rescue Aws::IVS::Errors::ServiceError
|
20
|
+
# # rescues all IVS API errors
|
21
|
+
# end
|
22
|
+
#
|
23
|
+
#
|
24
|
+
# ## Request Context
|
25
|
+
# ServiceError objects have a {Aws::Errors::ServiceError#context #context} method that returns
|
26
|
+
# information about the request that generated the error.
|
27
|
+
# See {Seahorse::Client::RequestContext} for more information.
|
28
|
+
#
|
29
|
+
# ## Error Classes
|
30
|
+
# * {AccessDeniedException}
|
31
|
+
# * {ChannelNotBroadcasting}
|
32
|
+
# * {ConflictException}
|
33
|
+
# * {InternalServerException}
|
34
|
+
# * {ResourceNotFoundException}
|
35
|
+
# * {ServiceQuotaExceededException}
|
36
|
+
# * {StreamUnavailable}
|
37
|
+
# * {ThrottlingException}
|
38
|
+
# * {ValidationException}
|
39
|
+
#
|
40
|
+
# Additionally, error classes are dynamically generated for service errors based on the error code
|
41
|
+
# if they are not defined above.
|
42
|
+
module Errors
|
43
|
+
|
44
|
+
extend Aws::Errors::DynamicErrors
|
45
|
+
|
46
|
+
class AccessDeniedException < ServiceError
|
47
|
+
|
48
|
+
# @param [Seahorse::Client::RequestContext] context
|
49
|
+
# @param [String] message
|
50
|
+
# @param [Aws::IVS::Types::AccessDeniedException] data
|
51
|
+
def initialize(context, message, data = Aws::EmptyStructure.new)
|
52
|
+
super(context, message, data)
|
53
|
+
end
|
54
|
+
|
55
|
+
# @return [String]
|
56
|
+
def exception_message
|
57
|
+
@data[:exception_message]
|
58
|
+
end
|
59
|
+
end
|
60
|
+
|
61
|
+
class ChannelNotBroadcasting < ServiceError
|
62
|
+
|
63
|
+
# @param [Seahorse::Client::RequestContext] context
|
64
|
+
# @param [String] message
|
65
|
+
# @param [Aws::IVS::Types::ChannelNotBroadcasting] data
|
66
|
+
def initialize(context, message, data = Aws::EmptyStructure.new)
|
67
|
+
super(context, message, data)
|
68
|
+
end
|
69
|
+
|
70
|
+
# @return [String]
|
71
|
+
def exception_message
|
72
|
+
@data[:exception_message]
|
73
|
+
end
|
74
|
+
end
|
75
|
+
|
76
|
+
class ConflictException < ServiceError
|
77
|
+
|
78
|
+
# @param [Seahorse::Client::RequestContext] context
|
79
|
+
# @param [String] message
|
80
|
+
# @param [Aws::IVS::Types::ConflictException] data
|
81
|
+
def initialize(context, message, data = Aws::EmptyStructure.new)
|
82
|
+
super(context, message, data)
|
83
|
+
end
|
84
|
+
|
85
|
+
# @return [String]
|
86
|
+
def exception_message
|
87
|
+
@data[:exception_message]
|
88
|
+
end
|
89
|
+
end
|
90
|
+
|
91
|
+
class InternalServerException < ServiceError
|
92
|
+
|
93
|
+
# @param [Seahorse::Client::RequestContext] context
|
94
|
+
# @param [String] message
|
95
|
+
# @param [Aws::IVS::Types::InternalServerException] data
|
96
|
+
def initialize(context, message, data = Aws::EmptyStructure.new)
|
97
|
+
super(context, message, data)
|
98
|
+
end
|
99
|
+
|
100
|
+
# @return [String]
|
101
|
+
def exception_message
|
102
|
+
@data[:exception_message]
|
103
|
+
end
|
104
|
+
end
|
105
|
+
|
106
|
+
class ResourceNotFoundException < ServiceError
|
107
|
+
|
108
|
+
# @param [Seahorse::Client::RequestContext] context
|
109
|
+
# @param [String] message
|
110
|
+
# @param [Aws::IVS::Types::ResourceNotFoundException] data
|
111
|
+
def initialize(context, message, data = Aws::EmptyStructure.new)
|
112
|
+
super(context, message, data)
|
113
|
+
end
|
114
|
+
|
115
|
+
# @return [String]
|
116
|
+
def exception_message
|
117
|
+
@data[:exception_message]
|
118
|
+
end
|
119
|
+
end
|
120
|
+
|
121
|
+
class ServiceQuotaExceededException < ServiceError
|
122
|
+
|
123
|
+
# @param [Seahorse::Client::RequestContext] context
|
124
|
+
# @param [String] message
|
125
|
+
# @param [Aws::IVS::Types::ServiceQuotaExceededException] data
|
126
|
+
def initialize(context, message, data = Aws::EmptyStructure.new)
|
127
|
+
super(context, message, data)
|
128
|
+
end
|
129
|
+
|
130
|
+
# @return [String]
|
131
|
+
def exception_message
|
132
|
+
@data[:exception_message]
|
133
|
+
end
|
134
|
+
end
|
135
|
+
|
136
|
+
class StreamUnavailable < ServiceError
|
137
|
+
|
138
|
+
# @param [Seahorse::Client::RequestContext] context
|
139
|
+
# @param [String] message
|
140
|
+
# @param [Aws::IVS::Types::StreamUnavailable] data
|
141
|
+
def initialize(context, message, data = Aws::EmptyStructure.new)
|
142
|
+
super(context, message, data)
|
143
|
+
end
|
144
|
+
|
145
|
+
# @return [String]
|
146
|
+
def exception_message
|
147
|
+
@data[:exception_message]
|
148
|
+
end
|
149
|
+
end
|
150
|
+
|
151
|
+
class ThrottlingException < ServiceError
|
152
|
+
|
153
|
+
# @param [Seahorse::Client::RequestContext] context
|
154
|
+
# @param [String] message
|
155
|
+
# @param [Aws::IVS::Types::ThrottlingException] data
|
156
|
+
def initialize(context, message, data = Aws::EmptyStructure.new)
|
157
|
+
super(context, message, data)
|
158
|
+
end
|
159
|
+
|
160
|
+
# @return [String]
|
161
|
+
def exception_message
|
162
|
+
@data[:exception_message]
|
163
|
+
end
|
164
|
+
end
|
165
|
+
|
166
|
+
class ValidationException < ServiceError
|
167
|
+
|
168
|
+
# @param [Seahorse::Client::RequestContext] context
|
169
|
+
# @param [String] message
|
170
|
+
# @param [Aws::IVS::Types::ValidationException] data
|
171
|
+
def initialize(context, message, data = Aws::EmptyStructure.new)
|
172
|
+
super(context, message, data)
|
173
|
+
end
|
174
|
+
|
175
|
+
# @return [String]
|
176
|
+
def exception_message
|
177
|
+
@data[:exception_message]
|
178
|
+
end
|
179
|
+
end
|
180
|
+
|
181
|
+
end
|
182
|
+
end
|
@@ -0,0 +1,26 @@
|
|
1
|
+
# frozen_string_literal: true
|
2
|
+
|
3
|
+
# WARNING ABOUT GENERATED CODE
|
4
|
+
#
|
5
|
+
# This file is generated. See the contributing guide for more information:
|
6
|
+
# https://github.com/aws/aws-sdk-ruby/blob/master/CONTRIBUTING.md
|
7
|
+
#
|
8
|
+
# WARNING ABOUT GENERATED CODE
|
9
|
+
|
10
|
+
module Aws::IVS
|
11
|
+
|
12
|
+
class Resource
|
13
|
+
|
14
|
+
# @param options ({})
|
15
|
+
# @option options [Client] :client
|
16
|
+
def initialize(options = {})
|
17
|
+
@client = options[:client] || Client.new(options)
|
18
|
+
end
|
19
|
+
|
20
|
+
# @return [Client]
|
21
|
+
def client
|
22
|
+
@client
|
23
|
+
end
|
24
|
+
|
25
|
+
end
|
26
|
+
end
|
@@ -0,0 +1,1010 @@
|
|
1
|
+
# frozen_string_literal: true
|
2
|
+
|
3
|
+
# WARNING ABOUT GENERATED CODE
|
4
|
+
#
|
5
|
+
# This file is generated. See the contributing guide for more information:
|
6
|
+
# https://github.com/aws/aws-sdk-ruby/blob/master/CONTRIBUTING.md
|
7
|
+
#
|
8
|
+
# WARNING ABOUT GENERATED CODE
|
9
|
+
|
10
|
+
module Aws::IVS
|
11
|
+
module Types
|
12
|
+
|
13
|
+
# @!attribute [rw] exception_message
|
14
|
+
# User does not have sufficient access to perform this action.
|
15
|
+
# @return [String]
|
16
|
+
#
|
17
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/ivs-2020-07-14/AccessDeniedException AWS API Documentation
|
18
|
+
#
|
19
|
+
class AccessDeniedException < Struct.new(
|
20
|
+
:exception_message)
|
21
|
+
SENSITIVE = []
|
22
|
+
include Aws::Structure
|
23
|
+
end
|
24
|
+
|
25
|
+
# Error related to a specific channel, specified by its ARN.
|
26
|
+
#
|
27
|
+
# @!attribute [rw] arn
|
28
|
+
# Channel ARN.
|
29
|
+
# @return [String]
|
30
|
+
#
|
31
|
+
# @!attribute [rw] code
|
32
|
+
# Error code.
|
33
|
+
# @return [String]
|
34
|
+
#
|
35
|
+
# @!attribute [rw] message
|
36
|
+
# Error message, determined by the application.
|
37
|
+
# @return [String]
|
38
|
+
#
|
39
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/ivs-2020-07-14/BatchError AWS API Documentation
|
40
|
+
#
|
41
|
+
class BatchError < Struct.new(
|
42
|
+
:arn,
|
43
|
+
:code,
|
44
|
+
:message)
|
45
|
+
SENSITIVE = []
|
46
|
+
include Aws::Structure
|
47
|
+
end
|
48
|
+
|
49
|
+
# @note When making an API call, you may pass BatchGetChannelRequest
|
50
|
+
# data as a hash:
|
51
|
+
#
|
52
|
+
# {
|
53
|
+
# arns: ["ChannelArn"], # required
|
54
|
+
# }
|
55
|
+
#
|
56
|
+
# @!attribute [rw] arns
|
57
|
+
# Array of ARNs, one per channel.
|
58
|
+
# @return [Array<String>]
|
59
|
+
#
|
60
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/ivs-2020-07-14/BatchGetChannelRequest AWS API Documentation
|
61
|
+
#
|
62
|
+
class BatchGetChannelRequest < Struct.new(
|
63
|
+
:arns)
|
64
|
+
SENSITIVE = []
|
65
|
+
include Aws::Structure
|
66
|
+
end
|
67
|
+
|
68
|
+
# @!attribute [rw] channels
|
69
|
+
# @return [Array<Types::Channel>]
|
70
|
+
#
|
71
|
+
# @!attribute [rw] errors
|
72
|
+
# Each error object is related to a specific ARN in the request.
|
73
|
+
# @return [Array<Types::BatchError>]
|
74
|
+
#
|
75
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/ivs-2020-07-14/BatchGetChannelResponse AWS API Documentation
|
76
|
+
#
|
77
|
+
class BatchGetChannelResponse < Struct.new(
|
78
|
+
:channels,
|
79
|
+
:errors)
|
80
|
+
SENSITIVE = []
|
81
|
+
include Aws::Structure
|
82
|
+
end
|
83
|
+
|
84
|
+
# @note When making an API call, you may pass BatchGetStreamKeyRequest
|
85
|
+
# data as a hash:
|
86
|
+
#
|
87
|
+
# {
|
88
|
+
# arns: ["StreamKeyArn"], # required
|
89
|
+
# }
|
90
|
+
#
|
91
|
+
# @!attribute [rw] arns
|
92
|
+
# Array of ARNs, one per channel.
|
93
|
+
# @return [Array<String>]
|
94
|
+
#
|
95
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/ivs-2020-07-14/BatchGetStreamKeyRequest AWS API Documentation
|
96
|
+
#
|
97
|
+
class BatchGetStreamKeyRequest < Struct.new(
|
98
|
+
:arns)
|
99
|
+
SENSITIVE = []
|
100
|
+
include Aws::Structure
|
101
|
+
end
|
102
|
+
|
103
|
+
# @!attribute [rw] stream_keys
|
104
|
+
# @return [Array<Types::StreamKey>]
|
105
|
+
#
|
106
|
+
# @!attribute [rw] errors
|
107
|
+
# @return [Array<Types::BatchError>]
|
108
|
+
#
|
109
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/ivs-2020-07-14/BatchGetStreamKeyResponse AWS API Documentation
|
110
|
+
#
|
111
|
+
class BatchGetStreamKeyResponse < Struct.new(
|
112
|
+
:stream_keys,
|
113
|
+
:errors)
|
114
|
+
SENSITIVE = []
|
115
|
+
include Aws::Structure
|
116
|
+
end
|
117
|
+
|
118
|
+
# Object specifying a channel.
|
119
|
+
#
|
120
|
+
# @!attribute [rw] arn
|
121
|
+
# Channel ARN.
|
122
|
+
# @return [String]
|
123
|
+
#
|
124
|
+
# @!attribute [rw] name
|
125
|
+
# Channel name.
|
126
|
+
# @return [String]
|
127
|
+
#
|
128
|
+
# @!attribute [rw] latency_mode
|
129
|
+
# Channel latency mode. Default: `LOW`.
|
130
|
+
# @return [String]
|
131
|
+
#
|
132
|
+
# @!attribute [rw] type
|
133
|
+
# Channel type, which determines the allowable resolution and bitrate.
|
134
|
+
# STANDARD: The stream is transcoded; resolution (width, in landscape
|
135
|
+
# orientation) can be up to 1080p or the input source resolution,
|
136
|
+
# whichever is lower; and bitrate can be up to 8.5 Mbps. BASIC: The
|
137
|
+
# stream is transfixed; resolution can be up to 480p; and bitrate can
|
138
|
+
# be up to 1.5 Mbps. Default STANDARD.
|
139
|
+
# @return [String]
|
140
|
+
#
|
141
|
+
# @!attribute [rw] ingest_endpoint
|
142
|
+
# Channel ingest endpoint, part of the definition of an ingest server,
|
143
|
+
# used when you set up streaming software.
|
144
|
+
# @return [String]
|
145
|
+
#
|
146
|
+
# @!attribute [rw] playback_url
|
147
|
+
# Channel playback URL.
|
148
|
+
# @return [String]
|
149
|
+
#
|
150
|
+
# @!attribute [rw] tags
|
151
|
+
# Array of 1-50 maps, each of the form `string:string (key:value)`.
|
152
|
+
# @return [Hash<String,String>]
|
153
|
+
#
|
154
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/ivs-2020-07-14/Channel AWS API Documentation
|
155
|
+
#
|
156
|
+
class Channel < Struct.new(
|
157
|
+
:arn,
|
158
|
+
:name,
|
159
|
+
:latency_mode,
|
160
|
+
:type,
|
161
|
+
:ingest_endpoint,
|
162
|
+
:playback_url,
|
163
|
+
:tags)
|
164
|
+
SENSITIVE = []
|
165
|
+
include Aws::Structure
|
166
|
+
end
|
167
|
+
|
168
|
+
# @!attribute [rw] exception_message
|
169
|
+
# The stream is offline for the given channel ARN.
|
170
|
+
# @return [String]
|
171
|
+
#
|
172
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/ivs-2020-07-14/ChannelNotBroadcasting AWS API Documentation
|
173
|
+
#
|
174
|
+
class ChannelNotBroadcasting < Struct.new(
|
175
|
+
:exception_message)
|
176
|
+
SENSITIVE = []
|
177
|
+
include Aws::Structure
|
178
|
+
end
|
179
|
+
|
180
|
+
# Summary information about a channel.
|
181
|
+
#
|
182
|
+
# @!attribute [rw] arn
|
183
|
+
# Channel ARN.
|
184
|
+
# @return [String]
|
185
|
+
#
|
186
|
+
# @!attribute [rw] name
|
187
|
+
# Channel name.
|
188
|
+
# @return [String]
|
189
|
+
#
|
190
|
+
# @!attribute [rw] latency_mode
|
191
|
+
# Channel latency mode. Default: `LOW`.
|
192
|
+
# @return [String]
|
193
|
+
#
|
194
|
+
# @!attribute [rw] tags
|
195
|
+
# Array of 1-50 maps, each of the form `string:string (key:value)`.
|
196
|
+
# @return [Hash<String,String>]
|
197
|
+
#
|
198
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/ivs-2020-07-14/ChannelSummary AWS API Documentation
|
199
|
+
#
|
200
|
+
class ChannelSummary < Struct.new(
|
201
|
+
:arn,
|
202
|
+
:name,
|
203
|
+
:latency_mode,
|
204
|
+
:tags)
|
205
|
+
SENSITIVE = []
|
206
|
+
include Aws::Structure
|
207
|
+
end
|
208
|
+
|
209
|
+
# @!attribute [rw] exception_message
|
210
|
+
# Updating or deleting a resource can cause an inconsistent state.
|
211
|
+
# @return [String]
|
212
|
+
#
|
213
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/ivs-2020-07-14/ConflictException AWS API Documentation
|
214
|
+
#
|
215
|
+
class ConflictException < Struct.new(
|
216
|
+
:exception_message)
|
217
|
+
SENSITIVE = []
|
218
|
+
include Aws::Structure
|
219
|
+
end
|
220
|
+
|
221
|
+
# @note When making an API call, you may pass CreateChannelRequest
|
222
|
+
# data as a hash:
|
223
|
+
#
|
224
|
+
# {
|
225
|
+
# name: "ChannelName",
|
226
|
+
# latency_mode: "NORMAL", # accepts NORMAL, LOW
|
227
|
+
# type: "BASIC", # accepts BASIC, STANDARD
|
228
|
+
# tags: {
|
229
|
+
# "TagKey" => "TagValue",
|
230
|
+
# },
|
231
|
+
# }
|
232
|
+
#
|
233
|
+
# @!attribute [rw] name
|
234
|
+
# Channel name.
|
235
|
+
# @return [String]
|
236
|
+
#
|
237
|
+
# @!attribute [rw] latency_mode
|
238
|
+
# Channel latency mode. Default: `LOW`.
|
239
|
+
# @return [String]
|
240
|
+
#
|
241
|
+
# @!attribute [rw] type
|
242
|
+
# Channel type, which determines the allowable resolution and bitrate.
|
243
|
+
# `STANDARD`\: The stream is transcoded; resolution (width, in
|
244
|
+
# landscape orientation) can be up to 1080p or the input source
|
245
|
+
# resolution, whichever is lower; and bitrate can be up to 8.5 Mbps.
|
246
|
+
# `BASIC`\: The stream is transfixed; resolution can be up to 480p;
|
247
|
+
# and bitrate can be up to 1.5 Mbps. Default: `STANDARD`.
|
248
|
+
# @return [String]
|
249
|
+
#
|
250
|
+
# @!attribute [rw] tags
|
251
|
+
# See Channel$tags.
|
252
|
+
# @return [Hash<String,String>]
|
253
|
+
#
|
254
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/ivs-2020-07-14/CreateChannelRequest AWS API Documentation
|
255
|
+
#
|
256
|
+
class CreateChannelRequest < Struct.new(
|
257
|
+
:name,
|
258
|
+
:latency_mode,
|
259
|
+
:type,
|
260
|
+
:tags)
|
261
|
+
SENSITIVE = []
|
262
|
+
include Aws::Structure
|
263
|
+
end
|
264
|
+
|
265
|
+
# @!attribute [rw] channel
|
266
|
+
# Object specifying a channel.
|
267
|
+
# @return [Types::Channel]
|
268
|
+
#
|
269
|
+
# @!attribute [rw] stream_key
|
270
|
+
# Object specifying a stream key.
|
271
|
+
# @return [Types::StreamKey]
|
272
|
+
#
|
273
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/ivs-2020-07-14/CreateChannelResponse AWS API Documentation
|
274
|
+
#
|
275
|
+
class CreateChannelResponse < Struct.new(
|
276
|
+
:channel,
|
277
|
+
:stream_key)
|
278
|
+
SENSITIVE = []
|
279
|
+
include Aws::Structure
|
280
|
+
end
|
281
|
+
|
282
|
+
# @note When making an API call, you may pass CreateStreamKeyRequest
|
283
|
+
# data as a hash:
|
284
|
+
#
|
285
|
+
# {
|
286
|
+
# channel_arn: "ChannelArn", # required
|
287
|
+
# tags: {
|
288
|
+
# "TagKey" => "TagValue",
|
289
|
+
# },
|
290
|
+
# }
|
291
|
+
#
|
292
|
+
# @!attribute [rw] channel_arn
|
293
|
+
# ARN of the channel for which to create the stream key.
|
294
|
+
# @return [String]
|
295
|
+
#
|
296
|
+
# @!attribute [rw] tags
|
297
|
+
# See Channel$tags.
|
298
|
+
# @return [Hash<String,String>]
|
299
|
+
#
|
300
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/ivs-2020-07-14/CreateStreamKeyRequest AWS API Documentation
|
301
|
+
#
|
302
|
+
class CreateStreamKeyRequest < Struct.new(
|
303
|
+
:channel_arn,
|
304
|
+
:tags)
|
305
|
+
SENSITIVE = []
|
306
|
+
include Aws::Structure
|
307
|
+
end
|
308
|
+
|
309
|
+
# @!attribute [rw] stream_key
|
310
|
+
# Stream key used to authenticate an RTMP stream for ingestion.
|
311
|
+
# @return [Types::StreamKey]
|
312
|
+
#
|
313
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/ivs-2020-07-14/CreateStreamKeyResponse AWS API Documentation
|
314
|
+
#
|
315
|
+
class CreateStreamKeyResponse < Struct.new(
|
316
|
+
:stream_key)
|
317
|
+
SENSITIVE = []
|
318
|
+
include Aws::Structure
|
319
|
+
end
|
320
|
+
|
321
|
+
# @note When making an API call, you may pass DeleteChannelRequest
|
322
|
+
# data as a hash:
|
323
|
+
#
|
324
|
+
# {
|
325
|
+
# arn: "ChannelArn", # required
|
326
|
+
# }
|
327
|
+
#
|
328
|
+
# @!attribute [rw] arn
|
329
|
+
# ARN of the channel to be deleted.
|
330
|
+
# @return [String]
|
331
|
+
#
|
332
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/ivs-2020-07-14/DeleteChannelRequest AWS API Documentation
|
333
|
+
#
|
334
|
+
class DeleteChannelRequest < Struct.new(
|
335
|
+
:arn)
|
336
|
+
SENSITIVE = []
|
337
|
+
include Aws::Structure
|
338
|
+
end
|
339
|
+
|
340
|
+
# @note When making an API call, you may pass DeleteStreamKeyRequest
|
341
|
+
# data as a hash:
|
342
|
+
#
|
343
|
+
# {
|
344
|
+
# arn: "StreamKeyArn", # required
|
345
|
+
# }
|
346
|
+
#
|
347
|
+
# @!attribute [rw] arn
|
348
|
+
# ARN of the stream key to be deleted.
|
349
|
+
# @return [String]
|
350
|
+
#
|
351
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/ivs-2020-07-14/DeleteStreamKeyRequest AWS API Documentation
|
352
|
+
#
|
353
|
+
class DeleteStreamKeyRequest < Struct.new(
|
354
|
+
:arn)
|
355
|
+
SENSITIVE = []
|
356
|
+
include Aws::Structure
|
357
|
+
end
|
358
|
+
|
359
|
+
# @note When making an API call, you may pass GetChannelRequest
|
360
|
+
# data as a hash:
|
361
|
+
#
|
362
|
+
# {
|
363
|
+
# arn: "ChannelArn", # required
|
364
|
+
# }
|
365
|
+
#
|
366
|
+
# @!attribute [rw] arn
|
367
|
+
# ARN of the channel for which the configuration is to be retrieved.
|
368
|
+
# @return [String]
|
369
|
+
#
|
370
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/ivs-2020-07-14/GetChannelRequest AWS API Documentation
|
371
|
+
#
|
372
|
+
class GetChannelRequest < Struct.new(
|
373
|
+
:arn)
|
374
|
+
SENSITIVE = []
|
375
|
+
include Aws::Structure
|
376
|
+
end
|
377
|
+
|
378
|
+
# @!attribute [rw] channel
|
379
|
+
# Object specifying a channel.
|
380
|
+
# @return [Types::Channel]
|
381
|
+
#
|
382
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/ivs-2020-07-14/GetChannelResponse AWS API Documentation
|
383
|
+
#
|
384
|
+
class GetChannelResponse < Struct.new(
|
385
|
+
:channel)
|
386
|
+
SENSITIVE = []
|
387
|
+
include Aws::Structure
|
388
|
+
end
|
389
|
+
|
390
|
+
# @note When making an API call, you may pass GetStreamKeyRequest
|
391
|
+
# data as a hash:
|
392
|
+
#
|
393
|
+
# {
|
394
|
+
# arn: "StreamKeyArn", # required
|
395
|
+
# }
|
396
|
+
#
|
397
|
+
# @!attribute [rw] arn
|
398
|
+
# ARN for the stream key to be retrieved.
|
399
|
+
# @return [String]
|
400
|
+
#
|
401
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/ivs-2020-07-14/GetStreamKeyRequest AWS API Documentation
|
402
|
+
#
|
403
|
+
class GetStreamKeyRequest < Struct.new(
|
404
|
+
:arn)
|
405
|
+
SENSITIVE = []
|
406
|
+
include Aws::Structure
|
407
|
+
end
|
408
|
+
|
409
|
+
# @!attribute [rw] stream_key
|
410
|
+
# Object specifying a stream key.
|
411
|
+
# @return [Types::StreamKey]
|
412
|
+
#
|
413
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/ivs-2020-07-14/GetStreamKeyResponse AWS API Documentation
|
414
|
+
#
|
415
|
+
class GetStreamKeyResponse < Struct.new(
|
416
|
+
:stream_key)
|
417
|
+
SENSITIVE = []
|
418
|
+
include Aws::Structure
|
419
|
+
end
|
420
|
+
|
421
|
+
# @note When making an API call, you may pass GetStreamRequest
|
422
|
+
# data as a hash:
|
423
|
+
#
|
424
|
+
# {
|
425
|
+
# channel_arn: "ChannelArn", # required
|
426
|
+
# }
|
427
|
+
#
|
428
|
+
# @!attribute [rw] channel_arn
|
429
|
+
# Channel ARN for stream to be accessed.
|
430
|
+
# @return [String]
|
431
|
+
#
|
432
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/ivs-2020-07-14/GetStreamRequest AWS API Documentation
|
433
|
+
#
|
434
|
+
class GetStreamRequest < Struct.new(
|
435
|
+
:channel_arn)
|
436
|
+
SENSITIVE = []
|
437
|
+
include Aws::Structure
|
438
|
+
end
|
439
|
+
|
440
|
+
# @!attribute [rw] stream
|
441
|
+
# Specifies a live video stream that has been ingested and
|
442
|
+
# distributed.
|
443
|
+
# @return [Types::Stream]
|
444
|
+
#
|
445
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/ivs-2020-07-14/GetStreamResponse AWS API Documentation
|
446
|
+
#
|
447
|
+
class GetStreamResponse < Struct.new(
|
448
|
+
:stream)
|
449
|
+
SENSITIVE = []
|
450
|
+
include Aws::Structure
|
451
|
+
end
|
452
|
+
|
453
|
+
# @!attribute [rw] exception_message
|
454
|
+
# Unexpected error during processing of request.
|
455
|
+
# @return [String]
|
456
|
+
#
|
457
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/ivs-2020-07-14/InternalServerException AWS API Documentation
|
458
|
+
#
|
459
|
+
class InternalServerException < Struct.new(
|
460
|
+
:exception_message)
|
461
|
+
SENSITIVE = []
|
462
|
+
include Aws::Structure
|
463
|
+
end
|
464
|
+
|
465
|
+
# @note When making an API call, you may pass ListChannelsRequest
|
466
|
+
# data as a hash:
|
467
|
+
#
|
468
|
+
# {
|
469
|
+
# filter_by_name: "ChannelName",
|
470
|
+
# next_token: "PaginationToken",
|
471
|
+
# max_results: 1,
|
472
|
+
# }
|
473
|
+
#
|
474
|
+
# @!attribute [rw] filter_by_name
|
475
|
+
# Filters the channel list to match the specified name.
|
476
|
+
# @return [String]
|
477
|
+
#
|
478
|
+
# @!attribute [rw] next_token
|
479
|
+
# The first channel to retrieve. This is used for pagination; see the
|
480
|
+
# `nextToken` response field.
|
481
|
+
# @return [String]
|
482
|
+
#
|
483
|
+
# @!attribute [rw] max_results
|
484
|
+
# Maximum number of channels to return.
|
485
|
+
# @return [Integer]
|
486
|
+
#
|
487
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/ivs-2020-07-14/ListChannelsRequest AWS API Documentation
|
488
|
+
#
|
489
|
+
class ListChannelsRequest < Struct.new(
|
490
|
+
:filter_by_name,
|
491
|
+
:next_token,
|
492
|
+
:max_results)
|
493
|
+
SENSITIVE = []
|
494
|
+
include Aws::Structure
|
495
|
+
end
|
496
|
+
|
497
|
+
# @!attribute [rw] channels
|
498
|
+
# List of the matching channels.
|
499
|
+
# @return [Array<Types::ChannelSummary>]
|
500
|
+
#
|
501
|
+
# @!attribute [rw] next_token
|
502
|
+
# If there are more channels than `maxResults`, use `nextToken` in the
|
503
|
+
# request to get the next set.
|
504
|
+
# @return [String]
|
505
|
+
#
|
506
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/ivs-2020-07-14/ListChannelsResponse AWS API Documentation
|
507
|
+
#
|
508
|
+
class ListChannelsResponse < Struct.new(
|
509
|
+
:channels,
|
510
|
+
:next_token)
|
511
|
+
SENSITIVE = []
|
512
|
+
include Aws::Structure
|
513
|
+
end
|
514
|
+
|
515
|
+
# @note When making an API call, you may pass ListStreamKeysRequest
|
516
|
+
# data as a hash:
|
517
|
+
#
|
518
|
+
# {
|
519
|
+
# channel_arn: "ChannelArn", # required
|
520
|
+
# next_token: "PaginationToken",
|
521
|
+
# max_results: 1,
|
522
|
+
# }
|
523
|
+
#
|
524
|
+
# @!attribute [rw] channel_arn
|
525
|
+
# Channel ARN used to filter the list.
|
526
|
+
# @return [String]
|
527
|
+
#
|
528
|
+
# @!attribute [rw] next_token
|
529
|
+
# The first stream key to retrieve. This is used for pagination; see
|
530
|
+
# the `nextToken` response field.
|
531
|
+
# @return [String]
|
532
|
+
#
|
533
|
+
# @!attribute [rw] max_results
|
534
|
+
# Maximum number of streamKeys to return.
|
535
|
+
# @return [Integer]
|
536
|
+
#
|
537
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/ivs-2020-07-14/ListStreamKeysRequest AWS API Documentation
|
538
|
+
#
|
539
|
+
class ListStreamKeysRequest < Struct.new(
|
540
|
+
:channel_arn,
|
541
|
+
:next_token,
|
542
|
+
:max_results)
|
543
|
+
SENSITIVE = []
|
544
|
+
include Aws::Structure
|
545
|
+
end
|
546
|
+
|
547
|
+
# @!attribute [rw] stream_keys
|
548
|
+
# List of stream keys.
|
549
|
+
# @return [Array<Types::StreamKeySummary>]
|
550
|
+
#
|
551
|
+
# @!attribute [rw] next_token
|
552
|
+
# If there are more stream keys than `maxResults`, use `nextToken` in
|
553
|
+
# the request to get the next set.
|
554
|
+
# @return [String]
|
555
|
+
#
|
556
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/ivs-2020-07-14/ListStreamKeysResponse AWS API Documentation
|
557
|
+
#
|
558
|
+
class ListStreamKeysResponse < Struct.new(
|
559
|
+
:stream_keys,
|
560
|
+
:next_token)
|
561
|
+
SENSITIVE = []
|
562
|
+
include Aws::Structure
|
563
|
+
end
|
564
|
+
|
565
|
+
# @note When making an API call, you may pass ListStreamsRequest
|
566
|
+
# data as a hash:
|
567
|
+
#
|
568
|
+
# {
|
569
|
+
# next_token: "PaginationToken",
|
570
|
+
# max_results: 1,
|
571
|
+
# }
|
572
|
+
#
|
573
|
+
# @!attribute [rw] next_token
|
574
|
+
# The first stream to retrieve. This is used for pagination; see the
|
575
|
+
# `nextToken` response field.
|
576
|
+
# @return [String]
|
577
|
+
#
|
578
|
+
# @!attribute [rw] max_results
|
579
|
+
# Maximum number of streams to return.
|
580
|
+
# @return [Integer]
|
581
|
+
#
|
582
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/ivs-2020-07-14/ListStreamsRequest AWS API Documentation
|
583
|
+
#
|
584
|
+
class ListStreamsRequest < Struct.new(
|
585
|
+
:next_token,
|
586
|
+
:max_results)
|
587
|
+
SENSITIVE = []
|
588
|
+
include Aws::Structure
|
589
|
+
end
|
590
|
+
|
591
|
+
# @!attribute [rw] streams
|
592
|
+
# List of streams.
|
593
|
+
# @return [Array<Types::StreamSummary>]
|
594
|
+
#
|
595
|
+
# @!attribute [rw] next_token
|
596
|
+
# If there are more streams than `maxResults`, use `nextToken` in the
|
597
|
+
# request to get the next set.
|
598
|
+
# @return [String]
|
599
|
+
#
|
600
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/ivs-2020-07-14/ListStreamsResponse AWS API Documentation
|
601
|
+
#
|
602
|
+
class ListStreamsResponse < Struct.new(
|
603
|
+
:streams,
|
604
|
+
:next_token)
|
605
|
+
SENSITIVE = []
|
606
|
+
include Aws::Structure
|
607
|
+
end
|
608
|
+
|
609
|
+
# @note When making an API call, you may pass ListTagsForResourceRequest
|
610
|
+
# data as a hash:
|
611
|
+
#
|
612
|
+
# {
|
613
|
+
# resource_arn: "ResourceArn", # required
|
614
|
+
# next_token: "String",
|
615
|
+
# max_results: 1,
|
616
|
+
# }
|
617
|
+
#
|
618
|
+
# @!attribute [rw] resource_arn
|
619
|
+
# The ARN of the resource to be retrieved.
|
620
|
+
# @return [String]
|
621
|
+
#
|
622
|
+
# @!attribute [rw] next_token
|
623
|
+
# The first tag to retrieve. This is used for pagination; see the
|
624
|
+
# `nextToken` response field.
|
625
|
+
# @return [String]
|
626
|
+
#
|
627
|
+
# @!attribute [rw] max_results
|
628
|
+
# Maximum number of tags to return.
|
629
|
+
# @return [Integer]
|
630
|
+
#
|
631
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/ivs-2020-07-14/ListTagsForResourceRequest AWS API Documentation
|
632
|
+
#
|
633
|
+
class ListTagsForResourceRequest < Struct.new(
|
634
|
+
:resource_arn,
|
635
|
+
:next_token,
|
636
|
+
:max_results)
|
637
|
+
SENSITIVE = []
|
638
|
+
include Aws::Structure
|
639
|
+
end
|
640
|
+
|
641
|
+
# @!attribute [rw] tags
|
642
|
+
# @return [Hash<String,String>]
|
643
|
+
#
|
644
|
+
# @!attribute [rw] next_token
|
645
|
+
# If there are more tags than `maxResults`, use `nextToken` in the
|
646
|
+
# request to get the next set.
|
647
|
+
# @return [String]
|
648
|
+
#
|
649
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/ivs-2020-07-14/ListTagsForResourceResponse AWS API Documentation
|
650
|
+
#
|
651
|
+
class ListTagsForResourceResponse < Struct.new(
|
652
|
+
:tags,
|
653
|
+
:next_token)
|
654
|
+
SENSITIVE = []
|
655
|
+
include Aws::Structure
|
656
|
+
end
|
657
|
+
|
658
|
+
# @note When making an API call, you may pass PutMetadataRequest
|
659
|
+
# data as a hash:
|
660
|
+
#
|
661
|
+
# {
|
662
|
+
# channel_arn: "ChannelArn", # required
|
663
|
+
# metadata: "StreamMetadata", # required
|
664
|
+
# }
|
665
|
+
#
|
666
|
+
# @!attribute [rw] channel_arn
|
667
|
+
# ARN of the channel into which metadata is inserted. This channel
|
668
|
+
# must have an active stream.
|
669
|
+
# @return [String]
|
670
|
+
#
|
671
|
+
# @!attribute [rw] metadata
|
672
|
+
# Metadata to insert into the stream. Maximum: 1 KB per request.
|
673
|
+
# @return [String]
|
674
|
+
#
|
675
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/ivs-2020-07-14/PutMetadataRequest AWS API Documentation
|
676
|
+
#
|
677
|
+
class PutMetadataRequest < Struct.new(
|
678
|
+
:channel_arn,
|
679
|
+
:metadata)
|
680
|
+
SENSITIVE = []
|
681
|
+
include Aws::Structure
|
682
|
+
end
|
683
|
+
|
684
|
+
# @!attribute [rw] exception_message
|
685
|
+
# Request references a resource which does not exist.
|
686
|
+
# @return [String]
|
687
|
+
#
|
688
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/ivs-2020-07-14/ResourceNotFoundException AWS API Documentation
|
689
|
+
#
|
690
|
+
class ResourceNotFoundException < Struct.new(
|
691
|
+
:exception_message)
|
692
|
+
SENSITIVE = []
|
693
|
+
include Aws::Structure
|
694
|
+
end
|
695
|
+
|
696
|
+
# @!attribute [rw] exception_message
|
697
|
+
# Request would cause a service quota to be exceeded.
|
698
|
+
# @return [String]
|
699
|
+
#
|
700
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/ivs-2020-07-14/ServiceQuotaExceededException AWS API Documentation
|
701
|
+
#
|
702
|
+
class ServiceQuotaExceededException < Struct.new(
|
703
|
+
:exception_message)
|
704
|
+
SENSITIVE = []
|
705
|
+
include Aws::Structure
|
706
|
+
end
|
707
|
+
|
708
|
+
# @note When making an API call, you may pass StopStreamRequest
|
709
|
+
# data as a hash:
|
710
|
+
#
|
711
|
+
# {
|
712
|
+
# channel_arn: "ChannelArn", # required
|
713
|
+
# }
|
714
|
+
#
|
715
|
+
# @!attribute [rw] channel_arn
|
716
|
+
# ARN of the channel for which the stream is to be stopped.
|
717
|
+
# @return [String]
|
718
|
+
#
|
719
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/ivs-2020-07-14/StopStreamRequest AWS API Documentation
|
720
|
+
#
|
721
|
+
class StopStreamRequest < Struct.new(
|
722
|
+
:channel_arn)
|
723
|
+
SENSITIVE = []
|
724
|
+
include Aws::Structure
|
725
|
+
end
|
726
|
+
|
727
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/ivs-2020-07-14/StopStreamResponse AWS API Documentation
|
728
|
+
#
|
729
|
+
class StopStreamResponse < Aws::EmptyStructure; end
|
730
|
+
|
731
|
+
# Specifies a live video stream that has been ingested and distributed.
|
732
|
+
#
|
733
|
+
# @!attribute [rw] channel_arn
|
734
|
+
# Channel ARN for the stream.
|
735
|
+
# @return [String]
|
736
|
+
#
|
737
|
+
# @!attribute [rw] playback_url
|
738
|
+
# URL of the video master manifest, required by the video player to
|
739
|
+
# play the HLS stream.
|
740
|
+
# @return [String]
|
741
|
+
#
|
742
|
+
# @!attribute [rw] start_time
|
743
|
+
# ISO-8601 formatted timestamp of the stream’s start.
|
744
|
+
# @return [Time]
|
745
|
+
#
|
746
|
+
# @!attribute [rw] state
|
747
|
+
# The stream’s state.
|
748
|
+
# @return [String]
|
749
|
+
#
|
750
|
+
# @!attribute [rw] health
|
751
|
+
# The stream’s health.
|
752
|
+
# @return [String]
|
753
|
+
#
|
754
|
+
# @!attribute [rw] viewer_count
|
755
|
+
# Number of current viewers of the stream.
|
756
|
+
# @return [Integer]
|
757
|
+
#
|
758
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/ivs-2020-07-14/Stream AWS API Documentation
|
759
|
+
#
|
760
|
+
class Stream < Struct.new(
|
761
|
+
:channel_arn,
|
762
|
+
:playback_url,
|
763
|
+
:start_time,
|
764
|
+
:state,
|
765
|
+
:health,
|
766
|
+
:viewer_count)
|
767
|
+
SENSITIVE = []
|
768
|
+
include Aws::Structure
|
769
|
+
end
|
770
|
+
|
771
|
+
# Object specifying a stream key.
|
772
|
+
#
|
773
|
+
# @!attribute [rw] arn
|
774
|
+
# Stream-key ARN.
|
775
|
+
# @return [String]
|
776
|
+
#
|
777
|
+
# @!attribute [rw] value
|
778
|
+
# Stream-key value.
|
779
|
+
# @return [String]
|
780
|
+
#
|
781
|
+
# @!attribute [rw] channel_arn
|
782
|
+
# Channel ARN for the stream.
|
783
|
+
# @return [String]
|
784
|
+
#
|
785
|
+
# @!attribute [rw] tags
|
786
|
+
# Array of 1-50 maps, each of the form `string:string (key:value)`
|
787
|
+
# @return [Hash<String,String>]
|
788
|
+
#
|
789
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/ivs-2020-07-14/StreamKey AWS API Documentation
|
790
|
+
#
|
791
|
+
class StreamKey < Struct.new(
|
792
|
+
:arn,
|
793
|
+
:value,
|
794
|
+
:channel_arn,
|
795
|
+
:tags)
|
796
|
+
SENSITIVE = []
|
797
|
+
include Aws::Structure
|
798
|
+
end
|
799
|
+
|
800
|
+
# Summary information about a stream key.
|
801
|
+
#
|
802
|
+
# @!attribute [rw] arn
|
803
|
+
# Stream-key ARN.
|
804
|
+
# @return [String]
|
805
|
+
#
|
806
|
+
# @!attribute [rw] channel_arn
|
807
|
+
# Channel ARN for the stream.
|
808
|
+
# @return [String]
|
809
|
+
#
|
810
|
+
# @!attribute [rw] tags
|
811
|
+
# Array of 1-50 maps, each of the form `string:string (key:value)`
|
812
|
+
# @return [Hash<String,String>]
|
813
|
+
#
|
814
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/ivs-2020-07-14/StreamKeySummary AWS API Documentation
|
815
|
+
#
|
816
|
+
class StreamKeySummary < Struct.new(
|
817
|
+
:arn,
|
818
|
+
:channel_arn,
|
819
|
+
:tags)
|
820
|
+
SENSITIVE = []
|
821
|
+
include Aws::Structure
|
822
|
+
end
|
823
|
+
|
824
|
+
# Summary information about a stream.
|
825
|
+
#
|
826
|
+
# @!attribute [rw] channel_arn
|
827
|
+
# Channel ARN for the stream.
|
828
|
+
# @return [String]
|
829
|
+
#
|
830
|
+
# @!attribute [rw] state
|
831
|
+
# The stream’s state.
|
832
|
+
# @return [String]
|
833
|
+
#
|
834
|
+
# @!attribute [rw] health
|
835
|
+
# The stream’s health.
|
836
|
+
# @return [String]
|
837
|
+
#
|
838
|
+
# @!attribute [rw] viewer_count
|
839
|
+
# Number of current viewers of the stream.
|
840
|
+
# @return [Integer]
|
841
|
+
#
|
842
|
+
# @!attribute [rw] start_time
|
843
|
+
# ISO-8601 formatted timestamp of the stream’s start.
|
844
|
+
# @return [Time]
|
845
|
+
#
|
846
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/ivs-2020-07-14/StreamSummary AWS API Documentation
|
847
|
+
#
|
848
|
+
class StreamSummary < Struct.new(
|
849
|
+
:channel_arn,
|
850
|
+
:state,
|
851
|
+
:health,
|
852
|
+
:viewer_count,
|
853
|
+
:start_time)
|
854
|
+
SENSITIVE = []
|
855
|
+
include Aws::Structure
|
856
|
+
end
|
857
|
+
|
858
|
+
# @!attribute [rw] exception_message
|
859
|
+
# The stream is temporarily unavailable.
|
860
|
+
# @return [String]
|
861
|
+
#
|
862
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/ivs-2020-07-14/StreamUnavailable AWS API Documentation
|
863
|
+
#
|
864
|
+
class StreamUnavailable < Struct.new(
|
865
|
+
:exception_message)
|
866
|
+
SENSITIVE = []
|
867
|
+
include Aws::Structure
|
868
|
+
end
|
869
|
+
|
870
|
+
# @note When making an API call, you may pass TagResourceRequest
|
871
|
+
# data as a hash:
|
872
|
+
#
|
873
|
+
# {
|
874
|
+
# resource_arn: "ResourceArn", # required
|
875
|
+
# tags: { # required
|
876
|
+
# "TagKey" => "TagValue",
|
877
|
+
# },
|
878
|
+
# }
|
879
|
+
#
|
880
|
+
# @!attribute [rw] resource_arn
|
881
|
+
# ARN of the resource for which tags are to be added or updated.
|
882
|
+
# @return [String]
|
883
|
+
#
|
884
|
+
# @!attribute [rw] tags
|
885
|
+
# Array of tags to be added or updated.
|
886
|
+
# @return [Hash<String,String>]
|
887
|
+
#
|
888
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/ivs-2020-07-14/TagResourceRequest AWS API Documentation
|
889
|
+
#
|
890
|
+
class TagResourceRequest < Struct.new(
|
891
|
+
:resource_arn,
|
892
|
+
:tags)
|
893
|
+
SENSITIVE = []
|
894
|
+
include Aws::Structure
|
895
|
+
end
|
896
|
+
|
897
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/ivs-2020-07-14/TagResourceResponse AWS API Documentation
|
898
|
+
#
|
899
|
+
class TagResourceResponse < Aws::EmptyStructure; end
|
900
|
+
|
901
|
+
# @!attribute [rw] exception_message
|
902
|
+
# Request was denied due to request throttling.
|
903
|
+
# @return [String]
|
904
|
+
#
|
905
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/ivs-2020-07-14/ThrottlingException AWS API Documentation
|
906
|
+
#
|
907
|
+
class ThrottlingException < Struct.new(
|
908
|
+
:exception_message)
|
909
|
+
SENSITIVE = []
|
910
|
+
include Aws::Structure
|
911
|
+
end
|
912
|
+
|
913
|
+
# @note When making an API call, you may pass UntagResourceRequest
|
914
|
+
# data as a hash:
|
915
|
+
#
|
916
|
+
# {
|
917
|
+
# resource_arn: "ResourceArn", # required
|
918
|
+
# tag_keys: ["TagKey"], # required
|
919
|
+
# }
|
920
|
+
#
|
921
|
+
# @!attribute [rw] resource_arn
|
922
|
+
# ARN of the resource for which tags are to be removed.
|
923
|
+
# @return [String]
|
924
|
+
#
|
925
|
+
# @!attribute [rw] tag_keys
|
926
|
+
# Array of tags to be removed.
|
927
|
+
# @return [Array<String>]
|
928
|
+
#
|
929
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/ivs-2020-07-14/UntagResourceRequest AWS API Documentation
|
930
|
+
#
|
931
|
+
class UntagResourceRequest < Struct.new(
|
932
|
+
:resource_arn,
|
933
|
+
:tag_keys)
|
934
|
+
SENSITIVE = []
|
935
|
+
include Aws::Structure
|
936
|
+
end
|
937
|
+
|
938
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/ivs-2020-07-14/UntagResourceResponse AWS API Documentation
|
939
|
+
#
|
940
|
+
class UntagResourceResponse < Aws::EmptyStructure; end
|
941
|
+
|
942
|
+
# @note When making an API call, you may pass UpdateChannelRequest
|
943
|
+
# data as a hash:
|
944
|
+
#
|
945
|
+
# {
|
946
|
+
# arn: "ChannelArn", # required
|
947
|
+
# name: "ChannelName",
|
948
|
+
# latency_mode: "NORMAL", # accepts NORMAL, LOW
|
949
|
+
# type: "BASIC", # accepts BASIC, STANDARD
|
950
|
+
# }
|
951
|
+
#
|
952
|
+
# @!attribute [rw] arn
|
953
|
+
# ARN of the channel to be updated.
|
954
|
+
# @return [String]
|
955
|
+
#
|
956
|
+
# @!attribute [rw] name
|
957
|
+
# Channel name.
|
958
|
+
# @return [String]
|
959
|
+
#
|
960
|
+
# @!attribute [rw] latency_mode
|
961
|
+
# Channel latency mode. Default: `LOW`.
|
962
|
+
# @return [String]
|
963
|
+
#
|
964
|
+
# @!attribute [rw] type
|
965
|
+
# Channel type, which determines the allowable resolution and bitrate.
|
966
|
+
# `STANDARD`\: The stream is transcoded; resolution (width, in
|
967
|
+
# landscape orientation) can be up to 1080p or the input source
|
968
|
+
# resolution, whichever is lower; and bitrate can be up to 8.5 Mbps.
|
969
|
+
# `BASIC`\: The stream is transfixed; resolution can be up to 480p;
|
970
|
+
# and bitrate can be up to 1.5 Mbps. Default `STANDARD`.
|
971
|
+
# @return [String]
|
972
|
+
#
|
973
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/ivs-2020-07-14/UpdateChannelRequest AWS API Documentation
|
974
|
+
#
|
975
|
+
class UpdateChannelRequest < Struct.new(
|
976
|
+
:arn,
|
977
|
+
:name,
|
978
|
+
:latency_mode,
|
979
|
+
:type)
|
980
|
+
SENSITIVE = []
|
981
|
+
include Aws::Structure
|
982
|
+
end
|
983
|
+
|
984
|
+
# @!attribute [rw] channel
|
985
|
+
# Object specifying a channel.
|
986
|
+
# @return [Types::Channel]
|
987
|
+
#
|
988
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/ivs-2020-07-14/UpdateChannelResponse AWS API Documentation
|
989
|
+
#
|
990
|
+
class UpdateChannelResponse < Struct.new(
|
991
|
+
:channel)
|
992
|
+
SENSITIVE = []
|
993
|
+
include Aws::Structure
|
994
|
+
end
|
995
|
+
|
996
|
+
# @!attribute [rw] exception_message
|
997
|
+
# The input fails to satisfy the constraints specified by an AWS
|
998
|
+
# service.
|
999
|
+
# @return [String]
|
1000
|
+
#
|
1001
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/ivs-2020-07-14/ValidationException AWS API Documentation
|
1002
|
+
#
|
1003
|
+
class ValidationException < Struct.new(
|
1004
|
+
:exception_message)
|
1005
|
+
SENSITIVE = []
|
1006
|
+
include Aws::Structure
|
1007
|
+
end
|
1008
|
+
|
1009
|
+
end
|
1010
|
+
end
|