aws-sdk-ivs 1.12.0 → 1.16.0

Sign up to get free protection for your applications and to get access to all the features.
@@ -119,7 +119,9 @@ module Aws::IVS
119
119
  # * EC2/ECS IMDS instance profile - When used by default, the timeouts
120
120
  # are very aggressive. Construct and pass an instance of
121
121
  # `Aws::InstanceProfileCredentails` or `Aws::ECSCredentials` to
122
- # enable retries and extended timeouts.
122
+ # enable retries and extended timeouts. Instance profile credential
123
+ # fetching can be disabled by setting ENV['AWS_EC2_METADATA_DISABLED']
124
+ # to true.
123
125
  #
124
126
  # @option options [required, String] :region
125
127
  # The AWS region to connect to. The configured `:region` is
@@ -275,6 +277,15 @@ module Aws::IVS
275
277
  # ** Please note ** When response stubbing is enabled, no HTTP
276
278
  # requests are made, and retries are disabled.
277
279
  #
280
+ # @option options [Boolean] :use_dualstack_endpoint
281
+ # When set to `true`, dualstack enabled endpoints (with `.aws` TLD)
282
+ # will be used if available.
283
+ #
284
+ # @option options [Boolean] :use_fips_endpoint
285
+ # When set to `true`, fips compatible endpoints will be used if available.
286
+ # When a `fips` region is used, the region is normalized and this config
287
+ # is set to `true`.
288
+ #
278
289
  # @option options [Boolean] :validate_params (true)
279
290
  # When `true`, request parameters are validated before
280
291
  # sending the request.
@@ -347,15 +358,15 @@ module Aws::IVS
347
358
  #
348
359
  # resp.channels #=> Array
349
360
  # 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
361
+ # resp.channels[0].authorized #=> Boolean
354
362
  # resp.channels[0].ingest_endpoint #=> String
363
+ # resp.channels[0].latency_mode #=> String, one of "NORMAL", "LOW"
364
+ # resp.channels[0].name #=> String
355
365
  # resp.channels[0].playback_url #=> String
356
- # resp.channels[0].authorized #=> Boolean
366
+ # resp.channels[0].recording_configuration_arn #=> String
357
367
  # resp.channels[0].tags #=> Hash
358
368
  # resp.channels[0].tags["TagKey"] #=> String
369
+ # resp.channels[0].type #=> String, one of "BASIC", "STANDARD"
359
370
  # resp.errors #=> Array
360
371
  # resp.errors[0].arn #=> String
361
372
  # resp.errors[0].code #=> String
@@ -377,8 +388,8 @@ module Aws::IVS
377
388
  #
378
389
  # @return [Types::BatchGetStreamKeyResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
379
390
  #
380
- # * {Types::BatchGetStreamKeyResponse#stream_keys #stream_keys} => Array<Types::StreamKey>
381
391
  # * {Types::BatchGetStreamKeyResponse#errors #errors} => Array<Types::BatchError>
392
+ # * {Types::BatchGetStreamKeyResponse#stream_keys #stream_keys} => Array<Types::StreamKey>
382
393
  #
383
394
  # @example Request syntax with placeholder values
384
395
  #
@@ -388,16 +399,16 @@ module Aws::IVS
388
399
  #
389
400
  # @example Response structure
390
401
  #
402
+ # resp.errors #=> Array
403
+ # resp.errors[0].arn #=> String
404
+ # resp.errors[0].code #=> String
405
+ # resp.errors[0].message #=> String
391
406
  # resp.stream_keys #=> Array
392
407
  # resp.stream_keys[0].arn #=> String
393
- # resp.stream_keys[0].value #=> String
394
408
  # resp.stream_keys[0].channel_arn #=> String
395
409
  # resp.stream_keys[0].tags #=> Hash
396
410
  # 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
411
+ # resp.stream_keys[0].value #=> String
401
412
  #
402
413
  # @see http://docs.aws.amazon.com/goto/WebAPI/ivs-2020-07-14/BatchGetStreamKey AWS API Documentation
403
414
  #
@@ -410,8 +421,9 @@ module Aws::IVS
410
421
 
411
422
  # Creates a new channel and an associated stream key to start streaming.
412
423
  #
413
- # @option params [String] :name
414
- # Channel name.
424
+ # @option params [Boolean] :authorized
425
+ # Whether the channel is private (enabled for playback authorization).
426
+ # Default: `false`.
415
427
  #
416
428
  # @option params [String] :latency_mode
417
429
  # Channel latency mode. Use `NORMAL` to broadcast and deliver live video
@@ -419,6 +431,16 @@ module Aws::IVS
419
431
  # (Note: In the Amazon IVS console, `LOW` and `NORMAL` correspond to
420
432
  # Ultra-low and Standard, respectively.) Default: `LOW`.
421
433
  #
434
+ # @option params [String] :name
435
+ # Channel name.
436
+ #
437
+ # @option params [String] :recording_configuration_arn
438
+ # Recording-configuration ARN. Default: "" (empty string, recording is
439
+ # disabled).
440
+ #
441
+ # @option params [Hash<String,String>] :tags
442
+ # Array of 1-50 maps, each of the form `string:string (key:value)`.
443
+ #
422
444
  # @option params [String] :type
