aws-sdk-ivs 1.11.0 → 1.15.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.
@@ -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].name #=> String
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].authorized #=> Boolean
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.errors #=> Array
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 [String] :name
414
- # Channel name.
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. Vertical resolution can be up to
431
- # 1080 and bitrate can be up to 8.5 Mbps.
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
- # Vertical resolution can be up to 480 and bitrate can be up to 1.5
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.name #=> String
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.authorized #=> Boolean
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 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.)
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.name #=> String
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.authorized #=> Boolean
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,11 @@ 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"
856
+ # resp.stream.stream_id #=> String
848
857
  # resp.stream.viewer_count #=> Integer
849
858
  #
850
859
  # @see http://docs.aws.amazon.com/goto/WebAPI/ivs-2020-07-14/GetStream AWS API Documentation
@@ -874,10 +883,10 @@ module Aws::IVS
874
883
  # @example Response structure
875
884
  #
876
885
  # resp.stream_key.arn #=> String
877
- # resp.stream_key.value #=> String
878
886
  # resp.stream_key.channel_arn #=> String
879
887
  # resp.stream_key.tags #=> Hash
880
888
  # resp.stream_key.tags["TagKey"] #=> String
889
+ # resp.stream_key.value #=> String
881
890
  #
882
891
  # @see http://docs.aws.amazon.com/goto/WebAPI/ivs-2020-07-14/GetStreamKey AWS API Documentation
883
892
  #
@@ -888,6 +897,74 @@ module Aws::IVS
888
897
  req.send_request(options)
889
898
  end
890
899
 
900
+ # Gets metadata on a specified stream.
901
+ #
902
+ # @option params [required, String] :channel_arn
903
+ # ARN of the channel resource
904
+ #
905
+ # @option params [String] :stream_id
906
+ # Unique identifier for a live or previously live stream in the
907
+ # specified channel. If no `streamId` is provided, this returns the most
908
+ # recent stream session for the channel, if it exists.
909
+ #
910
+ # @return [Types::GetStreamSessionResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
911
+ #
912
+ # * {Types::GetStreamSessionResponse#stream_session #stream_session} => Types::StreamSession
913
+ #
914
+ # @example Request syntax with placeholder values
915
+ #
916
+ # resp = client.get_stream_session({
917
+ # channel_arn: "ChannelArn", # required
918
+ # stream_id: "StreamId",
919
+ # })
920
+ #
921
+ # @example Response structure
922
+ #
923
+ # resp.stream_session.channel.arn #=> String
924
+ # resp.stream_session.channel.authorized #=> Boolean
925
+ # resp.stream_session.channel.ingest_endpoint #=> String
926
+ # resp.stream_session.channel.latency_mode #=> String, one of "NORMAL", "LOW"
927
+ # resp.stream_session.channel.name #=> String
928
+ # resp.stream_session.channel.playback_url #=> String
929
+ # resp.stream_session.channel.recording_configuration_arn #=> String
930
+ # resp.stream_session.channel.tags #=> Hash
931
+ # resp.stream_session.channel.tags["TagKey"] #=> String
932
+ # resp.stream_session.channel.type #=> String, one of "BASIC", "STANDARD"
933
+ # resp.stream_session.end_time #=> Time
934
+ # resp.stream_session.ingest_configuration.audio.channels #=> Integer
935
+ # resp.stream_session.ingest_configuration.audio.codec #=> String
936
+ # resp.stream_session.ingest_configuration.audio.sample_rate #=> Integer
937
+ # resp.stream_session.ingest_configuration.audio.target_bitrate #=> Integer
938
+ # resp.stream_session.ingest_configuration.video.avc_level #=> String
939
+ # resp.stream_session.ingest_configuration.video.avc_profile #=> String
940
+ # resp.stream_session.ingest_configuration.video.codec #=> String
941
+ # resp.stream_session.ingest_configuration.video.encoder #=> String
942
+ # resp.stream_session.ingest_configuration.video.target_bitrate #=> Integer
943
+ # resp.stream_session.ingest_configuration.video.target_framerate #=> Integer
944
+ # resp.stream_session.ingest_configuration.video.video_height #=> Integer
945
+ # resp.stream_session.ingest_configuration.video.video_width #=> Integer
946
+ # resp.stream_session.recording_configuration.arn #=> String
947
+ # resp.stream_session.recording_configuration.destination_configuration.s3.bucket_name #=> String
948
+ # resp.stream_session.recording_configuration.name #=> String
949
+ # resp.stream_session.recording_configuration.state #=> String, one of "CREATING", "CREATE_FAILED", "ACTIVE"
950
+ # resp.stream_session.recording_configuration.tags #=> Hash
951
+ # resp.stream_session.recording_configuration.tags["TagKey"] #=> String
952
+ # resp.stream_session.start_time #=> Time
953
+ # resp.stream_session.stream_id #=> String
954
+ # resp.stream_session.truncated_events #=> Array
955
+ # resp.stream_session.truncated_events[0].event_time #=> Time
956
+ # resp.stream_session.truncated_events[0].name #=> String
957
+ # resp.stream_session.truncated_events[0].type #=> String
958
+ #
959
+ # @see http://docs.aws.amazon.com/goto/WebAPI/ivs-2020-07-14/GetStreamSession AWS API Documentation
960
+ #
961
+ # @overload get_stream_session(params = {})
962
+ # @param [Hash] params ({})
963
+ def get_stream_session(params = {}, options = {})
964
+ req = build_request(:get_stream_session, params)
965
+ req.send_request(options)
966
+ end
967
+
891
968
  # Imports the public portion of a new key pair and returns its `arn` and
