aws-sdk-ivs 1.0.0 → 1.1.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/lib/aws-sdk-ivs.rb +1 -1
- data/lib/aws-sdk-ivs/client.rb +47 -28
- data/lib/aws-sdk-ivs/client_api.rb +9 -0
- data/lib/aws-sdk-ivs/errors.rb +16 -0
- data/lib/aws-sdk-ivs/types.rb +55 -16
- metadata +2 -2
checksums.yaml
CHANGED
@@ -1,7 +1,7 @@
|
|
1
1
|
---
|
2
2
|
SHA256:
|
3
|
-
metadata.gz:
|
4
|
-
data.tar.gz:
|
3
|
+
metadata.gz: 77e716b4fe416071aecb32fc58bf49d6708b32a9088dd01ffc382e0b48f1f271
|
4
|
+
data.tar.gz: 01cf7e7a131a562ac1d21fcd3682c0a442564c21eb97ff2ffb506cfecda8cfb7
|
5
5
|
SHA512:
|
6
|
-
metadata.gz:
|
7
|
-
data.tar.gz:
|
6
|
+
metadata.gz: e683d5f5fd91ade241e901f9b3df0dd350d5da6fbff8dd620017d3591ca904f786ff4adf424e61a72132042cd21a266290bbc8afffa878337d5cca2ea6e85f8c
|
7
|
+
data.tar.gz: 3d7717da9ef14aed49fe4ab659d74442c96c098ba28ac1107d2129854a0cc208b01aeaf6c5884802ef311a84965296a76969f5eb2c5c5124961dee3cbdf100d0
|
data/lib/aws-sdk-ivs.rb
CHANGED
data/lib/aws-sdk-ivs/client.rb
CHANGED
@@ -401,11 +401,20 @@ module Aws::IVS
|
|
401
401
|
#
|
402
402
|
# @option params [String] :type
|
403
403
|
# Channel type, which determines the allowable resolution and bitrate.
|
404
|
-
#
|
405
|
-
#
|
406
|
-
#
|
407
|
-
#
|
408
|
-
#
|
404
|
+
# *If you exceed the allowable resolution or bitrate, the stream
|
405
|
+
# probably will disconnect immediately.* Valid values:
|
406
|
+
#
|
407
|
+
# * `STANDARD`\: Multiple qualities are generated from the original
|
408
|
+
# input, to automatically give viewers the best experience for their
|
409
|
+
# devices and network conditions. Vertical resolution can be up to
|
410
|
+
# 1080 and bitrate can be up to 8.5 Mbps.
|
411
|
+
#
|
412
|
+
# * `BASIC`\: Amazon IVS delivers the original input to viewers. The
|
413
|
+
# viewer’s video-quality choice is limited to the original input.
|
414
|
+
# Vertical resolution can be up to 480 and bitrate can be up to 1.5
|
415
|
+
# Mbps.
|
416
|
+
#
|
417
|
+
# Default: `STANDARD`.
|
409
418
|
#
|
410
419
|
# @option params [Hash<String,String>] :tags
|
411
420
|
# See Channel$tags.
|
@@ -451,7 +460,7 @@ module Aws::IVS
|
|
451
460
|
req.send_request(options)
|
452
461
|
end
|
453
462
|
|
454
|
-
# Creates a stream key, used to initiate a stream, for
|
463
|
+
# Creates a stream key, used to initiate a stream, for the specified
|
455
464
|
# channel ARN.
|
456
465
|
#
|
457
466
|
# Note that CreateChannel creates a stream key. If you subsequently use
|
@@ -496,7 +505,7 @@ module Aws::IVS
|
|
496
505
|
req.send_request(options)
|
497
506
|
end
|
498
507
|
|
499
|
-
# Deletes
|
508
|
+
# Deletes the specified channel and its associated stream keys.
|
500
509
|
#
|
501
510
|
# @option params [required, String] :arn
|
502
511
|
# ARN of the channel to be deleted.
|
@@ -518,7 +527,7 @@ module Aws::IVS
|
|
518
527
|
req.send_request(options)
|
519
528
|
end
|
520
529
|
|
521
|
-
# Deletes the stream key for
|
530
|
+
# Deletes the stream key for the specified ARN, so it can no longer be
|
522
531
|
# used to stream.
|
523
532
|
#
|
524
533
|
# @option params [required, String] :arn
|
@@ -541,7 +550,7 @@ module Aws::IVS
|
|
541
550
|
req.send_request(options)
|
542
551
|
end
|
543
552
|
|
544
|
-
# Gets the channel configuration for
|
553
|
+
# Gets the channel configuration for the specified channel ARN. See also
|
545
554
|
# BatchGetChannel.
|
546
555
|
#
|
547
556
|
# @option params [required, String] :arn
|
@@ -643,8 +652,9 @@ module Aws::IVS
|
|
643
652
|
req.send_request(options)
|
644
653
|
end
|
645
654
|
|
646
|
-
# Gets summary information about channels
|
647
|
-
#
|
655
|
+
# Gets summary information about all channels in your account, in the
|
656
|
+
# AWS region where the API request is processed. This list can be
|
657
|
+
# filtered to match a specified string.
|
648
658
|
#
|
649
659
|
# @option params [String] :filter_by_name
|
650
660
|
# Filters the channel list to match the specified name.
|
@@ -690,8 +700,7 @@ module Aws::IVS
|
|
690
700
|
req.send_request(options)
|
691
701
|
end
|
692
702
|
|
693
|
-
# Gets summary information about stream keys
|
694
|
-
# to a particular channel.
|
703
|
+
# Gets summary information about stream keys for the specified channel.
|
695
704
|
#
|
696
705
|
# @option params [required, String] :channel_arn
|
697
706
|
# Channel ARN used to filter the list.
|
@@ -736,7 +745,8 @@ module Aws::IVS
|
|
736
745
|
req.send_request(options)
|
737
746
|
end
|
738
747
|
|
739
|
-
# Gets summary information about live streams
|
748
|
+
# Gets summary information about live streams in your account, in the
|
749
|
+
# AWS region where the API request is processed.
|
740
750
|
#
|
741
751
|
# @option params [String] :next_token
|
742
752
|
# The first stream to retrieve. This is used for pagination; see the
|
@@ -778,7 +788,7 @@ module Aws::IVS
|
|
778
788
|
req.send_request(options)
|
779
789
|
end
|
780
790
|
|
781
|
-
# Gets information about
|
791
|
+
# Gets information about AWS tags for the specified ARN.
|
782
792
|
#
|
783
793
|
# @option params [required, String] :resource_arn
|
784
794
|
# The ARN of the resource to be retrieved.
|
@@ -820,7 +830,7 @@ module Aws::IVS
|
|
820
830
|
req.send_request(options)
|
821
831
|
end
|
822
832
|
|
823
|
-
# Inserts metadata into an
|
833
|
+
# Inserts metadata into an RTMPS stream for the specified channel. A
|
824
834
|
# maximum of 5 requests per second per channel is allowed, each with a
|
825
835
|
# maximum 1KB payload.
|
826
836
|
#
|
@@ -849,12 +859,12 @@ module Aws::IVS
|
|
849
859
|
req.send_request(options)
|
850
860
|
end
|
851
861
|
|
852
|
-
# Disconnects the stream for the specified channel.
|
853
|
-
#
|
854
|
-
#
|
862
|
+
# Disconnects the incoming RTMPS stream for the specified channel. Can
|
863
|
+
# be used in conjunction with DeleteStreamKey to prevent further
|
864
|
+
# streaming to a channel.
|
855
865
|
#
|
856
866
|
# <note markdown="1"> Many streaming client-software libraries automatically reconnect a
|
857
|
-
# dropped
|
867
|
+
# dropped RTMPS session, so to stop the stream permanently, you may want
|
858
868
|
# to first revoke the `streamKey` attached to the channel.
|
859
869
|
#
|
860
870
|
# </note>
|
@@ -879,7 +889,7 @@ module Aws::IVS
|
|
879
889
|
req.send_request(options)
|
880
890
|
end
|
881
891
|
|
882
|
-
# Adds or updates tags for
|
892
|
+
# Adds or updates tags for the AWS resource with the specified ARN.
|
883
893
|
#
|
884
894
|
# @option params [required, String] :resource_arn
|
885
895
|
# ARN of the resource for which tags are to be added or updated.
|
@@ -907,7 +917,7 @@ module Aws::IVS
|
|
907
917
|
req.send_request(options)
|
908
918
|
end
|
909
919
|
|
910
|
-
# Removes tags
|
920
|
+
# Removes tags from the resource with the specified ARN.
|
911
921
|
#
|
912
922
|
# @option params [required, String] :resource_arn
|
913
923
|
# ARN of the resource for which tags are to be removed.
|
@@ -948,11 +958,20 @@ module Aws::IVS
|
|
948
958
|
#
|
949
959
|
# @option params [String] :type
|
950
960
|
# Channel type, which determines the allowable resolution and bitrate.
|
951
|
-
#
|
952
|
-
#
|
953
|
-
#
|
954
|
-
#
|
955
|
-
#
|
961
|
+
# *If you exceed the allowable resolution or bitrate, the stream
|
962
|
+
# probably will disconnect immediately.* Valid values:
|
963
|
+
#
|
964
|
+
# * `STANDARD`\: Multiple qualities are generated from the original
|
965
|
+
# input, to automatically give viewers the best experience for their
|
966
|
+
# devices and network conditions. Vertical resolution can be up to
|
967
|
+
# 1080 and bitrate can be up to 8.5 Mbps.
|
968
|
+
#
|
969
|
+
# * `BASIC`\: Amazon IVS delivers the original input to viewers. The
|
970
|
+
# viewer’s video-quality choice is limited to the original input.
|
971
|
+
# Vertical resolution can be up to 480 and bitrate can be up to 1.5
|
972
|
+
# Mbps.
|
973
|
+
#
|
974
|
+
# Default: `STANDARD`.
|
956
975
|
#
|
957
976
|
# @return [Types::UpdateChannelResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
958
977
|
#
|
@@ -1000,7 +1019,7 @@ module Aws::IVS
|
|
1000
1019
|
params: params,
|
1001
1020
|
config: config)
|
1002
1021
|
context[:gem_name] = 'aws-sdk-ivs'
|
1003
|
-
context[:gem_version] = '1.
|
1022
|
+
context[:gem_version] = '1.1.0'
|
1004
1023
|
Seahorse::Client::Request.new(handlers, context)
|
1005
1024
|
end
|
1006
1025
|
|
@@ -58,6 +58,7 @@ module Aws::IVS
|
|
58
58
|
MaxStreamResults = Shapes::IntegerShape.new(name: 'MaxStreamResults')
|
59
59
|
MaxTagResults = Shapes::IntegerShape.new(name: 'MaxTagResults')
|
60
60
|
PaginationToken = Shapes::StringShape.new(name: 'PaginationToken')
|
61
|
+
PendingVerification = Shapes::StructureShape.new(name: 'PendingVerification')
|
61
62
|
PlaybackURL = Shapes::StringShape.new(name: 'PlaybackURL')
|
62
63
|
PutMetadataRequest = Shapes::StructureShape.new(name: 'PutMetadataRequest')
|
63
64
|
ResourceArn = Shapes::StringShape.new(name: 'ResourceArn')
|
@@ -227,6 +228,9 @@ module Aws::IVS
|
|
227
228
|
ListTagsForResourceResponse.add_member(:next_token, Shapes::ShapeRef.new(shape: String, location_name: "nextToken"))
|
228
229
|
ListTagsForResourceResponse.struct_class = Types::ListTagsForResourceResponse
|
229
230
|
|
231
|
+
PendingVerification.add_member(:exception_message, Shapes::ShapeRef.new(shape: errorMessage, location_name: "exceptionMessage"))
|
232
|
+
PendingVerification.struct_class = Types::PendingVerification
|
233
|
+
|
230
234
|
PutMetadataRequest.add_member(:channel_arn, Shapes::ShapeRef.new(shape: ChannelArn, required: true, location_name: "channelArn"))
|
231
235
|
PutMetadataRequest.add_member(:metadata, Shapes::ShapeRef.new(shape: StreamMetadata, required: true, location_name: "metadata"))
|
232
236
|
PutMetadataRequest.struct_class = Types::PutMetadataRequest
|
@@ -354,6 +358,7 @@ module Aws::IVS
|
|
354
358
|
o.errors << Shapes::ShapeRef.new(shape: ValidationException)
|
355
359
|
o.errors << Shapes::ShapeRef.new(shape: AccessDeniedException)
|
356
360
|
o.errors << Shapes::ShapeRef.new(shape: ServiceQuotaExceededException)
|
361
|
+
o.errors << Shapes::ShapeRef.new(shape: PendingVerification)
|
357
362
|
end)
|
358
363
|
|
359
364
|
api.add_operation(:create_stream_key, Seahorse::Model::Operation.new.tap do |o|
|
@@ -366,6 +371,7 @@ module Aws::IVS
|
|
366
371
|
o.errors << Shapes::ShapeRef.new(shape: AccessDeniedException)
|
367
372
|
o.errors << Shapes::ShapeRef.new(shape: ResourceNotFoundException)
|
368
373
|
o.errors << Shapes::ShapeRef.new(shape: ServiceQuotaExceededException)
|
374
|
+
o.errors << Shapes::ShapeRef.new(shape: PendingVerification)
|
369
375
|
end)
|
370
376
|
|
371
377
|
api.add_operation(:delete_channel, Seahorse::Model::Operation.new.tap do |o|
|
@@ -378,6 +384,7 @@ module Aws::IVS
|
|
378
384
|
o.errors << Shapes::ShapeRef.new(shape: AccessDeniedException)
|
379
385
|
o.errors << Shapes::ShapeRef.new(shape: ResourceNotFoundException)
|
380
386
|
o.errors << Shapes::ShapeRef.new(shape: ConflictException)
|
387
|
+
o.errors << Shapes::ShapeRef.new(shape: PendingVerification)
|
381
388
|
end)
|
382
389
|
|
383
390
|
api.add_operation(:delete_stream_key, Seahorse::Model::Operation.new.tap do |o|
|
@@ -389,6 +396,7 @@ module Aws::IVS
|
|
389
396
|
o.errors << Shapes::ShapeRef.new(shape: ValidationException)
|
390
397
|
o.errors << Shapes::ShapeRef.new(shape: AccessDeniedException)
|
391
398
|
o.errors << Shapes::ShapeRef.new(shape: ResourceNotFoundException)
|
399
|
+
o.errors << Shapes::ShapeRef.new(shape: PendingVerification)
|
392
400
|
end)
|
393
401
|
|
394
402
|
api.add_operation(:get_channel, Seahorse::Model::Operation.new.tap do |o|
|
@@ -548,6 +556,7 @@ module Aws::IVS
|
|
548
556
|
o.errors << Shapes::ShapeRef.new(shape: AccessDeniedException)
|
549
557
|
o.errors << Shapes::ShapeRef.new(shape: ResourceNotFoundException)
|
550
558
|
o.errors << Shapes::ShapeRef.new(shape: ConflictException)
|
559
|
+
o.errors << Shapes::ShapeRef.new(shape: PendingVerification)
|
551
560
|
end)
|
552
561
|
end
|
553
562
|
|
data/lib/aws-sdk-ivs/errors.rb
CHANGED
@@ -31,6 +31,7 @@ module Aws::IVS
|
|
31
31
|
# * {ChannelNotBroadcasting}
|
32
32
|
# * {ConflictException}
|
33
33
|
# * {InternalServerException}
|
34
|
+
# * {PendingVerification}
|
34
35
|
# * {ResourceNotFoundException}
|
35
36
|
# * {ServiceQuotaExceededException}
|
36
37
|
# * {StreamUnavailable}
|
@@ -103,6 +104,21 @@ module Aws::IVS
|
|
103
104
|
end
|
104
105
|
end
|
105
106
|
|
107
|
+
class PendingVerification < ServiceError
|
108
|
+
|
109
|
+
# @param [Seahorse::Client::RequestContext] context
|
110
|
+
# @param [String] message
|
111
|
+
# @param [Aws::IVS::Types::PendingVerification] data
|
112
|
+
def initialize(context, message, data = Aws::EmptyStructure.new)
|
113
|
+
super(context, message, data)
|
114
|
+
end
|
115
|
+
|
116
|
+
# @return [String]
|
117
|
+
def exception_message
|
118
|
+
@data[:exception_message]
|
119
|
+
end
|
120
|
+
end
|
121
|
+
|
106
122
|
class ResourceNotFoundException < ServiceError
|
107
123
|
|
108
124
|
# @param [Seahorse::Client::RequestContext] context
|
data/lib/aws-sdk-ivs/types.rb
CHANGED
@@ -131,11 +131,20 @@ module Aws::IVS
|
|
131
131
|
#
|
132
132
|
# @!attribute [rw] type
|
133
133
|
# Channel type, which determines the allowable resolution and bitrate.
|
134
|
-
#
|
135
|
-
#
|
136
|
-
#
|
137
|
-
#
|
138
|
-
#
|
134
|
+
# *If you exceed the allowable resolution or bitrate, the stream
|
135
|
+
# probably will disconnect immediately.* Valid values:
|
136
|
+
#
|
137
|
+
# * `STANDARD`\: Multiple qualities are generated from the original
|
138
|
+
# input, to automatically give viewers the best experience for their
|
139
|
+
# devices and network conditions. Vertical resolution can be up to
|
140
|
+
# 1080 and bitrate can be up to 8.5 Mbps.
|
141
|
+
#
|
142
|
+
# * `BASIC`\: Amazon IVS delivers the original input to viewers. The
|
143
|
+
# viewer’s video-quality choice is limited to the original input.
|
144
|
+
# Vertical resolution can be up to 480 and bitrate can be up to 1.5
|
145
|
+
# Mbps.
|
146
|
+
#
|
147
|
+
# Default: `STANDARD`.
|
139
148
|
# @return [String]
|
140
149
|
#
|
141
150
|
# @!attribute [rw] ingest_endpoint
|
@@ -240,11 +249,20 @@ module Aws::IVS
|
|
240
249
|
#
|
241
250
|
# @!attribute [rw] type
|
242
251
|
# Channel type, which determines the allowable resolution and bitrate.
|
243
|
-
#
|
244
|
-
#
|
245
|
-
#
|
246
|
-
# `
|
247
|
-
#
|
252
|
+
# *If you exceed the allowable resolution or bitrate, the stream
|
253
|
+
# probably will disconnect immediately.* Valid values:
|
254
|
+
#
|
255
|
+
# * `STANDARD`\: Multiple qualities are generated from the original
|
256
|
+
# input, to automatically give viewers the best experience for their
|
257
|
+
# devices and network conditions. Vertical resolution can be up to
|
258
|
+
# 1080 and bitrate can be up to 8.5 Mbps.
|
259
|
+
#
|
260
|
+
# * `BASIC`\: Amazon IVS delivers the original input to viewers. The
|
261
|
+
# viewer’s video-quality choice is limited to the original input.
|
262
|
+
# Vertical resolution can be up to 480 and bitrate can be up to 1.5
|
263
|
+
# Mbps.
|
264
|
+
#
|
265
|
+
# Default: `STANDARD`.
|
248
266
|
# @return [String]
|
249
267
|
#
|
250
268
|
# @!attribute [rw] tags
|
@@ -307,7 +325,7 @@ module Aws::IVS
|
|
307
325
|
end
|
308
326
|
|
309
327
|
# @!attribute [rw] stream_key
|
310
|
-
# Stream key used to authenticate an
|
328
|
+
# Stream key used to authenticate an RTMPS stream for ingestion.
|
311
329
|
# @return [Types::StreamKey]
|
312
330
|
#
|
313
331
|
# @see http://docs.aws.amazon.com/goto/WebAPI/ivs-2020-07-14/CreateStreamKeyResponse AWS API Documentation
|
@@ -655,6 +673,18 @@ module Aws::IVS
|
|
655
673
|
include Aws::Structure
|
656
674
|
end
|
657
675
|
|
676
|
+
# @!attribute [rw] exception_message
|
677
|
+
# Your account is pending verification.
|
678
|
+
# @return [String]
|
679
|
+
#
|
680
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/ivs-2020-07-14/PendingVerification AWS API Documentation
|
681
|
+
#
|
682
|
+
class PendingVerification < Struct.new(
|
683
|
+
:exception_message)
|
684
|
+
SENSITIVE = []
|
685
|
+
include Aws::Structure
|
686
|
+
end
|
687
|
+
|
658
688
|
# @note When making an API call, you may pass PutMetadataRequest
|
659
689
|
# data as a hash:
|
660
690
|
#
|
@@ -963,11 +993,20 @@ module Aws::IVS
|
|
963
993
|
#
|
964
994
|
# @!attribute [rw] type
|
965
995
|
# Channel type, which determines the allowable resolution and bitrate.
|
966
|
-
#
|
967
|
-
#
|
968
|
-
#
|
969
|
-
# `
|
970
|
-
#
|
996
|
+
# *If you exceed the allowable resolution or bitrate, the stream
|
997
|
+
# probably will disconnect immediately.* Valid values:
|
998
|
+
#
|
999
|
+
# * `STANDARD`\: Multiple qualities are generated from the original
|
1000
|
+
# input, to automatically give viewers the best experience for their
|
1001
|
+
# devices and network conditions. Vertical resolution can be up to
|
1002
|
+
# 1080 and bitrate can be up to 8.5 Mbps.
|
1003
|
+
#
|
1004
|
+
# * `BASIC`\: Amazon IVS delivers the original input to viewers. The
|
1005
|
+
# viewer’s video-quality choice is limited to the original input.
|
1006
|
+
# Vertical resolution can be up to 480 and bitrate can be up to 1.5
|
1007
|
+
# Mbps.
|
1008
|
+
#
|
1009
|
+
# Default: `STANDARD`.
|
971
1010
|
# @return [String]
|
972
1011
|
#
|
973
1012
|
# @see http://docs.aws.amazon.com/goto/WebAPI/ivs-2020-07-14/UpdateChannelRequest AWS API Documentation
|
metadata
CHANGED
@@ -1,14 +1,14 @@
|
|
1
1
|
--- !ruby/object:Gem::Specification
|
2
2
|
name: aws-sdk-ivs
|
3
3
|
version: !ruby/object:Gem::Version
|
4
|
-
version: 1.
|
4
|
+
version: 1.1.0
|
5
5
|
platform: ruby
|
6
6
|
authors:
|
7
7
|
- Amazon Web Services
|
8
8
|
autorequire:
|
9
9
|
bindir: bin
|
10
10
|
cert_chain: []
|
11
|
-
date: 2020-07-
|
11
|
+
date: 2020-07-28 00:00:00.000000000 Z
|
12
12
|
dependencies:
|
13
13
|
- !ruby/object:Gem::Dependency
|
14
14
|
name: aws-sdk-core
|