423
445
  # Channel type, which determines the allowable resolution and bitrate.
424
446
  # *If you exceed the allowable resolution or bitrate, the stream
@@ -427,24 +449,13 @@ module Aws::IVS
427
449
  #
428
450
  # * `STANDARD`\: Multiple qualities are generated from the original
429
451
  # 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.
452
+ # devices and network conditions. Resolution can be up to 1080p and
453
+ # bitrate can be up to 8.5 Mbps. Audio is transcoded only for
454
+ # renditions 360p and below; above that, audio is passed through.
432
455
  #
433
456
  # * `BASIC`\: Amazon IVS delivers the original input to viewers. The
434
457
  # 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)`.
458
+ # Resolution can be up to 480p and bitrate can be up to 1.5 Mbps.
448
459
  #
449
460
  # @return [Types::CreateChannelResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
450
461
  #
@@ -454,33 +465,33 @@ module Aws::IVS
454
465
  # @example Request syntax with placeholder values
455
466
  #
456
467
  # resp = client.create_channel({
457
- # name: "ChannelName",
458
- # latency_mode: "NORMAL", # accepts NORMAL, LOW
459
- # type: "BASIC", # accepts BASIC, STANDARD
460
468
  # authorized: false,
469
+ # latency_mode: "NORMAL", # accepts NORMAL, LOW
470
+ # name: "ChannelName",
461
471
  # recording_configuration_arn: "ChannelRecordingConfigurationArn",
462
472
  # tags: {
463
473
  # "TagKey" => "TagValue",
464
474
  # },
475
+ # type: "BASIC", # accepts BASIC, STANDARD
465
476
  # })
466
477
  #
467
478
  # @example Response structure
468
479
  #
469
480
  # 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
481
+ # resp.channel.authorized #=> Boolean
474
482
  # resp.channel.ingest_endpoint #=> String
483
+ # resp.channel.latency_mode #=> String, one of "NORMAL", "LOW"
484
+ # resp.channel.name #=> String
475
485
  # resp.channel.playback_url #=> String
476
- # resp.channel.authorized #=> Boolean
486
+ # resp.channel.recording_configuration_arn #=> String
477
487
  # resp.channel.tags #=> Hash
478
488
  # resp.channel.tags["TagKey"] #=> String
489
+ # resp.channel.type #=> String, one of "BASIC", "STANDARD"
479
490
  # resp.stream_key.arn #=> String
480
- # resp.stream_key.value #=> String
481
491
  # resp.stream_key.channel_arn #=> String
482
492
  # resp.stream_key.tags #=> Hash
483
493
  # resp.stream_key.tags["TagKey"] #=> String
494
+ # resp.stream_key.value #=> String
484
495
  #
485
496
  # @see http://docs.aws.amazon.com/goto/WebAPI/ivs-2020-07-14/CreateChannel AWS API Documentation
486
497
  #
@@ -494,12 +505,12 @@ module Aws::IVS
494
505
  # Creates a new recording configuration, used to enable recording to
495
506
  # Amazon S3.
496
507
  #
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.)
508
+ # **Known issue:** In the us-east-1 region, if you use the Amazon Web
509
+ # Services CLI to create a recording configuration, it returns success
510
+ # even if the S3 bucket is in a different region. In this case, the
511
+ # `state` of the recording configuration is `CREATE_FAILED` (instead of
512
+ # `ACTIVE`). (In other regions, the CLI correctly returns failure if the
513
+ # bucket is in a different region.)
503
514
  #
504
515
  # **Workaround:** Ensure that your S3 bucket is in the same region as
505
516
  # the recording configuration. If you create a recording configuration
@@ -507,14 +518,13 @@ module Aws::IVS
507
518
  # configuration and create a new one with an S3 bucket from the correct
508
519
  # region.
509
520
  #
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
521
  # @option params [required, Types::DestinationConfiguration] :destination_configuration
515
522
  # A complex type that contains a destination configuration for where
516
523
  # recorded video will be stored.
517
524
  #
525
+ # @option params [String] :name
526
+ # Recording-configuration name. The value does not need to be unique.
527
+ #
518
528
  # @option params [Hash<String,String>] :tags
519
529
  # Array of 1-50 maps, each of the form `string:string (key:value)`.
520
530
  #
@@ -525,12 +535,12 @@ module Aws::IVS
525
535
  # @example Request syntax with placeholder values
526
536
  #
527
537
  # resp = client.create_recording_configuration({
528
- # name: "RecordingConfigurationName",
529
538
  # destination_configuration: { # required
530
539
  # s3: {
531
540
  # bucket_name: "S3DestinationBucketName", # required
532
541
  # },
533
542
  # },
543
+ # name: "RecordingConfigurationName",
534
544
  # tags: {
535
545
  # "TagKey" => "TagValue",
536
546
  # },
@@ -539,8 +549,8 @@ module Aws::IVS
539
549
  # @example Response structure
540
550
  #
541
551
  # resp.recording_configuration.arn #=> String