892
969
  # `fingerprint`. The `privateKey` can then be used to generate viewer
893
970
  # authorization tokens, to grant viewers access to private channels. For
@@ -898,14 +975,12 @@ module Aws::IVS
898
975
  #
899
976
  # [1]: https://docs.aws.amazon.com/ivs/latest/userguide/private-channels.html
900
977
  #
978
+ # @option params [String] :name
979
+ # Playback-key-pair name. The value does not need to be unique.
980
+ #
901
981
  # @option params [required, String] :public_key_material
902
982
  # The public portion of a customer-generated key pair.
903
983
  #
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
984
  # @option params [Hash<String,String>] :tags
910
985
  # Any tags provided with the request are added to the playback key pair
911
986
  # tags.
@@ -917,8 +992,8 @@ module Aws::IVS
917
992
  # @example Request syntax with placeholder values
918
993
  #
919
994
  # resp = client.import_playback_key_pair({
920
- # public_key_material: "PlaybackPublicKeyMaterial", # required
921
995
  # name: "PlaybackKeyPairName",
996
+ # public_key_material: "PlaybackPublicKeyMaterial", # required
922
997
  # tags: {
923
998
  # "TagKey" => "TagValue",
924
999
  # },
@@ -927,8 +1002,8 @@ module Aws::IVS
927
1002
  # @example Response structure
928
1003
  #
929
1004
  # resp.key_pair.arn #=> String
930
- # resp.key_pair.name #=> String
931
1005
  # resp.key_pair.fingerprint #=> String
1006
+ # resp.key_pair.name #=> String
932
1007
  # resp.key_pair.tags #=> Hash
933
1008
  # resp.key_pair.tags["TagKey"] #=> String
934
1009
  #
@@ -942,10 +1017,11 @@ module Aws::IVS
942
1017
  end
943
1018
 
944
1019
  # Gets summary information about all channels in your account, in the
945
- # AWS region where the API request is processed. This list can be
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).
1020
+ # Amazon Web Services region where the API request is processed. This
1021
+ # list can be filtered to match a specified name or
1022
+ # recording-configuration ARN. Filters are mutually exclusive and cannot
1023
+ # be used together. If you try to use both filters, you will get an
1024
+ # error (409 ConflictException).
949
1025
  #
950
1026
  # @option params [String] :filter_by_name
951
1027
  # Filters the channel list to match the specified name.
@@ -954,13 +1030,13 @@ module Aws::IVS
954
1030
  # Filters the channel list to match the specified
