aws-sdk-ivs 1.10.0 → 1.14.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 +20 -0
- data/VERSION +1 -1
- data/lib/aws-sdk-ivs/client.rb +142 -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 +5 -5
data/lib/aws-sdk-ivs/client.rb
CHANGED
@@ -275,6 +275,15 @@ module Aws::IVS
|
|
275
275
|
# ** Please note ** When response stubbing is enabled, no HTTP
|
276
276
|
# requests are made, and retries are disabled.
|
277
277
|
#
|
278
|
+
# @option options [Boolean] :use_dualstack_endpoint
|
279
|
+
# When set to `true`, dualstack enabled endpoints (with `.aws` TLD)
|
280
|
+
# will be used if available.
|
281
|
+
#
|
282
|
+
# @option options [Boolean] :use_fips_endpoint
|
283
|
+
# When set to `true`, fips compatible endpoints will be used if available.
|
284
|
+
# When a `fips` region is used, the region is normalized and this config
|
285
|
+
# is set to `true`.
|
286
|
+
#
|
278
287
|
# @option options [Boolean] :validate_params (true)
|
279
288
|
# When `true`, request parameters are validated before
|
280
289
|
# sending the request.
|
@@ -347,15 +356,15 @@ module Aws::IVS
|
|
347
356
|
#
|
348
357
|
# resp.channels #=> Array
|
349
358
|
# 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
|
359
|
+
# resp.channels[0].authorized #=> Boolean
|
354
360
|
# resp.channels[0].ingest_endpoint #=> String
|
361
|
+
# resp.channels[0].latency_mode #=> String, one of "NORMAL", "LOW"
|
362
|
+
# resp.channels[0].name #=> String
|
355
363
|
# resp.channels[0].playback_url #=> String
|
356
|
-
# resp.channels[0].
|
364
|
+
# resp.channels[0].recording_configuration_arn #=> String
|
357
365
|
# resp.channels[0].tags #=> Hash
|
358
366
|
# resp.channels[0].tags["TagKey"] #=> String
|
367
|
+
# resp.channels[0].type #=> String, one of "BASIC", "STANDARD"
|
359
368
|
# resp.errors #=> Array
|
360
369
|
# resp.errors[0].arn #=> String
|
361
370
|
# resp.errors[0].code #=> String
|
@@ -377,8 +386,8 @@ module Aws::IVS
|
|
377
386
|
#
|
378
387
|
# @return [Types::BatchGetStreamKeyResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
379
388
|
#
|
380
|
-
# * {Types::BatchGetStreamKeyResponse#stream_keys #stream_keys} => Array<Types::StreamKey>
|
381
389
|
# * {Types::BatchGetStreamKeyResponse#errors #errors} => Array<Types::BatchError>
|
390
|
+
# * {Types::BatchGetStreamKeyResponse#stream_keys #stream_keys} => Array<Types::StreamKey>
|
382
391
|
#
|
383
392
|
# @example Request syntax with placeholder values
|
384
393
|
#
|
@@ -388,16 +397,16 @@ module Aws::IVS
|
|
388
397
|
#
|
389
398
|
# @example Response structure
|
390
399
|
#
|
400
|
+
# resp.errors #=> Array
|
401
|
+
# resp.errors[0].arn #=> String
|
402
|
+
# resp.errors[0].code #=> String
|
403
|
+
# resp.errors[0].message #=> String
|
391
404
|
# resp.stream_keys #=> Array
|
392
405
|
# resp.stream_keys[0].arn #=> String
|
393
|
-
# resp.stream_keys[0].value #=> String
|
394
406
|
# resp.stream_keys[0].channel_arn #=> String
|
395
407
|
# resp.stream_keys[0].tags #=> Hash
|
396
408
|
# 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
|
409
|
+
# resp.stream_keys[0].value #=> String
|
401
410
|
#
|
402
411
|
# @see http://docs.aws.amazon.com/goto/WebAPI/ivs-2020-07-14/BatchGetStreamKey AWS API Documentation
|
403
412
|
#
|
@@ -410,8 +419,9 @@ module Aws::IVS
|
|
410
419
|
|
411
420
|
# Creates a new channel and an associated stream key to start streaming.
|
412
421
|
#
|
413
|
-
# @option params [
|
414
|
-
#
|
422
|
+
# @option params [Boolean] :authorized
|
423
|
+
# Whether the channel is private (enabled for playback authorization).
|
424
|
+
# Default: `false`.
|
415
425
|
#
|
416
426
|
# @option params [String] :latency_mode
|
417
427
|
# Channel latency mode. Use `NORMAL` to broadcast and deliver live video
|
@@ -419,6 +429,16 @@ module Aws::IVS
|
|
419
429
|
# (Note: In the Amazon IVS console, `LOW` and `NORMAL` correspond to
|
420
430
|
# Ultra-low and Standard, respectively.) Default: `LOW`.
|
421
431
|
#
|
432
|
+
# @option params [String] :name
|
433
|
+
# Channel name.
|
434
|
+
#
|
435
|
+
# @option params [String] :recording_configuration_arn
|
436
|
+
# Recording-configuration ARN. Default: "" (empty string, recording is
|
437
|
+
# disabled).
|
438
|
+
#
|
439
|
+
# @option params [Hash<String,String>] :tags
|
440
|
+
# Array of 1-50 maps, each of the form `string:string (key:value)`.
|
441
|
+
#
|
422
442
|
# @option params [String] :type
|
423
443
|
# Channel type, which determines the allowable resolution and bitrate.
|
424
444
|
# *If you exceed the allowable resolution or bitrate, the stream
|
@@ -427,24 +447,13 @@ module Aws::IVS
|
|
427
447
|
#
|
428
448
|
# * `STANDARD`\: Multiple qualities are generated from the original
|
429
449
|
# input, to automatically give viewers the best experience for their
|
430
|
-
# devices and network conditions.
|
431
|
-
#
|
450
|
+
# devices and network conditions. Resolution can be up to 1080p and
|
451
|
+
# bitrate can be up to 8.5 Mbps. Audio is transcoded only for
|
452
|
+
# renditions 360p and below; above that, audio is passed through.
|
432
453
|
#
|
433
454
|
# * `BASIC`\: Amazon IVS delivers the original input to viewers. The
|
434
455
|
# 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)`.
|
456
|
+
# Resolution can be up to 480p and bitrate can be up to 1.5 Mbps.
|
448
457
|
#
|
449
458
|
# @return [Types::CreateChannelResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
450
459
|
#
|
@@ -454,33 +463,33 @@ module Aws::IVS
|
|
454
463
|
# @example Request syntax with placeholder values
|
455
464
|
#
|
456
465
|
# resp = client.create_channel({
|
457
|
-
# name: "ChannelName",
|
458
|
-
# latency_mode: "NORMAL", # accepts NORMAL, LOW
|
459
|
-
# type: "BASIC", # accepts BASIC, STANDARD
|
460
466
|
# authorized: false,
|
467
|
+
# latency_mode: "NORMAL", # accepts NORMAL, LOW
|
468
|
+
# name: "ChannelName",
|
461
469
|
# recording_configuration_arn: "ChannelRecordingConfigurationArn",
|
462
470
|
# tags: {
|
463
471
|
# "TagKey" => "TagValue",
|
464
472
|
# },
|
473
|
+
# type: "BASIC", # accepts BASIC, STANDARD
|
465
474
|
# })
|
466
475
|
#
|
467
476
|
# @example Response structure
|
468
477
|
#
|
469
478
|
# 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
|
479
|
+
# resp.channel.authorized #=> Boolean
|
474
480
|
# resp.channel.ingest_endpoint #=> String
|
481
|
+
# resp.channel.latency_mode #=> String, one of "NORMAL", "LOW"
|
482
|
+
# resp.channel.name #=> String
|
475
483
|
# resp.channel.playback_url #=> String
|
476
|
-
# resp.channel.
|
484
|
+
# resp.channel.recording_configuration_arn #=> String
|
477
485
|
# resp.channel.tags #=> Hash
|
478
486
|
# resp.channel.tags["TagKey"] #=> String
|
487
|
+
# resp.channel.type #=> String, one of "BASIC", "STANDARD"
|
479
488
|
# resp.stream_key.arn #=> String
|
480
|
-
# resp.stream_key.value #=> String
|
481
489
|
# resp.stream_key.channel_arn #=> String
|
482
490
|
# resp.stream_key.tags #=> Hash
|
483
491
|
# resp.stream_key.tags["TagKey"] #=> String
|
492
|
+
# resp.stream_key.value #=> String
|
484
493
|
#
|
485
494
|
# @see http://docs.aws.amazon.com/goto/WebAPI/ivs-2020-07-14/CreateChannel AWS API Documentation
|
486
495
|
#
|
@@ -494,12 +503,12 @@ module Aws::IVS
|
|
494
503
|
# Creates a new recording configuration, used to enable recording to
|
495
504
|
# Amazon S3.
|
496
505
|
#
|
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.)
|
506
|
+
# **Known issue:** In the us-east-1 region, if you use the Amazon Web
|
507
|
+
# Services CLI to create a recording configuration, it returns success
|
508
|
+
# even if the S3 bucket is in a different region. In this case, the
|
509
|
+
# `state` of the recording configuration is `CREATE_FAILED` (instead of
|
510
|
+
# `ACTIVE`). (In other regions, the CLI correctly returns failure if the
|
511
|
+
# bucket is in a different region.)
|
503
512
|
#
|
504
513
|
# **Workaround:** Ensure that your S3 bucket is in the same region as
|
505
514
|
# the recording configuration. If you create a recording configuration
|
@@ -507,14 +516,13 @@ module Aws::IVS
|
|
507
516
|
# configuration and create a new one with an S3 bucket from the correct
|
508
517
|
# region.
|
509
518
|
#
|
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
519
|
# @option params [required, Types::DestinationConfiguration] :destination_configuration
|
515
520
|
# A complex type that contains a destination configuration for where
|
516
521
|
# recorded video will be stored.
|
517
522
|
#
|
523
|
+
# @option params [String] :name
|
524
|
+
# Recording-configuration name. The value does not need to be unique.
|
525
|
+
#
|
518
526
|
# @option params [Hash<String,String>] :tags
|
519
527
|
# Array of 1-50 maps, each of the form `string:string (key:value)`.
|
520
528
|
#
|
@@ -525,12 +533,12 @@ module Aws::IVS
|
|
525
533
|
# @example Request syntax with placeholder values
|
526
534
|
#
|
527
535
|
# resp = client.create_recording_configuration({
|
528
|
-
# name: "RecordingConfigurationName",
|
529
536
|
# destination_configuration: { # required
|
530
537
|
# s3: {
|
531
538
|
# bucket_name: "S3DestinationBucketName", # required
|
532
539
|
# },
|
533
540
|
# },
|
541
|
+
# name: "RecordingConfigurationName",
|
534
542
|
# tags: {
|
535
543
|
# "TagKey" => "TagValue",
|
536
544
|
# },
|
@@ -539,8 +547,8 @@ module Aws::IVS
|
|
539
547
|
# @example Response structure
|
540
548
|
#
|
541
549
|
# resp.recording_configuration.arn #=> String
|
542
|
-
# resp.recording_configuration.name #=> String
|
543
550
|
# resp.recording_configuration.destination_configuration.s3.bucket_name #=> String
|
551
|
+
# resp.recording_configuration.name #=> String
|
544
552
|
# resp.recording_configuration.state #=> String, one of "CREATING", "CREATE_FAILED", "ACTIVE"
|
545
553
|
# resp.recording_configuration.tags #=> Hash
|
546
554
|
# resp.recording_configuration.tags["TagKey"] #=> String
|
@@ -585,10 +593,10 @@ module Aws::IVS
|
|
585
593
|
# @example Response structure
|
586
594
|
#
|
587
595
|
# resp.stream_key.arn #=> String
|
588
|
-
# resp.stream_key.value #=> String
|
589
596
|
# resp.stream_key.channel_arn #=> String
|
590
597
|
# resp.stream_key.tags #=> Hash
|
591
598
|
# resp.stream_key.tags["TagKey"] #=> String
|
599
|
+
# resp.stream_key.value #=> String
|
592
600
|
#
|
593
601
|
# @see http://docs.aws.amazon.com/goto/WebAPI/ivs-2020-07-14/CreateStreamKey AWS API Documentation
|
594
602
|
#
|
@@ -730,15 +738,15 @@ module Aws::IVS
|
|
730
738
|
# @example Response structure
|
731
739
|
#
|
732
740
|
# 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
|
741
|
+
# resp.channel.authorized #=> Boolean
|
737
742
|
# resp.channel.ingest_endpoint #=> String
|
743
|
+
# resp.channel.latency_mode #=> String, one of "NORMAL", "LOW"
|
744
|
+
# resp.channel.name #=> String
|
738
745
|
# resp.channel.playback_url #=> String
|
739
|
-
# resp.channel.
|
746
|
+
# resp.channel.recording_configuration_arn #=> String
|
740
747
|
# resp.channel.tags #=> Hash
|
741
748
|
# resp.channel.tags["TagKey"] #=> String
|
749
|
+
# resp.channel.type #=> String, one of "BASIC", "STANDARD"
|
742
750
|
#
|
743
751
|
# @see http://docs.aws.amazon.com/goto/WebAPI/ivs-2020-07-14/GetChannel AWS API Documentation
|
744
752
|
#
|
@@ -775,8 +783,8 @@ module Aws::IVS
|
|
775
783
|
# @example Response structure
|
776
784
|
#
|
777
785
|
# resp.key_pair.arn #=> String
|
778
|
-
# resp.key_pair.name #=> String
|
779
786
|
# resp.key_pair.fingerprint #=> String
|
787
|
+
# resp.key_pair.name #=> String
|
780
788
|
# resp.key_pair.tags #=> Hash
|
781
789
|
# resp.key_pair.tags["TagKey"] #=> String
|
782
790
|
#
|
@@ -807,8 +815,8 @@ module Aws::IVS
|
|
807
815
|
# @example Response structure
|
808
816
|
#
|
809
817
|
# resp.recording_configuration.arn #=> String
|
810
|
-
# resp.recording_configuration.name #=> String
|
811
818
|
# resp.recording_configuration.destination_configuration.s3.bucket_name #=> String
|
819
|
+
# resp.recording_configuration.name #=> String
|
812
820
|
# resp.recording_configuration.state #=> String, one of "CREATING", "CREATE_FAILED", "ACTIVE"
|
813
821
|
# resp.recording_configuration.tags #=> Hash
|
814
822
|
# resp.recording_configuration.tags["TagKey"] #=> String
|
@@ -841,10 +849,10 @@ module Aws::IVS
|
|
841
849
|
# @example Response structure
|
842
850
|
#
|
843
851
|
# resp.stream.channel_arn #=> String
|
852
|
+
# resp.stream.health #=> String, one of "HEALTHY", "STARVING", "UNKNOWN"
|
844
853
|
# resp.stream.playback_url #=> String
|
845
854
|
# resp.stream.start_time #=> Time
|
846
855
|
# resp.stream.state #=> String, one of "LIVE", "OFFLINE"
|
847
|
-
# resp.stream.health #=> String, one of "HEALTHY", "STARVING", "UNKNOWN"
|
848
856
|
# resp.stream.viewer_count #=> Integer
|
849
857
|
#
|
850
858
|
# @see http://docs.aws.amazon.com/goto/WebAPI/ivs-2020-07-14/GetStream AWS API Documentation
|
@@ -874,10 +882,10 @@ module Aws::IVS
|
|
874
882
|
# @example Response structure
|
875
883
|
#
|
876
884
|
# resp.stream_key.arn #=> String
|
877
|
-
# resp.stream_key.value #=> String
|
878
885
|
# resp.stream_key.channel_arn #=> String
|
879
886
|
# resp.stream_key.tags #=> Hash
|
880
887
|
# resp.stream_key.tags["TagKey"] #=> String
|
888
|
+
# resp.stream_key.value #=> String
|
881
889
|
#
|
882
890
|
# @see http://docs.aws.amazon.com/goto/WebAPI/ivs-2020-07-14/GetStreamKey AWS API Documentation
|
883
891
|
#
|
@@ -898,14 +906,12 @@ module Aws::IVS
|
|
898
906
|
#
|
899
907
|
# [1]: https://docs.aws.amazon.com/ivs/latest/userguide/private-channels.html
|
900
908
|
#
|
909
|
+
# @option params [String] :name
|
910
|
+
# Playback-key-pair name. The value does not need to be unique.
|
911
|
+
#
|
901
912
|
# @option params [required, String] :public_key_material
|
902
913
|
# The public portion of a customer-generated key pair.
|
903
914
|
#
|
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
915
|
# @option params [Hash<String,String>] :tags
|
910
916
|
# Any tags provided with the request are added to the playback key pair
|
911
917
|
# tags.
|
@@ -917,8 +923,8 @@ module Aws::IVS
|
|
917
923
|
# @example Request syntax with placeholder values
|
918
924
|
#
|
919
925
|
# resp = client.import_playback_key_pair({
|
920
|
-
# public_key_material: "PlaybackPublicKeyMaterial", # required
|
921
926
|
# name: "PlaybackKeyPairName",
|
927
|
+
# public_key_material: "PlaybackPublicKeyMaterial", # required
|
922
928
|
# tags: {
|
923
929
|
# "TagKey" => "TagValue",
|
924
930
|
# },
|
@@ -927,8 +933,8 @@ module Aws::IVS
|
|
927
933
|
# @example Response structure
|
928
934
|
#
|
929
935
|
# resp.key_pair.arn #=> String
|
930
|
-
# resp.key_pair.name #=> String
|
931
936
|
# resp.key_pair.fingerprint #=> String
|
937
|
+
# resp.key_pair.name #=> String
|
932
938
|
# resp.key_pair.tags #=> Hash
|
933
939
|
# resp.key_pair.tags["TagKey"] #=> String
|
934
940
|
#
|
@@ -942,10 +948,11 @@ module Aws::IVS
|
|
942
948
|
end
|
943
949
|
|
944
950
|
# 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
|
951
|
+
# Amazon Web Services region where the API request is processed. This
|
952
|
+
# list can be filtered to match a specified name or
|
953
|
+
# recording-configuration ARN. Filters are mutually exclusive and cannot
|
954
|
+
# be used together. If you try to use both filters, you will get an
|
955
|
+
# error (409 ConflictException).
|
949
956
|
#
|
950
957
|
# @option params [String] :filter_by_name
|
951
958
|
# Filters the channel list to match the specified name.
|
@@ -954,13 +961,13 @@ module Aws::IVS
|
|
954
961
|
# Filters the channel list to match the specified
|
955
962
|
# recording-configuration ARN.
|
956
963
|
#
|
964
|
+
# @option params [Integer] :max_results
|
965
|
+
# Maximum number of channels to return. Default: 50.
|
966
|
+
#
|
957
967
|
# @option params [String] :next_token
|
958
968
|
# The first channel to retrieve. This is used for pagination; see the
|
959
969
|
# `nextToken` response field.
|
960
970
|
#
|
961
|
-
# @option params [Integer] :max_results
|
962
|
-
# Maximum number of channels to return. Default: 50.
|
963
|
-
#
|
964
971
|
# @return [Types::ListChannelsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
965
972
|
#
|
966
973
|
# * {Types::ListChannelsResponse#channels #channels} => Array<Types::ChannelSummary>
|
@@ -973,17 +980,17 @@ module Aws::IVS
|
|
973
980
|
# resp = client.list_channels({
|
974
981
|
# filter_by_name: "ChannelName",
|
975
982
|
# filter_by_recording_configuration_arn: "ChannelRecordingConfigurationArn",
|
976
|
-
# next_token: "PaginationToken",
|
977
983
|
# max_results: 1,
|
984
|
+
# next_token: "PaginationToken",
|
978
985
|
# })
|
979
986
|
#
|
980
987
|
# @example Response structure
|
981
988
|
#
|
982
989
|
# resp.channels #=> Array
|
983
990
|
# resp.channels[0].arn #=> String
|
984
|
-
# resp.channels[0].name #=> String
|
985
|
-
# resp.channels[0].latency_mode #=> String, one of "NORMAL", "LOW"
|
986
991
|
# resp.channels[0].authorized #=> Boolean
|
992
|
+
# resp.channels[0].latency_mode #=> String, one of "NORMAL", "LOW"
|
993
|
+
# resp.channels[0].name #=> String
|
987
994
|
# resp.channels[0].recording_configuration_arn #=> String
|
988
995
|
# resp.channels[0].tags #=> Hash
|
989
996
|
# resp.channels[0].tags["TagKey"] #=> String
|
@@ -1006,13 +1013,13 @@ module Aws::IVS
|
|
1006
1013
|
#
|
1007
1014
|
# [1]: https://docs.aws.amazon.com/ivs/latest/userguide/private-channels.html
|
1008
1015
|
#
|
1009
|
-
# @option params [String] :next_token
|
1010
|
-
# Maximum number of key pairs to return.
|
1011
|
-
#
|
1012
1016
|
# @option params [Integer] :max_results
|
1013
1017
|
# The first key pair to retrieve. This is used for pagination; see the
|
1014
1018
|
# `nextToken` response field. Default: 50.
|
1015
1019
|
#
|
1020
|
+
# @option params [String] :next_token
|
1021
|
+
# Maximum number of key pairs to return.
|
1022
|
+
#
|
1016
1023
|
# @return [Types::ListPlaybackKeyPairsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1017
1024
|
#
|
1018
1025
|
# * {Types::ListPlaybackKeyPairsResponse#key_pairs #key_pairs} => Array<Types::PlaybackKeyPairSummary>
|
@@ -1023,8 +1030,8 @@ module Aws::IVS
|
|
1023
1030
|
# @example Request syntax with placeholder values
|
1024
1031
|
#
|
1025
1032
|
# resp = client.list_playback_key_pairs({
|
1026
|
-
# next_token: "PaginationToken",
|
1027
1033
|
# max_results: 1,
|
1034
|
+
# next_token: "PaginationToken",
|
1028
1035
|
# })
|
1029
1036
|
#
|
1030
1037
|
# @example Response structure
|
@@ -1046,39 +1053,40 @@ module Aws::IVS
|
|
1046
1053
|
end
|
1047
1054
|
|
1048
1055
|
# Gets summary information about all recording configurations in your
|
1049
|
-
# account, in the
|
1056
|
+
# account, in the Amazon Web Services region where the API request is
|
1057
|
+
# processed.
|
1058
|
+
#
|
1059
|
+
# @option params [Integer] :max_results
|
1060
|
+
# Maximum number of recording configurations to return. Default: 50.
|
1050
1061
|
#
|
1051
1062
|
# @option params [String] :next_token
|
1052
1063
|
# The first recording configuration to retrieve. This is used for
|
1053
1064
|
# pagination; see the `nextToken` response field.
|
1054
1065
|
#
|
1055
|
-
# @option params [Integer] :max_results
|
1056
|
-
# Maximum number of recording configurations to return. Default: 50.
|
1057
|
-
#
|
1058
1066
|
# @return [Types::ListRecordingConfigurationsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1059
1067
|
#
|
1060
|
-
# * {Types::ListRecordingConfigurationsResponse#recording_configurations #recording_configurations} => Array<Types::RecordingConfigurationSummary>
|
1061
1068
|
# * {Types::ListRecordingConfigurationsResponse#next_token #next_token} => String
|
1069
|
+
# * {Types::ListRecordingConfigurationsResponse#recording_configurations #recording_configurations} => Array<Types::RecordingConfigurationSummary>
|
1062
1070
|
#
|
1063
1071
|
# The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
|
1064
1072
|
#
|
1065
1073
|
# @example Request syntax with placeholder values
|
1066
1074
|
#
|
1067
1075
|
# resp = client.list_recording_configurations({
|
1068
|
-
# next_token: "PaginationToken",
|
1069
1076
|
# max_results: 1,
|
1077
|
+
# next_token: "PaginationToken",
|
1070
1078
|
# })
|
1071
1079
|
#
|
1072
1080
|
# @example Response structure
|
1073
1081
|
#
|
1082
|
+
# resp.next_token #=> String
|
1074
1083
|
# resp.recording_configurations #=> Array
|
1075
1084
|
# resp.recording_configurations[0].arn #=> String
|
1076
|
-
# resp.recording_configurations[0].name #=> String
|
1077
1085
|
# resp.recording_configurations[0].destination_configuration.s3.bucket_name #=> String
|
1086
|
+
# resp.recording_configurations[0].name #=> String
|
1078
1087
|
# resp.recording_configurations[0].state #=> String, one of "CREATING", "CREATE_FAILED", "ACTIVE"
|
1079
1088
|
# resp.recording_configurations[0].tags #=> Hash
|
1080
1089
|
# resp.recording_configurations[0].tags["TagKey"] #=> String
|
1081
|
-
# resp.next_token #=> String
|
1082
1090
|
#
|
1083
1091
|
# @see http://docs.aws.amazon.com/goto/WebAPI/ivs-2020-07-14/ListRecordingConfigurations AWS API Documentation
|
1084
1092
|
#
|
@@ -1094,17 +1102,17 @@ module Aws::IVS
|
|
1094
1102
|
# @option params [required, String] :channel_arn
|
1095
1103
|
# Channel ARN used to filter the list.
|
1096
1104
|
#
|
1105
|
+
# @option params [Integer] :max_results
|
1106
|
+
# Maximum number of streamKeys to return. Default: 50.
|
1107
|
+
#
|
1097
1108
|
# @option params [String] :next_token
|
1098
1109
|
# The first stream key to retrieve. This is used for pagination; see the
|
1099
1110
|
# `nextToken` response field.
|
1100
1111
|
#
|
1101
|
-
# @option params [Integer] :max_results
|
1102
|
-
# Maximum number of streamKeys to return. Default: 50.
|
1103
|
-
#
|
1104
1112
|
# @return [Types::ListStreamKeysResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1105
1113
|
#
|
1106
|
-
# * {Types::ListStreamKeysResponse#stream_keys #stream_keys} => Array<Types::StreamKeySummary>
|
1107
1114
|
# * {Types::ListStreamKeysResponse#next_token #next_token} => String
|
1115
|
+
# * {Types::ListStreamKeysResponse#stream_keys #stream_keys} => Array<Types::StreamKeySummary>
|
1108
1116
|
#
|
1109
1117
|
# The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
|
1110
1118
|
#
|
@@ -1112,18 +1120,18 @@ module Aws::IVS
|
|
1112
1120
|
#
|
1113
1121
|
# resp = client.list_stream_keys({
|
1114
1122
|
# channel_arn: "ChannelArn", # required
|
1115
|
-
# next_token: "PaginationToken",
|
1116
1123
|
# max_results: 1,
|
1124
|
+
# next_token: "PaginationToken",
|
1117
1125
|
# })
|
1118
1126
|
#
|
1119
1127
|
# @example Response structure
|
1120
1128
|
#
|
1129
|
+
# resp.next_token #=> String
|
1121
1130
|
# resp.stream_keys #=> Array
|
1122
1131
|
# resp.stream_keys[0].arn #=> String
|
1123
1132
|
# resp.stream_keys[0].channel_arn #=> String
|
1124
1133
|
# resp.stream_keys[0].tags #=> Hash
|
1125
1134
|
# resp.stream_keys[0].tags["TagKey"] #=> String
|
1126
|
-
# resp.next_token #=> String
|
1127
1135
|
#
|
1128
1136
|
# @see http://docs.aws.amazon.com/goto/WebAPI/ivs-2020-07-14/ListStreamKeys AWS API Documentation
|
1129
1137
|
#
|
@@ -1135,38 +1143,38 @@ module Aws::IVS
|
|
1135
1143
|
end
|
1136
1144
|
|
1137
1145
|
# Gets summary information about live streams in your account, in the
|
1138
|
-
#
|
1146
|
+
# Amazon Web Services region where the API request is processed.
|
1147
|
+
#
|
1148
|
+
# @option params [Integer] :max_results
|
1149
|
+
# Maximum number of streams to return. Default: 50.
|
1139
1150
|
#
|
1140
1151
|
# @option params [String] :next_token
|
1141
1152
|
# The first stream to retrieve. This is used for pagination; see the
|
1142
1153
|
# `nextToken` response field.
|
1143
1154
|
#
|
1144
|
-
# @option params [Integer] :max_results
|
1145
|
-
# Maximum number of streams to return. Default: 50.
|
1146
|
-
#
|
1147
1155
|
# @return [Types::ListStreamsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1148
1156
|
#
|
1149
|
-
# * {Types::ListStreamsResponse#streams #streams} => Array<Types::StreamSummary>
|
1150
1157
|
# * {Types::ListStreamsResponse#next_token #next_token} => String
|
1158
|
+
# * {Types::ListStreamsResponse#streams #streams} => Array<Types::StreamSummary>
|
1151
1159
|
#
|
1152
1160
|
# The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
|
1153
1161
|
#
|
1154
1162
|
# @example Request syntax with placeholder values
|
1155
1163
|
#
|
1156
1164
|
# resp = client.list_streams({
|
1157
|
-
# next_token: "PaginationToken",
|
1158
1165
|
# max_results: 1,
|
1166
|
+
# next_token: "PaginationToken",
|
1159
1167
|
# })
|
1160
1168
|
#
|
1161
1169
|
# @example Response structure
|
1162
1170
|
#
|
1171
|
+
# resp.next_token #=> String
|
1163
1172
|
# resp.streams #=> Array
|
1164
1173
|
# resp.streams[0].channel_arn #=> String
|
1165
|
-
# resp.streams[0].state #=> String, one of "LIVE", "OFFLINE"
|
1166
1174
|
# resp.streams[0].health #=> String, one of "HEALTHY", "STARVING", "UNKNOWN"
|
1167
|
-
# resp.streams[0].viewer_count #=> Integer
|
1168
1175
|
# resp.streams[0].start_time #=> Time
|
1169
|
-
# resp.
|
1176
|
+
# resp.streams[0].state #=> String, one of "LIVE", "OFFLINE"
|
1177
|
+
# resp.streams[0].viewer_count #=> Integer
|
1170
1178
|
#
|
1171
1179
|
# @see http://docs.aws.amazon.com/goto/WebAPI/ivs-2020-07-14/ListStreams AWS API Documentation
|
1172
1180
|
#
|
@@ -1177,38 +1185,25 @@ module Aws::IVS
|
|
1177
1185
|
req.send_request(options)
|
1178
1186
|
end
|
1179
1187
|
|
1180
|
-
# Gets information about
|
1188
|
+
# Gets information about Amazon Web Services tags for the specified ARN.
|
1181
1189
|
#
|
1182
1190
|
# @option params [required, String] :resource_arn
|
1183
1191
|
# The ARN of the resource to be retrieved.
|
1184
1192
|
#
|
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
1193
|
# @return [Types::ListTagsForResourceResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1193
1194
|
#
|
1194
1195
|
# * {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
1196
|
#
|
1199
1197
|
# @example Request syntax with placeholder values
|
1200
1198
|
#
|
1201
1199
|
# resp = client.list_tags_for_resource({
|
1202
1200
|
# resource_arn: "ResourceArn", # required
|
1203
|
-
# next_token: "String",
|
1204
|
-
# max_results: 1,
|
1205
1201
|
# })
|
1206
1202
|
#
|
1207
1203
|
# @example Response structure
|
1208
1204
|
#
|
1209
1205
|
# resp.tags #=> Hash
|
1210
1206
|
# resp.tags["TagKey"] #=> String
|
1211
|
-
# resp.next_token #=> String
|
1212
1207
|
#
|
1213
1208
|
# @see http://docs.aws.amazon.com/goto/WebAPI/ivs-2020-07-14/ListTagsForResource AWS API Documentation
|
1214
1209
|
#
|
@@ -1219,12 +1214,12 @@ module Aws::IVS
|
|
1219
1214
|
req.send_request(options)
|
1220
1215
|
end
|
1221
1216
|
|
1222
|
-
# Inserts metadata into the active stream of the specified channel.
|
1223
|
-
#
|
1217
|
+
# Inserts metadata into the active stream of the specified channel. At
|
1218
|
+
# most 5 requests per second per channel are allowed, each with a
|
1224
1219
|
# 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*.
|
1220
|
+
# recommend batching your data into a single PutMetadata call.) At most
|
1221
|
+
# 155 requests per second per account are allowed. Also see [Embedding
|
1222
|
+
# Metadata within a Video Stream][1] in the *Amazon IVS User Guide*.
|
1228
1223
|
#
|
1229
1224
|
#
|
1230
1225
|
#
|
@@ -1285,7 +1280,8 @@ module Aws::IVS
|
|
1285
1280
|
req.send_request(options)
|
1286
1281
|
end
|
1287
1282
|
|
1288
|
-
# Adds or updates tags for the
|
1283
|
+
# Adds or updates tags for the Amazon Web Services resource with the
|
1284
|
+
# specified ARN.
|
1289
1285
|
#
|
1290
1286
|
# @option params [required, String] :resource_arn
|
1291
1287
|
# ARN of the resource for which tags are to be added or updated.
|
@@ -1346,8 +1342,8 @@ module Aws::IVS
|
|
1346
1342
|
# @option params [required, String] :arn
|
1347
1343
|
# ARN of the channel to be updated.
|
1348
1344
|
#
|
1349
|
-
# @option params [
|
1350
|
-
#
|
1345
|
+
# @option params [Boolean] :authorized
|
1346
|
+
# Whether the channel is private (enabled for playback authorization).
|
1351
1347
|
#
|
1352
1348
|
# @option params [String] :latency_mode
|
1353
1349
|
# Channel latency mode. Use `NORMAL` to broadcast and deliver live video
|
@@ -1355,6 +1351,14 @@ module Aws::IVS
|
|
1355
1351
|
# (Note: In the Amazon IVS console, `LOW` and `NORMAL` correspond to
|
1356
1352
|
# Ultra-low and Standard, respectively.)
|
1357
1353
|
#
|
1354
|
+
# @option params [String] :name
|
1355
|
+
# Channel name.
|
1356
|
+
#
|
1357
|
+
# @option params [String] :recording_configuration_arn
|
1358
|
+
# Recording-configuration ARN. If this is set to an empty string,
|
1359
|
+
# recording is disabled. A value other than an empty string indicates
|
1360
|
+
# that recording is enabled
|
1361
|
+
#
|
1358
1362
|
# @option params [String] :type
|
1359
1363
|
# Channel type, which determines the allowable resolution and bitrate.
|
1360
1364
|
# *If you exceed the allowable resolution or bitrate, the stream
|
@@ -1362,21 +1366,13 @@ module Aws::IVS
|
|
1362
1366
|
#
|
1363
1367
|
# * `STANDARD`\: Multiple qualities are generated from the original
|
1364
1368
|
# input, to automatically give viewers the best experience for their
|
1365
|
-
# devices and network conditions.
|
1366
|
-
#
|
1369
|
+
# devices and network conditions. Resolution can be up to 1080p and
|
1370
|
+
# bitrate can be up to 8.5 Mbps. Audio is transcoded only for
|
1371
|
+
# renditions 360p and below; above that, audio is passed through.
|
1367
1372
|
#
|
1368
1373
|
# * `BASIC`\: Amazon IVS delivers the original input to viewers. The
|
1369
1374
|
# 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
|
1375
|
+
# Resolution can be up to 480p and bitrate can be up to 1.5 Mbps.
|
1380
1376
|
#
|
1381
1377
|
# @return [Types::UpdateChannelResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1382
1378
|
#
|
@@ -1386,25 +1382,25 @@ module Aws::IVS
|
|
1386
1382
|
#
|
1387
1383
|
# resp = client.update_channel({
|
1388
1384
|
# arn: "ChannelArn", # required
|
1389
|
-
# name: "ChannelName",
|
1390
|
-
# latency_mode: "NORMAL", # accepts NORMAL, LOW
|
1391
|
-
# type: "BASIC", # accepts BASIC, STANDARD
|
1392
1385
|
# authorized: false,
|
1386
|
+
# latency_mode: "NORMAL", # accepts NORMAL, LOW
|
1387
|
+
# name: "ChannelName",
|
1393
1388
|
# recording_configuration_arn: "ChannelRecordingConfigurationArn",
|
1389
|
+
# type: "BASIC", # accepts BASIC, STANDARD
|
1394
1390
|
# })
|
1395
1391
|
#
|
1396
1392
|
# @example Response structure
|
1397
1393
|
#
|
1398
1394
|
# 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
|
1395
|
+
# resp.channel.authorized #=> Boolean
|
1403
1396
|
# resp.channel.ingest_endpoint #=> String
|
1397
|
+
# resp.channel.latency_mode #=> String, one of "NORMAL", "LOW"
|
1398
|
+
# resp.channel.name #=> String
|
1404
1399
|
# resp.channel.playback_url #=> String
|
1405
|
-
# resp.channel.
|
1400
|
+
# resp.channel.recording_configuration_arn #=> String
|
1406
1401
|
# resp.channel.tags #=> Hash
|
1407
1402
|
# resp.channel.tags["TagKey"] #=> String
|
1403
|
+
# resp.channel.type #=> String, one of "BASIC", "STANDARD"
|
1408
1404
|
#
|
1409
1405
|
# @see http://docs.aws.amazon.com/goto/WebAPI/ivs-2020-07-14/UpdateChannel AWS API Documentation
|
1410
1406
|
#
|
@@ -1428,7 +1424,7 @@ module Aws::IVS
|
|
1428
1424
|
params: params,
|
1429
1425
|
config: config)
|
1430
1426
|
context[:gem_name] = 'aws-sdk-ivs'
|
1431
|
-
context[:gem_version] = '1.
|
1427
|
+
context[:gem_version] = '1.14.0'
|
1432
1428
|
Seahorse::Client::Request.new(handlers, context)
|
1433
1429
|
end
|
1434
1430
|
|