aws-sdk-ivs 1.10.0 → 1.14.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -100,17 +100,17 @@ module Aws::IVS
100
100
  include Aws::Structure
101
101
  end
102
102
 
103
- # @!attribute [rw] stream_keys
104
- # @return [Array<Types::StreamKey>]
105
- #
106
103
  # @!attribute [rw] errors
107
104
  # @return [Array<Types::BatchError>]
108
105
  #
106
+ # @!attribute [rw] stream_keys
107
+ # @return [Array<Types::StreamKey>]
108
+ #
109
109
  # @see http://docs.aws.amazon.com/goto/WebAPI/ivs-2020-07-14/BatchGetStreamKeyResponse AWS API Documentation
110
110
  #
111
111
  class BatchGetStreamKeyResponse < Struct.new(
112
- :stream_keys,
113
- :errors)
112
+ :errors,
113
+ :stream_keys)
114
114
  SENSITIVE = []
115
115
  include Aws::Structure
116
116
  end
@@ -121,8 +121,14 @@ module Aws::IVS
121
121
  # Channel ARN.
122
122
  # @return [String]
123
123
  #
124
- # @!attribute [rw] name
125
- # Channel name.
124
+ # @!attribute [rw] authorized
125
+ # Whether the channel is private (enabled for playback authorization).
126
+ # Default: `false`.
127
+ # @return [Boolean]
128
+ #
129
+ # @!attribute [rw] ingest_endpoint
130
+ # Channel ingest endpoint, part of the definition of an ingest server,
131
+ # used when you set up streaming software.
126
132
  # @return [String]
127
133
  #
128
134
  # @!attribute [rw] latency_mode
@@ -132,21 +138,12 @@ module Aws::IVS
132
138
  # `NORMAL` correspond to Ultra-low and Standard, respectively.)
133
139
  # @return [String]
134
140
  #
135
- # @!attribute [rw] type
136
- # Channel type, which determines the allowable resolution and bitrate.
137
- # *If you exceed the allowable resolution or bitrate, the stream
138
- # probably will disconnect immediately.* Default: `STANDARD`. Valid
139
- # values:
140
- #
141
- # * `STANDARD`\: Multiple qualities are generated from the original
142
- # input, to automatically give viewers the best experience for their
143
- # devices and network conditions. Vertical resolution can be up to
144
- # 1080 and bitrate can be up to 8.5 Mbps.
141
+ # @!attribute [rw] name
142
+ # Channel name.
143
+ # @return [String]
145
144
  #
146
- # * `BASIC`\: Amazon IVS delivers the original input to viewers. The
147
- # viewer’s video-quality choice is limited to the original input.
148
- # Vertical resolution can be up to 480 and bitrate can be up to 1.5
149
- # Mbps.
145
+ # @!attribute [rw] playback_url
146
+ # Channel playback URL.
150
147
  # @return [String]
151
148
  #
152
149
  # @!attribute [rw] recording_configuration_arn
@@ -155,36 +152,39 @@ module Aws::IVS
155
152
  # recording is disabled).
156
153
  # @return [String]
157
154
  #
158
- # @!attribute [rw] ingest_endpoint
159
- # Channel ingest endpoint, part of the definition of an ingest server,
160
- # used when you set up streaming software.
161
- # @return [String]
162
- #
163
- # @!attribute [rw] playback_url
164
- # Channel playback URL.
165
- # @return [String]
166
- #
167
- # @!attribute [rw] authorized
168
- # Whether the channel is private (enabled for playback authorization).
169
- # Default: `false`.
170
- # @return [Boolean]
171
- #
172
155
  # @!attribute [rw] tags
173
156
  # Array of 1-50 maps, each of the form `string:string (key:value)`.
174
157
  # @return [Hash<String,String>]
175
158
  #
159
+ # @!attribute [rw] type
160
+ # Channel type, which determines the allowable resolution and bitrate.
161
+ # *If you exceed the allowable resolution or bitrate, the stream
162
+ # probably will disconnect immediately.* Default: `STANDARD`. Valid
163
+ # values:
164
+ #
165
+ # * `STANDARD`\: Multiple qualities are generated from the original
166
+ # input, to automatically give viewers the best experience for their
167
+ # devices and network conditions. Resolution can be up to 1080p and
168
+ # bitrate can be up to 8.5 Mbps. Audio is transcoded only for
169
+ # renditions 360p and below; above that, audio is passed through.
170
+ #
171
+ # * `BASIC`\: Amazon IVS delivers the original input to viewers. The
172
+ # viewer’s video-quality choice is limited to the original input.
173
+ # Resolution can be up to 480p and bitrate can be up to 1.5 Mbps.
174
+ # @return [String]
175
+ #
176
176
  # @see http://docs.aws.amazon.com/goto/WebAPI/ivs-2020-07-14/Channel AWS API Documentation
177
177
  #
178
178
  class Channel < Struct.new(
179
179
  :arn,
180
- :name,
181
- :latency_mode,
182
- :type,
183
- :recording_configuration_arn,
180
+ :authorized,
184
181
  :ingest_endpoint,
182
+ :latency_mode,
183
+ :name,
185
184
  :playback_url,
186
- :authorized,
187
- :tags)
185
+ :recording_configuration_arn,
186
+ :tags,
187
+ :type)
188
188
  SENSITIVE = []
189
189
  include Aws::Structure
190
190
  end
@@ -207,9 +207,10 @@ module Aws::IVS
207
207
  # Channel ARN.
208
208
  # @return [String]
209
209
  #