542
- # resp.recording_configuration.name #=> String
543
552
  # resp.recording_configuration.destination_configuration.s3.bucket_name #=> String
553
+ # resp.recording_configuration.name #=> String
544
554
  # resp.recording_configuration.state #=> String, one of "CREATING", "CREATE_FAILED", "ACTIVE"
545
555
  # resp.recording_configuration.tags #=> Hash
546
556
  # resp.recording_configuration.tags["TagKey"] #=> String
@@ -585,10 +595,10 @@ module Aws::IVS
585
595
  # @example Response structure
586
596
  #
587
597
  # resp.stream_key.arn #=> String
588
- # resp.stream_key.value #=> String
589
598
  # resp.stream_key.channel_arn #=> String
590
599
  # resp.stream_key.tags #=> Hash
591
600
  # resp.stream_key.tags["TagKey"] #=> String
601
+ # resp.stream_key.value #=> String
592
602
  #
593
603
  # @see http://docs.aws.amazon.com/goto/WebAPI/ivs-2020-07-14/CreateStreamKey AWS API Documentation
594
604
  #
@@ -730,15 +740,15 @@ module Aws::IVS
730
740
  # @example Response structure
731
741
  #
732
742
  # 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
743
+ # resp.channel.authorized #=> Boolean
737
744
  # resp.channel.ingest_endpoint #=> String
745
+ # resp.channel.latency_mode #=> String, one of "NORMAL", "LOW"
746
+ # resp.channel.name #=> String
738
747
  # resp.channel.playback_url #=> String
739
- # resp.channel.authorized #=> Boolean
748
+ # resp.channel.recording_configuration_arn #=> String
740
749
  # resp.channel.tags #=> Hash
741
750
  # resp.channel.tags["TagKey"] #=> String
751
+ # resp.channel.type #=> String, one of "BASIC", "STANDARD"
742
752
  #
743
753
  # @see http://docs.aws.amazon.com/goto/WebAPI/ivs-2020-07-14/GetChannel AWS API Documentation
744
754
  #
@@ -775,8 +785,8 @@ module Aws::IVS
775
785
  # @example Response structure
776
786
  #
777
787
  # resp.key_pair.arn #=> String
778
- # resp.key_pair.name #=> String
779
788
  # resp.key_pair.fingerprint #=> String
789
+ # resp.key_pair.name #=> String
780
790
  # resp.key_pair.tags #=> Hash
781
791
  # resp.key_pair.tags["TagKey"] #=> String
782
792
  #
@@ -807,8 +817,8 @@ module Aws::IVS
807
817
  # @example Response structure
808
818
  #
809
819
  # resp.recording_configuration.arn #=> String
810
- # resp.recording_configuration.name #=> String
811
820
  # resp.recording_configuration.destination_configuration.s3.bucket_name #=> String
821
+ # resp.recording_configuration.name #=> String
812
822
  # resp.recording_configuration.state #=> String, one of "CREATING", "CREATE_FAILED", "ACTIVE"
813
823
  # resp.recording_configuration.tags #=> Hash
814
824
  # resp.recording_configuration.tags["TagKey"] #=> String
@@ -841,10 +851,11 @@ module Aws::IVS
841
851
  # @example Response structure
842
852
  #
843
853
  # resp.stream.channel_arn #=> String
854
+ # resp.stream.health #=> String, one of "HEALTHY", "STARVING", "UNKNOWN"
844
855
  # resp.stream.playback_url #=> String
845
856
  # resp.stream.start_time #=> Time
846
857
  # resp.stream.state #=> String, one of "LIVE", "OFFLINE"
847
- # resp.stream.health #=> String, one of "HEALTHY", "STARVING", "UNKNOWN"
858
+ # resp.stream.stream_id #=> String
848
859
  # resp.stream.viewer_count #=> Integer
849
860
  #
850
861
  # @see http://docs.aws.amazon.com/goto/WebAPI/ivs-2020-07-14/GetStream AWS API Documentation
@@ -874,10 +885,10 @@ module Aws::IVS
874
885
  # @example Response structure
875
886
  #
876
887
  # resp.stream_key.arn #=> String
877
- # resp.stream_key.value #=> String
878
888
  # resp.stream_key.channel_arn #=> String
879
889
  # resp.stream_key.tags #=> Hash
880
890
  # resp.stream_key.tags["TagKey"] #=> String
891
+ # resp.stream_key.value #=> String
881
892
  #
882
893
  # @see http://docs.aws.amazon.com/goto/WebAPI/ivs-2020-07-14/GetStreamKey AWS API Documentation
883
894
  #
@@ -888,6 +899,74 @@ module Aws::IVS
888
899
  req.send_request(options)
889
900
  end
890
901
 
