forked from aws/aws-sdk-go
-
Notifications
You must be signed in to change notification settings - Fork 0
/
api.go
663 lines (537 loc) · 20.6 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
// THIS FILE IS AUTOMATICALLY GENERATED. DO NOT EDIT.
// Package dynamodbstreams provides a client for Amazon DynamoDB Streams.
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/service/dynamodb"
)
const opDescribeStream = "DescribeStream"
// DescribeStreamRequest generates a request for the DescribeStream operation.
func (c *DynamoDBStreams) DescribeStreamRequest(input *DescribeStreamInput) (req *aws.Request, output *DescribeStreamOutput) {
op := &aws.Operation{
Name: opDescribeStream,
HTTPMethod: "POST",
HTTPPath: "/",
}
if input == nil {
input = &DescribeStreamInput{}
}
req = c.newRequest(op, input, output)
output = &DescribeStreamOutput{}
req.Data = output
return
}
// 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, the that shared
// is closed and can no longer receive more data.
func (c *DynamoDBStreams) DescribeStream(input *DescribeStreamInput) (*DescribeStreamOutput, error) {
req, out := c.DescribeStreamRequest(input)
err := req.Send()
return out, err
}
const opGetRecords = "GetRecords"
// GetRecordsRequest generates a request for the GetRecords operation.
func (c *DynamoDBStreams) GetRecordsRequest(input *GetRecordsInput) (req *aws.Request, output *GetRecordsOutput) {
op := &aws.Operation{
Name: opGetRecords,
HTTPMethod: "POST",
HTTPPath: "/",
}
if input == nil {
input = &GetRecordsInput{}
}
req = c.newRequest(op, input, output)
output = &GetRecordsOutput{}
req.Data = output
return
}
// 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 2000 stream records,
// whichever comes first.
func (c *DynamoDBStreams) GetRecords(input *GetRecordsInput) (*GetRecordsOutput, error) {
req, out := c.GetRecordsRequest(input)
err := req.Send()
return out, err
}
const opGetShardIterator = "GetShardIterator"
// GetShardIteratorRequest generates a request for the GetShardIterator operation.
func (c *DynamoDBStreams) GetShardIteratorRequest(input *GetShardIteratorInput) (req *aws.Request, output *GetShardIteratorOutput) {
op := &aws.Operation{
Name: opGetShardIterator,
HTTPMethod: "POST",
HTTPPath: "/",
}
if input == nil {
input = &GetShardIteratorInput{}
}
req = c.newRequest(op, input, output)
output = &GetShardIteratorOutput{}
req.Data = output
return
}
// 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.
func (c *DynamoDBStreams) GetShardIterator(input *GetShardIteratorInput) (*GetShardIteratorOutput, error) {
req, out := c.GetShardIteratorRequest(input)
err := req.Send()
return out, err
}
const opListStreams = "ListStreams"
// ListStreamsRequest generates a request for the ListStreams operation.
func (c *DynamoDBStreams) ListStreamsRequest(input *ListStreamsInput) (req *aws.Request, output *ListStreamsOutput) {
op := &aws.Operation{
Name: opListStreams,
HTTPMethod: "POST",
HTTPPath: "/",
}
if input == nil {
input = &ListStreamsInput{}
}
req = c.newRequest(op, input, output)
output = &ListStreamsOutput{}
req.Data = output
return
}
// 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.
func (c *DynamoDBStreams) ListStreams(input *ListStreamsInput) (*ListStreamsOutput, error) {
req, out := c.ListStreamsRequest(input)
err := req.Send()
return out, err
}
// Represents the input of a DescribeStream operation.
type DescribeStreamInput struct {
// 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 `locationName:"ExclusiveStartShardId" type:"string"`
// The maximum number of shard objects to return. The upper limit is 100.
Limit *int64 `type:"integer"`
// The Amazon Resource Name (ARN) for the stream.
StreamARN *string `locationName:"StreamArn" type:"string" required:"true"`
metadataDescribeStreamInput `json:"-" xml:"-"`
}
type metadataDescribeStreamInput struct {
SDKShapeTraits bool `type:"structure"`
}
// String returns the string representation
func (s DescribeStreamInput) String() string {
return awsutil.StringValue(s)
}
// GoString returns the string representation
func (s DescribeStreamInput) GoString() string {
return s.String()
}
// Represents the output of a DescribeStream operation.
type DescribeStreamOutput struct {
// 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"`
metadataDescribeStreamOutput `json:"-" xml:"-"`
}
type metadataDescribeStreamOutput struct {
SDKShapeTraits bool `type:"structure"`
}
// String returns the string representation
func (s DescribeStreamOutput) String() string {
return awsutil.StringValue(s)
}
// GoString returns the string representation
func (s DescribeStreamOutput) GoString() string {
return s.String()
}
// Represents the input of a GetRecords operation.
type GetRecordsInput struct {
// The maximum number of records to return from the shard. The upper limit is
// 1000.
Limit *int64 `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 *string `type:"string" required:"true"`
metadataGetRecordsInput `json:"-" xml:"-"`
}
type metadataGetRecordsInput struct {
SDKShapeTraits bool `type:"structure"`
}
// String returns the string representation
func (s GetRecordsInput) String() string {
return awsutil.StringValue(s)
}
// GoString returns the string representation
func (s GetRecordsInput) GoString() string {
return s.String()
}
// Represents the output of a GetRecords operation.
type GetRecordsOutput struct {
// 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 `type:"string"`
// The stream records from the shard, which were retrieved using the shard iterator.
Records []*Record `type:"list"`
metadataGetRecordsOutput `json:"-" xml:"-"`
}
type metadataGetRecordsOutput struct {
SDKShapeTraits bool `type:"structure"`
}
// String returns the string representation
func (s GetRecordsOutput) String() string {
return awsutil.StringValue(s)
}
// GoString returns the string representation
func (s GetRecordsOutput) GoString() string {
return s.String()
}
// Represents the input of a GetShardIterator operation.
type GetShardIteratorInput struct {
// The sequence number of a stream record in the shard from which to start reading.
SequenceNumber *string `type:"string"`
// The identifier of the shard. The iterator will be returned for this shard
// ID.
ShardID *string `locationName:"ShardId" 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 *string `type:"string" required:"true"`
// The Amazon Resource Name (ARN) for the stream.
StreamARN *string `locationName:"StreamArn" type:"string" required:"true"`
metadataGetShardIteratorInput `json:"-" xml:"-"`
}
type metadataGetShardIteratorInput struct {
SDKShapeTraits bool `type:"structure"`
}
// String returns the string representation
func (s GetShardIteratorInput) String() string {
return awsutil.StringValue(s)
}
// GoString returns the string representation
func (s GetShardIteratorInput) GoString() string {
return s.String()
}
// Represents the output of a GetShardIterator operation.
type GetShardIteratorOutput struct {
// 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 `type:"string"`
metadataGetShardIteratorOutput `json:"-" xml:"-"`
}
type metadataGetShardIteratorOutput struct {
SDKShapeTraits bool `type:"structure"`
}
// String returns the string representation
func (s GetShardIteratorOutput) String() string {
return awsutil.StringValue(s)
}
// GoString returns the string representation
func (s GetShardIteratorOutput) GoString() string {
return s.String()
}
// Represents the input of a ListStreams operation.
type ListStreamsInput struct {
// 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 `locationName:"ExclusiveStartStreamArn" type:"string"`
// The maximum number of streams to return. The upper limit is 100.
Limit *int64 `type:"integer"`
// If this parameter is provided, then only the streams associated with this
// table name are returned.
TableName *string `type:"string"`
metadataListStreamsInput `json:"-" xml:"-"`
}
type metadataListStreamsInput struct {
SDKShapeTraits bool `type:"structure"`
}
// String returns the string representation
func (s ListStreamsInput) String() string {
return awsutil.StringValue(s)
}
// GoString returns the string representation
func (s ListStreamsInput) GoString() string {
return s.String()
}
// Represents the output of a ListStreams operation.
type ListStreamsOutput struct {
// 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 `locationName:"LastEvaluatedStreamArn" type:"string"`
// A list of stream descriptors associated with the current account and endpoint.
Streams []*Stream `type:"list"`
metadataListStreamsOutput `json:"-" xml:"-"`
}
type metadataListStreamsOutput struct {
SDKShapeTraits bool `type:"structure"`
}
// String returns the string representation
func (s ListStreamsOutput) String() string {
return awsutil.StringValue(s)
}
// GoString returns the string representation
func (s ListStreamsOutput) GoString() string {
return s.String()
}
// A description of a unique event within a stream.
type Record struct {
// 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 the item's attributes were updated.
//
// REMOVE - the item was deleted from the table
EventName *string `locationName:"eventName" type:"string"`
// 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. Currently, this is 1.0.
EventVersion *string `locationName:"eventVersion" type:"string"`
metadataRecord `json:"-" xml:"-"`
}
type metadataRecord struct {
SDKShapeTraits bool `type:"structure"`
}
// String returns the string representation
func (s Record) String() string {
return awsutil.StringValue(s)
}
// GoString returns the string representation
func (s Record) GoString() string {
return s.String()
}
// The beginning and ending sequence numbers for the stream records contained
// within a shard.
type SequenceNumberRange struct {
// The last sequence number.
EndingSequenceNumber *string `type:"string"`
// The first sequence number.
StartingSequenceNumber *string `type:"string"`
metadataSequenceNumberRange `json:"-" xml:"-"`
}
type metadataSequenceNumberRange struct {
SDKShapeTraits bool `type:"structure"`
}
// String returns the string representation
func (s SequenceNumberRange) String() string {
return awsutil.StringValue(s)
}
// GoString returns the string representation
func (s SequenceNumberRange) GoString() string {
return s.String()
}
// A uniquely identified group of stream records within a stream.
type Shard struct {
// The shard ID of the current shard's parent.
ParentShardID *string `locationName:"ParentShardId" type:"string"`
// The range of possible sequence numbers for the shard.
SequenceNumberRange *SequenceNumberRange `type:"structure"`
// The system-generated identifier for this shard.
ShardID *string `locationName:"ShardId" type:"string"`
metadataShard `json:"-" xml:"-"`
}
type metadataShard struct {
SDKShapeTraits bool `type:"structure"`
}
// String returns the string representation
func (s Shard) String() string {
return awsutil.StringValue(s)
}
// GoString returns the string representation
func (s Shard) GoString() string {
return s.String()
}
// Represents all of the data describing a particular stream.
type Stream struct {
// The Amazon Resource Name (ARN) for the stream.
StreamARN *string `locationName:"StreamArn" type:"string"`
// A timestamp, in ISO 8601 format, for this stream.
//
// Note that LatestStreamLabel is not a unique identifier for the stream, because
// it is possible that a stream from another table might have the same timestamp.
// However, the combination of the following three elements is guaranteed to
// be unique:
//
// the AWS customer ID.
//
// the table name
//
// the StreamLabel
StreamLabel *string `type:"string"`
// The DynamoDB table with which the stream is associated.
TableName *string `type:"string"`
metadataStream `json:"-" xml:"-"`
}
type metadataStream struct {
SDKShapeTraits bool `type:"structure"`
}
// String returns the string representation
func (s Stream) String() string {
return awsutil.StringValue(s)
}
// GoString returns the string representation
func (s Stream) GoString() string {
return s.String()
}
// Represents all of the data describing a particular stream.
type StreamDescription struct {
// The date and time when the request to create this stream was issued.
CreationRequestDateTime *time.Time `type:"timestamp" timestampFormat:"unix"`
// The key attribute(s) of the stream's DynamoDB table.
KeySchema []*dynamodb.KeySchemaElement `type:"list"`
// The shard ID 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 LastEvaluatedShardId is empty, then the "last page" of results has been
// processed and there is currently no more data to be retrieved.
//
// If LastEvaluatedShardId 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 LastEvaluatedShardId is empty.
LastEvaluatedShardID *string `locationName:"LastEvaluatedShardId" type:"string"`
// The shards that comprise the stream.
Shards []*Shard `type:"list"`
// The Amazon Resource Name (ARN) for the stream.
StreamARN *string `locationName:"StreamArn" type:"string"`
// A timestamp, in ISO 8601 format, for this stream.
//
// Note that LatestStreamLabel is not a unique identifier for the stream, because
// it is possible that a stream from another table might have the same timestamp.
// However, the combination of the following three elements is guaranteed to
// be unique:
//
// the AWS customer ID.
//
// the table name
//
// the StreamLabel
StreamLabel *string `type:"string"`
// Indicates the current status of the stream:
//
// ENABLING - Streams is currently being enabled on the DynamoDB table.
//
// ENABLING - the stream is enabled.
//
// DISABLING - Streams is currently being disabled on the DynamoDB table.
//
// DISABLED - the stream is disabled.
StreamStatus *string `type:"string"`
// Indicates the format of the records within this stream:
//
// KEYS_ONLY - only the key attributes of items that were modified in the
// DynamoDB table.
//
// NEW_IMAGE - entire item from the table, as it appeared after they were modified.
//
// OLD_IMAGE - entire item from the table, as it appeared before they were
// modified.
//
// NEW_AND_OLD_IMAGES - both the new and the old images of the items from the
// table.
StreamViewType *string `type:"string"`
// The DynamoDB table with which the stream is associated.
TableName *string `type:"string"`
metadataStreamDescription `json:"-" xml:"-"`
}
type metadataStreamDescription struct {
SDKShapeTraits bool `type:"structure"`
}
// String returns the string representation
func (s StreamDescription) String() string {
return awsutil.StringValue(s)
}
// GoString returns the string representation
func (s StreamDescription) GoString() string {
return s.String()
}
// A description of a single data modification that was performed on an item
// in a DynamoDB table.
type StreamRecord struct {
// The primary key attribute(s) for the DynamoDB item that was modified.
Keys map[string]*dynamodb.AttributeValue `type:"map"`
// The item in the DynamoDB table as it appeared after it was modified.
NewImage map[string]*dynamodb.AttributeValue `type:"map"`
// The item in the DynamoDB table as it appeared before it was modified.
OldImage map[string]*dynamodb.AttributeValue `type:"map"`
// The sequence number of the stream record.
SequenceNumber *string `type:"string"`
// The size of the stream record, in bytes.
SizeBytes *int64 `type:"long"`
// The type of data from the modified DynamoDB item that was captured in this
// stream record:
//
// KEYS_ONLY - only the key attributes of the modified item.
//
// NEW_IMAGE - the entire item, as it appears after it was modified.
//
// OLD_IMAGE - the entire item, as it appeared before it was modified.
//
// NEW_AND_OLD_IMAGES — both the new and the old item images of the item.
StreamViewType *string `type:"string"`
metadataStreamRecord `json:"-" xml:"-"`
}
type metadataStreamRecord struct {
SDKShapeTraits bool `type:"structure"`
}
// String returns the string representation
func (s StreamRecord) String() string {
return awsutil.StringValue(s)
}
// GoString returns the string representation
func (s StreamRecord) GoString() string {
return s.String()
}