210
- # @!attribute [rw] name
211
- # Channel name.
212
- # @return [String]
210
+ # @!attribute [rw] authorized
211
+ # Whether the channel is private (enabled for playback authorization).
212
+ # Default: `false`.
213
+ # @return [Boolean]
213
214
  #
214
215
  # @!attribute [rw] latency_mode
215
216
  # Channel latency mode. Use `NORMAL` to broadcast and deliver live
@@ -218,10 +219,9 @@ module Aws::IVS
218
219
  # `NORMAL` correspond to Ultra-low and Standard, respectively.)
219
220
  # @return [String]
220
221
  #
221
- # @!attribute [rw] authorized
222
- # Whether the channel is private (enabled for playback authorization).
223
- # Default: `false`.
224
- # @return [Boolean]
222
+ # @!attribute [rw] name
223
+ # Channel name.
224
+ # @return [String]
225
225
  #
226
226
  # @!attribute [rw] recording_configuration_arn
227
227
  # Recording-configuration ARN. A value other than an empty string
@@ -237,9 +237,9 @@ module Aws::IVS
237
237
  #
238
238
  class ChannelSummary < Struct.new(
239
239
  :arn,
240
- :name,
241
- :latency_mode,
242
240
  :authorized,
241
+ :latency_mode,
242
+ :name,
243
243
  :recording_configuration_arn,
244
244
  :tags)
245
245
  SENSITIVE = []
@@ -262,19 +262,20 @@ module Aws::IVS
262
262
  # data as a hash:
263
263
  #
264
264
  # {
265
- # name: "ChannelName",
266
- # latency_mode: "NORMAL", # accepts NORMAL, LOW
267
- # type: "BASIC", # accepts BASIC, STANDARD
268
265
  # authorized: false,
266
+ # latency_mode: "NORMAL", # accepts NORMAL, LOW
267
+ # name: "ChannelName",
269
268
  # recording_configuration_arn: "ChannelRecordingConfigurationArn",
270
269
  # tags: {
271
270
  # "TagKey" => "TagValue",
272
271
  # },
272
+ # type: "BASIC", # accepts BASIC, STANDARD
273
273
  # }
274
274
  #
275
- # @!attribute [rw] name
276
- # Channel name.
277
- # @return [String]
275
+ # @!attribute [rw] authorized
276
+ # Whether the channel is private (enabled for playback authorization).
277
+ # Default: `false`.
278
+ # @return [Boolean]
278
279
  #
279
280
  # @!attribute [rw] latency_mode
280
281
  # Channel latency mode. Use `NORMAL` to broadcast and deliver live
@@ -283,6 +284,19 @@ module Aws::IVS
283
284
  # correspond to Ultra-low and Standard, respectively.) Default: `LOW`.
284
285
  # @return [String]
285
286
  #
287
+ # @!attribute [rw] name
288
+ # Channel name.
289
+ # @return [String]
290
+ #
291
+ # @!attribute [rw] recording_configuration_arn
292
+ # Recording-configuration ARN. Default: "" (empty string, recording
293
+ # is disabled).
294
+ # @return [String]
295
+ #
296
+ # @!attribute [rw] tags
297
+ # Array of 1-50 maps, each of the form `string:string (key:value)`.
298
+ # @return [Hash<String,String>]
299
+ #
286
300
  # @!attribute [rw] type
287
301
  # Channel type, which determines the allowable resolution and bitrate.
288
302
  # *If you exceed the allowable resolution or bitrate, the stream
@@ -291,48 +305,32 @@ module Aws::IVS
291
305
  #
292
306
  # * `STANDARD`\: Multiple qualities are generated from the original
293
307
  # input, to automatically give viewers the best experience for their
294
- # devices and network conditions. Vertical resolution can be up to
295
- # 1080 and bitrate can be up to 8.5 Mbps.
308
+ # devices and network conditions. Resolution can be up to 1080p and
309
+ # bitrate can be up to 8.5 Mbps. Audio is transcoded only for
310
+ # renditions 360p and below; above that, audio is passed through.
296
311
  #
297
312
  # * `BASIC`\: Amazon IVS delivers the original input to viewers. The
298
313
  # viewer’s video-quality choice is limited to the original input.
299
- # Vertical resolution can be up to 480 and bitrate can be up to 1.5
300
- # Mbps.
301
- # @return [String]
302
- #
303
- # @!attribute [rw] authorized
304
- # Whether the channel is private (enabled for playback authorization).
305
- # Default: `false`.
306
- # @return [Boolean]
307
- #
308
- # @!attribute [rw] recording_configuration_arn
309
- # Recording-configuration ARN. Default: "" (empty string, recording
310
- # is disabled).
314
+ # Resolution can be up to 480p and bitrate can be up to 1.5 Mbps.
311
315
  # @return [String]
312
316
  #
313
- # @!attribute [rw] tags
314
- # Array of 1-50 maps, each of the form `string:string (key:value)`.
315
- # @return [Hash<String,String>]
316
- #
317
317
  # @see http://docs.aws.amazon.com/goto/WebAPI/ivs-2020-07-14/CreateChannelRequest AWS API Documentation
318
318
  #
319
319
  class CreateChannelRequest < Struct.new(
320
- :name,
321
- :latency_mode,
322
- :type,
323
320
  :authorized,
321
+ :latency_mode,
322
+ :name,
324
323
  :recording_configuration_arn,
325
- :tags)
324
+ :tags,
325
+ :type)
326
326
  SENSITIVE = []
327
327
  include Aws::Structure
328
328
  end
329
329
 
330
330
  # @!attribute [rw] channel
331
- # Object specifying a channel.
332
331
  # @return [Types::Channel]
333
332
  #
334
333
  # @!attribute [rw] stream_key
