aws-sdk-ivs 1.8.0 → 1.9.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +4 -4
- data/CHANGELOG.md +5 -0
- data/VERSION +1 -1
- data/lib/aws-sdk-ivs.rb +1 -1
- data/lib/aws-sdk-ivs/client.rb +260 -25
- data/lib/aws-sdk-ivs/client_api.rb +127 -0
- data/lib/aws-sdk-ivs/types.rb +356 -31
- metadata +4 -4
checksums.yaml
CHANGED
@@ -1,7 +1,7 @@
|
|
1
1
|
---
|
2
2
|
SHA256:
|
3
|
-
metadata.gz:
|
4
|
-
data.tar.gz:
|
3
|
+
metadata.gz: 4471811332b704f302ddabc731c4081333a9138538ab43d3caf6f8323f0d0db8
|
4
|
+
data.tar.gz: 761804e9c54aec158217094e300942006342d9838e55fd4abbfd23bfe949061d
|
5
5
|
SHA512:
|
6
|
-
metadata.gz:
|
7
|
-
data.tar.gz:
|
6
|
+
metadata.gz: 408d77158ed7b73c1d745cae1a2bd4db00c334ce0c6e03ce253b5f5a538852d1047bd8060f3c7c3e03f65115ab928c1df9a593242481c29b43f790635f6b3c67
|
7
|
+
data.tar.gz: 1f42521764d672d190106814ae41bee9c841aceeb5631c3759dc9891c28accf4735ea092206a480db113212f56b68c0ffb36947f7a7c3adcac4b4dc06d85b440
|
data/CHANGELOG.md
CHANGED
@@ -1,6 +1,11 @@
|
|
1
1
|
Unreleased Changes
|
2
2
|
------------------
|
3
3
|
|
4
|
+
1.9.0 (2021-04-07)
|
5
|
+
------------------
|
6
|
+
|
7
|
+
* Feature - This release adds support for the Auto-Record to S3 feature. Amazon IVS now enables you to save your live video to Amazon S3.
|
8
|
+
|
4
9
|
1.8.0 (2021-03-10)
|
5
10
|
------------------
|
6
11
|
|
data/VERSION
CHANGED
@@ -1 +1 @@
|
|
1
|
-
1.
|
1
|
+
1.9.0
|
data/lib/aws-sdk-ivs.rb
CHANGED
data/lib/aws-sdk-ivs/client.rb
CHANGED
@@ -350,6 +350,7 @@ module Aws::IVS
|
|
350
350
|
# resp.channels[0].name #=> String
|
351
351
|
# resp.channels[0].latency_mode #=> String, one of "NORMAL", "LOW"
|
352
352
|
# resp.channels[0].type #=> String, one of "BASIC", "STANDARD"
|
353
|
+
# resp.channels[0].recording_configuration_arn #=> String
|
353
354
|
# resp.channels[0].ingest_endpoint #=> String
|
354
355
|
# resp.channels[0].playback_url #=> String
|
355
356
|
# resp.channels[0].authorized #=> Boolean
|
@@ -413,12 +414,16 @@ module Aws::IVS
|
|
413
414
|
# Channel name.
|
414
415
|
#
|
415
416
|
# @option params [String] :latency_mode
|
416
|
-
# Channel latency mode.
|
417
|
+
# Channel latency mode. Use `NORMAL` to broadcast and deliver live video
|
418
|
+
# up to Full HD. Use `LOW` for near-real-time interaction with viewers.
|
419
|
+
# (Note: In the Amazon IVS console, `LOW` and `NORMAL` correspond to
|
420
|
+
# Ultra-low and Standard, respectively.) Default: `LOW`.
|
417
421
|
#
|
418
422
|
# @option params [String] :type
|
419
423
|
# Channel type, which determines the allowable resolution and bitrate.
|
420
424
|
# *If you exceed the allowable resolution or bitrate, the stream
|
421
|
-
# probably will disconnect immediately.* Valid
|
425
|
+
# probably will disconnect immediately.* Default: `STANDARD`. Valid
|
426
|
+
# values:
|
422
427
|
#
|
423
428
|
# * `STANDARD`\: Multiple qualities are generated from the original
|
424
429
|
# input, to automatically give viewers the best experience for their
|
@@ -430,13 +435,16 @@ module Aws::IVS
|
|
430
435
|
# Vertical resolution can be up to 480 and bitrate can be up to 1.5
|
431
436
|
# Mbps.
|
432
437
|
#
|
433
|
-
# Default: `STANDARD`.
|
434
|
-
#
|
435
438
|
# @option params [Boolean] :authorized
|
436
|
-
# Whether the channel is
|
439
|
+
# Whether the channel is private (enabled for playback authorization).
|
440
|
+
# Default: `false`.
|
441
|
+
#
|
442
|
+
# @option params [String] :recording_configuration_arn
|
443
|
+
# Recording-configuration ARN. Default: "" (empty string, recording is
|
444
|
+
# disabled).
|
437
445
|
#
|
438
446
|
# @option params [Hash<String,String>] :tags
|
439
|
-
#
|
447
|
+
# Array of 1-50 maps, each of the form `string:string (key:value)`.
|
440
448
|
#
|
441
449
|
# @return [Types::CreateChannelResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
442
450
|
#
|
@@ -450,6 +458,7 @@ module Aws::IVS
|
|
450
458
|
# latency_mode: "NORMAL", # accepts NORMAL, LOW
|
451
459
|
# type: "BASIC", # accepts BASIC, STANDARD
|
452
460
|
# authorized: false,
|
461
|
+
# recording_configuration_arn: "ChannelRecordingConfigurationArn",
|
453
462
|
# tags: {
|
454
463
|
# "TagKey" => "TagValue",
|
455
464
|
# },
|
@@ -461,6 +470,7 @@ module Aws::IVS
|
|
461
470
|
# resp.channel.name #=> String
|
462
471
|
# resp.channel.latency_mode #=> String, one of "NORMAL", "LOW"
|
463
472
|
# resp.channel.type #=> String, one of "BASIC", "STANDARD"
|
473
|
+
# resp.channel.recording_configuration_arn #=> String
|
464
474
|
# resp.channel.ingest_endpoint #=> String
|
465
475
|
# resp.channel.playback_url #=> String
|
466
476
|
# resp.channel.authorized #=> Boolean
|
@@ -481,6 +491,69 @@ module Aws::IVS
|
|
481
491
|
req.send_request(options)
|
482
492
|
end
|
483
493
|
|
494
|
+
# Creates a new recording configuration, used to enable recording to
|
495
|
+
# Amazon S3.
|
496
|
+
#
|
497
|
+
# **Known issue:** In the us-east-1 region, if you use the AWS CLI to
|
498
|
+
# create a recording configuration, it returns success even if the S3
|
499
|
+
# bucket is in a different region. In this case, the `state` of the
|
500
|
+
# recording configuration is `CREATE_FAILED` (instead of `ACTIVE`). (In
|
501
|
+
# other regions, the CLI correctly returns failure if the bucket is in a
|
502
|
+
# different region.)
|
503
|
+
#
|
504
|
+
# **Workaround:** Ensure that your S3 bucket is in the same region as
|
505
|
+
# the recording configuration. If you create a recording configuration
|
506
|
+
# in a different region as your S3 bucket, delete that recording
|
507
|
+
# configuration and create a new one with an S3 bucket from the correct
|
508
|
+
# region.
|
509
|
+
#
|
510
|
+
# @option params [String] :name
|
511
|
+
# An arbitrary string (a nickname) that helps the customer identify that
|
512
|
+
# resource. The value does not need to be unique.
|
513
|
+
#
|
514
|
+
# @option params [required, Types::DestinationConfiguration] :destination_configuration
|
515
|
+
# A complex type that contains a destination configuration for where
|
516
|
+
# recorded video will be stored.
|
517
|
+
#
|
518
|
+
# @option params [Hash<String,String>] :tags
|
519
|
+
# Array of 1-50 maps, each of the form `string:string (key:value)`.
|
520
|
+
#
|
521
|
+
# @return [Types::CreateRecordingConfigurationResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
522
|
+
#
|
523
|
+
# * {Types::CreateRecordingConfigurationResponse#recording_configuration #recording_configuration} => Types::RecordingConfiguration
|
524
|
+
#
|
525
|
+
# @example Request syntax with placeholder values
|
526
|
+
#
|
527
|
+
# resp = client.create_recording_configuration({
|
528
|
+
# name: "RecordingConfigurationName",
|
529
|
+
# destination_configuration: { # required
|
530
|
+
# s3: {
|
531
|
+
# bucket_name: "S3DestinationBucketName", # required
|
532
|
+
# },
|
533
|
+
# },
|
534
|
+
# tags: {
|
535
|
+
# "TagKey" => "TagValue",
|
536
|
+
# },
|
537
|
+
# })
|
538
|
+
#
|
539
|
+
# @example Response structure
|
540
|
+
#
|
541
|
+
# resp.recording_configuration.arn #=> String
|
542
|
+
# resp.recording_configuration.name #=> String
|
543
|
+
# resp.recording_configuration.destination_configuration.s3.bucket_name #=> String
|
544
|
+
# resp.recording_configuration.state #=> String, one of "CREATING", "CREATE_FAILED", "ACTIVE"
|
545
|
+
# resp.recording_configuration.tags #=> Hash
|
546
|
+
# resp.recording_configuration.tags["TagKey"] #=> String
|
547
|
+
#
|
548
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/ivs-2020-07-14/CreateRecordingConfiguration AWS API Documentation
|
549
|
+
#
|
550
|
+
# @overload create_recording_configuration(params = {})
|
551
|
+
# @param [Hash] params ({})
|
552
|
+
def create_recording_configuration(params = {}, options = {})
|
553
|
+
req = build_request(:create_recording_configuration, params)
|
554
|
+
req.send_request(options)
|
555
|
+
end
|
556
|
+
|
484
557
|
# Creates a stream key, used to initiate a stream, for the specified
|
485
558
|
# channel ARN.
|
486
559
|
#
|
@@ -494,7 +567,7 @@ module Aws::IVS
|
|
494
567
|
# ARN of the channel for which to create the stream key.
|
495
568
|
#
|
496
569
|
# @option params [Hash<String,String>] :tags
|
497
|
-
#
|
570
|
+
# Array of 1-50 maps, each of the form `string:string (key:value)`.
|
498
571
|
#
|
499
572
|
# @return [Types::CreateStreamKeyResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
500
573
|
#
|
@@ -528,6 +601,16 @@ module Aws::IVS
|
|
528
601
|
|
529
602
|
# Deletes the specified channel and its associated stream keys.
|
530
603
|
#
|
604
|
+
# If you try to delete a live channel, you will get an error (409
|
605
|
+
# ConflictException). To delete a channel that is live, call StopStream,
|
606
|
+
# wait for the Amazon EventBridge "Stream End" event (to verify that
|
607
|
+
# the stream's state was changed from Live to Offline), then call
|
608
|
+
# DeleteChannel. (See [ Using EventBridge with Amazon IVS][1].)
|
609
|
+
#
|
610
|
+
#
|
611
|
+
#
|
612
|
+
# [1]: https://docs.aws.amazon.com/ivs/latest/userguide/eventbridge.html
|
613
|
+
#
|
531
614
|
# @option params [required, String] :arn
|
532
615
|
# ARN of the channel to be deleted.
|
533
616
|
#
|
@@ -549,7 +632,13 @@ module Aws::IVS
|
|
549
632
|
end
|
550
633
|
|
551
634
|
# Deletes a specified authorization key pair. This invalidates future
|
552
|
-
# viewer tokens generated using the key pair’s `privateKey`.
|
635
|
+
# viewer tokens generated using the key pair’s `privateKey`. For more
|
636
|
+
# information, see [Setting Up Private Channels][1] in the *Amazon IVS
|
637
|
+
# User Guide*.
|
638
|
+
#
|
639
|
+
#
|
640
|
+
#
|
641
|
+
# [1]: https://docs.aws.amazon.com/ivs/latest/userguide/private-channels.html
|
553
642
|
#
|
554
643
|
# @option params [required, String] :arn
|
555
644
|
# ARN of the key pair to be deleted.
|
@@ -571,6 +660,34 @@ module Aws::IVS
|
|
571
660
|
req.send_request(options)
|
572
661
|
end
|
573
662
|
|
663
|
+
# Deletes the recording configuration for the specified ARN.
|
664
|
+
#
|
665
|
+
# If you try to delete a recording configuration that is associated with
|
666
|
+
# a channel, you will get an error (409 ConflictException). To avoid
|
667
|
+
# this, for all channels that reference the recording configuration,
|
668
|
+
# first use UpdateChannel to set the `recordingConfigurationArn` field
|
669
|
+
# to an empty string, then use DeleteRecordingConfiguration.
|
670
|
+
#
|
671
|
+
# @option params [required, String] :arn
|
672
|
+
# ARN of the recording configuration to be deleted.
|
673
|
+
#
|
674
|
+
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
675
|
+
#
|
676
|
+
# @example Request syntax with placeholder values
|
677
|
+
#
|
678
|
+
# resp = client.delete_recording_configuration({
|
679
|
+
# arn: "RecordingConfigurationArn", # required
|
680
|
+
# })
|
681
|
+
#
|
682
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/ivs-2020-07-14/DeleteRecordingConfiguration AWS API Documentation
|
683
|
+
#
|
684
|
+
# @overload delete_recording_configuration(params = {})
|
685
|
+
# @param [Hash] params ({})
|
686
|
+
def delete_recording_configuration(params = {}, options = {})
|
687
|
+
req = build_request(:delete_recording_configuration, params)
|
688
|
+
req.send_request(options)
|
689
|
+
end
|
690
|
+
|
574
691
|
# Deletes the stream key for the specified ARN, so it can no longer be
|
575
692
|
# used to stream.
|
576
693
|
#
|
@@ -616,6 +733,7 @@ module Aws::IVS
|
|
616
733
|
# resp.channel.name #=> String
|
617
734
|
# resp.channel.latency_mode #=> String, one of "NORMAL", "LOW"
|
618
735
|
# resp.channel.type #=> String, one of "BASIC", "STANDARD"
|
736
|
+
# resp.channel.recording_configuration_arn #=> String
|
619
737
|
# resp.channel.ingest_endpoint #=> String
|
620
738
|
# resp.channel.playback_url #=> String
|
621
739
|
# resp.channel.authorized #=> Boolean
|
@@ -634,7 +752,12 @@ module Aws::IVS
|
|
634
752
|
# Gets a specified playback authorization key pair and returns the `arn`
|
635
753
|
# and `fingerprint`. The `privateKey` held by the caller can be used to
|
636
754
|
# generate viewer authorization tokens, to grant viewers access to
|
637
|
-
#
|
755
|
+
# private channels. For more information, see [Setting Up Private
|
756
|
+
# Channels][1] in the *Amazon IVS User Guide*.
|
757
|
+
#
|
758
|
+
#
|
759
|
+
#
|
760
|
+
# [1]: https://docs.aws.amazon.com/ivs/latest/userguide/private-channels.html
|
638
761
|
#
|
639
762
|
# @option params [required, String] :arn
|
640
763
|
# ARN of the key pair to be returned.
|
@@ -666,6 +789,39 @@ module Aws::IVS
|
|
666
789
|
req.send_request(options)
|
667
790
|
end
|
668
791
|
|
792
|
+
# Gets the recording configuration for the specified ARN.
|
793
|
+
#
|
794
|
+
# @option params [required, String] :arn
|
795
|
+
# ARN of the recording configuration to be retrieved.
|
796
|
+
#
|
797
|
+
# @return [Types::GetRecordingConfigurationResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
798
|
+
#
|
799
|
+
# * {Types::GetRecordingConfigurationResponse#recording_configuration #recording_configuration} => Types::RecordingConfiguration
|
800
|
+
#
|
801
|
+
# @example Request syntax with placeholder values
|
802
|
+
#
|
803
|
+
# resp = client.get_recording_configuration({
|
804
|
+
# arn: "RecordingConfigurationArn", # required
|
805
|
+
# })
|
806
|
+
#
|
807
|
+
# @example Response structure
|
808
|
+
#
|
809
|
+
# resp.recording_configuration.arn #=> String
|
810
|
+
# resp.recording_configuration.name #=> String
|
811
|
+
# resp.recording_configuration.destination_configuration.s3.bucket_name #=> String
|
812
|
+
# resp.recording_configuration.state #=> String, one of "CREATING", "CREATE_FAILED", "ACTIVE"
|
813
|
+
# resp.recording_configuration.tags #=> Hash
|
814
|
+
# resp.recording_configuration.tags["TagKey"] #=> String
|
815
|
+
#
|
816
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/ivs-2020-07-14/GetRecordingConfiguration AWS API Documentation
|
817
|
+
#
|
818
|
+
# @overload get_recording_configuration(params = {})
|
819
|
+
# @param [Hash] params ({})
|
820
|
+
def get_recording_configuration(params = {}, options = {})
|
821
|
+
req = build_request(:get_recording_configuration, params)
|
822
|
+
req.send_request(options)
|
823
|
+
end
|
824
|
+
|
669
825
|
# Gets information about the active (live) stream on a specified
|
670
826
|
# channel.
|
671
827
|
#
|
@@ -734,7 +890,13 @@ module Aws::IVS
|
|
734
890
|
|
735
891
|
# Imports the public portion of a new key pair and returns its `arn` and
|
736
892
|
# `fingerprint`. The `privateKey` can then be used to generate viewer
|
737
|
-
# authorization tokens, to grant viewers access to
|
893
|
+
# authorization tokens, to grant viewers access to private channels. For
|
894
|
+
# more information, see [Setting Up Private Channels][1] in the *Amazon
|
895
|
+
# IVS User Guide*.
|
896
|
+
#
|
897
|
+
#
|
898
|
+
#
|
899
|
+
# [1]: https://docs.aws.amazon.com/ivs/latest/userguide/private-channels.html
|
738
900
|
#
|
739
901
|
# @option params [required, String] :public_key_material
|
740
902
|
# The public portion of a customer-generated key pair.
|
@@ -781,17 +943,23 @@ module Aws::IVS
|
|
781
943
|
|
782
944
|
# Gets summary information about all channels in your account, in the
|
783
945
|
# AWS region where the API request is processed. This list can be
|
784
|
-
# filtered to match a specified
|
946
|
+
# filtered to match a specified name or recording-configuration ARN.
|
947
|
+
# Filters are mutually exclusive and cannot be used together. If you try
|
948
|
+
# to use both filters, you will get an error (409 ConflictException).
|
785
949
|
#
|
786
950
|
# @option params [String] :filter_by_name
|
787
951
|
# Filters the channel list to match the specified name.
|
788
952
|
#
|
953
|
+
# @option params [String] :filter_by_recording_configuration_arn
|
954
|
+
# Filters the channel list to match the specified
|
955
|
+
# recording-configuration ARN.
|
956
|
+
#
|
789
957
|
# @option params [String] :next_token
|
790
958
|
# The first channel to retrieve. This is used for pagination; see the
|
791
959
|
# `nextToken` response field.
|
792
960
|
#
|
793
961
|
# @option params [Integer] :max_results
|
794
|
-
# Maximum number of channels to return.
|
962
|
+
# Maximum number of channels to return. Default: 50.
|
795
963
|
#
|
796
964
|
# @return [Types::ListChannelsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
797
965
|
#
|
@@ -804,6 +972,7 @@ module Aws::IVS
|
|
804
972
|
#
|
805
973
|
# resp = client.list_channels({
|
806
974
|
# filter_by_name: "ChannelName",
|
975
|
+
# filter_by_recording_configuration_arn: "ChannelRecordingConfigurationArn",
|
807
976
|
# next_token: "PaginationToken",
|
808
977
|
# max_results: 1,
|
809
978
|
# })
|
@@ -815,6 +984,7 @@ module Aws::IVS
|
|
815
984
|
# resp.channels[0].name #=> String
|
816
985
|
# resp.channels[0].latency_mode #=> String, one of "NORMAL", "LOW"
|
817
986
|
# resp.channels[0].authorized #=> Boolean
|
987
|
+
# resp.channels[0].recording_configuration_arn #=> String
|
818
988
|
# resp.channels[0].tags #=> Hash
|
819
989
|
# resp.channels[0].tags["TagKey"] #=> String
|
820
990
|
# resp.next_token #=> String
|
@@ -828,14 +998,20 @@ module Aws::IVS
|
|
828
998
|
req.send_request(options)
|
829
999
|
end
|
830
1000
|
|
831
|
-
# Gets summary information about playback key pairs.
|
1001
|
+
# Gets summary information about playback key pairs. For more
|
1002
|
+
# information, see [Setting Up Private Channels][1] in the *Amazon IVS
|
1003
|
+
# User Guide*.
|
1004
|
+
#
|
1005
|
+
#
|
1006
|
+
#
|
1007
|
+
# [1]: https://docs.aws.amazon.com/ivs/latest/userguide/private-channels.html
|
832
1008
|
#
|
833
1009
|
# @option params [String] :next_token
|
834
1010
|
# Maximum number of key pairs to return.
|
835
1011
|
#
|
836
1012
|
# @option params [Integer] :max_results
|
837
1013
|
# The first key pair to retrieve. This is used for pagination; see the
|
838
|
-
# `nextToken` response field.
|
1014
|
+
# `nextToken` response field. Default: 50.
|
839
1015
|
#
|
840
1016
|
# @return [Types::ListPlaybackKeyPairsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
841
1017
|
#
|
@@ -869,6 +1045,50 @@ module Aws::IVS
|
|
869
1045
|
req.send_request(options)
|
870
1046
|
end
|
871
1047
|
|
1048
|
+
# Gets summary information about all recording configurations in your
|
1049
|
+
# account, in the AWS region where the API request is processed.
|
1050
|
+
#
|
1051
|
+
# @option params [String] :next_token
|
1052
|
+
# The first recording configuration to retrieve. This is used for
|
1053
|
+
# pagination; see the `nextToken` response field.
|
1054
|
+
#
|
1055
|
+
# @option params [Integer] :max_results
|
1056
|
+
# Maximum number of recording configurations to return. Default: 50.
|
1057
|
+
#
|
1058
|
+
# @return [Types::ListRecordingConfigurationsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1059
|
+
#
|
1060
|
+
# * {Types::ListRecordingConfigurationsResponse#recording_configurations #recording_configurations} => Array<Types::RecordingConfigurationSummary>
|
1061
|
+
# * {Types::ListRecordingConfigurationsResponse#next_token #next_token} => String
|
1062
|
+
#
|
1063
|
+
# The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
|
1064
|
+
#
|
1065
|
+
# @example Request syntax with placeholder values
|
1066
|
+
#
|
1067
|
+
# resp = client.list_recording_configurations({
|
1068
|
+
# next_token: "PaginationToken",
|
1069
|
+
# max_results: 1,
|
1070
|
+
# })
|
1071
|
+
#
|
1072
|
+
# @example Response structure
|
1073
|
+
#
|
1074
|
+
# resp.recording_configurations #=> Array
|
1075
|
+
# resp.recording_configurations[0].arn #=> String
|
1076
|
+
# resp.recording_configurations[0].name #=> String
|
1077
|
+
# resp.recording_configurations[0].destination_configuration.s3.bucket_name #=> String
|
1078
|
+
# resp.recording_configurations[0].state #=> String, one of "CREATING", "CREATE_FAILED", "ACTIVE"
|
1079
|
+
# resp.recording_configurations[0].tags #=> Hash
|
1080
|
+
# resp.recording_configurations[0].tags["TagKey"] #=> String
|
1081
|
+
# resp.next_token #=> String
|
1082
|
+
#
|
1083
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/ivs-2020-07-14/ListRecordingConfigurations AWS API Documentation
|
1084
|
+
#
|
1085
|
+
# @overload list_recording_configurations(params = {})
|
1086
|
+
# @param [Hash] params ({})
|
1087
|
+
def list_recording_configurations(params = {}, options = {})
|
1088
|
+
req = build_request(:list_recording_configurations, params)
|
1089
|
+
req.send_request(options)
|
1090
|
+
end
|
1091
|
+
|
872
1092
|
# Gets summary information about stream keys for the specified channel.
|
873
1093
|
#
|
874
1094
|
# @option params [required, String] :channel_arn
|
@@ -879,7 +1099,7 @@ module Aws::IVS
|
|
879
1099
|
# `nextToken` response field.
|
880
1100
|
#
|
881
1101
|
# @option params [Integer] :max_results
|
882
|
-
# Maximum number of streamKeys to return.
|
1102
|
+
# Maximum number of streamKeys to return. Default: 50.
|
883
1103
|
#
|
884
1104
|
# @return [Types::ListStreamKeysResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
885
1105
|
#
|
@@ -922,7 +1142,7 @@ module Aws::IVS
|
|
922
1142
|
# `nextToken` response field.
|
923
1143
|
#
|
924
1144
|
# @option params [Integer] :max_results
|
925
|
-
# Maximum number of streams to return.
|
1145
|
+
# Maximum number of streams to return. Default: 50.
|
926
1146
|
#
|
927
1147
|
# @return [Types::ListStreamsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
928
1148
|
#
|
@@ -967,7 +1187,7 @@ module Aws::IVS
|
|
967
1187
|
# `nextToken` response field.
|
968
1188
|
#
|
969
1189
|
# @option params [Integer] :max_results
|
970
|
-
# Maximum number of tags to return.
|
1190
|
+
# Maximum number of tags to return. Default: 50.
|
971
1191
|
#
|
972
1192
|
# @return [Types::ListTagsForResourceResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
973
1193
|
#
|
@@ -999,9 +1219,16 @@ module Aws::IVS
|
|
999
1219
|
req.send_request(options)
|
1000
1220
|
end
|
1001
1221
|
|
1002
|
-
# Inserts metadata into
|
1222
|
+
# Inserts metadata into the active stream of the specified channel. A
|
1003
1223
|
# maximum of 5 requests per second per channel is allowed, each with a
|
1004
|
-
# maximum
|
1224
|
+
# maximum 1 KB payload. (If 5 TPS is not sufficient for your needs, we
|
1225
|
+
# recommend batching your data into a single PutMetadata call.) Also see
|
1226
|
+
# [Embedding Metadata within a Video Stream][1] in the *Amazon IVS User
|
1227
|
+
# Guide*.
|
1228
|
+
#
|
1229
|
+
#
|
1230
|
+
#
|
1231
|
+
# [1]: https://docs.aws.amazon.com/ivs/latest/userguide/metadata.html
|
1005
1232
|
#
|
1006
1233
|
# @option params [required, String] :channel_arn
|
1007
1234
|
# ARN of the channel into which metadata is inserted. This channel must
|
@@ -1123,12 +1350,15 @@ module Aws::IVS
|
|
1123
1350
|
# Channel name.
|
1124
1351
|
#
|
1125
1352
|
# @option params [String] :latency_mode
|
1126
|
-
# Channel latency mode.
|
1353
|
+
# Channel latency mode. Use `NORMAL` to broadcast and deliver live video
|
1354
|
+
# up to Full HD. Use `LOW` for near-real-time interaction with viewers.
|
1355
|
+
# (Note: In the Amazon IVS console, `LOW` and `NORMAL` correspond to
|
1356
|
+
# Ultra-low and Standard, respectively.)
|
1127
1357
|
#
|
1128
1358
|
# @option params [String] :type
|
1129
1359
|
# Channel type, which determines the allowable resolution and bitrate.
|
1130
1360
|
# *If you exceed the allowable resolution or bitrate, the stream
|
1131
|
-
# probably will disconnect immediately
|
1361
|
+
# probably will disconnect immediately*. Valid values:
|
1132
1362
|
#
|
1133
1363
|
# * `STANDARD`\: Multiple qualities are generated from the original
|
1134
1364
|
# input, to automatically give viewers the best experience for their
|
@@ -1140,10 +1370,13 @@ module Aws::IVS
|
|
1140
1370
|
# Vertical resolution can be up to 480 and bitrate can be up to 1.5
|
1141
1371
|
# Mbps.
|
1142
1372
|
#
|
1143
|
-
# Default: `STANDARD`.
|
1144
|
-
#
|
1145
1373
|
# @option params [Boolean] :authorized
|
1146
|
-
# Whether the channel is
|
1374
|
+
# Whether the channel is private (enabled for playback authorization).
|
1375
|
+
#
|
1376
|
+
# @option params [String] :recording_configuration_arn
|
1377
|
+
# Recording-configuration ARN. If this is set to an empty string,
|
1378
|
+
# recording is disabled. A value other than an empty string indicates
|
1379
|
+
# that recording is enabled
|
1147
1380
|
#
|
1148
1381
|
# @return [Types::UpdateChannelResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1149
1382
|
#
|
@@ -1157,6 +1390,7 @@ module Aws::IVS
|
|
1157
1390
|
# latency_mode: "NORMAL", # accepts NORMAL, LOW
|
1158
1391
|
# type: "BASIC", # accepts BASIC, STANDARD
|
1159
1392
|
# authorized: false,
|
1393
|
+
# recording_configuration_arn: "ChannelRecordingConfigurationArn",
|
1160
1394
|
# })
|
1161
1395
|
#
|
1162
1396
|
# @example Response structure
|
@@ -1165,6 +1399,7 @@ module Aws::IVS
|
|
1165
1399
|
# resp.channel.name #=> String
|
1166
1400
|
# resp.channel.latency_mode #=> String, one of "NORMAL", "LOW"
|
1167
1401
|
# resp.channel.type #=> String, one of "BASIC", "STANDARD"
|
1402
|
+
# resp.channel.recording_configuration_arn #=> String
|
1168
1403
|
# resp.channel.ingest_endpoint #=> String
|
1169
1404
|
# resp.channel.playback_url #=> String
|
1170
1405
|
# resp.channel.authorized #=> Boolean
|
@@ -1193,7 +1428,7 @@ module Aws::IVS
|
|
1193
1428
|
params: params,
|
1194
1429
|
config: config)
|
1195
1430
|
context[:gem_name] = 'aws-sdk-ivs'
|
1196
|
-
context[:gem_version] = '1.
|
1431
|
+
context[:gem_version] = '1.9.0'
|
1197
1432
|
Seahorse::Client::Request.new(handlers, context)
|
1198
1433
|
end
|
1199
1434
|
|