902
+ # Gets metadata on a specified stream.
903
+ #
904
+ # @option params [required, String] :channel_arn
905
+ # ARN of the channel resource
906
+ #
907
+ # @option params [String] :stream_id
908
+ # Unique identifier for a live or previously live stream in the
909
+ # specified channel. If no `streamId` is provided, this returns the most
910
+ # recent stream session for the channel, if it exists.
911
+ #
912
+ # @return [Types::GetStreamSessionResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
913
+ #
914
+ # * {Types::GetStreamSessionResponse#stream_session #stream_session} => Types::StreamSession
915
+ #
916
+ # @example Request syntax with placeholder values
917
+ #
918
+ # resp = client.get_stream_session({
919
+ # channel_arn: "ChannelArn", # required
920
+ # stream_id: "StreamId",
921
+ # })
922
+ #
923
+ # @example Response structure
924
+ #
925
+ # resp.stream_session.channel.arn #=> String
926
+ # resp.stream_session.channel.authorized #=> Boolean
927
+ # resp.stream_session.channel.ingest_endpoint #=> String
928
+ # resp.stream_session.channel.latency_mode #=> String, one of "NORMAL", "LOW"
929
+ # resp.stream_session.channel.name #=> String
930
+ # resp.stream_session.channel.playback_url #=> String
931
+ # resp.stream_session.channel.recording_configuration_arn #=> String
932
+ # resp.stream_session.channel.tags #=> Hash
933
+ # resp.stream_session.channel.tags["TagKey"] #=> String
934
+ # resp.stream_session.channel.type #=> String, one of "BASIC", "STANDARD"
935
+ # resp.stream_session.end_time #=> Time
936
+ # resp.stream_session.ingest_configuration.audio.channels #=> Integer
937
+ # resp.stream_session.ingest_configuration.audio.codec #=> String
938
+ # resp.stream_session.ingest_configuration.audio.sample_rate #=> Integer
939
+ # resp.stream_session.ingest_configuration.audio.target_bitrate #=> Integer
940
+ # resp.stream_session.ingest_configuration.video.avc_level #=> String
941
+ # resp.stream_session.ingest_configuration.video.avc_profile #=> String
942
+ # resp.stream_session.ingest_configuration.video.codec #=> String
943
+ # resp.stream_session.ingest_configuration.video.encoder #=> String
944
+ # resp.stream_session.ingest_configuration.video.target_bitrate #=> Integer
945
+ # resp.stream_session.ingest_configuration.video.target_framerate #=> Integer
946
+ # resp.stream_session.ingest_configuration.video.video_height #=> Integer
947
+ # resp.stream_session.ingest_configuration.video.video_width #=> Integer
948
+ # resp.stream_session.recording_configuration.arn #=> String
949
+ # resp.stream_session.recording_configuration.destination_configuration.s3.bucket_name #=> String
950
+ # resp.stream_session.recording_configuration.name #=> String
951
+ # resp.stream_session.recording_configuration.state #=> String, one of "CREATING", "CREATE_FAILED", "ACTIVE"
952
+ # resp.stream_session.recording_configuration.tags #=> Hash
953
+ # resp.stream_session.recording_configuration.tags["TagKey"] #=> String
954
+ # resp.stream_session.start_time #=> Time
955
+ # resp.stream_session.stream_id #=> String
956
+ # resp.stream_session.truncated_events #=> Array
957
+ # resp.stream_session.truncated_events[0].event_time #=> Time
958
+ # resp.stream_session.truncated_events[0].name #=> String
959
+ # resp.stream_session.truncated_events[0].type #=> String
960
+ #
961
+ # @see http://docs.aws.amazon.com/goto/WebAPI/ivs-2020-07-14/GetStreamSession AWS API Documentation
962
+ #
963
+ # @overload get_stream_session(params = {})
964
+ # @param [Hash] params ({})
965
+ def get_stream_session(params = {}, options = {})
966
+ req = build_request(:get_stream_session, params)
967
+ req.send_request(options)
968
+ end
969
+
891
970
  # Imports the public portion of a new key pair and returns its `arn` and
892
971
  # `fingerprint`. The `privateKey` can then be used to generate viewer
893
972
  # authorization tokens, to grant viewers access to private channels. For
@@ -898,14 +977,12 @@ module Aws::IVS
898
977
  #
899
978
  # [1]: https://docs.aws.amazon.com/ivs/latest/userguide/private-channels.html
900
979
  #
980
+ # @option params [String] :name
981
+ # Playback-key-pair name. The value does not need to be unique.
982
+ #
901
983
  # @option params [required, String] :public_key_material
902
984
  # The public portion of a customer-generated key pair.
903
985
  #
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
986
  # @option params [Hash<String,String>] :tags
910
987
  # Any tags provided with the request are added to the playback key pair
911
988
  # tags.
@@ -917,8 +994,8 @@ module Aws::IVS
917
994
  # @example Request syntax with placeholder values
918
995
  #
919
996
  # resp = client.import_playback_key_pair({
920
- # public_key_material: "PlaybackPublicKeyMaterial", # required
921
997
  # name: "PlaybackKeyPairName",
998
+ # public_key_material: "PlaybackPublicKeyMaterial", # required
922
999
  # tags: {
923
1000
  # "TagKey" => "TagValue",
924
1001
  # },
@@ -927,8 +1004,8 @@ module Aws::IVS
927
1004
  # @example Response structure
928
1005
  #
929
1006
  # resp.key_pair.arn #=> String
930
- # resp.key_pair.name #=> String
931
1007
  # resp.key_pair.fingerprint #=> String