335
- # Object specifying a stream key.
336
334
  # @return [Types::StreamKey]
337
335
  #
338
336
  # @see http://docs.aws.amazon.com/goto/WebAPI/ivs-2020-07-14/CreateChannelResponse AWS API Documentation
@@ -348,27 +346,26 @@ module Aws::IVS
348
346
  # data as a hash:
349
347
  #
350
348
  # {
351
- # name: "RecordingConfigurationName",
352
349
  # destination_configuration: { # required
353
350
  # s3: {
354
351
  # bucket_name: "S3DestinationBucketName", # required
355
352
  # },
356
353
  # },
354
+ # name: "RecordingConfigurationName",
357
355
  # tags: {
358
356
  # "TagKey" => "TagValue",
359
357
  # },
360
358
  # }
361
359
  #
362
- # @!attribute [rw] name
363
- # An arbitrary string (a nickname) that helps the customer identify
364
- # that resource. The value does not need to be unique.
365
- # @return [String]
366
- #
367
360
  # @!attribute [rw] destination_configuration
368
361
  # A complex type that contains a destination configuration for where
369
362
  # recorded video will be stored.
370
363
  # @return [Types::DestinationConfiguration]
371
364
  #
365
+ # @!attribute [rw] name
366
+ # Recording-configuration name. The value does not need to be unique.
367
+ # @return [String]
368
+ #
372
369
  # @!attribute [rw] tags
373
370
  # Array of 1-50 maps, each of the form `string:string (key:value)`.
374
371
  # @return [Hash<String,String>]
@@ -376,15 +373,17 @@ module Aws::IVS
376
373
  # @see http://docs.aws.amazon.com/goto/WebAPI/ivs-2020-07-14/CreateRecordingConfigurationRequest AWS API Documentation
377
374
  #
378
375
  class CreateRecordingConfigurationRequest < Struct.new(
379
- :name,
380
376
  :destination_configuration,
377
+ :name,
381
378
  :tags)
382
379
  SENSITIVE = []
383
380
  include Aws::Structure
384
381
  end
385
382
 
386
383
  # @!attribute [rw] recording_configuration
387
- # An object representing a configuration to record a channel stream.
384
+ # <zonbook />
385
+ #
386
+ # <xhtml />
388
387
  # @return [Types::RecordingConfiguration]
389
388
  #
390
389
  # @see http://docs.aws.amazon.com/goto/WebAPI/ivs-2020-07-14/CreateRecordingConfigurationResponse AWS API Documentation
@@ -561,7 +560,6 @@ module Aws::IVS
561
560
  end
562
561
 
563
562
  # @!attribute [rw] channel
564
- # Object specifying a channel.
565
563
  # @return [Types::Channel]
566
564
  #
567
565
  # @see http://docs.aws.amazon.com/goto/WebAPI/ivs-2020-07-14/GetChannelResponse AWS API Documentation
@@ -592,7 +590,9 @@ module Aws::IVS
592
590
  end
593
591
 
594
592
  # @!attribute [rw] key_pair
595
- # A key pair used to sign and validate a playback authorization token.
593
+ # <zonbook />
594
+ #
595
+ # <xhtml />
596
596
  # @return [Types::PlaybackKeyPair]
597
597
  #
598
598
  # @see http://docs.aws.amazon.com/goto/WebAPI/ivs-2020-07-14/GetPlaybackKeyPairResponse AWS API Documentation
@@ -623,7 +623,9 @@ module Aws::IVS
623
623
  end
624
624
 
625
625
  # @!attribute [rw] recording_configuration
626
- # An object representing a configuration to record a channel stream.
626
+ # <zonbook />
627
+ #
628
+ # <xhtml />
627
629
  # @return [Types::RecordingConfiguration]
628
630
  #
629
631
  # @see http://docs.aws.amazon.com/goto/WebAPI/ivs-2020-07-14/GetRecordingConfigurationResponse AWS API Documentation
@@ -654,7 +656,9 @@ module Aws::IVS
654
656
  end
655
657
 
656
658
  # @!attribute [rw] stream_key
657
- # Object specifying a stream key.
659
+ # <zonbook />
660
+ #
661
+ # <xhtml />
658
662
  # @return [Types::StreamKey]
659
663
  #
660
664
  # @see http://docs.aws.amazon.com/goto/WebAPI/ivs-2020-07-14/GetStreamKeyResponse AWS API Documentation
@@ -685,8 +689,6 @@ module Aws::IVS
685
689
  end
686
690
 
687
691
  # @!attribute [rw] stream
688
- # Specifies a live video stream that has been ingested and
689
- # distributed.
690
692
  # @return [Types::Stream]
691
693
  #
692
694
  # @see http://docs.aws.amazon.com/goto/WebAPI/ivs-2020-07-14/GetStreamResponse AWS API Documentation
@@ -701,21 +703,19 @@ module Aws::IVS
701
703
  # data as a hash:
702
704
  #
703
705
  # {
704
- # public_key_material: "PlaybackPublicKeyMaterial", # required
705
706
  # name: "PlaybackKeyPairName",
707
+ # public_key_material: "PlaybackPublicKeyMaterial", # required
706
708
  # tags: {
707
709
  # "TagKey" => "TagValue",
708
710
  # },
709
711
  # }
710
712
  #
711
- # @!attribute [rw] public_key_material
712
- # The public portion of a customer-generated key pair.
713
+ # @!attribute [rw] name
714
+ # Playback-key-pair name. The value does not need to be unique.
713
715
  # @return [String]
714
716
  #