955
1031
  # recording-configuration ARN.
956
1032
  #
1033
+ # @option params [Integer] :max_results
1034
+ # Maximum number of channels to return. Default: 50.
1035
+ #
957
1036
  # @option params [String] :next_token
958
1037
  # The first channel to retrieve. This is used for pagination; see the
959
1038
  # `nextToken` response field.
960
1039
  #
961
- # @option params [Integer] :max_results
962
- # Maximum number of channels to return. Default: 50.
963
- #
964
1040
  # @return [Types::ListChannelsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
965
1041
  #
966
1042
  # * {Types::ListChannelsResponse#channels #channels} => Array&lt;Types::ChannelSummary&gt;
@@ -973,17 +1049,17 @@ module Aws::IVS
973
1049
  # resp = client.list_channels({
974
1050
  # filter_by_name: "ChannelName",
975
1051
  # filter_by_recording_configuration_arn: "ChannelRecordingConfigurationArn",
976
- # next_token: "PaginationToken",
977
1052
  # max_results: 1,
1053
+ # next_token: "PaginationToken",
978
1054
  # })
979
1055
  #
980
1056
  # @example Response structure
981
1057
  #
982
1058
  # resp.channels #=> Array
983
1059
  # resp.channels[0].arn #=> String
984
- # resp.channels[0].name #=> String
985
- # resp.channels[0].latency_mode #=> String, one of "NORMAL", "LOW"
986
1060
  # resp.channels[0].authorized #=> Boolean
1061
+ # resp.channels[0].latency_mode #=> String, one of "NORMAL", "LOW"
1062
+ # resp.channels[0].name #=> String
987
1063
  # resp.channels[0].recording_configuration_arn #=> String
988
1064
  # resp.channels[0].tags #=> Hash
989
1065
  # resp.channels[0].tags["TagKey"] #=> String
@@ -1006,13 +1082,13 @@ module Aws::IVS
1006
1082
  #
1007
1083
  # [1]: https://docs.aws.amazon.com/ivs/latest/userguide/private-channels.html
1008
1084
  #
1009
- # @option params [String] :next_token
1010
- # Maximum number of key pairs to return.
1011
- #
1012
1085
  # @option params [Integer] :max_results
1013
1086
  # The first key pair to retrieve. This is used for pagination; see the
1014
1087
  # `nextToken` response field. Default: 50.
1015
1088
  #
1089
+ # @option params [String] :next_token
1090
+ # Maximum number of key pairs to return.
1091
+ #
1016
1092
  # @return [Types::ListPlaybackKeyPairsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
1017
1093
  #
1018
1094
  # * {Types::ListPlaybackKeyPairsResponse#key_pairs #key_pairs} => Array&lt;Types::PlaybackKeyPairSummary&gt;
@@ -1023,8 +1099,8 @@ module Aws::IVS
1023
1099
  # @example Request syntax with placeholder values
1024
1100
  #
1025
1101
  # resp = client.list_playback_key_pairs({
1026
- # next_token: "PaginationToken",
1027
1102
  # max_results: 1,
1103
+ # next_token: "PaginationToken",
1028
1104
  # })
1029
1105
  #
1030
1106
  # @example Response structure
@@ -1046,39 +1122,40 @@ module Aws::IVS
1046
1122
  end
1047
1123
 
1048
1124
  # Gets summary information about all recording configurations in your
1049
- # account, in the AWS region where the API request is processed.
1125
+ # account, in the Amazon Web Services region where the API request is
1126
+ # processed.
1127
+ #
1128
+ # @option params [Integer] :max_results
1129
+ # Maximum number of recording configurations to return. Default: 50.
1050
1130
  #
1051
1131
  # @option params [String] :next_token
1052
1132
  # The first recording configuration to retrieve. This is used for
1053
1133
  # pagination; see the `nextToken` response field.
1054
1134
  #
1055
- # @option params [Integer] :max_results
1056
- # Maximum number of recording configurations to return. Default: 50.
1057
- #
1058
1135
  # @return [Types::ListRecordingConfigurationsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
1059
1136
  #