1008
+ # resp.key_pair.name #=> String
932
1009
  # resp.key_pair.tags #=> Hash
933
1010
  # resp.key_pair.tags["TagKey"] #=> String
934
1011
  #
@@ -942,10 +1019,11 @@ module Aws::IVS
942
1019
  end
943
1020
 
944
1021
  # 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).
1022
+ # Amazon Web Services region where the API request is processed. This
1023
+ # list can be filtered to match a specified name or
1024
+ # recording-configuration ARN. Filters are mutually exclusive and cannot
1025
+ # be used together. If you try to use both filters, you will get an
1026
+ # error (409 ConflictException).
949
1027
  #
950
1028
  # @option params [String] :filter_by_name
951
1029
  # Filters the channel list to match the specified name.
@@ -954,13 +1032,13 @@ module Aws::IVS
954
1032
  # Filters the channel list to match the specified
955
1033
  # recording-configuration ARN.
956
1034
  #
1035
+ # @option params [Integer] :max_results
1036
+ # Maximum number of channels to return. Default: 50.
1037
+ #
957
1038
  # @option params [String] :next_token
958
1039
  # The first channel to retrieve. This is used for pagination; see the
959
1040
  # `nextToken` response field.
960
1041
  #
961
- # @option params [Integer] :max_results
962
- # Maximum number of channels to return. Default: 50.
963
- #
964
1042
  # @return [Types::ListChannelsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
965
1043
  #
966
1044
  # * {Types::ListChannelsResponse#channels #channels} => Array&lt;Types::ChannelSummary&gt;
@@ -973,17 +1051,17 @@ module Aws::IVS
973
1051
  # resp = client.list_channels({
974
1052
  # filter_by_name: "ChannelName",
975
1053
  # filter_by_recording_configuration_arn: "ChannelRecordingConfigurationArn",
976
- # next_token: "PaginationToken",
977
1054
  # max_results: 1,
1055
+ # next_token: "PaginationToken",
978
1056
  # })
979
1057
  #
980
1058
  # @example Response structure
981
1059
  #
982
1060
  # resp.channels #=> Array
983
1061
  # resp.channels[0].arn #=> String
984
- # resp.channels[0].name #=> String
985
- # resp.channels[0].latency_mode #=> String, one of "NORMAL", "LOW"
986
1062
  # resp.channels[0].authorized #=> Boolean
1063
+ # resp.channels[0].latency_mode #=> String, one of "NORMAL", "LOW"
1064
+ # resp.channels[0].name #=> String
987
1065
  # resp.channels[0].recording_configuration_arn #=> String
988
1066
  # resp.channels[0].tags #=> Hash
989
1067
  # resp.channels[0].tags["TagKey"] #=> String
@@ -1006,13 +1084,13 @@ module Aws::IVS
1006
1084
  #
1007
1085
  # [1]: https://docs.aws.amazon.com/ivs/latest/userguide/private-channels.html
1008
1086
  #
1009
- # @option params [String] :next_token
1010
- # Maximum number of key pairs to return.
1011
- #
1012
1087
  # @option params [Integer] :max_results
1013
1088
  # The first key pair to retrieve. This is used for pagination; see the
1014
1089
  # `nextToken` response field. Default: 50.
1015
1090
  #
1091
+ # @option params [String] :next_token
1092
+ # Maximum number of key pairs to return.
1093
+ #
1016
1094
  # @return [Types::ListPlaybackKeyPairsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
1017
1095
  #
1018
1096
  # * {Types::ListPlaybackKeyPairsResponse#key_pairs #key_pairs} => Array&lt;Types::PlaybackKeyPairSummary&gt;
@@ -1023,8 +1101,8 @@ module Aws::IVS
1023
1101
  # @example Request syntax with placeholder values
1024
1102
  #
1025
1103
  # resp = client.list_playback_key_pairs({
1026
- # next_token: "PaginationToken",
1027
1104
  # max_results: 1,
1105
+ # next_token: "PaginationToken",
1028
1106
  # })
1029
1107
  #
1030
1108
  # @example Response structure
@@ -1046,39 +1124,40 @@ module Aws::IVS
1046
1124
  end
1047
1125
 
1048
1126
  # Gets summary information about all recording configurations in your
1049
- # account, in the AWS region where the API request is processed.
1127
+ # account, in the Amazon Web Services region where the API request is
1128
+ # processed.
1129
+ #
1130
+ # @option params [Integer] :max_results
1131
+ # Maximum number of recording configurations to return. Default: 50.
1050
1132
  #
1051
1133
  # @option params [String] :next_token
1052
1134
  # The first recording configuration to retrieve. This is used for
1053
1135
  # pagination; see the `nextToken` response field.
1054
1136
  #
1055
- # @option params [Integer] :max_results
1056
- # Maximum number of recording configurations to return. Default: 50.
1057
- #
1058
1137
  # @return [Types::ListRecordingConfigurationsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
1059
1138
  #
1060
- # * {Types::ListRecordingConfigurationsResponse#recording_configurations #recording_configurations} => Array&lt;Types::RecordingConfigurationSummary&gt;
1061
1139
  # * {Types::ListRecordingConfigurationsResponse#next_token #next_token} => String
