forked from aws/aws-sdk-go-v2
-
Notifications
You must be signed in to change notification settings - Fork 0
/
api.go
1992 lines (1638 loc) · 61.7 KB
/
api.go
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
// Code generated by private/model/cli/gen-api/main.go. DO NOT EDIT.
package kinesisvideo
import (
"time"
"github.com/aws/aws-sdk-go-v2/aws"
"github.com/aws/aws-sdk-go-v2/internal/awsutil"
"github.com/aws/aws-sdk-go-v2/private/protocol"
)
const opCreateStream = "CreateStream"
// CreateStreamRequest is a API request type for the CreateStream API operation.
type CreateStreamRequest struct {
*aws.Request
Input *CreateStreamInput
Copy func(*CreateStreamInput) CreateStreamRequest
}
// Send marshals and sends the CreateStream API request.
func (r CreateStreamRequest) Send() (*CreateStreamOutput, error) {
err := r.Request.Send()
if err != nil {
return nil, err
}
return r.Request.Data.(*CreateStreamOutput), nil
}
// CreateStreamRequest returns a request value for making API operation for
// Amazon Kinesis Video Streams.
//
// Creates a new Kinesis video stream.
//
// When you create a new stream, Kinesis Video Streams assigns it a version
// number. When you change the stream's metadata, Kinesis Video Streams updates
// the version.
//
// CreateStream is an asynchronous operation.
//
// For information about how the service works, see How it Works (http://docs.aws.amazon.com/kinesisvideostreams/latest/dg/how-it-works.html).
//
// You must have permissions for the KinesisVideo:CreateStream action.
//
// // Example sending a request using the CreateStreamRequest method.
// req := client.CreateStreamRequest(params)
// resp, err := req.Send()
// if err == nil {
// fmt.Println(resp)
// }
//
// Please also see https://docs.aws.amazon.com/goto/WebAPI/kinesisvideo-2017-09-30/CreateStream
func (c *KinesisVideo) CreateStreamRequest(input *CreateStreamInput) CreateStreamRequest {
op := &aws.Operation{
Name: opCreateStream,
HTTPMethod: "POST",
HTTPPath: "/createStream",
}
if input == nil {
input = &CreateStreamInput{}
}
output := &CreateStreamOutput{}
req := c.newRequest(op, input, output)
output.responseMetadata = aws.Response{Request: req}
return CreateStreamRequest{Request: req, Input: input, Copy: c.CreateStreamRequest}
}
const opDeleteStream = "DeleteStream"
// DeleteStreamRequest is a API request type for the DeleteStream API operation.
type DeleteStreamRequest struct {
*aws.Request
Input *DeleteStreamInput
Copy func(*DeleteStreamInput) DeleteStreamRequest
}
// Send marshals and sends the DeleteStream API request.
func (r DeleteStreamRequest) Send() (*DeleteStreamOutput, error) {
err := r.Request.Send()
if err != nil {
return nil, err
}
return r.Request.Data.(*DeleteStreamOutput), nil
}
// DeleteStreamRequest returns a request value for making API operation for
// Amazon Kinesis Video Streams.
//
// Deletes a Kinesis video stream and the data contained in the stream.
//
// This method marks the stream for deletion, and makes the data in the stream
// inaccessible immediately.
//
// To ensure that you have the latest version of the stream before deleting
// it, you can specify the stream version. Kinesis Video Streams assigns a version
// to each stream. When you update a stream, Kinesis Video Streams assigns a
// new version number. To get the latest stream version, use the DescribeStream
// API.
//
// This operation requires permission for the KinesisVideo:DeleteStream action.
//
// // Example sending a request using the DeleteStreamRequest method.
// req := client.DeleteStreamRequest(params)
// resp, err := req.Send()
// if err == nil {
// fmt.Println(resp)
// }
//
// Please also see https://docs.aws.amazon.com/goto/WebAPI/kinesisvideo-2017-09-30/DeleteStream
func (c *KinesisVideo) DeleteStreamRequest(input *DeleteStreamInput) DeleteStreamRequest {
op := &aws.Operation{
Name: opDeleteStream,
HTTPMethod: "POST",
HTTPPath: "/deleteStream",
}
if input == nil {
input = &DeleteStreamInput{}
}
output := &DeleteStreamOutput{}
req := c.newRequest(op, input, output)
output.responseMetadata = aws.Response{Request: req}
return DeleteStreamRequest{Request: req, Input: input, Copy: c.DeleteStreamRequest}
}
const opDescribeStream = "DescribeStream"
// DescribeStreamRequest is a API request type for the DescribeStream API operation.
type DescribeStreamRequest struct {
*aws.Request
Input *DescribeStreamInput
Copy func(*DescribeStreamInput) DescribeStreamRequest
}
// Send marshals and sends the DescribeStream API request.
func (r DescribeStreamRequest) Send() (*DescribeStreamOutput, error) {
err := r.Request.Send()
if err != nil {
return nil, err
}
return r.Request.Data.(*DescribeStreamOutput), nil
}
// DescribeStreamRequest returns a request value for making API operation for
// Amazon Kinesis Video Streams.
//
// Returns the most current information about the specified stream. You must
// specify either the StreamName or the StreamARN.
//
// // Example sending a request using the DescribeStreamRequest method.
// req := client.DescribeStreamRequest(params)
// resp, err := req.Send()
// if err == nil {
// fmt.Println(resp)
// }
//
// Please also see https://docs.aws.amazon.com/goto/WebAPI/kinesisvideo-2017-09-30/DescribeStream
func (c *KinesisVideo) DescribeStreamRequest(input *DescribeStreamInput) DescribeStreamRequest {
op := &aws.Operation{
Name: opDescribeStream,
HTTPMethod: "POST",
HTTPPath: "/describeStream",
}
if input == nil {
input = &DescribeStreamInput{}
}
output := &DescribeStreamOutput{}
req := c.newRequest(op, input, output)
output.responseMetadata = aws.Response{Request: req}
return DescribeStreamRequest{Request: req, Input: input, Copy: c.DescribeStreamRequest}
}
const opGetDataEndpoint = "GetDataEndpoint"
// GetDataEndpointRequest is a API request type for the GetDataEndpoint API operation.
type GetDataEndpointRequest struct {
*aws.Request
Input *GetDataEndpointInput
Copy func(*GetDataEndpointInput) GetDataEndpointRequest
}
// Send marshals and sends the GetDataEndpoint API request.
func (r GetDataEndpointRequest) Send() (*GetDataEndpointOutput, error) {
err := r.Request.Send()
if err != nil {
return nil, err
}
return r.Request.Data.(*GetDataEndpointOutput), nil
}
// GetDataEndpointRequest returns a request value for making API operation for
// Amazon Kinesis Video Streams.
//
// Gets an endpoint for a specified stream for either reading or writing. Use
// this endpoint in your application to read from the specified stream (using
// the GetMedia or GetMediaForFragmentList operations) or write to it (using
// the PutMedia operation).
//
// The returned endpoint does not have the API name appended. The client needs
// to add the API name to the returned endpoint.
//
// In the request, specify the stream either by StreamName or StreamARN.
//
// // Example sending a request using the GetDataEndpointRequest method.
// req := client.GetDataEndpointRequest(params)
// resp, err := req.Send()
// if err == nil {
// fmt.Println(resp)
// }
//
// Please also see https://docs.aws.amazon.com/goto/WebAPI/kinesisvideo-2017-09-30/GetDataEndpoint
func (c *KinesisVideo) GetDataEndpointRequest(input *GetDataEndpointInput) GetDataEndpointRequest {
op := &aws.Operation{
Name: opGetDataEndpoint,
HTTPMethod: "POST",
HTTPPath: "/getDataEndpoint",
}
if input == nil {
input = &GetDataEndpointInput{}
}
output := &GetDataEndpointOutput{}
req := c.newRequest(op, input, output)
output.responseMetadata = aws.Response{Request: req}
return GetDataEndpointRequest{Request: req, Input: input, Copy: c.GetDataEndpointRequest}
}
const opListStreams = "ListStreams"
// ListStreamsRequest is a API request type for the ListStreams API operation.
type ListStreamsRequest struct {
*aws.Request
Input *ListStreamsInput
Copy func(*ListStreamsInput) ListStreamsRequest
}
// Send marshals and sends the ListStreams API request.
func (r ListStreamsRequest) Send() (*ListStreamsOutput, error) {
err := r.Request.Send()
if err != nil {
return nil, err
}
return r.Request.Data.(*ListStreamsOutput), nil
}
// ListStreamsRequest returns a request value for making API operation for
// Amazon Kinesis Video Streams.
//
// Returns an array of StreamInfo objects. Each object describes a stream. To
// retrieve only streams that satisfy a specific condition, you can specify
// a StreamNameCondition.
//
// // Example sending a request using the ListStreamsRequest method.
// req := client.ListStreamsRequest(params)
// resp, err := req.Send()
// if err == nil {
// fmt.Println(resp)
// }
//
// Please also see https://docs.aws.amazon.com/goto/WebAPI/kinesisvideo-2017-09-30/ListStreams
func (c *KinesisVideo) ListStreamsRequest(input *ListStreamsInput) ListStreamsRequest {
op := &aws.Operation{
Name: opListStreams,
HTTPMethod: "POST",
HTTPPath: "/listStreams",
}
if input == nil {
input = &ListStreamsInput{}
}
output := &ListStreamsOutput{}
req := c.newRequest(op, input, output)
output.responseMetadata = aws.Response{Request: req}
return ListStreamsRequest{Request: req, Input: input, Copy: c.ListStreamsRequest}
}
const opListTagsForStream = "ListTagsForStream"
// ListTagsForStreamRequest is a API request type for the ListTagsForStream API operation.
type ListTagsForStreamRequest struct {
*aws.Request
Input *ListTagsForStreamInput
Copy func(*ListTagsForStreamInput) ListTagsForStreamRequest
}
// Send marshals and sends the ListTagsForStream API request.
func (r ListTagsForStreamRequest) Send() (*ListTagsForStreamOutput, error) {
err := r.Request.Send()
if err != nil {
return nil, err
}
return r.Request.Data.(*ListTagsForStreamOutput), nil
}
// ListTagsForStreamRequest returns a request value for making API operation for
// Amazon Kinesis Video Streams.
//
// Returns a list of tags associated with the specified stream.
//
// In the request, you must specify either the StreamName or the StreamARN.
//
// // Example sending a request using the ListTagsForStreamRequest method.
// req := client.ListTagsForStreamRequest(params)
// resp, err := req.Send()
// if err == nil {
// fmt.Println(resp)
// }
//
// Please also see https://docs.aws.amazon.com/goto/WebAPI/kinesisvideo-2017-09-30/ListTagsForStream
func (c *KinesisVideo) ListTagsForStreamRequest(input *ListTagsForStreamInput) ListTagsForStreamRequest {
op := &aws.Operation{
Name: opListTagsForStream,
HTTPMethod: "POST",
HTTPPath: "/listTagsForStream",
}
if input == nil {
input = &ListTagsForStreamInput{}
}
output := &ListTagsForStreamOutput{}
req := c.newRequest(op, input, output)
output.responseMetadata = aws.Response{Request: req}
return ListTagsForStreamRequest{Request: req, Input: input, Copy: c.ListTagsForStreamRequest}
}
const opTagStream = "TagStream"
// TagStreamRequest is a API request type for the TagStream API operation.
type TagStreamRequest struct {
*aws.Request
Input *TagStreamInput
Copy func(*TagStreamInput) TagStreamRequest
}
// Send marshals and sends the TagStream API request.
func (r TagStreamRequest) Send() (*TagStreamOutput, error) {
err := r.Request.Send()
if err != nil {
return nil, err
}
return r.Request.Data.(*TagStreamOutput), nil
}
// TagStreamRequest returns a request value for making API operation for
// Amazon Kinesis Video Streams.
//
// Adds one or more tags to a stream. A tag is a key-value pair (the value is
// optional) that you can define and assign to AWS resources. If you specify
// a tag that already exists, the tag value is replaced with the value that
// you specify in the request. For more information, see Using Cost Allocation
// Tags (http://docs.aws.amazon.com/awsaccountbilling/latest/aboutv2/cost-alloc-tags.html)
// in the AWS Billing and Cost Management User Guide.
//
// You must provide either the StreamName or the StreamARN.
//
// This operation requires permission for the KinesisVideo:TagStream action.
//
// Kinesis video streams support up to 50 tags.
//
// // Example sending a request using the TagStreamRequest method.
// req := client.TagStreamRequest(params)
// resp, err := req.Send()
// if err == nil {
// fmt.Println(resp)
// }
//
// Please also see https://docs.aws.amazon.com/goto/WebAPI/kinesisvideo-2017-09-30/TagStream
func (c *KinesisVideo) TagStreamRequest(input *TagStreamInput) TagStreamRequest {
op := &aws.Operation{
Name: opTagStream,
HTTPMethod: "POST",
HTTPPath: "/tagStream",
}
if input == nil {
input = &TagStreamInput{}
}
output := &TagStreamOutput{}
req := c.newRequest(op, input, output)
output.responseMetadata = aws.Response{Request: req}
return TagStreamRequest{Request: req, Input: input, Copy: c.TagStreamRequest}
}
const opUntagStream = "UntagStream"
// UntagStreamRequest is a API request type for the UntagStream API operation.
type UntagStreamRequest struct {
*aws.Request
Input *UntagStreamInput
Copy func(*UntagStreamInput) UntagStreamRequest
}
// Send marshals and sends the UntagStream API request.
func (r UntagStreamRequest) Send() (*UntagStreamOutput, error) {
err := r.Request.Send()
if err != nil {
return nil, err
}
return r.Request.Data.(*UntagStreamOutput), nil
}
// UntagStreamRequest returns a request value for making API operation for
// Amazon Kinesis Video Streams.
//
// Removes one or more tags from a stream. In the request, specify only a tag
// key or keys; don't specify the value. If you specify a tag key that does
// not exist, it's ignored.
//
// In the request, you must provide the StreamName or StreamARN.
//
// // Example sending a request using the UntagStreamRequest method.
// req := client.UntagStreamRequest(params)
// resp, err := req.Send()
// if err == nil {
// fmt.Println(resp)
// }
//
// Please also see https://docs.aws.amazon.com/goto/WebAPI/kinesisvideo-2017-09-30/UntagStream
func (c *KinesisVideo) UntagStreamRequest(input *UntagStreamInput) UntagStreamRequest {
op := &aws.Operation{
Name: opUntagStream,
HTTPMethod: "POST",
HTTPPath: "/untagStream",
}
if input == nil {
input = &UntagStreamInput{}
}
output := &UntagStreamOutput{}
req := c.newRequest(op, input, output)
output.responseMetadata = aws.Response{Request: req}
return UntagStreamRequest{Request: req, Input: input, Copy: c.UntagStreamRequest}
}
const opUpdateDataRetention = "UpdateDataRetention"
// UpdateDataRetentionRequest is a API request type for the UpdateDataRetention API operation.
type UpdateDataRetentionRequest struct {
*aws.Request
Input *UpdateDataRetentionInput
Copy func(*UpdateDataRetentionInput) UpdateDataRetentionRequest
}
// Send marshals and sends the UpdateDataRetention API request.
func (r UpdateDataRetentionRequest) Send() (*UpdateDataRetentionOutput, error) {
err := r.Request.Send()
if err != nil {
return nil, err
}
return r.Request.Data.(*UpdateDataRetentionOutput), nil
}
// UpdateDataRetentionRequest returns a request value for making API operation for
// Amazon Kinesis Video Streams.
//
// Increases or decreases the stream's data retention period by the value that
// you specify. To indicate whether you want to increase or decrease the data
// retention period, specify the Operation parameter in the request body. In
// the request, you must specify either the StreamName or the StreamARN.
//
// The retention period that you specify replaces the current value.
//
// This operation requires permission for the KinesisVideo:UpdateDataRetention
// action.
//
// Changing the data retention period affects the data in the stream as follows:
//
// * If the data retention period is increased, existing data is retained
// for the new retention period. For example, if the data retention period
// is increased from one hour to seven hours, all existing data is retained
// for seven hours.
//
// * If the data retention period is decreased, existing data is retained
// for the new retention period. For example, if the data retention period
// is decreased from seven hours to one hour, all existing data is retained
// for one hour, and any data older than one hour is deleted immediately.
//
// // Example sending a request using the UpdateDataRetentionRequest method.
// req := client.UpdateDataRetentionRequest(params)
// resp, err := req.Send()
// if err == nil {
// fmt.Println(resp)
// }
//
// Please also see https://docs.aws.amazon.com/goto/WebAPI/kinesisvideo-2017-09-30/UpdateDataRetention
func (c *KinesisVideo) UpdateDataRetentionRequest(input *UpdateDataRetentionInput) UpdateDataRetentionRequest {
op := &aws.Operation{
Name: opUpdateDataRetention,
HTTPMethod: "POST",
HTTPPath: "/updateDataRetention",
}
if input == nil {
input = &UpdateDataRetentionInput{}
}
output := &UpdateDataRetentionOutput{}
req := c.newRequest(op, input, output)
output.responseMetadata = aws.Response{Request: req}
return UpdateDataRetentionRequest{Request: req, Input: input, Copy: c.UpdateDataRetentionRequest}
}
const opUpdateStream = "UpdateStream"
// UpdateStreamRequest is a API request type for the UpdateStream API operation.
type UpdateStreamRequest struct {
*aws.Request
Input *UpdateStreamInput
Copy func(*UpdateStreamInput) UpdateStreamRequest
}
// Send marshals and sends the UpdateStream API request.
func (r UpdateStreamRequest) Send() (*UpdateStreamOutput, error) {
err := r.Request.Send()
if err != nil {
return nil, err
}
return r.Request.Data.(*UpdateStreamOutput), nil
}
// UpdateStreamRequest returns a request value for making API operation for
// Amazon Kinesis Video Streams.
//
// Updates stream metadata, such as the device name and media type.
//
// You must provide the stream name or the Amazon Resource Name (ARN) of the
// stream.
//
// To make sure that you have the latest version of the stream before updating
// it, you can specify the stream version. Kinesis Video Streams assigns a version
// to each stream. When you update a stream, Kinesis Video Streams assigns a
// new version number. To get the latest stream version, use the DescribeStream
// API.
//
// UpdateStream is an asynchronous operation, and takes time to complete.
//
// // Example sending a request using the UpdateStreamRequest method.
// req := client.UpdateStreamRequest(params)
// resp, err := req.Send()
// if err == nil {
// fmt.Println(resp)
// }
//
// Please also see https://docs.aws.amazon.com/goto/WebAPI/kinesisvideo-2017-09-30/UpdateStream
func (c *KinesisVideo) UpdateStreamRequest(input *UpdateStreamInput) UpdateStreamRequest {
op := &aws.Operation{
Name: opUpdateStream,
HTTPMethod: "POST",
HTTPPath: "/updateStream",
}
if input == nil {
input = &UpdateStreamInput{}
}
output := &UpdateStreamOutput{}
req := c.newRequest(op, input, output)
output.responseMetadata = aws.Response{Request: req}
return UpdateStreamRequest{Request: req, Input: input, Copy: c.UpdateStreamRequest}
}
// Please also see https://docs.aws.amazon.com/goto/WebAPI/kinesisvideo-2017-09-30/CreateStreamInput
type CreateStreamInput struct {
_ struct{} `type:"structure"`
// The number of hours that you want to retain the data in the stream. Kinesis
// Video Streams retains the data in a data store that is associated with the
// stream.
//
// The default value is 0, indicating that the stream does not persist data.
DataRetentionInHours *int64 `type:"integer"`
// The name of the device that is writing to the stream.
//
// In the current implementation, Kinesis Video Streams does not use this name.
DeviceName *string `min:"1" type:"string"`
// The ID of the AWS Key Management Service (AWS KMS) key that you want Kinesis
// Video Streams to use to encrypt stream data.
//
// If no key ID is specified, the default, Kinesis Video-managed key (aws/kinesisvideo)
// is used.
//
// For more information, see DescribeKey (http://docs.aws.amazon.com/kms/latest/APIReference/API_DescribeKey.html#API_DescribeKey_RequestParameters).
KmsKeyId *string `min:"1" type:"string"`
// The media type of the stream. Consumers of the stream can use this information
// when processing the stream. For more information about media types, see Media
// Types (http://www.iana.org/assignments/media-types/media-types.xhtml). If
// you choose to specify the MediaType, see Naming Requirements (https://tools.ietf.org/html/rfc6838#section-4.2)
// for guidelines.
//
// To play video on the console, the media must be H.264 encoded, and you need
// to specify this video type in this parameter as video/h264.
//
// This parameter is optional; the default value is null (or empty in JSON).
MediaType *string `min:"1" type:"string"`
// A name for the stream that you are creating.
//
// The stream name is an identifier for the stream, and must be unique for each
// account and region.
//
// StreamName is a required field
StreamName *string `min:"1" type:"string" required:"true"`
}
// String returns the string representation
func (s CreateStreamInput) String() string {
return awsutil.Prettify(s)
}
// GoString returns the string representation
func (s CreateStreamInput) GoString() string {
return s.String()
}
// Validate inspects the fields of the type to determine if they are valid.
func (s *CreateStreamInput) Validate() error {
invalidParams := aws.ErrInvalidParams{Context: "CreateStreamInput"}
if s.DeviceName != nil && len(*s.DeviceName) < 1 {
invalidParams.Add(aws.NewErrParamMinLen("DeviceName", 1))
}
if s.KmsKeyId != nil && len(*s.KmsKeyId) < 1 {
invalidParams.Add(aws.NewErrParamMinLen("KmsKeyId", 1))
}
if s.MediaType != nil && len(*s.MediaType) < 1 {
invalidParams.Add(aws.NewErrParamMinLen("MediaType", 1))
}
if s.StreamName == nil {
invalidParams.Add(aws.NewErrParamRequired("StreamName"))
}
if s.StreamName != nil && len(*s.StreamName) < 1 {
invalidParams.Add(aws.NewErrParamMinLen("StreamName", 1))
}
if invalidParams.Len() > 0 {
return invalidParams
}
return nil
}
// MarshalFields encodes the AWS API shape using the passed in protocol encoder.
func (s CreateStreamInput) MarshalFields(e protocol.FieldEncoder) error {
if s.DataRetentionInHours != nil {
v := *s.DataRetentionInHours
metadata := protocol.Metadata{}
e.SetValue(protocol.BodyTarget, "DataRetentionInHours", protocol.Int64Value(v), metadata)
}
if s.DeviceName != nil {
v := *s.DeviceName
metadata := protocol.Metadata{}
e.SetValue(protocol.BodyTarget, "DeviceName", protocol.QuotedValue{ValueMarshaler: protocol.StringValue(v)}, metadata)
}
if s.KmsKeyId != nil {
v := *s.KmsKeyId
metadata := protocol.Metadata{}
e.SetValue(protocol.BodyTarget, "KmsKeyId", protocol.QuotedValue{ValueMarshaler: protocol.StringValue(v)}, metadata)
}
if s.MediaType != nil {
v := *s.MediaType
metadata := protocol.Metadata{}
e.SetValue(protocol.BodyTarget, "MediaType", protocol.QuotedValue{ValueMarshaler: protocol.StringValue(v)}, metadata)
}
if s.StreamName != nil {
v := *s.StreamName
metadata := protocol.Metadata{}
e.SetValue(protocol.BodyTarget, "StreamName", protocol.QuotedValue{ValueMarshaler: protocol.StringValue(v)}, metadata)
}
return nil
}
// Please also see https://docs.aws.amazon.com/goto/WebAPI/kinesisvideo-2017-09-30/CreateStreamOutput
type CreateStreamOutput struct {
_ struct{} `type:"structure"`
responseMetadata aws.Response
// The Amazon Resource Name (ARN) of the stream.
StreamARN *string `min:"1" type:"string"`
}
// String returns the string representation
func (s CreateStreamOutput) String() string {
return awsutil.Prettify(s)
}
// GoString returns the string representation
func (s CreateStreamOutput) GoString() string {
return s.String()
}
// SDKResponseMetdata return sthe response metadata for the API.
func (s CreateStreamOutput) SDKResponseMetadata() aws.Response {
return s.responseMetadata
}
// MarshalFields encodes the AWS API shape using the passed in protocol encoder.
func (s CreateStreamOutput) MarshalFields(e protocol.FieldEncoder) error {
if s.StreamARN != nil {
v := *s.StreamARN
metadata := protocol.Metadata{}
e.SetValue(protocol.BodyTarget, "StreamARN", protocol.QuotedValue{ValueMarshaler: protocol.StringValue(v)}, metadata)
}
return nil
}
// Please also see https://docs.aws.amazon.com/goto/WebAPI/kinesisvideo-2017-09-30/DeleteStreamInput
type DeleteStreamInput struct {
_ struct{} `type:"structure"`
// Optional: The version of the stream that you want to delete.
//
// Specify the version as a safeguard to ensure that your are deleting the correct
// stream. To get the stream version, use the DescribeStream API.
//
// If not specified, only the CreationTime is checked before deleting the stream.
CurrentVersion *string `min:"1" type:"string"`
// The Amazon Resource Name (ARN) of the stream that you want to delete.
//
// StreamARN is a required field
StreamARN *string `min:"1" type:"string" required:"true"`
}
// String returns the string representation
func (s DeleteStreamInput) String() string {
return awsutil.Prettify(s)
}
// GoString returns the string representation
func (s DeleteStreamInput) GoString() string {
return s.String()
}
// Validate inspects the fields of the type to determine if they are valid.
func (s *DeleteStreamInput) Validate() error {
invalidParams := aws.ErrInvalidParams{Context: "DeleteStreamInput"}
if s.CurrentVersion != nil && len(*s.CurrentVersion) < 1 {
invalidParams.Add(aws.NewErrParamMinLen("CurrentVersion", 1))
}
if s.StreamARN == nil {
invalidParams.Add(aws.NewErrParamRequired("StreamARN"))
}
if s.StreamARN != nil && len(*s.StreamARN) < 1 {
invalidParams.Add(aws.NewErrParamMinLen("StreamARN", 1))
}
if invalidParams.Len() > 0 {
return invalidParams
}
return nil
}
// MarshalFields encodes the AWS API shape using the passed in protocol encoder.
func (s DeleteStreamInput) MarshalFields(e protocol.FieldEncoder) error {
if s.CurrentVersion != nil {
v := *s.CurrentVersion
metadata := protocol.Metadata{}
e.SetValue(protocol.BodyTarget, "CurrentVersion", protocol.QuotedValue{ValueMarshaler: protocol.StringValue(v)}, metadata)
}
if s.StreamARN != nil {
v := *s.StreamARN
metadata := protocol.Metadata{}
e.SetValue(protocol.BodyTarget, "StreamARN", protocol.QuotedValue{ValueMarshaler: protocol.StringValue(v)}, metadata)
}
return nil
}
// Please also see https://docs.aws.amazon.com/goto/WebAPI/kinesisvideo-2017-09-30/DeleteStreamOutput
type DeleteStreamOutput struct {
_ struct{} `type:"structure"`
responseMetadata aws.Response
}
// String returns the string representation
func (s DeleteStreamOutput) String() string {
return awsutil.Prettify(s)
}
// GoString returns the string representation
func (s DeleteStreamOutput) GoString() string {
return s.String()
}
// SDKResponseMetdata return sthe response metadata for the API.
func (s DeleteStreamOutput) SDKResponseMetadata() aws.Response {
return s.responseMetadata
}
// MarshalFields encodes the AWS API shape using the passed in protocol encoder.
func (s DeleteStreamOutput) MarshalFields(e protocol.FieldEncoder) error {
return nil
}
// Please also see https://docs.aws.amazon.com/goto/WebAPI/kinesisvideo-2017-09-30/DescribeStreamInput
type DescribeStreamInput struct {
_ struct{} `type:"structure"`
// The Amazon Resource Name (ARN) of the stream.
StreamARN *string `min:"1" type:"string"`
// The name of the stream.
StreamName *string `min:"1" type:"string"`
}
// String returns the string representation
func (s DescribeStreamInput) String() string {
return awsutil.Prettify(s)
}
// GoString returns the string representation
func (s DescribeStreamInput) GoString() string {
return s.String()
}
// Validate inspects the fields of the type to determine if they are valid.
func (s *DescribeStreamInput) Validate() error {
invalidParams := aws.ErrInvalidParams{Context: "DescribeStreamInput"}
if s.StreamARN != nil && len(*s.StreamARN) < 1 {
invalidParams.Add(aws.NewErrParamMinLen("StreamARN", 1))
}
if s.StreamName != nil && len(*s.StreamName) < 1 {
invalidParams.Add(aws.NewErrParamMinLen("StreamName", 1))
}
if invalidParams.Len() > 0 {
return invalidParams
}
return nil
}
// MarshalFields encodes the AWS API shape using the passed in protocol encoder.
func (s DescribeStreamInput) MarshalFields(e protocol.FieldEncoder) error {
if s.StreamARN != nil {
v := *s.StreamARN
metadata := protocol.Metadata{}
e.SetValue(protocol.BodyTarget, "StreamARN", protocol.QuotedValue{ValueMarshaler: protocol.StringValue(v)}, metadata)
}
if s.StreamName != nil {
v := *s.StreamName
metadata := protocol.Metadata{}
e.SetValue(protocol.BodyTarget, "StreamName", protocol.QuotedValue{ValueMarshaler: protocol.StringValue(v)}, metadata)
}
return nil
}
// Please also see https://docs.aws.amazon.com/goto/WebAPI/kinesisvideo-2017-09-30/DescribeStreamOutput
type DescribeStreamOutput struct {
_ struct{} `type:"structure"`
responseMetadata aws.Response
// An object that describes the stream.
StreamInfo *StreamInfo `type:"structure"`
}
// String returns the string representation
func (s DescribeStreamOutput) String() string {
return awsutil.Prettify(s)
}
// GoString returns the string representation
func (s DescribeStreamOutput) GoString() string {
return s.String()
}
// SDKResponseMetdata return sthe response metadata for the API.
func (s DescribeStreamOutput) SDKResponseMetadata() aws.Response {
return s.responseMetadata
}
// MarshalFields encodes the AWS API shape using the passed in protocol encoder.
func (s DescribeStreamOutput) MarshalFields(e protocol.FieldEncoder) error {
if s.StreamInfo != nil {
v := s.StreamInfo
metadata := protocol.Metadata{}
e.SetFields(protocol.BodyTarget, "StreamInfo", v, metadata)
}
return nil
}
// Please also see https://docs.aws.amazon.com/goto/WebAPI/kinesisvideo-2017-09-30/GetDataEndpointInput
type GetDataEndpointInput struct {
_ struct{} `type:"structure"`
// The name of the API action for which to get an endpoint.
//
// APIName is a required field
APIName APIName `type:"string" required:"true" enum:"true"`
// The Amazon Resource Name (ARN) of the stream that you want to get the endpoint
// for. You must specify either this parameter or a StreamName in the request.
StreamARN *string `min:"1" type:"string"`
// The name of the stream that you want to get the endpoint for. You must specify
// either this parameter or a StreamARN in the request.
StreamName *string `min:"1" type:"string"`
}
// String returns the string representation
func (s GetDataEndpointInput) String() string {
return awsutil.Prettify(s)
}
// GoString returns the string representation
func (s GetDataEndpointInput) GoString() string {
return s.String()
}
// Validate inspects the fields of the type to determine if they are valid.
func (s *GetDataEndpointInput) Validate() error {
invalidParams := aws.ErrInvalidParams{Context: "GetDataEndpointInput"}
if len(s.APIName) == 0 {
invalidParams.Add(aws.NewErrParamRequired("APIName"))
}
if s.StreamARN != nil && len(*s.StreamARN) < 1 {
invalidParams.Add(aws.NewErrParamMinLen("StreamARN", 1))
}
if s.StreamName != nil && len(*s.StreamName) < 1 {
invalidParams.Add(aws.NewErrParamMinLen("StreamName", 1))
}
if invalidParams.Len() > 0 {
return invalidParams
}
return nil
}
// MarshalFields encodes the AWS API shape using the passed in protocol encoder.
func (s GetDataEndpointInput) MarshalFields(e protocol.FieldEncoder) error {
if len(s.APIName) > 0 {
v := s.APIName
metadata := protocol.Metadata{}
e.SetValue(protocol.BodyTarget, "APIName", protocol.QuotedValue{ValueMarshaler: v}, metadata)
}
if s.StreamARN != nil {
v := *s.StreamARN
metadata := protocol.Metadata{}
e.SetValue(protocol.BodyTarget, "StreamARN", protocol.QuotedValue{ValueMarshaler: protocol.StringValue(v)}, metadata)
}
if s.StreamName != nil {
v := *s.StreamName
metadata := protocol.Metadata{}
e.SetValue(protocol.BodyTarget, "StreamName", protocol.QuotedValue{ValueMarshaler: protocol.StringValue(v)}, metadata)
}
return nil
}