715
- # @!attribute [rw] name
716
- # An arbitrary string (a nickname) assigned to a playback key pair
717
- # that helps the customer identify that resource. The value does not
718
- # need to be unique.
717
+ # @!attribute [rw] public_key_material
718
+ # The public portion of a customer-generated key pair.
719
719
  # @return [String]
720
720
  #
721
721
  # @!attribute [rw] tags
@@ -726,15 +726,14 @@ module Aws::IVS
726
726
  # @see http://docs.aws.amazon.com/goto/WebAPI/ivs-2020-07-14/ImportPlaybackKeyPairRequest AWS API Documentation
727
727
  #
728
728
  class ImportPlaybackKeyPairRequest < Struct.new(
729
- :public_key_material,
730
729
  :name,
730
+ :public_key_material,
731
731
  :tags)
732
732
  SENSITIVE = []
733
733
  include Aws::Structure
734
734
  end
735
735
 
736
736
  # @!attribute [rw] key_pair
737
- # A key pair used to sign and validate a playback authorization token.
738
737
  # @return [Types::PlaybackKeyPair]
739
738
  #
740
739
  # @see http://docs.aws.amazon.com/goto/WebAPI/ivs-2020-07-14/ImportPlaybackKeyPairResponse AWS API Documentation
@@ -763,8 +762,8 @@ module Aws::IVS
763
762
  # {
764
763
  # filter_by_name: "ChannelName",
765
764
  # filter_by_recording_configuration_arn: "ChannelRecordingConfigurationArn",
766
- # next_token: "PaginationToken",
767
765
  # max_results: 1,
766
+ # next_token: "PaginationToken",
768
767
  # }
769
768
  #
770
769
  # @!attribute [rw] filter_by_name
@@ -776,22 +775,22 @@ module Aws::IVS
776
775
  # recording-configuration ARN.
777
776
  # @return [String]
778
777
  #
778
+ # @!attribute [rw] max_results
779
+ # Maximum number of channels to return. Default: 50.
780
+ # @return [Integer]
781
+ #
779
782
  # @!attribute [rw] next_token
780
783
  # The first channel to retrieve. This is used for pagination; see the
781
784
  # `nextToken` response field.
782
785
  # @return [String]
783
786
  #
784
- # @!attribute [rw] max_results
785
- # Maximum number of channels to return. Default: 50.
786
- # @return [Integer]
787
- #
788
787
  # @see http://docs.aws.amazon.com/goto/WebAPI/ivs-2020-07-14/ListChannelsRequest AWS API Documentation
789
788
  #
790
789
  class ListChannelsRequest < Struct.new(
791
790
  :filter_by_name,
792
791
  :filter_by_recording_configuration_arn,
793
- :next_token,
794
- :max_results)
792
+ :max_results,
793
+ :next_token)
795
794
  SENSITIVE = []
796
795
  include Aws::Structure
797
796
  end
@@ -818,24 +817,24 @@ module Aws::IVS
818
817
  # data as a hash:
819
818
  #
820
819
  # {
821
- # next_token: "PaginationToken",
822
820
  # max_results: 1,
821
+ # next_token: "PaginationToken",
823
822
  # }
824
823
  #
825
- # @!attribute [rw] next_token
826
- # Maximum number of key pairs to return.
827
- # @return [String]
828
- #
829
824
  # @!attribute [rw] max_results
830
825
  # The first key pair to retrieve. This is used for pagination; see the
831
826
  # `nextToken` response field. Default: 50.
832
827
  # @return [Integer]
833
828
  #
829
+ # @!attribute [rw] next_token
830
+ # Maximum number of key pairs to return.
831
+ # @return [String]
832
+ #
834
833
  # @see http://docs.aws.amazon.com/goto/WebAPI/ivs-2020-07-14/ListPlaybackKeyPairsRequest AWS API Documentation
835
834
  #
836
835
  class ListPlaybackKeyPairsRequest < Struct.new(
837
- :next_token,
838
- :max_results)
836
+ :max_results,
837
+ :next_token)
839
838
  SENSITIVE = []
840
839
  include Aws::Structure
841
840
  end
@@ -862,42 +861,42 @@ module Aws::IVS
862
861
  # data as a hash:
863
862
  #
864
863
  # {
865
- # next_token: "PaginationToken",
866
864
  # max_results: 1,
865
+ # next_token: "PaginationToken",
867
866
  # }
868
867
  #
868
+ # @!attribute [rw] max_results
869
+ # Maximum number of recording configurations to return. Default: 50.
870
+ # @return [Integer]
871
+ #
869
872
  # @!attribute [rw] next_token
870
873
  # The first recording configuration to retrieve. This is used for
871
874
  # pagination; see the `nextToken` response field.
872
875
  # @return [String]
873
876
  #
874
- # @!attribute [rw] max_results
875
- # Maximum number of recording configurations to return. Default: 50.
876
- # @return [Integer]
877
- #
878
877
  # @see http://docs.aws.amazon.com/goto/WebAPI/ivs-2020-07-14/ListRecordingConfigurationsRequest AWS API Documentation
879
878
  #
880
879
  class ListRecordingConfigurationsRequest < Struct.new(
881
- :next_token,
882
- :max_results)
880
+ :max_results,
881
+ :next_token)
883
882
  SENSITIVE = []
884
883
  include Aws::Structure
885
884
  end
886
885
 
887
- # @!attribute [rw] recording_configurations
888
- # List of the matching recording configurations.
889
- # @return [Array<Types::RecordingConfigurationSummary>]
890
- #
891
886
  # @!attribute [rw] next_token
892
887
  # If there are more recording configurations than `maxResults`, use
893
888
  # `nextToken` in the request to get the next set.
