aws-sdk-ivs 1.61.0 → 1.62.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +4 -4
- data/CHANGELOG.md +5 -0
- data/VERSION +1 -1
- data/lib/aws-sdk-ivs/client.rb +235 -234
- data/lib/aws-sdk-ivs/client_api.rb +70 -68
- data/lib/aws-sdk-ivs/types.rb +432 -413
- data/lib/aws-sdk-ivs.rb +1 -1
- data/sig/client.rbs +42 -42
- data/sig/types.rbs +69 -68
- metadata +2 -2
data/lib/aws-sdk-ivs/client.rb
CHANGED
@@ -467,20 +467,20 @@ module Aws::IVS
|
|
467
467
|
#
|
468
468
|
# resp.channels #=> Array
|
469
469
|
# resp.channels[0].arn #=> String
|
470
|
-
# resp.channels[0].name #=> String
|
471
|
-
# resp.channels[0].latency_mode #=> String, one of "NORMAL", "LOW"
|
472
|
-
# resp.channels[0].type #=> String, one of "BASIC", "STANDARD", "ADVANCED_SD", "ADVANCED_HD"
|
473
|
-
# resp.channels[0].recording_configuration_arn #=> String
|
474
|
-
# resp.channels[0].ingest_endpoint #=> String
|
475
|
-
# resp.channels[0].playback_url #=> String
|
476
470
|
# resp.channels[0].authorized #=> Boolean
|
477
|
-
# resp.channels[0].
|
478
|
-
# resp.channels[0].tags["TagKey"] #=> String
|
471
|
+
# resp.channels[0].ingest_endpoint #=> String
|
479
472
|
# resp.channels[0].insecure_ingest #=> Boolean
|
473
|
+
# resp.channels[0].latency_mode #=> String, one of "NORMAL", "LOW"
|
474
|
+
# resp.channels[0].name #=> String
|
475
|
+
# resp.channels[0].playback_restriction_policy_arn #=> String
|
476
|
+
# resp.channels[0].playback_url #=> String
|
480
477
|
# resp.channels[0].preset #=> String, one of "HIGHER_BANDWIDTH_DELIVERY", "CONSTRAINED_BANDWIDTH_DELIVERY"
|
478
|
+
# resp.channels[0].recording_configuration_arn #=> String
|
481
479
|
# resp.channels[0].srt.endpoint #=> String
|
482
480
|
# resp.channels[0].srt.passphrase #=> String
|
483
|
-
# resp.channels[0].
|
481
|
+
# resp.channels[0].tags #=> Hash
|
482
|
+
# resp.channels[0].tags["TagKey"] #=> String
|
483
|
+
# resp.channels[0].type #=> String, one of "BASIC", "STANDARD", "ADVANCED_SD", "ADVANCED_HD"
|
484
484
|
# resp.errors #=> Array
|
485
485
|
# resp.errors[0].arn #=> String
|
486
486
|
# resp.errors[0].code #=> String
|
@@ -502,8 +502,8 @@ module Aws::IVS
|
|
502
502
|
#
|
503
503
|
# @return [Types::BatchGetStreamKeyResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
504
504
|
#
|
505
|
-
# * {Types::BatchGetStreamKeyResponse#stream_keys #stream_keys} => Array<Types::StreamKey>
|
506
505
|
# * {Types::BatchGetStreamKeyResponse#errors #errors} => Array<Types::BatchError>
|
506
|
+
# * {Types::BatchGetStreamKeyResponse#stream_keys #stream_keys} => Array<Types::StreamKey>
|
507
507
|
#
|
508
508
|
# @example Request syntax with placeholder values
|
509
509
|
#
|
@@ -513,16 +513,16 @@ module Aws::IVS
|
|
513
513
|
#
|
514
514
|
# @example Response structure
|
515
515
|
#
|
516
|
+
# resp.errors #=> Array
|
517
|
+
# resp.errors[0].arn #=> String
|
518
|
+
# resp.errors[0].code #=> String
|
519
|
+
# resp.errors[0].message #=> String
|
516
520
|
# resp.stream_keys #=> Array
|
517
521
|
# resp.stream_keys[0].arn #=> String
|
518
|
-
# resp.stream_keys[0].value #=> String
|
519
522
|
# resp.stream_keys[0].channel_arn #=> String
|
520
523
|
# resp.stream_keys[0].tags #=> Hash
|
521
524
|
# resp.stream_keys[0].tags["TagKey"] #=> String
|
522
|
-
# resp.
|
523
|
-
# resp.errors[0].arn #=> String
|
524
|
-
# resp.errors[0].code #=> String
|
525
|
-
# resp.errors[0].message #=> String
|
525
|
+
# resp.stream_keys[0].value #=> String
|
526
526
|
#
|
527
527
|
# @see http://docs.aws.amazon.com/goto/WebAPI/ivs-2020-07-14/BatchGetStreamKey AWS API Documentation
|
528
528
|
#
|
@@ -559,9 +559,9 @@ module Aws::IVS
|
|
559
559
|
#
|
560
560
|
# resp.errors #=> Array
|
561
561
|
# resp.errors[0].channel_arn #=> String
|
562
|
-
# resp.errors[0].viewer_id #=> String
|
563
562
|
# resp.errors[0].code #=> String
|
564
563
|
# resp.errors[0].message #=> String
|
564
|
+
# resp.errors[0].viewer_id #=> String
|
565
565
|
#
|
566
566
|
# @see http://docs.aws.amazon.com/goto/WebAPI/ivs-2020-07-14/BatchStartViewerSessionRevocation AWS API Documentation
|
567
567
|
#
|
@@ -574,27 +574,33 @@ module Aws::IVS
|
|
574
574
|
|
575
575
|
# Creates a new channel and an associated stream key to start streaming.
|
576
576
|
#
|
577
|
-
# @option params [
|
578
|
-
#
|
577
|
+
# @option params [Boolean] :authorized
|
578
|
+
# Whether the channel is private (enabled for playback authorization).
|
579
|
+
# Default: `false`.
|
580
|
+
#
|
581
|
+
# @option params [Boolean] :insecure_ingest
|
582
|
+
# Whether the channel allows insecure RTMP and SRT ingest. Default:
|
583
|
+
# `false`.
|
579
584
|
#
|
580
585
|
# @option params [String] :latency_mode
|
581
586
|
# Channel latency mode. Use `NORMAL` to broadcast and deliver live video
|
582
587
|
# up to Full HD. Use `LOW` for near-real-time interaction with viewers.
|
583
588
|
# Default: `LOW`.
|
584
589
|
#
|
585
|
-
# @option params [String] :
|
586
|
-
# Channel
|
587
|
-
# *If you exceed the allowable input resolution or bitrate, the stream
|
588
|
-
# probably will disconnect immediately.* Default: `STANDARD`. For
|
589
|
-
# details, see [Channel Types][1].
|
590
|
-
#
|
591
|
-
#
|
590
|
+
# @option params [String] :name
|
591
|
+
# Channel name.
|
592
592
|
#
|
593
|
-
#
|
593
|
+
# @option params [String] :playback_restriction_policy_arn
|
594
|
+
# Playback-restriction-policy ARN. A valid ARN value here both specifies
|
595
|
+
# the ARN and enables playback restriction. Default: "" (empty string,
|
596
|
+
# no playback restriction policy is applied).
|
594
597
|
#
|
595
|
-
# @option params [
|
596
|
-
#
|
597
|
-
#
|
598
|
+
# @option params [String] :preset
|
599
|
+
# Optional transcode preset for the channel. This is selectable only for
|
600
|
+
# `ADVANCED_HD` and `ADVANCED_SD` channel types. For those channel
|
601
|
+
# types, the default `preset` is `HIGHER_BANDWIDTH_DELIVERY`. For other
|
602
|
+
# channel types (`BASIC` and `STANDARD`), `preset` is the empty string
|
603
|
+
# (`""`).
|
598
604
|
#
|
599
605
|
# @option params [String] :recording_configuration_arn
|
600
606
|
# Recording-configuration ARN. A valid ARN value here both specifies the
|
@@ -612,21 +618,15 @@ module Aws::IVS
|
|
612
618
|
#
|
613
619
|
# [1]: https://docs.aws.amazon.com/tag-editor/latest/userguide/best-practices-and-strats.html
|
614
620
|
#
|
615
|
-
# @option params [
|
616
|
-
#
|
617
|
-
#
|
621
|
+
# @option params [String] :type
|
622
|
+
# Channel type, which determines the allowable resolution and bitrate.
|
623
|
+
# *If you exceed the allowable input resolution or bitrate, the stream
|
624
|
+
# probably will disconnect immediately.* Default: `STANDARD`. For
|
625
|
+
# details, see [Channel Types][1].
|
618
626
|
#
|
619
|
-
# @option params [String] :preset
|
620
|
-
# Optional transcode preset for the channel. This is selectable only for
|
621
|
-
# `ADVANCED_HD` and `ADVANCED_SD` channel types. For those channel
|
622
|
-
# types, the default `preset` is `HIGHER_BANDWIDTH_DELIVERY`. For other
|
623
|
-
# channel types (`BASIC` and `STANDARD`), `preset` is the empty string
|
624
|
-
# (`""`).
|
625
627
|
#
|
626
|
-
#
|
627
|
-
#
|
628
|
-
# the ARN and enables playback restriction. Default: "" (empty string,
|
629
|
-
# no playback restriction policy is applied).
|
628
|
+
#
|
629
|
+
# [1]: https://docs.aws.amazon.com/ivs/latest/LowLatencyAPIReference/channel-types.html
|
630
630
|
#
|
631
631
|
# @return [Types::CreateChannelResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
632
632
|
#
|
@@ -636,41 +636,41 @@ module Aws::IVS
|
|
636
636
|
# @example Request syntax with placeholder values
|
637
637
|
#
|
638
638
|
# resp = client.create_channel({
|
639
|
-
# name: "ChannelName",
|
640
|
-
# latency_mode: "NORMAL", # accepts NORMAL, LOW
|
641
|
-
# type: "BASIC", # accepts BASIC, STANDARD, ADVANCED_SD, ADVANCED_HD
|
642
639
|
# authorized: false,
|
640
|
+
# insecure_ingest: false,
|
641
|
+
# latency_mode: "NORMAL", # accepts NORMAL, LOW
|
642
|
+
# name: "ChannelName",
|
643
|
+
# playback_restriction_policy_arn: "ChannelPlaybackRestrictionPolicyArn",
|
644
|
+
# preset: "HIGHER_BANDWIDTH_DELIVERY", # accepts HIGHER_BANDWIDTH_DELIVERY, CONSTRAINED_BANDWIDTH_DELIVERY
|
643
645
|
# recording_configuration_arn: "ChannelRecordingConfigurationArn",
|
644
646
|
# tags: {
|
645
647
|
# "TagKey" => "TagValue",
|
646
648
|
# },
|
647
|
-
#
|
648
|
-
# preset: "HIGHER_BANDWIDTH_DELIVERY", # accepts HIGHER_BANDWIDTH_DELIVERY, CONSTRAINED_BANDWIDTH_DELIVERY
|
649
|
-
# playback_restriction_policy_arn: "ChannelPlaybackRestrictionPolicyArn",
|
649
|
+
# type: "BASIC", # accepts BASIC, STANDARD, ADVANCED_SD, ADVANCED_HD
|
650
650
|
# })
|
651
651
|
#
|
652
652
|
# @example Response structure
|
653
653
|
#
|
654
654
|
# resp.channel.arn #=> String
|
655
|
-
# resp.channel.name #=> String
|
656
|
-
# resp.channel.latency_mode #=> String, one of "NORMAL", "LOW"
|
657
|
-
# resp.channel.type #=> String, one of "BASIC", "STANDARD", "ADVANCED_SD", "ADVANCED_HD"
|
658
|
-
# resp.channel.recording_configuration_arn #=> String
|
659
|
-
# resp.channel.ingest_endpoint #=> String
|
660
|
-
# resp.channel.playback_url #=> String
|
661
655
|
# resp.channel.authorized #=> Boolean
|
662
|
-
# resp.channel.
|
663
|
-
# resp.channel.tags["TagKey"] #=> String
|
656
|
+
# resp.channel.ingest_endpoint #=> String
|
664
657
|
# resp.channel.insecure_ingest #=> Boolean
|
658
|
+
# resp.channel.latency_mode #=> String, one of "NORMAL", "LOW"
|
659
|
+
# resp.channel.name #=> String
|
660
|
+
# resp.channel.playback_restriction_policy_arn #=> String
|
661
|
+
# resp.channel.playback_url #=> String
|
665
662
|
# resp.channel.preset #=> String, one of "HIGHER_BANDWIDTH_DELIVERY", "CONSTRAINED_BANDWIDTH_DELIVERY"
|
663
|
+
# resp.channel.recording_configuration_arn #=> String
|
666
664
|
# resp.channel.srt.endpoint #=> String
|
667
665
|
# resp.channel.srt.passphrase #=> String
|
668
|
-
# resp.channel.
|
666
|
+
# resp.channel.tags #=> Hash
|
667
|
+
# resp.channel.tags["TagKey"] #=> String
|
668
|
+
# resp.channel.type #=> String, one of "BASIC", "STANDARD", "ADVANCED_SD", "ADVANCED_HD"
|
669
669
|
# resp.stream_key.arn #=> String
|
670
|
-
# resp.stream_key.value #=> String
|
671
670
|
# resp.stream_key.channel_arn #=> String
|
672
671
|
# resp.stream_key.tags #=> Hash
|
673
672
|
# resp.stream_key.tags["TagKey"] #=> String
|
673
|
+
# resp.stream_key.value #=> String
|
674
674
|
#
|
675
675
|
# @see http://docs.aws.amazon.com/goto/WebAPI/ivs-2020-07-14/CreateChannel AWS API Documentation
|
676
676
|
#
|
@@ -740,11 +740,11 @@ module Aws::IVS
|
|
740
740
|
#
|
741
741
|
# @example Response structure
|
742
742
|
#
|
743
|
-
# resp.playback_restriction_policy.arn #=> String
|
744
743
|
# resp.playback_restriction_policy.allowed_countries #=> Array
|
745
744
|
# resp.playback_restriction_policy.allowed_countries[0] #=> String
|
746
745
|
# resp.playback_restriction_policy.allowed_origins #=> Array
|
747
746
|
# resp.playback_restriction_policy.allowed_origins[0] #=> String
|
747
|
+
# resp.playback_restriction_policy.arn #=> String
|
748
748
|
# resp.playback_restriction_policy.enable_strict_origin_enforcement #=> Boolean
|
749
749
|
# resp.playback_restriction_policy.name #=> String
|
750
750
|
# resp.playback_restriction_policy.tags #=> Hash
|
@@ -775,13 +775,22 @@ module Aws::IVS
|
|
775
775
|
# configuration and create a new one with an S3 bucket from the correct
|
776
776
|
# region.
|
777
777
|
#
|
778
|
-
# @option params [String] :name
|
779
|
-
# Recording-configuration name. The value does not need to be unique.
|
780
|
-
#
|
781
778
|
# @option params [required, Types::DestinationConfiguration] :destination_configuration
|
782
779
|
# A complex type that contains a destination configuration for where
|
783
780
|
# recorded video will be stored.
|
784
781
|
#
|
782
|
+
# @option params [String] :name
|
783
|
+
# Recording-configuration name. The value does not need to be unique.
|
784
|
+
#
|
785
|
+
# @option params [Integer] :recording_reconnect_window_seconds
|
786
|
+
# If a broadcast disconnects and then reconnects within the specified
|
787
|
+
# interval, the multiple streams will be considered a single broadcast
|
788
|
+
# and merged together. Default: 0.
|
789
|
+
#
|
790
|
+
# @option params [Types::RenditionConfiguration] :rendition_configuration
|
791
|
+
# Object that describes which renditions should be recorded for a
|
792
|
+
# stream.
|
793
|
+
#
|
785
794
|
# @option params [Hash<String,String>] :tags
|
786
795
|
# Array of 1-50 maps, each of the form `string:string (key:value)`. See
|
787
796
|
# [Best practices and strategies][1] in *Tagging Amazon Web Services
|
@@ -798,15 +807,6 @@ module Aws::IVS
|
|
798
807
|
# thumbnails for a live session and modify the interval at which
|
799
808
|
# thumbnails are generated for the live session.
|
800
809
|
#
|
801
|
-
# @option params [Integer] :recording_reconnect_window_seconds
|
802
|
-
# If a broadcast disconnects and then reconnects within the specified
|
803
|
-
# interval, the multiple streams will be considered a single broadcast
|
804
|
-
# and merged together. Default: 0.
|
805
|
-
#
|
806
|
-
# @option params [Types::RenditionConfiguration] :rendition_configuration
|
807
|
-
# Object that describes which renditions should be recorded for a
|
808
|
-
# stream.
|
809
|
-
#
|
810
810
|
# @return [Types::CreateRecordingConfigurationResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
811
811
|
#
|
812
812
|
# * {Types::CreateRecordingConfigurationResponse#recording_configuration #recording_configuration} => Types::RecordingConfiguration
|
@@ -814,45 +814,45 @@ module Aws::IVS
|
|
814
814
|
# @example Request syntax with placeholder values
|
815
815
|
#
|
816
816
|
# resp = client.create_recording_configuration({
|
817
|
-
# name: "RecordingConfigurationName",
|
818
817
|
# destination_configuration: { # required
|
819
818
|
# s3: {
|
820
819
|
# bucket_name: "S3DestinationBucketName", # required
|
821
820
|
# },
|
822
821
|
# },
|
822
|
+
# name: "RecordingConfigurationName",
|
823
|
+
# recording_reconnect_window_seconds: 1,
|
824
|
+
# rendition_configuration: {
|
825
|
+
# rendition_selection: "ALL", # accepts ALL, NONE, CUSTOM
|
826
|
+
# renditions: ["SD"], # accepts SD, HD, FULL_HD, LOWEST_RESOLUTION
|
827
|
+
# },
|
823
828
|
# tags: {
|
824
829
|
# "TagKey" => "TagValue",
|
825
830
|
# },
|
826
831
|
# thumbnail_configuration: {
|
827
832
|
# recording_mode: "DISABLED", # accepts DISABLED, INTERVAL
|
828
|
-
# target_interval_seconds: 1,
|
829
833
|
# resolution: "SD", # accepts SD, HD, FULL_HD, LOWEST_RESOLUTION
|
830
834
|
# storage: ["SEQUENTIAL"], # accepts SEQUENTIAL, LATEST
|
831
|
-
#
|
832
|
-
# recording_reconnect_window_seconds: 1,
|
833
|
-
# rendition_configuration: {
|
834
|
-
# rendition_selection: "ALL", # accepts ALL, NONE, CUSTOM
|
835
|
-
# renditions: ["SD"], # accepts SD, HD, FULL_HD, LOWEST_RESOLUTION
|
835
|
+
# target_interval_seconds: 1,
|
836
836
|
# },
|
837
837
|
# })
|
838
838
|
#
|
839
839
|
# @example Response structure
|
840
840
|
#
|
841
841
|
# resp.recording_configuration.arn #=> String
|
842
|
-
# resp.recording_configuration.name #=> String
|
843
842
|
# resp.recording_configuration.destination_configuration.s3.bucket_name #=> String
|
843
|
+
# resp.recording_configuration.name #=> String
|
844
|
+
# resp.recording_configuration.recording_reconnect_window_seconds #=> Integer
|
845
|
+
# resp.recording_configuration.rendition_configuration.rendition_selection #=> String, one of "ALL", "NONE", "CUSTOM"
|
846
|
+
# resp.recording_configuration.rendition_configuration.renditions #=> Array
|
847
|
+
# resp.recording_configuration.rendition_configuration.renditions[0] #=> String, one of "SD", "HD", "FULL_HD", "LOWEST_RESOLUTION"
|
844
848
|
# resp.recording_configuration.state #=> String, one of "CREATING", "CREATE_FAILED", "ACTIVE"
|
845
849
|
# resp.recording_configuration.tags #=> Hash
|
846
850
|
# resp.recording_configuration.tags["TagKey"] #=> String
|
847
851
|
# resp.recording_configuration.thumbnail_configuration.recording_mode #=> String, one of "DISABLED", "INTERVAL"
|
848
|
-
# resp.recording_configuration.thumbnail_configuration.target_interval_seconds #=> Integer
|
849
852
|
# resp.recording_configuration.thumbnail_configuration.resolution #=> String, one of "SD", "HD", "FULL_HD", "LOWEST_RESOLUTION"
|
850
853
|
# resp.recording_configuration.thumbnail_configuration.storage #=> Array
|
851
854
|
# resp.recording_configuration.thumbnail_configuration.storage[0] #=> String, one of "SEQUENTIAL", "LATEST"
|
852
|
-
# resp.recording_configuration.
|
853
|
-
# resp.recording_configuration.rendition_configuration.rendition_selection #=> String, one of "ALL", "NONE", "CUSTOM"
|
854
|
-
# resp.recording_configuration.rendition_configuration.renditions #=> Array
|
855
|
-
# resp.recording_configuration.rendition_configuration.renditions[0] #=> String, one of "SD", "HD", "FULL_HD", "LOWEST_RESOLUTION"
|
855
|
+
# resp.recording_configuration.thumbnail_configuration.target_interval_seconds #=> Integer
|
856
856
|
#
|
857
857
|
# @see http://docs.aws.amazon.com/goto/WebAPI/ivs-2020-07-14/CreateRecordingConfiguration AWS API Documentation
|
858
858
|
#
|
@@ -902,10 +902,10 @@ module Aws::IVS
|
|
902
902
|
# @example Response structure
|
903
903
|
#
|
904
904
|
# resp.stream_key.arn #=> String
|
905
|
-
# resp.stream_key.value #=> String
|
906
905
|
# resp.stream_key.channel_arn #=> String
|
907
906
|
# resp.stream_key.tags #=> Hash
|
908
907
|
# resp.stream_key.tags["TagKey"] #=> String
|
908
|
+
# resp.stream_key.value #=> String
|
909
909
|
#
|
910
910
|
# @see http://docs.aws.amazon.com/goto/WebAPI/ivs-2020-07-14/CreateStreamKey AWS API Documentation
|
911
911
|
#
|
@@ -1069,20 +1069,20 @@ module Aws::IVS
|
|
1069
1069
|
# @example Response structure
|
1070
1070
|
#
|
1071
1071
|
# resp.channel.arn #=> String
|
1072
|
-
# resp.channel.name #=> String
|
1073
|
-
# resp.channel.latency_mode #=> String, one of "NORMAL", "LOW"
|
1074
|
-
# resp.channel.type #=> String, one of "BASIC", "STANDARD", "ADVANCED_SD", "ADVANCED_HD"
|
1075
|
-
# resp.channel.recording_configuration_arn #=> String
|
1076
|
-
# resp.channel.ingest_endpoint #=> String
|
1077
|
-
# resp.channel.playback_url #=> String
|
1078
1072
|
# resp.channel.authorized #=> Boolean
|
1079
|
-
# resp.channel.
|
1080
|
-
# resp.channel.tags["TagKey"] #=> String
|
1073
|
+
# resp.channel.ingest_endpoint #=> String
|
1081
1074
|
# resp.channel.insecure_ingest #=> Boolean
|
1075
|
+
# resp.channel.latency_mode #=> String, one of "NORMAL", "LOW"
|
1076
|
+
# resp.channel.name #=> String
|
1077
|
+
# resp.channel.playback_restriction_policy_arn #=> String
|
1078
|
+
# resp.channel.playback_url #=> String
|
1082
1079
|
# resp.channel.preset #=> String, one of "HIGHER_BANDWIDTH_DELIVERY", "CONSTRAINED_BANDWIDTH_DELIVERY"
|
1080
|
+
# resp.channel.recording_configuration_arn #=> String
|
1083
1081
|
# resp.channel.srt.endpoint #=> String
|
1084
1082
|
# resp.channel.srt.passphrase #=> String
|
1085
|
-
# resp.channel.
|
1083
|
+
# resp.channel.tags #=> Hash
|
1084
|
+
# resp.channel.tags["TagKey"] #=> String
|
1085
|
+
# resp.channel.type #=> String, one of "BASIC", "STANDARD", "ADVANCED_SD", "ADVANCED_HD"
|
1086
1086
|
#
|
1087
1087
|
# @see http://docs.aws.amazon.com/goto/WebAPI/ivs-2020-07-14/GetChannel AWS API Documentation
|
1088
1088
|
#
|
@@ -1119,8 +1119,8 @@ module Aws::IVS
|
|
1119
1119
|
# @example Response structure
|
1120
1120
|
#
|
1121
1121
|
# resp.key_pair.arn #=> String
|
1122
|
-
# resp.key_pair.name #=> String
|
1123
1122
|
# resp.key_pair.fingerprint #=> String
|
1123
|
+
# resp.key_pair.name #=> String
|
1124
1124
|
# resp.key_pair.tags #=> Hash
|
1125
1125
|
# resp.key_pair.tags["TagKey"] #=> String
|
1126
1126
|
#
|
@@ -1150,11 +1150,11 @@ module Aws::IVS
|
|
1150
1150
|
#
|
1151
1151
|
# @example Response structure
|
1152
1152
|
#
|
1153
|
-
# resp.playback_restriction_policy.arn #=> String
|
1154
1153
|
# resp.playback_restriction_policy.allowed_countries #=> Array
|
1155
1154
|
# resp.playback_restriction_policy.allowed_countries[0] #=> String
|
1156
1155
|
# resp.playback_restriction_policy.allowed_origins #=> Array
|
1157
1156
|
# resp.playback_restriction_policy.allowed_origins[0] #=> String
|
1157
|
+
# resp.playback_restriction_policy.arn #=> String
|
1158
1158
|
# resp.playback_restriction_policy.enable_strict_origin_enforcement #=> Boolean
|
1159
1159
|
# resp.playback_restriction_policy.name #=> String
|
1160
1160
|
# resp.playback_restriction_policy.tags #=> Hash
|
@@ -1187,20 +1187,20 @@ module Aws::IVS
|
|
1187
1187
|
# @example Response structure
|
1188
1188
|
#
|
1189
1189
|
# resp.recording_configuration.arn #=> String
|
1190
|
-
# resp.recording_configuration.name #=> String
|
1191
1190
|
# resp.recording_configuration.destination_configuration.s3.bucket_name #=> String
|
1191
|
+
# resp.recording_configuration.name #=> String
|
1192
|
+
# resp.recording_configuration.recording_reconnect_window_seconds #=> Integer
|
1193
|
+
# resp.recording_configuration.rendition_configuration.rendition_selection #=> String, one of "ALL", "NONE", "CUSTOM"
|
1194
|
+
# resp.recording_configuration.rendition_configuration.renditions #=> Array
|
1195
|
+
# resp.recording_configuration.rendition_configuration.renditions[0] #=> String, one of "SD", "HD", "FULL_HD", "LOWEST_RESOLUTION"
|
1192
1196
|
# resp.recording_configuration.state #=> String, one of "CREATING", "CREATE_FAILED", "ACTIVE"
|
1193
1197
|
# resp.recording_configuration.tags #=> Hash
|
1194
1198
|
# resp.recording_configuration.tags["TagKey"] #=> String
|
1195
1199
|
# resp.recording_configuration.thumbnail_configuration.recording_mode #=> String, one of "DISABLED", "INTERVAL"
|
1196
|
-
# resp.recording_configuration.thumbnail_configuration.target_interval_seconds #=> Integer
|
1197
1200
|
# resp.recording_configuration.thumbnail_configuration.resolution #=> String, one of "SD", "HD", "FULL_HD", "LOWEST_RESOLUTION"
|
1198
1201
|
# resp.recording_configuration.thumbnail_configuration.storage #=> Array
|
1199
1202
|
# resp.recording_configuration.thumbnail_configuration.storage[0] #=> String, one of "SEQUENTIAL", "LATEST"
|
1200
|
-
# resp.recording_configuration.
|
1201
|
-
# resp.recording_configuration.rendition_configuration.rendition_selection #=> String, one of "ALL", "NONE", "CUSTOM"
|
1202
|
-
# resp.recording_configuration.rendition_configuration.renditions #=> Array
|
1203
|
-
# resp.recording_configuration.rendition_configuration.renditions[0] #=> String, one of "SD", "HD", "FULL_HD", "LOWEST_RESOLUTION"
|
1203
|
+
# resp.recording_configuration.thumbnail_configuration.target_interval_seconds #=> Integer
|
1204
1204
|
#
|
1205
1205
|
# @see http://docs.aws.amazon.com/goto/WebAPI/ivs-2020-07-14/GetRecordingConfiguration AWS API Documentation
|
1206
1206
|
#
|
@@ -1230,11 +1230,11 @@ module Aws::IVS
|
|
1230
1230
|
# @example Response structure
|
1231
1231
|
#
|
1232
1232
|
# resp.stream.channel_arn #=> String
|
1233
|
-
# resp.stream.
|
1233
|
+
# resp.stream.health #=> String, one of "HEALTHY", "STARVING", "UNKNOWN"
|
1234
1234
|
# resp.stream.playback_url #=> String
|
1235
1235
|
# resp.stream.start_time #=> Time
|
1236
1236
|
# resp.stream.state #=> String, one of "LIVE", "OFFLINE"
|
1237
|
-
# resp.stream.
|
1237
|
+
# resp.stream.stream_id #=> String
|
1238
1238
|
# resp.stream.viewer_count #=> Integer
|
1239
1239
|
#
|
1240
1240
|
# @see http://docs.aws.amazon.com/goto/WebAPI/ivs-2020-07-14/GetStream AWS API Documentation
|
@@ -1264,10 +1264,10 @@ module Aws::IVS
|
|
1264
1264
|
# @example Response structure
|
1265
1265
|
#
|
1266
1266
|
# resp.stream_key.arn #=> String
|
1267
|
-
# resp.stream_key.value #=> String
|
1268
1267
|
# resp.stream_key.channel_arn #=> String
|
1269
1268
|
# resp.stream_key.tags #=> Hash
|
1270
1269
|
# resp.stream_key.tags["TagKey"] #=> String
|
1270
|
+
# resp.stream_key.value #=> String
|
1271
1271
|
#
|
1272
1272
|
# @see http://docs.aws.amazon.com/goto/WebAPI/ivs-2020-07-14/GetStreamKey AWS API Documentation
|
1273
1273
|
#
|
@@ -1301,55 +1301,56 @@ module Aws::IVS
|
|
1301
1301
|
#
|
1302
1302
|
# @example Response structure
|
1303
1303
|
#
|
1304
|
-
# resp.stream_session.stream_id #=> String
|
1305
|
-
# resp.stream_session.start_time #=> Time
|
1306
|
-
# resp.stream_session.end_time #=> Time
|
1307
1304
|
# resp.stream_session.channel.arn #=> String
|
1308
|
-
# resp.stream_session.channel.name #=> String
|
1309
|
-
# resp.stream_session.channel.latency_mode #=> String, one of "NORMAL", "LOW"
|
1310
|
-
# resp.stream_session.channel.type #=> String, one of "BASIC", "STANDARD", "ADVANCED_SD", "ADVANCED_HD"
|
1311
|
-
# resp.stream_session.channel.recording_configuration_arn #=> String
|
1312
|
-
# resp.stream_session.channel.ingest_endpoint #=> String
|
1313
|
-
# resp.stream_session.channel.playback_url #=> String
|
1314
1305
|
# resp.stream_session.channel.authorized #=> Boolean
|
1315
|
-
# resp.stream_session.channel.
|
1316
|
-
# resp.stream_session.channel.tags["TagKey"] #=> String
|
1306
|
+
# resp.stream_session.channel.ingest_endpoint #=> String
|
1317
1307
|
# resp.stream_session.channel.insecure_ingest #=> Boolean
|
1308
|
+
# resp.stream_session.channel.latency_mode #=> String, one of "NORMAL", "LOW"
|
1309
|
+
# resp.stream_session.channel.name #=> String
|
1310
|
+
# resp.stream_session.channel.playback_restriction_policy_arn #=> String
|
1311
|
+
# resp.stream_session.channel.playback_url #=> String
|
1318
1312
|
# resp.stream_session.channel.preset #=> String, one of "HIGHER_BANDWIDTH_DELIVERY", "CONSTRAINED_BANDWIDTH_DELIVERY"
|
1313
|
+
# resp.stream_session.channel.recording_configuration_arn #=> String
|
1319
1314
|
# resp.stream_session.channel.srt.endpoint #=> String
|
1320
1315
|
# resp.stream_session.channel.srt.passphrase #=> String
|
1321
|
-
# resp.stream_session.channel.
|
1322
|
-
# resp.stream_session.
|
1316
|
+
# resp.stream_session.channel.tags #=> Hash
|
1317
|
+
# resp.stream_session.channel.tags["TagKey"] #=> String
|
1318
|
+
# resp.stream_session.channel.type #=> String, one of "BASIC", "STANDARD", "ADVANCED_SD", "ADVANCED_HD"
|
1319
|
+
# resp.stream_session.end_time #=> Time
|
1320
|
+
# resp.stream_session.ingest_configuration.audio.channels #=> Integer
|
1321
|
+
# resp.stream_session.ingest_configuration.audio.codec #=> String
|
1322
|
+
# resp.stream_session.ingest_configuration.audio.sample_rate #=> Integer
|
1323
|
+
# resp.stream_session.ingest_configuration.audio.target_bitrate #=> Integer
|
1323
1324
|
# resp.stream_session.ingest_configuration.video.avc_level #=> String
|
1325
|
+
# resp.stream_session.ingest_configuration.video.avc_profile #=> String
|
1324
1326
|
# resp.stream_session.ingest_configuration.video.codec #=> String
|
1325
1327
|
# resp.stream_session.ingest_configuration.video.encoder #=> String
|
1326
1328
|
# resp.stream_session.ingest_configuration.video.target_bitrate #=> Integer
|
1327
1329
|
# resp.stream_session.ingest_configuration.video.target_framerate #=> Integer
|
1328
1330
|
# resp.stream_session.ingest_configuration.video.video_height #=> Integer
|
1329
1331
|
# resp.stream_session.ingest_configuration.video.video_width #=> Integer
|
1330
|
-
# resp.stream_session.ingest_configuration.audio.codec #=> String
|
1331
|
-
# resp.stream_session.ingest_configuration.audio.target_bitrate #=> Integer
|
1332
|
-
# resp.stream_session.ingest_configuration.audio.sample_rate #=> Integer
|
1333
|
-
# resp.stream_session.ingest_configuration.audio.channels #=> Integer
|
1334
1332
|
# resp.stream_session.recording_configuration.arn #=> String
|
1335
|
-
# resp.stream_session.recording_configuration.name #=> String
|
1336
1333
|
# resp.stream_session.recording_configuration.destination_configuration.s3.bucket_name #=> String
|
1334
|
+
# resp.stream_session.recording_configuration.name #=> String
|
1335
|
+
# resp.stream_session.recording_configuration.recording_reconnect_window_seconds #=> Integer
|
1336
|
+
# resp.stream_session.recording_configuration.rendition_configuration.rendition_selection #=> String, one of "ALL", "NONE", "CUSTOM"
|
1337
|
+
# resp.stream_session.recording_configuration.rendition_configuration.renditions #=> Array
|
1338
|
+
# resp.stream_session.recording_configuration.rendition_configuration.renditions[0] #=> String, one of "SD", "HD", "FULL_HD", "LOWEST_RESOLUTION"
|
1337
1339
|
# resp.stream_session.recording_configuration.state #=> String, one of "CREATING", "CREATE_FAILED", "ACTIVE"
|
1338
1340
|
# resp.stream_session.recording_configuration.tags #=> Hash
|
1339
1341
|
# resp.stream_session.recording_configuration.tags["TagKey"] #=> String
|
1340
1342
|
# resp.stream_session.recording_configuration.thumbnail_configuration.recording_mode #=> String, one of "DISABLED", "INTERVAL"
|
1341
|
-
# resp.stream_session.recording_configuration.thumbnail_configuration.target_interval_seconds #=> Integer
|
1342
1343
|
# resp.stream_session.recording_configuration.thumbnail_configuration.resolution #=> String, one of "SD", "HD", "FULL_HD", "LOWEST_RESOLUTION"
|
1343
1344
|
# resp.stream_session.recording_configuration.thumbnail_configuration.storage #=> Array
|
1344
1345
|
# resp.stream_session.recording_configuration.thumbnail_configuration.storage[0] #=> String, one of "SEQUENTIAL", "LATEST"
|
1345
|
-
# resp.stream_session.recording_configuration.
|
1346
|
-
# resp.stream_session.
|
1347
|
-
# resp.stream_session.
|
1348
|
-
# resp.stream_session.recording_configuration.rendition_configuration.renditions[0] #=> String, one of "SD", "HD", "FULL_HD", "LOWEST_RESOLUTION"
|
1346
|
+
# resp.stream_session.recording_configuration.thumbnail_configuration.target_interval_seconds #=> Integer
|
1347
|
+
# resp.stream_session.start_time #=> Time
|
1348
|
+
# resp.stream_session.stream_id #=> String
|
1349
1349
|
# resp.stream_session.truncated_events #=> Array
|
1350
|
+
# resp.stream_session.truncated_events[0].code #=> String
|
1351
|
+
# resp.stream_session.truncated_events[0].event_time #=> Time
|
1350
1352
|
# resp.stream_session.truncated_events[0].name #=> String
|
1351
1353
|
# resp.stream_session.truncated_events[0].type #=> String
|
1352
|
-
# resp.stream_session.truncated_events[0].event_time #=> Time
|
1353
1354
|
#
|
1354
1355
|
# @see http://docs.aws.amazon.com/goto/WebAPI/ivs-2020-07-14/GetStreamSession AWS API Documentation
|
1355
1356
|
#
|
@@ -1370,12 +1371,12 @@ module Aws::IVS
|
|
1370
1371
|
#
|
1371
1372
|
# [1]: https://docs.aws.amazon.com/ivs/latest/userguide/private-channels.html
|
1372
1373
|
#
|
1373
|
-
# @option params [required, String] :public_key_material
|
1374
|
-
# The public portion of a customer-generated key pair.
|
1375
|
-
#
|
1376
1374
|
# @option params [String] :name
|
1377
1375
|
# Playback-key-pair name. The value does not need to be unique.
|
1378
1376
|
#
|
1377
|
+
# @option params [required, String] :public_key_material
|
1378
|
+
# The public portion of a customer-generated key pair.
|
1379
|
+
#
|
1379
1380
|
# @option params [Hash<String,String>] :tags
|
1380
1381
|
# Any tags provided with the request are added to the playback key pair
|
1381
1382
|
# tags. See [Best practices and strategies][1] in *Tagging Amazon Web
|
@@ -1395,8 +1396,8 @@ module Aws::IVS
|
|
1395
1396
|
# @example Request syntax with placeholder values
|
1396
1397
|
#
|
1397
1398
|
# resp = client.import_playback_key_pair({
|
1398
|
-
# public_key_material: "PlaybackPublicKeyMaterial", # required
|
1399
1399
|
# name: "PlaybackKeyPairName",
|
1400
|
+
# public_key_material: "PlaybackPublicKeyMaterial", # required
|
1400
1401
|
# tags: {
|
1401
1402
|
# "TagKey" => "TagValue",
|
1402
1403
|
# },
|
@@ -1405,8 +1406,8 @@ module Aws::IVS
|
|
1405
1406
|
# @example Response structure
|
1406
1407
|
#
|
1407
1408
|
# resp.key_pair.arn #=> String
|
1408
|
-
# resp.key_pair.name #=> String
|
1409
1409
|
# resp.key_pair.fingerprint #=> String
|
1410
|
+
# resp.key_pair.name #=> String
|
1410
1411
|
# resp.key_pair.tags #=> Hash
|
1411
1412
|
# resp.key_pair.tags["TagKey"] #=> String
|
1412
1413
|
#
|
@@ -1429,20 +1430,20 @@ module Aws::IVS
|
|
1429
1430
|
# @option params [String] :filter_by_name
|
1430
1431
|
# Filters the channel list to match the specified name.
|
1431
1432
|
#
|
1433
|
+
# @option params [String] :filter_by_playback_restriction_policy_arn
|
1434
|
+
# Filters the channel list to match the specified policy.
|
1435
|
+
#
|
1432
1436
|
# @option params [String] :filter_by_recording_configuration_arn
|
1433
1437
|
# Filters the channel list to match the specified
|
1434
1438
|
# recording-configuration ARN.
|
1435
1439
|
#
|
1436
|
-
# @option params [
|
1437
|
-
#
|
1440
|
+
# @option params [Integer] :max_results
|
1441
|
+
# Maximum number of channels to return. Default: 100.
|
1438
1442
|
#
|
1439
1443
|
# @option params [String] :next_token
|
1440
1444
|
# The first channel to retrieve. This is used for pagination; see the
|
1441
1445
|
# `nextToken` response field.
|
1442
1446
|
#
|
1443
|
-
# @option params [Integer] :max_results
|
1444
|
-
# Maximum number of channels to return. Default: 100.
|
1445
|
-
#
|
1446
1447
|
# @return [Types::ListChannelsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1447
1448
|
#
|
1448
1449
|
# * {Types::ListChannelsResponse#channels #channels} => Array<Types::ChannelSummary>
|
@@ -1454,26 +1455,26 @@ module Aws::IVS
|
|
1454
1455
|
#
|
1455
1456
|
# resp = client.list_channels({
|
1456
1457
|
# filter_by_name: "ChannelName",
|
1457
|
-
# filter_by_recording_configuration_arn: "ChannelRecordingConfigurationArn",
|
1458
1458
|
# filter_by_playback_restriction_policy_arn: "ChannelPlaybackRestrictionPolicyArn",
|
1459
|
-
#
|
1459
|
+
# filter_by_recording_configuration_arn: "ChannelRecordingConfigurationArn",
|
1460
1460
|
# max_results: 1,
|
1461
|
+
# next_token: "PaginationToken",
|
1461
1462
|
# })
|
1462
1463
|
#
|
1463
1464
|
# @example Response structure
|
1464
1465
|
#
|
1465
1466
|
# resp.channels #=> Array
|
1466
1467
|
# resp.channels[0].arn #=> String
|
1467
|
-
# resp.channels[0].name #=> String
|
1468
|
-
# resp.channels[0].latency_mode #=> String, one of "NORMAL", "LOW"
|
1469
1468
|
# resp.channels[0].authorized #=> Boolean
|
1469
|
+
# resp.channels[0].insecure_ingest #=> Boolean
|
1470
|
+
# resp.channels[0].latency_mode #=> String, one of "NORMAL", "LOW"
|
1471
|
+
# resp.channels[0].name #=> String
|
1472
|
+
# resp.channels[0].playback_restriction_policy_arn #=> String
|
1473
|
+
# resp.channels[0].preset #=> String, one of "HIGHER_BANDWIDTH_DELIVERY", "CONSTRAINED_BANDWIDTH_DELIVERY"
|
1470
1474
|
# resp.channels[0].recording_configuration_arn #=> String
|
1471
1475
|
# resp.channels[0].tags #=> Hash
|
1472
1476
|
# resp.channels[0].tags["TagKey"] #=> String
|
1473
|
-
# resp.channels[0].insecure_ingest #=> Boolean
|
1474
1477
|
# resp.channels[0].type #=> String, one of "BASIC", "STANDARD", "ADVANCED_SD", "ADVANCED_HD"
|
1475
|
-
# resp.channels[0].preset #=> String, one of "HIGHER_BANDWIDTH_DELIVERY", "CONSTRAINED_BANDWIDTH_DELIVERY"
|
1476
|
-
# resp.channels[0].playback_restriction_policy_arn #=> String
|
1477
1478
|
# resp.next_token #=> String
|
1478
1479
|
#
|
1479
1480
|
# @see http://docs.aws.amazon.com/goto/WebAPI/ivs-2020-07-14/ListChannels AWS API Documentation
|
@@ -1493,14 +1494,14 @@ module Aws::IVS
|
|
1493
1494
|
#
|
1494
1495
|
# [1]: https://docs.aws.amazon.com/ivs/latest/userguide/private-channels.html
|
1495
1496
|
#
|
1496
|
-
# @option params [String] :next_token
|
1497
|
-
# The first key pair to retrieve. This is used for pagination; see the
|
1498
|
-
# `nextToken` response field.
|
1499
|
-
#
|
1500
1497
|
# @option params [Integer] :max_results
|
1501
1498
|
# Maximum number of key pairs to return. Default: your service quota or
|
1502
1499
|
# 100, whichever is smaller.
|
1503
1500
|
#
|
1501
|
+
# @option params [String] :next_token
|
1502
|
+
# The first key pair to retrieve. This is used for pagination; see the
|
1503
|
+
# `nextToken` response field.
|
1504
|
+
#
|
1504
1505
|
# @return [Types::ListPlaybackKeyPairsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1505
1506
|
#
|
1506
1507
|
# * {Types::ListPlaybackKeyPairsResponse#key_pairs #key_pairs} => Array<Types::PlaybackKeyPairSummary>
|
@@ -1511,8 +1512,8 @@ module Aws::IVS
|
|
1511
1512
|
# @example Request syntax with placeholder values
|
1512
1513
|
#
|
1513
1514
|
# resp = client.list_playback_key_pairs({
|
1514
|
-
# next_token: "PaginationToken",
|
1515
1515
|
# max_results: 1,
|
1516
|
+
# next_token: "PaginationToken",
|
1516
1517
|
# })
|
1517
1518
|
#
|
1518
1519
|
# @example Response structure
|
@@ -1535,40 +1536,40 @@ module Aws::IVS
|
|
1535
1536
|
|
1536
1537
|
# Gets summary information about playback restriction policies.
|
1537
1538
|
#
|
1539
|
+
# @option params [Integer] :max_results
|
1540
|
+
# Maximum number of policies to return. Default: 1.
|
1541
|
+
#
|
1538
1542
|
# @option params [String] :next_token
|
1539
1543
|
# The first policy to retrieve. This is used for pagination; see the
|
1540
1544
|
# `nextToken` response field.
|
1541
1545
|
#
|
1542
|
-
# @option params [Integer] :max_results
|
1543
|
-
# Maximum number of policies to return. Default: 1.
|
1544
|
-
#
|
1545
1546
|
# @return [Types::ListPlaybackRestrictionPoliciesResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1546
1547
|
#
|
1547
|
-
# * {Types::ListPlaybackRestrictionPoliciesResponse#playback_restriction_policies #playback_restriction_policies} => Array<Types::PlaybackRestrictionPolicySummary>
|
1548
1548
|
# * {Types::ListPlaybackRestrictionPoliciesResponse#next_token #next_token} => String
|
1549
|
+
# * {Types::ListPlaybackRestrictionPoliciesResponse#playback_restriction_policies #playback_restriction_policies} => Array<Types::PlaybackRestrictionPolicySummary>
|
1549
1550
|
#
|
1550
1551
|
# The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
|
1551
1552
|
#
|
1552
1553
|
# @example Request syntax with placeholder values
|
1553
1554
|
#
|
1554
1555
|
# resp = client.list_playback_restriction_policies({
|
1555
|
-
# next_token: "PaginationToken",
|
1556
1556
|
# max_results: 1,
|
1557
|
+
# next_token: "PaginationToken",
|
1557
1558
|
# })
|
1558
1559
|
#
|
1559
1560
|
# @example Response structure
|
1560
1561
|
#
|
1562
|
+
# resp.next_token #=> String
|
1561
1563
|
# resp.playback_restriction_policies #=> Array
|
1562
|
-
# resp.playback_restriction_policies[0].arn #=> String
|
1563
1564
|
# resp.playback_restriction_policies[0].allowed_countries #=> Array
|
1564
1565
|
# resp.playback_restriction_policies[0].allowed_countries[0] #=> String
|
1565
1566
|
# resp.playback_restriction_policies[0].allowed_origins #=> Array
|
1566
1567
|
# resp.playback_restriction_policies[0].allowed_origins[0] #=> String
|
1568
|
+
# resp.playback_restriction_policies[0].arn #=> String
|
1567
1569
|
# resp.playback_restriction_policies[0].enable_strict_origin_enforcement #=> Boolean
|
1568
1570
|
# resp.playback_restriction_policies[0].name #=> String
|
1569
1571
|
# resp.playback_restriction_policies[0].tags #=> Hash
|
1570
1572
|
# resp.playback_restriction_policies[0].tags["TagKey"] #=> String
|
1571
|
-
# resp.next_token #=> String
|
1572
1573
|
#
|
1573
1574
|
# @see http://docs.aws.amazon.com/goto/WebAPI/ivs-2020-07-14/ListPlaybackRestrictionPolicies AWS API Documentation
|
1574
1575
|
#
|
@@ -1583,38 +1584,38 @@ module Aws::IVS
|
|
1583
1584
|
# account, in the Amazon Web Services region where the API request is
|
1584
1585
|
# processed.
|
1585
1586
|
#
|
1586
|
-
# @option params [String] :next_token
|
1587
|
-
# The first recording configuration to retrieve. This is used for
|
1588
|
-
# pagination; see the `nextToken` response field.
|
1589
|
-
#
|
1590
1587
|
# @option params [Integer] :max_results
|
1591
1588
|
# Maximum number of recording configurations to return. Default: your
|
1592
1589
|
# service quota or 100, whichever is smaller.
|
1593
1590
|
#
|
1591
|
+
# @option params [String] :next_token
|
1592
|
+
# The first recording configuration to retrieve. This is used for
|
1593
|
+
# pagination; see the `nextToken` response field.
|
1594
|
+
#
|
1594
1595
|
# @return [Types::ListRecordingConfigurationsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1595
1596
|
#
|
1596
|
-
# * {Types::ListRecordingConfigurationsResponse#recording_configurations #recording_configurations} => Array<Types::RecordingConfigurationSummary>
|
1597
1597
|
# * {Types::ListRecordingConfigurationsResponse#next_token #next_token} => String
|
1598
|
+
# * {Types::ListRecordingConfigurationsResponse#recording_configurations #recording_configurations} => Array<Types::RecordingConfigurationSummary>
|
1598
1599
|
#
|
1599
1600
|
# The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
|
1600
1601
|
#
|
1601
1602
|
# @example Request syntax with placeholder values
|
1602
1603
|
#
|
1603
1604
|
# resp = client.list_recording_configurations({
|
1604
|
-
# next_token: "PaginationToken",
|
1605
1605
|
# max_results: 1,
|
1606
|
+
# next_token: "PaginationToken",
|
1606
1607
|
# })
|
1607
1608
|
#
|
1608
1609
|
# @example Response structure
|
1609
1610
|
#
|
1611
|
+
# resp.next_token #=> String
|
1610
1612
|
# resp.recording_configurations #=> Array
|
1611
1613
|
# resp.recording_configurations[0].arn #=> String
|
1612
|
-
# resp.recording_configurations[0].name #=> String
|
1613
1614
|
# resp.recording_configurations[0].destination_configuration.s3.bucket_name #=> String
|
1615
|
+
# resp.recording_configurations[0].name #=> String
|
1614
1616
|
# resp.recording_configurations[0].state #=> String, one of "CREATING", "CREATE_FAILED", "ACTIVE"
|
1615
1617
|
# resp.recording_configurations[0].tags #=> Hash
|
1616
1618
|
# resp.recording_configurations[0].tags["TagKey"] #=> String
|
1617
|
-
# resp.next_token #=> String
|
1618
1619
|
#
|
1619
1620
|
# @see http://docs.aws.amazon.com/goto/WebAPI/ivs-2020-07-14/ListRecordingConfigurations AWS API Documentation
|
1620
1621
|
#
|
@@ -1630,17 +1631,17 @@ module Aws::IVS
|
|
1630
1631
|
# @option params [required, String] :channel_arn
|
1631
1632
|
# Channel ARN used to filter the list.
|
1632
1633
|
#
|
1634
|
+
# @option params [Integer] :max_results
|
1635
|
+
# Maximum number of streamKeys to return. Default: 1.
|
1636
|
+
#
|
1633
1637
|
# @option params [String] :next_token
|
1634
1638
|
# The first stream key to retrieve. This is used for pagination; see the
|
1635
1639
|
# `nextToken` response field.
|
1636
1640
|
#
|
1637
|
-
# @option params [Integer] :max_results
|
1638
|
-
# Maximum number of streamKeys to return. Default: 1.
|
1639
|
-
#
|
1640
1641
|
# @return [Types::ListStreamKeysResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1641
1642
|
#
|
1642
|
-
# * {Types::ListStreamKeysResponse#stream_keys #stream_keys} => Array<Types::StreamKeySummary>
|
1643
1643
|
# * {Types::ListStreamKeysResponse#next_token #next_token} => String
|
1644
|
+
# * {Types::ListStreamKeysResponse#stream_keys #stream_keys} => Array<Types::StreamKeySummary>
|
1644
1645
|
#
|
1645
1646
|
# The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
|
1646
1647
|
#
|
@@ -1648,18 +1649,18 @@ module Aws::IVS
|
|
1648
1649
|
#
|
1649
1650
|
# resp = client.list_stream_keys({
|
1650
1651
|
# channel_arn: "ChannelArn", # required
|
1651
|
-
# next_token: "PaginationToken",
|
1652
1652
|
# max_results: 1,
|
1653
|
+
# next_token: "PaginationToken",
|
1653
1654
|
# })
|
1654
1655
|
#
|
1655
1656
|
# @example Response structure
|
1656
1657
|
#
|
1658
|
+
# resp.next_token #=> String
|
1657
1659
|
# resp.stream_keys #=> Array
|
1658
1660
|
# resp.stream_keys[0].arn #=> String
|
1659
1661
|
# resp.stream_keys[0].channel_arn #=> String
|
1660
1662
|
# resp.stream_keys[0].tags #=> Hash
|
1661
1663
|
# resp.stream_keys[0].tags["TagKey"] #=> String
|
1662
|
-
# resp.next_token #=> String
|
1663
1664
|
#
|
1664
1665
|
# @see http://docs.aws.amazon.com/goto/WebAPI/ivs-2020-07-14/ListStreamKeys AWS API Documentation
|
1665
1666
|
#
|
@@ -1676,17 +1677,17 @@ module Aws::IVS
|
|
1676
1677
|
# @option params [required, String] :channel_arn
|
1677
1678
|
# Channel ARN used to filter the list.
|
1678
1679
|
#
|
1680
|
+
# @option params [Integer] :max_results
|
1681
|
+
# Maximum number of streams to return. Default: 100.
|
1682
|
+
#
|
1679
1683
|
# @option params [String] :next_token
|
1680
1684
|
# The first stream to retrieve. This is used for pagination; see the
|
1681
1685
|
# `nextToken` response field.
|
1682
1686
|
#
|
1683
|
-
# @option params [Integer] :max_results
|
1684
|
-
# Maximum number of streams to return. Default: 100.
|
1685
|
-
#
|
1686
1687
|
# @return [Types::ListStreamSessionsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1687
1688
|
#
|
1688
|
-
# * {Types::ListStreamSessionsResponse#stream_sessions #stream_sessions} => Array<Types::StreamSessionSummary>
|
1689
1689
|
# * {Types::ListStreamSessionsResponse#next_token #next_token} => String
|
1690
|
+
# * {Types::ListStreamSessionsResponse#stream_sessions #stream_sessions} => Array<Types::StreamSessionSummary>
|
1690
1691
|
#
|
1691
1692
|
# The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
|
1692
1693
|
#
|
@@ -1694,18 +1695,18 @@ module Aws::IVS
|
|
1694
1695
|
#
|
1695
1696
|
# resp = client.list_stream_sessions({
|
1696
1697
|
# channel_arn: "ChannelArn", # required
|
1697
|
-
# next_token: "PaginationToken",
|
1698
1698
|
# max_results: 1,
|
1699
|
+
# next_token: "PaginationToken",
|
1699
1700
|
# })
|
1700
1701
|
#
|
1701
1702
|
# @example Response structure
|
1702
1703
|
#
|
1704
|
+
# resp.next_token #=> String
|
1703
1705
|
# resp.stream_sessions #=> Array
|
1704
|
-
# resp.stream_sessions[0].stream_id #=> String
|
1705
|
-
# resp.stream_sessions[0].start_time #=> Time
|
1706
1706
|
# resp.stream_sessions[0].end_time #=> Time
|
1707
1707
|
# resp.stream_sessions[0].has_error_event #=> Boolean
|
1708
|
-
# resp.
|
1708
|
+
# resp.stream_sessions[0].start_time #=> Time
|
1709
|
+
# resp.stream_sessions[0].stream_id #=> String
|
1709
1710
|
#
|
1710
1711
|
# @see http://docs.aws.amazon.com/goto/WebAPI/ivs-2020-07-14/ListStreamSessions AWS API Documentation
|
1711
1712
|
#
|
@@ -1722,17 +1723,17 @@ module Aws::IVS
|
|
1722
1723
|
# @option params [Types::StreamFilters] :filter_by
|
1723
1724
|
# Filters the stream list to match the specified criterion.
|
1724
1725
|
#
|
1726
|
+
# @option params [Integer] :max_results
|
1727
|
+
# Maximum number of streams to return. Default: 100.
|
1728
|
+
#
|
1725
1729
|
# @option params [String] :next_token
|
1726
1730
|
# The first stream to retrieve. This is used for pagination; see the
|
1727
1731
|
# `nextToken` response field.
|
1728
1732
|
#
|
1729
|
-
# @option params [Integer] :max_results
|
1730
|
-
# Maximum number of streams to return. Default: 100.
|
1731
|
-
#
|
1732
1733
|
# @return [Types::ListStreamsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1733
1734
|
#
|
1734
|
-
# * {Types::ListStreamsResponse#streams #streams} => Array<Types::StreamSummary>
|
1735
1735
|
# * {Types::ListStreamsResponse#next_token #next_token} => String
|
1736
|
+
# * {Types::ListStreamsResponse#streams #streams} => Array<Types::StreamSummary>
|
1736
1737
|
#
|
1737
1738
|
# The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
|
1738
1739
|
#
|
@@ -1742,20 +1743,20 @@ module Aws::IVS
|
|
1742
1743
|
# filter_by: {
|
1743
1744
|
# health: "HEALTHY", # accepts HEALTHY, STARVING, UNKNOWN
|
1744
1745
|
# },
|
1745
|
-
# next_token: "PaginationToken",
|
1746
1746
|
# max_results: 1,
|
1747
|
+
# next_token: "PaginationToken",
|
1747
1748
|
# })
|
1748
1749
|
#
|
1749
1750
|
# @example Response structure
|
1750
1751
|
#
|
1752
|
+
# resp.next_token #=> String
|
1751
1753
|
# resp.streams #=> Array
|
1752
1754
|
# resp.streams[0].channel_arn #=> String
|
1753
|
-
# resp.streams[0].stream_id #=> String
|
1754
|
-
# resp.streams[0].state #=> String, one of "LIVE", "OFFLINE"
|
1755
1755
|
# resp.streams[0].health #=> String, one of "HEALTHY", "STARVING", "UNKNOWN"
|
1756
|
-
# resp.streams[0].viewer_count #=> Integer
|
1757
1756
|
# resp.streams[0].start_time #=> Time
|
1758
|
-
# resp.
|
1757
|
+
# resp.streams[0].state #=> String, one of "LIVE", "OFFLINE"
|
1758
|
+
# resp.streams[0].stream_id #=> String
|
1759
|
+
# resp.streams[0].viewer_count #=> Integer
|
1759
1760
|
#
|
1760
1761
|
# @see http://docs.aws.amazon.com/goto/WebAPI/ivs-2020-07-14/ListStreams AWS API Documentation
|
1761
1762
|
#
|
@@ -1985,46 +1986,46 @@ module Aws::IVS
|
|
1985
1986
|
# @option params [required, String] :arn
|
1986
1987
|
# ARN of the channel to be updated.
|
1987
1988
|
#
|
1988
|
-
# @option params [
|
1989
|
-
#
|
1989
|
+
# @option params [Boolean] :authorized
|
1990
|
+
# Whether the channel is private (enabled for playback authorization).
|
1991
|
+
#
|
1992
|
+
# @option params [Boolean] :insecure_ingest
|
1993
|
+
# Whether the channel allows insecure RTMP and SRT ingest. Default:
|
1994
|
+
# `false`.
|
1990
1995
|
#
|
1991
1996
|
# @option params [String] :latency_mode
|
1992
1997
|
# Channel latency mode. Use `NORMAL` to broadcast and deliver live video
|
1993
1998
|
# up to Full HD. Use `LOW` for near-real-time interaction with viewers.
|
1994
1999
|
#
|
1995
|
-
# @option params [String] :
|
1996
|
-
# Channel
|
1997
|
-
# *If you exceed the allowable input resolution or bitrate, the stream
|
1998
|
-
# probably will disconnect immediately.* Default: `STANDARD`. For
|
1999
|
-
# details, see [Channel Types][1].
|
2000
|
-
#
|
2001
|
-
#
|
2000
|
+
# @option params [String] :name
|
2001
|
+
# Channel name.
|
2002
2002
|
#
|
2003
|
-
#
|
2003
|
+
# @option params [String] :playback_restriction_policy_arn
|
2004
|
+
# Playback-restriction-policy ARN. A valid ARN value here both specifies
|
2005
|
+
# the ARN and enables playback restriction. If this is set to an empty
|
2006
|
+
# string, playback restriction policy is disabled.
|
2004
2007
|
#
|
2005
|
-
# @option params [
|
2006
|
-
#
|
2008
|
+
# @option params [String] :preset
|
2009
|
+
# Optional transcode preset for the channel. This is selectable only for
|
2010
|
+
# `ADVANCED_HD` and `ADVANCED_SD` channel types. For those channel
|
2011
|
+
# types, the default `preset` is `HIGHER_BANDWIDTH_DELIVERY`. For other
|
2012
|
+
# channel types (`BASIC` and `STANDARD`), `preset` is the empty string
|
2013
|
+
# (`""`).
|
2007
2014
|
#
|
2008
2015
|
# @option params [String] :recording_configuration_arn
|
2009
2016
|
# Recording-configuration ARN. A valid ARN value here both specifies the
|
2010
2017
|
# ARN and enables recording. If this is set to an empty string,
|
2011
2018
|
# recording is disabled.
|
2012
2019
|
#
|
2013
|
-
# @option params [
|
2014
|
-
#
|
2015
|
-
#
|
2020
|
+
# @option params [String] :type
|
2021
|
+
# Channel type, which determines the allowable resolution and bitrate.
|
2022
|
+
# *If you exceed the allowable input resolution or bitrate, the stream
|
2023
|
+
# probably will disconnect immediately.* Default: `STANDARD`. For
|
2024
|
+
# details, see [Channel Types][1].
|
2016
2025
|
#
|
2017
|
-
# @option params [String] :preset
|
2018
|
-
# Optional transcode preset for the channel. This is selectable only for
|
2019
|
-
# `ADVANCED_HD` and `ADVANCED_SD` channel types. For those channel
|
2020
|
-
# types, the default `preset` is `HIGHER_BANDWIDTH_DELIVERY`. For other
|
2021
|
-
# channel types (`BASIC` and `STANDARD`), `preset` is the empty string
|
2022
|
-
# (`""`).
|
2023
2026
|
#
|
2024
|
-
#
|
2025
|
-
#
|
2026
|
-
# the ARN and enables playback restriction. If this is set to an empty
|
2027
|
-
# string, playback restriction policy is disabled.
|
2027
|
+
#
|
2028
|
+
# [1]: https://docs.aws.amazon.com/ivs/latest/LowLatencyAPIReference/channel-types.html
|
2028
2029
|
#
|
2029
2030
|
# @return [Types::UpdateChannelResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
2030
2031
|
#
|
@@ -2034,33 +2035,33 @@ module Aws::IVS
|
|
2034
2035
|
#
|
2035
2036
|
# resp = client.update_channel({
|
2036
2037
|
# arn: "ChannelArn", # required
|
2037
|
-
# name: "ChannelName",
|
2038
|
-
# latency_mode: "NORMAL", # accepts NORMAL, LOW
|
2039
|
-
# type: "BASIC", # accepts BASIC, STANDARD, ADVANCED_SD, ADVANCED_HD
|
2040
2038
|
# authorized: false,
|
2041
|
-
# recording_configuration_arn: "ChannelRecordingConfigurationArn",
|
2042
2039
|
# insecure_ingest: false,
|
2043
|
-
#
|
2040
|
+
# latency_mode: "NORMAL", # accepts NORMAL, LOW
|
2041
|
+
# name: "ChannelName",
|
2044
2042
|
# playback_restriction_policy_arn: "ChannelPlaybackRestrictionPolicyArn",
|
2043
|
+
# preset: "HIGHER_BANDWIDTH_DELIVERY", # accepts HIGHER_BANDWIDTH_DELIVERY, CONSTRAINED_BANDWIDTH_DELIVERY
|
2044
|
+
# recording_configuration_arn: "ChannelRecordingConfigurationArn",
|
2045
|
+
# type: "BASIC", # accepts BASIC, STANDARD, ADVANCED_SD, ADVANCED_HD
|
2045
2046
|
# })
|
2046
2047
|
#
|
2047
2048
|
# @example Response structure
|
2048
2049
|
#
|
2049
2050
|
# resp.channel.arn #=> String
|
2050
|
-
# resp.channel.name #=> String
|
2051
|
-
# resp.channel.latency_mode #=> String, one of "NORMAL", "LOW"
|
2052
|
-
# resp.channel.type #=> String, one of "BASIC", "STANDARD", "ADVANCED_SD", "ADVANCED_HD"
|
2053
|
-
# resp.channel.recording_configuration_arn #=> String
|
2054
|
-
# resp.channel.ingest_endpoint #=> String
|
2055
|
-
# resp.channel.playback_url #=> String
|
2056
2051
|
# resp.channel.authorized #=> Boolean
|
2057
|
-
# resp.channel.
|
2058
|
-
# resp.channel.tags["TagKey"] #=> String
|
2052
|
+
# resp.channel.ingest_endpoint #=> String
|
2059
2053
|
# resp.channel.insecure_ingest #=> Boolean
|
2054
|
+
# resp.channel.latency_mode #=> String, one of "NORMAL", "LOW"
|
2055
|
+
# resp.channel.name #=> String
|
2056
|
+
# resp.channel.playback_restriction_policy_arn #=> String
|
2057
|
+
# resp.channel.playback_url #=> String
|
2060
2058
|
# resp.channel.preset #=> String, one of "HIGHER_BANDWIDTH_DELIVERY", "CONSTRAINED_BANDWIDTH_DELIVERY"
|
2059
|
+
# resp.channel.recording_configuration_arn #=> String
|
2061
2060
|
# resp.channel.srt.endpoint #=> String
|
2062
2061
|
# resp.channel.srt.passphrase #=> String
|
2063
|
-
# resp.channel.
|
2062
|
+
# resp.channel.tags #=> Hash
|
2063
|
+
# resp.channel.tags["TagKey"] #=> String
|
2064
|
+
# resp.channel.type #=> String, one of "BASIC", "STANDARD", "ADVANCED_SD", "ADVANCED_HD"
|
2064
2065
|
#
|
2065
2066
|
# @see http://docs.aws.amazon.com/goto/WebAPI/ivs-2020-07-14/UpdateChannel AWS API Documentation
|
2066
2067
|
#
|
@@ -2073,9 +2074,6 @@ module Aws::IVS
|
|
2073
2074
|
|
2074
2075
|
# Updates a specified playback restriction policy.
|
2075
2076
|
#
|
2076
|
-
# @option params [required, String] :arn
|
2077
|
-
# ARN of the playback-restriction-policy to be updated.
|
2078
|
-
#
|
2079
2077
|
# @option params [Array<String>] :allowed_countries
|
2080
2078
|
# A list of country codes that control geoblocking restriction. Allowed
|
2081
2079
|
# values are the officially assigned [ISO 3166-1 alpha-2][1] codes.
|
@@ -2095,6 +2093,9 @@ module Aws::IVS
|
|
2095
2093
|
#
|
2096
2094
|
# [1]: https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Origin
|
2097
2095
|
#
|
2096
|
+
# @option params [required, String] :arn
|
2097
|
+
# ARN of the playback-restriction-policy to be updated.
|
2098
|
+
#
|
2098
2099
|
# @option params [Boolean] :enable_strict_origin_enforcement
|
2099
2100
|
# Whether channel playback is constrained by origin site. Default:
|
2100
2101
|
# `false`.
|
@@ -2110,20 +2111,20 @@ module Aws::IVS
|
|
2110
2111
|
# @example Request syntax with placeholder values
|
2111
2112
|
#
|
2112
2113
|
# resp = client.update_playback_restriction_policy({
|
2113
|
-
# arn: "PlaybackRestrictionPolicyArn", # required
|
2114
2114
|
# allowed_countries: ["PlaybackRestrictionPolicyAllowedCountry"],
|
2115
2115
|
# allowed_origins: ["PlaybackRestrictionPolicyAllowedOrigin"],
|
2116
|
+
# arn: "PlaybackRestrictionPolicyArn", # required
|
2116
2117
|
# enable_strict_origin_enforcement: false,
|
2117
2118
|
# name: "PlaybackRestrictionPolicyName",
|
2118
2119
|
# })
|
2119
2120
|
#
|
2120
2121
|
# @example Response structure
|
2121
2122
|
#
|
2122
|
-
# resp.playback_restriction_policy.arn #=> String
|
2123
2123
|
# resp.playback_restriction_policy.allowed_countries #=> Array
|
2124
2124
|
# resp.playback_restriction_policy.allowed_countries[0] #=> String
|
2125
2125
|
# resp.playback_restriction_policy.allowed_origins #=> Array
|
2126
2126
|
# resp.playback_restriction_policy.allowed_origins[0] #=> String
|
2127
|
+
# resp.playback_restriction_policy.arn #=> String
|
2127
2128
|
# resp.playback_restriction_policy.enable_strict_origin_enforcement #=> Boolean
|
2128
2129
|
# resp.playback_restriction_policy.name #=> String
|
2129
2130
|
# resp.playback_restriction_policy.tags #=> Hash
|
@@ -2156,7 +2157,7 @@ module Aws::IVS
|
|
2156
2157
|
tracer: tracer
|
2157
2158
|
)
|
2158
2159
|
context[:gem_name] = 'aws-sdk-ivs'
|
2159
|
-
context[:gem_version] = '1.
|
2160
|
+
context[:gem_version] = '1.62.0'
|
2160
2161
|
Seahorse::Client::Request.new(handlers, context)
|
2161
2162
|
end
|
2162
2163
|
|