1140
+ # * {Types::ListRecordingConfigurationsResponse#recording_configurations #recording_configurations} => Array&lt;Types::RecordingConfigurationSummary&gt;
1062
1141
  #
1063
1142
  # The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
1064
1143
  #
1065
1144
  # @example Request syntax with placeholder values
1066
1145
  #
1067
1146
  # resp = client.list_recording_configurations({
1068
- # next_token: "PaginationToken",
1069
1147
  # max_results: 1,
1148
+ # next_token: "PaginationToken",
1070
1149
  # })
1071
1150
  #
1072
1151
  # @example Response structure
1073
1152
  #
1153
+ # resp.next_token #=> String
1074
1154
  # resp.recording_configurations #=> Array
1075
1155
  # resp.recording_configurations[0].arn #=> String
1076
- # resp.recording_configurations[0].name #=> String
1077
1156
  # resp.recording_configurations[0].destination_configuration.s3.bucket_name #=> String
1157
+ # resp.recording_configurations[0].name #=> String
1078
1158
  # resp.recording_configurations[0].state #=> String, one of "CREATING", "CREATE_FAILED", "ACTIVE"
1079
1159
  # resp.recording_configurations[0].tags #=> Hash
1080
1160
  # resp.recording_configurations[0].tags["TagKey"] #=> String
1081
- # resp.next_token #=> String
1082
1161
  #
1083
1162
  # @see http://docs.aws.amazon.com/goto/WebAPI/ivs-2020-07-14/ListRecordingConfigurations AWS API Documentation
1084
1163
  #
@@ -1094,17 +1173,17 @@ module Aws::IVS
1094
1173
  # @option params [required, String] :channel_arn
1095
1174
  # Channel ARN used to filter the list.
1096
1175
  #
1176
+ # @option params [Integer] :max_results
1177
+ # Maximum number of streamKeys to return. Default: 50.
1178
+ #
1097
1179
  # @option params [String] :next_token
1098
1180
  # The first stream key to retrieve. This is used for pagination; see the
1099
1181
  # `nextToken` response field.
1100
1182
  #
1101
- # @option params [Integer] :max_results
1102
- # Maximum number of streamKeys to return. Default: 50.
1103
- #
1104
1183
  # @return [Types::ListStreamKeysResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
1105
1184
  #
1106
- # * {Types::ListStreamKeysResponse#stream_keys #stream_keys} => Array&lt;Types::StreamKeySummary&gt;
1107
1185
  # * {Types::ListStreamKeysResponse#next_token #next_token} => String
1186
+ # * {Types::ListStreamKeysResponse#stream_keys #stream_keys} => Array&lt;Types::StreamKeySummary&gt;
1108
1187
  #
1109
1188
  # The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
1110
1189
  #
@@ -1112,18 +1191,18 @@ module Aws::IVS
1112
1191
  #
1113
1192
  # resp = client.list_stream_keys({
1114
1193
  # channel_arn: "ChannelArn", # required
1115
- # next_token: "PaginationToken",
1116
1194
  # max_results: 1,
1195
+ # next_token: "PaginationToken",
1117
1196
  # })
1118
1197
  #
1119
1198
  # @example Response structure
1120
1199
  #
1200
+ # resp.next_token #=> String
1121
1201
  # resp.stream_keys #=> Array
1122
1202
  # resp.stream_keys[0].arn #=> String
1123
1203
  # resp.stream_keys[0].channel_arn #=> String
1124
1204
  # resp.stream_keys[0].tags #=> Hash
1125
1205
  # resp.stream_keys[0].tags["TagKey"] #=> String
1126
- # resp.next_token #=> String
1127
1206
  #
1128
1207
  # @see http://docs.aws.amazon.com/goto/WebAPI/ivs-2020-07-14/ListStreamKeys AWS API Documentation
1129
1208
  #
@@ -1134,39 +1213,92 @@ module Aws::IVS
1134
1213
  req.send_request(options)
1135
1214
  end
1136
1215
 
1137
- # Gets summary information about live streams in your account, in the
1138
- # AWS region where the API request is processed.
1216
+ # Gets a summary of current and previous streams for a specified channel
1217
+ # in your account, in the AWS region where the API request is processed.
1218
+ #
1219
+ # @option params [required, String] :channel_arn
1220
+ # Channel ARN used to filter the list.
1221
+ #
1222
+ # @option params [Integer] :max_results
1223
+ # Maximum number of streams to return. Default: 50.
1139
1224
  #
1140
1225
  # @option params [String] :next_token
1141
1226
  # The first stream to retrieve. This is used for pagination; see the
1142
1227
  # `nextToken` response field.
1143
1228
  #