894
889
  # @return [String]
895
890
  #
891
+ # @!attribute [rw] recording_configurations
892
+ # List of the matching recording configurations.
893
+ # @return [Array<Types::RecordingConfigurationSummary>]
894
+ #
896
895
  # @see http://docs.aws.amazon.com/goto/WebAPI/ivs-2020-07-14/ListRecordingConfigurationsResponse AWS API Documentation
897
896
  #
898
897
  class ListRecordingConfigurationsResponse < Struct.new(
899
- :recording_configurations,
900
- :next_token)
898
+ :next_token,
899
+ :recording_configurations)
901
900
  SENSITIVE = []
902
901
  include Aws::Structure
903
902
  end
@@ -907,47 +906,47 @@ module Aws::IVS
907
906
  #
908
907
  # {
909
908
  # channel_arn: "ChannelArn", # required
910
- # next_token: "PaginationToken",
911
909
  # max_results: 1,
910
+ # next_token: "PaginationToken",
912
911
  # }
913
912
  #
914
913
  # @!attribute [rw] channel_arn
915
914
  # Channel ARN used to filter the list.
916
915
  # @return [String]
917
916
  #
917
+ # @!attribute [rw] max_results
918
+ # Maximum number of streamKeys to return. Default: 50.
919
+ # @return [Integer]
920
+ #
918
921
  # @!attribute [rw] next_token
919
922
  # The first stream key to retrieve. This is used for pagination; see
920
923
  # the `nextToken` response field.
921
924
  # @return [String]
922
925
  #
923
- # @!attribute [rw] max_results
924
- # Maximum number of streamKeys to return. Default: 50.
925
- # @return [Integer]
926
- #
927
926
  # @see http://docs.aws.amazon.com/goto/WebAPI/ivs-2020-07-14/ListStreamKeysRequest AWS API Documentation
928
927
  #
929
928
  class ListStreamKeysRequest < Struct.new(
930
929
  :channel_arn,
931
- :next_token,
932
- :max_results)
930
+ :max_results,
931
+ :next_token)
933
932
  SENSITIVE = []
934
933
  include Aws::Structure
935
934
  end
936
935
 
937
- # @!attribute [rw] stream_keys
938
- # List of stream keys.
939
- # @return [Array<Types::StreamKeySummary>]
940
- #
941
936
  # @!attribute [rw] next_token
942
937
  # If there are more stream keys than `maxResults`, use `nextToken` in
943
938
  # the request to get the next set.
944
939
  # @return [String]
945
940
  #
941
+ # @!attribute [rw] stream_keys
942
+ # List of stream keys.
943
+ # @return [Array<Types::StreamKeySummary>]
944
+ #
946
945
  # @see http://docs.aws.amazon.com/goto/WebAPI/ivs-2020-07-14/ListStreamKeysResponse AWS API Documentation
947
946
  #
948
947
  class ListStreamKeysResponse < Struct.new(
949
- :stream_keys,
950
- :next_token)
948
+ :next_token,
949
+ :stream_keys)
951
950
  SENSITIVE = []
952
951
  include Aws::Structure
953
952
  end
@@ -956,42 +955,42 @@ module Aws::IVS
956
955
  # data as a hash:
957
956
  #
958
957
  # {
959
- # next_token: "PaginationToken",
960
958
  # max_results: 1,
959
+ # next_token: "PaginationToken",
961
960
  # }
962
961
  #
962
+ # @!attribute [rw] max_results
963
+ # Maximum number of streams to return. Default: 50.
964
+ # @return [Integer]
965
+ #
963
966
  # @!attribute [rw] next_token
964
967
  # The first stream to retrieve. This is used for pagination; see the
965
968
  # `nextToken` response field.
966
969
  # @return [String]
967
970
  #
968
- # @!attribute [rw] max_results
969
- # Maximum number of streams to return. Default: 50.
970
- # @return [Integer]
971
- #
972
971
  # @see http://docs.aws.amazon.com/goto/WebAPI/ivs-2020-07-14/ListStreamsRequest AWS API Documentation
973
972
  #
974
973
  class ListStreamsRequest < Struct.new(
975
- :next_token,
976
- :max_results)
974
+ :max_results,
975
+ :next_token)
977
976
  SENSITIVE = []
978
977
  include Aws::Structure
979
978
  end
980
979
 
981
- # @!attribute [rw] streams
982
- # List of streams.
983
- # @return [Array<Types::StreamSummary>]
984
- #
985
980
  # @!attribute [rw] next_token
986
981
  # If there are more streams than `maxResults`, use `nextToken` in the
987
982
  # request to get the next set.
988
983
  # @return [String]
989
984
  #
985
+ # @!attribute [rw] streams
986
+ # List of streams.
987
+ # @return [Array<Types::StreamSummary>]
988
+ #
990
989
  # @see http://docs.aws.amazon.com/goto/WebAPI/ivs-2020-07-14/ListStreamsResponse AWS API Documentation
991
990
  #
992
991
  class ListStreamsResponse < Struct.new(
993
- :streams,
994
- :next_token)
992
+ :next_token,
993
+ :streams)
995
994
  SENSITIVE = []
996
995
  include Aws::Structure
997
996
  end
@@ -1001,29 +1000,16 @@ module Aws::IVS
1001
1000
  #
1002
1001
  # {
1003
1002
  # resource_arn: "ResourceArn", # required
1004
- # next_token: "String",
1005
- # max_results: 1,
1006
1003
  # }
1007
1004
  #
1008
1005
  # @!attribute [rw] resource_arn
1009
1006
  # The ARN of the resource to be retrieved.
1010
1007
  # @return [String]