1060
- # * {Types::ListRecordingConfigurationsResponse#recording_configurations #recording_configurations} => Array&lt;Types::RecordingConfigurationSummary&gt;
1061
1137
  # * {Types::ListRecordingConfigurationsResponse#next_token #next_token} => String
1138
+ # * {Types::ListRecordingConfigurationsResponse#recording_configurations #recording_configurations} => Array&lt;Types::RecordingConfigurationSummary&gt;
1062
1139
  #
1063
1140
  # The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
1064
1141
  #
1065
1142
  # @example Request syntax with placeholder values
1066
1143
  #
1067
1144
  # resp = client.list_recording_configurations({
1068
- # next_token: "PaginationToken",
1069
1145
  # max_results: 1,
1146
+ # next_token: "PaginationToken",
1070
1147
  # })
1071
1148
  #
1072
1149
  # @example Response structure
1073
1150
  #
1151
+ # resp.next_token #=> String
1074
1152
  # resp.recording_configurations #=> Array
1075
1153
  # resp.recording_configurations[0].arn #=> String
1076
- # resp.recording_configurations[0].name #=> String
1077
1154
  # resp.recording_configurations[0].destination_configuration.s3.bucket_name #=> String
1155
+ # resp.recording_configurations[0].name #=> String
1078
1156
  # resp.recording_configurations[0].state #=> String, one of "CREATING", "CREATE_FAILED", "ACTIVE"
1079
1157
  # resp.recording_configurations[0].tags #=> Hash
1080
1158
  # resp.recording_configurations[0].tags["TagKey"] #=> String
1081
- # resp.next_token #=> String
1082
1159
  #
1083
1160
  # @see http://docs.aws.amazon.com/goto/WebAPI/ivs-2020-07-14/ListRecordingConfigurations AWS API Documentation
1084
1161
  #
@@ -1094,17 +1171,17 @@ module Aws::IVS
1094
1171
  # @option params [required, String] :channel_arn
1095
1172
  # Channel ARN used to filter the list.
1096
1173
  #
1174
+ # @option params [Integer] :max_results
1175
+ # Maximum number of streamKeys to return. Default: 50.
1176
+ #
1097
1177
  # @option params [String] :next_token
1098
1178
  # The first stream key to retrieve. This is used for pagination; see the
1099
1179
  # `nextToken` response field.
1100
1180
  #
1101
- # @option params [Integer] :max_results
1102
- # Maximum number of streamKeys to return. Default: 50.
1103
- #
1104
1181
  # @return [Types::ListStreamKeysResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
1105
1182
  #
1106
- # * {Types::ListStreamKeysResponse#stream_keys #stream_keys} => Array&lt;Types::StreamKeySummary&gt;
1107
1183
  # * {Types::ListStreamKeysResponse#next_token #next_token} => String
1184
+ # * {Types::ListStreamKeysResponse#stream_keys #stream_keys} => Array&lt;Types::StreamKeySummary&gt;
1108
1185
  #
1109
1186
  # The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
1110
1187
  #
@@ -1112,18 +1189,18 @@ module Aws::IVS
1112
1189
  #
1113
1190
  # resp = client.list_stream_keys({
1114
1191
  # channel_arn: "ChannelArn", # required
1115
- # next_token: "PaginationToken",
1116
1192
  # max_results: 1,
1193
+ # next_token: "PaginationToken",
1117
1194
  # })
1118
1195
  #
1119
1196
  # @example Response structure
1120
1197
  #
1198
+ # resp.next_token #=> String
1121
1199
  # resp.stream_keys #=> Array
1122
1200
  # resp.stream_keys[0].arn #=> String
1123
1201
  # resp.stream_keys[0].channel_arn #=> String
1124
1202
  # resp.stream_keys[0].tags #=> Hash
1125
1203
  # resp.stream_keys[0].tags["TagKey"] #=> String
1126
- # resp.next_token #=> String
1127
1204
  #
1128
1205
  # @see http://docs.aws.amazon.com/goto/WebAPI/ivs-2020-07-14/ListStreamKeys AWS API Documentation