1229
+ # @return [Types::ListStreamSessionsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
1230
+ #
1231
+ # * {Types::ListStreamSessionsResponse#next_token #next_token} => String
1232
+ # * {Types::ListStreamSessionsResponse#stream_sessions #stream_sessions} => Array&lt;Types::StreamSessionSummary&gt;
1233
+ #
1234
+ # The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
1235
+ #
1236
+ # @example Request syntax with placeholder values
1237
+ #
1238
+ # resp = client.list_stream_sessions({
1239
+ # channel_arn: "ChannelArn", # required
1240
+ # max_results: 1,
1241
+ # next_token: "PaginationToken",
1242
+ # })
1243
+ #
1244
+ # @example Response structure
1245
+ #
1246
+ # resp.next_token #=> String
1247
+ # resp.stream_sessions #=> Array
1248
+ # resp.stream_sessions[0].end_time #=> Time
1249
+ # resp.stream_sessions[0].has_error_event #=> Boolean
1250
+ # resp.stream_sessions[0].start_time #=> Time
1251
+ # resp.stream_sessions[0].stream_id #=> String
1252
+ #
1253
+ # @see http://docs.aws.amazon.com/goto/WebAPI/ivs-2020-07-14/ListStreamSessions AWS API Documentation
1254
+ #
1255
+ # @overload list_stream_sessions(params = {})
1256
+ # @param [Hash] params ({})
1257
+ def list_stream_sessions(params = {}, options = {})
1258
+ req = build_request(:list_stream_sessions, params)
1259
+ req.send_request(options)
1260
+ end
1261
+
1262
+ # Gets summary information about live streams in your account, in the
1263
+ # Amazon Web Services region where the API request is processed.
1264
+ #
1265
+ # @option params [Types::StreamFilters] :filter_by
1266
+ # Filters the stream list to match the specified criterion.
1267
+ #
1144
1268
  # @option params [Integer] :max_results
1145
1269
  # Maximum number of streams to return. Default: 50.
1146
1270
  #
1271
+ # @option params [String] :next_token
1272
+ # The first stream to retrieve. This is used for pagination; see the
1273
+ # `nextToken` response field.
1274
+ #
1147
1275
  # @return [Types::ListStreamsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
1148
1276
  #
1149
- # * {Types::ListStreamsResponse#streams #streams} => Array&lt;Types::StreamSummary&gt;
1150
1277
  # * {Types::ListStreamsResponse#next_token #next_token} => String
1278
+ # * {Types::ListStreamsResponse#streams #streams} => Array&lt;Types::StreamSummary&gt;
1151
1279
  #
1152
1280
  # The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
1153
1281
  #
1154
1282
  # @example Request syntax with placeholder values
1155
1283
  #
1156
1284
  # resp = client.list_streams({
1157
- # next_token: "PaginationToken",
1285
+ # filter_by: {
1286
+ # health: "HEALTHY", # accepts HEALTHY, STARVING, UNKNOWN
1287
+ # },
1158
1288
  # max_results: 1,
1289
+ # next_token: "PaginationToken",
1159
1290
  # })
1160
1291
  #
1161
1292
  # @example Response structure
1162
1293
  #
1294
+ # resp.next_token #=> String
1163
1295
  # resp.streams #=> Array
1164
1296
  # resp.streams[0].channel_arn #=> String
1165
- # resp.streams[0].state #=> String, one of "LIVE", "OFFLINE"
1166
1297
  # resp.streams[0].health #=> String, one of "HEALTHY", "STARVING", "UNKNOWN"
1167
- # resp.streams[0].viewer_count #=> Integer
1168
1298
  # resp.streams[0].start_time #=> Time
1169
- # resp.next_token #=> String
1299
+ # resp.streams[0].state #=> String, one of "LIVE", "OFFLINE"
1300
+ # resp.streams[0].stream_id #=> String
1301
+ # resp.streams[0].viewer_count #=> Integer
1170
1302
  #
1171
1303
  # @see http://docs.aws.amazon.com/goto/WebAPI/ivs-2020-07-14/ListStreams AWS API Documentation
1172
1304
  #
@@ -1177,38 +1309,25 @@ module Aws::IVS
1177
1309
  req.send_request(options)
1178
1310
  end
1179
1311
 
1180
- # Gets information about AWS tags for the specified ARN.
1312
+ # Gets information about Amazon Web Services tags for the specified ARN.
1181
1313
  #
1182
1314
  # @option params [required, String] :resource_arn
1183
1315
  # The ARN of the resource to be retrieved.
1184
1316
  #
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
1317
  # @return [Types::ListTagsForResourceResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
1193
1318
  #
1194
1319
  # * {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
1320
  #
1199
1321
  # @example Request syntax with placeholder values
1200
1322
  #
1201
1323
  # resp = client.list_tags_for_resource({
1202
1324
  # resource_arn: "ResourceArn", # required
1203
- # next_token: "String",
1204
- # max_results: 1,
1205
1325
  # })
1206
1326
  #
1207
1327
  # @example Response structure
1208
1328
  #
1209
1329
  # resp.tags #=> Hash
1210
1330
  # resp.tags["TagKey"] #=> String
1211
- # resp.next_token #=> String
1212
1331
  #
1213
1332
  # @see http://docs.aws.amazon.com/goto/WebAPI/ivs-2020-07-14/ListTagsForResource AWS API Documentation
1214
1333
  #
@@ -1219,12 +1338,12 @@ module Aws::IVS
1219
1338
  req.send_request(options)
1220
1339
  end
