aws-sdk-chimesdkmediapipelines 1.0.0

Sign up to get free protection for your applications and to get access to all the features.
@@ -0,0 +1,684 @@
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/version-3/CONTRIBUTING.md
7
+ #
8
+ # WARNING ABOUT GENERATED CODE
9
+
10
+ require 'seahorse/client/plugins/content_length.rb'
11
+ require 'aws-sdk-core/plugins/credentials_configuration.rb'
12
+ require 'aws-sdk-core/plugins/logging.rb'
13
+ require 'aws-sdk-core/plugins/param_converter.rb'
14
+ require 'aws-sdk-core/plugins/param_validator.rb'
15
+ require 'aws-sdk-core/plugins/user_agent.rb'
16
+ require 'aws-sdk-core/plugins/helpful_socket_errors.rb'
17
+ require 'aws-sdk-core/plugins/retry_errors.rb'
18
+ require 'aws-sdk-core/plugins/global_configuration.rb'
19
+ require 'aws-sdk-core/plugins/regional_endpoint.rb'
20
+ require 'aws-sdk-core/plugins/endpoint_discovery.rb'
21
+ require 'aws-sdk-core/plugins/endpoint_pattern.rb'
22
+ require 'aws-sdk-core/plugins/response_paging.rb'
23
+ require 'aws-sdk-core/plugins/stub_responses.rb'
24
+ require 'aws-sdk-core/plugins/idempotency_token.rb'
25
+ require 'aws-sdk-core/plugins/jsonvalue_converter.rb'
26
+ require 'aws-sdk-core/plugins/client_metrics_plugin.rb'
27
+ require 'aws-sdk-core/plugins/client_metrics_send_plugin.rb'
28
+ require 'aws-sdk-core/plugins/transfer_encoding.rb'
29
+ require 'aws-sdk-core/plugins/http_checksum.rb'
30
+ require 'aws-sdk-core/plugins/checksum_algorithm.rb'
31
+ require 'aws-sdk-core/plugins/defaults_mode.rb'
32
+ require 'aws-sdk-core/plugins/recursion_detection.rb'
33
+ require 'aws-sdk-core/plugins/signature_v4.rb'
34
+ require 'aws-sdk-core/plugins/protocols/rest_json.rb'
35
+
36
+ Aws::Plugins::GlobalConfiguration.add_identifier(:chimesdkmediapipelines)
37
+
38
+ module Aws::ChimeSDKMediaPipelines
39
+ # An API client for ChimeSDKMediaPipelines. To construct a client, you need to configure a `:region` and `:credentials`.
40
+ #
41
+ # client = Aws::ChimeSDKMediaPipelines::Client.new(
42
+ # region: region_name,
43
+ # credentials: credentials,
44
+ # # ...
45
+ # )
46
+ #
47
+ # For details on configuring region and credentials see
48
+ # the [developer guide](/sdk-for-ruby/v3/developer-guide/setup-config.html).
49
+ #
50
+ # See {#initialize} for a full list of supported configuration options.
51
+ class Client < Seahorse::Client::Base
52
+
53
+ include Aws::ClientStubs
54
+
55
+ @identifier = :chimesdkmediapipelines
56
+
57
+ set_api(ClientApi::API)
58
+
59
+ add_plugin(Seahorse::Client::Plugins::ContentLength)
60
+ add_plugin(Aws::Plugins::CredentialsConfiguration)
61
+ add_plugin(Aws::Plugins::Logging)
62
+ add_plugin(Aws::Plugins::ParamConverter)
63
+ add_plugin(Aws::Plugins::ParamValidator)
64
+ add_plugin(Aws::Plugins::UserAgent)
65
+ add_plugin(Aws::Plugins::HelpfulSocketErrors)
66
+ add_plugin(Aws::Plugins::RetryErrors)
67
+ add_plugin(Aws::Plugins::GlobalConfiguration)
68
+ add_plugin(Aws::Plugins::RegionalEndpoint)
69
+ add_plugin(Aws::Plugins::EndpointDiscovery)
70
+ add_plugin(Aws::Plugins::EndpointPattern)
71
+ add_plugin(Aws::Plugins::ResponsePaging)
72
+ add_plugin(Aws::Plugins::StubResponses)
73
+ add_plugin(Aws::Plugins::IdempotencyToken)
74
+ add_plugin(Aws::Plugins::JsonvalueConverter)
75
+ add_plugin(Aws::Plugins::ClientMetricsPlugin)
76
+ add_plugin(Aws::Plugins::ClientMetricsSendPlugin)
77
+ add_plugin(Aws::Plugins::TransferEncoding)
78
+ add_plugin(Aws::Plugins::HttpChecksum)
79
+ add_plugin(Aws::Plugins::ChecksumAlgorithm)
80
+ add_plugin(Aws::Plugins::DefaultsMode)
81
+ add_plugin(Aws::Plugins::RecursionDetection)
82
+ add_plugin(Aws::Plugins::SignatureV4)
83
+ add_plugin(Aws::Plugins::Protocols::RestJson)
84
+
85
+ # @overload initialize(options)
86
+ # @param [Hash] options
87
+ # @option options [required, Aws::CredentialProvider] :credentials
88
+ # Your AWS credentials. This can be an instance of any one of the
89
+ # following classes:
90
+ #
91
+ # * `Aws::Credentials` - Used for configuring static, non-refreshing
92
+ # credentials.
93
+ #
94
+ # * `Aws::SharedCredentials` - Used for loading static credentials from a
95
+ # shared file, such as `~/.aws/config`.
96
+ #
97
+ # * `Aws::AssumeRoleCredentials` - Used when you need to assume a role.
98
+ #
99
+ # * `Aws::AssumeRoleWebIdentityCredentials` - Used when you need to
100
+ # assume a role after providing credentials via the web.
101
+ #
102
+ # * `Aws::SSOCredentials` - Used for loading credentials from AWS SSO using an
103
+ # access token generated from `aws login`.
104
+ #
105
+ # * `Aws::ProcessCredentials` - Used for loading credentials from a
106
+ # process that outputs to stdout.
107
+ #
108
+ # * `Aws::InstanceProfileCredentials` - Used for loading credentials
109
+ # from an EC2 IMDS on an EC2 instance.
110
+ #
111
+ # * `Aws::ECSCredentials` - Used for loading credentials from
112
+ # instances running in ECS.
113
+ #
114
+ # * `Aws::CognitoIdentityCredentials` - Used for loading credentials
115
+ # from the Cognito Identity service.
116
+ #
117
+ # When `:credentials` are not configured directly, the following
118
+ # locations will be searched for credentials:
119
+ #
120
+ # * `Aws.config[:credentials]`
121
+ # * The `:access_key_id`, `:secret_access_key`, and `:session_token` options.
122
+ # * ENV['AWS_ACCESS_KEY_ID'], ENV['AWS_SECRET_ACCESS_KEY']
123
+ # * `~/.aws/credentials`
124
+ # * `~/.aws/config`
125
+ # * EC2/ECS IMDS instance profile - When used by default, the timeouts
126
+ # are very aggressive. Construct and pass an instance of
127
+ # `Aws::InstanceProfileCredentails` or `Aws::ECSCredentials` to
128
+ # enable retries and extended timeouts. Instance profile credential
129
+ # fetching can be disabled by setting ENV['AWS_EC2_METADATA_DISABLED']
130
+ # to true.
131
+ #
132
+ # @option options [required, String] :region
133
+ # The AWS region to connect to. The configured `:region` is
134
+ # used to determine the service `:endpoint`. When not passed,
135
+ # a default `:region` is searched for in the following locations:
136
+ #
137
+ # * `Aws.config[:region]`
138
+ # * `ENV['AWS_REGION']`
139
+ # * `ENV['AMAZON_REGION']`
140
+ # * `ENV['AWS_DEFAULT_REGION']`
141
+ # * `~/.aws/credentials`
142
+ # * `~/.aws/config`
143
+ #
144
+ # @option options [String] :access_key_id
145
+ #
146
+ # @option options [Boolean] :active_endpoint_cache (false)
147
+ # When set to `true`, a thread polling for endpoints will be running in
148
+ # the background every 60 secs (default). Defaults to `false`.
149
+ #
150
+ # @option options [Boolean] :adaptive_retry_wait_to_fill (true)
151
+ # Used only in `adaptive` retry mode. When true, the request will sleep
152
+ # until there is sufficent client side capacity to retry the request.
153
+ # When false, the request will raise a `RetryCapacityNotAvailableError` and will
154
+ # not retry instead of sleeping.
155
+ #
156
+ # @option options [Boolean] :client_side_monitoring (false)
157
+ # When `true`, client-side metrics will be collected for all API requests from
158
+ # this client.
159
+ #
160
+ # @option options [String] :client_side_monitoring_client_id ("")
161
+ # Allows you to provide an identifier for this client which will be attached to
162
+ # all generated client side metrics. Defaults to an empty string.
163
+ #
164
+ # @option options [String] :client_side_monitoring_host ("127.0.0.1")
165
+ # Allows you to specify the DNS hostname or IPv4 or IPv6 address that the client
166
+ # side monitoring agent is running on, where client metrics will be published via UDP.
167
+ #
168
+ # @option options [Integer] :client_side_monitoring_port (31000)
169
+ # Required for publishing client metrics. The port that the client side monitoring
170
+ # agent is running on, where client metrics will be published via UDP.
171
+ #
172
+ # @option options [Aws::ClientSideMonitoring::Publisher] :client_side_monitoring_publisher (Aws::ClientSideMonitoring::Publisher)
173
+ # Allows you to provide a custom client-side monitoring publisher class. By default,
174
+ # will use the Client Side Monitoring Agent Publisher.
175
+ #
176
+ # @option options [Boolean] :convert_params (true)
177
+ # When `true`, an attempt is made to coerce request parameters into
178
+ # the required types.
179
+ #
180
+ # @option options [Boolean] :correct_clock_skew (true)
181
+ # Used only in `standard` and adaptive retry modes. Specifies whether to apply
182
+ # a clock skew correction and retry requests with skewed client clocks.
183
+ #
184
+ # @option options [String] :defaults_mode ("legacy")
185
+ # See {Aws::DefaultsModeConfiguration} for a list of the
186
+ # accepted modes and the configuration defaults that are included.
187
+ #
188
+ # @option options [Boolean] :disable_host_prefix_injection (false)
189
+ # Set to true to disable SDK automatically adding host prefix
190
+ # to default service endpoint when available.
191
+ #
192
+ # @option options [String] :endpoint
193
+ # The client endpoint is normally constructed from the `:region`
194
+ # option. You should only configure an `:endpoint` when connecting
195
+ # to test or custom endpoints. This should be a valid HTTP(S) URI.
196
+ #
197
+ # @option options [Integer] :endpoint_cache_max_entries (1000)
198
+ # Used for the maximum size limit of the LRU cache storing endpoints data
199
+ # for endpoint discovery enabled operations. Defaults to 1000.
200
+ #
201
+ # @option options [Integer] :endpoint_cache_max_threads (10)
202
+ # Used for the maximum threads in use for polling endpoints to be cached, defaults to 10.
203
+ #
204
+ # @option options [Integer] :endpoint_cache_poll_interval (60)
205
+ # When :endpoint_discovery and :active_endpoint_cache is enabled,
206
+ # Use this option to config the time interval in seconds for making
207
+ # requests fetching endpoints information. Defaults to 60 sec.
208
+ #
209
+ # @option options [Boolean] :endpoint_discovery (false)
210
+ # When set to `true`, endpoint discovery will be enabled for operations when available.
211
+ #
212
+ # @option options [Aws::Log::Formatter] :log_formatter (Aws::Log::Formatter.default)
213
+ # The log formatter.
214
+ #
215
+ # @option options [Symbol] :log_level (:info)
216
+ # The log level to send messages to the `:logger` at.
217
+ #
218
+ # @option options [Logger] :logger
219
+ # The Logger instance to send log messages to. If this option
220
+ # is not set, logging will be disabled.
221
+ #
222
+ # @option options [Integer] :max_attempts (3)
223
+ # An integer representing the maximum number attempts that will be made for
224
+ # a single request, including the initial attempt. For example,
225
+ # setting this value to 5 will result in a request being retried up to
226
+ # 4 times. Used in `standard` and `adaptive` retry modes.
227
+ #
228
+ # @option options [String] :profile ("default")
229
+ # Used when loading credentials from the shared credentials file
230
+ # at HOME/.aws/credentials. When not specified, 'default' is used.
231
+ #
232
+ # @option options [Proc] :retry_backoff
233
+ # A proc or lambda used for backoff. Defaults to 2**retries * retry_base_delay.
234
+ # This option is only used in the `legacy` retry mode.
235
+ #
236
+ # @option options [Float] :retry_base_delay (0.3)
237
+ # The base delay in seconds used by the default backoff function. This option
238
+ # is only used in the `legacy` retry mode.
239
+ #
240
+ # @option options [Symbol] :retry_jitter (:none)
241
+ # A delay randomiser function used by the default backoff function.
242
+ # Some predefined functions can be referenced by name - :none, :equal, :full,
243
+ # otherwise a Proc that takes and returns a number. This option is only used
244
+ # in the `legacy` retry mode.
245
+ #
246
+ # @see https://www.awsarchitectureblog.com/2015/03/backoff.html
247
+ #
248
+ # @option options [Integer] :retry_limit (3)
249
+ # The maximum number of times to retry failed requests. Only
250
+ # ~ 500 level server errors and certain ~ 400 level client errors
251
+ # are retried. Generally, these are throttling errors, data
252
+ # checksum errors, networking errors, timeout errors, auth errors,
253
+ # endpoint discovery, and errors from expired credentials.
254
+ # This option is only used in the `legacy` retry mode.
255
+ #
256
+ # @option options [Integer] :retry_max_delay (0)
257
+ # The maximum number of seconds to delay between retries (0 for no limit)
258
+ # used by the default backoff function. This option is only used in the
259
+ # `legacy` retry mode.
260
+ #
261
+ # @option options [String] :retry_mode ("legacy")
262
+ # Specifies which retry algorithm to use. Values are:
263
+ #
264
+ # * `legacy` - The pre-existing retry behavior. This is default value if
265
+ # no retry mode is provided.
266
+ #
267
+ # * `standard` - A standardized set of retry rules across the AWS SDKs.
268
+ # This includes support for retry quotas, which limit the number of
269
+ # unsuccessful retries a client can make.
270
+ #
271
+ # * `adaptive` - An experimental retry mode that includes all the
272
+ # functionality of `standard` mode along with automatic client side
273
+ # throttling. This is a provisional mode that may change behavior
274
+ # in the future.
275
+ #
276
+ #
277
+ # @option options [String] :secret_access_key
278
+ #
279
+ # @option options [String] :session_token
280
+ #
281
+ # @option options [Boolean] :stub_responses (false)
282
+ # Causes the client to return stubbed responses. By default
283
+ # fake responses are generated and returned. You can specify
284
+ # the response data to return or errors to raise by calling
285
+ # {ClientStubs#stub_responses}. See {ClientStubs} for more information.
286
+ #
287
+ # ** Please note ** When response stubbing is enabled, no HTTP
288
+ # requests are made, and retries are disabled.
289
+ #
290
+ # @option options [Boolean] :use_dualstack_endpoint
291
+ # When set to `true`, dualstack enabled endpoints (with `.aws` TLD)
292
+ # will be used if available.
293
+ #
294
+ # @option options [Boolean] :use_fips_endpoint
295
+ # When set to `true`, fips compatible endpoints will be used if available.
296
+ # When a `fips` region is used, the region is normalized and this config
297
+ # is set to `true`.
298
+ #
299
+ # @option options [Boolean] :validate_params (true)
300
+ # When `true`, request parameters are validated before
301
+ # sending the request.
302
+ #
303
+ # @option options [URI::HTTP,String] :http_proxy A proxy to send
304
+ # requests through. Formatted like 'http://proxy.com:123'.
305
+ #
306
+ # @option options [Float] :http_open_timeout (15) The number of
307
+ # seconds to wait when opening a HTTP session before raising a
308
+ # `Timeout::Error`.
309
+ #
310
+ # @option options [Float] :http_read_timeout (60) The default
311
+ # number of seconds to wait for response data. This value can
312
+ # safely be set per-request on the session.
313
+ #
314
+ # @option options [Float] :http_idle_timeout (5) The number of
315
+ # seconds a connection is allowed to sit idle before it is
316
+ # considered stale. Stale connections are closed and removed
317
+ # from the pool before making a request.
318
+ #
319
+ # @option options [Float] :http_continue_timeout (1) The number of
320
+ # seconds to wait for a 100-continue response before sending the
321
+ # request body. This option has no effect unless the request has
322
+ # "Expect" header set to "100-continue". Defaults to `nil` which
323
+ # disables this behaviour. This value can safely be set per
324
+ # request on the session.
325
+ #
326
+ # @option options [Float] :ssl_timeout (nil) Sets the SSL timeout
327
+ # in seconds.
328
+ #
329
+ # @option options [Boolean] :http_wire_trace (false) When `true`,
330
+ # HTTP debug output will be sent to the `:logger`.
331
+ #
332
+ # @option options [Boolean] :ssl_verify_peer (true) When `true`,
333
+ # SSL peer certificates are verified when establishing a
334
+ # connection.
335
+ #
336
+ # @option options [String] :ssl_ca_bundle Full path to the SSL
337
+ # certificate authority bundle file that should be used when
338
+ # verifying peer certificates. If you do not pass
339
+ # `:ssl_ca_bundle` or `:ssl_ca_directory` the the system default
340
+ # will be used if available.
341
+ #
342
+ # @option options [String] :ssl_ca_directory Full path of the
343
+ # directory that contains the unbundled SSL certificate
344
+ # authority files for verifying peer certificates. If you do
345
+ # not pass `:ssl_ca_bundle` or `:ssl_ca_directory` the the
346
+ # system default will be used if available.
347
+ #
348
+ def initialize(*args)
349
+ super
350
+ end
351
+
352
+ # @!group API Operations
353
+
354
+ # Creates a media capture pipeline.
355
+ #
356
+ # @option params [required, String] :source_type
357
+ # Source type from which the media artifacts are captured. A Chime SDK
358
+ # Meeting is the only supported source.
359
+ #
360
+ # @option params [required, String] :source_arn
361
+ # ARN of the source from which the media artifacts are captured.
362
+ #
363
+ # @option params [required, String] :sink_type
364
+ # Destination type to which the media artifacts are saved. You must use
365
+ # an S3 bucket.
366
+ #
367
+ # @option params [required, String] :sink_arn
368
+ # The ARN of the sink type.
369
+ #
370
+ # @option params [String] :client_request_token
371
+ # The token assigned to the client making the pipeline request.
372
+ #
373
+ # **A suitable default value is auto-generated.** You should normally
374
+ # not need to pass this option.**
375
+ #
376
+ # @option params [Types::ChimeSdkMeetingConfiguration] :chime_sdk_meeting_configuration
377
+ # The configuration for a specified media capture pipeline. `SourceType`
378
+ # must be `ChimeSdkMeeting`.
379
+ #
380
+ # @option params [Array<Types::Tag>] :tags
381
+ # The list of tags.
382
+ #
383
+ # @return [Types::CreateMediaCapturePipelineResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
384
+ #
385
+ # * {Types::CreateMediaCapturePipelineResponse#media_capture_pipeline #media_capture_pipeline} => Types::MediaCapturePipeline
386
+ #
387
+ # @example Request syntax with placeholder values
388
+ #
389
+ # resp = client.create_media_capture_pipeline({
390
+ # source_type: "ChimeSdkMeeting", # required, accepts ChimeSdkMeeting
391
+ # source_arn: "Arn", # required
392
+ # sink_type: "S3Bucket", # required, accepts S3Bucket
393
+ # sink_arn: "Arn", # required
394
+ # client_request_token: "ClientRequestToken",
395
+ # chime_sdk_meeting_configuration: {
396
+ # source_configuration: {
397
+ # selected_video_streams: {
398
+ # attendee_ids: ["GuidString"],
399
+ # external_user_ids: ["ExternalUserIdType"],
400
+ # },
401
+ # },
402
+ # artifacts_configuration: {
403
+ # audio: { # required
404
+ # mux_type: "AudioOnly", # required, accepts AudioOnly, AudioWithActiveSpeakerVideo
405
+ # },
406
+ # video: { # required
407
+ # state: "Enabled", # required, accepts Enabled, Disabled
408
+ # mux_type: "VideoOnly", # accepts VideoOnly
409
+ # },
410
+ # content: { # required
411
+ # state: "Enabled", # required, accepts Enabled, Disabled
412
+ # mux_type: "ContentOnly", # accepts ContentOnly
413
+ # },
414
+ # },
415
+ # },
416
+ # tags: [
417
+ # {
418
+ # key: "TagKey", # required
419
+ # value: "TagValue", # required
420
+ # },
421
+ # ],
422
+ # })
423
+ #
424
+ # @example Response structure
425
+ #
426
+ # resp.media_capture_pipeline.media_pipeline_id #=> String
427
+ # resp.media_capture_pipeline.media_pipeline_arn #=> String
428
+ # resp.media_capture_pipeline.source_type #=> String, one of "ChimeSdkMeeting"
429
+ # resp.media_capture_pipeline.source_arn #=> String
430
+ # resp.media_capture_pipeline.status #=> String, one of "Initializing", "InProgress", "Failed", "Stopping", "Stopped"
431
+ # resp.media_capture_pipeline.sink_type #=> String, one of "S3Bucket"
432
+ # resp.media_capture_pipeline.sink_arn #=> String
433
+ # resp.media_capture_pipeline.created_timestamp #=> Time
434
+ # resp.media_capture_pipeline.updated_timestamp #=> Time
435
+ # resp.media_capture_pipeline.chime_sdk_meeting_configuration.source_configuration.selected_video_streams.attendee_ids #=> Array
436
+ # resp.media_capture_pipeline.chime_sdk_meeting_configuration.source_configuration.selected_video_streams.attendee_ids[0] #=> String
437
+ # resp.media_capture_pipeline.chime_sdk_meeting_configuration.source_configuration.selected_video_streams.external_user_ids #=> Array
438
+ # resp.media_capture_pipeline.chime_sdk_meeting_configuration.source_configuration.selected_video_streams.external_user_ids[0] #=> String
439
+ # resp.media_capture_pipeline.chime_sdk_meeting_configuration.artifacts_configuration.audio.mux_type #=> String, one of "AudioOnly", "AudioWithActiveSpeakerVideo"
440
+ # resp.media_capture_pipeline.chime_sdk_meeting_configuration.artifacts_configuration.video.state #=> String, one of "Enabled", "Disabled"
441
+ # resp.media_capture_pipeline.chime_sdk_meeting_configuration.artifacts_configuration.video.mux_type #=> String, one of "VideoOnly"
442
+ # resp.media_capture_pipeline.chime_sdk_meeting_configuration.artifacts_configuration.content.state #=> String, one of "Enabled", "Disabled"
443
+ # resp.media_capture_pipeline.chime_sdk_meeting_configuration.artifacts_configuration.content.mux_type #=> String, one of "ContentOnly"
444
+ #
445
+ # @see http://docs.aws.amazon.com/goto/WebAPI/chime-sdk-media-pipelines-2021-07-15/CreateMediaCapturePipeline AWS API Documentation
446
+ #
447
+ # @overload create_media_capture_pipeline(params = {})
448
+ # @param [Hash] params ({})
449
+ def create_media_capture_pipeline(params = {}, options = {})
450
+ req = build_request(:create_media_capture_pipeline, params)
451
+ req.send_request(options)
452
+ end
453
+
454
+ # Deletes the media capture pipeline.
455
+ #
456
+ # @option params [required, String] :media_pipeline_id
457
+ # The ID of the media capture pipeline being deleted.
458
+ #
459
+ # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
460
+ #
461
+ # @example Request syntax with placeholder values
462
+ #
463
+ # resp = client.delete_media_capture_pipeline({
464
+ # media_pipeline_id: "GuidString", # required
465
+ # })
466
+ #
467
+ # @see http://docs.aws.amazon.com/goto/WebAPI/chime-sdk-media-pipelines-2021-07-15/DeleteMediaCapturePipeline AWS API Documentation
468
+ #
469
+ # @overload delete_media_capture_pipeline(params = {})
470
+ # @param [Hash] params ({})
471
+ def delete_media_capture_pipeline(params = {}, options = {})
472
+ req = build_request(:delete_media_capture_pipeline, params)
473
+ req.send_request(options)
474
+ end
475
+
476
+ # Gets an existing media capture pipeline.
477
+ #
478
+ # @option params [required, String] :media_pipeline_id
479
+ # The ID of the pipeline that you want to get.
480
+ #
481
+ # @return [Types::GetMediaCapturePipelineResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
482
+ #
483
+ # * {Types::GetMediaCapturePipelineResponse#media_capture_pipeline #media_capture_pipeline} => Types::MediaCapturePipeline
484
+ #
485
+ # @example Request syntax with placeholder values
486
+ #
487
+ # resp = client.get_media_capture_pipeline({
488
+ # media_pipeline_id: "GuidString", # required
489
+ # })
490
+ #
491
+ # @example Response structure
492
+ #
493
+ # resp.media_capture_pipeline.media_pipeline_id #=> String
494
+ # resp.media_capture_pipeline.media_pipeline_arn #=> String
495
+ # resp.media_capture_pipeline.source_type #=> String, one of "ChimeSdkMeeting"
496
+ # resp.media_capture_pipeline.source_arn #=> String
497
+ # resp.media_capture_pipeline.status #=> String, one of "Initializing", "InProgress", "Failed", "Stopping", "Stopped"
498
+ # resp.media_capture_pipeline.sink_type #=> String, one of "S3Bucket"
499
+ # resp.media_capture_pipeline.sink_arn #=> String
500
+ # resp.media_capture_pipeline.created_timestamp #=> Time
501
+ # resp.media_capture_pipeline.updated_timestamp #=> Time
502
+ # resp.media_capture_pipeline.chime_sdk_meeting_configuration.source_configuration.selected_video_streams.attendee_ids #=> Array
503
+ # resp.media_capture_pipeline.chime_sdk_meeting_configuration.source_configuration.selected_video_streams.attendee_ids[0] #=> String
504
+ # resp.media_capture_pipeline.chime_sdk_meeting_configuration.source_configuration.selected_video_streams.external_user_ids #=> Array
505
+ # resp.media_capture_pipeline.chime_sdk_meeting_configuration.source_configuration.selected_video_streams.external_user_ids[0] #=> String
506
+ # resp.media_capture_pipeline.chime_sdk_meeting_configuration.artifacts_configuration.audio.mux_type #=> String, one of "AudioOnly", "AudioWithActiveSpeakerVideo"
507
+ # resp.media_capture_pipeline.chime_sdk_meeting_configuration.artifacts_configuration.video.state #=> String, one of "Enabled", "Disabled"
508
+ # resp.media_capture_pipeline.chime_sdk_meeting_configuration.artifacts_configuration.video.mux_type #=> String, one of "VideoOnly"
509
+ # resp.media_capture_pipeline.chime_sdk_meeting_configuration.artifacts_configuration.content.state #=> String, one of "Enabled", "Disabled"
510
+ # resp.media_capture_pipeline.chime_sdk_meeting_configuration.artifacts_configuration.content.mux_type #=> String, one of "ContentOnly"
511
+ #
512
+ # @see http://docs.aws.amazon.com/goto/WebAPI/chime-sdk-media-pipelines-2021-07-15/GetMediaCapturePipeline AWS API Documentation
513
+ #
514
+ # @overload get_media_capture_pipeline(params = {})
515
+ # @param [Hash] params ({})
516
+ def get_media_capture_pipeline(params = {}, options = {})
517
+ req = build_request(:get_media_capture_pipeline, params)
518
+ req.send_request(options)
519
+ end
520
+
521
+ # Returns a list of media capture pipelines.
522
+ #
523
+ # @option params [String] :next_token
524
+ # The token used to retrieve the next page of results.
525
+ #
526
+ # @option params [Integer] :max_results
527
+ # The maximum number of results to return in a single call. Valid Range:
528
+ # 1 - 99.
529
+ #
530
+ # @return [Types::ListMediaCapturePipelinesResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
531
+ #
532
+ # * {Types::ListMediaCapturePipelinesResponse#media_capture_pipelines #media_capture_pipelines} => Array&lt;Types::MediaCapturePipelineSummary&gt;
533
+ # * {Types::ListMediaCapturePipelinesResponse#next_token #next_token} => String
534
+ #
535
+ # The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
536
+ #
537
+ # @example Request syntax with placeholder values
538
+ #
539
+ # resp = client.list_media_capture_pipelines({
540
+ # next_token: "String",
541
+ # max_results: 1,
542
+ # })
543
+ #
544
+ # @example Response structure
545
+ #
546
+ # resp.media_capture_pipelines #=> Array
547
+ # resp.media_capture_pipelines[0].media_pipeline_id #=> String
548
+ # resp.media_capture_pipelines[0].media_pipeline_arn #=> String
549
+ # resp.next_token #=> String
550
+ #
551
+ # @see http://docs.aws.amazon.com/goto/WebAPI/chime-sdk-media-pipelines-2021-07-15/ListMediaCapturePipelines AWS API Documentation
552
+ #
553
+ # @overload list_media_capture_pipelines(params = {})
554
+ # @param [Hash] params ({})
555
+ def list_media_capture_pipelines(params = {}, options = {})
556
+ req = build_request(:list_media_capture_pipelines, params)
557
+ req.send_request(options)
558
+ end
559
+
560
+ # Lists the tags applied to an Amazon Chime SDK media capture pipeline.
561
+ #
562
+ # @option params [required, String] :resource_arn
563
+ # The resource ARN.
564
+ #
565
+ # @return [Types::ListTagsForResourceResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
566
+ #
567
+ # * {Types::ListTagsForResourceResponse#tags #tags} => Array&lt;Types::Tag&gt;
568
+ #
569
+ # @example Request syntax with placeholder values
570
+ #
571
+ # resp = client.list_tags_for_resource({
572
+ # resource_arn: "AmazonResourceName", # required
573
+ # })
574
+ #
575
+ # @example Response structure
576
+ #
577
+ # resp.tags #=> Array
578
+ # resp.tags[0].key #=> String
579
+ # resp.tags[0].value #=> String
580
+ #
581
+ # @see http://docs.aws.amazon.com/goto/WebAPI/chime-sdk-media-pipelines-2021-07-15/ListTagsForResource AWS API Documentation
582
+ #
583
+ # @overload list_tags_for_resource(params = {})
584
+ # @param [Hash] params ({})
585
+ def list_tags_for_resource(params = {}, options = {})
586
+ req = build_request(:list_tags_for_resource, params)
587
+ req.send_request(options)
588
+ end
589
+
590
+ # Applies the specified tags to the specified Amazon Chime SDK media
591
+ # capture pipeline.
592
+ #
593
+ # @option params [required, String] :resource_arn
594
+ # The resource ARN.
595
+ #
596
+ # @option params [required, Array<Types::Tag>] :tags
597
+ # The tag key-value pairs.
598
+ #
599
+ # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
600
+ #
601
+ # @example Request syntax with placeholder values
602
+ #
603
+ # resp = client.tag_resource({
604
+ # resource_arn: "AmazonResourceName", # required
605
+ # tags: [ # required
606
+ # {
607
+ # key: "TagKey", # required
608
+ # value: "TagValue", # required
609
+ # },
610
+ # ],
611
+ # })
612
+ #
613
+ # @see http://docs.aws.amazon.com/goto/WebAPI/chime-sdk-media-pipelines-2021-07-15/TagResource AWS API Documentation
614
+ #
615
+ # @overload tag_resource(params = {})
616
+ # @param [Hash] params ({})
617
+ def tag_resource(params = {}, options = {})
618
+ req = build_request(:tag_resource, params)
619
+ req.send_request(options)
620
+ end
621
+
622
+ # Removes the specified tags from the specified Amazon Chime SDK media
623
+ # capture pipeline.
624
+ #
625
+ # @option params [required, String] :resource_arn
626
+ # The resource ARN.
627
+ #
628
+ # @option params [required, Array<String>] :tag_keys
629
+ # The tag keys.
630
+ #
631
+ # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
632
+ #
633
+ # @example Request syntax with placeholder values
634
+ #
635
+ # resp = client.untag_resource({
636
+ # resource_arn: "AmazonResourceName", # required
637
+ # tag_keys: ["TagKey"], # required
638
+ # })
639
+ #
640
+ # @see http://docs.aws.amazon.com/goto/WebAPI/chime-sdk-media-pipelines-2021-07-15/UntagResource AWS API Documentation
641
+ #
642
+ # @overload untag_resource(params = {})
643
+ # @param [Hash] params ({})
644
+ def untag_resource(params = {}, options = {})
645
+ req = build_request(:untag_resource, params)
646
+ req.send_request(options)
647
+ end
648
+
649
+ # @!endgroup
650
+
651
+ # @param params ({})
652
+ # @api private
653
+ def build_request(operation_name, params = {})
654
+ handlers = @handlers.for(operation_name)
655
+ context = Seahorse::Client::RequestContext.new(
656
+ operation_name: operation_name,
657
+ operation: config.api.operation(operation_name),
658
+ client: self,
659
+ params: params,
660
+ config: config)
661
+ context[:gem_name] = 'aws-sdk-chimesdkmediapipelines'
662
+ context[:gem_version] = '1.0.0'
663
+ Seahorse::Client::Request.new(handlers, context)
664
+ end
665
+
666
+ # @api private
667
+ # @deprecated
668
+ def waiter_names
669
+ []
670
+ end
671
+
672
+ class << self
673
+
674
+ # @api private
675
+ attr_reader :identifier
676
+
677
+ # @api private
678
+ def errors_module
679
+ Errors
680
+ end
681
+
682
+ end
683
+ end
684
+ end