1011
1008
  #
1012
- # @!attribute [rw] next_token
1013
- # The first tag to retrieve. This is used for pagination; see the
1014
- # `nextToken` response field.
1015
- # @return [String]
1016
- #
1017
- # @!attribute [rw] max_results
1018
- # Maximum number of tags to return. Default: 50.
1019
- # @return [Integer]
1020
- #
1021
1009
  # @see http://docs.aws.amazon.com/goto/WebAPI/ivs-2020-07-14/ListTagsForResourceRequest AWS API Documentation
1022
1010
  #
1023
1011
  class ListTagsForResourceRequest < Struct.new(
1024
- :resource_arn,
1025
- :next_token,
1026
- :max_results)
1012
+ :resource_arn)
1027
1013
  SENSITIVE = []
1028
1014
  include Aws::Structure
1029
1015
  end
@@ -1031,16 +1017,10 @@ module Aws::IVS
1031
1017
  # @!attribute [rw] tags
1032
1018
  # @return [Hash<String,String>]
1033
1019
  #
1034
- # @!attribute [rw] next_token
1035
- # If there are more tags than `maxResults`, use `nextToken` in the
1036
- # request to get the next set.
1037
- # @return [String]
1038
- #
1039
1020
  # @see http://docs.aws.amazon.com/goto/WebAPI/ivs-2020-07-14/ListTagsForResourceResponse AWS API Documentation
1040
1021
  #
1041
1022
  class ListTagsForResourceResponse < Struct.new(
1042
- :tags,
1043
- :next_token)
1023
+ :tags)
1044
1024
  SENSITIVE = []
1045
1025
  include Aws::Structure
1046
1026
  end
@@ -1063,16 +1043,14 @@ module Aws::IVS
1063
1043
  # Key-pair ARN.
1064
1044
  # @return [String]
1065
1045
  #
1066
- # @!attribute [rw] name
1067
- # An arbitrary string (a nickname) assigned to a playback key pair
1068
- # that helps the customer identify that resource. The value does not
1069
- # need to be unique.
1070
- # @return [String]
1071
- #
1072
1046
  # @!attribute [rw] fingerprint
1073
1047
  # Key-pair identifier.
1074
1048
  # @return [String]
1075
1049
  #
1050
+ # @!attribute [rw] name
1051
+ # Playback-key-pair name. The value does not need to be unique.
1052
+ # @return [String]
1053
+ #
1076
1054
  # @!attribute [rw] tags
1077
1055
  # Array of 1-50 maps, each of the form `string:string (key:value)`.
1078
1056
  # @return [Hash<String,String>]
@@ -1081,8 +1059,8 @@ module Aws::IVS
1081
1059
  #
1082
1060
  class PlaybackKeyPair < Struct.new(
1083
1061
  :arn,
1084
- :name,
1085
1062
  :fingerprint,
1063
+ :name,
1086
1064
  :tags)
1087
1065
  SENSITIVE = []
1088
1066
  include Aws::Structure
@@ -1095,9 +1073,7 @@ module Aws::IVS
1095
1073
  # @return [String]
1096
1074
  #
1097
1075
  # @!attribute [rw] name
1098
- # An arbitrary string (a nickname) assigned to a playback key pair
1099
- # that helps the customer identify that resource. The value does not
1100
- # need to be unique.
1076
+ # Playback-key-pair name. The value does not need to be unique.
1101
1077
  # @return [String]
1102
1078
  #
1103
1079
  # @!attribute [rw] tags
@@ -1136,7 +1112,7 @@ module Aws::IVS
1136
1112
  class PutMetadataRequest < Struct.new(
1137
1113
  :channel_arn,
1138
1114
  :metadata)
1139
- SENSITIVE = []
1115
+ SENSITIVE = [:metadata]
1140
1116
  include Aws::Structure
1141
1117
  end
1142
1118
 
@@ -1146,17 +1122,15 @@ module Aws::IVS
1146
1122
  # Recording-configuration ARN.
1147
1123
  # @return [String]
1148
1124
  #
1149
- # @!attribute [rw] name
1150
- # An arbitrary string (a nickname) assigned to a recording
1151
- # configuration that helps the customer identify that resource. The
1152
- # value does not need to be unique.
1153
- # @return [String]
1154
- #
1155
1125
  # @!attribute [rw] destination_configuration
1156
1126
  # A complex type that contains information about where recorded video
1157
1127
  # will be stored.
1158
1128
  # @return [Types::DestinationConfiguration]
1159
1129
  #
1130
+ # @!attribute [rw] name
1131
+ # Recording-configuration name. The value does not need to be unique.
1132
+ # @return [String]
1133
+ #
1160
1134
  # @!attribute [rw] state
1161
1135
  # Indicates the current state of the recording configuration. When the
1162
1136
  # state is `ACTIVE`, the configuration is ready for recording a
@@ -1171,8 +1145,8 @@ module Aws::IVS
1171
1145
  #
1172
1146
  class RecordingConfiguration < Struct.new(
1173
1147
  :arn,
1174
- :name,
1175
1148
  :destination_configuration,
1149
+ :name,
1176
1150
  :state,
1177
1151
  :tags)
1178
1152
  SENSITIVE = []
@@ -1185,17 +1159,15 @@ module Aws::IVS
1185
1159
  # Recording-configuration ARN.
1186
1160
  # @return [String]
1187
1161
  #
1188
- # @!attribute [rw] name
1189
- # An arbitrary string (a nickname) assigned to a recording
1190
- # configuration that helps the customer identify that resource. The
1191
- # value does not need to be unique.
1192
- # @return [String]
1193
- #
1194
1162
  # @!attribute [rw] destination_configuration
