aws-sdk-mediaconnect 1.0.0
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +7 -0
- data/lib/aws-sdk-mediaconnect/client.rb +1060 -0
- data/lib/aws-sdk-mediaconnect/client_api.rb +556 -0
- data/lib/aws-sdk-mediaconnect/customizations.rb +0 -0
- data/lib/aws-sdk-mediaconnect/errors.rb +14 -0
- data/lib/aws-sdk-mediaconnect/resource.rb +23 -0
- data/lib/aws-sdk-mediaconnect/types.rb +1475 -0
- data/lib/aws-sdk-mediaconnect.rb +47 -0
- metadata +88 -0
@@ -0,0 +1,1060 @@
|
|
1
|
+
# WARNING ABOUT GENERATED CODE
|
2
|
+
#
|
3
|
+
# This file is generated. See the contributing guide for more information:
|
4
|
+
# https://github.com/aws/aws-sdk-ruby/blob/master/CONTRIBUTING.md
|
5
|
+
#
|
6
|
+
# WARNING ABOUT GENERATED CODE
|
7
|
+
|
8
|
+
require 'seahorse/client/plugins/content_length.rb'
|
9
|
+
require 'aws-sdk-core/plugins/credentials_configuration.rb'
|
10
|
+
require 'aws-sdk-core/plugins/logging.rb'
|
11
|
+
require 'aws-sdk-core/plugins/param_converter.rb'
|
12
|
+
require 'aws-sdk-core/plugins/param_validator.rb'
|
13
|
+
require 'aws-sdk-core/plugins/user_agent.rb'
|
14
|
+
require 'aws-sdk-core/plugins/helpful_socket_errors.rb'
|
15
|
+
require 'aws-sdk-core/plugins/retry_errors.rb'
|
16
|
+
require 'aws-sdk-core/plugins/global_configuration.rb'
|
17
|
+
require 'aws-sdk-core/plugins/regional_endpoint.rb'
|
18
|
+
require 'aws-sdk-core/plugins/endpoint_discovery.rb'
|
19
|
+
require 'aws-sdk-core/plugins/endpoint_pattern.rb'
|
20
|
+
require 'aws-sdk-core/plugins/response_paging.rb'
|
21
|
+
require 'aws-sdk-core/plugins/stub_responses.rb'
|
22
|
+
require 'aws-sdk-core/plugins/idempotency_token.rb'
|
23
|
+
require 'aws-sdk-core/plugins/jsonvalue_converter.rb'
|
24
|
+
require 'aws-sdk-core/plugins/client_metrics_plugin.rb'
|
25
|
+
require 'aws-sdk-core/plugins/client_metrics_send_plugin.rb'
|
26
|
+
require 'aws-sdk-core/plugins/signature_v4.rb'
|
27
|
+
require 'aws-sdk-core/plugins/protocols/rest_json.rb'
|
28
|
+
|
29
|
+
Aws::Plugins::GlobalConfiguration.add_identifier(:mediaconnect)
|
30
|
+
|
31
|
+
module Aws::MediaConnect
|
32
|
+
class Client < Seahorse::Client::Base
|
33
|
+
|
34
|
+
include Aws::ClientStubs
|
35
|
+
|
36
|
+
@identifier = :mediaconnect
|
37
|
+
|
38
|
+
set_api(ClientApi::API)
|
39
|
+
|
40
|
+
add_plugin(Seahorse::Client::Plugins::ContentLength)
|
41
|
+
add_plugin(Aws::Plugins::CredentialsConfiguration)
|
42
|
+
add_plugin(Aws::Plugins::Logging)
|
43
|
+
add_plugin(Aws::Plugins::ParamConverter)
|
44
|
+
add_plugin(Aws::Plugins::ParamValidator)
|
45
|
+
add_plugin(Aws::Plugins::UserAgent)
|
46
|
+
add_plugin(Aws::Plugins::HelpfulSocketErrors)
|
47
|
+
add_plugin(Aws::Plugins::RetryErrors)
|
48
|
+
add_plugin(Aws::Plugins::GlobalConfiguration)
|
49
|
+
add_plugin(Aws::Plugins::RegionalEndpoint)
|
50
|
+
add_plugin(Aws::Plugins::EndpointDiscovery)
|
51
|
+
add_plugin(Aws::Plugins::EndpointPattern)
|
52
|
+
add_plugin(Aws::Plugins::ResponsePaging)
|
53
|
+
add_plugin(Aws::Plugins::StubResponses)
|
54
|
+
add_plugin(Aws::Plugins::IdempotencyToken)
|
55
|
+
add_plugin(Aws::Plugins::JsonvalueConverter)
|
56
|
+
add_plugin(Aws::Plugins::ClientMetricsPlugin)
|
57
|
+
add_plugin(Aws::Plugins::ClientMetricsSendPlugin)
|
58
|
+
add_plugin(Aws::Plugins::SignatureV4)
|
59
|
+
add_plugin(Aws::Plugins::Protocols::RestJson)
|
60
|
+
|
61
|
+
# @overload initialize(options)
|
62
|
+
# @param [Hash] options
|
63
|
+
# @option options [required, Aws::CredentialProvider] :credentials
|
64
|
+
# Your AWS credentials. This can be an instance of any one of the
|
65
|
+
# following classes:
|
66
|
+
#
|
67
|
+
# * `Aws::Credentials` - Used for configuring static, non-refreshing
|
68
|
+
# credentials.
|
69
|
+
#
|
70
|
+
# * `Aws::InstanceProfileCredentials` - Used for loading credentials
|
71
|
+
# from an EC2 IMDS on an EC2 instance.
|
72
|
+
#
|
73
|
+
# * `Aws::SharedCredentials` - Used for loading credentials from a
|
74
|
+
# shared file, such as `~/.aws/config`.
|
75
|
+
#
|
76
|
+
# * `Aws::AssumeRoleCredentials` - Used when you need to assume a role.
|
77
|
+
#
|
78
|
+
# When `:credentials` are not configured directly, the following
|
79
|
+
# locations will be searched for credentials:
|
80
|
+
#
|
81
|
+
# * `Aws.config[:credentials]`
|
82
|
+
# * The `:access_key_id`, `:secret_access_key`, and `:session_token` options.
|
83
|
+
# * ENV['AWS_ACCESS_KEY_ID'], ENV['AWS_SECRET_ACCESS_KEY']
|
84
|
+
# * `~/.aws/credentials`
|
85
|
+
# * `~/.aws/config`
|
86
|
+
# * EC2 IMDS instance profile - When used by default, the timeouts are
|
87
|
+
# very aggressive. Construct and pass an instance of
|
88
|
+
# `Aws::InstanceProfileCredentails` to enable retries and extended
|
89
|
+
# timeouts.
|
90
|
+
#
|
91
|
+
# @option options [required, String] :region
|
92
|
+
# The AWS region to connect to. The configured `:region` is
|
93
|
+
# used to determine the service `:endpoint`. When not passed,
|
94
|
+
# a default `:region` is search for in the following locations:
|
95
|
+
#
|
96
|
+
# * `Aws.config[:region]`
|
97
|
+
# * `ENV['AWS_REGION']`
|
98
|
+
# * `ENV['AMAZON_REGION']`
|
99
|
+
# * `ENV['AWS_DEFAULT_REGION']`
|
100
|
+
# * `~/.aws/credentials`
|
101
|
+
# * `~/.aws/config`
|
102
|
+
#
|
103
|
+
# @option options [String] :access_key_id
|
104
|
+
#
|
105
|
+
# @option options [Boolean] :active_endpoint_cache (false)
|
106
|
+
# When set to `true`, a thread polling for endpoints will be running in
|
107
|
+
# the background every 60 secs (default). Defaults to `false`.
|
108
|
+
#
|
109
|
+
# @option options [Boolean] :client_side_monitoring (false)
|
110
|
+
# When `true`, client-side metrics will be collected for all API requests from
|
111
|
+
# this client.
|
112
|
+
#
|
113
|
+
# @option options [String] :client_side_monitoring_client_id ("")
|
114
|
+
# Allows you to provide an identifier for this client which will be attached to
|
115
|
+
# all generated client side metrics. Defaults to an empty string.
|
116
|
+
#
|
117
|
+
# @option options [Integer] :client_side_monitoring_port (31000)
|
118
|
+
# Required for publishing client metrics. The port that the client side monitoring
|
119
|
+
# agent is running on, where client metrics will be published via UDP.
|
120
|
+
#
|
121
|
+
# @option options [Aws::ClientSideMonitoring::Publisher] :client_side_monitoring_publisher (Aws::ClientSideMonitoring::Publisher)
|
122
|
+
# Allows you to provide a custom client-side monitoring publisher class. By default,
|
123
|
+
# will use the Client Side Monitoring Agent Publisher.
|
124
|
+
#
|
125
|
+
# @option options [Boolean] :convert_params (true)
|
126
|
+
# When `true`, an attempt is made to coerce request parameters into
|
127
|
+
# the required types.
|
128
|
+
#
|
129
|
+
# @option options [Boolean] :disable_host_prefix_injection (false)
|
130
|
+
# Set to true to disable SDK automatically adding host prefix
|
131
|
+
# to default service endpoint when available.
|
132
|
+
#
|
133
|
+
# @option options [String] :endpoint
|
134
|
+
# The client endpoint is normally constructed from the `:region`
|
135
|
+
# option. You should only configure an `:endpoint` when connecting
|
136
|
+
# to test endpoints. This should be avalid HTTP(S) URI.
|
137
|
+
#
|
138
|
+
# @option options [Integer] :endpoint_cache_max_entries (1000)
|
139
|
+
# Used for the maximum size limit of the LRU cache storing endpoints data
|
140
|
+
# for endpoint discovery enabled operations. Defaults to 1000.
|
141
|
+
#
|
142
|
+
# @option options [Integer] :endpoint_cache_max_threads (10)
|
143
|
+
# Used for the maximum threads in use for polling endpoints to be cached, defaults to 10.
|
144
|
+
#
|
145
|
+
# @option options [Integer] :endpoint_cache_poll_interval (60)
|
146
|
+
# When :endpoint_discovery and :active_endpoint_cache is enabled,
|
147
|
+
# Use this option to config the time interval in seconds for making
|
148
|
+
# requests fetching endpoints information. Defaults to 60 sec.
|
149
|
+
#
|
150
|
+
# @option options [Boolean] :endpoint_discovery (false)
|
151
|
+
# When set to `true`, endpoint discovery will be enabled for operations when available. Defaults to `false`.
|
152
|
+
#
|
153
|
+
# @option options [Aws::Log::Formatter] :log_formatter (Aws::Log::Formatter.default)
|
154
|
+
# The log formatter.
|
155
|
+
#
|
156
|
+
# @option options [Symbol] :log_level (:info)
|
157
|
+
# The log level to send messages to the `:logger` at.
|
158
|
+
#
|
159
|
+
# @option options [Logger] :logger
|
160
|
+
# The Logger instance to send log messages to. If this option
|
161
|
+
# is not set, logging will be disabled.
|
162
|
+
#
|
163
|
+
# @option options [String] :profile ("default")
|
164
|
+
# Used when loading credentials from the shared credentials file
|
165
|
+
# at HOME/.aws/credentials. When not specified, 'default' is used.
|
166
|
+
#
|
167
|
+
# @option options [Float] :retry_base_delay (0.3)
|
168
|
+
# The base delay in seconds used by the default backoff function.
|
169
|
+
#
|
170
|
+
# @option options [Symbol] :retry_jitter (:none)
|
171
|
+
# A delay randomiser function used by the default backoff function. Some predefined functions can be referenced by name - :none, :equal, :full, otherwise a Proc that takes and returns a number.
|
172
|
+
#
|
173
|
+
# @see https://www.awsarchitectureblog.com/2015/03/backoff.html
|
174
|
+
#
|
175
|
+
# @option options [Integer] :retry_limit (3)
|
176
|
+
# The maximum number of times to retry failed requests. Only
|
177
|
+
# ~ 500 level server errors and certain ~ 400 level client errors
|
178
|
+
# are retried. Generally, these are throttling errors, data
|
179
|
+
# checksum errors, networking errors, timeout errors and auth
|
180
|
+
# errors from expired credentials.
|
181
|
+
#
|
182
|
+
# @option options [Integer] :retry_max_delay (0)
|
183
|
+
# The maximum number of seconds to delay between retries (0 for no limit) used by the default backoff function.
|
184
|
+
#
|
185
|
+
# @option options [String] :secret_access_key
|
186
|
+
#
|
187
|
+
# @option options [String] :session_token
|
188
|
+
#
|
189
|
+
# @option options [Boolean] :stub_responses (false)
|
190
|
+
# Causes the client to return stubbed responses. By default
|
191
|
+
# fake responses are generated and returned. You can specify
|
192
|
+
# the response data to return or errors to raise by calling
|
193
|
+
# {ClientStubs#stub_responses}. See {ClientStubs} for more information.
|
194
|
+
#
|
195
|
+
# ** Please note ** When response stubbing is enabled, no HTTP
|
196
|
+
# requests are made, and retries are disabled.
|
197
|
+
#
|
198
|
+
# @option options [Boolean] :validate_params (true)
|
199
|
+
# When `true`, request parameters are validated before
|
200
|
+
# sending the request.
|
201
|
+
#
|
202
|
+
def initialize(*args)
|
203
|
+
super
|
204
|
+
end
|
205
|
+
|
206
|
+
# @!group API Operations
|
207
|
+
|
208
|
+
# Adds outputs to an existing flow. You can create up to 20 outputs per
|
209
|
+
# flow.
|
210
|
+
#
|
211
|
+
# @option params [required, String] :flow_arn
|
212
|
+
#
|
213
|
+
# @option params [required, Array<Types::AddOutputRequest>] :outputs
|
214
|
+
# A list of outputs that you want to add.
|
215
|
+
#
|
216
|
+
# @return [Types::AddFlowOutputsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
217
|
+
#
|
218
|
+
# * {Types::AddFlowOutputsResponse#flow_arn #flow_arn} => String
|
219
|
+
# * {Types::AddFlowOutputsResponse#outputs #outputs} => Array<Types::Output>
|
220
|
+
#
|
221
|
+
# @example Request syntax with placeholder values
|
222
|
+
#
|
223
|
+
# resp = client.add_flow_outputs({
|
224
|
+
# flow_arn: "__string", # required
|
225
|
+
# outputs: [ # required
|
226
|
+
# {
|
227
|
+
# description: "__string",
|
228
|
+
# destination: "__string", # required
|
229
|
+
# encryption: {
|
230
|
+
# algorithm: "aes128", # required, accepts aes128, aes192, aes256
|
231
|
+
# key_type: "static-key", # accepts static-key
|
232
|
+
# role_arn: "__string", # required
|
233
|
+
# secret_arn: "__string", # required
|
234
|
+
# },
|
235
|
+
# max_latency: 1,
|
236
|
+
# name: "__string",
|
237
|
+
# port: 1, # required
|
238
|
+
# protocol: "zixi-push", # required, accepts zixi-push, rtp-fec, rtp
|
239
|
+
# smoothing_latency: 1,
|
240
|
+
# stream_id: "__string",
|
241
|
+
# },
|
242
|
+
# ],
|
243
|
+
# })
|
244
|
+
#
|
245
|
+
# @example Response structure
|
246
|
+
#
|
247
|
+
# resp.flow_arn #=> String
|
248
|
+
# resp.outputs #=> Array
|
249
|
+
# resp.outputs[0].description #=> String
|
250
|
+
# resp.outputs[0].destination #=> String
|
251
|
+
# resp.outputs[0].encryption.algorithm #=> String, one of "aes128", "aes192", "aes256"
|
252
|
+
# resp.outputs[0].encryption.key_type #=> String, one of "static-key"
|
253
|
+
# resp.outputs[0].encryption.role_arn #=> String
|
254
|
+
# resp.outputs[0].encryption.secret_arn #=> String
|
255
|
+
# resp.outputs[0].entitlement_arn #=> String
|
256
|
+
# resp.outputs[0].media_live_input_arn #=> String
|
257
|
+
# resp.outputs[0].name #=> String
|
258
|
+
# resp.outputs[0].output_arn #=> String
|
259
|
+
# resp.outputs[0].port #=> Integer
|
260
|
+
# resp.outputs[0].transport.max_bitrate #=> Integer
|
261
|
+
# resp.outputs[0].transport.max_latency #=> Integer
|
262
|
+
# resp.outputs[0].transport.protocol #=> String, one of "zixi-push", "rtp-fec", "rtp"
|
263
|
+
# resp.outputs[0].transport.smoothing_latency #=> Integer
|
264
|
+
# resp.outputs[0].transport.stream_id #=> String
|
265
|
+
#
|
266
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/mediaconnect-2018-11-14/AddFlowOutputs AWS API Documentation
|
267
|
+
#
|
268
|
+
# @overload add_flow_outputs(params = {})
|
269
|
+
# @param [Hash] params ({})
|
270
|
+
def add_flow_outputs(params = {}, options = {})
|
271
|
+
req = build_request(:add_flow_outputs, params)
|
272
|
+
req.send_request(options)
|
273
|
+
end
|
274
|
+
|
275
|
+
# Creates a new flow. The request must include one source. The request
|
276
|
+
# optionally can include outputs (up to 20) and entitlements (up to 50).
|
277
|
+
#
|
278
|
+
# @option params [String] :availability_zone
|
279
|
+
# The Availability Zone that you want to create the flow in. These
|
280
|
+
# options are limited to the Availability Zones within the current AWS
|
281
|
+
# Region.
|
282
|
+
#
|
283
|
+
# @option params [Array<Types::GrantEntitlementRequest>] :entitlements
|
284
|
+
# The entitlements that you want to grant on a flow.
|
285
|
+
#
|
286
|
+
# @option params [required, String] :name
|
287
|
+
# The name of the flow.
|
288
|
+
#
|
289
|
+
# @option params [Array<Types::AddOutputRequest>] :outputs
|
290
|
+
# The outputs that you want to add to this flow.
|
291
|
+
#
|
292
|
+
# @option params [required, Types::SetSourceRequest] :source
|
293
|
+
# The settings for the source of the flow.
|
294
|
+
#
|
295
|
+
# @return [Types::CreateFlowResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
296
|
+
#
|
297
|
+
# * {Types::CreateFlowResponse#flow #flow} => Types::Flow
|
298
|
+
#
|
299
|
+
# @example Request syntax with placeholder values
|
300
|
+
#
|
301
|
+
# resp = client.create_flow({
|
302
|
+
# availability_zone: "__string",
|
303
|
+
# entitlements: [
|
304
|
+
# {
|
305
|
+
# description: "__string",
|
306
|
+
# encryption: {
|
307
|
+
# algorithm: "aes128", # required, accepts aes128, aes192, aes256
|
308
|
+
# key_type: "static-key", # accepts static-key
|
309
|
+
# role_arn: "__string", # required
|
310
|
+
# secret_arn: "__string", # required
|
311
|
+
# },
|
312
|
+
# name: "__string",
|
313
|
+
# subscribers: ["__string"], # required
|
314
|
+
# },
|
315
|
+
# ],
|
316
|
+
# name: "__string", # required
|
317
|
+
# outputs: [
|
318
|
+
# {
|
319
|
+
# description: "__string",
|
320
|
+
# destination: "__string", # required
|
321
|
+
# encryption: {
|
322
|
+
# algorithm: "aes128", # required, accepts aes128, aes192, aes256
|
323
|
+
# key_type: "static-key", # accepts static-key
|
324
|
+
# role_arn: "__string", # required
|
325
|
+
# secret_arn: "__string", # required
|
326
|
+
# },
|
327
|
+
# max_latency: 1,
|
328
|
+
# name: "__string",
|
329
|
+
# port: 1, # required
|
330
|
+
# protocol: "zixi-push", # required, accepts zixi-push, rtp-fec, rtp
|
331
|
+
# smoothing_latency: 1,
|
332
|
+
# stream_id: "__string",
|
333
|
+
# },
|
334
|
+
# ],
|
335
|
+
# source: { # required
|
336
|
+
# decryption: {
|
337
|
+
# algorithm: "aes128", # required, accepts aes128, aes192, aes256
|
338
|
+
# key_type: "static-key", # accepts static-key
|
339
|
+
# role_arn: "__string", # required
|
340
|
+
# secret_arn: "__string", # required
|
341
|
+
# },
|
342
|
+
# description: "__string",
|
343
|
+
# entitlement_arn: "__string",
|
344
|
+
# ingest_port: 1,
|
345
|
+
# max_bitrate: 1,
|
346
|
+
# max_latency: 1,
|
347
|
+
# name: "__string",
|
348
|
+
# protocol: "zixi-push", # accepts zixi-push, rtp-fec, rtp
|
349
|
+
# stream_id: "__string",
|
350
|
+
# whitelist_cidr: "__string",
|
351
|
+
# },
|
352
|
+
# })
|
353
|
+
#
|
354
|
+
# @example Response structure
|
355
|
+
#
|
356
|
+
# resp.flow.availability_zone #=> String
|
357
|
+
# resp.flow.description #=> String
|
358
|
+
# resp.flow.egress_ip #=> String
|
359
|
+
# resp.flow.entitlements #=> Array
|
360
|
+
# resp.flow.entitlements[0].description #=> String
|
361
|
+
# resp.flow.entitlements[0].encryption.algorithm #=> String, one of "aes128", "aes192", "aes256"
|
362
|
+
# resp.flow.entitlements[0].encryption.key_type #=> String, one of "static-key"
|
363
|
+
# resp.flow.entitlements[0].encryption.role_arn #=> String
|
364
|
+
# resp.flow.entitlements[0].encryption.secret_arn #=> String
|
365
|
+
# resp.flow.entitlements[0].entitlement_arn #=> String
|
366
|
+
# resp.flow.entitlements[0].name #=> String
|
367
|
+
# resp.flow.entitlements[0].subscribers #=> Array
|
368
|
+
# resp.flow.entitlements[0].subscribers[0] #=> String
|
369
|
+
# resp.flow.flow_arn #=> String
|
370
|
+
# resp.flow.name #=> String
|
371
|
+
# resp.flow.outputs #=> Array
|
372
|
+
# resp.flow.outputs[0].description #=> String
|
373
|
+
# resp.flow.outputs[0].destination #=> String
|
374
|
+
# resp.flow.outputs[0].encryption.algorithm #=> String, one of "aes128", "aes192", "aes256"
|
375
|
+
# resp.flow.outputs[0].encryption.key_type #=> String, one of "static-key"
|
376
|
+
# resp.flow.outputs[0].encryption.role_arn #=> String
|
377
|
+
# resp.flow.outputs[0].encryption.secret_arn #=> String
|
378
|
+
# resp.flow.outputs[0].entitlement_arn #=> String
|
379
|
+
# resp.flow.outputs[0].media_live_input_arn #=> String
|
380
|
+
# resp.flow.outputs[0].name #=> String
|
381
|
+
# resp.flow.outputs[0].output_arn #=> String
|
382
|
+
# resp.flow.outputs[0].port #=> Integer
|
383
|
+
# resp.flow.outputs[0].transport.max_bitrate #=> Integer
|
384
|
+
# resp.flow.outputs[0].transport.max_latency #=> Integer
|
385
|
+
# resp.flow.outputs[0].transport.protocol #=> String, one of "zixi-push", "rtp-fec", "rtp"
|
386
|
+
# resp.flow.outputs[0].transport.smoothing_latency #=> Integer
|
387
|
+
# resp.flow.outputs[0].transport.stream_id #=> String
|
388
|
+
# resp.flow.source.decryption.algorithm #=> String, one of "aes128", "aes192", "aes256"
|
389
|
+
# resp.flow.source.decryption.key_type #=> String, one of "static-key"
|
390
|
+
# resp.flow.source.decryption.role_arn #=> String
|
391
|
+
# resp.flow.source.decryption.secret_arn #=> String
|
392
|
+
# resp.flow.source.description #=> String
|
393
|
+
# resp.flow.source.entitlement_arn #=> String
|
394
|
+
# resp.flow.source.ingest_ip #=> String
|
395
|
+
# resp.flow.source.ingest_port #=> Integer
|
396
|
+
# resp.flow.source.name #=> String
|
397
|
+
# resp.flow.source.source_arn #=> String
|
398
|
+
# resp.flow.source.transport.max_bitrate #=> Integer
|
399
|
+
# resp.flow.source.transport.max_latency #=> Integer
|
400
|
+
# resp.flow.source.transport.protocol #=> String, one of "zixi-push", "rtp-fec", "rtp"
|
401
|
+
# resp.flow.source.transport.smoothing_latency #=> Integer
|
402
|
+
# resp.flow.source.transport.stream_id #=> String
|
403
|
+
# resp.flow.source.whitelist_cidr #=> String
|
404
|
+
# resp.flow.status #=> String, one of "STANDBY", "ACTIVE", "UPDATING", "DELETING", "STARTING", "STOPPING", "ERROR"
|
405
|
+
#
|
406
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/mediaconnect-2018-11-14/CreateFlow AWS API Documentation
|
407
|
+
#
|
408
|
+
# @overload create_flow(params = {})
|
409
|
+
# @param [Hash] params ({})
|
410
|
+
def create_flow(params = {}, options = {})
|
411
|
+
req = build_request(:create_flow, params)
|
412
|
+
req.send_request(options)
|
413
|
+
end
|
414
|
+
|
415
|
+
# Deletes a flow. Before you can delete a flow, you must stop the flow.
|
416
|
+
#
|
417
|
+
# @option params [required, String] :flow_arn
|
418
|
+
#
|
419
|
+
# @return [Types::DeleteFlowResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
420
|
+
#
|
421
|
+
# * {Types::DeleteFlowResponse#flow_arn #flow_arn} => String
|
422
|
+
# * {Types::DeleteFlowResponse#status #status} => String
|
423
|
+
#
|
424
|
+
# @example Request syntax with placeholder values
|
425
|
+
#
|
426
|
+
# resp = client.delete_flow({
|
427
|
+
# flow_arn: "__string", # required
|
428
|
+
# })
|
429
|
+
#
|
430
|
+
# @example Response structure
|
431
|
+
#
|
432
|
+
# resp.flow_arn #=> String
|
433
|
+
# resp.status #=> String, one of "STANDBY", "ACTIVE", "UPDATING", "DELETING", "STARTING", "STOPPING", "ERROR"
|
434
|
+
#
|
435
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/mediaconnect-2018-11-14/DeleteFlow AWS API Documentation
|
436
|
+
#
|
437
|
+
# @overload delete_flow(params = {})
|
438
|
+
# @param [Hash] params ({})
|
439
|
+
def delete_flow(params = {}, options = {})
|
440
|
+
req = build_request(:delete_flow, params)
|
441
|
+
req.send_request(options)
|
442
|
+
end
|
443
|
+
|
444
|
+
# Displays the details of a flow. The response includes the flow ARN,
|
445
|
+
# name, and Availability Zone, as well as details about the source,
|
446
|
+
# outputs, and entitlements.
|
447
|
+
#
|
448
|
+
# @option params [required, String] :flow_arn
|
449
|
+
#
|
450
|
+
# @return [Types::DescribeFlowResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
451
|
+
#
|
452
|
+
# * {Types::DescribeFlowResponse#flow #flow} => Types::Flow
|
453
|
+
# * {Types::DescribeFlowResponse#messages #messages} => Types::Messages
|
454
|
+
#
|
455
|
+
# @example Request syntax with placeholder values
|
456
|
+
#
|
457
|
+
# resp = client.describe_flow({
|
458
|
+
# flow_arn: "__string", # required
|
459
|
+
# })
|
460
|
+
#
|
461
|
+
# @example Response structure
|
462
|
+
#
|
463
|
+
# resp.flow.availability_zone #=> String
|
464
|
+
# resp.flow.description #=> String
|
465
|
+
# resp.flow.egress_ip #=> String
|
466
|
+
# resp.flow.entitlements #=> Array
|
467
|
+
# resp.flow.entitlements[0].description #=> String
|
468
|
+
# resp.flow.entitlements[0].encryption.algorithm #=> String, one of "aes128", "aes192", "aes256"
|
469
|
+
# resp.flow.entitlements[0].encryption.key_type #=> String, one of "static-key"
|
470
|
+
# resp.flow.entitlements[0].encryption.role_arn #=> String
|
471
|
+
# resp.flow.entitlements[0].encryption.secret_arn #=> String
|
472
|
+
# resp.flow.entitlements[0].entitlement_arn #=> String
|
473
|
+
# resp.flow.entitlements[0].name #=> String
|
474
|
+
# resp.flow.entitlements[0].subscribers #=> Array
|
475
|
+
# resp.flow.entitlements[0].subscribers[0] #=> String
|
476
|
+
# resp.flow.flow_arn #=> String
|
477
|
+
# resp.flow.name #=> String
|
478
|
+
# resp.flow.outputs #=> Array
|
479
|
+
# resp.flow.outputs[0].description #=> String
|
480
|
+
# resp.flow.outputs[0].destination #=> String
|
481
|
+
# resp.flow.outputs[0].encryption.algorithm #=> String, one of "aes128", "aes192", "aes256"
|
482
|
+
# resp.flow.outputs[0].encryption.key_type #=> String, one of "static-key"
|
483
|
+
# resp.flow.outputs[0].encryption.role_arn #=> String
|
484
|
+
# resp.flow.outputs[0].encryption.secret_arn #=> String
|
485
|
+
# resp.flow.outputs[0].entitlement_arn #=> String
|
486
|
+
# resp.flow.outputs[0].media_live_input_arn #=> String
|
487
|
+
# resp.flow.outputs[0].name #=> String
|
488
|
+
# resp.flow.outputs[0].output_arn #=> String
|
489
|
+
# resp.flow.outputs[0].port #=> Integer
|
490
|
+
# resp.flow.outputs[0].transport.max_bitrate #=> Integer
|
491
|
+
# resp.flow.outputs[0].transport.max_latency #=> Integer
|
492
|
+
# resp.flow.outputs[0].transport.protocol #=> String, one of "zixi-push", "rtp-fec", "rtp"
|
493
|
+
# resp.flow.outputs[0].transport.smoothing_latency #=> Integer
|
494
|
+
# resp.flow.outputs[0].transport.stream_id #=> String
|
495
|
+
# resp.flow.source.decryption.algorithm #=> String, one of "aes128", "aes192", "aes256"
|
496
|
+
# resp.flow.source.decryption.key_type #=> String, one of "static-key"
|
497
|
+
# resp.flow.source.decryption.role_arn #=> String
|
498
|
+
# resp.flow.source.decryption.secret_arn #=> String
|
499
|
+
# resp.flow.source.description #=> String
|
500
|
+
# resp.flow.source.entitlement_arn #=> String
|
501
|
+
# resp.flow.source.ingest_ip #=> String
|
502
|
+
# resp.flow.source.ingest_port #=> Integer
|
503
|
+
# resp.flow.source.name #=> String
|
504
|
+
# resp.flow.source.source_arn #=> String
|
505
|
+
# resp.flow.source.transport.max_bitrate #=> Integer
|
506
|
+
# resp.flow.source.transport.max_latency #=> Integer
|
507
|
+
# resp.flow.source.transport.protocol #=> String, one of "zixi-push", "rtp-fec", "rtp"
|
508
|
+
# resp.flow.source.transport.smoothing_latency #=> Integer
|
509
|
+
# resp.flow.source.transport.stream_id #=> String
|
510
|
+
# resp.flow.source.whitelist_cidr #=> String
|
511
|
+
# resp.flow.status #=> String, one of "STANDBY", "ACTIVE", "UPDATING", "DELETING", "STARTING", "STOPPING", "ERROR"
|
512
|
+
# resp.messages.errors #=> Array
|
513
|
+
# resp.messages.errors[0] #=> String
|
514
|
+
#
|
515
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/mediaconnect-2018-11-14/DescribeFlow AWS API Documentation
|
516
|
+
#
|
517
|
+
# @overload describe_flow(params = {})
|
518
|
+
# @param [Hash] params ({})
|
519
|
+
def describe_flow(params = {}, options = {})
|
520
|
+
req = build_request(:describe_flow, params)
|
521
|
+
req.send_request(options)
|
522
|
+
end
|
523
|
+
|
524
|
+
# Grants entitlements to an existing flow.
|
525
|
+
#
|
526
|
+
# @option params [required, Array<Types::GrantEntitlementRequest>] :entitlements
|
527
|
+
# The list of entitlements that you want to grant.
|
528
|
+
#
|
529
|
+
# @option params [required, String] :flow_arn
|
530
|
+
#
|
531
|
+
# @return [Types::GrantFlowEntitlementsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
532
|
+
#
|
533
|
+
# * {Types::GrantFlowEntitlementsResponse#entitlements #entitlements} => Array<Types::Entitlement>
|
534
|
+
# * {Types::GrantFlowEntitlementsResponse#flow_arn #flow_arn} => String
|
535
|
+
#
|
536
|
+
# @example Request syntax with placeholder values
|
537
|
+
#
|
538
|
+
# resp = client.grant_flow_entitlements({
|
539
|
+
# entitlements: [ # required
|
540
|
+
# {
|
541
|
+
# description: "__string",
|
542
|
+
# encryption: {
|
543
|
+
# algorithm: "aes128", # required, accepts aes128, aes192, aes256
|
544
|
+
# key_type: "static-key", # accepts static-key
|
545
|
+
# role_arn: "__string", # required
|
546
|
+
# secret_arn: "__string", # required
|
547
|
+
# },
|
548
|
+
# name: "__string",
|
549
|
+
# subscribers: ["__string"], # required
|
550
|
+
# },
|
551
|
+
# ],
|
552
|
+
# flow_arn: "__string", # required
|
553
|
+
# })
|
554
|
+
#
|
555
|
+
# @example Response structure
|
556
|
+
#
|
557
|
+
# resp.entitlements #=> Array
|
558
|
+
# resp.entitlements[0].description #=> String
|
559
|
+
# resp.entitlements[0].encryption.algorithm #=> String, one of "aes128", "aes192", "aes256"
|
560
|
+
# resp.entitlements[0].encryption.key_type #=> String, one of "static-key"
|
561
|
+
# resp.entitlements[0].encryption.role_arn #=> String
|
562
|
+
# resp.entitlements[0].encryption.secret_arn #=> String
|
563
|
+
# resp.entitlements[0].entitlement_arn #=> String
|
564
|
+
# resp.entitlements[0].name #=> String
|
565
|
+
# resp.entitlements[0].subscribers #=> Array
|
566
|
+
# resp.entitlements[0].subscribers[0] #=> String
|
567
|
+
# resp.flow_arn #=> String
|
568
|
+
#
|
569
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/mediaconnect-2018-11-14/GrantFlowEntitlements AWS API Documentation
|
570
|
+
#
|
571
|
+
# @overload grant_flow_entitlements(params = {})
|
572
|
+
# @param [Hash] params ({})
|
573
|
+
def grant_flow_entitlements(params = {}, options = {})
|
574
|
+
req = build_request(:grant_flow_entitlements, params)
|
575
|
+
req.send_request(options)
|
576
|
+
end
|
577
|
+
|
578
|
+
# Displays a list of all entitlements that have been granted to this
|
579
|
+
# account. This request returns 20 results per page.
|
580
|
+
#
|
581
|
+
# @option params [Integer] :max_results
|
582
|
+
#
|
583
|
+
# @option params [String] :next_token
|
584
|
+
#
|
585
|
+
# @return [Types::ListEntitlementsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
586
|
+
#
|
587
|
+
# * {Types::ListEntitlementsResponse#entitlements #entitlements} => Array<Types::ListedEntitlement>
|
588
|
+
# * {Types::ListEntitlementsResponse#next_token #next_token} => String
|
589
|
+
#
|
590
|
+
# @example Request syntax with placeholder values
|
591
|
+
#
|
592
|
+
# resp = client.list_entitlements({
|
593
|
+
# max_results: 1,
|
594
|
+
# next_token: "__string",
|
595
|
+
# })
|
596
|
+
#
|
597
|
+
# @example Response structure
|
598
|
+
#
|
599
|
+
# resp.entitlements #=> Array
|
600
|
+
# resp.entitlements[0].entitlement_arn #=> String
|
601
|
+
# resp.entitlements[0].entitlement_name #=> String
|
602
|
+
# resp.next_token #=> String
|
603
|
+
#
|
604
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/mediaconnect-2018-11-14/ListEntitlements AWS API Documentation
|
605
|
+
#
|
606
|
+
# @overload list_entitlements(params = {})
|
607
|
+
# @param [Hash] params ({})
|
608
|
+
def list_entitlements(params = {}, options = {})
|
609
|
+
req = build_request(:list_entitlements, params)
|
610
|
+
req.send_request(options)
|
611
|
+
end
|
612
|
+
|
613
|
+
# Displays a list of flows that are associated with this account. This
|
614
|
+
# request returns a paginated result.
|
615
|
+
#
|
616
|
+
# @option params [Integer] :max_results
|
617
|
+
#
|
618
|
+
# @option params [String] :next_token
|
619
|
+
#
|
620
|
+
# @return [Types::ListFlowsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
621
|
+
#
|
622
|
+
# * {Types::ListFlowsResponse#flows #flows} => Array<Types::ListedFlow>
|
623
|
+
# * {Types::ListFlowsResponse#next_token #next_token} => String
|
624
|
+
#
|
625
|
+
# @example Request syntax with placeholder values
|
626
|
+
#
|
627
|
+
# resp = client.list_flows({
|
628
|
+
# max_results: 1,
|
629
|
+
# next_token: "__string",
|
630
|
+
# })
|
631
|
+
#
|
632
|
+
# @example Response structure
|
633
|
+
#
|
634
|
+
# resp.flows #=> Array
|
635
|
+
# resp.flows[0].availability_zone #=> String
|
636
|
+
# resp.flows[0].description #=> String
|
637
|
+
# resp.flows[0].flow_arn #=> String
|
638
|
+
# resp.flows[0].name #=> String
|
639
|
+
# resp.flows[0].source_type #=> String, one of "OWNED", "ENTITLED"
|
640
|
+
# resp.flows[0].status #=> String, one of "STANDBY", "ACTIVE", "UPDATING", "DELETING", "STARTING", "STOPPING", "ERROR"
|
641
|
+
# resp.next_token #=> String
|
642
|
+
#
|
643
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/mediaconnect-2018-11-14/ListFlows AWS API Documentation
|
644
|
+
#
|
645
|
+
# @overload list_flows(params = {})
|
646
|
+
# @param [Hash] params ({})
|
647
|
+
def list_flows(params = {}, options = {})
|
648
|
+
req = build_request(:list_flows, params)
|
649
|
+
req.send_request(options)
|
650
|
+
end
|
651
|
+
|
652
|
+
# Removes an output from an existing flow. This request can be made only
|
653
|
+
# on an output that does not have an entitlement associated with it. If
|
654
|
+
# the output has an entitlement, you must revoke the entitlement
|
655
|
+
# instead. When an entitlement is revoked from a flow, the service
|
656
|
+
# automatically removes the associated output.
|
657
|
+
#
|
658
|
+
# @option params [required, String] :flow_arn
|
659
|
+
#
|
660
|
+
# @option params [required, String] :output_arn
|
661
|
+
#
|
662
|
+
# @return [Types::RemoveFlowOutputResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
663
|
+
#
|
664
|
+
# * {Types::RemoveFlowOutputResponse#flow_arn #flow_arn} => String
|
665
|
+
# * {Types::RemoveFlowOutputResponse#output_arn #output_arn} => String
|
666
|
+
#
|
667
|
+
# @example Request syntax with placeholder values
|
668
|
+
#
|
669
|
+
# resp = client.remove_flow_output({
|
670
|
+
# flow_arn: "__string", # required
|
671
|
+
# output_arn: "__string", # required
|
672
|
+
# })
|
673
|
+
#
|
674
|
+
# @example Response structure
|
675
|
+
#
|
676
|
+
# resp.flow_arn #=> String
|
677
|
+
# resp.output_arn #=> String
|
678
|
+
#
|
679
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/mediaconnect-2018-11-14/RemoveFlowOutput AWS API Documentation
|
680
|
+
#
|
681
|
+
# @overload remove_flow_output(params = {})
|
682
|
+
# @param [Hash] params ({})
|
683
|
+
def remove_flow_output(params = {}, options = {})
|
684
|
+
req = build_request(:remove_flow_output, params)
|
685
|
+
req.send_request(options)
|
686
|
+
end
|
687
|
+
|
688
|
+
# Revokes an entitlement from a flow. Once an entitlement is revoked,
|
689
|
+
# the content becomes unavailable to the subscriber and the associated
|
690
|
+
# output is removed.
|
691
|
+
#
|
692
|
+
# @option params [required, String] :entitlement_arn
|
693
|
+
#
|
694
|
+
# @option params [required, String] :flow_arn
|
695
|
+
#
|
696
|
+
# @return [Types::RevokeFlowEntitlementResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
697
|
+
#
|
698
|
+
# * {Types::RevokeFlowEntitlementResponse#entitlement_arn #entitlement_arn} => String
|
699
|
+
# * {Types::RevokeFlowEntitlementResponse#flow_arn #flow_arn} => String
|
700
|
+
#
|
701
|
+
# @example Request syntax with placeholder values
|
702
|
+
#
|
703
|
+
# resp = client.revoke_flow_entitlement({
|
704
|
+
# entitlement_arn: "__string", # required
|
705
|
+
# flow_arn: "__string", # required
|
706
|
+
# })
|
707
|
+
#
|
708
|
+
# @example Response structure
|
709
|
+
#
|
710
|
+
# resp.entitlement_arn #=> String
|
711
|
+
# resp.flow_arn #=> String
|
712
|
+
#
|
713
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/mediaconnect-2018-11-14/RevokeFlowEntitlement AWS API Documentation
|
714
|
+
#
|
715
|
+
# @overload revoke_flow_entitlement(params = {})
|
716
|
+
# @param [Hash] params ({})
|
717
|
+
def revoke_flow_entitlement(params = {}, options = {})
|
718
|
+
req = build_request(:revoke_flow_entitlement, params)
|
719
|
+
req.send_request(options)
|
720
|
+
end
|
721
|
+
|
722
|
+
# Starts a flow.
|
723
|
+
#
|
724
|
+
# @option params [required, String] :flow_arn
|
725
|
+
#
|
726
|
+
# @return [Types::StartFlowResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
727
|
+
#
|
728
|
+
# * {Types::StartFlowResponse#flow_arn #flow_arn} => String
|
729
|
+
# * {Types::StartFlowResponse#status #status} => String
|
730
|
+
#
|
731
|
+
# @example Request syntax with placeholder values
|
732
|
+
#
|
733
|
+
# resp = client.start_flow({
|
734
|
+
# flow_arn: "__string", # required
|
735
|
+
# })
|
736
|
+
#
|
737
|
+
# @example Response structure
|
738
|
+
#
|
739
|
+
# resp.flow_arn #=> String
|
740
|
+
# resp.status #=> String, one of "STANDBY", "ACTIVE", "UPDATING", "DELETING", "STARTING", "STOPPING", "ERROR"
|
741
|
+
#
|
742
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/mediaconnect-2018-11-14/StartFlow AWS API Documentation
|
743
|
+
#
|
744
|
+
# @overload start_flow(params = {})
|
745
|
+
# @param [Hash] params ({})
|
746
|
+
def start_flow(params = {}, options = {})
|
747
|
+
req = build_request(:start_flow, params)
|
748
|
+
req.send_request(options)
|
749
|
+
end
|
750
|
+
|
751
|
+
# Stops a flow.
|
752
|
+
#
|
753
|
+
# @option params [required, String] :flow_arn
|
754
|
+
#
|
755
|
+
# @return [Types::StopFlowResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
756
|
+
#
|
757
|
+
# * {Types::StopFlowResponse#flow_arn #flow_arn} => String
|
758
|
+
# * {Types::StopFlowResponse#status #status} => String
|
759
|
+
#
|
760
|
+
# @example Request syntax with placeholder values
|
761
|
+
#
|
762
|
+
# resp = client.stop_flow({
|
763
|
+
# flow_arn: "__string", # required
|
764
|
+
# })
|
765
|
+
#
|
766
|
+
# @example Response structure
|
767
|
+
#
|
768
|
+
# resp.flow_arn #=> String
|
769
|
+
# resp.status #=> String, one of "STANDBY", "ACTIVE", "UPDATING", "DELETING", "STARTING", "STOPPING", "ERROR"
|
770
|
+
#
|
771
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/mediaconnect-2018-11-14/StopFlow AWS API Documentation
|
772
|
+
#
|
773
|
+
# @overload stop_flow(params = {})
|
774
|
+
# @param [Hash] params ({})
|
775
|
+
def stop_flow(params = {}, options = {})
|
776
|
+
req = build_request(:stop_flow, params)
|
777
|
+
req.send_request(options)
|
778
|
+
end
|
779
|
+
|
780
|
+
# You can change an entitlement's description, subscribers, and
|
781
|
+
# encryption. If you change the subscribers, the service will remove the
|
782
|
+
# outputs that are are used by the subscribers that are removed.
|
783
|
+
#
|
784
|
+
# @option params [String] :description
|
785
|
+
# A description of the entitlement. This description appears only on the
|
786
|
+
# AWS Elemental MediaConnect console and will not be seen by the
|
787
|
+
# subscriber or end user.
|
788
|
+
#
|
789
|
+
# @option params [Types::UpdateEncryption] :encryption
|
790
|
+
# The type of encryption that will be used on the output associated with
|
791
|
+
# this entitlement.
|
792
|
+
#
|
793
|
+
# @option params [required, String] :entitlement_arn
|
794
|
+
#
|
795
|
+
# @option params [required, String] :flow_arn
|
796
|
+
#
|
797
|
+
# @option params [Array<String>] :subscribers
|
798
|
+
# The AWS account IDs that you want to share your content with. The
|
799
|
+
# receiving accounts (subscribers) will be allowed to create their own
|
800
|
+
# flow using your content as the source.
|
801
|
+
#
|
802
|
+
# @return [Types::UpdateFlowEntitlementResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
803
|
+
#
|
804
|
+
# * {Types::UpdateFlowEntitlementResponse#entitlement #entitlement} => Types::Entitlement
|
805
|
+
# * {Types::UpdateFlowEntitlementResponse#flow_arn #flow_arn} => String
|
806
|
+
#
|
807
|
+
# @example Request syntax with placeholder values
|
808
|
+
#
|
809
|
+
# resp = client.update_flow_entitlement({
|
810
|
+
# description: "__string",
|
811
|
+
# encryption: {
|
812
|
+
# algorithm: "aes128", # accepts aes128, aes192, aes256
|
813
|
+
# key_type: "static-key", # accepts static-key
|
814
|
+
# role_arn: "__string",
|
815
|
+
# secret_arn: "__string",
|
816
|
+
# },
|
817
|
+
# entitlement_arn: "__string", # required
|
818
|
+
# flow_arn: "__string", # required
|
819
|
+
# subscribers: ["__string"],
|
820
|
+
# })
|
821
|
+
#
|
822
|
+
# @example Response structure
|
823
|
+
#
|
824
|
+
# resp.entitlement.description #=> String
|
825
|
+
# resp.entitlement.encryption.algorithm #=> String, one of "aes128", "aes192", "aes256"
|
826
|
+
# resp.entitlement.encryption.key_type #=> String, one of "static-key"
|
827
|
+
# resp.entitlement.encryption.role_arn #=> String
|
828
|
+
# resp.entitlement.encryption.secret_arn #=> String
|
829
|
+
# resp.entitlement.entitlement_arn #=> String
|
830
|
+
# resp.entitlement.name #=> String
|
831
|
+
# resp.entitlement.subscribers #=> Array
|
832
|
+
# resp.entitlement.subscribers[0] #=> String
|
833
|
+
# resp.flow_arn #=> String
|
834
|
+
#
|
835
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/mediaconnect-2018-11-14/UpdateFlowEntitlement AWS API Documentation
|
836
|
+
#
|
837
|
+
# @overload update_flow_entitlement(params = {})
|
838
|
+
# @param [Hash] params ({})
|
839
|
+
def update_flow_entitlement(params = {}, options = {})
|
840
|
+
req = build_request(:update_flow_entitlement, params)
|
841
|
+
req.send_request(options)
|
842
|
+
end
|
843
|
+
|
844
|
+
# Updates an existing flow output.
|
845
|
+
#
|
846
|
+
# @option params [String] :description
|
847
|
+
# A description of the output. This description appears only on the AWS
|
848
|
+
# Elemental MediaConnect console and will not be seen by the end user.
|
849
|
+
#
|
850
|
+
# @option params [String] :destination
|
851
|
+
# The IP address where you want to send the output.
|
852
|
+
#
|
853
|
+
# @option params [Types::UpdateEncryption] :encryption
|
854
|
+
# The type of key used for the encryption. If no keyType is provided,
|
855
|
+
# the service will use the default setting (static-key).
|
856
|
+
#
|
857
|
+
# @option params [required, String] :flow_arn
|
858
|
+
#
|
859
|
+
# @option params [Integer] :max_latency
|
860
|
+
# The maximum latency in milliseconds for Zixi-based streams.
|
861
|
+
#
|
862
|
+
# @option params [required, String] :output_arn
|
863
|
+
#
|
864
|
+
# @option params [Integer] :port
|
865
|
+
# The port to use when content is distributed to this output.
|
866
|
+
#
|
867
|
+
# @option params [String] :protocol
|
868
|
+
# The protocol to use for the output.
|
869
|
+
#
|
870
|
+
# @option params [Integer] :smoothing_latency
|
871
|
+
# The smoothing latency in milliseconds for RTP and RTP-FEC streams.
|
872
|
+
#
|
873
|
+
# @option params [String] :stream_id
|
874
|
+
# The stream ID that you want to use for this transport. This parameter
|
875
|
+
# applies only to Zixi-based streams.
|
876
|
+
#
|
877
|
+
# @return [Types::UpdateFlowOutputResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
878
|
+
#
|
879
|
+
# * {Types::UpdateFlowOutputResponse#flow_arn #flow_arn} => String
|
880
|
+
# * {Types::UpdateFlowOutputResponse#output #output} => Types::Output
|
881
|
+
#
|
882
|
+
# @example Request syntax with placeholder values
|
883
|
+
#
|
884
|
+
# resp = client.update_flow_output({
|
885
|
+
# description: "__string",
|
886
|
+
# destination: "__string",
|
887
|
+
# encryption: {
|
888
|
+
# algorithm: "aes128", # accepts aes128, aes192, aes256
|
889
|
+
# key_type: "static-key", # accepts static-key
|
890
|
+
# role_arn: "__string",
|
891
|
+
# secret_arn: "__string",
|
892
|
+
# },
|
893
|
+
# flow_arn: "__string", # required
|
894
|
+
# max_latency: 1,
|
895
|
+
# output_arn: "__string", # required
|
896
|
+
# port: 1,
|
897
|
+
# protocol: "zixi-push", # accepts zixi-push, rtp-fec, rtp
|
898
|
+
# smoothing_latency: 1,
|
899
|
+
# stream_id: "__string",
|
900
|
+
# })
|
901
|
+
#
|
902
|
+
# @example Response structure
|
903
|
+
#
|
904
|
+
# resp.flow_arn #=> String
|
905
|
+
# resp.output.description #=> String
|
906
|
+
# resp.output.destination #=> String
|
907
|
+
# resp.output.encryption.algorithm #=> String, one of "aes128", "aes192", "aes256"
|
908
|
+
# resp.output.encryption.key_type #=> String, one of "static-key"
|
909
|
+
# resp.output.encryption.role_arn #=> String
|
910
|
+
# resp.output.encryption.secret_arn #=> String
|
911
|
+
# resp.output.entitlement_arn #=> String
|
912
|
+
# resp.output.media_live_input_arn #=> String
|
913
|
+
# resp.output.name #=> String
|
914
|
+
# resp.output.output_arn #=> String
|
915
|
+
# resp.output.port #=> Integer
|
916
|
+
# resp.output.transport.max_bitrate #=> Integer
|
917
|
+
# resp.output.transport.max_latency #=> Integer
|
918
|
+
# resp.output.transport.protocol #=> String, one of "zixi-push", "rtp-fec", "rtp"
|
919
|
+
# resp.output.transport.smoothing_latency #=> Integer
|
920
|
+
# resp.output.transport.stream_id #=> String
|
921
|
+
#
|
922
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/mediaconnect-2018-11-14/UpdateFlowOutput AWS API Documentation
|
923
|
+
#
|
924
|
+
# @overload update_flow_output(params = {})
|
925
|
+
# @param [Hash] params ({})
|
926
|
+
def update_flow_output(params = {}, options = {})
|
927
|
+
req = build_request(:update_flow_output, params)
|
928
|
+
req.send_request(options)
|
929
|
+
end
|
930
|
+
|
931
|
+
# Updates the source of a flow.
|
932
|
+
#
|
933
|
+
# @option params [Types::UpdateEncryption] :decryption
|
934
|
+
# The type of encryption used on the content ingested from this source.
|
935
|
+
#
|
936
|
+
# @option params [String] :description
|
937
|
+
# A description for the source. This value is not used or seen outside
|
938
|
+
# of the current AWS Elemental MediaConnect account.
|
939
|
+
#
|
940
|
+
# @option params [String] :entitlement_arn
|
941
|
+
# The ARN of the entitlement that allows you to subscribe to this flow.
|
942
|
+
# The entitlement is set by the flow originator, and the ARN is
|
943
|
+
# generated as part of the originator's flow.
|
944
|
+
#
|
945
|
+
# @option params [required, String] :flow_arn
|
946
|
+
#
|
947
|
+
# @option params [Integer] :ingest_port
|
948
|
+
# The port that the flow will be listening on for incoming content.
|
949
|
+
#
|
950
|
+
# @option params [Integer] :max_bitrate
|
951
|
+
# The smoothing max bitrate for RTP and RTP-FEC streams.
|
952
|
+
#
|
953
|
+
# @option params [Integer] :max_latency
|
954
|
+
# The maximum latency in milliseconds for Zixi-based streams.
|
955
|
+
#
|
956
|
+
# @option params [String] :protocol
|
957
|
+
# The protocol that is used by the source.
|
958
|
+
#
|
959
|
+
# @option params [required, String] :source_arn
|
960
|
+
#
|
961
|
+
# @option params [String] :stream_id
|
962
|
+
# The stream ID that you want to use for this transport. This parameter
|
963
|
+
# applies only to Zixi-based streams.
|
964
|
+
#
|
965
|
+
# @option params [String] :whitelist_cidr
|
966
|
+
# The range of IP addresses that should be allowed to contribute content
|
967
|
+
# to your source. These IP addresses should in the form of a Classless
|
968
|
+
# Inter-Domain Routing (CIDR) block; for example, 10.0.0.0/16.
|
969
|
+
#
|
970
|
+
# @return [Types::UpdateFlowSourceResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
971
|
+
#
|
972
|
+
# * {Types::UpdateFlowSourceResponse#flow_arn #flow_arn} => String
|
973
|
+
# * {Types::UpdateFlowSourceResponse#source #source} => Types::Source
|
974
|
+
#
|
975
|
+
# @example Request syntax with placeholder values
|
976
|
+
#
|
977
|
+
# resp = client.update_flow_source({
|
978
|
+
# decryption: {
|
979
|
+
# algorithm: "aes128", # accepts aes128, aes192, aes256
|
980
|
+
# key_type: "static-key", # accepts static-key
|
981
|
+
# role_arn: "__string",
|
982
|
+
# secret_arn: "__string",
|
983
|
+
# },
|
984
|
+
# description: "__string",
|
985
|
+
# entitlement_arn: "__string",
|
986
|
+
# flow_arn: "__string", # required
|
987
|
+
# ingest_port: 1,
|
988
|
+
# max_bitrate: 1,
|
989
|
+
# max_latency: 1,
|
990
|
+
# protocol: "zixi-push", # accepts zixi-push, rtp-fec, rtp
|
991
|
+
# source_arn: "__string", # required
|
992
|
+
# stream_id: "__string",
|
993
|
+
# whitelist_cidr: "__string",
|
994
|
+
# })
|
995
|
+
#
|
996
|
+
# @example Response structure
|
997
|
+
#
|
998
|
+
# resp.flow_arn #=> String
|
999
|
+
# resp.source.decryption.algorithm #=> String, one of "aes128", "aes192", "aes256"
|
1000
|
+
# resp.source.decryption.key_type #=> String, one of "static-key"
|
1001
|
+
# resp.source.decryption.role_arn #=> String
|
1002
|
+
# resp.source.decryption.secret_arn #=> String
|
1003
|
+
# resp.source.description #=> String
|
1004
|
+
# resp.source.entitlement_arn #=> String
|
1005
|
+
# resp.source.ingest_ip #=> String
|
1006
|
+
# resp.source.ingest_port #=> Integer
|
1007
|
+
# resp.source.name #=> String
|
1008
|
+
# resp.source.source_arn #=> String
|
1009
|
+
# resp.source.transport.max_bitrate #=> Integer
|
1010
|
+
# resp.source.transport.max_latency #=> Integer
|
1011
|
+
# resp.source.transport.protocol #=> String, one of "zixi-push", "rtp-fec", "rtp"
|
1012
|
+
# resp.source.transport.smoothing_latency #=> Integer
|
1013
|
+
# resp.source.transport.stream_id #=> String
|
1014
|
+
# resp.source.whitelist_cidr #=> String
|
1015
|
+
#
|
1016
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/mediaconnect-2018-11-14/UpdateFlowSource AWS API Documentation
|
1017
|
+
#
|
1018
|
+
# @overload update_flow_source(params = {})
|
1019
|
+
# @param [Hash] params ({})
|
1020
|
+
def update_flow_source(params = {}, options = {})
|
1021
|
+
req = build_request(:update_flow_source, params)
|
1022
|
+
req.send_request(options)
|
1023
|
+
end
|
1024
|
+
|
1025
|
+
# @!endgroup
|
1026
|
+
|
1027
|
+
# @param params ({})
|
1028
|
+
# @api private
|
1029
|
+
def build_request(operation_name, params = {})
|
1030
|
+
handlers = @handlers.for(operation_name)
|
1031
|
+
context = Seahorse::Client::RequestContext.new(
|
1032
|
+
operation_name: operation_name,
|
1033
|
+
operation: config.api.operation(operation_name),
|
1034
|
+
client: self,
|
1035
|
+
params: params,
|
1036
|
+
config: config)
|
1037
|
+
context[:gem_name] = 'aws-sdk-mediaconnect'
|
1038
|
+
context[:gem_version] = '1.0.0'
|
1039
|
+
Seahorse::Client::Request.new(handlers, context)
|
1040
|
+
end
|
1041
|
+
|
1042
|
+
# @api private
|
1043
|
+
# @deprecated
|
1044
|
+
def waiter_names
|
1045
|
+
[]
|
1046
|
+
end
|
1047
|
+
|
1048
|
+
class << self
|
1049
|
+
|
1050
|
+
# @api private
|
1051
|
+
attr_reader :identifier
|
1052
|
+
|
1053
|
+
# @api private
|
1054
|
+
def errors_module
|
1055
|
+
Errors
|
1056
|
+
end
|
1057
|
+
|
1058
|
+
end
|
1059
|
+
end
|
1060
|
+
end
|