/
AmazonKinesisVideoArchivedMediaClient.java
1252 lines (1157 loc) · 65.2 KB
/
AmazonKinesisVideoArchivedMediaClient.java
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
/*
* Copyright 2019-2024 Amazon.com, Inc. or its affiliates. All Rights Reserved.
*
* Licensed under the Apache License, Version 2.0 (the "License"). You may not use this file except in compliance with
* the License. A copy of the License is located at
*
* http://aws.amazon.com/apache2.0
*
* or in the "license" file accompanying this file. This file is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR
* CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions
* and limitations under the License.
*/
package com.amazonaws.services.kinesisvideo;
import org.w3c.dom.*;
import java.net.*;
import java.util.*;
import javax.annotation.Generated;
import org.apache.commons.logging.*;
import com.amazonaws.*;
import com.amazonaws.annotation.SdkInternalApi;
import com.amazonaws.auth.*;
import com.amazonaws.handlers.*;
import com.amazonaws.http.*;
import com.amazonaws.internal.*;
import com.amazonaws.internal.auth.*;
import com.amazonaws.metrics.*;
import com.amazonaws.regions.*;
import com.amazonaws.transform.*;
import com.amazonaws.util.*;
import com.amazonaws.protocol.json.*;
import com.amazonaws.util.AWSRequestMetrics.Field;
import com.amazonaws.annotation.ThreadSafe;
import com.amazonaws.client.AwsSyncClientParams;
import com.amazonaws.client.builder.AdvancedConfig;
import com.amazonaws.services.kinesisvideo.AmazonKinesisVideoArchivedMediaClientBuilder;
import com.amazonaws.util.ServiceClientHolderInputStream;
import com.amazonaws.AmazonServiceException;
import com.amazonaws.services.kinesisvideo.model.*;
import com.amazonaws.services.kinesisvideo.model.transform.*;
/**
* Client for accessing Kinesis Video Archived Media. All service calls made using this client are blocking, and will
* not return until the service call completes.
* <p>
* <p/>
*/
@ThreadSafe
@Generated("com.amazonaws:aws-java-sdk-code-generator")
public class AmazonKinesisVideoArchivedMediaClient extends AmazonWebServiceClient implements AmazonKinesisVideoArchivedMedia {
/** Provider for AWS credentials. */
private final AWSCredentialsProvider awsCredentialsProvider;
private static final Log log = LogFactory.getLog(AmazonKinesisVideoArchivedMedia.class);
/** Default signing name for the service. */
private static final String DEFAULT_SIGNING_NAME = "kinesisvideo";
/** Client configuration factory providing ClientConfigurations tailored to this client */
protected static final ClientConfigurationFactory configFactory = new ClientConfigurationFactory();
private final AdvancedConfig advancedConfig;
private static final com.amazonaws.protocol.json.SdkJsonProtocolFactory protocolFactory = new com.amazonaws.protocol.json.SdkJsonProtocolFactory(
new JsonClientMetadata()
.withProtocolVersion("1.1")
.withSupportsCbor(false)
.withSupportsIon(false)
.withContentTypeOverride("application/json")
.addErrorMetadata(
new JsonErrorShapeMetadata().withErrorCode("NotAuthorizedException").withExceptionUnmarshaller(
com.amazonaws.services.kinesisvideo.model.transform.NotAuthorizedExceptionUnmarshaller.getInstance()))
.addErrorMetadata(
new JsonErrorShapeMetadata().withErrorCode("InvalidCodecPrivateDataException").withExceptionUnmarshaller(
com.amazonaws.services.kinesisvideo.model.transform.InvalidCodecPrivateDataExceptionUnmarshaller.getInstance()))
.addErrorMetadata(
new JsonErrorShapeMetadata().withErrorCode("InvalidArgumentException").withExceptionUnmarshaller(
com.amazonaws.services.kinesisvideo.model.transform.InvalidArgumentExceptionUnmarshaller.getInstance()))
.addErrorMetadata(
new JsonErrorShapeMetadata().withErrorCode("ClientLimitExceededException").withExceptionUnmarshaller(
com.amazonaws.services.kinesisvideo.model.transform.ClientLimitExceededExceptionUnmarshaller.getInstance()))
.addErrorMetadata(
new JsonErrorShapeMetadata().withErrorCode("NoDataRetentionException").withExceptionUnmarshaller(
com.amazonaws.services.kinesisvideo.model.transform.NoDataRetentionExceptionUnmarshaller.getInstance()))
.addErrorMetadata(
new JsonErrorShapeMetadata().withErrorCode("ResourceNotFoundException").withExceptionUnmarshaller(
com.amazonaws.services.kinesisvideo.model.transform.ResourceNotFoundExceptionUnmarshaller.getInstance()))
.addErrorMetadata(
new JsonErrorShapeMetadata().withErrorCode("UnsupportedStreamMediaTypeException").withExceptionUnmarshaller(
com.amazonaws.services.kinesisvideo.model.transform.UnsupportedStreamMediaTypeExceptionUnmarshaller.getInstance()))
.addErrorMetadata(
new JsonErrorShapeMetadata().withErrorCode("InvalidMediaFrameException").withExceptionUnmarshaller(
com.amazonaws.services.kinesisvideo.model.transform.InvalidMediaFrameExceptionUnmarshaller.getInstance()))
.addErrorMetadata(
new JsonErrorShapeMetadata().withErrorCode("MissingCodecPrivateDataException").withExceptionUnmarshaller(
com.amazonaws.services.kinesisvideo.model.transform.MissingCodecPrivateDataExceptionUnmarshaller.getInstance()))
.withBaseServiceExceptionClass(com.amazonaws.services.kinesisvideo.model.AmazonKinesisVideoException.class));
public static AmazonKinesisVideoArchivedMediaClientBuilder builder() {
return AmazonKinesisVideoArchivedMediaClientBuilder.standard();
}
/**
* Constructs a new client to invoke service methods on Kinesis Video Archived Media using the specified parameters.
*
* <p>
* All service calls made using this new client object are blocking, and will not return until the service call
* completes.
*
* @param clientParams
* Object providing client parameters.
*/
AmazonKinesisVideoArchivedMediaClient(AwsSyncClientParams clientParams) {
this(clientParams, false);
}
/**
* Constructs a new client to invoke service methods on Kinesis Video Archived Media using the specified parameters.
*
* <p>
* All service calls made using this new client object are blocking, and will not return until the service call
* completes.
*
* @param clientParams
* Object providing client parameters.
*/
AmazonKinesisVideoArchivedMediaClient(AwsSyncClientParams clientParams, boolean endpointDiscoveryEnabled) {
super(clientParams);
this.awsCredentialsProvider = clientParams.getCredentialsProvider();
this.advancedConfig = clientParams.getAdvancedConfig();
init();
}
private void init() {
setServiceNameIntern(DEFAULT_SIGNING_NAME);
setEndpointPrefix(ENDPOINT_PREFIX);
// calling this.setEndPoint(...) will also modify the signer accordingly
setEndpoint("kinesisvideo.us-east-1.amazonaws.com");
HandlerChainFactory chainFactory = new HandlerChainFactory();
requestHandler2s.addAll(chainFactory.newRequestHandlerChain("/com/amazonaws/services/kinesisvideo/request.handlers"));
requestHandler2s.addAll(chainFactory.newRequestHandler2Chain("/com/amazonaws/services/kinesisvideo/request.handler2s"));
requestHandler2s.addAll(chainFactory.getGlobalHandlers());
}
/**
* <p>
* Downloads an MP4 file (clip) containing the archived, on-demand media from the specified video stream over the
* specified time range.
* </p>
* <p>
* Both the StreamName and the StreamARN parameters are optional, but you must specify either the StreamName or the
* StreamARN when invoking this API operation.
* </p>
* <p>
* As a prerequisite to using GetCLip API, you must obtain an endpoint using <code>GetDataEndpoint</code>,
* specifying GET_CLIP for<code/> the <code>APIName</code> parameter.
* </p>
* <p>
* An Amazon Kinesis video stream has the following requirements for providing data through MP4:
* </p>
* <ul>
* <li>
* <p>
* The media must contain h.264 or h.265 encoded video and, optionally, AAC or G.711 encoded audio. Specifically,
* the codec ID of track 1 should be <code>V_MPEG/ISO/AVC</code> (for h.264) or V_MPEGH/ISO/HEVC (for H.265).
* Optionally, the codec ID of track 2 should be <code>A_AAC</code> (for AAC) or A_MS/ACM (for G.711).
* </p>
* </li>
* <li>
* <p>
* Data retention must be greater than 0.
* </p>
* </li>
* <li>
* <p>
* The video track of each fragment must contain codec private data in the Advanced Video Coding (AVC) for H.264
* format and HEVC for H.265 format. For more information, see <a
* href="https://www.iso.org/standard/55980.html">MPEG-4 specification ISO/IEC 14496-15</a>. For information about
* adapting stream data to a given format, see <a
* href="http://docs.aws.amazon.com/kinesisvideostreams/latest/dg/producer-reference-nal.html">NAL Adaptation
* Flags</a>.
* </p>
* </li>
* <li>
* <p>
* The audio track (if present) of each fragment must contain codec private data in the AAC format (<a
* href="https://www.iso.org/standard/43345.html">AAC specification ISO/IEC 13818-7</a>) or the <a
* href="http://www-mmsp.ece.mcgill.ca/Documents/AudioFormats/WAVE/WAVE.html">MS Wave format</a>.
* </p>
* </li>
* </ul>
* <p>
* You can monitor the amount of outgoing data by monitoring the <code>GetClip.OutgoingBytes</code> Amazon
* CloudWatch metric. For information about using CloudWatch to monitor Kinesis Video Streams, see <a
* href="http://docs.aws.amazon.com/kinesisvideostreams/latest/dg/monitoring.html">Monitoring Kinesis Video
* Streams</a>. For pricing information, see <a href="https://aws.amazon.com/kinesis/video-streams/pricing/">Amazon
* Kinesis Video Streams Pricing</a> and <a href="https://aws.amazon.com/pricing/"> Amazon Web Services Pricing</a>.
* Charges for outgoing Amazon Web Services data apply.
* </p>
*
* @param getClipRequest
* @return Result of the GetClip operation returned by the service.
* @throws ResourceNotFoundException
* <code>GetImages</code> will throw this error when Kinesis Video Streams can't find the stream that you
* specified.</p>
* <p>
* <code>GetHLSStreamingSessionURL</code> and <code>GetDASHStreamingSessionURL</code> throw this error if a
* session with a <code>PlaybackMode</code> of <code>ON_DEMAND</code> or <code>LIVE_REPLAY</code>is
* requested for a stream that has no fragments within the requested time range, or if a session with a
* <code>PlaybackMode</code> of <code>LIVE</code> is requested for a stream that has no fragments within the
* last 30 seconds.
* @throws InvalidArgumentException
* A specified parameter exceeds its restrictions, is not supported, or can't be used.
* @throws ClientLimitExceededException
* Kinesis Video Streams has throttled the request because you have exceeded a limit. Try making the call
* later. For information about limits, see <a
* href="http://docs.aws.amazon.com/kinesisvideostreams/latest/dg/limits.html">Kinesis Video Streams
* Limits</a>.
* @throws NotAuthorizedException
* Status Code: 403, The caller is not authorized to perform an operation on the given stream, or the token
* has expired.
* @throws UnsupportedStreamMediaTypeException
* The type of the media (for example, h.264 or h.265 video or ACC or G.711 audio) could not be determined
* from the codec IDs of the tracks in the first fragment for a playback session. The codec ID for track 1
* should be <code>V_MPEG/ISO/AVC</code> and, optionally, the codec ID for track 2 should be
* <code>A_AAC</code>.
* @throws MissingCodecPrivateDataException
* No codec private data was found in at least one of tracks of the video stream.
* @throws InvalidCodecPrivateDataException
* The codec private data in at least one of the tracks of the video stream is not valid for this operation.
* @throws InvalidMediaFrameException
* One or more frames in the requested clip could not be parsed based on the specified codec.
* @throws NoDataRetentionException
* <code>GetImages</code> was requested for a stream that does not retain data (that is, has a
* <code>DataRetentionInHours</code> of 0).
* @sample AmazonKinesisVideoArchivedMedia.GetClip
* @see <a href="http://docs.aws.amazon.com/goto/WebAPI/kinesis-video-archived-media-2017-09-30/GetClip"
* target="_top">AWS API Documentation</a>
*/
@Override
public GetClipResult getClip(GetClipRequest request) {
request = beforeClientExecution(request);
return executeGetClip(request);
}
@SdkInternalApi
final GetClipResult executeGetClip(GetClipRequest getClipRequest) {
ExecutionContext executionContext = createExecutionContext(getClipRequest);
AWSRequestMetrics awsRequestMetrics = executionContext.getAwsRequestMetrics();
awsRequestMetrics.startEvent(Field.ClientExecuteTime);
Request<GetClipRequest> request = null;
Response<GetClipResult> response = null;
try {
awsRequestMetrics.startEvent(Field.RequestMarshallTime);
try {
request = new GetClipRequestProtocolMarshaller(protocolFactory).marshall(super.beforeMarshalling(getClipRequest));
// Binds the request metrics to the current request.
request.setAWSRequestMetrics(awsRequestMetrics);
request.addHandlerContext(HandlerContextKey.CLIENT_ENDPOINT, endpoint);
request.addHandlerContext(HandlerContextKey.ENDPOINT_OVERRIDDEN, isEndpointOverridden());
request.addHandlerContext(HandlerContextKey.SIGNING_REGION, getSigningRegion());
request.addHandlerContext(HandlerContextKey.SERVICE_ID, "Kinesis Video Archived Media");
request.addHandlerContext(HandlerContextKey.OPERATION_NAME, "GetClip");
request.addHandlerContext(HandlerContextKey.ADVANCED_CONFIG, advancedConfig);
} finally {
awsRequestMetrics.endEvent(Field.RequestMarshallTime);
}
HttpResponseHandler<AmazonWebServiceResponse<GetClipResult>> responseHandler = protocolFactory.createResponseHandler(new JsonOperationMetadata()
.withPayloadJson(false).withHasStreamingSuccessResponse(true), new GetClipResultJsonUnmarshaller());
response = invoke(request, responseHandler, executionContext);
response.getAwsResponse().setPayload(new com.amazonaws.util.ServiceClientHolderInputStream(response.getAwsResponse().getPayload(), this));
request.addHandlerContext(HandlerContextKey.HAS_STREAMING_OUTPUT, Boolean.TRUE);
return response.getAwsResponse();
} finally {
endClientExecution(awsRequestMetrics, request, response);
}
}
/**
* <p>
* Retrieves an MPEG Dynamic Adaptive Streaming over HTTP (DASH) URL for the stream. You can then open the URL in a
* media player to view the stream contents.
* </p>
* <p>
* Both the <code>StreamName</code> and the <code>StreamARN</code> parameters are optional, but you must specify
* either the <code>StreamName</code> or the <code>StreamARN</code> when invoking this API operation.
* </p>
* <p>
* An Amazon Kinesis video stream has the following requirements for providing data through MPEG-DASH:
* </p>
* <ul>
* <li>
* <p>
* The media must contain h.264 or h.265 encoded video and, optionally, AAC or G.711 encoded audio. Specifically,
* the codec ID of track 1 should be <code>V_MPEG/ISO/AVC</code> (for h.264) or V_MPEGH/ISO/HEVC (for H.265).
* Optionally, the codec ID of track 2 should be <code>A_AAC</code> (for AAC) or A_MS/ACM (for G.711).
* </p>
* </li>
* <li>
* <p>
* Data retention must be greater than 0.
* </p>
* </li>
* <li>
* <p>
* The video track of each fragment must contain codec private data in the Advanced Video Coding (AVC) for H.264
* format and HEVC for H.265 format. For more information, see <a
* href="https://www.iso.org/standard/55980.html">MPEG-4 specification ISO/IEC 14496-15</a>. For information about
* adapting stream data to a given format, see <a
* href="http://docs.aws.amazon.com/kinesisvideostreams/latest/dg/producer-reference-nal.html">NAL Adaptation
* Flags</a>.
* </p>
* </li>
* <li>
* <p>
* The audio track (if present) of each fragment must contain codec private data in the AAC format (<a
* href="https://www.iso.org/standard/43345.html">AAC specification ISO/IEC 13818-7</a>) or the <a
* href="http://www-mmsp.ece.mcgill.ca/Documents/AudioFormats/WAVE/WAVE.html">MS Wave format</a>.
* </p>
* </li>
* </ul>
* <p>
* The following procedure shows how to use MPEG-DASH with Kinesis Video Streams:
* </p>
* <ol>
* <li>
* <p>
* Get an endpoint using <a
* href="http://docs.aws.amazon.com/kinesisvideostreams/latest/dg/API_GetDataEndpoint.html">GetDataEndpoint</a>,
* specifying <code>GET_DASH_STREAMING_SESSION_URL</code> for the <code>APIName</code> parameter.
* </p>
* </li>
* <li>
* <p>
* Retrieve the MPEG-DASH URL using <code>GetDASHStreamingSessionURL</code>. Kinesis Video Streams creates an
* MPEG-DASH streaming session to be used for accessing content in a stream using the MPEG-DASH protocol.
* <code>GetDASHStreamingSessionURL</code> returns an authenticated URL (that includes an encrypted session token)
* for the session's MPEG-DASH <i>manifest</i> (the root resource needed for streaming with MPEG-DASH).
* </p>
* <note>
* <p>
* Don't share or store this token where an unauthorized entity can access it. The token provides access to the
* content of the stream. Safeguard the token with the same measures that you use with your Amazon Web Services
* credentials.
* </p>
* </note>
* <p>
* The media that is made available through the manifest consists only of the requested stream, time range, and
* format. No other media data (such as frames outside the requested window or alternate bitrates) is made
* available.
* </p>
* </li>
* <li>
* <p>
* Provide the URL (containing the encrypted session token) for the MPEG-DASH manifest to a media player that
* supports the MPEG-DASH protocol. Kinesis Video Streams makes the initialization fragment and media fragments
* available through the manifest URL. The initialization fragment contains the codec private data for the stream,
* and other data needed to set up the video or audio decoder and renderer. The media fragments contain encoded
* video frames or encoded audio samples.
* </p>
* </li>
* <li>
* <p>
* The media player receives the authenticated URL and requests stream metadata and media data normally. When the
* media player requests data, it calls the following actions:
* </p>
* <ul>
* <li>
* <p>
* <b>GetDASHManifest:</b> Retrieves an MPEG DASH manifest, which contains the metadata for the media that you want
* to playback.
* </p>
* </li>
* <li>
* <p>
* <b>GetMP4InitFragment:</b> Retrieves the MP4 initialization fragment. The media player typically loads the
* initialization fragment before loading any media fragments. This fragment contains the "<code>fytp</code>" and "
* <code>moov</code>" MP4 atoms, and the child atoms that are needed to initialize the media player decoder.
* </p>
* <p>
* The initialization fragment does not correspond to a fragment in a Kinesis video stream. It contains only the
* codec private data for the stream and respective track, which the media player needs to decode the media frames.
* </p>
* </li>
* <li>
* <p>
* <b>GetMP4MediaFragment:</b> Retrieves MP4 media fragments. These fragments contain the "<code>moof</code>" and "
* <code>mdat</code>" MP4 atoms and their child atoms, containing the encoded fragment's media frames and their
* timestamps.
* </p>
* <note>
* <p>
* After the first media fragment is made available in a streaming session, any fragments that don't contain the
* same codec private data cause an error to be returned when those different media fragments are loaded. Therefore,
* the codec private data should not change between fragments in a session. This also means that the session fails
* if the fragments in a stream change from having only video to having both audio and video.
* </p>
* </note>
* <p>
* Data retrieved with this action is billable. See <a
* href="https://aws.amazon.com/kinesis/video-streams/pricing/">Pricing</a> for details.
* </p>
* </li>
* </ul>
* </li>
* </ol>
* <note>
* <p>
* For restrictions that apply to MPEG-DASH sessions, see <a
* href="http://docs.aws.amazon.com/kinesisvideostreams/latest/dg/limits.html">Kinesis Video Streams Limits</a>.
* </p>
* </note>
* <p>
* You can monitor the amount of data that the media player consumes by monitoring the
* <code>GetMP4MediaFragment.OutgoingBytes</code> Amazon CloudWatch metric. For information about using CloudWatch
* to monitor Kinesis Video Streams, see <a
* href="http://docs.aws.amazon.com/kinesisvideostreams/latest/dg/monitoring.html">Monitoring Kinesis Video
* Streams</a>. For pricing information, see <a href="https://aws.amazon.com/kinesis/video-streams/pricing/">Amazon
* Kinesis Video Streams Pricing</a> and <a href="https://aws.amazon.com/pricing/">Amazon Web Services Pricing</a>.
* Charges for both HLS sessions and outgoing Amazon Web Services data apply.
* </p>
* <p>
* For more information about HLS, see <a href="https://developer.apple.com/streaming/">HTTP Live Streaming</a> on
* the <a href="https://developer.apple.com">Apple Developer site</a>.
* </p>
* <important>
* <p>
* If an error is thrown after invoking a Kinesis Video Streams archived media API, in addition to the HTTP status
* code and the response body, it includes the following pieces of information:
* </p>
* <ul>
* <li>
* <p>
* <code>x-amz-ErrorType</code> HTTP header – contains a more specific error type in addition to what the HTTP
* status code provides.
* </p>
* </li>
* <li>
* <p>
* <code>x-amz-RequestId</code> HTTP header – if you want to report an issue to Amazon Web Services the support team
* can better diagnose the problem if given the Request Id.
* </p>
* </li>
* </ul>
* <p>
* Both the HTTP status code and the ErrorType header can be utilized to make programmatic decisions about whether
* errors are retry-able and under what conditions, as well as provide information on what actions the client
* programmer might need to take in order to successfully try again.
* </p>
* <p>
* For more information, see the <b>Errors</b> section at the bottom of this topic, as well as <a
* href="https://docs.aws.amazon.com/kinesisvideostreams/latest/dg/CommonErrors.html">Common Errors</a>.
* </p>
* </important>
*
* @param getDASHStreamingSessionURLRequest
* @return Result of the GetDASHStreamingSessionURL operation returned by the service.
* @throws ResourceNotFoundException
* <code>GetImages</code> will throw this error when Kinesis Video Streams can't find the stream that you
* specified.</p>
* <p>
* <code>GetHLSStreamingSessionURL</code> and <code>GetDASHStreamingSessionURL</code> throw this error if a
* session with a <code>PlaybackMode</code> of <code>ON_DEMAND</code> or <code>LIVE_REPLAY</code>is
* requested for a stream that has no fragments within the requested time range, or if a session with a
* <code>PlaybackMode</code> of <code>LIVE</code> is requested for a stream that has no fragments within the
* last 30 seconds.
* @throws InvalidArgumentException
* A specified parameter exceeds its restrictions, is not supported, or can't be used.
* @throws ClientLimitExceededException
* Kinesis Video Streams has throttled the request because you have exceeded a limit. Try making the call
* later. For information about limits, see <a
* href="http://docs.aws.amazon.com/kinesisvideostreams/latest/dg/limits.html">Kinesis Video Streams
* Limits</a>.
* @throws NotAuthorizedException
* Status Code: 403, The caller is not authorized to perform an operation on the given stream, or the token
* has expired.
* @throws UnsupportedStreamMediaTypeException
* The type of the media (for example, h.264 or h.265 video or ACC or G.711 audio) could not be determined
* from the codec IDs of the tracks in the first fragment for a playback session. The codec ID for track 1
* should be <code>V_MPEG/ISO/AVC</code> and, optionally, the codec ID for track 2 should be
* <code>A_AAC</code>.
* @throws NoDataRetentionException
* <code>GetImages</code> was requested for a stream that does not retain data (that is, has a
* <code>DataRetentionInHours</code> of 0).
* @throws MissingCodecPrivateDataException
* No codec private data was found in at least one of tracks of the video stream.
* @throws InvalidCodecPrivateDataException
* The codec private data in at least one of the tracks of the video stream is not valid for this operation.
* @sample AmazonKinesisVideoArchivedMedia.GetDASHStreamingSessionURL
* @see <a
* href="http://docs.aws.amazon.com/goto/WebAPI/kinesis-video-archived-media-2017-09-30/GetDASHStreamingSessionURL"
* target="_top">AWS API Documentation</a>
*/
@Override
public GetDASHStreamingSessionURLResult getDASHStreamingSessionURL(GetDASHStreamingSessionURLRequest request) {
request = beforeClientExecution(request);
return executeGetDASHStreamingSessionURL(request);
}
@SdkInternalApi
final GetDASHStreamingSessionURLResult executeGetDASHStreamingSessionURL(GetDASHStreamingSessionURLRequest getDASHStreamingSessionURLRequest) {
ExecutionContext executionContext = createExecutionContext(getDASHStreamingSessionURLRequest);
AWSRequestMetrics awsRequestMetrics = executionContext.getAwsRequestMetrics();
awsRequestMetrics.startEvent(Field.ClientExecuteTime);
Request<GetDASHStreamingSessionURLRequest> request = null;
Response<GetDASHStreamingSessionURLResult> response = null;
try {
awsRequestMetrics.startEvent(Field.RequestMarshallTime);
try {
request = new GetDASHStreamingSessionURLRequestProtocolMarshaller(protocolFactory).marshall(super
.beforeMarshalling(getDASHStreamingSessionURLRequest));
// Binds the request metrics to the current request.
request.setAWSRequestMetrics(awsRequestMetrics);
request.addHandlerContext(HandlerContextKey.CLIENT_ENDPOINT, endpoint);
request.addHandlerContext(HandlerContextKey.ENDPOINT_OVERRIDDEN, isEndpointOverridden());
request.addHandlerContext(HandlerContextKey.SIGNING_REGION, getSigningRegion());
request.addHandlerContext(HandlerContextKey.SERVICE_ID, "Kinesis Video Archived Media");
request.addHandlerContext(HandlerContextKey.OPERATION_NAME, "GetDASHStreamingSessionURL");
request.addHandlerContext(HandlerContextKey.ADVANCED_CONFIG, advancedConfig);
} finally {
awsRequestMetrics.endEvent(Field.RequestMarshallTime);
}
HttpResponseHandler<AmazonWebServiceResponse<GetDASHStreamingSessionURLResult>> responseHandler = protocolFactory.createResponseHandler(
new JsonOperationMetadata().withPayloadJson(true).withHasStreamingSuccessResponse(false),
new GetDASHStreamingSessionURLResultJsonUnmarshaller());
response = invoke(request, responseHandler, executionContext);
return response.getAwsResponse();
} finally {
endClientExecution(awsRequestMetrics, request, response);
}
}
/**
* <p>
* Retrieves an HTTP Live Streaming (HLS) URL for the stream. You can then open the URL in a browser or media player
* to view the stream contents.
* </p>
* <p>
* Both the <code>StreamName</code> and the <code>StreamARN</code> parameters are optional, but you must specify
* either the <code>StreamName</code> or the <code>StreamARN</code> when invoking this API operation.
* </p>
* <p>
* An Amazon Kinesis video stream has the following requirements for providing data through HLS:
* </p>
* <ul>
* <li>
* <p>
* For streaming video, the media must contain H.264 or H.265 encoded video and, optionally, AAC encoded audio.
* Specifically, the codec ID of track 1 should be <code>V_MPEG/ISO/AVC</code> (for H.264) or
* <code>V_MPEG/ISO/HEVC</code> (for H.265). Optionally, the codec ID of track 2 should be <code>A_AAC</code>. For
* audio only streaming, the codec ID of track 1 should be <code>A_AAC</code>.
* </p>
* </li>
* <li>
* <p>
* Data retention must be greater than 0.
* </p>
* </li>
* <li>
* <p>
* The video track of each fragment must contain codec private data in the Advanced Video Coding (AVC) for H.264
* format or HEVC for H.265 format (<a href="https://www.iso.org/standard/55980.html">MPEG-4 specification ISO/IEC
* 14496-15</a>). For information about adapting stream data to a given format, see <a
* href="http://docs.aws.amazon.com/kinesisvideostreams/latest/dg/producer-reference-nal.html">NAL Adaptation
* Flags</a>.
* </p>
* </li>
* <li>
* <p>
* The audio track (if present) of each fragment must contain codec private data in the AAC format (<a
* href="https://www.iso.org/standard/43345.html">AAC specification ISO/IEC 13818-7</a>).
* </p>
* </li>
* </ul>
* <p>
* Kinesis Video Streams HLS sessions contain fragments in the fragmented MPEG-4 form (also called fMP4 or CMAF) or
* the MPEG-2 form (also called TS chunks, which the HLS specification also supports). For more information about
* HLS fragment types, see the <a href="https://tools.ietf.org/html/draft-pantos-http-live-streaming-23">HLS
* specification</a>.
* </p>
* <p>
* The following procedure shows how to use HLS with Kinesis Video Streams:
* </p>
* <ol>
* <li>
* <p>
* Get an endpoint using <a
* href="http://docs.aws.amazon.com/kinesisvideostreams/latest/dg/API_GetDataEndpoint.html">GetDataEndpoint</a>,
* specifying <code>GET_HLS_STREAMING_SESSION_URL</code> for the <code>APIName</code> parameter.
* </p>
* </li>
* <li>
* <p>
* Retrieve the HLS URL using <code>GetHLSStreamingSessionURL</code>. Kinesis Video Streams creates an HLS streaming
* session to be used for accessing content in a stream using the HLS protocol.
* <code>GetHLSStreamingSessionURL</code> returns an authenticated URL (that includes an encrypted session token)
* for the session's HLS <i>master playlist</i> (the root resource needed for streaming with HLS).
* </p>
* <note>
* <p>
* Don't share or store this token where an unauthorized entity could access it. The token provides access to the
* content of the stream. Safeguard the token with the same measures that you would use with your Amazon Web
* Services credentials.
* </p>
* </note>
* <p>
* The media that is made available through the playlist consists only of the requested stream, time range, and
* format. No other media data (such as frames outside the requested window or alternate bitrates) is made
* available.
* </p>
* </li>
* <li>
* <p>
* Provide the URL (containing the encrypted session token) for the HLS master playlist to a media player that
* supports the HLS protocol. Kinesis Video Streams makes the HLS media playlist, initialization fragment, and media
* fragments available through the master playlist URL. The initialization fragment contains the codec private data
* for the stream, and other data needed to set up the video or audio decoder and renderer. The media fragments
* contain H.264-encoded video frames or AAC-encoded audio samples.
* </p>
* </li>
* <li>
* <p>
* The media player receives the authenticated URL and requests stream metadata and media data normally. When the
* media player requests data, it calls the following actions:
* </p>
* <ul>
* <li>
* <p>
* <b>GetHLSMasterPlaylist:</b> Retrieves an HLS master playlist, which contains a URL for the
* <code>GetHLSMediaPlaylist</code> action for each track, and additional metadata for the media player, including
* estimated bitrate and resolution.
* </p>
* </li>
* <li>
* <p>
* <b>GetHLSMediaPlaylist:</b> Retrieves an HLS media playlist, which contains a URL to access the MP4
* initialization fragment with the <code>GetMP4InitFragment</code> action, and URLs to access the MP4 media
* fragments with the <code>GetMP4MediaFragment</code> actions. The HLS media playlist also contains metadata about
* the stream that the player needs to play it, such as whether the <code>PlaybackMode</code> is <code>LIVE</code>
* or <code>ON_DEMAND</code>. The HLS media playlist is typically static for sessions with a
* <code>PlaybackType</code> of <code>ON_DEMAND</code>. The HLS media playlist is continually updated with new
* fragments for sessions with a <code>PlaybackType</code> of <code>LIVE</code>. There is a distinct HLS media
* playlist for the video track and the audio track (if applicable) that contains MP4 media URLs for the specific
* track.
* </p>
* </li>
* <li>
* <p>
* <b>GetMP4InitFragment:</b> Retrieves the MP4 initialization fragment. The media player typically loads the
* initialization fragment before loading any media fragments. This fragment contains the "<code>fytp</code>" and "
* <code>moov</code>" MP4 atoms, and the child atoms that are needed to initialize the media player decoder.
* </p>
* <p>
* The initialization fragment does not correspond to a fragment in a Kinesis video stream. It contains only the
* codec private data for the stream and respective track, which the media player needs to decode the media frames.
* </p>
* </li>
* <li>
* <p>
* <b>GetMP4MediaFragment:</b> Retrieves MP4 media fragments. These fragments contain the "<code>moof</code>" and "
* <code>mdat</code>" MP4 atoms and their child atoms, containing the encoded fragment's media frames and their
* timestamps.
* </p>
* <note>
* <p>
* For the HLS streaming session, in-track codec private data (CPD) changes are supported. After the first media
* fragment is made available in a streaming session, fragments can contain CPD changes for each track. Therefore,
* the fragments in a session can have a different resolution, bit rate, or other information in the CPD without
* interrupting playback. However, any change made in the track number or track codec format can return an error
* when those different media fragments are loaded. For example, streaming will fail if the fragments in the stream
* change from having only video to having both audio and video, or if an AAC audio track is changed to an ALAW
* audio track. For each streaming session, only 500 CPD changes are allowed.
* </p>
* </note>
* <p>
* Data retrieved with this action is billable. For information, see <a
* href="https://aws.amazon.com/kinesis/video-streams/pricing/">Pricing</a>.
* </p>
* </li>
* <li>
* <p>
* <b>GetTSFragment:</b> Retrieves MPEG TS fragments containing both initialization and media data for all tracks in
* the stream.
* </p>
* <note>
* <p>
* If the <code>ContainerFormat</code> is <code>MPEG_TS</code>, this API is used instead of
* <code>GetMP4InitFragment</code> and <code>GetMP4MediaFragment</code> to retrieve stream media.
* </p>
* </note>
* <p>
* Data retrieved with this action is billable. For more information, see <a
* href="https://aws.amazon.com/kinesis/video-streams/pricing/">Kinesis Video Streams pricing</a>.
* </p>
* </li>
* </ul>
* </li>
* </ol>
* <p>
* A streaming session URL must not be shared between players. The service might throttle a session if multiple
* media players are sharing it. For connection limits, see <a
* href="http://docs.aws.amazon.com/kinesisvideostreams/latest/dg/limits.html">Kinesis Video Streams Limits</a>.
* </p>
* <p>
* You can monitor the amount of data that the media player consumes by monitoring the
* <code>GetMP4MediaFragment.OutgoingBytes</code> Amazon CloudWatch metric. For information about using CloudWatch
* to monitor Kinesis Video Streams, see <a
* href="http://docs.aws.amazon.com/kinesisvideostreams/latest/dg/monitoring.html">Monitoring Kinesis Video
* Streams</a>. For pricing information, see <a href="https://aws.amazon.com/kinesis/video-streams/pricing/">Amazon
* Kinesis Video Streams Pricing</a> and <a href="https://aws.amazon.com/pricing/">Amazon Web Services Pricing</a>.
* Charges for both HLS sessions and outgoing Amazon Web Services data apply.
* </p>
* <p>
* For more information about HLS, see <a href="https://developer.apple.com/streaming/">HTTP Live Streaming</a> on
* the <a href="https://developer.apple.com">Apple Developer site</a>.
* </p>
* <important>
* <p>
* If an error is thrown after invoking a Kinesis Video Streams archived media API, in addition to the HTTP status
* code and the response body, it includes the following pieces of information:
* </p>
* <ul>
* <li>
* <p>
* <code>x-amz-ErrorType</code> HTTP header – contains a more specific error type in addition to what the HTTP
* status code provides.
* </p>
* </li>
* <li>
* <p>
* <code>x-amz-RequestId</code> HTTP header – if you want to report an issue to Amazon Web Services, the support
* team can better diagnose the problem if given the Request Id.
* </p>
* </li>
* </ul>
* <p>
* Both the HTTP status code and the ErrorType header can be utilized to make programmatic decisions about whether
* errors are retry-able and under what conditions, as well as provide information on what actions the client
* programmer might need to take in order to successfully try again.
* </p>
* <p>
* For more information, see the <b>Errors</b> section at the bottom of this topic, as well as <a
* href="https://docs.aws.amazon.com/kinesisvideostreams/latest/dg/CommonErrors.html">Common Errors</a>.
* </p>
* </important>
*
* @param getHLSStreamingSessionURLRequest
* @return Result of the GetHLSStreamingSessionURL operation returned by the service.
* @throws ResourceNotFoundException
* <code>GetImages</code> will throw this error when Kinesis Video Streams can't find the stream that you
* specified.</p>
* <p>
* <code>GetHLSStreamingSessionURL</code> and <code>GetDASHStreamingSessionURL</code> throw this error if a
* session with a <code>PlaybackMode</code> of <code>ON_DEMAND</code> or <code>LIVE_REPLAY</code>is
* requested for a stream that has no fragments within the requested time range, or if a session with a
* <code>PlaybackMode</code> of <code>LIVE</code> is requested for a stream that has no fragments within the
* last 30 seconds.
* @throws InvalidArgumentException
* A specified parameter exceeds its restrictions, is not supported, or can't be used.
* @throws ClientLimitExceededException
* Kinesis Video Streams has throttled the request because you have exceeded a limit. Try making the call
* later. For information about limits, see <a
* href="http://docs.aws.amazon.com/kinesisvideostreams/latest/dg/limits.html">Kinesis Video Streams
* Limits</a>.
* @throws NotAuthorizedException
* Status Code: 403, The caller is not authorized to perform an operation on the given stream, or the token
* has expired.
* @throws UnsupportedStreamMediaTypeException
* The type of the media (for example, h.264 or h.265 video or ACC or G.711 audio) could not be determined
* from the codec IDs of the tracks in the first fragment for a playback session. The codec ID for track 1
* should be <code>V_MPEG/ISO/AVC</code> and, optionally, the codec ID for track 2 should be
* <code>A_AAC</code>.
* @throws NoDataRetentionException
* <code>GetImages</code> was requested for a stream that does not retain data (that is, has a
* <code>DataRetentionInHours</code> of 0).
* @throws MissingCodecPrivateDataException
* No codec private data was found in at least one of tracks of the video stream.
* @throws InvalidCodecPrivateDataException
* The codec private data in at least one of the tracks of the video stream is not valid for this operation.
* @sample AmazonKinesisVideoArchivedMedia.GetHLSStreamingSessionURL
* @see <a
* href="http://docs.aws.amazon.com/goto/WebAPI/kinesis-video-archived-media-2017-09-30/GetHLSStreamingSessionURL"
* target="_top">AWS API Documentation</a>
*/
@Override
public GetHLSStreamingSessionURLResult getHLSStreamingSessionURL(GetHLSStreamingSessionURLRequest request) {
request = beforeClientExecution(request);
return executeGetHLSStreamingSessionURL(request);
}
@SdkInternalApi
final GetHLSStreamingSessionURLResult executeGetHLSStreamingSessionURL(GetHLSStreamingSessionURLRequest getHLSStreamingSessionURLRequest) {
ExecutionContext executionContext = createExecutionContext(getHLSStreamingSessionURLRequest);
AWSRequestMetrics awsRequestMetrics = executionContext.getAwsRequestMetrics();
awsRequestMetrics.startEvent(Field.ClientExecuteTime);
Request<GetHLSStreamingSessionURLRequest> request = null;
Response<GetHLSStreamingSessionURLResult> response = null;
try {
awsRequestMetrics.startEvent(Field.RequestMarshallTime);
try {
request = new GetHLSStreamingSessionURLRequestProtocolMarshaller(protocolFactory).marshall(super
.beforeMarshalling(getHLSStreamingSessionURLRequest));
// Binds the request metrics to the current request.
request.setAWSRequestMetrics(awsRequestMetrics);
request.addHandlerContext(HandlerContextKey.CLIENT_ENDPOINT, endpoint);
request.addHandlerContext(HandlerContextKey.ENDPOINT_OVERRIDDEN, isEndpointOverridden());
request.addHandlerContext(HandlerContextKey.SIGNING_REGION, getSigningRegion());
request.addHandlerContext(HandlerContextKey.SERVICE_ID, "Kinesis Video Archived Media");
request.addHandlerContext(HandlerContextKey.OPERATION_NAME, "GetHLSStreamingSessionURL");
request.addHandlerContext(HandlerContextKey.ADVANCED_CONFIG, advancedConfig);
} finally {
awsRequestMetrics.endEvent(Field.RequestMarshallTime);
}
HttpResponseHandler<AmazonWebServiceResponse<GetHLSStreamingSessionURLResult>> responseHandler = protocolFactory.createResponseHandler(
new JsonOperationMetadata().withPayloadJson(true).withHasStreamingSuccessResponse(false),
new GetHLSStreamingSessionURLResultJsonUnmarshaller());
response = invoke(request, responseHandler, executionContext);
return response.getAwsResponse();
} finally {
endClientExecution(awsRequestMetrics, request, response);
}
}
/**
* <p>
* Retrieves a list of images corresponding to each timestamp for a given time range, sampling interval, and image
* format configuration.
* </p>
*
* @param getImagesRequest
* @return Result of the GetImages operation returned by the service.
* @throws ResourceNotFoundException
* <code>GetImages</code> will throw this error when Kinesis Video Streams can't find the stream that you
* specified.</p>
* <p>
* <code>GetHLSStreamingSessionURL</code> and <code>GetDASHStreamingSessionURL</code> throw this error if a
* session with a <code>PlaybackMode</code> of <code>ON_DEMAND</code> or <code>LIVE_REPLAY</code>is
* requested for a stream that has no fragments within the requested time range, or if a session with a
* <code>PlaybackMode</code> of <code>LIVE</code> is requested for a stream that has no fragments within the
* last 30 seconds.
* @throws InvalidArgumentException
* A specified parameter exceeds its restrictions, is not supported, or can't be used.
* @throws ClientLimitExceededException
* Kinesis Video Streams has throttled the request because you have exceeded a limit. Try making the call
* later. For information about limits, see <a
* href="http://docs.aws.amazon.com/kinesisvideostreams/latest/dg/limits.html">Kinesis Video Streams
* Limits</a>.
* @throws NotAuthorizedException
* Status Code: 403, The caller is not authorized to perform an operation on the given stream, or the token
* has expired.
* @throws NoDataRetentionException
* <code>GetImages</code> was requested for a stream that does not retain data (that is, has a
* <code>DataRetentionInHours</code> of 0).
* @sample AmazonKinesisVideoArchivedMedia.GetImages
* @see <a href="http://docs.aws.amazon.com/goto/WebAPI/kinesis-video-archived-media-2017-09-30/GetImages"
* target="_top">AWS API Documentation</a>
*/
@Override
public GetImagesResult getImages(GetImagesRequest request) {
request = beforeClientExecution(request);
return executeGetImages(request);
}
@SdkInternalApi
final GetImagesResult executeGetImages(GetImagesRequest getImagesRequest) {
ExecutionContext executionContext = createExecutionContext(getImagesRequest);
AWSRequestMetrics awsRequestMetrics = executionContext.getAwsRequestMetrics();
awsRequestMetrics.startEvent(Field.ClientExecuteTime);
Request<GetImagesRequest> request = null;
Response<GetImagesResult> response = null;
try {
awsRequestMetrics.startEvent(Field.RequestMarshallTime);
try {
request = new GetImagesRequestProtocolMarshaller(protocolFactory).marshall(super.beforeMarshalling(getImagesRequest));
// Binds the request metrics to the current request.
request.setAWSRequestMetrics(awsRequestMetrics);
request.addHandlerContext(HandlerContextKey.CLIENT_ENDPOINT, endpoint);
request.addHandlerContext(HandlerContextKey.ENDPOINT_OVERRIDDEN, isEndpointOverridden());
request.addHandlerContext(HandlerContextKey.SIGNING_REGION, getSigningRegion());
request.addHandlerContext(HandlerContextKey.SERVICE_ID, "Kinesis Video Archived Media");
request.addHandlerContext(HandlerContextKey.OPERATION_NAME, "GetImages");
request.addHandlerContext(HandlerContextKey.ADVANCED_CONFIG, advancedConfig);
} finally {
awsRequestMetrics.endEvent(Field.RequestMarshallTime);
}
HttpResponseHandler<AmazonWebServiceResponse<GetImagesResult>> responseHandler = protocolFactory.createResponseHandler(new JsonOperationMetadata()
.withPayloadJson(true).withHasStreamingSuccessResponse(false), new GetImagesResultJsonUnmarshaller());
response = invoke(request, responseHandler, executionContext);
return response.getAwsResponse();
} finally {
endClientExecution(awsRequestMetrics, request, response);
}
}
/**
* <p>
* Gets media for a list of fragments (specified by fragment number) from the archived data in an Amazon Kinesis
* video stream.
* </p>
* <note>
* <p>
* You must first call the <code>GetDataEndpoint</code> API to get an endpoint. Then send the
* <code>GetMediaForFragmentList</code> requests to this endpoint using the <a
* href="https://docs.aws.amazon.com/cli/latest/reference/">--endpoint-url parameter</a>.
* </p>
* </note>
* <p>
* For limits, see <a href="http://docs.aws.amazon.com/kinesisvideostreams/latest/dg/limits.html">Kinesis Video
* Streams Limits</a>.
* </p>
* <important>
* <p>
* If an error is thrown after invoking a Kinesis Video Streams archived media API, in addition to the HTTP status
* code and the response body, it includes the following pieces of information:
* </p>
* <ul>
* <li>
* <p>
* <code>x-amz-ErrorType</code> HTTP header – contains a more specific error type in addition to what the HTTP
* status code provides.
* </p>
* </li>
* <li>
* <p>
* <code>x-amz-RequestId</code> HTTP header – if you want to report an issue to Amazon Web Services, the support
* team can better diagnose the problem if given the Request Id.
* </p>
* </li>
* </ul>
* <p>
* Both the HTTP status code and the ErrorType header can be utilized to make programmatic decisions about whether
* errors are retry-able and under what conditions, as well as provide information on what actions the client
* programmer might need to take in order to successfully try again.
* </p>
* <p>
* For more information, see the <b>Errors</b> section at the bottom of this topic, as well as <a
* href="https://docs.aws.amazon.com/kinesisvideostreams/latest/dg/CommonErrors.html">Common Errors</a>.
* </p>
* </important>
*
* @param getMediaForFragmentListRequest
* @return Result of the GetMediaForFragmentList operation returned by the service.
* @throws ResourceNotFoundException
* <code>GetImages</code> will throw this error when Kinesis Video Streams can't find the stream that you
* specified.</p>
* <p>
* <code>GetHLSStreamingSessionURL</code> and <code>GetDASHStreamingSessionURL</code> throw this error if a
* session with a <code>PlaybackMode</code> of <code>ON_DEMAND</code> or <code>LIVE_REPLAY</code>is
* requested for a stream that has no fragments within the requested time range, or if a session with a
* <code>PlaybackMode</code> of <code>LIVE</code> is requested for a stream that has no fragments within the
* last 30 seconds.
* @throws InvalidArgumentException
* A specified parameter exceeds its restrictions, is not supported, or can't be used.
* @throws ClientLimitExceededException
* Kinesis Video Streams has throttled the request because you have exceeded a limit. Try making the call
* later. For information about limits, see <a
* href="http://docs.aws.amazon.com/kinesisvideostreams/latest/dg/limits.html">Kinesis Video Streams
* Limits</a>.
* @throws NotAuthorizedException
* Status Code: 403, The caller is not authorized to perform an operation on the given stream, or the token