1195
1163
  # A complex type that contains information about where recorded video
1196
1164
  # will be stored.
1197
1165
  # @return [Types::DestinationConfiguration]
1198
1166
  #
1167
+ # @!attribute [rw] name
1168
+ # Recording-configuration name. The value does not need to be unique.
1169
+ # @return [String]
1170
+ #
1199
1171
  # @!attribute [rw] state
1200
1172
  # Indicates the current state of the recording configuration. When the
1201
1173
  # state is `ACTIVE`, the configuration is ready for recording a
@@ -1210,8 +1182,8 @@ module Aws::IVS
1210
1182
  #
1211
1183
  class RecordingConfigurationSummary < Struct.new(
1212
1184
  :arn,
1213
- :name,
1214
1185
  :destination_configuration,
1186
+ :name,
1215
1187
  :state,
1216
1188
  :tags)
1217
1189
  SENSITIVE = []
@@ -1293,36 +1265,40 @@ module Aws::IVS
1293
1265
  # Channel ARN for the stream.
1294
1266
  # @return [String]
1295
1267
  #
1268
+ # @!attribute [rw] health
1269
+ # The stream’s health.
1270
+ # @return [String]
1271
+ #
1296
1272
  # @!attribute [rw] playback_url
1297
1273
  # URL of the master playlist, required by the video player to play the
1298
1274
  # HLS stream.
1299
1275
  # @return [String]
1300
1276
  #
1301
1277
  # @!attribute [rw] start_time
1302
- # ISO-8601 formatted timestamp of the stream’s start.
1278
+ # Time of the stream’s start. This is an ISO 8601 timestamp returned
1279
+ # as a string.
1303
1280
  # @return [Time]
1304
1281
  #
1305
1282
  # @!attribute [rw] state
1306
1283
  # The stream’s state.
1307
1284
  # @return [String]
1308
1285
  #
1309
- # @!attribute [rw] health
1310
- # The stream’s health.
1311
- # @return [String]
1312
- #
1313
1286
  # @!attribute [rw] viewer_count
1314
- # Number of current viewers of the stream. A value of -1 indicates
1315
- # that the request timed out; in this case, retry.
1287
+ # A count of concurrent views of the stream. Typically, a new view
1288
+ # appears in `viewerCount` within 15 seconds of when video playback
1289
+ # starts and a view is removed from `viewerCount` within 1 minute of
1290
+ # when video playback ends. A value of -1 indicates that the request
1291
+ # timed out; in this case, retry.
1316
1292
  # @return [Integer]
1317
1293
  #
1318
1294
  # @see http://docs.aws.amazon.com/goto/WebAPI/ivs-2020-07-14/Stream AWS API Documentation
1319
1295
  #
1320
1296
  class Stream < Struct.new(
1321
1297
  :channel_arn,
1298
+ :health,
1322
1299
  :playback_url,
1323
1300
  :start_time,
1324
1301
  :state,
1325
- :health,
1326
1302
  :viewer_count)
1327
1303
  SENSITIVE = []
1328
1304
  include Aws::Structure
@@ -1334,10 +1310,6 @@ module Aws::IVS
1334
1310
  # Stream-key ARN.
1335
1311
  # @return [String]
1336
1312
  #
1337
- # @!attribute [rw] value
1338
- # Stream-key value.
1339
- # @return [String]
1340
- #
1341
1313
  # @!attribute [rw] channel_arn
1342
1314
  # Channel ARN for the stream.
1343
1315
  # @return [String]
@@ -1346,14 +1318,18 @@ module Aws::IVS
1346
1318
  # Array of 1-50 maps, each of the form `string:string (key:value)`.
1347
1319
  # @return [Hash<String,String>]
1348
1320
  #
1321
+ # @!attribute [rw] value
1322
+ # Stream-key value.
1323
+ # @return [String]
1324
+ #
1349
1325
  # @see http://docs.aws.amazon.com/goto/WebAPI/ivs-2020-07-14/StreamKey AWS API Documentation
1350
1326
  #
1351
1327
  class StreamKey < Struct.new(
1352
1328
  :arn,
1353
- :value,
1354
1329
  :channel_arn,
1355
- :tags)
1356
- SENSITIVE = []
1330
+ :tags,
1331
+ :value)
1332
+ SENSITIVE = [:value]
1357
1333
  include Aws::Structure
1358
1334
  end
1359
1335
 
@@ -1387,31 +1363,35 @@ module Aws::IVS
1387
1363
  # Channel ARN for the stream.
1388
1364
  # @return [String]
1389
1365
  #
1390
- # @!attribute [rw] state
1391
- # The stream’s state.
1392
- # @return [String]
1393
- #
1394
1366
  # @!attribute [rw] health
1395
1367
  # The stream’s health.
1396
1368
  # @return [String]
1397
1369
  #
1398
- # @!attribute [rw] viewer_count
1399
- # Number of current viewers of the stream. A value of -1 indicates
1400
- # that the request timed out; in this case, retry.
1401
- # @return [Integer]
1402
- #
1403
1370
  # @!attribute [rw] start_time
1404
- # ISO-8601 formatted timestamp of the stream’s start.
1371
+ # Time of the stream’s start. This is an ISO 8601 timestamp returned
1372
+ # as a string.
1405
1373
  # @return [Time]
1406
1374
  #
