-
Notifications
You must be signed in to change notification settings - Fork 626
/
api_types.go
533 lines (448 loc) · 18.7 KB
/
api_types.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
// Code generated by private/model/cli/gen-api/main.go. DO NOT EDIT.
package kinesis
import (
"time"
"github.com/aws/aws-sdk-go-v2/aws"
"github.com/aws/aws-sdk-go-v2/internal/awsutil"
)
var _ aws.Config
var _ = awsutil.Prettify
// An object that represents the details of the consumer you registered.
// Please also see https://docs.aws.amazon.com/goto/WebAPI/kinesis-2013-12-02/Consumer
type Consumer struct {
_ struct{} `type:"structure"`
// When you register a consumer, Kinesis Data Streams generates an ARN for it.
// You need this ARN to be able to call SubscribeToShard.
//
// If you delete a consumer and then create a new one with the same name, it
// won't have the same ARN. That's because consumer ARNs contain the creation
// timestamp. This is important to keep in mind if you have IAM policies that
// reference consumer ARNs.
//
// ConsumerARN is a required field
ConsumerARN *string `min:"1" type:"string" required:"true"`
// ConsumerCreationTimestamp is a required field
ConsumerCreationTimestamp *time.Time `type:"timestamp" required:"true"`
// The name of the consumer is something you choose when you register the consumer.
//
// ConsumerName is a required field
ConsumerName *string `min:"1" type:"string" required:"true"`
// A consumer can't read data while in the CREATING or DELETING states.
//
// ConsumerStatus is a required field
ConsumerStatus ConsumerStatus `type:"string" required:"true" enum:"true"`
}
// String returns the string representation
func (s Consumer) String() string {
return awsutil.Prettify(s)
}
// An object that represents the details of a registered consumer.
// Please also see https://docs.aws.amazon.com/goto/WebAPI/kinesis-2013-12-02/ConsumerDescription
type ConsumerDescription struct {
_ struct{} `type:"structure"`
// When you register a consumer, Kinesis Data Streams generates an ARN for it.
// You need this ARN to be able to call SubscribeToShard.
//
// If you delete a consumer and then create a new one with the same name, it
// won't have the same ARN. That's because consumer ARNs contain the creation
// timestamp. This is important to keep in mind if you have IAM policies that
// reference consumer ARNs.
//
// ConsumerARN is a required field
ConsumerARN *string `min:"1" type:"string" required:"true"`
// ConsumerCreationTimestamp is a required field
ConsumerCreationTimestamp *time.Time `type:"timestamp" required:"true"`
// The name of the consumer is something you choose when you register the consumer.
//
// ConsumerName is a required field
ConsumerName *string `min:"1" type:"string" required:"true"`
// A consumer can't read data while in the CREATING or DELETING states.
//
// ConsumerStatus is a required field
ConsumerStatus ConsumerStatus `type:"string" required:"true" enum:"true"`
// The ARN of the stream with which you registered the consumer.
//
// StreamARN is a required field
StreamARN *string `min:"1" type:"string" required:"true"`
}
// String returns the string representation
func (s ConsumerDescription) String() string {
return awsutil.Prettify(s)
}
// Represents enhanced metrics types.
// Please also see https://docs.aws.amazon.com/goto/WebAPI/kinesis-2013-12-02/EnhancedMetrics
type EnhancedMetrics struct {
_ struct{} `type:"structure"`
// List of shard-level metrics.
//
// The following are the valid shard-level metrics. The value "ALL" enhances
// every metric.
//
// * IncomingBytes
//
// * IncomingRecords
//
// * OutgoingBytes
//
// * OutgoingRecords
//
// * WriteProvisionedThroughputExceeded
//
// * ReadProvisionedThroughputExceeded
//
// * IteratorAgeMilliseconds
//
// * ALL
//
// For more information, see Monitoring the Amazon Kinesis Data Streams Service
// with Amazon CloudWatch (http://docs.aws.amazon.com/kinesis/latest/dev/monitoring-with-cloudwatch.html)
// in the Amazon Kinesis Data Streams Developer Guide.
ShardLevelMetrics []MetricsName `min:"1" type:"list"`
}
// String returns the string representation
func (s EnhancedMetrics) String() string {
return awsutil.Prettify(s)
}
// The range of possible hash key values for the shard, which is a set of ordered
// contiguous positive integers.
// Please also see https://docs.aws.amazon.com/goto/WebAPI/kinesis-2013-12-02/HashKeyRange
type HashKeyRange struct {
_ struct{} `type:"structure"`
// The ending hash key of the hash key range.
//
// EndingHashKey is a required field
EndingHashKey *string `type:"string" required:"true"`
// The starting hash key of the hash key range.
//
// StartingHashKey is a required field
StartingHashKey *string `type:"string" required:"true"`
}
// String returns the string representation
func (s HashKeyRange) String() string {
return awsutil.Prettify(s)
}
// Represents the output for PutRecords.
// Please also see https://docs.aws.amazon.com/goto/WebAPI/kinesis-2013-12-02/PutRecordsRequestEntry
type PutRecordsRequestEntry struct {
_ struct{} `type:"structure"`
// The data blob to put into the record, which is base64-encoded when the blob
// is serialized. When the data blob (the payload before base64-encoding) is
// added to the partition key size, the total size must not exceed the maximum
// record size (1 MB).
//
// Data is automatically base64 encoded/decoded by the SDK.
//
// Data is a required field
Data []byte `type:"blob" required:"true"`
// The hash value used to determine explicitly the shard that the data record
// is assigned to by overriding the partition key hash.
ExplicitHashKey *string `type:"string"`
// Determines which shard in the stream the data record is assigned to. Partition
// keys are Unicode strings with a maximum length limit of 256 characters for
// each key. Amazon Kinesis Data Streams uses the partition key as input to
// a hash function that maps the partition key and associated data to a specific
// shard. Specifically, an MD5 hash function is used to map partition keys to
// 128-bit integer values and to map associated data records to shards. As a
// result of this hashing mechanism, all data records with the same partition
// key map to the same shard within the stream.
//
// PartitionKey is a required field
PartitionKey *string `min:"1" type:"string" required:"true"`
}
// String returns the string representation
func (s PutRecordsRequestEntry) String() string {
return awsutil.Prettify(s)
}
// Validate inspects the fields of the type to determine if they are valid.
func (s *PutRecordsRequestEntry) Validate() error {
invalidParams := aws.ErrInvalidParams{Context: "PutRecordsRequestEntry"}
if s.Data == nil {
invalidParams.Add(aws.NewErrParamRequired("Data"))
}
if s.PartitionKey == nil {
invalidParams.Add(aws.NewErrParamRequired("PartitionKey"))
}
if s.PartitionKey != nil && len(*s.PartitionKey) < 1 {
invalidParams.Add(aws.NewErrParamMinLen("PartitionKey", 1))
}
if invalidParams.Len() > 0 {
return invalidParams
}
return nil
}
// Represents the result of an individual record from a PutRecords request.
// A record that is successfully added to a stream includes SequenceNumber and
// ShardId in the result. A record that fails to be added to the stream includes
// ErrorCode and ErrorMessage in the result.
// Please also see https://docs.aws.amazon.com/goto/WebAPI/kinesis-2013-12-02/PutRecordsResultEntry
type PutRecordsResultEntry struct {
_ struct{} `type:"structure"`
// The error code for an individual record result. ErrorCodes can be either
// ProvisionedThroughputExceededException or InternalFailure.
ErrorCode *string `type:"string"`
// The error message for an individual record result. An ErrorCode value of
// ProvisionedThroughputExceededException has an error message that includes
// the account ID, stream name, and shard ID. An ErrorCode value of InternalFailure
// has the error message "Internal Service Failure".
ErrorMessage *string `type:"string"`
// The sequence number for an individual record result.
SequenceNumber *string `type:"string"`
// The shard ID for an individual record result.
ShardId *string `min:"1" type:"string"`
}
// String returns the string representation
func (s PutRecordsResultEntry) String() string {
return awsutil.Prettify(s)
}
// The unit of data of the Kinesis data stream, which is composed of a sequence
// number, a partition key, and a data blob.
// Please also see https://docs.aws.amazon.com/goto/WebAPI/kinesis-2013-12-02/Record
type Record struct {
_ struct{} `type:"structure"`
// The approximate time that the record was inserted into the stream.
ApproximateArrivalTimestamp *time.Time `type:"timestamp"`
// The data blob. The data in the blob is both opaque and immutable to Kinesis
// Data Streams, which does not inspect, interpret, or change the data in the
// blob in any way. When the data blob (the payload before base64-encoding)
// is added to the partition key size, the total size must not exceed the maximum
// record size (1 MB).
//
// Data is automatically base64 encoded/decoded by the SDK.
//
// Data is a required field
Data []byte `type:"blob" required:"true"`
// The encryption type used on the record. This parameter can be one of the
// following values:
//
// * NONE: Do not encrypt the records in the stream.
//
// * KMS: Use server-side encryption on the records in the stream using a
// customer-managed AWS KMS key.
EncryptionType EncryptionType `type:"string" enum:"true"`
// Identifies which shard in the stream the data record is assigned to.
//
// PartitionKey is a required field
PartitionKey *string `min:"1" type:"string" required:"true"`
// The unique identifier of the record within its shard.
//
// SequenceNumber is a required field
SequenceNumber *string `type:"string" required:"true"`
}
// String returns the string representation
func (s Record) String() string {
return awsutil.Prettify(s)
}
// The range of possible sequence numbers for the shard.
// Please also see https://docs.aws.amazon.com/goto/WebAPI/kinesis-2013-12-02/SequenceNumberRange
type SequenceNumberRange struct {
_ struct{} `type:"structure"`
// The ending sequence number for the range. Shards that are in the OPEN state
// have an ending sequence number of null.
EndingSequenceNumber *string `type:"string"`
// The starting sequence number for the range.
//
// StartingSequenceNumber is a required field
StartingSequenceNumber *string `type:"string" required:"true"`
}
// String returns the string representation
func (s SequenceNumberRange) String() string {
return awsutil.Prettify(s)
}
// A uniquely identified group of data records in a Kinesis data stream.
// Please also see https://docs.aws.amazon.com/goto/WebAPI/kinesis-2013-12-02/Shard
type Shard struct {
_ struct{} `type:"structure"`
// The shard ID of the shard adjacent to the shard's parent.
AdjacentParentShardId *string `min:"1" type:"string"`
// The range of possible hash key values for the shard, which is a set of ordered
// contiguous positive integers.
//
// HashKeyRange is a required field
HashKeyRange *HashKeyRange `type:"structure" required:"true"`
// The shard ID of the shard's parent.
ParentShardId *string `min:"1" type:"string"`
// The range of possible sequence numbers for the shard.
//
// SequenceNumberRange is a required field
SequenceNumberRange *SequenceNumberRange `type:"structure" required:"true"`
// The unique identifier of the shard within the stream.
//
// ShardId is a required field
ShardId *string `min:"1" type:"string" required:"true"`
}
// String returns the string representation
func (s Shard) String() string {
return awsutil.Prettify(s)
}
// Represents the output for DescribeStream.
// Please also see https://docs.aws.amazon.com/goto/WebAPI/kinesis-2013-12-02/StreamDescription
type StreamDescription struct {
_ struct{} `type:"structure"`
// The server-side encryption type used on the stream. This parameter can be
// one of the following values:
//
// * NONE: Do not encrypt the records in the stream.
//
// * KMS: Use server-side encryption on the records in the stream using a
// customer-managed AWS KMS key.
EncryptionType EncryptionType `type:"string" enum:"true"`
// Represents the current enhanced monitoring settings of the stream.
//
// EnhancedMonitoring is a required field
EnhancedMonitoring []EnhancedMetrics `type:"list" required:"true"`
// If set to true, more shards in the stream are available to describe.
//
// HasMoreShards is a required field
HasMoreShards *bool `type:"boolean" required:"true"`
// The GUID for the customer-managed AWS KMS key to use for encryption. This
// value can be a globally unique identifier, a fully specified ARN to either
// an alias or a key, or an alias name prefixed by "alias/".You can also use
// a master key owned by Kinesis Data Streams by specifying the alias aws/kinesis.
//
// * Key ARN example: arn:aws:kms:us-east-1:123456789012:key/12345678-1234-1234-1234-123456789012
//
// * Alias ARN example: arn:aws:kms:us-east-1:123456789012:alias/MyAliasName
//
// * Globally unique key ID example: 12345678-1234-1234-1234-123456789012
//
// * Alias name example: alias/MyAliasName
//
// * Master key owned by Kinesis Data Streams: alias/aws/kinesis
KeyId *string `min:"1" type:"string"`
// The current retention period, in hours.
//
// RetentionPeriodHours is a required field
RetentionPeriodHours *int64 `min:"1" type:"integer" required:"true"`
// The shards that comprise the stream.
//
// Shards is a required field
Shards []Shard `type:"list" required:"true"`
// The Amazon Resource Name (ARN) for the stream being described.
//
// StreamARN is a required field
StreamARN *string `min:"1" type:"string" required:"true"`
// The approximate time that the stream was created.
//
// StreamCreationTimestamp is a required field
StreamCreationTimestamp *time.Time `type:"timestamp" required:"true"`
// The name of the stream being described.
//
// StreamName is a required field
StreamName *string `min:"1" type:"string" required:"true"`
// The current status of the stream being described. The stream status is one
// of the following states:
//
// * CREATING - The stream is being created. Kinesis Data Streams immediately
// returns and sets StreamStatus to CREATING.
//
// * DELETING - The stream is being deleted. The specified stream is in the
// DELETING state until Kinesis Data Streams completes the deletion.
//
// * ACTIVE - The stream exists and is ready for read and write operations
// or deletion. You should perform read and write operations only on an ACTIVE
// stream.
//
// * UPDATING - Shards in the stream are being merged or split. Read and
// write operations continue to work while the stream is in the UPDATING
// state.
//
// StreamStatus is a required field
StreamStatus StreamStatus `type:"string" required:"true" enum:"true"`
}
// String returns the string representation
func (s StreamDescription) String() string {
return awsutil.Prettify(s)
}
// Represents the output for DescribeStreamSummary
// Please also see https://docs.aws.amazon.com/goto/WebAPI/kinesis-2013-12-02/StreamDescriptionSummary
type StreamDescriptionSummary struct {
_ struct{} `type:"structure"`
// The number of enhanced fan-out consumers registered with the stream.
ConsumerCount *int64 `type:"integer"`
// The encryption type used. This value is one of the following:
//
// * KMS
//
// * NONE
EncryptionType EncryptionType `type:"string" enum:"true"`
// Represents the current enhanced monitoring settings of the stream.
//
// EnhancedMonitoring is a required field
EnhancedMonitoring []EnhancedMetrics `type:"list" required:"true"`
// The GUID for the customer-managed AWS KMS key to use for encryption. This
// value can be a globally unique identifier, a fully specified ARN to either
// an alias or a key, or an alias name prefixed by "alias/".You can also use
// a master key owned by Kinesis Data Streams by specifying the alias aws/kinesis.
//
// * Key ARN example: arn:aws:kms:us-east-1:123456789012:key/12345678-1234-1234-1234-123456789012
//
// * Alias ARN example: arn:aws:kms:us-east-1:123456789012:alias/MyAliasName
//
// * Globally unique key ID example: 12345678-1234-1234-1234-123456789012
//
// * Alias name example: alias/MyAliasName
//
// * Master key owned by Kinesis Data Streams: alias/aws/kinesis
KeyId *string `min:"1" type:"string"`
// The number of open shards in the stream.
//
// OpenShardCount is a required field
OpenShardCount *int64 `type:"integer" required:"true"`
// The current retention period, in hours.
//
// RetentionPeriodHours is a required field
RetentionPeriodHours *int64 `min:"1" type:"integer" required:"true"`
// The Amazon Resource Name (ARN) for the stream being described.
//
// StreamARN is a required field
StreamARN *string `min:"1" type:"string" required:"true"`
// The approximate time that the stream was created.
//
// StreamCreationTimestamp is a required field
StreamCreationTimestamp *time.Time `type:"timestamp" required:"true"`
// The name of the stream being described.
//
// StreamName is a required field
StreamName *string `min:"1" type:"string" required:"true"`
// The current status of the stream being described. The stream status is one
// of the following states:
//
// * CREATING - The stream is being created. Kinesis Data Streams immediately
// returns and sets StreamStatus to CREATING.
//
// * DELETING - The stream is being deleted. The specified stream is in the
// DELETING state until Kinesis Data Streams completes the deletion.
//
// * ACTIVE - The stream exists and is ready for read and write operations
// or deletion. You should perform read and write operations only on an ACTIVE
// stream.
//
// * UPDATING - Shards in the stream are being merged or split. Read and
// write operations continue to work while the stream is in the UPDATING
// state.
//
// StreamStatus is a required field
StreamStatus StreamStatus `type:"string" required:"true" enum:"true"`
}
// String returns the string representation
func (s StreamDescriptionSummary) String() string {
return awsutil.Prettify(s)
}
// Metadata assigned to the stream, consisting of a key-value pair.
// Please also see https://docs.aws.amazon.com/goto/WebAPI/kinesis-2013-12-02/Tag
type Tag struct {
_ struct{} `type:"structure"`
// A unique identifier for the tag. Maximum length: 128 characters. Valid characters:
// Unicode letters, digits, white space, _ . / = + - % @
//
// Key is a required field
Key *string `min:"1" type:"string" required:"true"`
// An optional string, typically used to describe or define the tag. Maximum
// length: 256 characters. Valid characters: Unicode letters, digits, white
// space, _ . / = + - % @
Value *string `type:"string"`
}
// String returns the string representation
func (s Tag) String() string {
return awsutil.Prettify(s)
}