aws-sdk-ivs 1.51.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 +10 -0
- data/VERSION +1 -1
- data/lib/aws-sdk-ivs/client.rb +247 -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 +44 -43
- data/sig/resource.rbs +1 -0
- data/sig/types.rbs +70 -70
- metadata +6 -6
data/lib/aws-sdk-ivs/client.rb
CHANGED
@@ -312,6 +312,15 @@ module Aws::IVS
|
|
312
312
|
#
|
313
313
|
# @option options [String] :session_token
|
314
314
|
#
|
315
|
+
# @option options [Array] :sigv4a_signing_region_set
|
316
|
+
# A list of regions that should be signed with SigV4a signing. When
|
317
|
+
# not passed, a default `:sigv4a_signing_region_set` is searched for
|
318
|
+
# in the following locations:
|
319
|
+
#
|
320
|
+
# * `Aws.config[:sigv4a_signing_region_set]`
|
321
|
+
# * `ENV['AWS_SIGV4A_SIGNING_REGION_SET']`
|
322
|
+
# * `~/.aws/config`
|
323
|
+
#
|
315
324
|
# @option options [Boolean] :stub_responses (false)
|
316
325
|
# Causes the client to return stubbed responses. By default
|
317
326
|
# fake responses are generated and returned. You can specify
|
@@ -436,20 +445,20 @@ module Aws::IVS
|
|
436
445
|
#
|
437
446
|
# resp.channels #=> Array
|
438
447
|
# resp.channels[0].arn #=> String
|
439
|
-
# resp.channels[0].authorized #=> Boolean
|
440
|
-
# resp.channels[0].ingest_endpoint #=> String
|
441
|
-
# resp.channels[0].insecure_ingest #=> Boolean
|
442
|
-
# resp.channels[0].latency_mode #=> String, one of "NORMAL", "LOW"
|
443
448
|
# resp.channels[0].name #=> String
|
444
|
-
# 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
|
445
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
|
446
458
|
# resp.channels[0].preset #=> String, one of "HIGHER_BANDWIDTH_DELIVERY", "CONSTRAINED_BANDWIDTH_DELIVERY"
|
447
|
-
# resp.channels[0].recording_configuration_arn #=> String
|
448
459
|
# resp.channels[0].srt.endpoint #=> String
|
449
460
|
# resp.channels[0].srt.passphrase #=> String
|
450
|
-
# resp.channels[0].
|
451
|
-
# resp.channels[0].tags["TagKey"] #=> String
|
452
|
-
# resp.channels[0].type #=> String, one of "BASIC", "STANDARD", "ADVANCED_SD", "ADVANCED_HD"
|
461
|
+
# resp.channels[0].playback_restriction_policy_arn #=> String
|
453
462
|
# resp.errors #=> Array
|
454
463
|
# resp.errors[0].arn #=> String
|
455
464
|
# resp.errors[0].code #=> String
|
@@ -471,8 +480,8 @@ module Aws::IVS
|
|
471
480
|
#
|
472
481
|
# @return [Types::BatchGetStreamKeyResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
473
482
|
#
|
474
|
-
# * {Types::BatchGetStreamKeyResponse#errors #errors} => Array<Types::BatchError>
|
475
483
|
# * {Types::BatchGetStreamKeyResponse#stream_keys #stream_keys} => Array<Types::StreamKey>
|
484
|
+
# * {Types::BatchGetStreamKeyResponse#errors #errors} => Array<Types::BatchError>
|
476
485
|
#
|
477
486
|
# @example Request syntax with placeholder values
|
478
487
|
#
|
@@ -482,16 +491,16 @@ module Aws::IVS
|
|
482
491
|
#
|
483
492
|
# @example Response structure
|
484
493
|
#
|
485
|
-
# resp.errors #=> Array
|
486
|
-
# resp.errors[0].arn #=> String
|
487
|
-
# resp.errors[0].code #=> String
|
488
|
-
# resp.errors[0].message #=> String
|
489
494
|
# resp.stream_keys #=> Array
|
490
495
|
# resp.stream_keys[0].arn #=> String
|
496
|
+
# resp.stream_keys[0].value #=> String
|
491
497
|
# resp.stream_keys[0].channel_arn #=> String
|
492
498
|
# resp.stream_keys[0].tags #=> Hash
|
493
499
|
# resp.stream_keys[0].tags["TagKey"] #=> String
|
494
|
-
# resp.
|
500
|
+
# resp.errors #=> Array
|
501
|
+
# resp.errors[0].arn #=> String
|
502
|
+
# resp.errors[0].code #=> String
|
503
|
+
# resp.errors[0].message #=> String
|
495
504
|
#
|
496
505
|
# @see http://docs.aws.amazon.com/goto/WebAPI/ivs-2020-07-14/BatchGetStreamKey AWS API Documentation
|
497
506
|
#
|
@@ -528,9 +537,9 @@ module Aws::IVS
|
|
528
537
|
#
|
529
538
|
# resp.errors #=> Array
|
530
539
|
# resp.errors[0].channel_arn #=> String
|
540
|
+
# resp.errors[0].viewer_id #=> String
|
531
541
|
# resp.errors[0].code #=> String
|
532
542
|
# resp.errors[0].message #=> String
|
533
|
-
# resp.errors[0].viewer_id #=> String
|
534
543
|
#
|
535
544
|
# @see http://docs.aws.amazon.com/goto/WebAPI/ivs-2020-07-14/BatchStartViewerSessionRevocation AWS API Documentation
|
536
545
|
#
|
@@ -543,33 +552,27 @@ module Aws::IVS
|
|
543
552
|
|
544
553
|
# Creates a new channel and an associated stream key to start streaming.
|
545
554
|
#
|
546
|
-
# @option params [
|
547
|
-
#
|
548
|
-
# Default: `false`.
|
549
|
-
#
|
550
|
-
# @option params [Boolean] :insecure_ingest
|
551
|
-
# Whether the channel allows insecure RTMP and SRT ingest. Default:
|
552
|
-
# `false`.
|
555
|
+
# @option params [String] :name
|
556
|
+
# Channel name.
|
553
557
|
#
|
554
558
|
# @option params [String] :latency_mode
|
555
559
|
# Channel latency mode. Use `NORMAL` to broadcast and deliver live video
|
556
560
|
# up to Full HD. Use `LOW` for near-real-time interaction with viewers.
|
557
561
|
# Default: `LOW`.
|
558
562
|
#
|
559
|
-
# @option params [String] :
|
560
|
-
# 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].
|
561
568
|
#
|
562
|
-
# @option params [String] :playback_restriction_policy_arn
|
563
|
-
# Playback-restriction-policy ARN. A valid ARN value here both specifies
|
564
|
-
# the ARN and enables playback restriction. Default: "" (empty string,
|
565
|
-
# no playback restriction policy is applied).
|
566
569
|
#
|
567
|
-
#
|
568
|
-
#
|
569
|
-
#
|
570
|
-
#
|
571
|
-
#
|
572
|
-
#
|
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`.
|
573
576
|
#
|
574
577
|
# @option params [String] :recording_configuration_arn
|
575
578
|
# Recording-configuration ARN. A valid ARN value here both specifies the
|
@@ -587,15 +590,21 @@ module Aws::IVS
|
|
587
590
|
#
|
588
591
|
# [1]: https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html
|
589
592
|
#
|
590
|
-
# @option params [
|
591
|
-
#
|
592
|
-
#
|
593
|
-
# probably will disconnect immediately.* Default: `STANDARD`. For
|
594
|
-
# details, see [Channel Types][1].
|
595
|
-
#
|
593
|
+
# @option params [Boolean] :insecure_ingest
|
594
|
+
# Whether the channel allows insecure RTMP and SRT ingest. Default:
|
595
|
+
# `false`.
|
596
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
|
+
# (`""`).
|
597
603
|
#
|
598
|
-
#
|
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).
|
599
608
|
#
|
600
609
|
# @return [Types::CreateChannelResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
601
610
|
#
|
@@ -605,41 +614,41 @@ module Aws::IVS
|
|
605
614
|
# @example Request syntax with placeholder values
|
606
615
|
#
|
607
616
|
# resp = client.create_channel({
|
608
|
-
# authorized: false,
|
609
|
-
# insecure_ingest: false,
|
610
|
-
# latency_mode: "NORMAL", # accepts NORMAL, LOW
|
611
617
|
# name: "ChannelName",
|
612
|
-
#
|
613
|
-
#
|
618
|
+
# latency_mode: "NORMAL", # accepts NORMAL, LOW
|
619
|
+
# type: "BASIC", # accepts BASIC, STANDARD, ADVANCED_SD, ADVANCED_HD
|
620
|
+
# authorized: false,
|
614
621
|
# recording_configuration_arn: "ChannelRecordingConfigurationArn",
|
615
622
|
# tags: {
|
616
623
|
# "TagKey" => "TagValue",
|
617
624
|
# },
|
618
|
-
#
|
625
|
+
# insecure_ingest: false,
|
626
|
+
# preset: "HIGHER_BANDWIDTH_DELIVERY", # accepts HIGHER_BANDWIDTH_DELIVERY, CONSTRAINED_BANDWIDTH_DELIVERY
|
627
|
+
# playback_restriction_policy_arn: "ChannelPlaybackRestrictionPolicyArn",
|
619
628
|
# })
|
620
629
|
#
|
621
630
|
# @example Response structure
|
622
631
|
#
|
623
632
|
# resp.channel.arn #=> String
|
624
|
-
# resp.channel.authorized #=> Boolean
|
625
|
-
# resp.channel.ingest_endpoint #=> String
|
626
|
-
# resp.channel.insecure_ingest #=> Boolean
|
627
|
-
# resp.channel.latency_mode #=> String, one of "NORMAL", "LOW"
|
628
633
|
# resp.channel.name #=> String
|
629
|
-
# 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
|
630
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
|
631
643
|
# resp.channel.preset #=> String, one of "HIGHER_BANDWIDTH_DELIVERY", "CONSTRAINED_BANDWIDTH_DELIVERY"
|
632
|
-
# resp.channel.recording_configuration_arn #=> String
|
633
644
|
# resp.channel.srt.endpoint #=> String
|
634
645
|
# resp.channel.srt.passphrase #=> String
|
635
|
-
# resp.channel.
|
636
|
-
# resp.channel.tags["TagKey"] #=> String
|
637
|
-
# resp.channel.type #=> String, one of "BASIC", "STANDARD", "ADVANCED_SD", "ADVANCED_HD"
|
646
|
+
# resp.channel.playback_restriction_policy_arn #=> String
|
638
647
|
# resp.stream_key.arn #=> String
|
648
|
+
# resp.stream_key.value #=> String
|
639
649
|
# resp.stream_key.channel_arn #=> String
|
640
650
|
# resp.stream_key.tags #=> Hash
|
641
651
|
# resp.stream_key.tags["TagKey"] #=> String
|
642
|
-
# resp.stream_key.value #=> String
|
643
652
|
#
|
644
653
|
# @see http://docs.aws.amazon.com/goto/WebAPI/ivs-2020-07-14/CreateChannel AWS API Documentation
|
645
654
|
#
|
@@ -709,11 +718,11 @@ module Aws::IVS
|
|
709
718
|
#
|
710
719
|
# @example Response structure
|
711
720
|
#
|
721
|
+
# resp.playback_restriction_policy.arn #=> String
|
712
722
|
# resp.playback_restriction_policy.allowed_countries #=> Array
|
713
723
|
# resp.playback_restriction_policy.allowed_countries[0] #=> String
|
714
724
|
# resp.playback_restriction_policy.allowed_origins #=> Array
|
715
725
|
# resp.playback_restriction_policy.allowed_origins[0] #=> String
|
716
|
-
# resp.playback_restriction_policy.arn #=> String
|
717
726
|
# resp.playback_restriction_policy.enable_strict_origin_enforcement #=> Boolean
|
718
727
|
# resp.playback_restriction_policy.name #=> String
|
719
728
|
# resp.playback_restriction_policy.tags #=> Hash
|
@@ -744,21 +753,12 @@ module Aws::IVS
|
|
744
753
|
# configuration and create a new one with an S3 bucket from the correct
|
745
754
|
# region.
|
746
755
|
#
|
747
|
-
# @option params [required, Types::DestinationConfiguration] :destination_configuration
|
748
|
-
# A complex type that contains a destination configuration for where
|
749
|
-
# recorded video will be stored.
|
750
|
-
#
|
751
756
|
# @option params [String] :name
|
752
757
|
# Recording-configuration name. The value does not need to be unique.
|
753
758
|
#
|
754
|
-
# @option params [
|
755
|
-
#
|
756
|
-
#
|
757
|
-
# and merged together. Default: 0.
|
758
|
-
#
|
759
|
-
# @option params [Types::RenditionConfiguration] :rendition_configuration
|
760
|
-
# Object that describes which renditions should be recorded for a
|
761
|
-
# 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.
|
762
762
|
#
|
763
763
|
# @option params [Hash<String,String>] :tags
|
764
764
|
# Array of 1-50 maps, each of the form `string:string (key:value)`. See
|
@@ -776,6 +776,15 @@ module Aws::IVS
|
|
776
776
|
# thumbnails for a live session and modify the interval at which
|
777
777
|
# thumbnails are generated for the live session.
|
778
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
|
+
#
|
779
788
|
# @return [Types::CreateRecordingConfigurationResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
780
789
|
#
|
781
790
|
# * {Types::CreateRecordingConfigurationResponse#recording_configuration #recording_configuration} => Types::RecordingConfiguration
|
@@ -783,45 +792,45 @@ module Aws::IVS
|
|
783
792
|
# @example Request syntax with placeholder values
|
784
793
|
#
|
785
794
|
# resp = client.create_recording_configuration({
|
795
|
+
# name: "RecordingConfigurationName",
|
786
796
|
# destination_configuration: { # required
|
787
797
|
# s3: {
|
788
798
|
# bucket_name: "S3DestinationBucketName", # required
|
789
799
|
# },
|
790
800
|
# },
|
791
|
-
# name: "RecordingConfigurationName",
|
792
|
-
# recording_reconnect_window_seconds: 1,
|
793
|
-
# rendition_configuration: {
|
794
|
-
# rendition_selection: "ALL", # accepts ALL, NONE, CUSTOM
|
795
|
-
# renditions: ["FULL_HD"], # accepts FULL_HD, HD, SD, LOWEST_RESOLUTION
|
796
|
-
# },
|
797
801
|
# tags: {
|
798
802
|
# "TagKey" => "TagValue",
|
799
803
|
# },
|
800
804
|
# thumbnail_configuration: {
|
801
805
|
# recording_mode: "DISABLED", # accepts DISABLED, INTERVAL
|
802
|
-
# resolution: "FULL_HD", # accepts FULL_HD, HD, SD, LOWEST_RESOLUTION
|
803
|
-
# storage: ["SEQUENTIAL"], # accepts SEQUENTIAL, LATEST
|
804
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
|
805
814
|
# },
|
806
815
|
# })
|
807
816
|
#
|
808
817
|
# @example Response structure
|
809
818
|
#
|
810
819
|
# resp.recording_configuration.arn #=> String
|
811
|
-
# resp.recording_configuration.destination_configuration.s3.bucket_name #=> String
|
812
820
|
# resp.recording_configuration.name #=> String
|
813
|
-
# resp.recording_configuration.
|
814
|
-
# resp.recording_configuration.rendition_configuration.rendition_selection #=> String, one of "ALL", "NONE", "CUSTOM"
|
815
|
-
# resp.recording_configuration.rendition_configuration.renditions #=> Array
|
816
|
-
# 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
|
817
822
|
# resp.recording_configuration.state #=> String, one of "CREATING", "CREATE_FAILED", "ACTIVE"
|
818
823
|
# resp.recording_configuration.tags #=> Hash
|
819
824
|
# resp.recording_configuration.tags["TagKey"] #=> String
|
820
825
|
# resp.recording_configuration.thumbnail_configuration.recording_mode #=> String, one of "DISABLED", "INTERVAL"
|
821
|
-
# 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"
|
822
828
|
# resp.recording_configuration.thumbnail_configuration.storage #=> Array
|
823
829
|
# resp.recording_configuration.thumbnail_configuration.storage[0] #=> String, one of "SEQUENTIAL", "LATEST"
|
824
|
-
# 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"
|
825
834
|
#
|
826
835
|
# @see http://docs.aws.amazon.com/goto/WebAPI/ivs-2020-07-14/CreateRecordingConfiguration AWS API Documentation
|
827
836
|
#
|
@@ -871,10 +880,10 @@ module Aws::IVS
|
|
871
880
|
# @example Response structure
|
872
881
|
#
|
873
882
|
# resp.stream_key.arn #=> String
|
883
|
+
# resp.stream_key.value #=> String
|
874
884
|
# resp.stream_key.channel_arn #=> String
|
875
885
|
# resp.stream_key.tags #=> Hash
|
876
886
|
# resp.stream_key.tags["TagKey"] #=> String
|
877
|
-
# resp.stream_key.value #=> String
|
878
887
|
#
|
879
888
|
# @see http://docs.aws.amazon.com/goto/WebAPI/ivs-2020-07-14/CreateStreamKey AWS API Documentation
|
880
889
|
#
|
@@ -1038,20 +1047,20 @@ module Aws::IVS
|
|
1038
1047
|
# @example Response structure
|
1039
1048
|
#
|
1040
1049
|
# resp.channel.arn #=> String
|
1041
|
-
# resp.channel.authorized #=> Boolean
|
1042
|
-
# resp.channel.ingest_endpoint #=> String
|
1043
|
-
# resp.channel.insecure_ingest #=> Boolean
|
1044
|
-
# resp.channel.latency_mode #=> String, one of "NORMAL", "LOW"
|
1045
1050
|
# resp.channel.name #=> String
|
1046
|
-
# 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
|
1047
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
|
1048
1060
|
# resp.channel.preset #=> String, one of "HIGHER_BANDWIDTH_DELIVERY", "CONSTRAINED_BANDWIDTH_DELIVERY"
|
1049
|
-
# resp.channel.recording_configuration_arn #=> String
|
1050
1061
|
# resp.channel.srt.endpoint #=> String
|
1051
1062
|
# resp.channel.srt.passphrase #=> String
|
1052
|
-
# resp.channel.
|
1053
|
-
# resp.channel.tags["TagKey"] #=> String
|
1054
|
-
# resp.channel.type #=> String, one of "BASIC", "STANDARD", "ADVANCED_SD", "ADVANCED_HD"
|
1063
|
+
# resp.channel.playback_restriction_policy_arn #=> String
|
1055
1064
|
#
|
1056
1065
|
# @see http://docs.aws.amazon.com/goto/WebAPI/ivs-2020-07-14/GetChannel AWS API Documentation
|
1057
1066
|
#
|
@@ -1088,8 +1097,8 @@ module Aws::IVS
|
|
1088
1097
|
# @example Response structure
|
1089
1098
|
#
|
1090
1099
|
# resp.key_pair.arn #=> String
|
1091
|
-
# resp.key_pair.fingerprint #=> String
|
1092
1100
|
# resp.key_pair.name #=> String
|
1101
|
+
# resp.key_pair.fingerprint #=> String
|
1093
1102
|
# resp.key_pair.tags #=> Hash
|
1094
1103
|
# resp.key_pair.tags["TagKey"] #=> String
|
1095
1104
|
#
|
@@ -1119,11 +1128,11 @@ module Aws::IVS
|
|
1119
1128
|
#
|
1120
1129
|
# @example Response structure
|
1121
1130
|
#
|
1131
|
+
# resp.playback_restriction_policy.arn #=> String
|
1122
1132
|
# resp.playback_restriction_policy.allowed_countries #=> Array
|
1123
1133
|
# resp.playback_restriction_policy.allowed_countries[0] #=> String
|
1124
1134
|
# resp.playback_restriction_policy.allowed_origins #=> Array
|
1125
1135
|
# resp.playback_restriction_policy.allowed_origins[0] #=> String
|
1126
|
-
# resp.playback_restriction_policy.arn #=> String
|
1127
1136
|
# resp.playback_restriction_policy.enable_strict_origin_enforcement #=> Boolean
|
1128
1137
|
# resp.playback_restriction_policy.name #=> String
|
1129
1138
|
# resp.playback_restriction_policy.tags #=> Hash
|
@@ -1156,20 +1165,20 @@ module Aws::IVS
|
|
1156
1165
|
# @example Response structure
|
1157
1166
|
#
|
1158
1167
|
# resp.recording_configuration.arn #=> String
|
1159
|
-
# resp.recording_configuration.destination_configuration.s3.bucket_name #=> String
|
1160
1168
|
# resp.recording_configuration.name #=> String
|
1161
|
-
# resp.recording_configuration.
|
1162
|
-
# resp.recording_configuration.rendition_configuration.rendition_selection #=> String, one of "ALL", "NONE", "CUSTOM"
|
1163
|
-
# resp.recording_configuration.rendition_configuration.renditions #=> Array
|
1164
|
-
# 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
|
1165
1170
|
# resp.recording_configuration.state #=> String, one of "CREATING", "CREATE_FAILED", "ACTIVE"
|
1166
1171
|
# resp.recording_configuration.tags #=> Hash
|
1167
1172
|
# resp.recording_configuration.tags["TagKey"] #=> String
|
1168
1173
|
# resp.recording_configuration.thumbnail_configuration.recording_mode #=> String, one of "DISABLED", "INTERVAL"
|
1169
|
-
# 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"
|
1170
1176
|
# resp.recording_configuration.thumbnail_configuration.storage #=> Array
|
1171
1177
|
# resp.recording_configuration.thumbnail_configuration.storage[0] #=> String, one of "SEQUENTIAL", "LATEST"
|
1172
|
-
# 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"
|
1173
1182
|
#
|
1174
1183
|
# @see http://docs.aws.amazon.com/goto/WebAPI/ivs-2020-07-14/GetRecordingConfiguration AWS API Documentation
|
1175
1184
|
#
|
@@ -1199,11 +1208,11 @@ module Aws::IVS
|
|
1199
1208
|
# @example Response structure
|
1200
1209
|
#
|
1201
1210
|
# resp.stream.channel_arn #=> String
|
1202
|
-
# resp.stream.
|
1211
|
+
# resp.stream.stream_id #=> String
|
1203
1212
|
# resp.stream.playback_url #=> String
|
1204
1213
|
# resp.stream.start_time #=> Time
|
1205
1214
|
# resp.stream.state #=> String, one of "LIVE", "OFFLINE"
|
1206
|
-
# resp.stream.
|
1215
|
+
# resp.stream.health #=> String, one of "HEALTHY", "STARVING", "UNKNOWN"
|
1207
1216
|
# resp.stream.viewer_count #=> Integer
|
1208
1217
|
#
|
1209
1218
|
# @see http://docs.aws.amazon.com/goto/WebAPI/ivs-2020-07-14/GetStream AWS API Documentation
|
@@ -1233,10 +1242,10 @@ module Aws::IVS
|
|
1233
1242
|
# @example Response structure
|
1234
1243
|
#
|
1235
1244
|
# resp.stream_key.arn #=> String
|
1245
|
+
# resp.stream_key.value #=> String
|
1236
1246
|
# resp.stream_key.channel_arn #=> String
|
1237
1247
|
# resp.stream_key.tags #=> Hash
|
1238
1248
|
# resp.stream_key.tags["TagKey"] #=> String
|
1239
|
-
# resp.stream_key.value #=> String
|
1240
1249
|
#
|
1241
1250
|
# @see http://docs.aws.amazon.com/goto/WebAPI/ivs-2020-07-14/GetStreamKey AWS API Documentation
|
1242
1251
|
#
|
@@ -1270,55 +1279,55 @@ module Aws::IVS
|
|
1270
1279
|
#
|
1271
1280
|
# @example Response structure
|
1272
1281
|
#
|
1282
|
+
# resp.stream_session.stream_id #=> String
|
1283
|
+
# resp.stream_session.start_time #=> Time
|
1284
|
+
# resp.stream_session.end_time #=> Time
|
1273
1285
|
# resp.stream_session.channel.arn #=> String
|
1274
|
-
# resp.stream_session.channel.authorized #=> Boolean
|
1275
|
-
# resp.stream_session.channel.ingest_endpoint #=> String
|
1276
|
-
# resp.stream_session.channel.insecure_ingest #=> Boolean
|
1277
|
-
# resp.stream_session.channel.latency_mode #=> String, one of "NORMAL", "LOW"
|
1278
1286
|
# resp.stream_session.channel.name #=> String
|
1279
|
-
# 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
|
1280
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
|
1281
1296
|
# resp.stream_session.channel.preset #=> String, one of "HIGHER_BANDWIDTH_DELIVERY", "CONSTRAINED_BANDWIDTH_DELIVERY"
|
1282
|
-
# resp.stream_session.channel.recording_configuration_arn #=> String
|
1283
1297
|
# resp.stream_session.channel.srt.endpoint #=> String
|
1284
1298
|
# resp.stream_session.channel.srt.passphrase #=> String
|
1285
|
-
# resp.stream_session.channel.
|
1286
|
-
# resp.stream_session.channel.tags["TagKey"] #=> String
|
1287
|
-
# resp.stream_session.channel.type #=> String, one of "BASIC", "STANDARD", "ADVANCED_SD", "ADVANCED_HD"
|
1288
|
-
# resp.stream_session.end_time #=> Time
|
1289
|
-
# resp.stream_session.ingest_configuration.audio.channels #=> Integer
|
1290
|
-
# resp.stream_session.ingest_configuration.audio.codec #=> String
|
1291
|
-
# resp.stream_session.ingest_configuration.audio.sample_rate #=> Integer
|
1292
|
-
# resp.stream_session.ingest_configuration.audio.target_bitrate #=> Integer
|
1293
|
-
# resp.stream_session.ingest_configuration.video.avc_level #=> String
|
1299
|
+
# resp.stream_session.channel.playback_restriction_policy_arn #=> String
|
1294
1300
|
# resp.stream_session.ingest_configuration.video.avc_profile #=> String
|
1301
|
+
# resp.stream_session.ingest_configuration.video.avc_level #=> String
|
1295
1302
|
# resp.stream_session.ingest_configuration.video.codec #=> String
|
1296
1303
|
# resp.stream_session.ingest_configuration.video.encoder #=> String
|
1297
1304
|
# resp.stream_session.ingest_configuration.video.target_bitrate #=> Integer
|
1298
1305
|
# resp.stream_session.ingest_configuration.video.target_framerate #=> Integer
|
1299
1306
|
# resp.stream_session.ingest_configuration.video.video_height #=> Integer
|
1300
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
|
1301
1312
|
# resp.stream_session.recording_configuration.arn #=> String
|
1302
|
-
# resp.stream_session.recording_configuration.destination_configuration.s3.bucket_name #=> String
|
1303
1313
|
# resp.stream_session.recording_configuration.name #=> String
|
1304
|
-
# resp.stream_session.recording_configuration.
|
1305
|
-
# resp.stream_session.recording_configuration.rendition_configuration.rendition_selection #=> String, one of "ALL", "NONE", "CUSTOM"
|
1306
|
-
# resp.stream_session.recording_configuration.rendition_configuration.renditions #=> Array
|
1307
|
-
# 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
|
1308
1315
|
# resp.stream_session.recording_configuration.state #=> String, one of "CREATING", "CREATE_FAILED", "ACTIVE"
|
1309
1316
|
# resp.stream_session.recording_configuration.tags #=> Hash
|
1310
1317
|
# resp.stream_session.recording_configuration.tags["TagKey"] #=> String
|
1311
1318
|
# resp.stream_session.recording_configuration.thumbnail_configuration.recording_mode #=> String, one of "DISABLED", "INTERVAL"
|
1312
|
-
# 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"
|
1313
1321
|
# resp.stream_session.recording_configuration.thumbnail_configuration.storage #=> Array
|
1314
1322
|
# resp.stream_session.recording_configuration.thumbnail_configuration.storage[0] #=> String, one of "SEQUENTIAL", "LATEST"
|
1315
|
-
# resp.stream_session.recording_configuration.
|
1316
|
-
# resp.stream_session.
|
1317
|
-
# 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"
|
1318
1327
|
# resp.stream_session.truncated_events #=> Array
|
1319
|
-
# resp.stream_session.truncated_events[0].event_time #=> Time
|
1320
1328
|
# resp.stream_session.truncated_events[0].name #=> String
|
1321
1329
|
# resp.stream_session.truncated_events[0].type #=> String
|
1330
|
+
# resp.stream_session.truncated_events[0].event_time #=> Time
|
1322
1331
|
#
|
1323
1332
|
# @see http://docs.aws.amazon.com/goto/WebAPI/ivs-2020-07-14/GetStreamSession AWS API Documentation
|
1324
1333
|
#
|
@@ -1339,12 +1348,12 @@ module Aws::IVS
|
|
1339
1348
|
#
|
1340
1349
|
# [1]: https://docs.aws.amazon.com/ivs/latest/userguide/private-channels.html
|
1341
1350
|
#
|
1342
|
-
# @option params [String] :name
|
1343
|
-
# Playback-key-pair name. The value does not need to be unique.
|
1344
|
-
#
|
1345
1351
|
# @option params [required, String] :public_key_material
|
1346
1352
|
# The public portion of a customer-generated key pair.
|
1347
1353
|
#
|
1354
|
+
# @option params [String] :name
|
1355
|
+
# Playback-key-pair name. The value does not need to be unique.
|
1356
|
+
#
|
1348
1357
|
# @option params [Hash<String,String>] :tags
|
1349
1358
|
# Any tags provided with the request are added to the playback key pair
|
1350
1359
|
# tags. See [Tagging Amazon Web Services Resources][1] for more
|
@@ -1363,8 +1372,8 @@ module Aws::IVS
|
|
1363
1372
|
# @example Request syntax with placeholder values
|
1364
1373
|
#
|
1365
1374
|
# resp = client.import_playback_key_pair({
|
1366
|
-
# name: "PlaybackKeyPairName",
|
1367
1375
|
# public_key_material: "PlaybackPublicKeyMaterial", # required
|
1376
|
+
# name: "PlaybackKeyPairName",
|
1368
1377
|
# tags: {
|
1369
1378
|
# "TagKey" => "TagValue",
|
1370
1379
|
# },
|
@@ -1373,8 +1382,8 @@ module Aws::IVS
|
|
1373
1382
|
# @example Response structure
|
1374
1383
|
#
|
1375
1384
|
# resp.key_pair.arn #=> String
|
1376
|
-
# resp.key_pair.fingerprint #=> String
|
1377
1385
|
# resp.key_pair.name #=> String
|
1386
|
+
# resp.key_pair.fingerprint #=> String
|
1378
1387
|
# resp.key_pair.tags #=> Hash
|
1379
1388
|
# resp.key_pair.tags["TagKey"] #=> String
|
1380
1389
|
#
|
@@ -1397,20 +1406,20 @@ module Aws::IVS
|
|
1397
1406
|
# @option params [String] :filter_by_name
|
1398
1407
|
# Filters the channel list to match the specified name.
|
1399
1408
|
#
|
1400
|
-
# @option params [String] :filter_by_playback_restriction_policy_arn
|
1401
|
-
# Filters the channel list to match the specified policy.
|
1402
|
-
#
|
1403
1409
|
# @option params [String] :filter_by_recording_configuration_arn
|
1404
1410
|
# Filters the channel list to match the specified
|
1405
1411
|
# recording-configuration ARN.
|
1406
1412
|
#
|
1407
|
-
# @option params [
|
1408
|
-
#
|
1413
|
+
# @option params [String] :filter_by_playback_restriction_policy_arn
|
1414
|
+
# Filters the channel list to match the specified policy.
|
1409
1415
|
#
|
1410
1416
|
# @option params [String] :next_token
|
1411
1417
|
# The first channel to retrieve. This is used for pagination; see the
|
1412
1418
|
# `nextToken` response field.
|
1413
1419
|
#
|
1420
|
+
# @option params [Integer] :max_results
|
1421
|
+
# Maximum number of channels to return. Default: 100.
|
1422
|
+
#
|
1414
1423
|
# @return [Types::ListChannelsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1415
1424
|
#
|
1416
1425
|
# * {Types::ListChannelsResponse#channels #channels} => Array<Types::ChannelSummary>
|
@@ -1422,26 +1431,26 @@ module Aws::IVS
|
|
1422
1431
|
#
|
1423
1432
|
# resp = client.list_channels({
|
1424
1433
|
# filter_by_name: "ChannelName",
|
1425
|
-
# filter_by_playback_restriction_policy_arn: "ChannelPlaybackRestrictionPolicyArn",
|
1426
1434
|
# filter_by_recording_configuration_arn: "ChannelRecordingConfigurationArn",
|
1427
|
-
#
|
1435
|
+
# filter_by_playback_restriction_policy_arn: "ChannelPlaybackRestrictionPolicyArn",
|
1428
1436
|
# next_token: "PaginationToken",
|
1437
|
+
# max_results: 1,
|
1429
1438
|
# })
|
1430
1439
|
#
|
1431
1440
|
# @example Response structure
|
1432
1441
|
#
|
1433
1442
|
# resp.channels #=> Array
|
1434
1443
|
# resp.channels[0].arn #=> String
|
1435
|
-
# resp.channels[0].authorized #=> Boolean
|
1436
|
-
# resp.channels[0].insecure_ingest #=> Boolean
|
1437
|
-
# resp.channels[0].latency_mode #=> String, one of "NORMAL", "LOW"
|
1438
1444
|
# resp.channels[0].name #=> String
|
1439
|
-
# resp.channels[0].
|
1440
|
-
# resp.channels[0].
|
1445
|
+
# resp.channels[0].latency_mode #=> String, one of "NORMAL", "LOW"
|
1446
|
+
# resp.channels[0].authorized #=> Boolean
|
1441
1447
|
# resp.channels[0].recording_configuration_arn #=> String
|
1442
1448
|
# resp.channels[0].tags #=> Hash
|
1443
1449
|
# resp.channels[0].tags["TagKey"] #=> String
|
1450
|
+
# resp.channels[0].insecure_ingest #=> Boolean
|
1444
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
|
1445
1454
|
# resp.next_token #=> String
|
1446
1455
|
#
|
1447
1456
|
# @see http://docs.aws.amazon.com/goto/WebAPI/ivs-2020-07-14/ListChannels AWS API Documentation
|
@@ -1461,14 +1470,14 @@ module Aws::IVS
|
|
1461
1470
|
#
|
1462
1471
|
# [1]: https://docs.aws.amazon.com/ivs/latest/userguide/private-channels.html
|
1463
1472
|
#
|
1464
|
-
# @option params [Integer] :max_results
|
1465
|
-
# Maximum number of key pairs to return. Default: your service quota or
|
1466
|
-
# 100, whichever is smaller.
|
1467
|
-
#
|
1468
1473
|
# @option params [String] :next_token
|
1469
1474
|
# The first key pair to retrieve. This is used for pagination; see the
|
1470
1475
|
# `nextToken` response field.
|
1471
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
|
+
#
|
1472
1481
|
# @return [Types::ListPlaybackKeyPairsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1473
1482
|
#
|
1474
1483
|
# * {Types::ListPlaybackKeyPairsResponse#key_pairs #key_pairs} => Array<Types::PlaybackKeyPairSummary>
|
@@ -1479,8 +1488,8 @@ module Aws::IVS
|
|
1479
1488
|
# @example Request syntax with placeholder values
|
1480
1489
|
#
|
1481
1490
|
# resp = client.list_playback_key_pairs({
|
1482
|
-
# max_results: 1,
|
1483
1491
|
# next_token: "PaginationToken",
|
1492
|
+
# max_results: 1,
|
1484
1493
|
# })
|
1485
1494
|
#
|
1486
1495
|
# @example Response structure
|
@@ -1503,40 +1512,40 @@ module Aws::IVS
|
|
1503
1512
|
|
1504
1513
|
# Gets summary information about playback restriction policies.
|
1505
1514
|
#
|
1506
|
-
# @option params [Integer] :max_results
|
1507
|
-
# Maximum number of policies to return. Default: 1.
|
1508
|
-
#
|
1509
1515
|
# @option params [String] :next_token
|
1510
1516
|
# The first policy to retrieve. This is used for pagination; see the
|
1511
1517
|
# `nextToken` response field.
|
1512
1518
|
#
|
1519
|
+
# @option params [Integer] :max_results
|
1520
|
+
# Maximum number of policies to return. Default: 1.
|
1521
|
+
#
|
1513
1522
|
# @return [Types::ListPlaybackRestrictionPoliciesResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1514
1523
|
#
|
1515
|
-
# * {Types::ListPlaybackRestrictionPoliciesResponse#next_token #next_token} => String
|
1516
1524
|
# * {Types::ListPlaybackRestrictionPoliciesResponse#playback_restriction_policies #playback_restriction_policies} => Array<Types::PlaybackRestrictionPolicySummary>
|
1525
|
+
# * {Types::ListPlaybackRestrictionPoliciesResponse#next_token #next_token} => String
|
1517
1526
|
#
|
1518
1527
|
# The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
|
1519
1528
|
#
|
1520
1529
|
# @example Request syntax with placeholder values
|
1521
1530
|
#
|
1522
1531
|
# resp = client.list_playback_restriction_policies({
|
1523
|
-
# max_results: 1,
|
1524
1532
|
# next_token: "PaginationToken",
|
1533
|
+
# max_results: 1,
|
1525
1534
|
# })
|
1526
1535
|
#
|
1527
1536
|
# @example Response structure
|
1528
1537
|
#
|
1529
|
-
# resp.next_token #=> String
|
1530
1538
|
# resp.playback_restriction_policies #=> Array
|
1539
|
+
# resp.playback_restriction_policies[0].arn #=> String
|
1531
1540
|
# resp.playback_restriction_policies[0].allowed_countries #=> Array
|
1532
1541
|
# resp.playback_restriction_policies[0].allowed_countries[0] #=> String
|
1533
1542
|
# resp.playback_restriction_policies[0].allowed_origins #=> Array
|
1534
1543
|
# resp.playback_restriction_policies[0].allowed_origins[0] #=> String
|
1535
|
-
# resp.playback_restriction_policies[0].arn #=> String
|
1536
1544
|
# resp.playback_restriction_policies[0].enable_strict_origin_enforcement #=> Boolean
|
1537
1545
|
# resp.playback_restriction_policies[0].name #=> String
|
1538
1546
|
# resp.playback_restriction_policies[0].tags #=> Hash
|
1539
1547
|
# resp.playback_restriction_policies[0].tags["TagKey"] #=> String
|
1548
|
+
# resp.next_token #=> String
|
1540
1549
|
#
|
1541
1550
|
# @see http://docs.aws.amazon.com/goto/WebAPI/ivs-2020-07-14/ListPlaybackRestrictionPolicies AWS API Documentation
|
1542
1551
|
#
|
@@ -1551,38 +1560,38 @@ module Aws::IVS
|
|
1551
1560
|
# account, in the Amazon Web Services region where the API request is
|
1552
1561
|
# processed.
|
1553
1562
|
#
|
1554
|
-
# @option params [Integer] :max_results
|
1555
|
-
# Maximum number of recording configurations to return. Default: your
|
1556
|
-
# service quota or 100, whichever is smaller.
|
1557
|
-
#
|
1558
1563
|
# @option params [String] :next_token
|
1559
1564
|
# The first recording configuration to retrieve. This is used for
|
1560
1565
|
# pagination; see the `nextToken` response field.
|
1561
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
|
+
#
|
1562
1571
|
# @return [Types::ListRecordingConfigurationsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1563
1572
|
#
|
1564
|
-
# * {Types::ListRecordingConfigurationsResponse#next_token #next_token} => String
|
1565
1573
|
# * {Types::ListRecordingConfigurationsResponse#recording_configurations #recording_configurations} => Array<Types::RecordingConfigurationSummary>
|
1574
|
+
# * {Types::ListRecordingConfigurationsResponse#next_token #next_token} => String
|
1566
1575
|
#
|
1567
1576
|
# The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
|
1568
1577
|
#
|
1569
1578
|
# @example Request syntax with placeholder values
|
1570
1579
|
#
|
1571
1580
|
# resp = client.list_recording_configurations({
|
1572
|
-
# max_results: 1,
|
1573
1581
|
# next_token: "PaginationToken",
|
1582
|
+
# max_results: 1,
|
1574
1583
|
# })
|
1575
1584
|
#
|
1576
1585
|
# @example Response structure
|
1577
1586
|
#
|
1578
|
-
# resp.next_token #=> String
|
1579
1587
|
# resp.recording_configurations #=> Array
|
1580
1588
|
# resp.recording_configurations[0].arn #=> String
|
1581
|
-
# resp.recording_configurations[0].destination_configuration.s3.bucket_name #=> String
|
1582
1589
|
# resp.recording_configurations[0].name #=> String
|
1590
|
+
# resp.recording_configurations[0].destination_configuration.s3.bucket_name #=> String
|
1583
1591
|
# resp.recording_configurations[0].state #=> String, one of "CREATING", "CREATE_FAILED", "ACTIVE"
|
1584
1592
|
# resp.recording_configurations[0].tags #=> Hash
|
1585
1593
|
# resp.recording_configurations[0].tags["TagKey"] #=> String
|
1594
|
+
# resp.next_token #=> String
|
1586
1595
|
#
|
1587
1596
|
# @see http://docs.aws.amazon.com/goto/WebAPI/ivs-2020-07-14/ListRecordingConfigurations AWS API Documentation
|
1588
1597
|
#
|
@@ -1598,17 +1607,17 @@ module Aws::IVS
|
|
1598
1607
|
# @option params [required, String] :channel_arn
|
1599
1608
|
# Channel ARN used to filter the list.
|
1600
1609
|
#
|
1601
|
-
# @option params [Integer] :max_results
|
1602
|
-
# Maximum number of streamKeys to return. Default: 1.
|
1603
|
-
#
|
1604
1610
|
# @option params [String] :next_token
|
1605
1611
|
# The first stream key to retrieve. This is used for pagination; see the
|
1606
1612
|
# `nextToken` response field.
|
1607
1613
|
#
|
1614
|
+
# @option params [Integer] :max_results
|
1615
|
+
# Maximum number of streamKeys to return. Default: 1.
|
1616
|
+
#
|
1608
1617
|
# @return [Types::ListStreamKeysResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1609
1618
|
#
|
1610
|
-
# * {Types::ListStreamKeysResponse#next_token #next_token} => String
|
1611
1619
|
# * {Types::ListStreamKeysResponse#stream_keys #stream_keys} => Array<Types::StreamKeySummary>
|
1620
|
+
# * {Types::ListStreamKeysResponse#next_token #next_token} => String
|
1612
1621
|
#
|
1613
1622
|
# The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
|
1614
1623
|
#
|
@@ -1616,18 +1625,18 @@ module Aws::IVS
|
|
1616
1625
|
#
|
1617
1626
|
# resp = client.list_stream_keys({
|
1618
1627
|
# channel_arn: "ChannelArn", # required
|
1619
|
-
# max_results: 1,
|
1620
1628
|
# next_token: "PaginationToken",
|
1629
|
+
# max_results: 1,
|
1621
1630
|
# })
|
1622
1631
|
#
|
1623
1632
|
# @example Response structure
|
1624
1633
|
#
|
1625
|
-
# resp.next_token #=> String
|
1626
1634
|
# resp.stream_keys #=> Array
|
1627
1635
|
# resp.stream_keys[0].arn #=> String
|
1628
1636
|
# resp.stream_keys[0].channel_arn #=> String
|
1629
1637
|
# resp.stream_keys[0].tags #=> Hash
|
1630
1638
|
# resp.stream_keys[0].tags["TagKey"] #=> String
|
1639
|
+
# resp.next_token #=> String
|
1631
1640
|
#
|
1632
1641
|
# @see http://docs.aws.amazon.com/goto/WebAPI/ivs-2020-07-14/ListStreamKeys AWS API Documentation
|
1633
1642
|
#
|
@@ -1644,17 +1653,17 @@ module Aws::IVS
|
|
1644
1653
|
# @option params [required, String] :channel_arn
|
1645
1654
|
# Channel ARN used to filter the list.
|
1646
1655
|
#
|
1647
|
-
# @option params [Integer] :max_results
|
1648
|
-
# Maximum number of streams to return. Default: 100.
|
1649
|
-
#
|
1650
1656
|
# @option params [String] :next_token
|
1651
1657
|
# The first stream to retrieve. This is used for pagination; see the
|
1652
1658
|
# `nextToken` response field.
|
1653
1659
|
#
|
1660
|
+
# @option params [Integer] :max_results
|
1661
|
+
# Maximum number of streams to return. Default: 100.
|
1662
|
+
#
|
1654
1663
|
# @return [Types::ListStreamSessionsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1655
1664
|
#
|
1656
|
-
# * {Types::ListStreamSessionsResponse#next_token #next_token} => String
|
1657
1665
|
# * {Types::ListStreamSessionsResponse#stream_sessions #stream_sessions} => Array<Types::StreamSessionSummary>
|
1666
|
+
# * {Types::ListStreamSessionsResponse#next_token #next_token} => String
|
1658
1667
|
#
|
1659
1668
|
# The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
|
1660
1669
|
#
|
@@ -1662,18 +1671,18 @@ module Aws::IVS
|
|
1662
1671
|
#
|
1663
1672
|
# resp = client.list_stream_sessions({
|
1664
1673
|
# channel_arn: "ChannelArn", # required
|
1665
|
-
# max_results: 1,
|
1666
1674
|
# next_token: "PaginationToken",
|
1675
|
+
# max_results: 1,
|
1667
1676
|
# })
|
1668
1677
|
#
|
1669
1678
|
# @example Response structure
|
1670
1679
|
#
|
1671
|
-
# resp.next_token #=> String
|
1672
1680
|
# resp.stream_sessions #=> Array
|
1681
|
+
# resp.stream_sessions[0].stream_id #=> String
|
1682
|
+
# resp.stream_sessions[0].start_time #=> Time
|
1673
1683
|
# resp.stream_sessions[0].end_time #=> Time
|
1674
1684
|
# resp.stream_sessions[0].has_error_event #=> Boolean
|
1675
|
-
# resp.
|
1676
|
-
# resp.stream_sessions[0].stream_id #=> String
|
1685
|
+
# resp.next_token #=> String
|
1677
1686
|
#
|
1678
1687
|
# @see http://docs.aws.amazon.com/goto/WebAPI/ivs-2020-07-14/ListStreamSessions AWS API Documentation
|
1679
1688
|
#
|
@@ -1690,17 +1699,17 @@ module Aws::IVS
|
|
1690
1699
|
# @option params [Types::StreamFilters] :filter_by
|
1691
1700
|
# Filters the stream list to match the specified criterion.
|
1692
1701
|
#
|
1693
|
-
# @option params [Integer] :max_results
|
1694
|
-
# Maximum number of streams to return. Default: 100.
|
1695
|
-
#
|
1696
1702
|
# @option params [String] :next_token
|
1697
1703
|
# The first stream to retrieve. This is used for pagination; see the
|
1698
1704
|
# `nextToken` response field.
|
1699
1705
|
#
|
1706
|
+
# @option params [Integer] :max_results
|
1707
|
+
# Maximum number of streams to return. Default: 100.
|
1708
|
+
#
|
1700
1709
|
# @return [Types::ListStreamsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1701
1710
|
#
|
1702
|
-
# * {Types::ListStreamsResponse#next_token #next_token} => String
|
1703
1711
|
# * {Types::ListStreamsResponse#streams #streams} => Array<Types::StreamSummary>
|
1712
|
+
# * {Types::ListStreamsResponse#next_token #next_token} => String
|
1704
1713
|
#
|
1705
1714
|
# The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
|
1706
1715
|
#
|
@@ -1710,20 +1719,20 @@ module Aws::IVS
|
|
1710
1719
|
# filter_by: {
|
1711
1720
|
# health: "HEALTHY", # accepts HEALTHY, STARVING, UNKNOWN
|
1712
1721
|
# },
|
1713
|
-
# max_results: 1,
|
1714
1722
|
# next_token: "PaginationToken",
|
1723
|
+
# max_results: 1,
|
1715
1724
|
# })
|
1716
1725
|
#
|
1717
1726
|
# @example Response structure
|
1718
1727
|
#
|
1719
|
-
# resp.next_token #=> String
|
1720
1728
|
# resp.streams #=> Array
|
1721
1729
|
# resp.streams[0].channel_arn #=> String
|
1722
|
-
# resp.streams[0].health #=> String, one of "HEALTHY", "STARVING", "UNKNOWN"
|
1723
|
-
# resp.streams[0].start_time #=> Time
|
1724
|
-
# resp.streams[0].state #=> String, one of "LIVE", "OFFLINE"
|
1725
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"
|
1726
1733
|
# resp.streams[0].viewer_count #=> Integer
|
1734
|
+
# resp.streams[0].start_time #=> Time
|
1735
|
+
# resp.next_token #=> String
|
1727
1736
|
#
|
1728
1737
|
# @see http://docs.aws.amazon.com/goto/WebAPI/ivs-2020-07-14/ListStreams AWS API Documentation
|
1729
1738
|
#
|
@@ -1951,46 +1960,46 @@ module Aws::IVS
|
|
1951
1960
|
# @option params [required, String] :arn
|
1952
1961
|
# ARN of the channel to be updated.
|
1953
1962
|
#
|
1954
|
-
# @option params [
|
1955
|
-
#
|
1956
|
-
#
|
1957
|
-
# @option params [Boolean] :insecure_ingest
|
1958
|
-
# Whether the channel allows insecure RTMP and SRT ingest. Default:
|
1959
|
-
# `false`.
|
1963
|
+
# @option params [String] :name
|
1964
|
+
# Channel name.
|
1960
1965
|
#
|
1961
1966
|
# @option params [String] :latency_mode
|
1962
1967
|
# Channel latency mode. Use `NORMAL` to broadcast and deliver live video
|
1963
1968
|
# up to Full HD. Use `LOW` for near-real-time interaction with viewers.
|
1964
1969
|
#
|
1965
|
-
# @option params [String] :
|
1966
|
-
# 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].
|
1967
1975
|
#
|
1968
|
-
# @option params [String] :playback_restriction_policy_arn
|
1969
|
-
# Playback-restriction-policy ARN. A valid ARN value here both specifies
|
1970
|
-
# the ARN and enables playback restriction. If this is set to an empty
|
1971
|
-
# string, playback restriction policy is disabled.
|
1972
1976
|
#
|
1973
|
-
#
|
1974
|
-
#
|
1975
|
-
#
|
1976
|
-
#
|
1977
|
-
#
|
1978
|
-
# (`""`).
|
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).
|
1979
1982
|
#
|
1980
1983
|
# @option params [String] :recording_configuration_arn
|
1981
1984
|
# Recording-configuration ARN. A valid ARN value here both specifies the
|
1982
1985
|
# ARN and enables recording. If this is set to an empty string,
|
1983
1986
|
# recording is disabled.
|
1984
1987
|
#
|
1985
|
-
# @option params [
|
1986
|
-
#
|
1987
|
-
#
|
1988
|
-
# probably will disconnect immediately.* Default: `STANDARD`. For
|
1989
|
-
# details, see [Channel Types][1].
|
1990
|
-
#
|
1988
|
+
# @option params [Boolean] :insecure_ingest
|
1989
|
+
# Whether the channel allows insecure RTMP and SRT ingest. Default:
|
1990
|
+
# `false`.
|
1991
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
|
+
# (`""`).
|
1992
1998
|
#
|
1993
|
-
#
|
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.
|
1994
2003
|
#
|
1995
2004
|
# @return [Types::UpdateChannelResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1996
2005
|
#
|
@@ -2000,33 +2009,33 @@ module Aws::IVS
|
|
2000
2009
|
#
|
2001
2010
|
# resp = client.update_channel({
|
2002
2011
|
# arn: "ChannelArn", # required
|
2012
|
+
# name: "ChannelName",
|
2013
|
+
# latency_mode: "NORMAL", # accepts NORMAL, LOW
|
2014
|
+
# type: "BASIC", # accepts BASIC, STANDARD, ADVANCED_SD, ADVANCED_HD
|
2003
2015
|
# authorized: false,
|
2016
|
+
# recording_configuration_arn: "ChannelRecordingConfigurationArn",
|
2004
2017
|
# insecure_ingest: false,
|
2005
|
-
# latency_mode: "NORMAL", # accepts NORMAL, LOW
|
2006
|
-
# name: "ChannelName",
|
2007
|
-
# playback_restriction_policy_arn: "ChannelPlaybackRestrictionPolicyArn",
|
2008
2018
|
# preset: "HIGHER_BANDWIDTH_DELIVERY", # accepts HIGHER_BANDWIDTH_DELIVERY, CONSTRAINED_BANDWIDTH_DELIVERY
|
2009
|
-
#
|
2010
|
-
# type: "BASIC", # accepts BASIC, STANDARD, ADVANCED_SD, ADVANCED_HD
|
2019
|
+
# playback_restriction_policy_arn: "ChannelPlaybackRestrictionPolicyArn",
|
2011
2020
|
# })
|
2012
2021
|
#
|
2013
2022
|
# @example Response structure
|
2014
2023
|
#
|
2015
2024
|
# resp.channel.arn #=> String
|
2016
|
-
# resp.channel.authorized #=> Boolean
|
2017
|
-
# resp.channel.ingest_endpoint #=> String
|
2018
|
-
# resp.channel.insecure_ingest #=> Boolean
|
2019
|
-
# resp.channel.latency_mode #=> String, one of "NORMAL", "LOW"
|
2020
2025
|
# resp.channel.name #=> String
|
2021
|
-
# 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
|
2022
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
|
2023
2035
|
# resp.channel.preset #=> String, one of "HIGHER_BANDWIDTH_DELIVERY", "CONSTRAINED_BANDWIDTH_DELIVERY"
|
2024
|
-
# resp.channel.recording_configuration_arn #=> String
|
2025
2036
|
# resp.channel.srt.endpoint #=> String
|
2026
2037
|
# resp.channel.srt.passphrase #=> String
|
2027
|
-
# resp.channel.
|
2028
|
-
# resp.channel.tags["TagKey"] #=> String
|
2029
|
-
# resp.channel.type #=> String, one of "BASIC", "STANDARD", "ADVANCED_SD", "ADVANCED_HD"
|
2038
|
+
# resp.channel.playback_restriction_policy_arn #=> String
|
2030
2039
|
#
|
2031
2040
|
# @see http://docs.aws.amazon.com/goto/WebAPI/ivs-2020-07-14/UpdateChannel AWS API Documentation
|
2032
2041
|
#
|
@@ -2039,6 +2048,9 @@ module Aws::IVS
|
|
2039
2048
|
|
2040
2049
|
# Updates a specified playback restriction policy.
|
2041
2050
|
#
|
2051
|
+
# @option params [required, String] :arn
|
2052
|
+
# ARN of the playback-restriction-policy to be updated.
|
2053
|
+
#
|
2042
2054
|
# @option params [Array<String>] :allowed_countries
|
2043
2055
|
# A list of country codes that control geoblocking restriction. Allowed
|
2044
2056
|
# values are the officially assigned [ISO 3166-1 alpha-2][1] codes.
|
@@ -2058,9 +2070,6 @@ module Aws::IVS
|
|
2058
2070
|
#
|
2059
2071
|
# [1]: https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Origin
|
2060
2072
|
#
|
2061
|
-
# @option params [required, String] :arn
|
2062
|
-
# ARN of the playback-restriction-policy to be updated.
|
2063
|
-
#
|
2064
2073
|
# @option params [Boolean] :enable_strict_origin_enforcement
|
2065
2074
|
# Whether channel playback is constrained by origin site. Default:
|
2066
2075
|
# `false`.
|
@@ -2076,20 +2085,20 @@ module Aws::IVS
|
|
2076
2085
|
# @example Request syntax with placeholder values
|
2077
2086
|
#
|
2078
2087
|
# resp = client.update_playback_restriction_policy({
|
2088
|
+
# arn: "PlaybackRestrictionPolicyArn", # required
|
2079
2089
|
# allowed_countries: ["PlaybackRestrictionPolicyAllowedCountry"],
|
2080
2090
|
# allowed_origins: ["PlaybackRestrictionPolicyAllowedOrigin"],
|
2081
|
-
# arn: "PlaybackRestrictionPolicyArn", # required
|
2082
2091
|
# enable_strict_origin_enforcement: false,
|
2083
2092
|
# name: "PlaybackRestrictionPolicyName",
|
2084
2093
|
# })
|
2085
2094
|
#
|
2086
2095
|
# @example Response structure
|
2087
2096
|
#
|
2097
|
+
# resp.playback_restriction_policy.arn #=> String
|
2088
2098
|
# resp.playback_restriction_policy.allowed_countries #=> Array
|
2089
2099
|
# resp.playback_restriction_policy.allowed_countries[0] #=> String
|
2090
2100
|
# resp.playback_restriction_policy.allowed_origins #=> Array
|
2091
2101
|
# resp.playback_restriction_policy.allowed_origins[0] #=> String
|
2092
|
-
# resp.playback_restriction_policy.arn #=> String
|
2093
2102
|
# resp.playback_restriction_policy.enable_strict_origin_enforcement #=> Boolean
|
2094
2103
|
# resp.playback_restriction_policy.name #=> String
|
2095
2104
|
# resp.playback_restriction_policy.tags #=> Hash
|
@@ -2117,7 +2126,7 @@ module Aws::IVS
|
|
2117
2126
|
params: params,
|
2118
2127
|
config: config)
|
2119
2128
|
context[:gem_name] = 'aws-sdk-ivs'
|
2120
|
-
context[:gem_version] = '1.
|
2129
|
+
context[:gem_version] = '1.53.0'
|
2121
2130
|
Seahorse::Client::Request.new(handlers, context)
|
2122
2131
|
end
|
2123
2132
|
|