1375
+ # @!attribute [rw] state
1376
+ # The stream’s state.
1377
+ # @return [String]
1378
+ #
1379
+ # @!attribute [rw] viewer_count
1380
+ # A count of concurrent views of the stream. Typically, a new view
1381
+ # appears in `viewerCount` within 15 seconds of when video playback
1382
+ # starts and a view is removed from `viewerCount` within 1 minute of
1383
+ # when video playback ends. A value of -1 indicates that the request
1384
+ # timed out; in this case, retry.
1385
+ # @return [Integer]
1386
+ #
1407
1387
  # @see http://docs.aws.amazon.com/goto/WebAPI/ivs-2020-07-14/StreamSummary AWS API Documentation
1408
1388
  #
1409
1389
  class StreamSummary < Struct.new(
1410
1390
  :channel_arn,
1411
- :state,
1412
1391
  :health,
1413
- :viewer_count,
1414
- :start_time)
1392
+ :start_time,
1393
+ :state,
1394
+ :viewer_count)
1415
1395
  SENSITIVE = []
1416
1396
  include Aws::Structure
1417
1397
  end
@@ -1505,20 +1485,20 @@ module Aws::IVS
1505
1485
  #
1506
1486
  # {
1507
1487
  # arn: "ChannelArn", # required
1508
- # name: "ChannelName",
1509
- # latency_mode: "NORMAL", # accepts NORMAL, LOW
1510
- # type: "BASIC", # accepts BASIC, STANDARD
1511
1488
  # authorized: false,
1489
+ # latency_mode: "NORMAL", # accepts NORMAL, LOW
1490
+ # name: "ChannelName",
1512
1491
  # recording_configuration_arn: "ChannelRecordingConfigurationArn",
1492
+ # type: "BASIC", # accepts BASIC, STANDARD
1513
1493
  # }
1514
1494
  #
1515
1495
  # @!attribute [rw] arn
1516
1496
  # ARN of the channel to be updated.
1517
1497
  # @return [String]
1518
1498
  #
1519
- # @!attribute [rw] name
1520
- # Channel name.
1521
- # @return [String]
1499
+ # @!attribute [rw] authorized
1500
+ # Whether the channel is private (enabled for playback authorization).
1501
+ # @return [Boolean]
1522
1502
  #
1523
1503
  # @!attribute [rw] latency_mode
1524
1504
  # Channel latency mode. Use `NORMAL` to broadcast and deliver live
@@ -1527,6 +1507,16 @@ module Aws::IVS
1527
1507
  # correspond to Ultra-low and Standard, respectively.)
1528
1508
  # @return [String]
1529
1509
  #
1510
+ # @!attribute [rw] name
1511
+ # Channel name.
1512
+ # @return [String]
1513
+ #
1514
+ # @!attribute [rw] recording_configuration_arn
1515
+ # Recording-configuration ARN. If this is set to an empty string,
1516
+ # recording is disabled. A value other than an empty string indicates
1517
+ # that recording is enabled
1518
+ # @return [String]
1519
+ #
1530
1520
  # @!attribute [rw] type
1531
1521
  # Channel type, which determines the allowable resolution and bitrate.
1532
1522
  # *If you exceed the allowable resolution or bitrate, the stream
@@ -1534,34 +1524,24 @@ module Aws::IVS
1534
1524
  #
1535
1525
  # * `STANDARD`\: Multiple qualities are generated from the original
1536
1526
  # input, to automatically give viewers the best experience for their
1537
- # devices and network conditions. Vertical resolution can be up to
1538
- # 1080 and bitrate can be up to 8.5 Mbps.
1527
+ # devices and network conditions. Resolution can be up to 1080p and
1528
+ # bitrate can be up to 8.5 Mbps. Audio is transcoded only for
1529
+ # renditions 360p and below; above that, audio is passed through.
1539
1530
  #
1540
1531
  # * `BASIC`\: Amazon IVS delivers the original input to viewers. The
1541
1532
  # viewer’s video-quality choice is limited to the original input.
1542
- # Vertical resolution can be up to 480 and bitrate can be up to 1.5
1543
- # Mbps.
1544
- # @return [String]
1545
- #
1546
- # @!attribute [rw] authorized
1547
- # Whether the channel is private (enabled for playback authorization).
1548
- # @return [Boolean]
1549
- #
1550
- # @!attribute [rw] recording_configuration_arn
1551
- # Recording-configuration ARN. If this is set to an empty string,
1552
- # recording is disabled. A value other than an empty string indicates
1553
- # that recording is enabled
1533
+ # Resolution can be up to 480p and bitrate can be up to 1.5 Mbps.
1554
1534
  # @return [String]
1555
1535
  #
1556
1536
  # @see http://docs.aws.amazon.com/goto/WebAPI/ivs-2020-07-14/UpdateChannelRequest AWS API Documentation
1557
1537
  #
1558
1538
  class UpdateChannelRequest < Struct.new(
1559
1539
  :arn,
1560
- :name,
1561
- :latency_mode,
1562
- :type,
1563
1540
  :authorized,
1564
- :recording_configuration_arn)
1541
+ :latency_mode,
1542
+ :name,
1543
+ :recording_configuration_arn,
1544
+ :type)
1565
1545
  SENSITIVE = []
1566
1546
  include Aws::Structure
1567
1547
  end
@@ -1579,8 +1559,8 @@ module Aws::IVS
1579
1559
  end
1580
1560
 
1581
1561
  # @!attribute [rw] exception_message
1582
- # The input fails to satisfy the constraints specified by an AWS
1583
- # service.
1562
+ # The input fails to satisfy the constraints specified by an Amazon
1563
+ # Web Services service.
1584
1564
  # @return [String]
1585
1565
  #
1586
1566
  # @see http://docs.aws.amazon.com/goto/WebAPI/ivs-2020-07-14/ValidationException AWS API Documentation