aws-sdk-ivs 1.12.0 → 1.13.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 +133 -146
- data/lib/aws-sdk-ivs/client_api.rb +78 -88
- data/lib/aws-sdk-ivs/types.rb +236 -256
- data/lib/aws-sdk-ivs.rb +1 -1
- metadata +4 -4
data/lib/aws-sdk-ivs/client.rb
CHANGED
@@ -347,15 +347,15 @@ module Aws::IVS
|
|
347
347
|
#
|
348
348
|
# resp.channels #=> Array
|
349
349
|
# resp.channels[0].arn #=> String
|
350
|
-
# resp.channels[0].
|
351
|
-
# resp.channels[0].latency_mode #=> String, one of "NORMAL", "LOW"
|
352
|
-
# resp.channels[0].type #=> String, one of "BASIC", "STANDARD"
|
353
|
-
# resp.channels[0].recording_configuration_arn #=> String
|
350
|
+
# resp.channels[0].authorized #=> Boolean
|
354
351
|
# resp.channels[0].ingest_endpoint #=> String
|
352
|
+
# resp.channels[0].latency_mode #=> String, one of "NORMAL", "LOW"
|
353
|
+
# resp.channels[0].name #=> String
|
355
354
|
# resp.channels[0].playback_url #=> String
|
356
|
-
# resp.channels[0].
|
355
|
+
# resp.channels[0].recording_configuration_arn #=> String
|
357
356
|
# resp.channels[0].tags #=> Hash
|
358
357
|
# resp.channels[0].tags["TagKey"] #=> String
|
358
|
+
# resp.channels[0].type #=> String, one of "BASIC", "STANDARD"
|
359
359
|
# resp.errors #=> Array
|
360
360
|
# resp.errors[0].arn #=> String
|
361
361
|
# resp.errors[0].code #=> String
|
@@ -377,8 +377,8 @@ module Aws::IVS
|
|
377
377
|
#
|
378
378
|
# @return [Types::BatchGetStreamKeyResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
379
379
|
#
|
380
|
-
# * {Types::BatchGetStreamKeyResponse#stream_keys #stream_keys} => Array<Types::StreamKey>
|
381
380
|
# * {Types::BatchGetStreamKeyResponse#errors #errors} => Array<Types::BatchError>
|
381
|
+
# * {Types::BatchGetStreamKeyResponse#stream_keys #stream_keys} => Array<Types::StreamKey>
|
382
382
|
#
|
383
383
|
# @example Request syntax with placeholder values
|
384
384
|
#
|
@@ -388,16 +388,16 @@ module Aws::IVS
|
|
388
388
|
#
|
389
389
|
# @example Response structure
|
390
390
|
#
|
391
|
+
# resp.errors #=> Array
|
392
|
+
# resp.errors[0].arn #=> String
|
393
|
+
# resp.errors[0].code #=> String
|
394
|
+
# resp.errors[0].message #=> String
|
391
395
|
# resp.stream_keys #=> Array
|
392
396
|
# resp.stream_keys[0].arn #=> String
|
393
|
-
# resp.stream_keys[0].value #=> String
|
394
397
|
# resp.stream_keys[0].channel_arn #=> String
|
395
398
|
# resp.stream_keys[0].tags #=> Hash
|
396
399
|
# resp.stream_keys[0].tags["TagKey"] #=> String
|
397
|
-
# resp.
|
398
|
-
# resp.errors[0].arn #=> String
|
399
|
-
# resp.errors[0].code #=> String
|
400
|
-
# resp.errors[0].message #=> String
|
400
|
+
# resp.stream_keys[0].value #=> String
|
401
401
|
#
|
402
402
|
# @see http://docs.aws.amazon.com/goto/WebAPI/ivs-2020-07-14/BatchGetStreamKey AWS API Documentation
|
403
403
|
#
|
@@ -410,8 +410,9 @@ module Aws::IVS
|
|
410
410
|
|
411
411
|
# Creates a new channel and an associated stream key to start streaming.
|
412
412
|
#
|
413
|
-
# @option params [
|
414
|
-
#
|
413
|
+
# @option params [Boolean] :authorized
|
414
|
+
# Whether the channel is private (enabled for playback authorization).
|
415
|
+
# Default: `false`.
|
415
416
|
#
|
416
417
|
# @option params [String] :latency_mode
|
417
418
|
# Channel latency mode. Use `NORMAL` to broadcast and deliver live video
|
@@ -419,6 +420,16 @@ module Aws::IVS
|
|
419
420
|
# (Note: In the Amazon IVS console, `LOW` and `NORMAL` correspond to
|
420
421
|
# Ultra-low and Standard, respectively.) Default: `LOW`.
|
421
422
|
#
|
423
|
+
# @option params [String] :name
|
424
|
+
# Channel name.
|
425
|
+
#
|
426
|
+
# @option params [String] :recording_configuration_arn
|
427
|
+
# Recording-configuration ARN. Default: "" (empty string, recording is
|
428
|
+
# disabled).
|
429
|
+
#
|
430
|
+
# @option params [Hash<String,String>] :tags
|
431
|
+
# Array of 1-50 maps, each of the form `string:string (key:value)`.
|
432
|
+
#
|
422
433
|
# @option params [String] :type
|
423
434
|
# Channel type, which determines the allowable resolution and bitrate.
|
424
435
|
# *If you exceed the allowable resolution or bitrate, the stream
|
@@ -427,24 +438,13 @@ module Aws::IVS
|
|
427
438
|
#
|
428
439
|
# * `STANDARD`\: Multiple qualities are generated from the original
|
429
440
|
# input, to automatically give viewers the best experience for their
|
430
|
-
# devices and network conditions.
|
431
|
-
#
|
441
|
+
# devices and network conditions. Resolution can be up to 1080p and
|
442
|
+
# bitrate can be up to 8.5 Mbps. Audio is transcoded only for
|
443
|
+
# renditions 360p and below; above that, audio is passed through.
|
432
444
|
#
|
433
445
|
# * `BASIC`\: Amazon IVS delivers the original input to viewers. The
|
434
446
|
# viewer’s video-quality choice is limited to the original input.
|
435
|
-
#
|
436
|
-
# Mbps.
|
437
|
-
#
|
438
|
-
# @option params [Boolean] :authorized
|
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).
|
445
|
-
#
|
446
|
-
# @option params [Hash<String,String>] :tags
|
447
|
-
# Array of 1-50 maps, each of the form `string:string (key:value)`.
|
447
|
+
# Resolution can be up to 480p and bitrate can be up to 1.5 Mbps.
|
448
448
|
#
|
449
449
|
# @return [Types::CreateChannelResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
450
450
|
#
|
@@ -454,33 +454,33 @@ module Aws::IVS
|
|
454
454
|
# @example Request syntax with placeholder values
|
455
455
|
#
|
456
456
|
# resp = client.create_channel({
|
457
|
-
# name: "ChannelName",
|
458
|
-
# latency_mode: "NORMAL", # accepts NORMAL, LOW
|
459
|
-
# type: "BASIC", # accepts BASIC, STANDARD
|
460
457
|
# authorized: false,
|
458
|
+
# latency_mode: "NORMAL", # accepts NORMAL, LOW
|
459
|
+
# name: "ChannelName",
|
461
460
|
# recording_configuration_arn: "ChannelRecordingConfigurationArn",
|
462
461
|
# tags: {
|
463
462
|
# "TagKey" => "TagValue",
|
464
463
|
# },
|
464
|
+
# type: "BASIC", # accepts BASIC, STANDARD
|
465
465
|
# })
|
466
466
|
#
|
467
467
|
# @example Response structure
|
468
468
|
#
|
469
469
|
# resp.channel.arn #=> String
|
470
|
-
# resp.channel.
|
471
|
-
# resp.channel.latency_mode #=> String, one of "NORMAL", "LOW"
|
472
|
-
# resp.channel.type #=> String, one of "BASIC", "STANDARD"
|
473
|
-
# resp.channel.recording_configuration_arn #=> String
|
470
|
+
# resp.channel.authorized #=> Boolean
|
474
471
|
# resp.channel.ingest_endpoint #=> String
|
472
|
+
# resp.channel.latency_mode #=> String, one of "NORMAL", "LOW"
|
473
|
+
# resp.channel.name #=> String
|
475
474
|
# resp.channel.playback_url #=> String
|
476
|
-
# resp.channel.
|
475
|
+
# resp.channel.recording_configuration_arn #=> String
|
477
476
|
# resp.channel.tags #=> Hash
|
478
477
|
# resp.channel.tags["TagKey"] #=> String
|
478
|
+
# resp.channel.type #=> String, one of "BASIC", "STANDARD"
|
479
479
|
# resp.stream_key.arn #=> String
|
480
|
-
# resp.stream_key.value #=> String
|
481
480
|
# resp.stream_key.channel_arn #=> String
|
482
481
|
# resp.stream_key.tags #=> Hash
|
483
482
|
# resp.stream_key.tags["TagKey"] #=> String
|
483
|
+
# resp.stream_key.value #=> String
|
484
484
|
#
|
485
485
|
# @see http://docs.aws.amazon.com/goto/WebAPI/ivs-2020-07-14/CreateChannel AWS API Documentation
|
486
486
|
#
|
@@ -494,12 +494,12 @@ module Aws::IVS
|
|
494
494
|
# Creates a new recording configuration, used to enable recording to
|
495
495
|
# Amazon S3.
|
496
496
|
#
|
497
|
-
# **Known issue:** In the us-east-1 region, if you use the
|
498
|
-
# create a recording configuration, it returns success
|
499
|
-
# bucket is in a different region. In this case, the
|
500
|
-
# recording configuration is `CREATE_FAILED` (instead of
|
501
|
-
# other regions, the CLI correctly returns failure if the
|
502
|
-
# different region.)
|
497
|
+
# **Known issue:** In the us-east-1 region, if you use the Amazon Web
|
498
|
+
# Services CLI to create a recording configuration, it returns success
|
499
|
+
# even if the S3 bucket is in a different region. In this case, the
|
500
|
+
# `state` of the recording configuration is `CREATE_FAILED` (instead of
|
501
|
+
# `ACTIVE`). (In other regions, the CLI correctly returns failure if the
|
502
|
+
# bucket is in a different region.)
|
503
503
|
#
|
504
504
|
# **Workaround:** Ensure that your S3 bucket is in the same region as
|
505
505
|
# the recording configuration. If you create a recording configuration
|
@@ -507,14 +507,13 @@ module Aws::IVS
|
|
507
507
|
# configuration and create a new one with an S3 bucket from the correct
|
508
508
|
# region.
|
509
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
510
|
# @option params [required, Types::DestinationConfiguration] :destination_configuration
|
515
511
|
# A complex type that contains a destination configuration for where
|
516
512
|
# recorded video will be stored.
|
517
513
|
#
|
514
|
+
# @option params [String] :name
|
515
|
+
# Recording-configuration name. The value does not need to be unique.
|
516
|
+
#
|
518
517
|
# @option params [Hash<String,String>] :tags
|
519
518
|
# Array of 1-50 maps, each of the form `string:string (key:value)`.
|
520
519
|
#
|
@@ -525,12 +524,12 @@ module Aws::IVS
|
|
525
524
|
# @example Request syntax with placeholder values
|
526
525
|
#
|
527
526
|
# resp = client.create_recording_configuration({
|
528
|
-
# name: "RecordingConfigurationName",
|
529
527
|
# destination_configuration: { # required
|
530
528
|
# s3: {
|
531
529
|
# bucket_name: "S3DestinationBucketName", # required
|
532
530
|
# },
|
533
531
|
# },
|
532
|
+
# name: "RecordingConfigurationName",
|
534
533
|
# tags: {
|
535
534
|
# "TagKey" => "TagValue",
|
536
535
|
# },
|
@@ -539,8 +538,8 @@ module Aws::IVS
|
|
539
538
|
# @example Response structure
|
540
539
|
#
|
541
540
|
# resp.recording_configuration.arn #=> String
|
542
|
-
# resp.recording_configuration.name #=> String
|
543
541
|
# resp.recording_configuration.destination_configuration.s3.bucket_name #=> String
|
542
|
+
# resp.recording_configuration.name #=> String
|
544
543
|
# resp.recording_configuration.state #=> String, one of "CREATING", "CREATE_FAILED", "ACTIVE"
|
545
544
|
# resp.recording_configuration.tags #=> Hash
|
546
545
|
# resp.recording_configuration.tags["TagKey"] #=> String
|
@@ -585,10 +584,10 @@ module Aws::IVS
|
|
585
584
|
# @example Response structure
|
586
585
|
#
|
587
586
|
# resp.stream_key.arn #=> String
|
588
|
-
# resp.stream_key.value #=> String
|
589
587
|
# resp.stream_key.channel_arn #=> String
|
590
588
|
# resp.stream_key.tags #=> Hash
|
591
589
|
# resp.stream_key.tags["TagKey"] #=> String
|
590
|
+
# resp.stream_key.value #=> String
|
592
591
|
#
|
593
592
|
# @see http://docs.aws.amazon.com/goto/WebAPI/ivs-2020-07-14/CreateStreamKey AWS API Documentation
|
594
593
|
#
|
@@ -730,15 +729,15 @@ module Aws::IVS
|
|
730
729
|
# @example Response structure
|
731
730
|
#
|
732
731
|
# resp.channel.arn #=> String
|
733
|
-
# resp.channel.
|
734
|
-
# resp.channel.latency_mode #=> String, one of "NORMAL", "LOW"
|
735
|
-
# resp.channel.type #=> String, one of "BASIC", "STANDARD"
|
736
|
-
# resp.channel.recording_configuration_arn #=> String
|
732
|
+
# resp.channel.authorized #=> Boolean
|
737
733
|
# resp.channel.ingest_endpoint #=> String
|
734
|
+
# resp.channel.latency_mode #=> String, one of "NORMAL", "LOW"
|
735
|
+
# resp.channel.name #=> String
|
738
736
|
# resp.channel.playback_url #=> String
|
739
|
-
# resp.channel.
|
737
|
+
# resp.channel.recording_configuration_arn #=> String
|
740
738
|
# resp.channel.tags #=> Hash
|
741
739
|
# resp.channel.tags["TagKey"] #=> String
|
740
|
+
# resp.channel.type #=> String, one of "BASIC", "STANDARD"
|
742
741
|
#
|
743
742
|
# @see http://docs.aws.amazon.com/goto/WebAPI/ivs-2020-07-14/GetChannel AWS API Documentation
|
744
743
|
#
|
@@ -775,8 +774,8 @@ module Aws::IVS
|
|
775
774
|
# @example Response structure
|
776
775
|
#
|
777
776
|
# resp.key_pair.arn #=> String
|
778
|
-
# resp.key_pair.name #=> String
|
779
777
|
# resp.key_pair.fingerprint #=> String
|
778
|
+
# resp.key_pair.name #=> String
|
780
779
|
# resp.key_pair.tags #=> Hash
|
781
780
|
# resp.key_pair.tags["TagKey"] #=> String
|
782
781
|
#
|
@@ -807,8 +806,8 @@ module Aws::IVS
|
|
807
806
|
# @example Response structure
|
808
807
|
#
|
809
808
|
# resp.recording_configuration.arn #=> String
|
810
|
-
# resp.recording_configuration.name #=> String
|
811
809
|
# resp.recording_configuration.destination_configuration.s3.bucket_name #=> String
|
810
|
+
# resp.recording_configuration.name #=> String
|
812
811
|
# resp.recording_configuration.state #=> String, one of "CREATING", "CREATE_FAILED", "ACTIVE"
|
813
812
|
# resp.recording_configuration.tags #=> Hash
|
814
813
|
# resp.recording_configuration.tags["TagKey"] #=> String
|
@@ -841,10 +840,10 @@ module Aws::IVS
|
|
841
840
|
# @example Response structure
|
842
841
|
#
|
843
842
|
# resp.stream.channel_arn #=> String
|
843
|
+
# resp.stream.health #=> String, one of "HEALTHY", "STARVING", "UNKNOWN"
|
844
844
|
# resp.stream.playback_url #=> String
|
845
845
|
# resp.stream.start_time #=> Time
|
846
846
|
# resp.stream.state #=> String, one of "LIVE", "OFFLINE"
|
847
|
-
# resp.stream.health #=> String, one of "HEALTHY", "STARVING", "UNKNOWN"
|
848
847
|
# resp.stream.viewer_count #=> Integer
|
849
848
|
#
|
850
849
|
# @see http://docs.aws.amazon.com/goto/WebAPI/ivs-2020-07-14/GetStream AWS API Documentation
|
@@ -874,10 +873,10 @@ module Aws::IVS
|
|
874
873
|
# @example Response structure
|
875
874
|
#
|
876
875
|
# resp.stream_key.arn #=> String
|
877
|
-
# resp.stream_key.value #=> String
|
878
876
|
# resp.stream_key.channel_arn #=> String
|
879
877
|
# resp.stream_key.tags #=> Hash
|
880
878
|
# resp.stream_key.tags["TagKey"] #=> String
|
879
|
+
# resp.stream_key.value #=> String
|
881
880
|
#
|
882
881
|
# @see http://docs.aws.amazon.com/goto/WebAPI/ivs-2020-07-14/GetStreamKey AWS API Documentation
|
883
882
|
#
|
@@ -898,14 +897,12 @@ module Aws::IVS
|
|
898
897
|
#
|
899
898
|
# [1]: https://docs.aws.amazon.com/ivs/latest/userguide/private-channels.html
|
900
899
|
#
|
900
|
+
# @option params [String] :name
|
901
|
+
# Playback-key-pair name. The value does not need to be unique.
|
902
|
+
#
|
901
903
|
# @option params [required, String] :public_key_material
|
902
904
|
# The public portion of a customer-generated key pair.
|
903
905
|
#
|
904
|
-
# @option params [String] :name
|
905
|
-
# An arbitrary string (a nickname) assigned to a playback key pair that
|
906
|
-
# helps the customer identify that resource. The value does not need to
|
907
|
-
# be unique.
|
908
|
-
#
|
909
906
|
# @option params [Hash<String,String>] :tags
|
910
907
|
# Any tags provided with the request are added to the playback key pair
|
911
908
|
# tags.
|
@@ -917,8 +914,8 @@ module Aws::IVS
|
|
917
914
|
# @example Request syntax with placeholder values
|
918
915
|
#
|
919
916
|
# resp = client.import_playback_key_pair({
|
920
|
-
# public_key_material: "PlaybackPublicKeyMaterial", # required
|
921
917
|
# name: "PlaybackKeyPairName",
|
918
|
+
# public_key_material: "PlaybackPublicKeyMaterial", # required
|
922
919
|
# tags: {
|
923
920
|
# "TagKey" => "TagValue",
|
924
921
|
# },
|
@@ -927,8 +924,8 @@ module Aws::IVS
|
|
927
924
|
# @example Response structure
|
928
925
|
#
|
929
926
|
# resp.key_pair.arn #=> String
|
930
|
-
# resp.key_pair.name #=> String
|
931
927
|
# resp.key_pair.fingerprint #=> String
|
928
|
+
# resp.key_pair.name #=> String
|
932
929
|
# resp.key_pair.tags #=> Hash
|
933
930
|
# resp.key_pair.tags["TagKey"] #=> String
|
934
931
|
#
|
@@ -942,10 +939,11 @@ module Aws::IVS
|
|
942
939
|
end
|
943
940
|
|
944
941
|
# Gets summary information about all channels in your account, in the
|
945
|
-
#
|
946
|
-
# filtered to match a specified name or
|
947
|
-
# Filters are mutually exclusive and cannot
|
948
|
-
# to use both filters, you will get an
|
942
|
+
# Amazon Web Services region where the API request is processed. This
|
943
|
+
# list can be filtered to match a specified name or
|
944
|
+
# recording-configuration ARN. Filters are mutually exclusive and cannot
|
945
|
+
# be used together. If you try to use both filters, you will get an
|
946
|
+
# error (409 ConflictException).
|
949
947
|
#
|
950
948
|
# @option params [String] :filter_by_name
|
951
949
|
# Filters the channel list to match the specified name.
|
@@ -954,13 +952,13 @@ module Aws::IVS
|
|
954
952
|
# Filters the channel list to match the specified
|
955
953
|
# recording-configuration ARN.
|
956
954
|
#
|
955
|
+
# @option params [Integer] :max_results
|
956
|
+
# Maximum number of channels to return. Default: 50.
|
957
|
+
#
|
957
958
|
# @option params [String] :next_token
|
958
959
|
# The first channel to retrieve. This is used for pagination; see the
|
959
960
|
# `nextToken` response field.
|
960
961
|
#
|
961
|
-
# @option params [Integer] :max_results
|
962
|
-
# Maximum number of channels to return. Default: 50.
|
963
|
-
#
|
964
962
|
# @return [Types::ListChannelsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
965
963
|
#
|
966
964
|
# * {Types::ListChannelsResponse#channels #channels} => Array<Types::ChannelSummary>
|
@@ -973,17 +971,17 @@ module Aws::IVS
|
|
973
971
|
# resp = client.list_channels({
|
974
972
|
# filter_by_name: "ChannelName",
|
975
973
|
# filter_by_recording_configuration_arn: "ChannelRecordingConfigurationArn",
|
976
|
-
# next_token: "PaginationToken",
|
977
974
|
# max_results: 1,
|
975
|
+
# next_token: "PaginationToken",
|
978
976
|
# })
|
979
977
|
#
|
980
978
|
# @example Response structure
|
981
979
|
#
|
982
980
|
# resp.channels #=> Array
|
983
981
|
# resp.channels[0].arn #=> String
|
984
|
-
# resp.channels[0].name #=> String
|
985
|
-
# resp.channels[0].latency_mode #=> String, one of "NORMAL", "LOW"
|
986
982
|
# resp.channels[0].authorized #=> Boolean
|
983
|
+
# resp.channels[0].latency_mode #=> String, one of "NORMAL", "LOW"
|
984
|
+
# resp.channels[0].name #=> String
|
987
985
|
# resp.channels[0].recording_configuration_arn #=> String
|
988
986
|
# resp.channels[0].tags #=> Hash
|
989
987
|
# resp.channels[0].tags["TagKey"] #=> String
|
@@ -1006,13 +1004,13 @@ module Aws::IVS
|
|
1006
1004
|
#
|
1007
1005
|
# [1]: https://docs.aws.amazon.com/ivs/latest/userguide/private-channels.html
|
1008
1006
|
#
|
1009
|
-
# @option params [String] :next_token
|
1010
|
-
# Maximum number of key pairs to return.
|
1011
|
-
#
|
1012
1007
|
# @option params [Integer] :max_results
|
1013
1008
|
# The first key pair to retrieve. This is used for pagination; see the
|
1014
1009
|
# `nextToken` response field. Default: 50.
|
1015
1010
|
#
|
1011
|
+
# @option params [String] :next_token
|
1012
|
+
# Maximum number of key pairs to return.
|
1013
|
+
#
|
1016
1014
|
# @return [Types::ListPlaybackKeyPairsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1017
1015
|
#
|
1018
1016
|
# * {Types::ListPlaybackKeyPairsResponse#key_pairs #key_pairs} => Array<Types::PlaybackKeyPairSummary>
|
@@ -1023,8 +1021,8 @@ module Aws::IVS
|
|
1023
1021
|
# @example Request syntax with placeholder values
|
1024
1022
|
#
|
1025
1023
|
# resp = client.list_playback_key_pairs({
|
1026
|
-
# next_token: "PaginationToken",
|
1027
1024
|
# max_results: 1,
|
1025
|
+
# next_token: "PaginationToken",
|
1028
1026
|
# })
|
1029
1027
|
#
|
1030
1028
|
# @example Response structure
|
@@ -1046,39 +1044,40 @@ module Aws::IVS
|
|
1046
1044
|
end
|
1047
1045
|
|
1048
1046
|
# Gets summary information about all recording configurations in your
|
1049
|
-
# account, in the
|
1047
|
+
# account, in the Amazon Web Services region where the API request is
|
1048
|
+
# processed.
|
1049
|
+
#
|
1050
|
+
# @option params [Integer] :max_results
|
1051
|
+
# Maximum number of recording configurations to return. Default: 50.
|
1050
1052
|
#
|
1051
1053
|
# @option params [String] :next_token
|
1052
1054
|
# The first recording configuration to retrieve. This is used for
|
1053
1055
|
# pagination; see the `nextToken` response field.
|
1054
1056
|
#
|
1055
|
-
# @option params [Integer] :max_results
|
1056
|
-
# Maximum number of recording configurations to return. Default: 50.
|
1057
|
-
#
|
1058
1057
|
# @return [Types::ListRecordingConfigurationsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1059
1058
|
#
|
1060
|
-
# * {Types::ListRecordingConfigurationsResponse#recording_configurations #recording_configurations} => Array<Types::RecordingConfigurationSummary>
|
1061
1059
|
# * {Types::ListRecordingConfigurationsResponse#next_token #next_token} => String
|
1060
|
+
# * {Types::ListRecordingConfigurationsResponse#recording_configurations #recording_configurations} => Array<Types::RecordingConfigurationSummary>
|
1062
1061
|
#
|
1063
1062
|
# The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
|
1064
1063
|
#
|
1065
1064
|
# @example Request syntax with placeholder values
|
1066
1065
|
#
|
1067
1066
|
# resp = client.list_recording_configurations({
|
1068
|
-
# next_token: "PaginationToken",
|
1069
1067
|
# max_results: 1,
|
1068
|
+
# next_token: "PaginationToken",
|
1070
1069
|
# })
|
1071
1070
|
#
|
1072
1071
|
# @example Response structure
|
1073
1072
|
#
|
1073
|
+
# resp.next_token #=> String
|
1074
1074
|
# resp.recording_configurations #=> Array
|
1075
1075
|
# resp.recording_configurations[0].arn #=> String
|
1076
|
-
# resp.recording_configurations[0].name #=> String
|
1077
1076
|
# resp.recording_configurations[0].destination_configuration.s3.bucket_name #=> String
|
1077
|
+
# resp.recording_configurations[0].name #=> String
|
1078
1078
|
# resp.recording_configurations[0].state #=> String, one of "CREATING", "CREATE_FAILED", "ACTIVE"
|
1079
1079
|
# resp.recording_configurations[0].tags #=> Hash
|
1080
1080
|
# resp.recording_configurations[0].tags["TagKey"] #=> String
|
1081
|
-
# resp.next_token #=> String
|
1082
1081
|
#
|
1083
1082
|
# @see http://docs.aws.amazon.com/goto/WebAPI/ivs-2020-07-14/ListRecordingConfigurations AWS API Documentation
|
1084
1083
|
#
|
@@ -1094,17 +1093,17 @@ module Aws::IVS
|
|
1094
1093
|
# @option params [required, String] :channel_arn
|
1095
1094
|
# Channel ARN used to filter the list.
|
1096
1095
|
#
|
1096
|
+
# @option params [Integer] :max_results
|
1097
|
+
# Maximum number of streamKeys to return. Default: 50.
|
1098
|
+
#
|
1097
1099
|
# @option params [String] :next_token
|
1098
1100
|
# The first stream key to retrieve. This is used for pagination; see the
|
1099
1101
|
# `nextToken` response field.
|
1100
1102
|
#
|
1101
|
-
# @option params [Integer] :max_results
|
1102
|
-
# Maximum number of streamKeys to return. Default: 50.
|
1103
|
-
#
|
1104
1103
|
# @return [Types::ListStreamKeysResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1105
1104
|
#
|
1106
|
-
# * {Types::ListStreamKeysResponse#stream_keys #stream_keys} => Array<Types::StreamKeySummary>
|
1107
1105
|
# * {Types::ListStreamKeysResponse#next_token #next_token} => String
|
1106
|
+
# * {Types::ListStreamKeysResponse#stream_keys #stream_keys} => Array<Types::StreamKeySummary>
|
1108
1107
|
#
|
1109
1108
|
# The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
|
1110
1109
|
#
|
@@ -1112,18 +1111,18 @@ module Aws::IVS
|
|
1112
1111
|
#
|
1113
1112
|
# resp = client.list_stream_keys({
|
1114
1113
|
# channel_arn: "ChannelArn", # required
|
1115
|
-
# next_token: "PaginationToken",
|
1116
1114
|
# max_results: 1,
|
1115
|
+
# next_token: "PaginationToken",
|
1117
1116
|
# })
|
1118
1117
|
#
|
1119
1118
|
# @example Response structure
|
1120
1119
|
#
|
1120
|
+
# resp.next_token #=> String
|
1121
1121
|
# resp.stream_keys #=> Array
|
1122
1122
|
# resp.stream_keys[0].arn #=> String
|
1123
1123
|
# resp.stream_keys[0].channel_arn #=> String
|
1124
1124
|
# resp.stream_keys[0].tags #=> Hash
|
1125
1125
|
# resp.stream_keys[0].tags["TagKey"] #=> String
|
1126
|
-
# resp.next_token #=> String
|
1127
1126
|
#
|
1128
1127
|
# @see http://docs.aws.amazon.com/goto/WebAPI/ivs-2020-07-14/ListStreamKeys AWS API Documentation
|
1129
1128
|
#
|
@@ -1135,38 +1134,38 @@ module Aws::IVS
|
|
1135
1134
|
end
|
1136
1135
|
|
1137
1136
|
# Gets summary information about live streams in your account, in the
|
1138
|
-
#
|
1137
|
+
# Amazon Web Services region where the API request is processed.
|
1138
|
+
#
|
1139
|
+
# @option params [Integer] :max_results
|
1140
|
+
# Maximum number of streams to return. Default: 50.
|
1139
1141
|
#
|
1140
1142
|
# @option params [String] :next_token
|
1141
1143
|
# The first stream to retrieve. This is used for pagination; see the
|
1142
1144
|
# `nextToken` response field.
|
1143
1145
|
#
|
1144
|
-
# @option params [Integer] :max_results
|
1145
|
-
# Maximum number of streams to return. Default: 50.
|
1146
|
-
#
|
1147
1146
|
# @return [Types::ListStreamsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1148
1147
|
#
|
1149
|
-
# * {Types::ListStreamsResponse#streams #streams} => Array<Types::StreamSummary>
|
1150
1148
|
# * {Types::ListStreamsResponse#next_token #next_token} => String
|
1149
|
+
# * {Types::ListStreamsResponse#streams #streams} => Array<Types::StreamSummary>
|
1151
1150
|
#
|
1152
1151
|
# The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
|
1153
1152
|
#
|
1154
1153
|
# @example Request syntax with placeholder values
|
1155
1154
|
#
|
1156
1155
|
# resp = client.list_streams({
|
1157
|
-
# next_token: "PaginationToken",
|
1158
1156
|
# max_results: 1,
|
1157
|
+
# next_token: "PaginationToken",
|
1159
1158
|
# })
|
1160
1159
|
#
|
1161
1160
|
# @example Response structure
|
1162
1161
|
#
|
1162
|
+
# resp.next_token #=> String
|
1163
1163
|
# resp.streams #=> Array
|
1164
1164
|
# resp.streams[0].channel_arn #=> String
|
1165
|
-
# resp.streams[0].state #=> String, one of "LIVE", "OFFLINE"
|
1166
1165
|
# resp.streams[0].health #=> String, one of "HEALTHY", "STARVING", "UNKNOWN"
|
1167
|
-
# resp.streams[0].viewer_count #=> Integer
|
1168
1166
|
# resp.streams[0].start_time #=> Time
|
1169
|
-
# resp.
|
1167
|
+
# resp.streams[0].state #=> String, one of "LIVE", "OFFLINE"
|
1168
|
+
# resp.streams[0].viewer_count #=> Integer
|
1170
1169
|
#
|
1171
1170
|
# @see http://docs.aws.amazon.com/goto/WebAPI/ivs-2020-07-14/ListStreams AWS API Documentation
|
1172
1171
|
#
|
@@ -1177,38 +1176,25 @@ module Aws::IVS
|
|
1177
1176
|
req.send_request(options)
|
1178
1177
|
end
|
1179
1178
|
|
1180
|
-
# Gets information about
|
1179
|
+
# Gets information about Amazon Web Services tags for the specified ARN.
|
1181
1180
|
#
|
1182
1181
|
# @option params [required, String] :resource_arn
|
1183
1182
|
# The ARN of the resource to be retrieved.
|
1184
1183
|
#
|
1185
|
-
# @option params [String] :next_token
|
1186
|
-
# The first tag to retrieve. This is used for pagination; see the
|
1187
|
-
# `nextToken` response field.
|
1188
|
-
#
|
1189
|
-
# @option params [Integer] :max_results
|
1190
|
-
# Maximum number of tags to return. Default: 50.
|
1191
|
-
#
|
1192
1184
|
# @return [Types::ListTagsForResourceResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1193
1185
|
#
|
1194
1186
|
# * {Types::ListTagsForResourceResponse#tags #tags} => Hash<String,String>
|
1195
|
-
# * {Types::ListTagsForResourceResponse#next_token #next_token} => String
|
1196
|
-
#
|
1197
|
-
# The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
|
1198
1187
|
#
|
1199
1188
|
# @example Request syntax with placeholder values
|
1200
1189
|
#
|
1201
1190
|
# resp = client.list_tags_for_resource({
|
1202
1191
|
# resource_arn: "ResourceArn", # required
|
1203
|
-
# next_token: "String",
|
1204
|
-
# max_results: 1,
|
1205
1192
|
# })
|
1206
1193
|
#
|
1207
1194
|
# @example Response structure
|
1208
1195
|
#
|
1209
1196
|
# resp.tags #=> Hash
|
1210
1197
|
# resp.tags["TagKey"] #=> String
|
1211
|
-
# resp.next_token #=> String
|
1212
1198
|
#
|
1213
1199
|
# @see http://docs.aws.amazon.com/goto/WebAPI/ivs-2020-07-14/ListTagsForResource AWS API Documentation
|
1214
1200
|
#
|
@@ -1219,12 +1205,12 @@ module Aws::IVS
|
|
1219
1205
|
req.send_request(options)
|
1220
1206
|
end
|
1221
1207
|
|
1222
|
-
# Inserts metadata into the active stream of the specified channel.
|
1223
|
-
#
|
1208
|
+
# Inserts metadata into the active stream of the specified channel. At
|
1209
|
+
# most 5 requests per second per channel are allowed, each with a
|
1224
1210
|
# maximum 1 KB payload. (If 5 TPS is not sufficient for your needs, we
|
1225
|
-
# recommend batching your data into a single PutMetadata call.)
|
1226
|
-
#
|
1227
|
-
# Guide*.
|
1211
|
+
# recommend batching your data into a single PutMetadata call.) At most
|
1212
|
+
# 155 requests per second per account are allowed. Also see [Embedding
|
1213
|
+
# Metadata within a Video Stream][1] in the *Amazon IVS User Guide*.
|
1228
1214
|
#
|
1229
1215
|
#
|
1230
1216
|
#
|
@@ -1285,7 +1271,8 @@ module Aws::IVS
|
|
1285
1271
|
req.send_request(options)
|
1286
1272
|
end
|
1287
1273
|
|
1288
|
-
# Adds or updates tags for the
|
1274
|
+
# Adds or updates tags for the Amazon Web Services resource with the
|
1275
|
+
# specified ARN.
|
1289
1276
|
#
|
1290
1277
|
# @option params [required, String] :resource_arn
|
1291
1278
|
# ARN of the resource for which tags are to be added or updated.
|
@@ -1346,8 +1333,8 @@ module Aws::IVS
|
|
1346
1333
|
# @option params [required, String] :arn
|
1347
1334
|
# ARN of the channel to be updated.
|
1348
1335
|
#
|
1349
|
-
# @option params [
|
1350
|
-
#
|
1336
|
+
# @option params [Boolean] :authorized
|
1337
|
+
# Whether the channel is private (enabled for playback authorization).
|
1351
1338
|
#
|
1352
1339
|
# @option params [String] :latency_mode
|
1353
1340
|
# Channel latency mode. Use `NORMAL` to broadcast and deliver live video
|
@@ -1355,6 +1342,14 @@ module Aws::IVS
|
|
1355
1342
|
# (Note: In the Amazon IVS console, `LOW` and `NORMAL` correspond to
|
1356
1343
|
# Ultra-low and Standard, respectively.)
|
1357
1344
|
#
|
1345
|
+
# @option params [String] :name
|
1346
|
+
# Channel name.
|
1347
|
+
#
|
1348
|
+
# @option params [String] :recording_configuration_arn
|
1349
|
+
# Recording-configuration ARN. If this is set to an empty string,
|
1350
|
+
# recording is disabled. A value other than an empty string indicates
|
1351
|
+
# that recording is enabled
|
1352
|
+
#
|
1358
1353
|
# @option params [String] :type
|
1359
1354
|
# Channel type, which determines the allowable resolution and bitrate.
|
1360
1355
|
# *If you exceed the allowable resolution or bitrate, the stream
|
@@ -1362,21 +1357,13 @@ module Aws::IVS
|
|
1362
1357
|
#
|
1363
1358
|
# * `STANDARD`\: Multiple qualities are generated from the original
|
1364
1359
|
# input, to automatically give viewers the best experience for their
|
1365
|
-
# devices and network conditions.
|
1366
|
-
#
|
1360
|
+
# devices and network conditions. Resolution can be up to 1080p and
|
1361
|
+
# bitrate can be up to 8.5 Mbps. Audio is transcoded only for
|
1362
|
+
# renditions 360p and below; above that, audio is passed through.
|
1367
1363
|
#
|
1368
1364
|
# * `BASIC`\: Amazon IVS delivers the original input to viewers. The
|
1369
1365
|
# viewer’s video-quality choice is limited to the original input.
|
1370
|
-
#
|
1371
|
-
# Mbps.
|
1372
|
-
#
|
1373
|
-
# @option params [Boolean] :authorized
|
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
|
1366
|
+
# Resolution can be up to 480p and bitrate can be up to 1.5 Mbps.
|
1380
1367
|
#
|
1381
1368
|
# @return [Types::UpdateChannelResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1382
1369
|
#
|
@@ -1386,25 +1373,25 @@ module Aws::IVS
|
|
1386
1373
|
#
|
1387
1374
|
# resp = client.update_channel({
|
1388
1375
|
# arn: "ChannelArn", # required
|
1389
|
-
# name: "ChannelName",
|
1390
|
-
# latency_mode: "NORMAL", # accepts NORMAL, LOW
|
1391
|
-
# type: "BASIC", # accepts BASIC, STANDARD
|
1392
1376
|
# authorized: false,
|
1377
|
+
# latency_mode: "NORMAL", # accepts NORMAL, LOW
|
1378
|
+
# name: "ChannelName",
|
1393
1379
|
# recording_configuration_arn: "ChannelRecordingConfigurationArn",
|
1380
|
+
# type: "BASIC", # accepts BASIC, STANDARD
|
1394
1381
|
# })
|
1395
1382
|
#
|
1396
1383
|
# @example Response structure
|
1397
1384
|
#
|
1398
1385
|
# resp.channel.arn #=> String
|
1399
|
-
# resp.channel.
|
1400
|
-
# resp.channel.latency_mode #=> String, one of "NORMAL", "LOW"
|
1401
|
-
# resp.channel.type #=> String, one of "BASIC", "STANDARD"
|
1402
|
-
# resp.channel.recording_configuration_arn #=> String
|
1386
|
+
# resp.channel.authorized #=> Boolean
|
1403
1387
|
# resp.channel.ingest_endpoint #=> String
|
1388
|
+
# resp.channel.latency_mode #=> String, one of "NORMAL", "LOW"
|
1389
|
+
# resp.channel.name #=> String
|
1404
1390
|
# resp.channel.playback_url #=> String
|
1405
|
-
# resp.channel.
|
1391
|
+
# resp.channel.recording_configuration_arn #=> String
|
1406
1392
|
# resp.channel.tags #=> Hash
|
1407
1393
|
# resp.channel.tags["TagKey"] #=> String
|
1394
|
+
# resp.channel.type #=> String, one of "BASIC", "STANDARD"
|
1408
1395
|
#
|
1409
1396
|
# @see http://docs.aws.amazon.com/goto/WebAPI/ivs-2020-07-14/UpdateChannel AWS API Documentation
|
1410
1397
|
#
|
@@ -1428,7 +1415,7 @@ module Aws::IVS
|
|
1428
1415
|
params: params,
|
1429
1416
|
config: config)
|
1430
1417
|
context[:gem_name] = 'aws-sdk-ivs'
|
1431
|
-
context[:gem_version] = '1.
|
1418
|
+
context[:gem_version] = '1.13.0'
|
1432
1419
|
Seahorse::Client::Request.new(handlers, context)
|
1433
1420
|
end
|
1434
1421
|
|