1221
1340
 
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
1341
+ # Inserts metadata into the active stream of the specified channel. At
1342
+ # most 5 requests per second per channel are allowed, each with a
1224
1343
  # 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*.
1344
+ # recommend batching your data into a single PutMetadata call.) At most
1345
+ # 155 requests per second per account are allowed. Also see [Embedding
1346
+ # Metadata within a Video Stream][1] in the *Amazon IVS User Guide*.
1228
1347
  #
1229
1348
  #
1230
1349
  #
@@ -1285,7 +1404,8 @@ module Aws::IVS
1285
1404
  req.send_request(options)
1286
1405
  end
1287
1406
 
1288
- # Adds or updates tags for the AWS resource with the specified ARN.
1407
+ # Adds or updates tags for the Amazon Web Services resource with the
1408
+ # specified ARN.
1289
1409
  #
1290
1410
  # @option params [required, String] :resource_arn
1291
1411
  # ARN of the resource for which tags are to be added or updated.
@@ -1346,8 +1466,8 @@ module Aws::IVS
1346
1466
  # @option params [required, String] :arn
1347
1467
  # ARN of the channel to be updated.
1348
1468
  #
1349
- # @option params [String] :name
1350
- # Channel name.
1469
+ # @option params [Boolean] :authorized
1470
+ # Whether the channel is private (enabled for playback authorization).
1351
1471
  #
1352
1472
  # @option params [String] :latency_mode
1353
1473
  # Channel latency mode. Use `NORMAL` to broadcast and deliver live video
@@ -1355,6 +1475,14 @@ module Aws::IVS
1355
1475
  # (Note: In the Amazon IVS console, `LOW` and `NORMAL` correspond to
1356
1476
  # Ultra-low and Standard, respectively.)
1357
1477
  #
1478
+ # @option params [String] :name
1479
+ # Channel name.
1480
+ #
1481
+ # @option params [String] :recording_configuration_arn
1482
+ # Recording-configuration ARN. If this is set to an empty string,
1483
+ # recording is disabled. A value other than an empty string indicates
1484
+ # that recording is enabled
1485
+ #
1358
1486
  # @option params [String] :type
1359
1487
  # Channel type, which determines the allowable resolution and bitrate.
1360
1488
  # *If you exceed the allowable resolution or bitrate, the stream
@@ -1362,21 +1490,13 @@ module Aws::IVS
1362
1490
  #
1363
1491
  # * `STANDARD`\: Multiple qualities are generated from the original
1364
1492
  # 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.
1493
+ # devices and network conditions. Resolution can be up to 1080p and
1494
+ # bitrate can be up to 8.5 Mbps. Audio is transcoded only for
1495
+ # renditions 360p and below; above that, audio is passed through.
1367
1496
  #
1368
1497
  # * `BASIC`\: Amazon IVS delivers the original input to viewers. The
1369
1498
  # 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
1499
+ # Resolution can be up to 480p and bitrate can be up to 1.5 Mbps.
1380
1500
  #
1381
1501
  # @return [Types::UpdateChannelResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
1382
1502
  #
@@ -1386,25 +1506,25 @@ module Aws::IVS
1386
1506
  #
1387
1507
  # resp = client.update_channel({
1388
1508
  # arn: "ChannelArn", # required
1389
- # name: "ChannelName",
1390
- # latency_mode: "NORMAL", # accepts NORMAL, LOW
1391
- # type: "BASIC", # accepts BASIC, STANDARD
1392
1509
  # authorized: false,
1510
+ # latency_mode: "NORMAL", # accepts NORMAL, LOW
1511
+ # name: "ChannelName",
1393
1512
  # recording_configuration_arn: "ChannelRecordingConfigurationArn",
1513
+ # type: "BASIC", # accepts BASIC, STANDARD
1394
1514
  # })
1395
1515
  #
1396
1516
  # @example Response structure
1397
1517
  #
1398
1518
  # 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
1519
+ # resp.channel.authorized #=> Boolean
1403
1520
  # resp.channel.ingest_endpoint #=> String
1521
+ # resp.channel.latency_mode #=> String, one of "NORMAL", "LOW"
1522
+ # resp.channel.name #=> String
1404
1523
  # resp.channel.playback_url #=> String
1405
- # resp.channel.authorized #=> Boolean
1524
+ # resp.channel.recording_configuration_arn #=> String
1406
1525
  # resp.channel.tags #=> Hash
1407
1526
  # resp.channel.tags["TagKey"] #=> String
1527
+ # resp.channel.type #=> String, one of "BASIC", "STANDARD"
1408
1528
  #
1409
1529
  # @see http://docs.aws.amazon.com/goto/WebAPI/ivs-2020-07-14/UpdateChannel AWS API Documentation
1410
1530
  #
@@ -1428,7 +1548,7 @@ module Aws::IVS
1428
1548
  params: params,
1429
1549
  config: config)
1430
1550
  context[:gem_name] = 'aws-sdk-ivs'
1431
- context[:gem_version] = '1.12.0'
1551
+ context[:gem_version] = '1.16.0'
1432
1552
  Seahorse::Client::Request.new(handlers, context)
1433
1553
  end
1434
1554