1129
1206
  #
@@ -1134,39 +1211,92 @@ module Aws::IVS
1134
1211
  req.send_request(options)
1135
1212
  end
1136
1213
 
1137
- # Gets summary information about live streams in your account, in the
1138
- # AWS region where the API request is processed.
1214
+ # Gets a summary of current and previous streams for a specified channel
1215
+ # in your account, in the AWS region where the API request is processed.
1216
+ #
1217
+ # @option params [required, String] :channel_arn
1218
+ # Channel ARN used to filter the list.
1219
+ #
1220
+ # @option params [Integer] :max_results
1221
+ # Maximum number of streams to return. Default: 50.
1139
1222
  #
1140
1223
  # @option params [String] :next_token
1141
1224
  # The first stream to retrieve. This is used for pagination; see the
1142
1225
  # `nextToken` response field.
1143
1226
  #
1227
+ # @return [Types::ListStreamSessionsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
1228
+ #
1229
+ # * {Types::ListStreamSessionsResponse#next_token #next_token} => String
1230
+ # * {Types::ListStreamSessionsResponse#stream_sessions #stream_sessions} => Array&lt;Types::StreamSessionSummary&gt;
1231
+ #
1232
+ # The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
1233
+ #
1234
+ # @example Request syntax with placeholder values
1235
+ #
1236
+ # resp = client.list_stream_sessions({
1237
+ # channel_arn: "ChannelArn", # required
1238
+ # max_results: 1,
1239
+ # next_token: "PaginationToken",
1240
+ # })
1241
+ #
1242
+ # @example Response structure
1243
+ #
1244
+ # resp.next_token #=> String
1245
+ # resp.stream_sessions #=> Array
1246
+ # resp.stream_sessions[0].end_time #=> Time
1247
+ # resp.stream_sessions[0].has_error_event #=> Boolean
1248
+ # resp.stream_sessions[0].start_time #=> Time
1249
+ # resp.stream_sessions[0].stream_id #=> String
1250
+ #
1251
+ # @see http://docs.aws.amazon.com/goto/WebAPI/ivs-2020-07-14/ListStreamSessions AWS API Documentation
1252
+ #
1253
+ # @overload list_stream_sessions(params = {})
1254
+ # @param [Hash] params ({})
1255
+ def list_stream_sessions(params = {}, options = {})
1256
+ req = build_request(:list_stream_sessions, params)
1257
+ req.send_request(options)
1258
+ end
1259
+
1260
+ # Gets summary information about live streams in your account, in the
1261
+ # Amazon Web Services region where the API request is processed.
1262
+ #
1263
+ # @option params [Types::StreamFilters] :filter_by
1264
+ # Filters the stream list to match the specified criterion.
1265
+ #
1144
1266
  # @option params [Integer] :max_results
1145
1267
  # Maximum number of streams to return. Default: 50.
1146
1268
  #
1269
+ # @option params [String] :next_token
1270
+ # The first stream to retrieve. This is used for pagination; see the
1271
+ # `nextToken` response field.
1272
+ #
1147
1273
  # @return [Types::ListStreamsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
1148
1274
  #
1149
- # * {Types::ListStreamsResponse#streams #streams} => Array&lt;Types::StreamSummary&gt;
1150
1275
  # * {Types::ListStreamsResponse#next_token #next_token} => String
1276
+ # * {Types::ListStreamsResponse#streams #streams} => Array&lt;Types::StreamSummary&gt;
1151
1277
  #
1152
1278
  # The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
1153
1279
  #
1154
1280
  # @example Request syntax with placeholder values
1155
1281
  #
1156
1282
  # resp = client.list_streams({
1157
- # next_token: "PaginationToken",
1283
+ # filter_by: {
1284
+ # health: "HEALTHY", # accepts HEALTHY, STARVING, UNKNOWN
1285
+ # },
1158
1286
  # max_results: 1,
1287
+ # next_token: "PaginationToken",
1159
1288
  # })
1160
1289
  #
1161
1290
  # @example Response structure
1162
1291
  #
