aws-sdk-chimesdkmediapipelines 1.0.0 → 1.1.0
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/CHANGELOG.md +5 -0
- data/VERSION +1 -1
- data/lib/aws-sdk-chimesdkmediapipelines/client.rb +405 -23
- data/lib/aws-sdk-chimesdkmediapipelines/client_api.rb +285 -0
- data/lib/aws-sdk-chimesdkmediapipelines/types.rb +1192 -57
- data/lib/aws-sdk-chimesdkmediapipelines.rb +1 -1
- metadata +2 -2
checksums.yaml
CHANGED
@@ -1,7 +1,7 @@
|
|
1
1
|
---
|
2
2
|
SHA256:
|
3
|
-
metadata.gz:
|
4
|
-
data.tar.gz:
|
3
|
+
metadata.gz: 01f89b16db752d4fe282bad74d47dd73928fde085db28481baf4e982b97338da
|
4
|
+
data.tar.gz: 350e1922514645563b98336deac3cf4bce6e69c5d9ed6564701ec013b8463f29
|
5
5
|
SHA512:
|
6
|
-
metadata.gz:
|
7
|
-
data.tar.gz:
|
6
|
+
metadata.gz: 9a6335db98315b8782be9fe8e9e94dc300126523618b05595d7474b9401ab13de40c0c68ba7ef37a24b2446cb92de97afafc7c4be130ab1154792c7a55bc6940
|
7
|
+
data.tar.gz: c8a2936e7b5d29e5057f3316deba492b4fbb538ff3bbb530b86251bd86a59e6ce723db47415b839d1dbdb00321e0b2d988d0d5bf0cfc002ce07efbac2fe87260
|
data/CHANGELOG.md
CHANGED
@@ -1,6 +1,11 @@
|
|
1
1
|
Unreleased Changes
|
2
2
|
------------------
|
3
3
|
|
4
|
+
1.1.0 (2022-08-18)
|
5
|
+
------------------
|
6
|
+
|
7
|
+
* Feature - The Amazon Chime SDK now supports live streaming of real-time video from the Amazon Chime SDK sessions to streaming platforms such as Amazon IVS and Amazon Elemental MediaLive. We have also added support for concatenation to create a single media capture file.
|
8
|
+
|
4
9
|
1.0.0 (2022-04-27)
|
5
10
|
------------------
|
6
11
|
|
data/VERSION
CHANGED
@@ -1 +1 @@
|
|
1
|
-
1.
|
1
|
+
1.1.0
|
@@ -351,7 +351,7 @@ module Aws::ChimeSDKMediaPipelines
|
|
351
351
|
|
352
352
|
# @!group API Operations
|
353
353
|
|
354
|
-
# Creates a media
|
354
|
+
# Creates a media pipeline.
|
355
355
|
#
|
356
356
|
# @option params [required, String] :source_type
|
357
357
|
# Source type from which the media artifacts are captured. A Chime SDK
|
@@ -368,17 +368,19 @@ module Aws::ChimeSDKMediaPipelines
|
|
368
368
|
# The ARN of the sink type.
|
369
369
|
#
|
370
370
|
# @option params [String] :client_request_token
|
371
|
-
# The
|
371
|
+
# The unique identifier for the client request. The token makes the API
|
372
|
+
# request idempotent. Use a unique token for each media pipeline
|
373
|
+
# request.
|
372
374
|
#
|
373
375
|
# **A suitable default value is auto-generated.** You should normally
|
374
376
|
# not need to pass this option.**
|
375
377
|
#
|
376
378
|
# @option params [Types::ChimeSdkMeetingConfiguration] :chime_sdk_meeting_configuration
|
377
|
-
# The configuration for a specified media
|
378
|
-
#
|
379
|
+
# The configuration for a specified media pipeline. `SourceType` must be
|
380
|
+
# `ChimeSdkMeeting`.
|
379
381
|
#
|
380
382
|
# @option params [Array<Types::Tag>] :tags
|
381
|
-
# The
|
383
|
+
# The tag key-value pairs.
|
382
384
|
#
|
383
385
|
# @return [Types::CreateMediaCapturePipelineResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
384
386
|
#
|
@@ -401,7 +403,7 @@ module Aws::ChimeSDKMediaPipelines
|
|
401
403
|
# },
|
402
404
|
# artifacts_configuration: {
|
403
405
|
# audio: { # required
|
404
|
-
# mux_type: "AudioOnly", # required, accepts AudioOnly, AudioWithActiveSpeakerVideo
|
406
|
+
# mux_type: "AudioOnly", # required, accepts AudioOnly, AudioWithActiveSpeakerVideo, AudioWithCompositedVideo
|
405
407
|
# },
|
406
408
|
# video: { # required
|
407
409
|
# state: "Enabled", # required, accepts Enabled, Disabled
|
@@ -411,6 +413,16 @@ module Aws::ChimeSDKMediaPipelines
|
|
411
413
|
# state: "Enabled", # required, accepts Enabled, Disabled
|
412
414
|
# mux_type: "ContentOnly", # accepts ContentOnly
|
413
415
|
# },
|
416
|
+
# composited_video: {
|
417
|
+
# layout: "GridView", # accepts GridView
|
418
|
+
# resolution: "HD", # accepts HD, FHD
|
419
|
+
# grid_view_configuration: { # required
|
420
|
+
# content_share_layout: "PresenterOnly", # required, accepts PresenterOnly, Horizontal, Vertical
|
421
|
+
# presenter_only_configuration: {
|
422
|
+
# presenter_position: "TopLeft", # accepts TopLeft, TopRight, BottomLeft, BottomRight
|
423
|
+
# },
|
424
|
+
# },
|
425
|
+
# },
|
414
426
|
# },
|
415
427
|
# },
|
416
428
|
# tags: [
|
@@ -436,11 +448,15 @@ module Aws::ChimeSDKMediaPipelines
|
|
436
448
|
# resp.media_capture_pipeline.chime_sdk_meeting_configuration.source_configuration.selected_video_streams.attendee_ids[0] #=> String
|
437
449
|
# resp.media_capture_pipeline.chime_sdk_meeting_configuration.source_configuration.selected_video_streams.external_user_ids #=> Array
|
438
450
|
# 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"
|
451
|
+
# resp.media_capture_pipeline.chime_sdk_meeting_configuration.artifacts_configuration.audio.mux_type #=> String, one of "AudioOnly", "AudioWithActiveSpeakerVideo", "AudioWithCompositedVideo"
|
440
452
|
# resp.media_capture_pipeline.chime_sdk_meeting_configuration.artifacts_configuration.video.state #=> String, one of "Enabled", "Disabled"
|
441
453
|
# resp.media_capture_pipeline.chime_sdk_meeting_configuration.artifacts_configuration.video.mux_type #=> String, one of "VideoOnly"
|
442
454
|
# resp.media_capture_pipeline.chime_sdk_meeting_configuration.artifacts_configuration.content.state #=> String, one of "Enabled", "Disabled"
|
443
455
|
# resp.media_capture_pipeline.chime_sdk_meeting_configuration.artifacts_configuration.content.mux_type #=> String, one of "ContentOnly"
|
456
|
+
# resp.media_capture_pipeline.chime_sdk_meeting_configuration.artifacts_configuration.composited_video.layout #=> String, one of "GridView"
|
457
|
+
# resp.media_capture_pipeline.chime_sdk_meeting_configuration.artifacts_configuration.composited_video.resolution #=> String, one of "HD", "FHD"
|
458
|
+
# resp.media_capture_pipeline.chime_sdk_meeting_configuration.artifacts_configuration.composited_video.grid_view_configuration.content_share_layout #=> String, one of "PresenterOnly", "Horizontal", "Vertical"
|
459
|
+
# resp.media_capture_pipeline.chime_sdk_meeting_configuration.artifacts_configuration.composited_video.grid_view_configuration.presenter_only_configuration.presenter_position #=> String, one of "TopLeft", "TopRight", "BottomLeft", "BottomRight"
|
444
460
|
#
|
445
461
|
# @see http://docs.aws.amazon.com/goto/WebAPI/chime-sdk-media-pipelines-2021-07-15/CreateMediaCapturePipeline AWS API Documentation
|
446
462
|
#
|
@@ -451,10 +467,220 @@ module Aws::ChimeSDKMediaPipelines
|
|
451
467
|
req.send_request(options)
|
452
468
|
end
|
453
469
|
|
454
|
-
#
|
470
|
+
# Creates a media concatenation pipeline.
|
471
|
+
#
|
472
|
+
# @option params [required, Array<Types::ConcatenationSource>] :sources
|
473
|
+
# An object that specifies the sources for the media concatenation
|
474
|
+
# pipeline.
|
475
|
+
#
|
476
|
+
# @option params [required, Array<Types::ConcatenationSink>] :sinks
|
477
|
+
# An object that specifies the data sinks for the media concatenation
|
478
|
+
# pipeline.
|
479
|
+
#
|
480
|
+
# @option params [String] :client_request_token
|
481
|
+
# The unique identifier for the client request. The token makes the API
|
482
|
+
# request idempotent. Use a unique token for each media concatenation
|
483
|
+
# pipeline request.
|
484
|
+
#
|
485
|
+
# **A suitable default value is auto-generated.** You should normally
|
486
|
+
# not need to pass this option.**
|
487
|
+
#
|
488
|
+
# @option params [Array<Types::Tag>] :tags
|
489
|
+
# The tags associated with the media concatenation pipeline.
|
490
|
+
#
|
491
|
+
# @return [Types::CreateMediaConcatenationPipelineResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
492
|
+
#
|
493
|
+
# * {Types::CreateMediaConcatenationPipelineResponse#media_concatenation_pipeline #media_concatenation_pipeline} => Types::MediaConcatenationPipeline
|
494
|
+
#
|
495
|
+
# @example Request syntax with placeholder values
|
496
|
+
#
|
497
|
+
# resp = client.create_media_concatenation_pipeline({
|
498
|
+
# sources: [ # required
|
499
|
+
# {
|
500
|
+
# type: "MediaCapturePipeline", # required, accepts MediaCapturePipeline
|
501
|
+
# media_capture_pipeline_source_configuration: { # required
|
502
|
+
# media_pipeline_arn: "Arn", # required
|
503
|
+
# chime_sdk_meeting_configuration: { # required
|
504
|
+
# artifacts_configuration: { # required
|
505
|
+
# audio: { # required
|
506
|
+
# state: "Enabled", # required, accepts Enabled
|
507
|
+
# },
|
508
|
+
# video: { # required
|
509
|
+
# state: "Enabled", # required, accepts Enabled, Disabled
|
510
|
+
# },
|
511
|
+
# content: { # required
|
512
|
+
# state: "Enabled", # required, accepts Enabled, Disabled
|
513
|
+
# },
|
514
|
+
# data_channel: { # required
|
515
|
+
# state: "Enabled", # required, accepts Enabled, Disabled
|
516
|
+
# },
|
517
|
+
# transcription_messages: { # required
|
518
|
+
# state: "Enabled", # required, accepts Enabled, Disabled
|
519
|
+
# },
|
520
|
+
# meeting_events: { # required
|
521
|
+
# state: "Enabled", # required, accepts Enabled, Disabled
|
522
|
+
# },
|
523
|
+
# composited_video: { # required
|
524
|
+
# state: "Enabled", # required, accepts Enabled, Disabled
|
525
|
+
# },
|
526
|
+
# },
|
527
|
+
# },
|
528
|
+
# },
|
529
|
+
# },
|
530
|
+
# ],
|
531
|
+
# sinks: [ # required
|
532
|
+
# {
|
533
|
+
# type: "S3Bucket", # required, accepts S3Bucket
|
534
|
+
# s3_bucket_sink_configuration: { # required
|
535
|
+
# destination: "Arn", # required
|
536
|
+
# },
|
537
|
+
# },
|
538
|
+
# ],
|
539
|
+
# client_request_token: "ClientRequestToken",
|
540
|
+
# tags: [
|
541
|
+
# {
|
542
|
+
# key: "TagKey", # required
|
543
|
+
# value: "TagValue", # required
|
544
|
+
# },
|
545
|
+
# ],
|
546
|
+
# })
|
547
|
+
#
|
548
|
+
# @example Response structure
|
549
|
+
#
|
550
|
+
# resp.media_concatenation_pipeline.media_pipeline_id #=> String
|
551
|
+
# resp.media_concatenation_pipeline.media_pipeline_arn #=> String
|
552
|
+
# resp.media_concatenation_pipeline.sources #=> Array
|
553
|
+
# resp.media_concatenation_pipeline.sources[0].type #=> String, one of "MediaCapturePipeline"
|
554
|
+
# resp.media_concatenation_pipeline.sources[0].media_capture_pipeline_source_configuration.media_pipeline_arn #=> String
|
555
|
+
# resp.media_concatenation_pipeline.sources[0].media_capture_pipeline_source_configuration.chime_sdk_meeting_configuration.artifacts_configuration.audio.state #=> String, one of "Enabled"
|
556
|
+
# resp.media_concatenation_pipeline.sources[0].media_capture_pipeline_source_configuration.chime_sdk_meeting_configuration.artifacts_configuration.video.state #=> String, one of "Enabled", "Disabled"
|
557
|
+
# resp.media_concatenation_pipeline.sources[0].media_capture_pipeline_source_configuration.chime_sdk_meeting_configuration.artifacts_configuration.content.state #=> String, one of "Enabled", "Disabled"
|
558
|
+
# resp.media_concatenation_pipeline.sources[0].media_capture_pipeline_source_configuration.chime_sdk_meeting_configuration.artifacts_configuration.data_channel.state #=> String, one of "Enabled", "Disabled"
|
559
|
+
# resp.media_concatenation_pipeline.sources[0].media_capture_pipeline_source_configuration.chime_sdk_meeting_configuration.artifacts_configuration.transcription_messages.state #=> String, one of "Enabled", "Disabled"
|
560
|
+
# resp.media_concatenation_pipeline.sources[0].media_capture_pipeline_source_configuration.chime_sdk_meeting_configuration.artifacts_configuration.meeting_events.state #=> String, one of "Enabled", "Disabled"
|
561
|
+
# resp.media_concatenation_pipeline.sources[0].media_capture_pipeline_source_configuration.chime_sdk_meeting_configuration.artifacts_configuration.composited_video.state #=> String, one of "Enabled", "Disabled"
|
562
|
+
# resp.media_concatenation_pipeline.sinks #=> Array
|
563
|
+
# resp.media_concatenation_pipeline.sinks[0].type #=> String, one of "S3Bucket"
|
564
|
+
# resp.media_concatenation_pipeline.sinks[0].s3_bucket_sink_configuration.destination #=> String
|
565
|
+
# resp.media_concatenation_pipeline.status #=> String, one of "Initializing", "InProgress", "Failed", "Stopping", "Stopped"
|
566
|
+
# resp.media_concatenation_pipeline.created_timestamp #=> Time
|
567
|
+
# resp.media_concatenation_pipeline.updated_timestamp #=> Time
|
568
|
+
#
|
569
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/chime-sdk-media-pipelines-2021-07-15/CreateMediaConcatenationPipeline AWS API Documentation
|
570
|
+
#
|
571
|
+
# @overload create_media_concatenation_pipeline(params = {})
|
572
|
+
# @param [Hash] params ({})
|
573
|
+
def create_media_concatenation_pipeline(params = {}, options = {})
|
574
|
+
req = build_request(:create_media_concatenation_pipeline, params)
|
575
|
+
req.send_request(options)
|
576
|
+
end
|
577
|
+
|
578
|
+
# Creates a streaming media pipeline in an Amazon Chime SDK meeting.
|
579
|
+
#
|
580
|
+
# @option params [required, Array<Types::LiveConnectorSourceConfiguration>] :sources
|
581
|
+
# The media pipeline's data sources.
|
582
|
+
#
|
583
|
+
# @option params [required, Array<Types::LiveConnectorSinkConfiguration>] :sinks
|
584
|
+
# The media pipeline's data sinks.
|
585
|
+
#
|
586
|
+
# @option params [String] :client_request_token
|
587
|
+
# The token assigned to the client making the request.
|
588
|
+
#
|
589
|
+
# **A suitable default value is auto-generated.** You should normally
|
590
|
+
# not need to pass this option.**
|
591
|
+
#
|
592
|
+
# @option params [Array<Types::Tag>] :tags
|
593
|
+
# The tags associated with the media pipeline.
|
594
|
+
#
|
595
|
+
# @return [Types::CreateMediaLiveConnectorPipelineResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
596
|
+
#
|
597
|
+
# * {Types::CreateMediaLiveConnectorPipelineResponse#media_live_connector_pipeline #media_live_connector_pipeline} => Types::MediaLiveConnectorPipeline
|
598
|
+
#
|
599
|
+
# @example Request syntax with placeholder values
|
600
|
+
#
|
601
|
+
# resp = client.create_media_live_connector_pipeline({
|
602
|
+
# sources: [ # required
|
603
|
+
# {
|
604
|
+
# source_type: "ChimeSdkMeeting", # required, accepts ChimeSdkMeeting
|
605
|
+
# chime_sdk_meeting_live_connector_configuration: { # required
|
606
|
+
# arn: "Arn", # required
|
607
|
+
# mux_type: "AudioWithCompositedVideo", # required, accepts AudioWithCompositedVideo, AudioWithActiveSpeakerVideo
|
608
|
+
# composited_video: {
|
609
|
+
# layout: "GridView", # accepts GridView
|
610
|
+
# resolution: "HD", # accepts HD, FHD
|
611
|
+
# grid_view_configuration: { # required
|
612
|
+
# content_share_layout: "PresenterOnly", # required, accepts PresenterOnly, Horizontal, Vertical
|
613
|
+
# presenter_only_configuration: {
|
614
|
+
# presenter_position: "TopLeft", # accepts TopLeft, TopRight, BottomLeft, BottomRight
|
615
|
+
# },
|
616
|
+
# },
|
617
|
+
# },
|
618
|
+
# source_configuration: {
|
619
|
+
# selected_video_streams: {
|
620
|
+
# attendee_ids: ["GuidString"],
|
621
|
+
# external_user_ids: ["ExternalUserIdType"],
|
622
|
+
# },
|
623
|
+
# },
|
624
|
+
# },
|
625
|
+
# },
|
626
|
+
# ],
|
627
|
+
# sinks: [ # required
|
628
|
+
# {
|
629
|
+
# sink_type: "RTMP", # required, accepts RTMP
|
630
|
+
# rtmp_configuration: { # required
|
631
|
+
# url: "SensitiveString", # required
|
632
|
+
# audio_channels: "Stereo", # accepts Stereo, Mono
|
633
|
+
# audio_sample_rate: "AudioSampleRateOption",
|
634
|
+
# },
|
635
|
+
# },
|
636
|
+
# ],
|
637
|
+
# client_request_token: "ClientRequestToken",
|
638
|
+
# tags: [
|
639
|
+
# {
|
640
|
+
# key: "TagKey", # required
|
641
|
+
# value: "TagValue", # required
|
642
|
+
# },
|
643
|
+
# ],
|
644
|
+
# })
|
645
|
+
#
|
646
|
+
# @example Response structure
|
647
|
+
#
|
648
|
+
# resp.media_live_connector_pipeline.sources #=> Array
|
649
|
+
# resp.media_live_connector_pipeline.sources[0].source_type #=> String, one of "ChimeSdkMeeting"
|
650
|
+
# resp.media_live_connector_pipeline.sources[0].chime_sdk_meeting_live_connector_configuration.arn #=> String
|
651
|
+
# resp.media_live_connector_pipeline.sources[0].chime_sdk_meeting_live_connector_configuration.mux_type #=> String, one of "AudioWithCompositedVideo", "AudioWithActiveSpeakerVideo"
|
652
|
+
# resp.media_live_connector_pipeline.sources[0].chime_sdk_meeting_live_connector_configuration.composited_video.layout #=> String, one of "GridView"
|
653
|
+
# resp.media_live_connector_pipeline.sources[0].chime_sdk_meeting_live_connector_configuration.composited_video.resolution #=> String, one of "HD", "FHD"
|
654
|
+
# resp.media_live_connector_pipeline.sources[0].chime_sdk_meeting_live_connector_configuration.composited_video.grid_view_configuration.content_share_layout #=> String, one of "PresenterOnly", "Horizontal", "Vertical"
|
655
|
+
# resp.media_live_connector_pipeline.sources[0].chime_sdk_meeting_live_connector_configuration.composited_video.grid_view_configuration.presenter_only_configuration.presenter_position #=> String, one of "TopLeft", "TopRight", "BottomLeft", "BottomRight"
|
656
|
+
# resp.media_live_connector_pipeline.sources[0].chime_sdk_meeting_live_connector_configuration.source_configuration.selected_video_streams.attendee_ids #=> Array
|
657
|
+
# resp.media_live_connector_pipeline.sources[0].chime_sdk_meeting_live_connector_configuration.source_configuration.selected_video_streams.attendee_ids[0] #=> String
|
658
|
+
# resp.media_live_connector_pipeline.sources[0].chime_sdk_meeting_live_connector_configuration.source_configuration.selected_video_streams.external_user_ids #=> Array
|
659
|
+
# resp.media_live_connector_pipeline.sources[0].chime_sdk_meeting_live_connector_configuration.source_configuration.selected_video_streams.external_user_ids[0] #=> String
|
660
|
+
# resp.media_live_connector_pipeline.sinks #=> Array
|
661
|
+
# resp.media_live_connector_pipeline.sinks[0].sink_type #=> String, one of "RTMP"
|
662
|
+
# resp.media_live_connector_pipeline.sinks[0].rtmp_configuration.url #=> String
|
663
|
+
# resp.media_live_connector_pipeline.sinks[0].rtmp_configuration.audio_channels #=> String, one of "Stereo", "Mono"
|
664
|
+
# resp.media_live_connector_pipeline.sinks[0].rtmp_configuration.audio_sample_rate #=> String
|
665
|
+
# resp.media_live_connector_pipeline.media_pipeline_id #=> String
|
666
|
+
# resp.media_live_connector_pipeline.media_pipeline_arn #=> String
|
667
|
+
# resp.media_live_connector_pipeline.status #=> String, one of "Initializing", "InProgress", "Failed", "Stopping", "Stopped"
|
668
|
+
# resp.media_live_connector_pipeline.created_timestamp #=> Time
|
669
|
+
# resp.media_live_connector_pipeline.updated_timestamp #=> Time
|
670
|
+
#
|
671
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/chime-sdk-media-pipelines-2021-07-15/CreateMediaLiveConnectorPipeline AWS API Documentation
|
672
|
+
#
|
673
|
+
# @overload create_media_live_connector_pipeline(params = {})
|
674
|
+
# @param [Hash] params ({})
|
675
|
+
def create_media_live_connector_pipeline(params = {}, options = {})
|
676
|
+
req = build_request(:create_media_live_connector_pipeline, params)
|
677
|
+
req.send_request(options)
|
678
|
+
end
|
679
|
+
|
680
|
+
# Deletes the media pipeline.
|
455
681
|
#
|
456
682
|
# @option params [required, String] :media_pipeline_id
|
457
|
-
# The ID of the media
|
683
|
+
# The ID of the media pipeline being deleted.
|
458
684
|
#
|
459
685
|
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
460
686
|
#
|
@@ -473,7 +699,29 @@ module Aws::ChimeSDKMediaPipelines
|
|
473
699
|
req.send_request(options)
|
474
700
|
end
|
475
701
|
|
476
|
-
#
|
702
|
+
# Deletes the media pipeline.
|
703
|
+
#
|
704
|
+
# @option params [required, String] :media_pipeline_id
|
705
|
+
# The ID of the media pipeline to delete.
|
706
|
+
#
|
707
|
+
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
708
|
+
#
|
709
|
+
# @example Request syntax with placeholder values
|
710
|
+
#
|
711
|
+
# resp = client.delete_media_pipeline({
|
712
|
+
# media_pipeline_id: "GuidString", # required
|
713
|
+
# })
|
714
|
+
#
|
715
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/chime-sdk-media-pipelines-2021-07-15/DeleteMediaPipeline AWS API Documentation
|
716
|
+
#
|
717
|
+
# @overload delete_media_pipeline(params = {})
|
718
|
+
# @param [Hash] params ({})
|
719
|
+
def delete_media_pipeline(params = {}, options = {})
|
720
|
+
req = build_request(:delete_media_pipeline, params)
|
721
|
+
req.send_request(options)
|
722
|
+
end
|
723
|
+
|
724
|
+
# Gets an existing media pipeline.
|
477
725
|
#
|
478
726
|
# @option params [required, String] :media_pipeline_id
|
479
727
|
# The ID of the pipeline that you want to get.
|
@@ -503,11 +751,15 @@ module Aws::ChimeSDKMediaPipelines
|
|
503
751
|
# resp.media_capture_pipeline.chime_sdk_meeting_configuration.source_configuration.selected_video_streams.attendee_ids[0] #=> String
|
504
752
|
# resp.media_capture_pipeline.chime_sdk_meeting_configuration.source_configuration.selected_video_streams.external_user_ids #=> Array
|
505
753
|
# 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"
|
754
|
+
# resp.media_capture_pipeline.chime_sdk_meeting_configuration.artifacts_configuration.audio.mux_type #=> String, one of "AudioOnly", "AudioWithActiveSpeakerVideo", "AudioWithCompositedVideo"
|
507
755
|
# resp.media_capture_pipeline.chime_sdk_meeting_configuration.artifacts_configuration.video.state #=> String, one of "Enabled", "Disabled"
|
508
756
|
# resp.media_capture_pipeline.chime_sdk_meeting_configuration.artifacts_configuration.video.mux_type #=> String, one of "VideoOnly"
|
509
757
|
# resp.media_capture_pipeline.chime_sdk_meeting_configuration.artifacts_configuration.content.state #=> String, one of "Enabled", "Disabled"
|
510
758
|
# resp.media_capture_pipeline.chime_sdk_meeting_configuration.artifacts_configuration.content.mux_type #=> String, one of "ContentOnly"
|
759
|
+
# resp.media_capture_pipeline.chime_sdk_meeting_configuration.artifacts_configuration.composited_video.layout #=> String, one of "GridView"
|
760
|
+
# resp.media_capture_pipeline.chime_sdk_meeting_configuration.artifacts_configuration.composited_video.resolution #=> String, one of "HD", "FHD"
|
761
|
+
# resp.media_capture_pipeline.chime_sdk_meeting_configuration.artifacts_configuration.composited_video.grid_view_configuration.content_share_layout #=> String, one of "PresenterOnly", "Horizontal", "Vertical"
|
762
|
+
# resp.media_capture_pipeline.chime_sdk_meeting_configuration.artifacts_configuration.composited_video.grid_view_configuration.presenter_only_configuration.presenter_position #=> String, one of "TopLeft", "TopRight", "BottomLeft", "BottomRight"
|
511
763
|
#
|
512
764
|
# @see http://docs.aws.amazon.com/goto/WebAPI/chime-sdk-media-pipelines-2021-07-15/GetMediaCapturePipeline AWS API Documentation
|
513
765
|
#
|
@@ -518,7 +770,96 @@ module Aws::ChimeSDKMediaPipelines
|
|
518
770
|
req.send_request(options)
|
519
771
|
end
|
520
772
|
|
521
|
-
#
|
773
|
+
# Gets an existing media pipeline.
|
774
|
+
#
|
775
|
+
# @option params [required, String] :media_pipeline_id
|
776
|
+
# The ID of the pipeline that you want to get.
|
777
|
+
#
|
778
|
+
# @return [Types::GetMediaPipelineResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
779
|
+
#
|
780
|
+
# * {Types::GetMediaPipelineResponse#media_pipeline #media_pipeline} => Types::MediaPipeline
|
781
|
+
#
|
782
|
+
# @example Request syntax with placeholder values
|
783
|
+
#
|
784
|
+
# resp = client.get_media_pipeline({
|
785
|
+
# media_pipeline_id: "GuidString", # required
|
786
|
+
# })
|
787
|
+
#
|
788
|
+
# @example Response structure
|
789
|
+
#
|
790
|
+
# resp.media_pipeline.media_capture_pipeline.media_pipeline_id #=> String
|
791
|
+
# resp.media_pipeline.media_capture_pipeline.media_pipeline_arn #=> String
|
792
|
+
# resp.media_pipeline.media_capture_pipeline.source_type #=> String, one of "ChimeSdkMeeting"
|
793
|
+
# resp.media_pipeline.media_capture_pipeline.source_arn #=> String
|
794
|
+
# resp.media_pipeline.media_capture_pipeline.status #=> String, one of "Initializing", "InProgress", "Failed", "Stopping", "Stopped"
|
795
|
+
# resp.media_pipeline.media_capture_pipeline.sink_type #=> String, one of "S3Bucket"
|
796
|
+
# resp.media_pipeline.media_capture_pipeline.sink_arn #=> String
|
797
|
+
# resp.media_pipeline.media_capture_pipeline.created_timestamp #=> Time
|
798
|
+
# resp.media_pipeline.media_capture_pipeline.updated_timestamp #=> Time
|
799
|
+
# resp.media_pipeline.media_capture_pipeline.chime_sdk_meeting_configuration.source_configuration.selected_video_streams.attendee_ids #=> Array
|
800
|
+
# resp.media_pipeline.media_capture_pipeline.chime_sdk_meeting_configuration.source_configuration.selected_video_streams.attendee_ids[0] #=> String
|
801
|
+
# resp.media_pipeline.media_capture_pipeline.chime_sdk_meeting_configuration.source_configuration.selected_video_streams.external_user_ids #=> Array
|
802
|
+
# resp.media_pipeline.media_capture_pipeline.chime_sdk_meeting_configuration.source_configuration.selected_video_streams.external_user_ids[0] #=> String
|
803
|
+
# resp.media_pipeline.media_capture_pipeline.chime_sdk_meeting_configuration.artifacts_configuration.audio.mux_type #=> String, one of "AudioOnly", "AudioWithActiveSpeakerVideo", "AudioWithCompositedVideo"
|
804
|
+
# resp.media_pipeline.media_capture_pipeline.chime_sdk_meeting_configuration.artifacts_configuration.video.state #=> String, one of "Enabled", "Disabled"
|
805
|
+
# resp.media_pipeline.media_capture_pipeline.chime_sdk_meeting_configuration.artifacts_configuration.video.mux_type #=> String, one of "VideoOnly"
|
806
|
+
# resp.media_pipeline.media_capture_pipeline.chime_sdk_meeting_configuration.artifacts_configuration.content.state #=> String, one of "Enabled", "Disabled"
|
807
|
+
# resp.media_pipeline.media_capture_pipeline.chime_sdk_meeting_configuration.artifacts_configuration.content.mux_type #=> String, one of "ContentOnly"
|
808
|
+
# resp.media_pipeline.media_capture_pipeline.chime_sdk_meeting_configuration.artifacts_configuration.composited_video.layout #=> String, one of "GridView"
|
809
|
+
# resp.media_pipeline.media_capture_pipeline.chime_sdk_meeting_configuration.artifacts_configuration.composited_video.resolution #=> String, one of "HD", "FHD"
|
810
|
+
# resp.media_pipeline.media_capture_pipeline.chime_sdk_meeting_configuration.artifacts_configuration.composited_video.grid_view_configuration.content_share_layout #=> String, one of "PresenterOnly", "Horizontal", "Vertical"
|
811
|
+
# resp.media_pipeline.media_capture_pipeline.chime_sdk_meeting_configuration.artifacts_configuration.composited_video.grid_view_configuration.presenter_only_configuration.presenter_position #=> String, one of "TopLeft", "TopRight", "BottomLeft", "BottomRight"
|
812
|
+
# resp.media_pipeline.media_live_connector_pipeline.sources #=> Array
|
813
|
+
# resp.media_pipeline.media_live_connector_pipeline.sources[0].source_type #=> String, one of "ChimeSdkMeeting"
|
814
|
+
# resp.media_pipeline.media_live_connector_pipeline.sources[0].chime_sdk_meeting_live_connector_configuration.arn #=> String
|
815
|
+
# resp.media_pipeline.media_live_connector_pipeline.sources[0].chime_sdk_meeting_live_connector_configuration.mux_type #=> String, one of "AudioWithCompositedVideo", "AudioWithActiveSpeakerVideo"
|
816
|
+
# resp.media_pipeline.media_live_connector_pipeline.sources[0].chime_sdk_meeting_live_connector_configuration.composited_video.layout #=> String, one of "GridView"
|
817
|
+
# resp.media_pipeline.media_live_connector_pipeline.sources[0].chime_sdk_meeting_live_connector_configuration.composited_video.resolution #=> String, one of "HD", "FHD"
|
818
|
+
# resp.media_pipeline.media_live_connector_pipeline.sources[0].chime_sdk_meeting_live_connector_configuration.composited_video.grid_view_configuration.content_share_layout #=> String, one of "PresenterOnly", "Horizontal", "Vertical"
|
819
|
+
# resp.media_pipeline.media_live_connector_pipeline.sources[0].chime_sdk_meeting_live_connector_configuration.composited_video.grid_view_configuration.presenter_only_configuration.presenter_position #=> String, one of "TopLeft", "TopRight", "BottomLeft", "BottomRight"
|
820
|
+
# resp.media_pipeline.media_live_connector_pipeline.sources[0].chime_sdk_meeting_live_connector_configuration.source_configuration.selected_video_streams.attendee_ids #=> Array
|
821
|
+
# resp.media_pipeline.media_live_connector_pipeline.sources[0].chime_sdk_meeting_live_connector_configuration.source_configuration.selected_video_streams.attendee_ids[0] #=> String
|
822
|
+
# resp.media_pipeline.media_live_connector_pipeline.sources[0].chime_sdk_meeting_live_connector_configuration.source_configuration.selected_video_streams.external_user_ids #=> Array
|
823
|
+
# resp.media_pipeline.media_live_connector_pipeline.sources[0].chime_sdk_meeting_live_connector_configuration.source_configuration.selected_video_streams.external_user_ids[0] #=> String
|
824
|
+
# resp.media_pipeline.media_live_connector_pipeline.sinks #=> Array
|
825
|
+
# resp.media_pipeline.media_live_connector_pipeline.sinks[0].sink_type #=> String, one of "RTMP"
|
826
|
+
# resp.media_pipeline.media_live_connector_pipeline.sinks[0].rtmp_configuration.url #=> String
|
827
|
+
# resp.media_pipeline.media_live_connector_pipeline.sinks[0].rtmp_configuration.audio_channels #=> String, one of "Stereo", "Mono"
|
828
|
+
# resp.media_pipeline.media_live_connector_pipeline.sinks[0].rtmp_configuration.audio_sample_rate #=> String
|
829
|
+
# resp.media_pipeline.media_live_connector_pipeline.media_pipeline_id #=> String
|
830
|
+
# resp.media_pipeline.media_live_connector_pipeline.media_pipeline_arn #=> String
|
831
|
+
# resp.media_pipeline.media_live_connector_pipeline.status #=> String, one of "Initializing", "InProgress", "Failed", "Stopping", "Stopped"
|
832
|
+
# resp.media_pipeline.media_live_connector_pipeline.created_timestamp #=> Time
|
833
|
+
# resp.media_pipeline.media_live_connector_pipeline.updated_timestamp #=> Time
|
834
|
+
# resp.media_pipeline.media_concatenation_pipeline.media_pipeline_id #=> String
|
835
|
+
# resp.media_pipeline.media_concatenation_pipeline.media_pipeline_arn #=> String
|
836
|
+
# resp.media_pipeline.media_concatenation_pipeline.sources #=> Array
|
837
|
+
# resp.media_pipeline.media_concatenation_pipeline.sources[0].type #=> String, one of "MediaCapturePipeline"
|
838
|
+
# resp.media_pipeline.media_concatenation_pipeline.sources[0].media_capture_pipeline_source_configuration.media_pipeline_arn #=> String
|
839
|
+
# resp.media_pipeline.media_concatenation_pipeline.sources[0].media_capture_pipeline_source_configuration.chime_sdk_meeting_configuration.artifacts_configuration.audio.state #=> String, one of "Enabled"
|
840
|
+
# resp.media_pipeline.media_concatenation_pipeline.sources[0].media_capture_pipeline_source_configuration.chime_sdk_meeting_configuration.artifacts_configuration.video.state #=> String, one of "Enabled", "Disabled"
|
841
|
+
# resp.media_pipeline.media_concatenation_pipeline.sources[0].media_capture_pipeline_source_configuration.chime_sdk_meeting_configuration.artifacts_configuration.content.state #=> String, one of "Enabled", "Disabled"
|
842
|
+
# resp.media_pipeline.media_concatenation_pipeline.sources[0].media_capture_pipeline_source_configuration.chime_sdk_meeting_configuration.artifacts_configuration.data_channel.state #=> String, one of "Enabled", "Disabled"
|
843
|
+
# resp.media_pipeline.media_concatenation_pipeline.sources[0].media_capture_pipeline_source_configuration.chime_sdk_meeting_configuration.artifacts_configuration.transcription_messages.state #=> String, one of "Enabled", "Disabled"
|
844
|
+
# resp.media_pipeline.media_concatenation_pipeline.sources[0].media_capture_pipeline_source_configuration.chime_sdk_meeting_configuration.artifacts_configuration.meeting_events.state #=> String, one of "Enabled", "Disabled"
|
845
|
+
# resp.media_pipeline.media_concatenation_pipeline.sources[0].media_capture_pipeline_source_configuration.chime_sdk_meeting_configuration.artifacts_configuration.composited_video.state #=> String, one of "Enabled", "Disabled"
|
846
|
+
# resp.media_pipeline.media_concatenation_pipeline.sinks #=> Array
|
847
|
+
# resp.media_pipeline.media_concatenation_pipeline.sinks[0].type #=> String, one of "S3Bucket"
|
848
|
+
# resp.media_pipeline.media_concatenation_pipeline.sinks[0].s3_bucket_sink_configuration.destination #=> String
|
849
|
+
# resp.media_pipeline.media_concatenation_pipeline.status #=> String, one of "Initializing", "InProgress", "Failed", "Stopping", "Stopped"
|
850
|
+
# resp.media_pipeline.media_concatenation_pipeline.created_timestamp #=> Time
|
851
|
+
# resp.media_pipeline.media_concatenation_pipeline.updated_timestamp #=> Time
|
852
|
+
#
|
853
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/chime-sdk-media-pipelines-2021-07-15/GetMediaPipeline AWS API Documentation
|
854
|
+
#
|
855
|
+
# @overload get_media_pipeline(params = {})
|
856
|
+
# @param [Hash] params ({})
|
857
|
+
def get_media_pipeline(params = {}, options = {})
|
858
|
+
req = build_request(:get_media_pipeline, params)
|
859
|
+
req.send_request(options)
|
860
|
+
end
|
861
|
+
|
862
|
+
# Returns a list of media pipelines.
|
522
863
|
#
|
523
864
|
# @option params [String] :next_token
|
524
865
|
# The token used to retrieve the next page of results.
|
@@ -557,10 +898,50 @@ module Aws::ChimeSDKMediaPipelines
|
|
557
898
|
req.send_request(options)
|
558
899
|
end
|
559
900
|
|
560
|
-
#
|
901
|
+
# Returns a list of media pipelines.
|
902
|
+
#
|
903
|
+
# @option params [String] :next_token
|
904
|
+
# The token used to retrieve the next page of results.
|
905
|
+
#
|
906
|
+
# @option params [Integer] :max_results
|
907
|
+
# The maximum number of results to return in a single call. Valid Range:
|
908
|
+
# 1 - 99.
|
909
|
+
#
|
910
|
+
# @return [Types::ListMediaPipelinesResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
911
|
+
#
|
912
|
+
# * {Types::ListMediaPipelinesResponse#media_pipelines #media_pipelines} => Array<Types::MediaPipelineSummary>
|
913
|
+
# * {Types::ListMediaPipelinesResponse#next_token #next_token} => String
|
914
|
+
#
|
915
|
+
# The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
|
916
|
+
#
|
917
|
+
# @example Request syntax with placeholder values
|
918
|
+
#
|
919
|
+
# resp = client.list_media_pipelines({
|
920
|
+
# next_token: "String",
|
921
|
+
# max_results: 1,
|
922
|
+
# })
|
923
|
+
#
|
924
|
+
# @example Response structure
|
925
|
+
#
|
926
|
+
# resp.media_pipelines #=> Array
|
927
|
+
# resp.media_pipelines[0].media_pipeline_id #=> String
|
928
|
+
# resp.media_pipelines[0].media_pipeline_arn #=> String
|
929
|
+
# resp.next_token #=> String
|
930
|
+
#
|
931
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/chime-sdk-media-pipelines-2021-07-15/ListMediaPipelines AWS API Documentation
|
932
|
+
#
|
933
|
+
# @overload list_media_pipelines(params = {})
|
934
|
+
# @param [Hash] params ({})
|
935
|
+
def list_media_pipelines(params = {}, options = {})
|
936
|
+
req = build_request(:list_media_pipelines, params)
|
937
|
+
req.send_request(options)
|
938
|
+
end
|
939
|
+
|
940
|
+
# Lists the tags available for a media pipeline.
|
561
941
|
#
|
562
942
|
# @option params [required, String] :resource_arn
|
563
|
-
# The
|
943
|
+
# The ARN of the media pipeline associated with any tags. The ARN
|
944
|
+
# consists of the pipeline's region, resource ID, and pipeline ID.
|
564
945
|
#
|
565
946
|
# @return [Types::ListTagsForResourceResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
566
947
|
#
|
@@ -587,14 +968,16 @@ module Aws::ChimeSDKMediaPipelines
|
|
587
968
|
req.send_request(options)
|
588
969
|
end
|
589
970
|
|
590
|
-
#
|
591
|
-
#
|
971
|
+
# The ARN of the media pipeline that you want to tag. Consists of he
|
972
|
+
# pipeline's endpoint region, resource ID, and pipeline ID.
|
592
973
|
#
|
593
974
|
# @option params [required, String] :resource_arn
|
594
|
-
# The
|
975
|
+
# The ARN of the media pipeline associated with any tags. The ARN
|
976
|
+
# consists of the pipeline's endpoint region, resource ID, and pipeline
|
977
|
+
# ID.
|
595
978
|
#
|
596
979
|
# @option params [required, Array<Types::Tag>] :tags
|
597
|
-
# The
|
980
|
+
# The tags associated with the specified media pipeline.
|
598
981
|
#
|
599
982
|
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
600
983
|
#
|
@@ -619,14 +1002,13 @@ module Aws::ChimeSDKMediaPipelines
|
|
619
1002
|
req.send_request(options)
|
620
1003
|
end
|
621
1004
|
|
622
|
-
# Removes
|
623
|
-
# capture pipeline.
|
1005
|
+
# Removes any tags from a media pipeline.
|
624
1006
|
#
|
625
1007
|
# @option params [required, String] :resource_arn
|
626
|
-
# The
|
1008
|
+
# The ARN of the pipeline that you want to untag.
|
627
1009
|
#
|
628
1010
|
# @option params [required, Array<String>] :tag_keys
|
629
|
-
# The tag
|
1011
|
+
# The key/value pairs in the tag that you want to remove.
|
630
1012
|
#
|
631
1013
|
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
632
1014
|
#
|
@@ -659,7 +1041,7 @@ module Aws::ChimeSDKMediaPipelines
|
|
659
1041
|
params: params,
|
660
1042
|
config: config)
|
661
1043
|
context[:gem_name] = 'aws-sdk-chimesdkmediapipelines'
|
662
|
-
context[:gem_version] = '1.
|
1044
|
+
context[:gem_version] = '1.1.0'
|
663
1045
|
Seahorse::Client::Request.new(handlers, context)
|
664
1046
|
end
|
665
1047
|
|