forked from aws/aws-sdk-go
-
Notifications
You must be signed in to change notification settings - Fork 1
/
api.go
1396 lines (1197 loc) · 47 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 dynamodbstreams
import (
"time"
"github.com/aws/aws-sdk-go/aws"
"github.com/aws/aws-sdk-go/aws/awsutil"
"github.com/aws/aws-sdk-go/aws/request"
"github.com/aws/aws-sdk-go/service/dynamodb"
)
const opDescribeStream = "DescribeStream"
// DescribeStreamRequest generates a "aws/request.Request" representing the
// client's request for the DescribeStream operation. The "output" return
// value can be used to capture response data after the request's "Send" method
// is called.
//
// See DescribeStream for usage and error information.
//
// Creating a request object using this method should be used when you want to inject
// custom logic into the request's lifecycle using a custom handler, or if you want to
// access properties on the request object before or after sending the request. If
// you just want the service response, call the DescribeStream method directly
// instead.
//
// Note: You must call the "Send" method on the returned request object in order
// to execute the request.
//
// // Example sending a request using the DescribeStreamRequest method.
// req, resp := client.DescribeStreamRequest(params)
//
// err := req.Send()
// if err == nil { // resp is now filled
// fmt.Println(resp)
// }
//
// Please also see https://docs.aws.amazon.com/goto/WebAPI/streams-dynamodb-2012-08-10/DescribeStream
func (c *DynamoDBStreams) DescribeStreamRequest(input *DescribeStreamInput) (req *request.Request, output *DescribeStreamOutput) {
op := &request.Operation{
Name: opDescribeStream,
HTTPMethod: "POST",
HTTPPath: "/",
}
if input == nil {
input = &DescribeStreamInput{}
}
output = &DescribeStreamOutput{}
req = c.newRequest(op, input, output)
return
}
// DescribeStream API operation for Amazon DynamoDB Streams.
//
// Returns information about a stream, including the current status of the stream,
// its Amazon Resource Name (ARN), the composition of its shards, and its corresponding
// DynamoDB table.
//
// You can call DescribeStream at a maximum rate of 10 times per second.
//
// Each shard in the stream has a SequenceNumberRange associated with it. If
// the SequenceNumberRange has a StartingSequenceNumber but no EndingSequenceNumber,
// then the shard is still open (able to receive more stream records). If both
// StartingSequenceNumber and EndingSequenceNumber are present, then that shard
// is closed and can no longer receive more data.
//
// Returns awserr.Error for service API and SDK errors. Use runtime type assertions
// with awserr.Error's Code and Message methods to get detailed information about
// the error.
//
// See the AWS API reference guide for Amazon DynamoDB Streams's
// API operation DescribeStream for usage and error information.
//
// Returned Error Codes:
// * ErrCodeResourceNotFoundException "ResourceNotFoundException"
// The operation tried to access a nonexistent stream.
//
// * ErrCodeInternalServerError "InternalServerError"
// An error occurred on the server side.
//
// Please also see https://docs.aws.amazon.com/goto/WebAPI/streams-dynamodb-2012-08-10/DescribeStream
func (c *DynamoDBStreams) DescribeStream(input *DescribeStreamInput) (*DescribeStreamOutput, error) {
req, out := c.DescribeStreamRequest(input)
return out, req.Send()
}
// DescribeStreamWithContext is the same as DescribeStream with the addition of
// the ability to pass a context and additional request options.
//
// See DescribeStream for details on how to use this API operation.
//
// The context must be non-nil and will be used for request cancellation. If
// the context is nil a panic will occur. In the future the SDK may create
// sub-contexts for http.Requests. See https://golang.org/pkg/context/
// for more information on using Contexts.
func (c *DynamoDBStreams) DescribeStreamWithContext(ctx aws.Context, input *DescribeStreamInput, opts ...request.Option) (*DescribeStreamOutput, error) {
req, out := c.DescribeStreamRequest(input)
req.SetContext(ctx)
req.ApplyOptions(opts...)
return out, req.Send()
}
const opGetRecords = "GetRecords"
// GetRecordsRequest generates a "aws/request.Request" representing the
// client's request for the GetRecords operation. The "output" return
// value can be used to capture response data after the request's "Send" method
// is called.
//
// See GetRecords for usage and error information.
//
// Creating a request object using this method should be used when you want to inject
// custom logic into the request's lifecycle using a custom handler, or if you want to
// access properties on the request object before or after sending the request. If
// you just want the service response, call the GetRecords method directly
// instead.
//
// Note: You must call the "Send" method on the returned request object in order
// to execute the request.
//
// // Example sending a request using the GetRecordsRequest method.
// req, resp := client.GetRecordsRequest(params)
//
// err := req.Send()
// if err == nil { // resp is now filled
// fmt.Println(resp)
// }
//
// Please also see https://docs.aws.amazon.com/goto/WebAPI/streams-dynamodb-2012-08-10/GetRecords
func (c *DynamoDBStreams) GetRecordsRequest(input *GetRecordsInput) (req *request.Request, output *GetRecordsOutput) {
op := &request.Operation{
Name: opGetRecords,
HTTPMethod: "POST",
HTTPPath: "/",
}
if input == nil {
input = &GetRecordsInput{}
}
output = &GetRecordsOutput{}
req = c.newRequest(op, input, output)
return
}
// GetRecords API operation for Amazon DynamoDB Streams.
//
// Retrieves the stream records from a given shard.
//
// Specify a shard iterator using the ShardIterator parameter. The shard iterator
// specifies the position in the shard from which you want to start reading
// stream records sequentially. If there are no stream records available in
// the portion of the shard that the iterator points to, GetRecords returns
// an empty list. Note that it might take multiple calls to get to a portion
// of the shard that contains stream records.
//
// GetRecords can retrieve a maximum of 1 MB of data or 1000 stream records,
// whichever comes first.
//
// Returns awserr.Error for service API and SDK errors. Use runtime type assertions
// with awserr.Error's Code and Message methods to get detailed information about
// the error.
//
// See the AWS API reference guide for Amazon DynamoDB Streams's
// API operation GetRecords for usage and error information.
//
// Returned Error Codes:
// * ErrCodeResourceNotFoundException "ResourceNotFoundException"
// The operation tried to access a nonexistent stream.
//
// * ErrCodeLimitExceededException "LimitExceededException"
// Your request rate is too high. The AWS SDKs for DynamoDB automatically retry
// requests that receive this exception. Your request is eventually successful,
// unless your retry queue is too large to finish. Reduce the frequency of requests
// and use exponential backoff. For more information, go to Error Retries and
// Exponential Backoff (http://docs.aws.amazon.com/amazondynamodb/latest/developerguide/ErrorHandling.html#APIRetries)
// in the Amazon DynamoDB Developer Guide.
//
// * ErrCodeInternalServerError "InternalServerError"
// An error occurred on the server side.
//
// * ErrCodeExpiredIteratorException "ExpiredIteratorException"
// The shard iterator has expired and can no longer be used to retrieve stream
// records. A shard iterator expires 15 minutes after it is retrieved using
// the GetShardIterator action.
//
// * ErrCodeTrimmedDataAccessException "TrimmedDataAccessException"
// The operation attempted to read past the oldest stream record in a shard.
//
// In DynamoDB Streams, there is a 24 hour limit on data retention. Stream records
// whose age exceeds this limit are subject to removal (trimming) from the stream.
// You might receive a TrimmedDataAccessException if:
//
// * You request a shard iterator with a sequence number older than the trim
// point (24 hours).
//
// * You obtain a shard iterator, but before you use the iterator in a GetRecords
// request, a stream record in the shard exceeds the 24 hour period and is
// trimmed. This causes the iterator to access a record that no longer exists.
//
// Please also see https://docs.aws.amazon.com/goto/WebAPI/streams-dynamodb-2012-08-10/GetRecords
func (c *DynamoDBStreams) GetRecords(input *GetRecordsInput) (*GetRecordsOutput, error) {
req, out := c.GetRecordsRequest(input)
return out, req.Send()
}
// GetRecordsWithContext is the same as GetRecords with the addition of
// the ability to pass a context and additional request options.
//
// See GetRecords for details on how to use this API operation.
//
// The context must be non-nil and will be used for request cancellation. If
// the context is nil a panic will occur. In the future the SDK may create
// sub-contexts for http.Requests. See https://golang.org/pkg/context/
// for more information on using Contexts.
func (c *DynamoDBStreams) GetRecordsWithContext(ctx aws.Context, input *GetRecordsInput, opts ...request.Option) (*GetRecordsOutput, error) {
req, out := c.GetRecordsRequest(input)
req.SetContext(ctx)
req.ApplyOptions(opts...)
return out, req.Send()
}
const opGetShardIterator = "GetShardIterator"
// GetShardIteratorRequest generates a "aws/request.Request" representing the
// client's request for the GetShardIterator operation. The "output" return
// value can be used to capture response data after the request's "Send" method
// is called.
//
// See GetShardIterator for usage and error information.
//
// Creating a request object using this method should be used when you want to inject
// custom logic into the request's lifecycle using a custom handler, or if you want to
// access properties on the request object before or after sending the request. If
// you just want the service response, call the GetShardIterator method directly
// instead.
//
// Note: You must call the "Send" method on the returned request object in order
// to execute the request.
//
// // Example sending a request using the GetShardIteratorRequest method.
// req, resp := client.GetShardIteratorRequest(params)
//
// err := req.Send()
// if err == nil { // resp is now filled
// fmt.Println(resp)
// }
//
// Please also see https://docs.aws.amazon.com/goto/WebAPI/streams-dynamodb-2012-08-10/GetShardIterator
func (c *DynamoDBStreams) GetShardIteratorRequest(input *GetShardIteratorInput) (req *request.Request, output *GetShardIteratorOutput) {
op := &request.Operation{
Name: opGetShardIterator,
HTTPMethod: "POST",
HTTPPath: "/",
}
if input == nil {
input = &GetShardIteratorInput{}
}
output = &GetShardIteratorOutput{}
req = c.newRequest(op, input, output)
return
}
// GetShardIterator API operation for Amazon DynamoDB Streams.
//
// Returns a shard iterator. A shard iterator provides information about how
// to retrieve the stream records from within a shard. Use the shard iterator
// in a subsequent GetRecords request to read the stream records from the shard.
//
// A shard iterator expires 15 minutes after it is returned to the requester.
//
// Returns awserr.Error for service API and SDK errors. Use runtime type assertions
// with awserr.Error's Code and Message methods to get detailed information about
// the error.
//
// See the AWS API reference guide for Amazon DynamoDB Streams's
// API operation GetShardIterator for usage and error information.
//
// Returned Error Codes:
// * ErrCodeResourceNotFoundException "ResourceNotFoundException"
// The operation tried to access a nonexistent stream.
//
// * ErrCodeInternalServerError "InternalServerError"
// An error occurred on the server side.
//
// * ErrCodeTrimmedDataAccessException "TrimmedDataAccessException"
// The operation attempted to read past the oldest stream record in a shard.
//
// In DynamoDB Streams, there is a 24 hour limit on data retention. Stream records
// whose age exceeds this limit are subject to removal (trimming) from the stream.
// You might receive a TrimmedDataAccessException if:
//
// * You request a shard iterator with a sequence number older than the trim
// point (24 hours).
//
// * You obtain a shard iterator, but before you use the iterator in a GetRecords
// request, a stream record in the shard exceeds the 24 hour period and is
// trimmed. This causes the iterator to access a record that no longer exists.
//
// Please also see https://docs.aws.amazon.com/goto/WebAPI/streams-dynamodb-2012-08-10/GetShardIterator
func (c *DynamoDBStreams) GetShardIterator(input *GetShardIteratorInput) (*GetShardIteratorOutput, error) {
req, out := c.GetShardIteratorRequest(input)
return out, req.Send()
}
// GetShardIteratorWithContext is the same as GetShardIterator with the addition of
// the ability to pass a context and additional request options.
//
// See GetShardIterator for details on how to use this API operation.
//
// The context must be non-nil and will be used for request cancellation. If
// the context is nil a panic will occur. In the future the SDK may create
// sub-contexts for http.Requests. See https://golang.org/pkg/context/
// for more information on using Contexts.
func (c *DynamoDBStreams) GetShardIteratorWithContext(ctx aws.Context, input *GetShardIteratorInput, opts ...request.Option) (*GetShardIteratorOutput, error) {
req, out := c.GetShardIteratorRequest(input)
req.SetContext(ctx)
req.ApplyOptions(opts...)
return out, req.Send()
}
const opListStreams = "ListStreams"
// ListStreamsRequest generates a "aws/request.Request" representing the
// client's request for the ListStreams operation. The "output" return
// value can be used to capture response data after the request's "Send" method
// is called.
//
// See ListStreams for usage and error information.
//
// Creating a request object using this method should be used when you want to inject
// custom logic into the request's lifecycle using a custom handler, or if you want to
// access properties on the request object before or after sending the request. If
// you just want the service response, call the ListStreams method directly
// instead.
//
// Note: You must call the "Send" method on the returned request object in order
// to execute the request.
//
// // Example sending a request using the ListStreamsRequest method.
// req, resp := client.ListStreamsRequest(params)
//
// err := req.Send()
// if err == nil { // resp is now filled
// fmt.Println(resp)
// }
//
// Please also see https://docs.aws.amazon.com/goto/WebAPI/streams-dynamodb-2012-08-10/ListStreams
func (c *DynamoDBStreams) ListStreamsRequest(input *ListStreamsInput) (req *request.Request, output *ListStreamsOutput) {
op := &request.Operation{
Name: opListStreams,
HTTPMethod: "POST",
HTTPPath: "/",
}
if input == nil {
input = &ListStreamsInput{}
}
output = &ListStreamsOutput{}
req = c.newRequest(op, input, output)
return
}
// ListStreams API operation for Amazon DynamoDB Streams.
//
// Returns an array of stream ARNs associated with the current account and endpoint.
// If the TableName parameter is present, then ListStreams will return only
// the streams ARNs for that table.
//
// You can call ListStreams at a maximum rate of 5 times per second.
//
// Returns awserr.Error for service API and SDK errors. Use runtime type assertions
// with awserr.Error's Code and Message methods to get detailed information about
// the error.
//
// See the AWS API reference guide for Amazon DynamoDB Streams's
// API operation ListStreams for usage and error information.
//
// Returned Error Codes:
// * ErrCodeResourceNotFoundException "ResourceNotFoundException"
// The operation tried to access a nonexistent stream.
//
// * ErrCodeInternalServerError "InternalServerError"
// An error occurred on the server side.
//
// Please also see https://docs.aws.amazon.com/goto/WebAPI/streams-dynamodb-2012-08-10/ListStreams
func (c *DynamoDBStreams) ListStreams(input *ListStreamsInput) (*ListStreamsOutput, error) {
req, out := c.ListStreamsRequest(input)
return out, req.Send()
}
// ListStreamsWithContext is the same as ListStreams with the addition of
// the ability to pass a context and additional request options.
//
// See ListStreams for details on how to use this API operation.
//
// The context must be non-nil and will be used for request cancellation. If
// the context is nil a panic will occur. In the future the SDK may create
// sub-contexts for http.Requests. See https://golang.org/pkg/context/
// for more information on using Contexts.
func (c *DynamoDBStreams) ListStreamsWithContext(ctx aws.Context, input *ListStreamsInput, opts ...request.Option) (*ListStreamsOutput, error) {
req, out := c.ListStreamsRequest(input)
req.SetContext(ctx)
req.ApplyOptions(opts...)
return out, req.Send()
}
// Represents the input of a DescribeStream operation.
// Please also see https://docs.aws.amazon.com/goto/WebAPI/streams-dynamodb-2012-08-10/DescribeStreamInput
type DescribeStreamInput struct {
_ struct{} `type:"structure"`
// The shard ID of the first item that this operation will evaluate. Use the
// value that was returned for LastEvaluatedShardId in the previous operation.
ExclusiveStartShardId *string `min:"28" type:"string"`
// The maximum number of shard objects to return. The upper limit is 100.
Limit *int64 `min:"1" type:"integer"`
// The Amazon Resource Name (ARN) for the stream.
//
// StreamArn is a required field
StreamArn *string `min:"37" type:"string" required:"true"`
}
// 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 := request.ErrInvalidParams{Context: "DescribeStreamInput"}
if s.ExclusiveStartShardId != nil && len(*s.ExclusiveStartShardId) < 28 {
invalidParams.Add(request.NewErrParamMinLen("ExclusiveStartShardId", 28))
}
if s.Limit != nil && *s.Limit < 1 {
invalidParams.Add(request.NewErrParamMinValue("Limit", 1))
}
if s.StreamArn == nil {
invalidParams.Add(request.NewErrParamRequired("StreamArn"))
}
if s.StreamArn != nil && len(*s.StreamArn) < 37 {
invalidParams.Add(request.NewErrParamMinLen("StreamArn", 37))
}
if invalidParams.Len() > 0 {
return invalidParams
}
return nil
}
// SetExclusiveStartShardId sets the ExclusiveStartShardId field's value.
func (s *DescribeStreamInput) SetExclusiveStartShardId(v string) *DescribeStreamInput {
s.ExclusiveStartShardId = &v
return s
}
// SetLimit sets the Limit field's value.
func (s *DescribeStreamInput) SetLimit(v int64) *DescribeStreamInput {
s.Limit = &v
return s
}
// SetStreamArn sets the StreamArn field's value.
func (s *DescribeStreamInput) SetStreamArn(v string) *DescribeStreamInput {
s.StreamArn = &v
return s
}
// Represents the output of a DescribeStream operation.
// Please also see https://docs.aws.amazon.com/goto/WebAPI/streams-dynamodb-2012-08-10/DescribeStreamOutput
type DescribeStreamOutput struct {
_ struct{} `type:"structure"`
// A complete description of the stream, including its creation date and time,
// the DynamoDB table associated with the stream, the shard IDs within the stream,
// and the beginning and ending sequence numbers of stream records within the
// shards.
StreamDescription *StreamDescription `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()
}
// SetStreamDescription sets the StreamDescription field's value.
func (s *DescribeStreamOutput) SetStreamDescription(v *StreamDescription) *DescribeStreamOutput {
s.StreamDescription = v
return s
}
// Represents the input of a GetRecords operation.
// Please also see https://docs.aws.amazon.com/goto/WebAPI/streams-dynamodb-2012-08-10/GetRecordsInput
type GetRecordsInput struct {
_ struct{} `type:"structure"`
// The maximum number of records to return from the shard. The upper limit is
// 1000.
Limit *int64 `min:"1" type:"integer"`
// A shard iterator that was retrieved from a previous GetShardIterator operation.
// This iterator can be used to access the stream records in this shard.
//
// ShardIterator is a required field
ShardIterator *string `min:"1" type:"string" required:"true"`
}
// String returns the string representation
func (s GetRecordsInput) String() string {
return awsutil.Prettify(s)
}
// GoString returns the string representation
func (s GetRecordsInput) GoString() string {
return s.String()
}
// Validate inspects the fields of the type to determine if they are valid.
func (s *GetRecordsInput) Validate() error {
invalidParams := request.ErrInvalidParams{Context: "GetRecordsInput"}
if s.Limit != nil && *s.Limit < 1 {
invalidParams.Add(request.NewErrParamMinValue("Limit", 1))
}
if s.ShardIterator == nil {
invalidParams.Add(request.NewErrParamRequired("ShardIterator"))
}
if s.ShardIterator != nil && len(*s.ShardIterator) < 1 {
invalidParams.Add(request.NewErrParamMinLen("ShardIterator", 1))
}
if invalidParams.Len() > 0 {
return invalidParams
}
return nil
}
// SetLimit sets the Limit field's value.
func (s *GetRecordsInput) SetLimit(v int64) *GetRecordsInput {
s.Limit = &v
return s
}
// SetShardIterator sets the ShardIterator field's value.
func (s *GetRecordsInput) SetShardIterator(v string) *GetRecordsInput {
s.ShardIterator = &v
return s
}
// Represents the output of a GetRecords operation.
// Please also see https://docs.aws.amazon.com/goto/WebAPI/streams-dynamodb-2012-08-10/GetRecordsOutput
type GetRecordsOutput struct {
_ struct{} `type:"structure"`
// The next position in the shard from which to start sequentially reading stream
// records. If set to null, the shard has been closed and the requested iterator
// will not return any more data.
NextShardIterator *string `min:"1" type:"string"`
// The stream records from the shard, which were retrieved using the shard iterator.
Records []*Record `type:"list"`
}
// String returns the string representation
func (s GetRecordsOutput) String() string {
return awsutil.Prettify(s)
}
// GoString returns the string representation
func (s GetRecordsOutput) GoString() string {
return s.String()
}
// SetNextShardIterator sets the NextShardIterator field's value.
func (s *GetRecordsOutput) SetNextShardIterator(v string) *GetRecordsOutput {
s.NextShardIterator = &v
return s
}
// SetRecords sets the Records field's value.
func (s *GetRecordsOutput) SetRecords(v []*Record) *GetRecordsOutput {
s.Records = v
return s
}
// Represents the input of a GetShardIterator operation.
// Please also see https://docs.aws.amazon.com/goto/WebAPI/streams-dynamodb-2012-08-10/GetShardIteratorInput
type GetShardIteratorInput struct {
_ struct{} `type:"structure"`
// The sequence number of a stream record in the shard from which to start reading.
SequenceNumber *string `min:"21" type:"string"`
// The identifier of the shard. The iterator will be returned for this shard
// ID.
//
// ShardId is a required field
ShardId *string `min:"28" type:"string" required:"true"`
// Determines how the shard iterator is used to start reading stream records
// from the shard:
//
// * AT_SEQUENCE_NUMBER - Start reading exactly from the position denoted
// by a specific sequence number.
//
// * AFTER_SEQUENCE_NUMBER - Start reading right after the position denoted
// by a specific sequence number.
//
// * TRIM_HORIZON - Start reading at the last (untrimmed) stream record,
// which is the oldest record in the shard. In DynamoDB Streams, there is
// a 24 hour limit on data retention. Stream records whose age exceeds this
// limit are subject to removal (trimming) from the stream.
//
// * LATEST - Start reading just after the most recent stream record in the
// shard, so that you always read the most recent data in the shard.
//
// ShardIteratorType is a required field
ShardIteratorType *string `type:"string" required:"true" enum:"ShardIteratorType"`
// The Amazon Resource Name (ARN) for the stream.
//
// StreamArn is a required field
StreamArn *string `min:"37" type:"string" required:"true"`
}
// String returns the string representation
func (s GetShardIteratorInput) String() string {
return awsutil.Prettify(s)
}
// GoString returns the string representation
func (s GetShardIteratorInput) GoString() string {
return s.String()
}
// Validate inspects the fields of the type to determine if they are valid.
func (s *GetShardIteratorInput) Validate() error {
invalidParams := request.ErrInvalidParams{Context: "GetShardIteratorInput"}
if s.SequenceNumber != nil && len(*s.SequenceNumber) < 21 {
invalidParams.Add(request.NewErrParamMinLen("SequenceNumber", 21))
}
if s.ShardId == nil {
invalidParams.Add(request.NewErrParamRequired("ShardId"))
}
if s.ShardId != nil && len(*s.ShardId) < 28 {
invalidParams.Add(request.NewErrParamMinLen("ShardId", 28))
}
if s.ShardIteratorType == nil {
invalidParams.Add(request.NewErrParamRequired("ShardIteratorType"))
}
if s.StreamArn == nil {
invalidParams.Add(request.NewErrParamRequired("StreamArn"))
}
if s.StreamArn != nil && len(*s.StreamArn) < 37 {
invalidParams.Add(request.NewErrParamMinLen("StreamArn", 37))
}
if invalidParams.Len() > 0 {
return invalidParams
}
return nil
}
// SetSequenceNumber sets the SequenceNumber field's value.
func (s *GetShardIteratorInput) SetSequenceNumber(v string) *GetShardIteratorInput {
s.SequenceNumber = &v
return s
}
// SetShardId sets the ShardId field's value.
func (s *GetShardIteratorInput) SetShardId(v string) *GetShardIteratorInput {
s.ShardId = &v
return s
}
// SetShardIteratorType sets the ShardIteratorType field's value.
func (s *GetShardIteratorInput) SetShardIteratorType(v string) *GetShardIteratorInput {
s.ShardIteratorType = &v
return s
}
// SetStreamArn sets the StreamArn field's value.
func (s *GetShardIteratorInput) SetStreamArn(v string) *GetShardIteratorInput {
s.StreamArn = &v
return s
}
// Represents the output of a GetShardIterator operation.
// Please also see https://docs.aws.amazon.com/goto/WebAPI/streams-dynamodb-2012-08-10/GetShardIteratorOutput
type GetShardIteratorOutput struct {
_ struct{} `type:"structure"`
// The position in the shard from which to start reading stream records sequentially.
// A shard iterator specifies this position using the sequence number of a stream
// record in a shard.
ShardIterator *string `min:"1" type:"string"`
}
// String returns the string representation
func (s GetShardIteratorOutput) String() string {
return awsutil.Prettify(s)
}
// GoString returns the string representation
func (s GetShardIteratorOutput) GoString() string {
return s.String()
}
// SetShardIterator sets the ShardIterator field's value.
func (s *GetShardIteratorOutput) SetShardIterator(v string) *GetShardIteratorOutput {
s.ShardIterator = &v
return s
}
// Contains details about the type of identity that made the request.
// Please also see https://docs.aws.amazon.com/goto/WebAPI/streams-dynamodb-2012-08-10/Identity
type Identity struct {
_ struct{} `type:"structure"`
// A unique identifier for the entity that made the call. For Time To Live,
// the principalId is "dynamodb.amazonaws.com".
PrincipalId *string `type:"string"`
// The type of the identity. For Time To Live, the type is "Service".
Type *string `type:"string"`
}
// String returns the string representation
func (s Identity) String() string {
return awsutil.Prettify(s)
}
// GoString returns the string representation
func (s Identity) GoString() string {
return s.String()
}
// SetPrincipalId sets the PrincipalId field's value.
func (s *Identity) SetPrincipalId(v string) *Identity {
s.PrincipalId = &v
return s
}
// SetType sets the Type field's value.
func (s *Identity) SetType(v string) *Identity {
s.Type = &v
return s
}
// Represents the input of a ListStreams operation.
// Please also see https://docs.aws.amazon.com/goto/WebAPI/streams-dynamodb-2012-08-10/ListStreamsInput
type ListStreamsInput struct {
_ struct{} `type:"structure"`
// The ARN (Amazon Resource Name) of the first item that this operation will
// evaluate. Use the value that was returned for LastEvaluatedStreamArn in the
// previous operation.
ExclusiveStartStreamArn *string `min:"37" type:"string"`
// The maximum number of streams to return. The upper limit is 100.
Limit *int64 `min:"1" type:"integer"`
// If this parameter is provided, then only the streams associated with this
// table name are returned.
TableName *string `min:"3" type:"string"`
}
// String returns the string representation
func (s ListStreamsInput) String() string {
return awsutil.Prettify(s)
}
// GoString returns the string representation
func (s ListStreamsInput) GoString() string {
return s.String()
}
// Validate inspects the fields of the type to determine if they are valid.
func (s *ListStreamsInput) Validate() error {
invalidParams := request.ErrInvalidParams{Context: "ListStreamsInput"}
if s.ExclusiveStartStreamArn != nil && len(*s.ExclusiveStartStreamArn) < 37 {
invalidParams.Add(request.NewErrParamMinLen("ExclusiveStartStreamArn", 37))
}
if s.Limit != nil && *s.Limit < 1 {
invalidParams.Add(request.NewErrParamMinValue("Limit", 1))
}
if s.TableName != nil && len(*s.TableName) < 3 {
invalidParams.Add(request.NewErrParamMinLen("TableName", 3))
}
if invalidParams.Len() > 0 {
return invalidParams
}
return nil
}
// SetExclusiveStartStreamArn sets the ExclusiveStartStreamArn field's value.
func (s *ListStreamsInput) SetExclusiveStartStreamArn(v string) *ListStreamsInput {
s.ExclusiveStartStreamArn = &v
return s
}
// SetLimit sets the Limit field's value.
func (s *ListStreamsInput) SetLimit(v int64) *ListStreamsInput {
s.Limit = &v
return s
}
// SetTableName sets the TableName field's value.
func (s *ListStreamsInput) SetTableName(v string) *ListStreamsInput {
s.TableName = &v
return s
}
// Represents the output of a ListStreams operation.
// Please also see https://docs.aws.amazon.com/goto/WebAPI/streams-dynamodb-2012-08-10/ListStreamsOutput
type ListStreamsOutput struct {
_ struct{} `type:"structure"`
// The stream ARN of the item where the operation stopped, inclusive of the
// previous result set. Use this value to start a new operation, excluding this
// value in the new request.
//
// If LastEvaluatedStreamArn is empty, then the "last page" of results has been
// processed and there is no more data to be retrieved.
//
// If LastEvaluatedStreamArn is not empty, it does not necessarily mean that
// there is more data in the result set. The only way to know when you have
// reached the end of the result set is when LastEvaluatedStreamArn is empty.
LastEvaluatedStreamArn *string `min:"37" type:"string"`
// A list of stream descriptors associated with the current account and endpoint.
Streams []*Stream `type:"list"`
}
// String returns the string representation
func (s ListStreamsOutput) String() string {
return awsutil.Prettify(s)
}
// GoString returns the string representation
func (s ListStreamsOutput) GoString() string {
return s.String()
}
// SetLastEvaluatedStreamArn sets the LastEvaluatedStreamArn field's value.
func (s *ListStreamsOutput) SetLastEvaluatedStreamArn(v string) *ListStreamsOutput {
s.LastEvaluatedStreamArn = &v
return s
}
// SetStreams sets the Streams field's value.
func (s *ListStreamsOutput) SetStreams(v []*Stream) *ListStreamsOutput {
s.Streams = v
return s
}
// A description of a unique event within a stream.
// Please also see https://docs.aws.amazon.com/goto/WebAPI/streams-dynamodb-2012-08-10/Record
type Record struct {
_ struct{} `type:"structure"`
// The region in which the GetRecords request was received.
AwsRegion *string `locationName:"awsRegion" type:"string"`
// The main body of the stream record, containing all of the DynamoDB-specific
// fields.
Dynamodb *StreamRecord `locationName:"dynamodb" type:"structure"`
// A globally unique identifier for the event that was recorded in this stream
// record.
EventID *string `locationName:"eventID" type:"string"`
// The type of data modification that was performed on the DynamoDB table:
//
// * INSERT - a new item was added to the table.
//
// * MODIFY - one or more of an existing item's attributes were modified.
//
// * REMOVE - the item was deleted from the table
EventName *string `locationName:"eventName" type:"string" enum:"OperationType"`
// The AWS service from which the stream record originated. For DynamoDB Streams,
// this is aws:dynamodb.
EventSource *string `locationName:"eventSource" type:"string"`
// The version number of the stream record format. This number is updated whenever
// the structure of Record is modified.
//
// Client applications must not assume that eventVersion will remain at a particular
// value, as this number is subject to change at any time. In general, eventVersion
// will only increase as the low-level DynamoDB Streams API evolves.
EventVersion *string `locationName:"eventVersion" type:"string"`
// Items that are deleted by the Time to Live process after expiration have
// the following fields:
//
// * Records[].userIdentity.type
//
// "Service"
//
// * Records[].userIdentity.principalId
//
// "dynamodb.amazonaws.com"
UserIdentity *Identity `locationName:"userIdentity" type:"structure"`
}
// String returns the string representation
func (s Record) String() string {
return awsutil.Prettify(s)
}
// GoString returns the string representation
func (s Record) GoString() string {
return s.String()
}
// SetAwsRegion sets the AwsRegion field's value.
func (s *Record) SetAwsRegion(v string) *Record {
s.AwsRegion = &v
return s
}
// SetDynamodb sets the Dynamodb field's value.
func (s *Record) SetDynamodb(v *StreamRecord) *Record {
s.Dynamodb = v
return s
}
// SetEventID sets the EventID field's value.
func (s *Record) SetEventID(v string) *Record {
s.EventID = &v
return s
}
// SetEventName sets the EventName field's value.
func (s *Record) SetEventName(v string) *Record {
s.EventName = &v
return s
}
// SetEventSource sets the EventSource field's value.
func (s *Record) SetEventSource(v string) *Record {
s.EventSource = &v
return s
}
// SetEventVersion sets the EventVersion field's value.
func (s *Record) SetEventVersion(v string) *Record {
s.EventVersion = &v
return s
}
// SetUserIdentity sets the UserIdentity field's value.
func (s *Record) SetUserIdentity(v *Identity) *Record {
s.UserIdentity = v
return s
}
// The beginning and ending sequence numbers for the stream records contained
// within a shard.
// Please also see https://docs.aws.amazon.com/goto/WebAPI/streams-dynamodb-2012-08-10/SequenceNumberRange
type SequenceNumberRange struct {
_ struct{} `type:"structure"`
// The last sequence number.
EndingSequenceNumber *string `min:"21" type:"string"`
// The first sequence number.
StartingSequenceNumber *string `min:"21" type:"string"`
}
// String returns the string representation
func (s SequenceNumberRange) String() string {
return awsutil.Prettify(s)
}
// GoString returns the string representation
func (s SequenceNumberRange) GoString() string {
return s.String()
}