1292
+ # resp.next_token #=> String
1163
1293
  # resp.streams #=> Array
1164
1294
  # resp.streams[0].channel_arn #=> String
1165
- # resp.streams[0].state #=> String, one of "LIVE", "OFFLINE"
1166
1295
  # resp.streams[0].health #=> String, one of "HEALTHY", "STARVING", "UNKNOWN"
1167
- # resp.streams[0].viewer_count #=> Integer
1168
1296
  # resp.streams[0].start_time #=> Time
1169
- # resp.next_token #=> String
1297
+ # resp.streams[0].state #=> String, one of "LIVE", "OFFLINE"
1298
+ # resp.streams[0].stream_id #=> String
1299
+ # resp.streams[0].viewer_count #=> Integer
1170
1300
  #
1171
1301
  # @see http://docs.aws.amazon.com/goto/WebAPI/ivs-2020-07-14/ListStreams AWS API Documentation
1172
1302
  #
@@ -1177,38 +1307,25 @@ module Aws::IVS
1177
1307
  req.send_request(options)
1178
1308
  end
1179
1309
 
1180
- # Gets information about AWS tags for the specified ARN.
1310
+ # Gets information about Amazon Web Services tags for the specified ARN.
1181
1311
  #
1182
1312
  # @option params [required, String] :resource_arn
1183
1313
  # The ARN of the resource to be retrieved.
1184
1314
  #
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
1315
  # @return [Types::ListTagsForResourceResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
1193
1316
  #
1194
1317
  # * {Types::ListTagsForResourceResponse#tags #tags} => Hash&lt;String,String&gt;
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
1318
  #
1199
1319
  # @example Request syntax with placeholder values
1200
1320
  #
1201
1321
  # resp = client.list_tags_for_resource({
1202
1322
  # resource_arn: "ResourceArn", # required
1203
- # next_token: "String",
1204
- # max_results: 1,
1205
1323
  # })
1206
1324
  #
1207
1325
  # @example Response structure
1208
1326
  #
1209
1327
  # resp.tags #=> Hash
1210
1328
  # resp.tags["TagKey"] #=> String
1211
- # resp.next_token #=> String
1212
1329
  #
1213
1330
  # @see http://docs.aws.amazon.com/goto/WebAPI/ivs-2020-07-14/ListTagsForResource AWS API Documentation
1214
1331
  #
@@ -1219,12 +1336,12 @@ module Aws::IVS
1219
1336
  req.send_request(options)
1220
1337
  end
1221
1338
 
1222
- # Inserts metadata into the active stream of the specified channel. A
1223
- # maximum of 5 requests per second per channel is allowed, each with a
1339
+ # Inserts metadata into the active stream of the specified channel. At
1340
+ # most 5 requests per second per channel are allowed, each with a
1224
1341
  # 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*.
1342
+ # recommend batching your data into a single PutMetadata call.) At most
1343
+ # 155 requests per second per account are allowed. Also see [Embedding
1344
+ # Metadata within a Video Stream][1] in the *Amazon IVS User Guide*.
1228
1345
  #
1229
1346
  #
1230
1347
  #
@@ -1285,7 +1402,8 @@ module Aws::IVS
1285
1402
  req.send_request(options)
1286
1403
  end
1287
1404
 
1288
- # Adds or updates tags for the AWS resource with the specified ARN.
1405
+ # Adds or updates tags for the Amazon Web Services resource with the
1406
+ # specified ARN.
1289
1407
  #
1290
1408
  # @option params [required, String] :resource_arn
1291
1409
  # ARN of the resource for which tags are to be added or updated.
@@ -1346,8 +1464,8 @@ module Aws::IVS
1346
1464
  # @option params [required, String] :arn
1347
1465
  # ARN of the channel to be updated.
1348
1466
  #
1349
- # @option params [String] :name
1350
- # Channel name.
1467
+ # @option params [Boolean] :authorized
1468
+ # Whether the channel is private (enabled for playback authorization).
1351
1469
  #
1352
1470
  # @option params [String] :latency_mode
1353
1471
  # Channel latency mode. Use `NORMAL` to broadcast and deliver live video
