aws-sdk-ivs 1.52.0 → 1.53.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-ivs/client.rb +238 -238
- data/lib/aws-sdk-ivs/client_api.rb +70 -69
- data/lib/aws-sdk-ivs/types.rb +410 -410
- data/lib/aws-sdk-ivs.rb +1 -1
- data/sig/client.rbs +43 -43
- data/sig/types.rbs +70 -70
- metadata +4 -4
data/lib/aws-sdk-ivs/client.rb
CHANGED
@@ -445,20 +445,20 @@ module Aws::IVS
|
|
445
445
|
#
|
446
446
|
# resp.channels #=> Array
|
447
447
|
# resp.channels[0].arn #=> String
|
448
|
-
# resp.channels[0].authorized #=> Boolean
|
449
|
-
# resp.channels[0].ingest_endpoint #=> String
|
450
|
-
# resp.channels[0].insecure_ingest #=> Boolean
|
451
|
-
# resp.channels[0].latency_mode #=> String, one of "NORMAL", "LOW"
|
452
448
|
# resp.channels[0].name #=> String
|
453
|
-
# resp.channels[0].
|
449
|
+
# resp.channels[0].latency_mode #=> String, one of "NORMAL", "LOW"
|
450
|
+
# resp.channels[0].type #=> String, one of "BASIC", "STANDARD", "ADVANCED_SD", "ADVANCED_HD"
|
451
|
+
# resp.channels[0].recording_configuration_arn #=> String
|
452
|
+
# resp.channels[0].ingest_endpoint #=> String
|
454
453
|
# resp.channels[0].playback_url #=> String
|
454
|
+
# resp.channels[0].authorized #=> Boolean
|
455
|
+
# resp.channels[0].tags #=> Hash
|
456
|
+
# resp.channels[0].tags["TagKey"] #=> String
|
457
|
+
# resp.channels[0].insecure_ingest #=> Boolean
|
455
458
|
# resp.channels[0].preset #=> String, one of "HIGHER_BANDWIDTH_DELIVERY", "CONSTRAINED_BANDWIDTH_DELIVERY"
|
456
|
-
# resp.channels[0].recording_configuration_arn #=> String
|
457
459
|
# resp.channels[0].srt.endpoint #=> String
|
458
460
|
# resp.channels[0].srt.passphrase #=> String
|
459
|
-
# resp.channels[0].
|
460
|
-
# resp.channels[0].tags["TagKey"] #=> String
|
461
|
-
# resp.channels[0].type #=> String, one of "BASIC", "STANDARD", "ADVANCED_SD", "ADVANCED_HD"
|
461
|
+
# resp.channels[0].playback_restriction_policy_arn #=> String
|
462
462
|
# resp.errors #=> Array
|
463
463
|
# resp.errors[0].arn #=> String
|
464
464
|
# resp.errors[0].code #=> String
|
@@ -480,8 +480,8 @@ module Aws::IVS
|
|
480
480
|
#
|
481
481
|
# @return [Types::BatchGetStreamKeyResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
482
482
|
#
|
483
|
-
# * {Types::BatchGetStreamKeyResponse#errors #errors} => Array<Types::BatchError>
|
484
483
|
# * {Types::BatchGetStreamKeyResponse#stream_keys #stream_keys} => Array<Types::StreamKey>
|
484
|
+
# * {Types::BatchGetStreamKeyResponse#errors #errors} => Array<Types::BatchError>
|
485
485
|
#
|
486
486
|
# @example Request syntax with placeholder values
|
487
487
|
#
|
@@ -491,16 +491,16 @@ module Aws::IVS
|
|
491
491
|
#
|
492
492
|
# @example Response structure
|
493
493
|
#
|
494
|
-
# resp.errors #=> Array
|
495
|
-
# resp.errors[0].arn #=> String
|
496
|
-
# resp.errors[0].code #=> String
|
497
|
-
# resp.errors[0].message #=> String
|
498
494
|
# resp.stream_keys #=> Array
|
499
495
|
# resp.stream_keys[0].arn #=> String
|
496
|
+
# resp.stream_keys[0].value #=> String
|
500
497
|
# resp.stream_keys[0].channel_arn #=> String
|
501
498
|
# resp.stream_keys[0].tags #=> Hash
|
502
499
|
# resp.stream_keys[0].tags["TagKey"] #=> String
|
503
|
-
# resp.
|
500
|
+
# resp.errors #=> Array
|
501
|
+
# resp.errors[0].arn #=> String
|
502
|
+
# resp.errors[0].code #=> String
|
503
|
+
# resp.errors[0].message #=> String
|
504
504
|
#
|
505
505
|
# @see http://docs.aws.amazon.com/goto/WebAPI/ivs-2020-07-14/BatchGetStreamKey AWS API Documentation
|
506
506
|
#
|
@@ -537,9 +537,9 @@ module Aws::IVS
|
|
537
537
|
#
|
538
538
|
# resp.errors #=> Array
|
539
539
|
# resp.errors[0].channel_arn #=> String
|
540
|
+
# resp.errors[0].viewer_id #=> String
|
540
541
|
# resp.errors[0].code #=> String
|
541
542
|
# resp.errors[0].message #=> String
|
542
|
-
# resp.errors[0].viewer_id #=> String
|
543
543
|
#
|
544
544
|
# @see http://docs.aws.amazon.com/goto/WebAPI/ivs-2020-07-14/BatchStartViewerSessionRevocation AWS API Documentation
|
545
545
|
#
|
@@ -552,33 +552,27 @@ module Aws::IVS
|
|
552
552
|
|
553
553
|
# Creates a new channel and an associated stream key to start streaming.
|
554
554
|
#
|
555
|
-
# @option params [
|
556
|
-
#
|
557
|
-
# Default: `false`.
|
558
|
-
#
|
559
|
-
# @option params [Boolean] :insecure_ingest
|
560
|
-
# Whether the channel allows insecure RTMP and SRT ingest. Default:
|
561
|
-
# `false`.
|
555
|
+
# @option params [String] :name
|
556
|
+
# Channel name.
|
562
557
|
#
|
563
558
|
# @option params [String] :latency_mode
|
564
559
|
# Channel latency mode. Use `NORMAL` to broadcast and deliver live video
|
565
560
|
# up to Full HD. Use `LOW` for near-real-time interaction with viewers.
|
566
561
|
# Default: `LOW`.
|
567
562
|
#
|
568
|
-
# @option params [String] :
|
569
|
-
# Channel
|
563
|
+
# @option params [String] :type
|
564
|
+
# Channel type, which determines the allowable resolution and bitrate.
|
565
|
+
# *If you exceed the allowable input resolution or bitrate, the stream
|
566
|
+
# probably will disconnect immediately.* Default: `STANDARD`. For
|
567
|
+
# details, see [Channel Types][1].
|
570
568
|
#
|
571
|
-
# @option params [String] :playback_restriction_policy_arn
|
572
|
-
# Playback-restriction-policy ARN. A valid ARN value here both specifies
|
573
|
-
# the ARN and enables playback restriction. Default: "" (empty string,
|
574
|
-
# no playback restriction policy is applied).
|
575
569
|
#
|
576
|
-
#
|
577
|
-
#
|
578
|
-
#
|
579
|
-
#
|
580
|
-
#
|
581
|
-
#
|
570
|
+
#
|
571
|
+
# [1]: https://docs.aws.amazon.com/ivs/latest/LowLatencyAPIReference/channel-types.html
|
572
|
+
#
|
573
|
+
# @option params [Boolean] :authorized
|
574
|
+
# Whether the channel is private (enabled for playback authorization).
|
575
|
+
# Default: `false`.
|
582
576
|
#
|
583
577
|
# @option params [String] :recording_configuration_arn
|
584
578
|
# Recording-configuration ARN. A valid ARN value here both specifies the
|
@@ -596,15 +590,21 @@ module Aws::IVS
|
|
596
590
|
#
|
597
591
|
# [1]: https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html
|
598
592
|
#
|
599
|
-
# @option params [
|
600
|
-
#
|
601
|
-
#
|
602
|
-
# probably will disconnect immediately.* Default: `STANDARD`. For
|
603
|
-
# details, see [Channel Types][1].
|
604
|
-
#
|
593
|
+
# @option params [Boolean] :insecure_ingest
|
594
|
+
# Whether the channel allows insecure RTMP and SRT ingest. Default:
|
595
|
+
# `false`.
|
605
596
|
#
|
597
|
+
# @option params [String] :preset
|
598
|
+
# Optional transcode preset for the channel. This is selectable only for
|
599
|
+
# `ADVANCED_HD` and `ADVANCED_SD` channel types. For those channel
|
600
|
+
# types, the default `preset` is `HIGHER_BANDWIDTH_DELIVERY`. For other
|
601
|
+
# channel types (`BASIC` and `STANDARD`), `preset` is the empty string
|
602
|
+
# (`""`).
|
606
603
|
#
|
607
|
-
#
|
604
|
+
# @option params [String] :playback_restriction_policy_arn
|
605
|
+
# Playback-restriction-policy ARN. A valid ARN value here both specifies
|
606
|
+
# the ARN and enables playback restriction. Default: "" (empty string,
|
607
|
+
# no playback restriction policy is applied).
|
608
608
|
#
|
609
609
|
# @return [Types::CreateChannelResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
610
610
|
#
|
@@ -614,41 +614,41 @@ module Aws::IVS
|
|
614
614
|
# @example Request syntax with placeholder values
|
615
615
|
#
|
616
616
|
# resp = client.create_channel({
|
617
|
-
# authorized: false,
|
618
|
-
# insecure_ingest: false,
|
619
|
-
# latency_mode: "NORMAL", # accepts NORMAL, LOW
|
620
617
|
# name: "ChannelName",
|
621
|
-
#
|
622
|
-
#
|
618
|
+
# latency_mode: "NORMAL", # accepts NORMAL, LOW
|
619
|
+
# type: "BASIC", # accepts BASIC, STANDARD, ADVANCED_SD, ADVANCED_HD
|
620
|
+
# authorized: false,
|
623
621
|
# recording_configuration_arn: "ChannelRecordingConfigurationArn",
|
624
622
|
# tags: {
|
625
623
|
# "TagKey" => "TagValue",
|
626
624
|
# },
|
627
|
-
#
|
625
|
+
# insecure_ingest: false,
|
626
|
+
# preset: "HIGHER_BANDWIDTH_DELIVERY", # accepts HIGHER_BANDWIDTH_DELIVERY, CONSTRAINED_BANDWIDTH_DELIVERY
|
627
|
+
# playback_restriction_policy_arn: "ChannelPlaybackRestrictionPolicyArn",
|
628
628
|
# })
|
629
629
|
#
|
630
630
|
# @example Response structure
|
631
631
|
#
|
632
632
|
# resp.channel.arn #=> String
|
633
|
-
# resp.channel.authorized #=> Boolean
|
634
|
-
# resp.channel.ingest_endpoint #=> String
|
635
|
-
# resp.channel.insecure_ingest #=> Boolean
|
636
|
-
# resp.channel.latency_mode #=> String, one of "NORMAL", "LOW"
|
637
633
|
# resp.channel.name #=> String
|
638
|
-
# resp.channel.
|
634
|
+
# resp.channel.latency_mode #=> String, one of "NORMAL", "LOW"
|
635
|
+
# resp.channel.type #=> String, one of "BASIC", "STANDARD", "ADVANCED_SD", "ADVANCED_HD"
|
636
|
+
# resp.channel.recording_configuration_arn #=> String
|
637
|
+
# resp.channel.ingest_endpoint #=> String
|
639
638
|
# resp.channel.playback_url #=> String
|
639
|
+
# resp.channel.authorized #=> Boolean
|
640
|
+
# resp.channel.tags #=> Hash
|
641
|
+
# resp.channel.tags["TagKey"] #=> String
|
642
|
+
# resp.channel.insecure_ingest #=> Boolean
|
640
643
|
# resp.channel.preset #=> String, one of "HIGHER_BANDWIDTH_DELIVERY", "CONSTRAINED_BANDWIDTH_DELIVERY"
|
641
|
-
# resp.channel.recording_configuration_arn #=> String
|
642
644
|
# resp.channel.srt.endpoint #=> String
|
643
645
|
# resp.channel.srt.passphrase #=> String
|
644
|
-
# resp.channel.
|
645
|
-
# resp.channel.tags["TagKey"] #=> String
|
646
|
-
# resp.channel.type #=> String, one of "BASIC", "STANDARD", "ADVANCED_SD", "ADVANCED_HD"
|
646
|
+
# resp.channel.playback_restriction_policy_arn #=> String
|
647
647
|
# resp.stream_key.arn #=> String
|
648
|
+
# resp.stream_key.value #=> String
|
648
649
|
# resp.stream_key.channel_arn #=> String
|
649
650
|
# resp.stream_key.tags #=> Hash
|
650
651
|
# resp.stream_key.tags["TagKey"] #=> String
|
651
|
-
# resp.stream_key.value #=> String
|
652
652
|
#
|
653
653
|
# @see http://docs.aws.amazon.com/goto/WebAPI/ivs-2020-07-14/CreateChannel AWS API Documentation
|
654
654
|
#
|
@@ -718,11 +718,11 @@ module Aws::IVS
|
|
718
718
|
#
|
719
719
|
# @example Response structure
|
720
720
|
#
|
721
|
+
# resp.playback_restriction_policy.arn #=> String
|
721
722
|
# resp.playback_restriction_policy.allowed_countries #=> Array
|
722
723
|
# resp.playback_restriction_policy.allowed_countries[0] #=> String
|
723
724
|
# resp.playback_restriction_policy.allowed_origins #=> Array
|
724
725
|
# resp.playback_restriction_policy.allowed_origins[0] #=> String
|
725
|
-
# resp.playback_restriction_policy.arn #=> String
|
726
726
|
# resp.playback_restriction_policy.enable_strict_origin_enforcement #=> Boolean
|
727
727
|
# resp.playback_restriction_policy.name #=> String
|
728
728
|
# resp.playback_restriction_policy.tags #=> Hash
|
@@ -753,21 +753,12 @@ module Aws::IVS
|
|
753
753
|
# configuration and create a new one with an S3 bucket from the correct
|
754
754
|
# region.
|
755
755
|
#
|
756
|
-
# @option params [required, Types::DestinationConfiguration] :destination_configuration
|
757
|
-
# A complex type that contains a destination configuration for where
|
758
|
-
# recorded video will be stored.
|
759
|
-
#
|
760
756
|
# @option params [String] :name
|
761
757
|
# Recording-configuration name. The value does not need to be unique.
|
762
758
|
#
|
763
|
-
# @option params [
|
764
|
-
#
|
765
|
-
#
|
766
|
-
# and merged together. Default: 0.
|
767
|
-
#
|
768
|
-
# @option params [Types::RenditionConfiguration] :rendition_configuration
|
769
|
-
# Object that describes which renditions should be recorded for a
|
770
|
-
# stream.
|
759
|
+
# @option params [required, Types::DestinationConfiguration] :destination_configuration
|
760
|
+
# A complex type that contains a destination configuration for where
|
761
|
+
# recorded video will be stored.
|
771
762
|
#
|
772
763
|
# @option params [Hash<String,String>] :tags
|
773
764
|
# Array of 1-50 maps, each of the form `string:string (key:value)`. See
|
@@ -785,6 +776,15 @@ module Aws::IVS
|
|
785
776
|
# thumbnails for a live session and modify the interval at which
|
786
777
|
# thumbnails are generated for the live session.
|
787
778
|
#
|
779
|
+
# @option params [Integer] :recording_reconnect_window_seconds
|
780
|
+
# If a broadcast disconnects and then reconnects within the specified
|
781
|
+
# interval, the multiple streams will be considered a single broadcast
|
782
|
+
# and merged together. Default: 0.
|
783
|
+
#
|
784
|
+
# @option params [Types::RenditionConfiguration] :rendition_configuration
|
785
|
+
# Object that describes which renditions should be recorded for a
|
786
|
+
# stream.
|
787
|
+
#
|
788
788
|
# @return [Types::CreateRecordingConfigurationResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
789
789
|
#
|
790
790
|
# * {Types::CreateRecordingConfigurationResponse#recording_configuration #recording_configuration} => Types::RecordingConfiguration
|
@@ -792,45 +792,45 @@ module Aws::IVS
|
|
792
792
|
# @example Request syntax with placeholder values
|
793
793
|
#
|
794
794
|
# resp = client.create_recording_configuration({
|
795
|
+
# name: "RecordingConfigurationName",
|
795
796
|
# destination_configuration: { # required
|
796
797
|
# s3: {
|
797
798
|
# bucket_name: "S3DestinationBucketName", # required
|
798
799
|
# },
|
799
800
|
# },
|
800
|
-
# name: "RecordingConfigurationName",
|
801
|
-
# recording_reconnect_window_seconds: 1,
|
802
|
-
# rendition_configuration: {
|
803
|
-
# rendition_selection: "ALL", # accepts ALL, NONE, CUSTOM
|
804
|
-
# renditions: ["FULL_HD"], # accepts FULL_HD, HD, SD, LOWEST_RESOLUTION
|
805
|
-
# },
|
806
801
|
# tags: {
|
807
802
|
# "TagKey" => "TagValue",
|
808
803
|
# },
|
809
804
|
# thumbnail_configuration: {
|
810
805
|
# recording_mode: "DISABLED", # accepts DISABLED, INTERVAL
|
811
|
-
# resolution: "FULL_HD", # accepts FULL_HD, HD, SD, LOWEST_RESOLUTION
|
812
|
-
# storage: ["SEQUENTIAL"], # accepts SEQUENTIAL, LATEST
|
813
806
|
# target_interval_seconds: 1,
|
807
|
+
# resolution: "SD", # accepts SD, HD, FULL_HD, LOWEST_RESOLUTION
|
808
|
+
# storage: ["SEQUENTIAL"], # accepts SEQUENTIAL, LATEST
|
809
|
+
# },
|
810
|
+
# recording_reconnect_window_seconds: 1,
|
811
|
+
# rendition_configuration: {
|
812
|
+
# rendition_selection: "ALL", # accepts ALL, NONE, CUSTOM
|
813
|
+
# renditions: ["SD"], # accepts SD, HD, FULL_HD, LOWEST_RESOLUTION
|
814
814
|
# },
|
815
815
|
# })
|
816
816
|
#
|
817
817
|
# @example Response structure
|
818
818
|
#
|
819
819
|
# resp.recording_configuration.arn #=> String
|
820
|
-
# resp.recording_configuration.destination_configuration.s3.bucket_name #=> String
|
821
820
|
# resp.recording_configuration.name #=> String
|
822
|
-
# resp.recording_configuration.
|
823
|
-
# resp.recording_configuration.rendition_configuration.rendition_selection #=> String, one of "ALL", "NONE", "CUSTOM"
|
824
|
-
# resp.recording_configuration.rendition_configuration.renditions #=> Array
|
825
|
-
# resp.recording_configuration.rendition_configuration.renditions[0] #=> String, one of "FULL_HD", "HD", "SD", "LOWEST_RESOLUTION"
|
821
|
+
# resp.recording_configuration.destination_configuration.s3.bucket_name #=> String
|
826
822
|
# resp.recording_configuration.state #=> String, one of "CREATING", "CREATE_FAILED", "ACTIVE"
|
827
823
|
# resp.recording_configuration.tags #=> Hash
|
828
824
|
# resp.recording_configuration.tags["TagKey"] #=> String
|
829
825
|
# resp.recording_configuration.thumbnail_configuration.recording_mode #=> String, one of "DISABLED", "INTERVAL"
|
830
|
-
# resp.recording_configuration.thumbnail_configuration.
|
826
|
+
# resp.recording_configuration.thumbnail_configuration.target_interval_seconds #=> Integer
|
827
|
+
# resp.recording_configuration.thumbnail_configuration.resolution #=> String, one of "SD", "HD", "FULL_HD", "LOWEST_RESOLUTION"
|
831
828
|
# resp.recording_configuration.thumbnail_configuration.storage #=> Array
|
832
829
|
# resp.recording_configuration.thumbnail_configuration.storage[0] #=> String, one of "SEQUENTIAL", "LATEST"
|
833
|
-
# resp.recording_configuration.
|
830
|
+
# resp.recording_configuration.recording_reconnect_window_seconds #=> Integer
|
831
|
+
# resp.recording_configuration.rendition_configuration.rendition_selection #=> String, one of "ALL", "NONE", "CUSTOM"
|
832
|
+
# resp.recording_configuration.rendition_configuration.renditions #=> Array
|
833
|
+
# resp.recording_configuration.rendition_configuration.renditions[0] #=> String, one of "SD", "HD", "FULL_HD", "LOWEST_RESOLUTION"
|
834
834
|
#
|
835
835
|
# @see http://docs.aws.amazon.com/goto/WebAPI/ivs-2020-07-14/CreateRecordingConfiguration AWS API Documentation
|
836
836
|
#
|
@@ -880,10 +880,10 @@ module Aws::IVS
|
|
880
880
|
# @example Response structure
|
881
881
|
#
|
882
882
|
# resp.stream_key.arn #=> String
|
883
|
+
# resp.stream_key.value #=> String
|
883
884
|
# resp.stream_key.channel_arn #=> String
|
884
885
|
# resp.stream_key.tags #=> Hash
|
885
886
|
# resp.stream_key.tags["TagKey"] #=> String
|
886
|
-
# resp.stream_key.value #=> String
|
887
887
|
#
|
888
888
|
# @see http://docs.aws.amazon.com/goto/WebAPI/ivs-2020-07-14/CreateStreamKey AWS API Documentation
|
889
889
|
#
|
@@ -1047,20 +1047,20 @@ module Aws::IVS
|
|
1047
1047
|
# @example Response structure
|
1048
1048
|
#
|
1049
1049
|
# resp.channel.arn #=> String
|
1050
|
-
# resp.channel.authorized #=> Boolean
|
1051
|
-
# resp.channel.ingest_endpoint #=> String
|
1052
|
-
# resp.channel.insecure_ingest #=> Boolean
|
1053
|
-
# resp.channel.latency_mode #=> String, one of "NORMAL", "LOW"
|
1054
1050
|
# resp.channel.name #=> String
|
1055
|
-
# resp.channel.
|
1051
|
+
# resp.channel.latency_mode #=> String, one of "NORMAL", "LOW"
|
1052
|
+
# resp.channel.type #=> String, one of "BASIC", "STANDARD", "ADVANCED_SD", "ADVANCED_HD"
|
1053
|
+
# resp.channel.recording_configuration_arn #=> String
|
1054
|
+
# resp.channel.ingest_endpoint #=> String
|
1056
1055
|
# resp.channel.playback_url #=> String
|
1056
|
+
# resp.channel.authorized #=> Boolean
|
1057
|
+
# resp.channel.tags #=> Hash
|
1058
|
+
# resp.channel.tags["TagKey"] #=> String
|
1059
|
+
# resp.channel.insecure_ingest #=> Boolean
|
1057
1060
|
# resp.channel.preset #=> String, one of "HIGHER_BANDWIDTH_DELIVERY", "CONSTRAINED_BANDWIDTH_DELIVERY"
|
1058
|
-
# resp.channel.recording_configuration_arn #=> String
|
1059
1061
|
# resp.channel.srt.endpoint #=> String
|
1060
1062
|
# resp.channel.srt.passphrase #=> String
|
1061
|
-
# resp.channel.
|
1062
|
-
# resp.channel.tags["TagKey"] #=> String
|
1063
|
-
# resp.channel.type #=> String, one of "BASIC", "STANDARD", "ADVANCED_SD", "ADVANCED_HD"
|
1063
|
+
# resp.channel.playback_restriction_policy_arn #=> String
|
1064
1064
|
#
|
1065
1065
|
# @see http://docs.aws.amazon.com/goto/WebAPI/ivs-2020-07-14/GetChannel AWS API Documentation
|
1066
1066
|
#
|
@@ -1097,8 +1097,8 @@ module Aws::IVS
|
|
1097
1097
|
# @example Response structure
|
1098
1098
|
#
|
1099
1099
|
# resp.key_pair.arn #=> String
|
1100
|
-
# resp.key_pair.fingerprint #=> String
|
1101
1100
|
# resp.key_pair.name #=> String
|
1101
|
+
# resp.key_pair.fingerprint #=> String
|
1102
1102
|
# resp.key_pair.tags #=> Hash
|
1103
1103
|
# resp.key_pair.tags["TagKey"] #=> String
|
1104
1104
|
#
|
@@ -1128,11 +1128,11 @@ module Aws::IVS
|
|
1128
1128
|
#
|
1129
1129
|
# @example Response structure
|
1130
1130
|
#
|
1131
|
+
# resp.playback_restriction_policy.arn #=> String
|
1131
1132
|
# resp.playback_restriction_policy.allowed_countries #=> Array
|
1132
1133
|
# resp.playback_restriction_policy.allowed_countries[0] #=> String
|
1133
1134
|
# resp.playback_restriction_policy.allowed_origins #=> Array
|
1134
1135
|
# resp.playback_restriction_policy.allowed_origins[0] #=> String
|
1135
|
-
# resp.playback_restriction_policy.arn #=> String
|
1136
1136
|
# resp.playback_restriction_policy.enable_strict_origin_enforcement #=> Boolean
|
1137
1137
|
# resp.playback_restriction_policy.name #=> String
|
1138
1138
|
# resp.playback_restriction_policy.tags #=> Hash
|
@@ -1165,20 +1165,20 @@ module Aws::IVS
|
|
1165
1165
|
# @example Response structure
|
1166
1166
|
#
|
1167
1167
|
# resp.recording_configuration.arn #=> String
|
1168
|
-
# resp.recording_configuration.destination_configuration.s3.bucket_name #=> String
|
1169
1168
|
# resp.recording_configuration.name #=> String
|
1170
|
-
# resp.recording_configuration.
|
1171
|
-
# resp.recording_configuration.rendition_configuration.rendition_selection #=> String, one of "ALL", "NONE", "CUSTOM"
|
1172
|
-
# resp.recording_configuration.rendition_configuration.renditions #=> Array
|
1173
|
-
# resp.recording_configuration.rendition_configuration.renditions[0] #=> String, one of "FULL_HD", "HD", "SD", "LOWEST_RESOLUTION"
|
1169
|
+
# resp.recording_configuration.destination_configuration.s3.bucket_name #=> String
|
1174
1170
|
# resp.recording_configuration.state #=> String, one of "CREATING", "CREATE_FAILED", "ACTIVE"
|
1175
1171
|
# resp.recording_configuration.tags #=> Hash
|
1176
1172
|
# resp.recording_configuration.tags["TagKey"] #=> String
|
1177
1173
|
# resp.recording_configuration.thumbnail_configuration.recording_mode #=> String, one of "DISABLED", "INTERVAL"
|
1178
|
-
# resp.recording_configuration.thumbnail_configuration.
|
1174
|
+
# resp.recording_configuration.thumbnail_configuration.target_interval_seconds #=> Integer
|
1175
|
+
# resp.recording_configuration.thumbnail_configuration.resolution #=> String, one of "SD", "HD", "FULL_HD", "LOWEST_RESOLUTION"
|
1179
1176
|
# resp.recording_configuration.thumbnail_configuration.storage #=> Array
|
1180
1177
|
# resp.recording_configuration.thumbnail_configuration.storage[0] #=> String, one of "SEQUENTIAL", "LATEST"
|
1181
|
-
# resp.recording_configuration.
|
1178
|
+
# resp.recording_configuration.recording_reconnect_window_seconds #=> Integer
|
1179
|
+
# resp.recording_configuration.rendition_configuration.rendition_selection #=> String, one of "ALL", "NONE", "CUSTOM"
|
1180
|
+
# resp.recording_configuration.rendition_configuration.renditions #=> Array
|
1181
|
+
# resp.recording_configuration.rendition_configuration.renditions[0] #=> String, one of "SD", "HD", "FULL_HD", "LOWEST_RESOLUTION"
|
1182
1182
|
#
|
1183
1183
|
# @see http://docs.aws.amazon.com/goto/WebAPI/ivs-2020-07-14/GetRecordingConfiguration AWS API Documentation
|
1184
1184
|
#
|
@@ -1208,11 +1208,11 @@ module Aws::IVS
|
|
1208
1208
|
# @example Response structure
|
1209
1209
|
#
|
1210
1210
|
# resp.stream.channel_arn #=> String
|
1211
|
-
# resp.stream.
|
1211
|
+
# resp.stream.stream_id #=> String
|
1212
1212
|
# resp.stream.playback_url #=> String
|
1213
1213
|
# resp.stream.start_time #=> Time
|
1214
1214
|
# resp.stream.state #=> String, one of "LIVE", "OFFLINE"
|
1215
|
-
# resp.stream.
|
1215
|
+
# resp.stream.health #=> String, one of "HEALTHY", "STARVING", "UNKNOWN"
|
1216
1216
|
# resp.stream.viewer_count #=> Integer
|
1217
1217
|
#
|
1218
1218
|
# @see http://docs.aws.amazon.com/goto/WebAPI/ivs-2020-07-14/GetStream AWS API Documentation
|
@@ -1242,10 +1242,10 @@ module Aws::IVS
|
|
1242
1242
|
# @example Response structure
|
1243
1243
|
#
|
1244
1244
|
# resp.stream_key.arn #=> String
|
1245
|
+
# resp.stream_key.value #=> String
|
1245
1246
|
# resp.stream_key.channel_arn #=> String
|
1246
1247
|
# resp.stream_key.tags #=> Hash
|
1247
1248
|
# resp.stream_key.tags["TagKey"] #=> String
|
1248
|
-
# resp.stream_key.value #=> String
|
1249
1249
|
#
|
1250
1250
|
# @see http://docs.aws.amazon.com/goto/WebAPI/ivs-2020-07-14/GetStreamKey AWS API Documentation
|
1251
1251
|
#
|
@@ -1279,55 +1279,55 @@ module Aws::IVS
|
|
1279
1279
|
#
|
1280
1280
|
# @example Response structure
|
1281
1281
|
#
|
1282
|
+
# resp.stream_session.stream_id #=> String
|
1283
|
+
# resp.stream_session.start_time #=> Time
|
1284
|
+
# resp.stream_session.end_time #=> Time
|
1282
1285
|
# resp.stream_session.channel.arn #=> String
|
1283
|
-
# resp.stream_session.channel.authorized #=> Boolean
|
1284
|
-
# resp.stream_session.channel.ingest_endpoint #=> String
|
1285
|
-
# resp.stream_session.channel.insecure_ingest #=> Boolean
|
1286
|
-
# resp.stream_session.channel.latency_mode #=> String, one of "NORMAL", "LOW"
|
1287
1286
|
# resp.stream_session.channel.name #=> String
|
1288
|
-
# resp.stream_session.channel.
|
1287
|
+
# resp.stream_session.channel.latency_mode #=> String, one of "NORMAL", "LOW"
|
1288
|
+
# resp.stream_session.channel.type #=> String, one of "BASIC", "STANDARD", "ADVANCED_SD", "ADVANCED_HD"
|
1289
|
+
# resp.stream_session.channel.recording_configuration_arn #=> String
|
1290
|
+
# resp.stream_session.channel.ingest_endpoint #=> String
|
1289
1291
|
# resp.stream_session.channel.playback_url #=> String
|
1292
|
+
# resp.stream_session.channel.authorized #=> Boolean
|
1293
|
+
# resp.stream_session.channel.tags #=> Hash
|
1294
|
+
# resp.stream_session.channel.tags["TagKey"] #=> String
|
1295
|
+
# resp.stream_session.channel.insecure_ingest #=> Boolean
|
1290
1296
|
# resp.stream_session.channel.preset #=> String, one of "HIGHER_BANDWIDTH_DELIVERY", "CONSTRAINED_BANDWIDTH_DELIVERY"
|
1291
|
-
# resp.stream_session.channel.recording_configuration_arn #=> String
|
1292
1297
|
# resp.stream_session.channel.srt.endpoint #=> String
|
1293
1298
|
# resp.stream_session.channel.srt.passphrase #=> String
|
1294
|
-
# resp.stream_session.channel.
|
1295
|
-
# resp.stream_session.channel.tags["TagKey"] #=> String
|
1296
|
-
# resp.stream_session.channel.type #=> String, one of "BASIC", "STANDARD", "ADVANCED_SD", "ADVANCED_HD"
|
1297
|
-
# resp.stream_session.end_time #=> Time
|
1298
|
-
# resp.stream_session.ingest_configuration.audio.channels #=> Integer
|
1299
|
-
# resp.stream_session.ingest_configuration.audio.codec #=> String
|
1300
|
-
# resp.stream_session.ingest_configuration.audio.sample_rate #=> Integer
|
1301
|
-
# resp.stream_session.ingest_configuration.audio.target_bitrate #=> Integer
|
1302
|
-
# resp.stream_session.ingest_configuration.video.avc_level #=> String
|
1299
|
+
# resp.stream_session.channel.playback_restriction_policy_arn #=> String
|
1303
1300
|
# resp.stream_session.ingest_configuration.video.avc_profile #=> String
|
1301
|
+
# resp.stream_session.ingest_configuration.video.avc_level #=> String
|
1304
1302
|
# resp.stream_session.ingest_configuration.video.codec #=> String
|
1305
1303
|
# resp.stream_session.ingest_configuration.video.encoder #=> String
|
1306
1304
|
# resp.stream_session.ingest_configuration.video.target_bitrate #=> Integer
|
1307
1305
|
# resp.stream_session.ingest_configuration.video.target_framerate #=> Integer
|
1308
1306
|
# resp.stream_session.ingest_configuration.video.video_height #=> Integer
|
1309
1307
|
# resp.stream_session.ingest_configuration.video.video_width #=> Integer
|
1308
|
+
# resp.stream_session.ingest_configuration.audio.codec #=> String
|
1309
|
+
# resp.stream_session.ingest_configuration.audio.target_bitrate #=> Integer
|
1310
|
+
# resp.stream_session.ingest_configuration.audio.sample_rate #=> Integer
|
1311
|
+
# resp.stream_session.ingest_configuration.audio.channels #=> Integer
|
1310
1312
|
# resp.stream_session.recording_configuration.arn #=> String
|
1311
|
-
# resp.stream_session.recording_configuration.destination_configuration.s3.bucket_name #=> String
|
1312
1313
|
# resp.stream_session.recording_configuration.name #=> String
|
1313
|
-
# resp.stream_session.recording_configuration.
|
1314
|
-
# resp.stream_session.recording_configuration.rendition_configuration.rendition_selection #=> String, one of "ALL", "NONE", "CUSTOM"
|
1315
|
-
# resp.stream_session.recording_configuration.rendition_configuration.renditions #=> Array
|
1316
|
-
# resp.stream_session.recording_configuration.rendition_configuration.renditions[0] #=> String, one of "FULL_HD", "HD", "SD", "LOWEST_RESOLUTION"
|
1314
|
+
# resp.stream_session.recording_configuration.destination_configuration.s3.bucket_name #=> String
|
1317
1315
|
# resp.stream_session.recording_configuration.state #=> String, one of "CREATING", "CREATE_FAILED", "ACTIVE"
|
1318
1316
|
# resp.stream_session.recording_configuration.tags #=> Hash
|
1319
1317
|
# resp.stream_session.recording_configuration.tags["TagKey"] #=> String
|
1320
1318
|
# resp.stream_session.recording_configuration.thumbnail_configuration.recording_mode #=> String, one of "DISABLED", "INTERVAL"
|
1321
|
-
# resp.stream_session.recording_configuration.thumbnail_configuration.
|
1319
|
+
# resp.stream_session.recording_configuration.thumbnail_configuration.target_interval_seconds #=> Integer
|
1320
|
+
# resp.stream_session.recording_configuration.thumbnail_configuration.resolution #=> String, one of "SD", "HD", "FULL_HD", "LOWEST_RESOLUTION"
|
1322
1321
|
# resp.stream_session.recording_configuration.thumbnail_configuration.storage #=> Array
|
1323
1322
|
# resp.stream_session.recording_configuration.thumbnail_configuration.storage[0] #=> String, one of "SEQUENTIAL", "LATEST"
|
1324
|
-
# resp.stream_session.recording_configuration.
|
1325
|
-
# resp.stream_session.
|
1326
|
-
# resp.stream_session.
|
1323
|
+
# resp.stream_session.recording_configuration.recording_reconnect_window_seconds #=> Integer
|
1324
|
+
# resp.stream_session.recording_configuration.rendition_configuration.rendition_selection #=> String, one of "ALL", "NONE", "CUSTOM"
|
1325
|
+
# resp.stream_session.recording_configuration.rendition_configuration.renditions #=> Array
|
1326
|
+
# resp.stream_session.recording_configuration.rendition_configuration.renditions[0] #=> String, one of "SD", "HD", "FULL_HD", "LOWEST_RESOLUTION"
|
1327
1327
|
# resp.stream_session.truncated_events #=> Array
|
1328
|
-
# resp.stream_session.truncated_events[0].event_time #=> Time
|
1329
1328
|
# resp.stream_session.truncated_events[0].name #=> String
|
1330
1329
|
# resp.stream_session.truncated_events[0].type #=> String
|
1330
|
+
# resp.stream_session.truncated_events[0].event_time #=> Time
|
1331
1331
|
#
|
1332
1332
|
# @see http://docs.aws.amazon.com/goto/WebAPI/ivs-2020-07-14/GetStreamSession AWS API Documentation
|
1333
1333
|
#
|
@@ -1348,12 +1348,12 @@ module Aws::IVS
|
|
1348
1348
|
#
|
1349
1349
|
# [1]: https://docs.aws.amazon.com/ivs/latest/userguide/private-channels.html
|
1350
1350
|
#
|
1351
|
-
# @option params [String] :name
|
1352
|
-
# Playback-key-pair name. The value does not need to be unique.
|
1353
|
-
#
|
1354
1351
|
# @option params [required, String] :public_key_material
|
1355
1352
|
# The public portion of a customer-generated key pair.
|
1356
1353
|
#
|
1354
|
+
# @option params [String] :name
|
1355
|
+
# Playback-key-pair name. The value does not need to be unique.
|
1356
|
+
#
|
1357
1357
|
# @option params [Hash<String,String>] :tags
|
1358
1358
|
# Any tags provided with the request are added to the playback key pair
|
1359
1359
|
# tags. See [Tagging Amazon Web Services Resources][1] for more
|
@@ -1372,8 +1372,8 @@ module Aws::IVS
|
|
1372
1372
|
# @example Request syntax with placeholder values
|
1373
1373
|
#
|
1374
1374
|
# resp = client.import_playback_key_pair({
|
1375
|
-
# name: "PlaybackKeyPairName",
|
1376
1375
|
# public_key_material: "PlaybackPublicKeyMaterial", # required
|
1376
|
+
# name: "PlaybackKeyPairName",
|
1377
1377
|
# tags: {
|
1378
1378
|
# "TagKey" => "TagValue",
|
1379
1379
|
# },
|
@@ -1382,8 +1382,8 @@ module Aws::IVS
|
|
1382
1382
|
# @example Response structure
|
1383
1383
|
#
|
1384
1384
|
# resp.key_pair.arn #=> String
|
1385
|
-
# resp.key_pair.fingerprint #=> String
|
1386
1385
|
# resp.key_pair.name #=> String
|
1386
|
+
# resp.key_pair.fingerprint #=> String
|
1387
1387
|
# resp.key_pair.tags #=> Hash
|
1388
1388
|
# resp.key_pair.tags["TagKey"] #=> String
|
1389
1389
|
#
|
@@ -1406,20 +1406,20 @@ module Aws::IVS
|
|
1406
1406
|
# @option params [String] :filter_by_name
|
1407
1407
|
# Filters the channel list to match the specified name.
|
1408
1408
|
#
|
1409
|
-
# @option params [String] :filter_by_playback_restriction_policy_arn
|
1410
|
-
# Filters the channel list to match the specified policy.
|
1411
|
-
#
|
1412
1409
|
# @option params [String] :filter_by_recording_configuration_arn
|
1413
1410
|
# Filters the channel list to match the specified
|
1414
1411
|
# recording-configuration ARN.
|
1415
1412
|
#
|
1416
|
-
# @option params [
|
1417
|
-
#
|
1413
|
+
# @option params [String] :filter_by_playback_restriction_policy_arn
|
1414
|
+
# Filters the channel list to match the specified policy.
|
1418
1415
|
#
|
1419
1416
|
# @option params [String] :next_token
|
1420
1417
|
# The first channel to retrieve. This is used for pagination; see the
|
1421
1418
|
# `nextToken` response field.
|
1422
1419
|
#
|
1420
|
+
# @option params [Integer] :max_results
|
1421
|
+
# Maximum number of channels to return. Default: 100.
|
1422
|
+
#
|
1423
1423
|
# @return [Types::ListChannelsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1424
1424
|
#
|
1425
1425
|
# * {Types::ListChannelsResponse#channels #channels} => Array<Types::ChannelSummary>
|
@@ -1431,26 +1431,26 @@ module Aws::IVS
|
|
1431
1431
|
#
|
1432
1432
|
# resp = client.list_channels({
|
1433
1433
|
# filter_by_name: "ChannelName",
|
1434
|
-
# filter_by_playback_restriction_policy_arn: "ChannelPlaybackRestrictionPolicyArn",
|
1435
1434
|
# filter_by_recording_configuration_arn: "ChannelRecordingConfigurationArn",
|
1436
|
-
#
|
1435
|
+
# filter_by_playback_restriction_policy_arn: "ChannelPlaybackRestrictionPolicyArn",
|
1437
1436
|
# next_token: "PaginationToken",
|
1437
|
+
# max_results: 1,
|
1438
1438
|
# })
|
1439
1439
|
#
|
1440
1440
|
# @example Response structure
|
1441
1441
|
#
|
1442
1442
|
# resp.channels #=> Array
|
1443
1443
|
# resp.channels[0].arn #=> String
|
1444
|
-
# resp.channels[0].authorized #=> Boolean
|
1445
|
-
# resp.channels[0].insecure_ingest #=> Boolean
|
1446
|
-
# resp.channels[0].latency_mode #=> String, one of "NORMAL", "LOW"
|
1447
1444
|
# resp.channels[0].name #=> String
|
1448
|
-
# resp.channels[0].
|
1449
|
-
# resp.channels[0].
|
1445
|
+
# resp.channels[0].latency_mode #=> String, one of "NORMAL", "LOW"
|
1446
|
+
# resp.channels[0].authorized #=> Boolean
|
1450
1447
|
# resp.channels[0].recording_configuration_arn #=> String
|
1451
1448
|
# resp.channels[0].tags #=> Hash
|
1452
1449
|
# resp.channels[0].tags["TagKey"] #=> String
|
1450
|
+
# resp.channels[0].insecure_ingest #=> Boolean
|
1453
1451
|
# resp.channels[0].type #=> String, one of "BASIC", "STANDARD", "ADVANCED_SD", "ADVANCED_HD"
|
1452
|
+
# resp.channels[0].preset #=> String, one of "HIGHER_BANDWIDTH_DELIVERY", "CONSTRAINED_BANDWIDTH_DELIVERY"
|
1453
|
+
# resp.channels[0].playback_restriction_policy_arn #=> String
|
1454
1454
|
# resp.next_token #=> String
|
1455
1455
|
#
|
1456
1456
|
# @see http://docs.aws.amazon.com/goto/WebAPI/ivs-2020-07-14/ListChannels AWS API Documentation
|
@@ -1470,14 +1470,14 @@ module Aws::IVS
|
|
1470
1470
|
#
|
1471
1471
|
# [1]: https://docs.aws.amazon.com/ivs/latest/userguide/private-channels.html
|
1472
1472
|
#
|
1473
|
-
# @option params [Integer] :max_results
|
1474
|
-
# Maximum number of key pairs to return. Default: your service quota or
|
1475
|
-
# 100, whichever is smaller.
|
1476
|
-
#
|
1477
1473
|
# @option params [String] :next_token
|
1478
1474
|
# The first key pair to retrieve. This is used for pagination; see the
|
1479
1475
|
# `nextToken` response field.
|
1480
1476
|
#
|
1477
|
+
# @option params [Integer] :max_results
|
1478
|
+
# Maximum number of key pairs to return. Default: your service quota or
|
1479
|
+
# 100, whichever is smaller.
|
1480
|
+
#
|
1481
1481
|
# @return [Types::ListPlaybackKeyPairsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1482
1482
|
#
|
1483
1483
|
# * {Types::ListPlaybackKeyPairsResponse#key_pairs #key_pairs} => Array<Types::PlaybackKeyPairSummary>
|
@@ -1488,8 +1488,8 @@ module Aws::IVS
|
|
1488
1488
|
# @example Request syntax with placeholder values
|
1489
1489
|
#
|
1490
1490
|
# resp = client.list_playback_key_pairs({
|
1491
|
-
# max_results: 1,
|
1492
1491
|
# next_token: "PaginationToken",
|
1492
|
+
# max_results: 1,
|
1493
1493
|
# })
|
1494
1494
|
#
|
1495
1495
|
# @example Response structure
|
@@ -1512,40 +1512,40 @@ module Aws::IVS
|
|
1512
1512
|
|
1513
1513
|
# Gets summary information about playback restriction policies.
|
1514
1514
|
#
|
1515
|
-
# @option params [Integer] :max_results
|
1516
|
-
# Maximum number of policies to return. Default: 1.
|
1517
|
-
#
|
1518
1515
|
# @option params [String] :next_token
|
1519
1516
|
# The first policy to retrieve. This is used for pagination; see the
|
1520
1517
|
# `nextToken` response field.
|
1521
1518
|
#
|
1519
|
+
# @option params [Integer] :max_results
|
1520
|
+
# Maximum number of policies to return. Default: 1.
|
1521
|
+
#
|
1522
1522
|
# @return [Types::ListPlaybackRestrictionPoliciesResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1523
1523
|
#
|
1524
|
-
# * {Types::ListPlaybackRestrictionPoliciesResponse#next_token #next_token} => String
|
1525
1524
|
# * {Types::ListPlaybackRestrictionPoliciesResponse#playback_restriction_policies #playback_restriction_policies} => Array<Types::PlaybackRestrictionPolicySummary>
|
1525
|
+
# * {Types::ListPlaybackRestrictionPoliciesResponse#next_token #next_token} => String
|
1526
1526
|
#
|
1527
1527
|
# The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
|
1528
1528
|
#
|
1529
1529
|
# @example Request syntax with placeholder values
|
1530
1530
|
#
|
1531
1531
|
# resp = client.list_playback_restriction_policies({
|
1532
|
-
# max_results: 1,
|
1533
1532
|
# next_token: "PaginationToken",
|
1533
|
+
# max_results: 1,
|
1534
1534
|
# })
|
1535
1535
|
#
|
1536
1536
|
# @example Response structure
|
1537
1537
|
#
|
1538
|
-
# resp.next_token #=> String
|
1539
1538
|
# resp.playback_restriction_policies #=> Array
|
1539
|
+
# resp.playback_restriction_policies[0].arn #=> String
|
1540
1540
|
# resp.playback_restriction_policies[0].allowed_countries #=> Array
|
1541
1541
|
# resp.playback_restriction_policies[0].allowed_countries[0] #=> String
|
1542
1542
|
# resp.playback_restriction_policies[0].allowed_origins #=> Array
|
1543
1543
|
# resp.playback_restriction_policies[0].allowed_origins[0] #=> String
|
1544
|
-
# resp.playback_restriction_policies[0].arn #=> String
|
1545
1544
|
# resp.playback_restriction_policies[0].enable_strict_origin_enforcement #=> Boolean
|
1546
1545
|
# resp.playback_restriction_policies[0].name #=> String
|
1547
1546
|
# resp.playback_restriction_policies[0].tags #=> Hash
|
1548
1547
|
# resp.playback_restriction_policies[0].tags["TagKey"] #=> String
|
1548
|
+
# resp.next_token #=> String
|
1549
1549
|
#
|
1550
1550
|
# @see http://docs.aws.amazon.com/goto/WebAPI/ivs-2020-07-14/ListPlaybackRestrictionPolicies AWS API Documentation
|
1551
1551
|
#
|
@@ -1560,38 +1560,38 @@ module Aws::IVS
|
|
1560
1560
|
# account, in the Amazon Web Services region where the API request is
|
1561
1561
|
# processed.
|
1562
1562
|
#
|
1563
|
-
# @option params [Integer] :max_results
|
1564
|
-
# Maximum number of recording configurations to return. Default: your
|
1565
|
-
# service quota or 100, whichever is smaller.
|
1566
|
-
#
|
1567
1563
|
# @option params [String] :next_token
|
1568
1564
|
# The first recording configuration to retrieve. This is used for
|
1569
1565
|
# pagination; see the `nextToken` response field.
|
1570
1566
|
#
|
1567
|
+
# @option params [Integer] :max_results
|
1568
|
+
# Maximum number of recording configurations to return. Default: your
|
1569
|
+
# service quota or 100, whichever is smaller.
|
1570
|
+
#
|
1571
1571
|
# @return [Types::ListRecordingConfigurationsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1572
1572
|
#
|
1573
|
-
# * {Types::ListRecordingConfigurationsResponse#next_token #next_token} => String
|
1574
1573
|
# * {Types::ListRecordingConfigurationsResponse#recording_configurations #recording_configurations} => Array<Types::RecordingConfigurationSummary>
|
1574
|
+
# * {Types::ListRecordingConfigurationsResponse#next_token #next_token} => String
|
1575
1575
|
#
|
1576
1576
|
# The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
|
1577
1577
|
#
|
1578
1578
|
# @example Request syntax with placeholder values
|
1579
1579
|
#
|
1580
1580
|
# resp = client.list_recording_configurations({
|
1581
|
-
# max_results: 1,
|
1582
1581
|
# next_token: "PaginationToken",
|
1582
|
+
# max_results: 1,
|
1583
1583
|
# })
|
1584
1584
|
#
|
1585
1585
|
# @example Response structure
|
1586
1586
|
#
|
1587
|
-
# resp.next_token #=> String
|
1588
1587
|
# resp.recording_configurations #=> Array
|
1589
1588
|
# resp.recording_configurations[0].arn #=> String
|
1590
|
-
# resp.recording_configurations[0].destination_configuration.s3.bucket_name #=> String
|
1591
1589
|
# resp.recording_configurations[0].name #=> String
|
1590
|
+
# resp.recording_configurations[0].destination_configuration.s3.bucket_name #=> String
|
1592
1591
|
# resp.recording_configurations[0].state #=> String, one of "CREATING", "CREATE_FAILED", "ACTIVE"
|
1593
1592
|
# resp.recording_configurations[0].tags #=> Hash
|
1594
1593
|
# resp.recording_configurations[0].tags["TagKey"] #=> String
|
1594
|
+
# resp.next_token #=> String
|
1595
1595
|
#
|
1596
1596
|
# @see http://docs.aws.amazon.com/goto/WebAPI/ivs-2020-07-14/ListRecordingConfigurations AWS API Documentation
|
1597
1597
|
#
|
@@ -1607,17 +1607,17 @@ module Aws::IVS
|
|
1607
1607
|
# @option params [required, String] :channel_arn
|
1608
1608
|
# Channel ARN used to filter the list.
|
1609
1609
|
#
|
1610
|
-
# @option params [Integer] :max_results
|
1611
|
-
# Maximum number of streamKeys to return. Default: 1.
|
1612
|
-
#
|
1613
1610
|
# @option params [String] :next_token
|
1614
1611
|
# The first stream key to retrieve. This is used for pagination; see the
|
1615
1612
|
# `nextToken` response field.
|
1616
1613
|
#
|
1614
|
+
# @option params [Integer] :max_results
|
1615
|
+
# Maximum number of streamKeys to return. Default: 1.
|
1616
|
+
#
|
1617
1617
|
# @return [Types::ListStreamKeysResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1618
1618
|
#
|
1619
|
-
# * {Types::ListStreamKeysResponse#next_token #next_token} => String
|
1620
1619
|
# * {Types::ListStreamKeysResponse#stream_keys #stream_keys} => Array<Types::StreamKeySummary>
|
1620
|
+
# * {Types::ListStreamKeysResponse#next_token #next_token} => String
|
1621
1621
|
#
|
1622
1622
|
# The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
|
1623
1623
|
#
|
@@ -1625,18 +1625,18 @@ module Aws::IVS
|
|
1625
1625
|
#
|
1626
1626
|
# resp = client.list_stream_keys({
|
1627
1627
|
# channel_arn: "ChannelArn", # required
|
1628
|
-
# max_results: 1,
|
1629
1628
|
# next_token: "PaginationToken",
|
1629
|
+
# max_results: 1,
|
1630
1630
|
# })
|
1631
1631
|
#
|
1632
1632
|
# @example Response structure
|
1633
1633
|
#
|
1634
|
-
# resp.next_token #=> String
|
1635
1634
|
# resp.stream_keys #=> Array
|
1636
1635
|
# resp.stream_keys[0].arn #=> String
|
1637
1636
|
# resp.stream_keys[0].channel_arn #=> String
|
1638
1637
|
# resp.stream_keys[0].tags #=> Hash
|
1639
1638
|
# resp.stream_keys[0].tags["TagKey"] #=> String
|
1639
|
+
# resp.next_token #=> String
|
1640
1640
|
#
|
1641
1641
|
# @see http://docs.aws.amazon.com/goto/WebAPI/ivs-2020-07-14/ListStreamKeys AWS API Documentation
|
1642
1642
|
#
|
@@ -1653,17 +1653,17 @@ module Aws::IVS
|
|
1653
1653
|
# @option params [required, String] :channel_arn
|
1654
1654
|
# Channel ARN used to filter the list.
|
1655
1655
|
#
|
1656
|
-
# @option params [Integer] :max_results
|
1657
|
-
# Maximum number of streams to return. Default: 100.
|
1658
|
-
#
|
1659
1656
|
# @option params [String] :next_token
|
1660
1657
|
# The first stream to retrieve. This is used for pagination; see the
|
1661
1658
|
# `nextToken` response field.
|
1662
1659
|
#
|
1660
|
+
# @option params [Integer] :max_results
|
1661
|
+
# Maximum number of streams to return. Default: 100.
|
1662
|
+
#
|
1663
1663
|
# @return [Types::ListStreamSessionsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1664
1664
|
#
|
1665
|
-
# * {Types::ListStreamSessionsResponse#next_token #next_token} => String
|
1666
1665
|
# * {Types::ListStreamSessionsResponse#stream_sessions #stream_sessions} => Array<Types::StreamSessionSummary>
|
1666
|
+
# * {Types::ListStreamSessionsResponse#next_token #next_token} => String
|
1667
1667
|
#
|
1668
1668
|
# The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
|
1669
1669
|
#
|
@@ -1671,18 +1671,18 @@ module Aws::IVS
|
|
1671
1671
|
#
|
1672
1672
|
# resp = client.list_stream_sessions({
|
1673
1673
|
# channel_arn: "ChannelArn", # required
|
1674
|
-
# max_results: 1,
|
1675
1674
|
# next_token: "PaginationToken",
|
1675
|
+
# max_results: 1,
|
1676
1676
|
# })
|
1677
1677
|
#
|
1678
1678
|
# @example Response structure
|
1679
1679
|
#
|
1680
|
-
# resp.next_token #=> String
|
1681
1680
|
# resp.stream_sessions #=> Array
|
1681
|
+
# resp.stream_sessions[0].stream_id #=> String
|
1682
|
+
# resp.stream_sessions[0].start_time #=> Time
|
1682
1683
|
# resp.stream_sessions[0].end_time #=> Time
|
1683
1684
|
# resp.stream_sessions[0].has_error_event #=> Boolean
|
1684
|
-
# resp.
|
1685
|
-
# resp.stream_sessions[0].stream_id #=> String
|
1685
|
+
# resp.next_token #=> String
|
1686
1686
|
#
|
1687
1687
|
# @see http://docs.aws.amazon.com/goto/WebAPI/ivs-2020-07-14/ListStreamSessions AWS API Documentation
|
1688
1688
|
#
|
@@ -1699,17 +1699,17 @@ module Aws::IVS
|
|
1699
1699
|
# @option params [Types::StreamFilters] :filter_by
|
1700
1700
|
# Filters the stream list to match the specified criterion.
|
1701
1701
|
#
|
1702
|
-
# @option params [Integer] :max_results
|
1703
|
-
# Maximum number of streams to return. Default: 100.
|
1704
|
-
#
|
1705
1702
|
# @option params [String] :next_token
|
1706
1703
|
# The first stream to retrieve. This is used for pagination; see the
|
1707
1704
|
# `nextToken` response field.
|
1708
1705
|
#
|
1706
|
+
# @option params [Integer] :max_results
|
1707
|
+
# Maximum number of streams to return. Default: 100.
|
1708
|
+
#
|
1709
1709
|
# @return [Types::ListStreamsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1710
1710
|
#
|
1711
|
-
# * {Types::ListStreamsResponse#next_token #next_token} => String
|
1712
1711
|
# * {Types::ListStreamsResponse#streams #streams} => Array<Types::StreamSummary>
|
1712
|
+
# * {Types::ListStreamsResponse#next_token #next_token} => String
|
1713
1713
|
#
|
1714
1714
|
# The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
|
1715
1715
|
#
|
@@ -1719,20 +1719,20 @@ module Aws::IVS
|
|
1719
1719
|
# filter_by: {
|
1720
1720
|
# health: "HEALTHY", # accepts HEALTHY, STARVING, UNKNOWN
|
1721
1721
|
# },
|
1722
|
-
# max_results: 1,
|
1723
1722
|
# next_token: "PaginationToken",
|
1723
|
+
# max_results: 1,
|
1724
1724
|
# })
|
1725
1725
|
#
|
1726
1726
|
# @example Response structure
|
1727
1727
|
#
|
1728
|
-
# resp.next_token #=> String
|
1729
1728
|
# resp.streams #=> Array
|
1730
1729
|
# resp.streams[0].channel_arn #=> String
|
1731
|
-
# resp.streams[0].health #=> String, one of "HEALTHY", "STARVING", "UNKNOWN"
|
1732
|
-
# resp.streams[0].start_time #=> Time
|
1733
|
-
# resp.streams[0].state #=> String, one of "LIVE", "OFFLINE"
|
1734
1730
|
# resp.streams[0].stream_id #=> String
|
1731
|
+
# resp.streams[0].state #=> String, one of "LIVE", "OFFLINE"
|
1732
|
+
# resp.streams[0].health #=> String, one of "HEALTHY", "STARVING", "UNKNOWN"
|
1735
1733
|
# resp.streams[0].viewer_count #=> Integer
|
1734
|
+
# resp.streams[0].start_time #=> Time
|
1735
|
+
# resp.next_token #=> String
|
1736
1736
|
#
|
1737
1737
|
# @see http://docs.aws.amazon.com/goto/WebAPI/ivs-2020-07-14/ListStreams AWS API Documentation
|
1738
1738
|
#
|
@@ -1960,46 +1960,46 @@ module Aws::IVS
|
|
1960
1960
|
# @option params [required, String] :arn
|
1961
1961
|
# ARN of the channel to be updated.
|
1962
1962
|
#
|
1963
|
-
# @option params [
|
1964
|
-
#
|
1965
|
-
#
|
1966
|
-
# @option params [Boolean] :insecure_ingest
|
1967
|
-
# Whether the channel allows insecure RTMP and SRT ingest. Default:
|
1968
|
-
# `false`.
|
1963
|
+
# @option params [String] :name
|
1964
|
+
# Channel name.
|
1969
1965
|
#
|
1970
1966
|
# @option params [String] :latency_mode
|
1971
1967
|
# Channel latency mode. Use `NORMAL` to broadcast and deliver live video
|
1972
1968
|
# up to Full HD. Use `LOW` for near-real-time interaction with viewers.
|
1973
1969
|
#
|
1974
|
-
# @option params [String] :
|
1975
|
-
# Channel
|
1970
|
+
# @option params [String] :type
|
1971
|
+
# Channel type, which determines the allowable resolution and bitrate.
|
1972
|
+
# *If you exceed the allowable input resolution or bitrate, the stream
|
1973
|
+
# probably will disconnect immediately.* Default: `STANDARD`. For
|
1974
|
+
# details, see [Channel Types][1].
|
1976
1975
|
#
|
1977
|
-
# @option params [String] :playback_restriction_policy_arn
|
1978
|
-
# Playback-restriction-policy ARN. A valid ARN value here both specifies
|
1979
|
-
# the ARN and enables playback restriction. If this is set to an empty
|
1980
|
-
# string, playback restriction policy is disabled.
|
1981
1976
|
#
|
1982
|
-
#
|
1983
|
-
#
|
1984
|
-
#
|
1985
|
-
#
|
1986
|
-
#
|
1987
|
-
# (`""`).
|
1977
|
+
#
|
1978
|
+
# [1]: https://docs.aws.amazon.com/ivs/latest/LowLatencyAPIReference/channel-types.html
|
1979
|
+
#
|
1980
|
+
# @option params [Boolean] :authorized
|
1981
|
+
# Whether the channel is private (enabled for playback authorization).
|
1988
1982
|
#
|
1989
1983
|
# @option params [String] :recording_configuration_arn
|
1990
1984
|
# Recording-configuration ARN. A valid ARN value here both specifies the
|
1991
1985
|
# ARN and enables recording. If this is set to an empty string,
|
1992
1986
|
# recording is disabled.
|
1993
1987
|
#
|
1994
|
-
# @option params [
|
1995
|
-
#
|
1996
|
-
#
|
1997
|
-
# probably will disconnect immediately.* Default: `STANDARD`. For
|
1998
|
-
# details, see [Channel Types][1].
|
1999
|
-
#
|
1988
|
+
# @option params [Boolean] :insecure_ingest
|
1989
|
+
# Whether the channel allows insecure RTMP and SRT ingest. Default:
|
1990
|
+
# `false`.
|
2000
1991
|
#
|
1992
|
+
# @option params [String] :preset
|
1993
|
+
# Optional transcode preset for the channel. This is selectable only for
|
1994
|
+
# `ADVANCED_HD` and `ADVANCED_SD` channel types. For those channel
|
1995
|
+
# types, the default `preset` is `HIGHER_BANDWIDTH_DELIVERY`. For other
|
1996
|
+
# channel types (`BASIC` and `STANDARD`), `preset` is the empty string
|
1997
|
+
# (`""`).
|
2001
1998
|
#
|
2002
|
-
#
|
1999
|
+
# @option params [String] :playback_restriction_policy_arn
|
2000
|
+
# Playback-restriction-policy ARN. A valid ARN value here both specifies
|
2001
|
+
# the ARN and enables playback restriction. If this is set to an empty
|
2002
|
+
# string, playback restriction policy is disabled.
|
2003
2003
|
#
|
2004
2004
|
# @return [Types::UpdateChannelResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
2005
2005
|
#
|
@@ -2009,33 +2009,33 @@ module Aws::IVS
|
|
2009
2009
|
#
|
2010
2010
|
# resp = client.update_channel({
|
2011
2011
|
# arn: "ChannelArn", # required
|
2012
|
+
# name: "ChannelName",
|
2013
|
+
# latency_mode: "NORMAL", # accepts NORMAL, LOW
|
2014
|
+
# type: "BASIC", # accepts BASIC, STANDARD, ADVANCED_SD, ADVANCED_HD
|
2012
2015
|
# authorized: false,
|
2016
|
+
# recording_configuration_arn: "ChannelRecordingConfigurationArn",
|
2013
2017
|
# insecure_ingest: false,
|
2014
|
-
# latency_mode: "NORMAL", # accepts NORMAL, LOW
|
2015
|
-
# name: "ChannelName",
|
2016
|
-
# playback_restriction_policy_arn: "ChannelPlaybackRestrictionPolicyArn",
|
2017
2018
|
# preset: "HIGHER_BANDWIDTH_DELIVERY", # accepts HIGHER_BANDWIDTH_DELIVERY, CONSTRAINED_BANDWIDTH_DELIVERY
|
2018
|
-
#
|
2019
|
-
# type: "BASIC", # accepts BASIC, STANDARD, ADVANCED_SD, ADVANCED_HD
|
2019
|
+
# playback_restriction_policy_arn: "ChannelPlaybackRestrictionPolicyArn",
|
2020
2020
|
# })
|
2021
2021
|
#
|
2022
2022
|
# @example Response structure
|
2023
2023
|
#
|
2024
2024
|
# resp.channel.arn #=> String
|
2025
|
-
# resp.channel.authorized #=> Boolean
|
2026
|
-
# resp.channel.ingest_endpoint #=> String
|
2027
|
-
# resp.channel.insecure_ingest #=> Boolean
|
2028
|
-
# resp.channel.latency_mode #=> String, one of "NORMAL", "LOW"
|
2029
2025
|
# resp.channel.name #=> String
|
2030
|
-
# resp.channel.
|
2026
|
+
# resp.channel.latency_mode #=> String, one of "NORMAL", "LOW"
|
2027
|
+
# resp.channel.type #=> String, one of "BASIC", "STANDARD", "ADVANCED_SD", "ADVANCED_HD"
|
2028
|
+
# resp.channel.recording_configuration_arn #=> String
|
2029
|
+
# resp.channel.ingest_endpoint #=> String
|
2031
2030
|
# resp.channel.playback_url #=> String
|
2031
|
+
# resp.channel.authorized #=> Boolean
|
2032
|
+
# resp.channel.tags #=> Hash
|
2033
|
+
# resp.channel.tags["TagKey"] #=> String
|
2034
|
+
# resp.channel.insecure_ingest #=> Boolean
|
2032
2035
|
# resp.channel.preset #=> String, one of "HIGHER_BANDWIDTH_DELIVERY", "CONSTRAINED_BANDWIDTH_DELIVERY"
|
2033
|
-
# resp.channel.recording_configuration_arn #=> String
|
2034
2036
|
# resp.channel.srt.endpoint #=> String
|
2035
2037
|
# resp.channel.srt.passphrase #=> String
|
2036
|
-
# resp.channel.
|
2037
|
-
# resp.channel.tags["TagKey"] #=> String
|
2038
|
-
# resp.channel.type #=> String, one of "BASIC", "STANDARD", "ADVANCED_SD", "ADVANCED_HD"
|
2038
|
+
# resp.channel.playback_restriction_policy_arn #=> String
|
2039
2039
|
#
|
2040
2040
|
# @see http://docs.aws.amazon.com/goto/WebAPI/ivs-2020-07-14/UpdateChannel AWS API Documentation
|
2041
2041
|
#
|
@@ -2048,6 +2048,9 @@ module Aws::IVS
|
|
2048
2048
|
|
2049
2049
|
# Updates a specified playback restriction policy.
|
2050
2050
|
#
|
2051
|
+
# @option params [required, String] :arn
|
2052
|
+
# ARN of the playback-restriction-policy to be updated.
|
2053
|
+
#
|
2051
2054
|
# @option params [Array<String>] :allowed_countries
|
2052
2055
|
# A list of country codes that control geoblocking restriction. Allowed
|
2053
2056
|
# values are the officially assigned [ISO 3166-1 alpha-2][1] codes.
|
@@ -2067,9 +2070,6 @@ module Aws::IVS
|
|
2067
2070
|
#
|
2068
2071
|
# [1]: https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Origin
|
2069
2072
|
#
|
2070
|
-
# @option params [required, String] :arn
|
2071
|
-
# ARN of the playback-restriction-policy to be updated.
|
2072
|
-
#
|
2073
2073
|
# @option params [Boolean] :enable_strict_origin_enforcement
|
2074
2074
|
# Whether channel playback is constrained by origin site. Default:
|
2075
2075
|
# `false`.
|
@@ -2085,20 +2085,20 @@ module Aws::IVS
|
|
2085
2085
|
# @example Request syntax with placeholder values
|
2086
2086
|
#
|
2087
2087
|
# resp = client.update_playback_restriction_policy({
|
2088
|
+
# arn: "PlaybackRestrictionPolicyArn", # required
|
2088
2089
|
# allowed_countries: ["PlaybackRestrictionPolicyAllowedCountry"],
|
2089
2090
|
# allowed_origins: ["PlaybackRestrictionPolicyAllowedOrigin"],
|
2090
|
-
# arn: "PlaybackRestrictionPolicyArn", # required
|
2091
2091
|
# enable_strict_origin_enforcement: false,
|
2092
2092
|
# name: "PlaybackRestrictionPolicyName",
|
2093
2093
|
# })
|
2094
2094
|
#
|
2095
2095
|
# @example Response structure
|
2096
2096
|
#
|
2097
|
+
# resp.playback_restriction_policy.arn #=> String
|
2097
2098
|
# resp.playback_restriction_policy.allowed_countries #=> Array
|
2098
2099
|
# resp.playback_restriction_policy.allowed_countries[0] #=> String
|
2099
2100
|
# resp.playback_restriction_policy.allowed_origins #=> Array
|
2100
2101
|
# resp.playback_restriction_policy.allowed_origins[0] #=> String
|
2101
|
-
# resp.playback_restriction_policy.arn #=> String
|
2102
2102
|
# resp.playback_restriction_policy.enable_strict_origin_enforcement #=> Boolean
|
2103
2103
|
# resp.playback_restriction_policy.name #=> String
|
2104
2104
|
# resp.playback_restriction_policy.tags #=> Hash
|
@@ -2126,7 +2126,7 @@ module Aws::IVS
|
|
2126
2126
|
params: params,
|
2127
2127
|
config: config)
|
2128
2128
|
context[:gem_name] = 'aws-sdk-ivs'
|
2129
|
-
context[:gem_version] = '1.
|
2129
|
+
context[:gem_version] = '1.53.0'
|
2130
2130
|
Seahorse::Client::Request.new(handlers, context)
|
2131
2131
|
end
|
2132
2132
|
|