aws-sdk-chimesdkmediapipelines 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/CHANGELOG.md +8 -0
- data/LICENSE.txt +202 -0
- data/VERSION +1 -0
- data/lib/aws-sdk-chimesdkmediapipelines/client.rb +684 -0
- data/lib/aws-sdk-chimesdkmediapipelines/client_api.rb +345 -0
- data/lib/aws-sdk-chimesdkmediapipelines/customizations.rb +0 -0
- data/lib/aws-sdk-chimesdkmediapipelines/errors.rb +246 -0
- data/lib/aws-sdk-chimesdkmediapipelines/resource.rb +26 -0
- data/lib/aws-sdk-chimesdkmediapipelines/types.rb +813 -0
- data/lib/aws-sdk-chimesdkmediapipelines.rb +53 -0
- metadata +90 -0
@@ -0,0 +1,813 @@
|
|
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
|
+
module Aws::ChimeSDKMediaPipelines
|
11
|
+
module Types
|
12
|
+
|
13
|
+
# The configuration for the artifacts.
|
14
|
+
#
|
15
|
+
# @note When making an API call, you may pass ArtifactsConfiguration
|
16
|
+
# data as a hash:
|
17
|
+
#
|
18
|
+
# {
|
19
|
+
# audio: { # required
|
20
|
+
# mux_type: "AudioOnly", # required, accepts AudioOnly, AudioWithActiveSpeakerVideo
|
21
|
+
# },
|
22
|
+
# video: { # required
|
23
|
+
# state: "Enabled", # required, accepts Enabled, Disabled
|
24
|
+
# mux_type: "VideoOnly", # accepts VideoOnly
|
25
|
+
# },
|
26
|
+
# content: { # required
|
27
|
+
# state: "Enabled", # required, accepts Enabled, Disabled
|
28
|
+
# mux_type: "ContentOnly", # accepts ContentOnly
|
29
|
+
# },
|
30
|
+
# }
|
31
|
+
#
|
32
|
+
# @!attribute [rw] audio
|
33
|
+
# The configuration for the audio artifacts.
|
34
|
+
# @return [Types::AudioArtifactsConfiguration]
|
35
|
+
#
|
36
|
+
# @!attribute [rw] video
|
37
|
+
# The configuration for the video artifacts.
|
38
|
+
# @return [Types::VideoArtifactsConfiguration]
|
39
|
+
#
|
40
|
+
# @!attribute [rw] content
|
41
|
+
# The configuration for the content artifacts.
|
42
|
+
# @return [Types::ContentArtifactsConfiguration]
|
43
|
+
#
|
44
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/chime-sdk-media-pipelines-2021-07-15/ArtifactsConfiguration AWS API Documentation
|
45
|
+
#
|
46
|
+
class ArtifactsConfiguration < Struct.new(
|
47
|
+
:audio,
|
48
|
+
:video,
|
49
|
+
:content)
|
50
|
+
SENSITIVE = []
|
51
|
+
include Aws::Structure
|
52
|
+
end
|
53
|
+
|
54
|
+
# The audio artifact configuration object.
|
55
|
+
#
|
56
|
+
# @note When making an API call, you may pass AudioArtifactsConfiguration
|
57
|
+
# data as a hash:
|
58
|
+
#
|
59
|
+
# {
|
60
|
+
# mux_type: "AudioOnly", # required, accepts AudioOnly, AudioWithActiveSpeakerVideo
|
61
|
+
# }
|
62
|
+
#
|
63
|
+
# @!attribute [rw] mux_type
|
64
|
+
# The MUX type of the audio artifact configuration object.
|
65
|
+
# @return [String]
|
66
|
+
#
|
67
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/chime-sdk-media-pipelines-2021-07-15/AudioArtifactsConfiguration AWS API Documentation
|
68
|
+
#
|
69
|
+
class AudioArtifactsConfiguration < Struct.new(
|
70
|
+
:mux_type)
|
71
|
+
SENSITIVE = []
|
72
|
+
include Aws::Structure
|
73
|
+
end
|
74
|
+
|
75
|
+
# The input parameters don't match the service's restrictions.
|
76
|
+
#
|
77
|
+
# @!attribute [rw] code
|
78
|
+
# @return [String]
|
79
|
+
#
|
80
|
+
# @!attribute [rw] message
|
81
|
+
# @return [String]
|
82
|
+
#
|
83
|
+
# @!attribute [rw] request_id
|
84
|
+
# The request id associated with the call responsible for the
|
85
|
+
# exception.
|
86
|
+
# @return [String]
|
87
|
+
#
|
88
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/chime-sdk-media-pipelines-2021-07-15/BadRequestException AWS API Documentation
|
89
|
+
#
|
90
|
+
class BadRequestException < Struct.new(
|
91
|
+
:code,
|
92
|
+
:message,
|
93
|
+
:request_id)
|
94
|
+
SENSITIVE = []
|
95
|
+
include Aws::Structure
|
96
|
+
end
|
97
|
+
|
98
|
+
# The configuration object of the Amazon Chime SDK meeting for a
|
99
|
+
# specified media capture pipeline. `SourceType` must be
|
100
|
+
# `ChimeSdkMeeting`.
|
101
|
+
#
|
102
|
+
# @note When making an API call, you may pass ChimeSdkMeetingConfiguration
|
103
|
+
# data as a hash:
|
104
|
+
#
|
105
|
+
# {
|
106
|
+
# source_configuration: {
|
107
|
+
# selected_video_streams: {
|
108
|
+
# attendee_ids: ["GuidString"],
|
109
|
+
# external_user_ids: ["ExternalUserIdType"],
|
110
|
+
# },
|
111
|
+
# },
|
112
|
+
# artifacts_configuration: {
|
113
|
+
# audio: { # required
|
114
|
+
# mux_type: "AudioOnly", # required, accepts AudioOnly, AudioWithActiveSpeakerVideo
|
115
|
+
# },
|
116
|
+
# video: { # required
|
117
|
+
# state: "Enabled", # required, accepts Enabled, Disabled
|
118
|
+
# mux_type: "VideoOnly", # accepts VideoOnly
|
119
|
+
# },
|
120
|
+
# content: { # required
|
121
|
+
# state: "Enabled", # required, accepts Enabled, Disabled
|
122
|
+
# mux_type: "ContentOnly", # accepts ContentOnly
|
123
|
+
# },
|
124
|
+
# },
|
125
|
+
# }
|
126
|
+
#
|
127
|
+
# @!attribute [rw] source_configuration
|
128
|
+
# The source configuration for a specified media capture pipline.
|
129
|
+
# @return [Types::SourceConfiguration]
|
130
|
+
#
|
131
|
+
# @!attribute [rw] artifacts_configuration
|
132
|
+
# The configuration for the artifacts in an Amazon Chime SDK meeting.
|
133
|
+
# @return [Types::ArtifactsConfiguration]
|
134
|
+
#
|
135
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/chime-sdk-media-pipelines-2021-07-15/ChimeSdkMeetingConfiguration AWS API Documentation
|
136
|
+
#
|
137
|
+
class ChimeSdkMeetingConfiguration < Struct.new(
|
138
|
+
:source_configuration,
|
139
|
+
:artifacts_configuration)
|
140
|
+
SENSITIVE = []
|
141
|
+
include Aws::Structure
|
142
|
+
end
|
143
|
+
|
144
|
+
# The content artifact object.
|
145
|
+
#
|
146
|
+
# @note When making an API call, you may pass ContentArtifactsConfiguration
|
147
|
+
# data as a hash:
|
148
|
+
#
|
149
|
+
# {
|
150
|
+
# state: "Enabled", # required, accepts Enabled, Disabled
|
151
|
+
# mux_type: "ContentOnly", # accepts ContentOnly
|
152
|
+
# }
|
153
|
+
#
|
154
|
+
# @!attribute [rw] state
|
155
|
+
# Indicates whether the content artifact is enabled or disabled.
|
156
|
+
# @return [String]
|
157
|
+
#
|
158
|
+
# @!attribute [rw] mux_type
|
159
|
+
# The MUX type of the artifact configuration.
|
160
|
+
# @return [String]
|
161
|
+
#
|
162
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/chime-sdk-media-pipelines-2021-07-15/ContentArtifactsConfiguration AWS API Documentation
|
163
|
+
#
|
164
|
+
class ContentArtifactsConfiguration < Struct.new(
|
165
|
+
:state,
|
166
|
+
:mux_type)
|
167
|
+
SENSITIVE = []
|
168
|
+
include Aws::Structure
|
169
|
+
end
|
170
|
+
|
171
|
+
# @note When making an API call, you may pass CreateMediaCapturePipelineRequest
|
172
|
+
# data as a hash:
|
173
|
+
#
|
174
|
+
# {
|
175
|
+
# source_type: "ChimeSdkMeeting", # required, accepts ChimeSdkMeeting
|
176
|
+
# source_arn: "Arn", # required
|
177
|
+
# sink_type: "S3Bucket", # required, accepts S3Bucket
|
178
|
+
# sink_arn: "Arn", # required
|
179
|
+
# client_request_token: "ClientRequestToken",
|
180
|
+
# chime_sdk_meeting_configuration: {
|
181
|
+
# source_configuration: {
|
182
|
+
# selected_video_streams: {
|
183
|
+
# attendee_ids: ["GuidString"],
|
184
|
+
# external_user_ids: ["ExternalUserIdType"],
|
185
|
+
# },
|
186
|
+
# },
|
187
|
+
# artifacts_configuration: {
|
188
|
+
# audio: { # required
|
189
|
+
# mux_type: "AudioOnly", # required, accepts AudioOnly, AudioWithActiveSpeakerVideo
|
190
|
+
# },
|
191
|
+
# video: { # required
|
192
|
+
# state: "Enabled", # required, accepts Enabled, Disabled
|
193
|
+
# mux_type: "VideoOnly", # accepts VideoOnly
|
194
|
+
# },
|
195
|
+
# content: { # required
|
196
|
+
# state: "Enabled", # required, accepts Enabled, Disabled
|
197
|
+
# mux_type: "ContentOnly", # accepts ContentOnly
|
198
|
+
# },
|
199
|
+
# },
|
200
|
+
# },
|
201
|
+
# tags: [
|
202
|
+
# {
|
203
|
+
# key: "TagKey", # required
|
204
|
+
# value: "TagValue", # required
|
205
|
+
# },
|
206
|
+
# ],
|
207
|
+
# }
|
208
|
+
#
|
209
|
+
# @!attribute [rw] source_type
|
210
|
+
# Source type from which the media artifacts are captured. A Chime SDK
|
211
|
+
# Meeting is the only supported source.
|
212
|
+
# @return [String]
|
213
|
+
#
|
214
|
+
# @!attribute [rw] source_arn
|
215
|
+
# ARN of the source from which the media artifacts are captured.
|
216
|
+
# @return [String]
|
217
|
+
#
|
218
|
+
# @!attribute [rw] sink_type
|
219
|
+
# Destination type to which the media artifacts are saved. You must
|
220
|
+
# use an S3 bucket.
|
221
|
+
# @return [String]
|
222
|
+
#
|
223
|
+
# @!attribute [rw] sink_arn
|
224
|
+
# The ARN of the sink type.
|
225
|
+
# @return [String]
|
226
|
+
#
|
227
|
+
# @!attribute [rw] client_request_token
|
228
|
+
# The token assigned to the client making the pipeline request.
|
229
|
+
#
|
230
|
+
# **A suitable default value is auto-generated.** You should normally
|
231
|
+
# not need to pass this option.
|
232
|
+
# @return [String]
|
233
|
+
#
|
234
|
+
# @!attribute [rw] chime_sdk_meeting_configuration
|
235
|
+
# The configuration for a specified media capture pipeline.
|
236
|
+
# `SourceType` must be `ChimeSdkMeeting`.
|
237
|
+
# @return [Types::ChimeSdkMeetingConfiguration]
|
238
|
+
#
|
239
|
+
# @!attribute [rw] tags
|
240
|
+
# The list of tags.
|
241
|
+
# @return [Array<Types::Tag>]
|
242
|
+
#
|
243
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/chime-sdk-media-pipelines-2021-07-15/CreateMediaCapturePipelineRequest AWS API Documentation
|
244
|
+
#
|
245
|
+
class CreateMediaCapturePipelineRequest < Struct.new(
|
246
|
+
:source_type,
|
247
|
+
:source_arn,
|
248
|
+
:sink_type,
|
249
|
+
:sink_arn,
|
250
|
+
:client_request_token,
|
251
|
+
:chime_sdk_meeting_configuration,
|
252
|
+
:tags)
|
253
|
+
SENSITIVE = [:source_arn, :sink_arn, :client_request_token]
|
254
|
+
include Aws::Structure
|
255
|
+
end
|
256
|
+
|
257
|
+
# @!attribute [rw] media_capture_pipeline
|
258
|
+
# A media capture pipeline object, the ID, source type, source ARN,
|
259
|
+
# sink type, and sink ARN of a media capture pipeline object.
|
260
|
+
# @return [Types::MediaCapturePipeline]
|
261
|
+
#
|
262
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/chime-sdk-media-pipelines-2021-07-15/CreateMediaCapturePipelineResponse AWS API Documentation
|
263
|
+
#
|
264
|
+
class CreateMediaCapturePipelineResponse < Struct.new(
|
265
|
+
:media_capture_pipeline)
|
266
|
+
SENSITIVE = []
|
267
|
+
include Aws::Structure
|
268
|
+
end
|
269
|
+
|
270
|
+
# @note When making an API call, you may pass DeleteMediaCapturePipelineRequest
|
271
|
+
# data as a hash:
|
272
|
+
#
|
273
|
+
# {
|
274
|
+
# media_pipeline_id: "GuidString", # required
|
275
|
+
# }
|
276
|
+
#
|
277
|
+
# @!attribute [rw] media_pipeline_id
|
278
|
+
# The ID of the media capture pipeline being deleted.
|
279
|
+
# @return [String]
|
280
|
+
#
|
281
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/chime-sdk-media-pipelines-2021-07-15/DeleteMediaCapturePipelineRequest AWS API Documentation
|
282
|
+
#
|
283
|
+
class DeleteMediaCapturePipelineRequest < Struct.new(
|
284
|
+
:media_pipeline_id)
|
285
|
+
SENSITIVE = []
|
286
|
+
include Aws::Structure
|
287
|
+
end
|
288
|
+
|
289
|
+
# The client is permanently forbidden from making the request.
|
290
|
+
#
|
291
|
+
# @!attribute [rw] code
|
292
|
+
# @return [String]
|
293
|
+
#
|
294
|
+
# @!attribute [rw] message
|
295
|
+
# @return [String]
|
296
|
+
#
|
297
|
+
# @!attribute [rw] request_id
|
298
|
+
# The request id associated with the call responsible for the
|
299
|
+
# exception.
|
300
|
+
# @return [String]
|
301
|
+
#
|
302
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/chime-sdk-media-pipelines-2021-07-15/ForbiddenException AWS API Documentation
|
303
|
+
#
|
304
|
+
class ForbiddenException < Struct.new(
|
305
|
+
:code,
|
306
|
+
:message,
|
307
|
+
:request_id)
|
308
|
+
SENSITIVE = []
|
309
|
+
include Aws::Structure
|
310
|
+
end
|
311
|
+
|
312
|
+
# @note When making an API call, you may pass GetMediaCapturePipelineRequest
|
313
|
+
# data as a hash:
|
314
|
+
#
|
315
|
+
# {
|
316
|
+
# media_pipeline_id: "GuidString", # required
|
317
|
+
# }
|
318
|
+
#
|
319
|
+
# @!attribute [rw] media_pipeline_id
|
320
|
+
# The ID of the pipeline that you want to get.
|
321
|
+
# @return [String]
|
322
|
+
#
|
323
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/chime-sdk-media-pipelines-2021-07-15/GetMediaCapturePipelineRequest AWS API Documentation
|
324
|
+
#
|
325
|
+
class GetMediaCapturePipelineRequest < Struct.new(
|
326
|
+
:media_pipeline_id)
|
327
|
+
SENSITIVE = []
|
328
|
+
include Aws::Structure
|
329
|
+
end
|
330
|
+
|
331
|
+
# @!attribute [rw] media_capture_pipeline
|
332
|
+
# The media capture pipeline object.
|
333
|
+
# @return [Types::MediaCapturePipeline]
|
334
|
+
#
|
335
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/chime-sdk-media-pipelines-2021-07-15/GetMediaCapturePipelineResponse AWS API Documentation
|
336
|
+
#
|
337
|
+
class GetMediaCapturePipelineResponse < Struct.new(
|
338
|
+
:media_capture_pipeline)
|
339
|
+
SENSITIVE = []
|
340
|
+
include Aws::Structure
|
341
|
+
end
|
342
|
+
|
343
|
+
# @note When making an API call, you may pass ListMediaCapturePipelinesRequest
|
344
|
+
# data as a hash:
|
345
|
+
#
|
346
|
+
# {
|
347
|
+
# next_token: "String",
|
348
|
+
# max_results: 1,
|
349
|
+
# }
|
350
|
+
#
|
351
|
+
# @!attribute [rw] next_token
|
352
|
+
# The token used to retrieve the next page of results.
|
353
|
+
# @return [String]
|
354
|
+
#
|
355
|
+
# @!attribute [rw] max_results
|
356
|
+
# The maximum number of results to return in a single call. Valid
|
357
|
+
# Range: 1 - 99.
|
358
|
+
# @return [Integer]
|
359
|
+
#
|
360
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/chime-sdk-media-pipelines-2021-07-15/ListMediaCapturePipelinesRequest AWS API Documentation
|
361
|
+
#
|
362
|
+
class ListMediaCapturePipelinesRequest < Struct.new(
|
363
|
+
:next_token,
|
364
|
+
:max_results)
|
365
|
+
SENSITIVE = []
|
366
|
+
include Aws::Structure
|
367
|
+
end
|
368
|
+
|
369
|
+
# @!attribute [rw] media_capture_pipelines
|
370
|
+
# The media capture pipeline objects in the list.
|
371
|
+
# @return [Array<Types::MediaCapturePipelineSummary>]
|
372
|
+
#
|
373
|
+
# @!attribute [rw] next_token
|
374
|
+
# The token used to retrieve the next page of results.
|
375
|
+
# @return [String]
|
376
|
+
#
|
377
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/chime-sdk-media-pipelines-2021-07-15/ListMediaCapturePipelinesResponse AWS API Documentation
|
378
|
+
#
|
379
|
+
class ListMediaCapturePipelinesResponse < Struct.new(
|
380
|
+
:media_capture_pipelines,
|
381
|
+
:next_token)
|
382
|
+
SENSITIVE = []
|
383
|
+
include Aws::Structure
|
384
|
+
end
|
385
|
+
|
386
|
+
# @note When making an API call, you may pass ListTagsForResourceRequest
|
387
|
+
# data as a hash:
|
388
|
+
#
|
389
|
+
# {
|
390
|
+
# resource_arn: "AmazonResourceName", # required
|
391
|
+
# }
|
392
|
+
#
|
393
|
+
# @!attribute [rw] resource_arn
|
394
|
+
# The resource ARN.
|
395
|
+
# @return [String]
|
396
|
+
#
|
397
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/chime-sdk-media-pipelines-2021-07-15/ListTagsForResourceRequest AWS API Documentation
|
398
|
+
#
|
399
|
+
class ListTagsForResourceRequest < Struct.new(
|
400
|
+
:resource_arn)
|
401
|
+
SENSITIVE = []
|
402
|
+
include Aws::Structure
|
403
|
+
end
|
404
|
+
|
405
|
+
# @!attribute [rw] tags
|
406
|
+
# The tag key-value pairs.
|
407
|
+
# @return [Array<Types::Tag>]
|
408
|
+
#
|
409
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/chime-sdk-media-pipelines-2021-07-15/ListTagsForResourceResponse AWS API Documentation
|
410
|
+
#
|
411
|
+
class ListTagsForResourceResponse < Struct.new(
|
412
|
+
:tags)
|
413
|
+
SENSITIVE = []
|
414
|
+
include Aws::Structure
|
415
|
+
end
|
416
|
+
|
417
|
+
# A media capture pipeline object consisting of an ID, source type,
|
418
|
+
# source ARN, a sink type, a sink ARN, and a configuration object.
|
419
|
+
#
|
420
|
+
# @!attribute [rw] media_pipeline_id
|
421
|
+
# The ID of a media capture pipeline.
|
422
|
+
# @return [String]
|
423
|
+
#
|
424
|
+
# @!attribute [rw] media_pipeline_arn
|
425
|
+
# The ARN of a media capture pipeline.
|
426
|
+
# @return [String]
|
427
|
+
#
|
428
|
+
# @!attribute [rw] source_type
|
429
|
+
# Source type from which media artifacts are saved. You must use
|
430
|
+
# `ChimeMeeting`.
|
431
|
+
# @return [String]
|
432
|
+
#
|
433
|
+
# @!attribute [rw] source_arn
|
434
|
+
# ARN of the source from which the media artifacts are saved.
|
435
|
+
# @return [String]
|
436
|
+
#
|
437
|
+
# @!attribute [rw] status
|
438
|
+
# The status of the media capture pipeline.
|
439
|
+
# @return [String]
|
440
|
+
#
|
441
|
+
# @!attribute [rw] sink_type
|
442
|
+
# Destination type to which the media artifacts are saved. You must
|
443
|
+
# use an S3 Bucket.
|
444
|
+
# @return [String]
|
445
|
+
#
|
446
|
+
# @!attribute [rw] sink_arn
|
447
|
+
# ARN of the destination to which the media artifacts are saved.
|
448
|
+
# @return [String]
|
449
|
+
#
|
450
|
+
# @!attribute [rw] created_timestamp
|
451
|
+
# The time at which the capture pipeline was created, in ISO 8601
|
452
|
+
# format.
|
453
|
+
# @return [Time]
|
454
|
+
#
|
455
|
+
# @!attribute [rw] updated_timestamp
|
456
|
+
# The time at which the capture pipeline was updated, in ISO 8601
|
457
|
+
# format.
|
458
|
+
# @return [Time]
|
459
|
+
#
|
460
|
+
# @!attribute [rw] chime_sdk_meeting_configuration
|
461
|
+
# The configuration for a specified media capture pipeline.
|
462
|
+
# `SourceType` must be `ChimeSdkMeeting`.
|
463
|
+
# @return [Types::ChimeSdkMeetingConfiguration]
|
464
|
+
#
|
465
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/chime-sdk-media-pipelines-2021-07-15/MediaCapturePipeline AWS API Documentation
|
466
|
+
#
|
467
|
+
class MediaCapturePipeline < Struct.new(
|
468
|
+
:media_pipeline_id,
|
469
|
+
:media_pipeline_arn,
|
470
|
+
:source_type,
|
471
|
+
:source_arn,
|
472
|
+
:status,
|
473
|
+
:sink_type,
|
474
|
+
:sink_arn,
|
475
|
+
:created_timestamp,
|
476
|
+
:updated_timestamp,
|
477
|
+
:chime_sdk_meeting_configuration)
|
478
|
+
SENSITIVE = [:source_arn, :sink_arn]
|
479
|
+
include Aws::Structure
|
480
|
+
end
|
481
|
+
|
482
|
+
# A summary of a media capture pipeline.
|
483
|
+
#
|
484
|
+
# @!attribute [rw] media_pipeline_id
|
485
|
+
# The ID of a media capture pipeline.
|
486
|
+
# @return [String]
|
487
|
+
#
|
488
|
+
# @!attribute [rw] media_pipeline_arn
|
489
|
+
# The ARN of a media capture pipeline.
|
490
|
+
# @return [String]
|
491
|
+
#
|
492
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/chime-sdk-media-pipelines-2021-07-15/MediaCapturePipelineSummary AWS API Documentation
|
493
|
+
#
|
494
|
+
class MediaCapturePipelineSummary < Struct.new(
|
495
|
+
:media_pipeline_id,
|
496
|
+
:media_pipeline_arn)
|
497
|
+
SENSITIVE = []
|
498
|
+
include Aws::Structure
|
499
|
+
end
|
500
|
+
|
501
|
+
# One or more of the resources in the request does not exist in the
|
502
|
+
# system.
|
503
|
+
#
|
504
|
+
# @!attribute [rw] code
|
505
|
+
# @return [String]
|
506
|
+
#
|
507
|
+
# @!attribute [rw] message
|
508
|
+
# @return [String]
|
509
|
+
#
|
510
|
+
# @!attribute [rw] request_id
|
511
|
+
# The request id associated with the call responsible for the
|
512
|
+
# exception.
|
513
|
+
# @return [String]
|
514
|
+
#
|
515
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/chime-sdk-media-pipelines-2021-07-15/NotFoundException AWS API Documentation
|
516
|
+
#
|
517
|
+
class NotFoundException < Struct.new(
|
518
|
+
:code,
|
519
|
+
:message,
|
520
|
+
:request_id)
|
521
|
+
SENSITIVE = []
|
522
|
+
include Aws::Structure
|
523
|
+
end
|
524
|
+
|
525
|
+
# The request exceeds the resource limit.
|
526
|
+
#
|
527
|
+
# @!attribute [rw] code
|
528
|
+
# @return [String]
|
529
|
+
#
|
530
|
+
# @!attribute [rw] message
|
531
|
+
# @return [String]
|
532
|
+
#
|
533
|
+
# @!attribute [rw] request_id
|
534
|
+
# The request id associated with the call responsible for the
|
535
|
+
# exception.
|
536
|
+
# @return [String]
|
537
|
+
#
|
538
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/chime-sdk-media-pipelines-2021-07-15/ResourceLimitExceededException AWS API Documentation
|
539
|
+
#
|
540
|
+
class ResourceLimitExceededException < Struct.new(
|
541
|
+
:code,
|
542
|
+
:message,
|
543
|
+
:request_id)
|
544
|
+
SENSITIVE = []
|
545
|
+
include Aws::Structure
|
546
|
+
end
|
547
|
+
|
548
|
+
# The video streams to capture for a specified media capture pipeline.
|
549
|
+
# The total number of video streams can't exceed 25.
|
550
|
+
#
|
551
|
+
# @note When making an API call, you may pass SelectedVideoStreams
|
552
|
+
# data as a hash:
|
553
|
+
#
|
554
|
+
# {
|
555
|
+
# attendee_ids: ["GuidString"],
|
556
|
+
# external_user_ids: ["ExternalUserIdType"],
|
557
|
+
# }
|
558
|
+
#
|
559
|
+
# @!attribute [rw] attendee_ids
|
560
|
+
# The attendee IDs of the streams selected for a media capture
|
561
|
+
# pipeline.
|
562
|
+
# @return [Array<String>]
|
563
|
+
#
|
564
|
+
# @!attribute [rw] external_user_ids
|
565
|
+
# The external user IDs of the streams selected for a media capture
|
566
|
+
# pipeline.
|
567
|
+
# @return [Array<String>]
|
568
|
+
#
|
569
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/chime-sdk-media-pipelines-2021-07-15/SelectedVideoStreams AWS API Documentation
|
570
|
+
#
|
571
|
+
class SelectedVideoStreams < Struct.new(
|
572
|
+
:attendee_ids,
|
573
|
+
:external_user_ids)
|
574
|
+
SENSITIVE = []
|
575
|
+
include Aws::Structure
|
576
|
+
end
|
577
|
+
|
578
|
+
# The service encountered an unexpected error.
|
579
|
+
#
|
580
|
+
# @!attribute [rw] code
|
581
|
+
# @return [String]
|
582
|
+
#
|
583
|
+
# @!attribute [rw] message
|
584
|
+
# @return [String]
|
585
|
+
#
|
586
|
+
# @!attribute [rw] request_id
|
587
|
+
# The request id associated with the call responsible for the
|
588
|
+
# exception.
|
589
|
+
# @return [String]
|
590
|
+
#
|
591
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/chime-sdk-media-pipelines-2021-07-15/ServiceFailureException AWS API Documentation
|
592
|
+
#
|
593
|
+
class ServiceFailureException < Struct.new(
|
594
|
+
:code,
|
595
|
+
:message,
|
596
|
+
:request_id)
|
597
|
+
SENSITIVE = []
|
598
|
+
include Aws::Structure
|
599
|
+
end
|
600
|
+
|
601
|
+
# The service is currently unavailable.
|
602
|
+
#
|
603
|
+
# @!attribute [rw] code
|
604
|
+
# @return [String]
|
605
|
+
#
|
606
|
+
# @!attribute [rw] message
|
607
|
+
# @return [String]
|
608
|
+
#
|
609
|
+
# @!attribute [rw] request_id
|
610
|
+
# The request id associated with the call responsible for the
|
611
|
+
# exception.
|
612
|
+
# @return [String]
|
613
|
+
#
|
614
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/chime-sdk-media-pipelines-2021-07-15/ServiceUnavailableException AWS API Documentation
|
615
|
+
#
|
616
|
+
class ServiceUnavailableException < Struct.new(
|
617
|
+
:code,
|
618
|
+
:message,
|
619
|
+
:request_id)
|
620
|
+
SENSITIVE = []
|
621
|
+
include Aws::Structure
|
622
|
+
end
|
623
|
+
|
624
|
+
# Source configuration for a specified media capture pipeline.
|
625
|
+
#
|
626
|
+
# @note When making an API call, you may pass SourceConfiguration
|
627
|
+
# data as a hash:
|
628
|
+
#
|
629
|
+
# {
|
630
|
+
# selected_video_streams: {
|
631
|
+
# attendee_ids: ["GuidString"],
|
632
|
+
# external_user_ids: ["ExternalUserIdType"],
|
633
|
+
# },
|
634
|
+
# }
|
635
|
+
#
|
636
|
+
# @!attribute [rw] selected_video_streams
|
637
|
+
# The selected video streams to capture for a specified media capture
|
638
|
+
# pipeline. The number of video streams can't exceed 25.
|
639
|
+
# @return [Types::SelectedVideoStreams]
|
640
|
+
#
|
641
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/chime-sdk-media-pipelines-2021-07-15/SourceConfiguration AWS API Documentation
|
642
|
+
#
|
643
|
+
class SourceConfiguration < Struct.new(
|
644
|
+
:selected_video_streams)
|
645
|
+
SENSITIVE = []
|
646
|
+
include Aws::Structure
|
647
|
+
end
|
648
|
+
|
649
|
+
# Describes a tag applied to a resource.
|
650
|
+
#
|
651
|
+
# @note When making an API call, you may pass Tag
|
652
|
+
# data as a hash:
|
653
|
+
#
|
654
|
+
# {
|
655
|
+
# key: "TagKey", # required
|
656
|
+
# value: "TagValue", # required
|
657
|
+
# }
|
658
|
+
#
|
659
|
+
# @!attribute [rw] key
|
660
|
+
# The key of the tag.
|
661
|
+
# @return [String]
|
662
|
+
#
|
663
|
+
# @!attribute [rw] value
|
664
|
+
# The value of the tag.
|
665
|
+
# @return [String]
|
666
|
+
#
|
667
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/chime-sdk-media-pipelines-2021-07-15/Tag AWS API Documentation
|
668
|
+
#
|
669
|
+
class Tag < Struct.new(
|
670
|
+
:key,
|
671
|
+
:value)
|
672
|
+
SENSITIVE = []
|
673
|
+
include Aws::Structure
|
674
|
+
end
|
675
|
+
|
676
|
+
# @note When making an API call, you may pass TagResourceRequest
|
677
|
+
# data as a hash:
|
678
|
+
#
|
679
|
+
# {
|
680
|
+
# resource_arn: "AmazonResourceName", # required
|
681
|
+
# tags: [ # required
|
682
|
+
# {
|
683
|
+
# key: "TagKey", # required
|
684
|
+
# value: "TagValue", # required
|
685
|
+
# },
|
686
|
+
# ],
|
687
|
+
# }
|
688
|
+
#
|
689
|
+
# @!attribute [rw] resource_arn
|
690
|
+
# The resource ARN.
|
691
|
+
# @return [String]
|
692
|
+
#
|
693
|
+
# @!attribute [rw] tags
|
694
|
+
# The tag key-value pairs.
|
695
|
+
# @return [Array<Types::Tag>]
|
696
|
+
#
|
697
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/chime-sdk-media-pipelines-2021-07-15/TagResourceRequest AWS API Documentation
|
698
|
+
#
|
699
|
+
class TagResourceRequest < Struct.new(
|
700
|
+
:resource_arn,
|
701
|
+
:tags)
|
702
|
+
SENSITIVE = []
|
703
|
+
include Aws::Structure
|
704
|
+
end
|
705
|
+
|
706
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/chime-sdk-media-pipelines-2021-07-15/TagResourceResponse AWS API Documentation
|
707
|
+
#
|
708
|
+
class TagResourceResponse < Aws::EmptyStructure; end
|
709
|
+
|
710
|
+
# The client exceeded its request rate limit.
|
711
|
+
#
|
712
|
+
# @!attribute [rw] code
|
713
|
+
# @return [String]
|
714
|
+
#
|
715
|
+
# @!attribute [rw] message
|
716
|
+
# @return [String]
|
717
|
+
#
|
718
|
+
# @!attribute [rw] request_id
|
719
|
+
# The request id associated with the call responsible for the
|
720
|
+
# exception.
|
721
|
+
# @return [String]
|
722
|
+
#
|
723
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/chime-sdk-media-pipelines-2021-07-15/ThrottledClientException AWS API Documentation
|
724
|
+
#
|
725
|
+
class ThrottledClientException < Struct.new(
|
726
|
+
:code,
|
727
|
+
:message,
|
728
|
+
:request_id)
|
729
|
+
SENSITIVE = []
|
730
|
+
include Aws::Structure
|
731
|
+
end
|
732
|
+
|
733
|
+
# The client is not currently authorized to make the request.
|
734
|
+
#
|
735
|
+
# @!attribute [rw] code
|
736
|
+
# @return [String]
|
737
|
+
#
|
738
|
+
# @!attribute [rw] message
|
739
|
+
# @return [String]
|
740
|
+
#
|
741
|
+
# @!attribute [rw] request_id
|
742
|
+
# The request id associated with the call responsible for the
|
743
|
+
# exception.
|
744
|
+
# @return [String]
|
745
|
+
#
|
746
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/chime-sdk-media-pipelines-2021-07-15/UnauthorizedClientException AWS API Documentation
|
747
|
+
#
|
748
|
+
class UnauthorizedClientException < Struct.new(
|
749
|
+
:code,
|
750
|
+
:message,
|
751
|
+
:request_id)
|
752
|
+
SENSITIVE = []
|
753
|
+
include Aws::Structure
|
754
|
+
end
|
755
|
+
|
756
|
+
# @note When making an API call, you may pass UntagResourceRequest
|
757
|
+
# data as a hash:
|
758
|
+
#
|
759
|
+
# {
|
760
|
+
# resource_arn: "AmazonResourceName", # required
|
761
|
+
# tag_keys: ["TagKey"], # required
|
762
|
+
# }
|
763
|
+
#
|
764
|
+
# @!attribute [rw] resource_arn
|
765
|
+
# The resource ARN.
|
766
|
+
# @return [String]
|
767
|
+
#
|
768
|
+
# @!attribute [rw] tag_keys
|
769
|
+
# The tag keys.
|
770
|
+
# @return [Array<String>]
|
771
|
+
#
|
772
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/chime-sdk-media-pipelines-2021-07-15/UntagResourceRequest AWS API Documentation
|
773
|
+
#
|
774
|
+
class UntagResourceRequest < Struct.new(
|
775
|
+
:resource_arn,
|
776
|
+
:tag_keys)
|
777
|
+
SENSITIVE = []
|
778
|
+
include Aws::Structure
|
779
|
+
end
|
780
|
+
|
781
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/chime-sdk-media-pipelines-2021-07-15/UntagResourceResponse AWS API Documentation
|
782
|
+
#
|
783
|
+
class UntagResourceResponse < Aws::EmptyStructure; end
|
784
|
+
|
785
|
+
# The video artifact configuration object.
|
786
|
+
#
|
787
|
+
# @note When making an API call, you may pass VideoArtifactsConfiguration
|
788
|
+
# data as a hash:
|
789
|
+
#
|
790
|
+
# {
|
791
|
+
# state: "Enabled", # required, accepts Enabled, Disabled
|
792
|
+
# mux_type: "VideoOnly", # accepts VideoOnly
|
793
|
+
# }
|
794
|
+
#
|
795
|
+
# @!attribute [rw] state
|
796
|
+
# Indicates whether the video artifact is enabled or disabled.
|
797
|
+
# @return [String]
|
798
|
+
#
|
799
|
+
# @!attribute [rw] mux_type
|
800
|
+
# The MUX type of the video artifact configuration object.
|
801
|
+
# @return [String]
|
802
|
+
#
|
803
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/chime-sdk-media-pipelines-2021-07-15/VideoArtifactsConfiguration AWS API Documentation
|
804
|
+
#
|
805
|
+
class VideoArtifactsConfiguration < Struct.new(
|
806
|
+
:state,
|
807
|
+
:mux_type)
|
808
|
+
SENSITIVE = []
|
809
|
+
include Aws::Structure
|
810
|
+
end
|
811
|
+
|
812
|
+
end
|
813
|
+
end
|