@@ -1355,6 +1473,14 @@ module Aws::IVS
1355
1473
  # (Note: In the Amazon IVS console, `LOW` and `NORMAL` correspond to
1356
1474
  # Ultra-low and Standard, respectively.)
1357
1475
  #
1476
+ # @option params [String] :name
1477
+ # Channel name.
1478
+ #
1479
+ # @option params [String] :recording_configuration_arn
1480
+ # Recording-configuration ARN. If this is set to an empty string,
1481
+ # recording is disabled. A value other than an empty string indicates
1482
+ # that recording is enabled
1483
+ #
1358
1484
  # @option params [String] :type
1359
1485
  # Channel type, which determines the allowable resolution and bitrate.
1360
1486
  # *If you exceed the allowable resolution or bitrate, the stream
@@ -1362,21 +1488,13 @@ module Aws::IVS
1362
1488
  #
1363
1489
  # * `STANDARD`\: Multiple qualities are generated from the original
1364
1490
  # input, to automatically give viewers the best experience for their
1365
- # devices and network conditions. Vertical resolution can be up to
1366
- # 1080 and bitrate can be up to 8.5 Mbps.
1491
+ # devices and network conditions. Resolution can be up to 1080p and
1492
+ # bitrate can be up to 8.5 Mbps. Audio is transcoded only for
1493
+ # renditions 360p and below; above that, audio is passed through.
1367
1494
  #
1368
1495
  # * `BASIC`\: Amazon IVS delivers the original input to viewers. The
1369
1496
  # viewer’s video-quality choice is limited to the original input.
1370
- # Vertical resolution can be up to 480 and bitrate can be up to 1.5
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
1497
+ # Resolution can be up to 480p and bitrate can be up to 1.5 Mbps.
1380
1498
  #
1381
1499
  # @return [Types::UpdateChannelResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
1382
1500
  #
@@ -1386,25 +1504,25 @@ module Aws::IVS
1386
1504
  #
1387
1505
  # resp = client.update_channel({
1388
1506
  # arn: "ChannelArn", # required
1389
- # name: "ChannelName",
1390
- # latency_mode: "NORMAL", # accepts NORMAL, LOW
1391
- # type: "BASIC", # accepts BASIC, STANDARD
1392
1507
  # authorized: false,
1508
+ # latency_mode: "NORMAL", # accepts NORMAL, LOW
1509
+ # name: "ChannelName",
1393
1510
  # recording_configuration_arn: "ChannelRecordingConfigurationArn",
1511
+ # type: "BASIC", # accepts BASIC, STANDARD
1394
1512
  # })
1395
1513
  #
1396
1514
  # @example Response structure
1397
1515
  #
1398
1516
  # resp.channel.arn #=> String
1399
- # resp.channel.name #=> String
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
1517
+ # resp.channel.authorized #=> Boolean
1403
1518
  # resp.channel.ingest_endpoint #=> String
1519
+ # resp.channel.latency_mode #=> String, one of "NORMAL", "LOW"
1520
+ # resp.channel.name #=> String
1404
1521
  # resp.channel.playback_url #=> String
1405
- # resp.channel.authorized #=> Boolean
1522
+ # resp.channel.recording_configuration_arn #=> String
1406
1523
  # resp.channel.tags #=> Hash
1407
1524
  # resp.channel.tags["TagKey"] #=> String
1525
+ # resp.channel.type #=> String, one of "BASIC", "STANDARD"
1408
1526
  #
1409
1527
  # @see http://docs.aws.amazon.com/goto/WebAPI/ivs-2020-07-14/UpdateChannel AWS API Documentation
1410
1528
  #
@@ -1428,7 +1546,7 @@ module Aws::IVS
1428
1546
  params: params,
1429
1547
  config: config)
1430
1548
  context[:gem_name] = 'aws-sdk-ivs'
1431
- context[:gem_version] = '1.11.0'
1549
+ context[:gem_version] = '1.15.0'
1432
1550
  Seahorse::Client::Request.new(handlers, context)
1433
1551
  end
1434
1552