aws-sdk-kinesis 1.1.0 → 1.2.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +4 -4
- data/lib/aws-sdk-kinesis.rb +1 -1
- data/lib/aws-sdk-kinesis/client.rb +280 -165
- data/lib/aws-sdk-kinesis/client_api.rb +35 -3
- data/lib/aws-sdk-kinesis/types.rb +184 -65
- metadata +2 -2
@@ -33,6 +33,7 @@ module Aws::Kinesis
|
|
33
33
|
ErrorCode = Shapes::StringShape.new(name: 'ErrorCode')
|
34
34
|
ErrorMessage = Shapes::StringShape.new(name: 'ErrorMessage')
|
35
35
|
ExpiredIteratorException = Shapes::StructureShape.new(name: 'ExpiredIteratorException')
|
36
|
+
ExpiredNextTokenException = Shapes::StructureShape.new(name: 'ExpiredNextTokenException')
|
36
37
|
GetRecordsInput = Shapes::StructureShape.new(name: 'GetRecordsInput')
|
37
38
|
GetRecordsInputLimit = Shapes::IntegerShape.new(name: 'GetRecordsInputLimit')
|
38
39
|
GetRecordsOutput = Shapes::StructureShape.new(name: 'GetRecordsOutput')
|
@@ -50,6 +51,9 @@ module Aws::Kinesis
|
|
50
51
|
KMSThrottlingException = Shapes::StructureShape.new(name: 'KMSThrottlingException')
|
51
52
|
KeyId = Shapes::StringShape.new(name: 'KeyId')
|
52
53
|
LimitExceededException = Shapes::StructureShape.new(name: 'LimitExceededException')
|
54
|
+
ListShardsInput = Shapes::StructureShape.new(name: 'ListShardsInput')
|
55
|
+
ListShardsInputLimit = Shapes::IntegerShape.new(name: 'ListShardsInputLimit')
|
56
|
+
ListShardsOutput = Shapes::StructureShape.new(name: 'ListShardsOutput')
|
53
57
|
ListStreamsInput = Shapes::StructureShape.new(name: 'ListStreamsInput')
|
54
58
|
ListStreamsInputLimit = Shapes::IntegerShape.new(name: 'ListStreamsInputLimit')
|
55
59
|
ListStreamsOutput = Shapes::StructureShape.new(name: 'ListStreamsOutput')
|
@@ -60,6 +64,7 @@ module Aws::Kinesis
|
|
60
64
|
MetricsName = Shapes::StringShape.new(name: 'MetricsName')
|
61
65
|
MetricsNameList = Shapes::ListShape.new(name: 'MetricsNameList')
|
62
66
|
MillisBehindLatest = Shapes::IntegerShape.new(name: 'MillisBehindLatest')
|
67
|
+
NextToken = Shapes::StringShape.new(name: 'NextToken')
|
63
68
|
PartitionKey = Shapes::StringShape.new(name: 'PartitionKey')
|
64
69
|
PositiveIntegerObject = Shapes::IntegerShape.new(name: 'PositiveIntegerObject')
|
65
70
|
ProvisionedThroughputExceededException = Shapes::StructureShape.new(name: 'ProvisionedThroughputExceededException')
|
@@ -76,6 +81,7 @@ module Aws::Kinesis
|
|
76
81
|
RemoveTagsFromStreamInput = Shapes::StructureShape.new(name: 'RemoveTagsFromStreamInput')
|
77
82
|
ResourceInUseException = Shapes::StructureShape.new(name: 'ResourceInUseException')
|
78
83
|
ResourceNotFoundException = Shapes::StructureShape.new(name: 'ResourceNotFoundException')
|
84
|
+
RetentionPeriodHours = Shapes::IntegerShape.new(name: 'RetentionPeriodHours')
|
79
85
|
ScalingType = Shapes::StringShape.new(name: 'ScalingType')
|
80
86
|
SequenceNumber = Shapes::StringShape.new(name: 'SequenceNumber')
|
81
87
|
SequenceNumberRange = Shapes::StructureShape.new(name: 'SequenceNumberRange')
|
@@ -113,7 +119,7 @@ module Aws::Kinesis
|
|
113
119
|
CreateStreamInput.struct_class = Types::CreateStreamInput
|
114
120
|
|
115
121
|
DecreaseStreamRetentionPeriodInput.add_member(:stream_name, Shapes::ShapeRef.new(shape: StreamName, required: true, location_name: "StreamName"))
|
116
|
-
DecreaseStreamRetentionPeriodInput.add_member(:retention_period_hours, Shapes::ShapeRef.new(shape:
|
122
|
+
DecreaseStreamRetentionPeriodInput.add_member(:retention_period_hours, Shapes::ShapeRef.new(shape: RetentionPeriodHours, required: true, location_name: "RetentionPeriodHours"))
|
117
123
|
DecreaseStreamRetentionPeriodInput.struct_class = Types::DecreaseStreamRetentionPeriodInput
|
118
124
|
|
119
125
|
DeleteStreamInput.add_member(:stream_name, Shapes::ShapeRef.new(shape: StreamName, required: true, location_name: "StreamName"))
|
@@ -181,9 +187,20 @@ module Aws::Kinesis
|
|
181
187
|
HashKeyRange.struct_class = Types::HashKeyRange
|
182
188
|
|
183
189
|
IncreaseStreamRetentionPeriodInput.add_member(:stream_name, Shapes::ShapeRef.new(shape: StreamName, required: true, location_name: "StreamName"))
|
184
|
-
IncreaseStreamRetentionPeriodInput.add_member(:retention_period_hours, Shapes::ShapeRef.new(shape:
|
190
|
+
IncreaseStreamRetentionPeriodInput.add_member(:retention_period_hours, Shapes::ShapeRef.new(shape: RetentionPeriodHours, required: true, location_name: "RetentionPeriodHours"))
|
185
191
|
IncreaseStreamRetentionPeriodInput.struct_class = Types::IncreaseStreamRetentionPeriodInput
|
186
192
|
|
193
|
+
ListShardsInput.add_member(:stream_name, Shapes::ShapeRef.new(shape: StreamName, location_name: "StreamName"))
|
194
|
+
ListShardsInput.add_member(:next_token, Shapes::ShapeRef.new(shape: NextToken, location_name: "NextToken"))
|
195
|
+
ListShardsInput.add_member(:exclusive_start_shard_id, Shapes::ShapeRef.new(shape: ShardId, location_name: "ExclusiveStartShardId"))
|
196
|
+
ListShardsInput.add_member(:max_results, Shapes::ShapeRef.new(shape: ListShardsInputLimit, location_name: "MaxResults"))
|
197
|
+
ListShardsInput.add_member(:stream_creation_timestamp, Shapes::ShapeRef.new(shape: Timestamp, location_name: "StreamCreationTimestamp"))
|
198
|
+
ListShardsInput.struct_class = Types::ListShardsInput
|
199
|
+
|
200
|
+
ListShardsOutput.add_member(:shards, Shapes::ShapeRef.new(shape: ShardList, location_name: "Shards"))
|
201
|
+
ListShardsOutput.add_member(:next_token, Shapes::ShapeRef.new(shape: NextToken, location_name: "NextToken"))
|
202
|
+
ListShardsOutput.struct_class = Types::ListShardsOutput
|
203
|
+
|
187
204
|
ListStreamsInput.add_member(:limit, Shapes::ShapeRef.new(shape: ListStreamsInputLimit, location_name: "Limit"))
|
188
205
|
ListStreamsInput.add_member(:exclusive_start_stream_name, Shapes::ShapeRef.new(shape: StreamName, location_name: "ExclusiveStartStreamName"))
|
189
206
|
ListStreamsInput.struct_class = Types::ListStreamsInput
|
@@ -290,7 +307,7 @@ module Aws::Kinesis
|
|
290
307
|
StreamDescription.add_member(:stream_status, Shapes::ShapeRef.new(shape: StreamStatus, required: true, location_name: "StreamStatus"))
|
291
308
|
StreamDescription.add_member(:shards, Shapes::ShapeRef.new(shape: ShardList, required: true, location_name: "Shards"))
|
292
309
|
StreamDescription.add_member(:has_more_shards, Shapes::ShapeRef.new(shape: BooleanObject, required: true, location_name: "HasMoreShards"))
|
293
|
-
StreamDescription.add_member(:retention_period_hours, Shapes::ShapeRef.new(shape:
|
310
|
+
StreamDescription.add_member(:retention_period_hours, Shapes::ShapeRef.new(shape: RetentionPeriodHours, required: true, location_name: "RetentionPeriodHours"))
|
294
311
|
StreamDescription.add_member(:stream_creation_timestamp, Shapes::ShapeRef.new(shape: Timestamp, required: true, location_name: "StreamCreationTimestamp"))
|
295
312
|
StreamDescription.add_member(:enhanced_monitoring, Shapes::ShapeRef.new(shape: EnhancedMonitoringList, required: true, location_name: "EnhancedMonitoring"))
|
296
313
|
StreamDescription.add_member(:encryption_type, Shapes::ShapeRef.new(shape: EncryptionType, location_name: "EncryptionType"))
|
@@ -377,6 +394,7 @@ module Aws::Kinesis
|
|
377
394
|
o.output = Shapes::ShapeRef.new(shape: Shapes::StructureShape.new(struct_class: Aws::EmptyStructure))
|
378
395
|
o.errors << Shapes::ShapeRef.new(shape: ResourceInUseException)
|
379
396
|
o.errors << Shapes::ShapeRef.new(shape: ResourceNotFoundException)
|
397
|
+
o.errors << Shapes::ShapeRef.new(shape: LimitExceededException)
|
380
398
|
o.errors << Shapes::ShapeRef.new(shape: InvalidArgumentException)
|
381
399
|
end)
|
382
400
|
|
@@ -487,7 +505,21 @@ module Aws::Kinesis
|
|
487
505
|
o.output = Shapes::ShapeRef.new(shape: Shapes::StructureShape.new(struct_class: Aws::EmptyStructure))
|
488
506
|
o.errors << Shapes::ShapeRef.new(shape: ResourceInUseException)
|
489
507
|
o.errors << Shapes::ShapeRef.new(shape: ResourceNotFoundException)
|
508
|
+
o.errors << Shapes::ShapeRef.new(shape: LimitExceededException)
|
509
|
+
o.errors << Shapes::ShapeRef.new(shape: InvalidArgumentException)
|
510
|
+
end)
|
511
|
+
|
512
|
+
api.add_operation(:list_shards, Seahorse::Model::Operation.new.tap do |o|
|
513
|
+
o.name = "ListShards"
|
514
|
+
o.http_method = "POST"
|
515
|
+
o.http_request_uri = "/"
|
516
|
+
o.input = Shapes::ShapeRef.new(shape: ListShardsInput)
|
517
|
+
o.output = Shapes::ShapeRef.new(shape: ListShardsOutput)
|
518
|
+
o.errors << Shapes::ShapeRef.new(shape: ResourceNotFoundException)
|
490
519
|
o.errors << Shapes::ShapeRef.new(shape: InvalidArgumentException)
|
520
|
+
o.errors << Shapes::ShapeRef.new(shape: LimitExceededException)
|
521
|
+
o.errors << Shapes::ShapeRef.new(shape: ExpiredNextTokenException)
|
522
|
+
o.errors << Shapes::ShapeRef.new(shape: ResourceInUseException)
|
491
523
|
end)
|
492
524
|
|
493
525
|
api.add_operation(:list_streams, Seahorse::Model::Operation.new.tap do |o|
|
@@ -49,9 +49,9 @@ module Aws::Kinesis
|
|
49
49
|
# @!attribute [rw] stream_name
|
50
50
|
# A name to identify the stream. The stream name is scoped to the AWS
|
51
51
|
# account used by the application that creates the stream. It is also
|
52
|
-
# scoped by
|
53
|
-
# can have the same name. Two streams in the same AWS account
|
54
|
-
# two different
|
52
|
+
# scoped by AWS Region. That is, two streams in two different AWS
|
53
|
+
# accounts can have the same name. Two streams in the same AWS account
|
54
|
+
# but in two different Regions can also have the same name.
|
55
55
|
# @return [String]
|
56
56
|
#
|
57
57
|
# @!attribute [rw] shard_count
|
@@ -176,9 +176,9 @@ module Aws::Kinesis
|
|
176
176
|
# Represents the output for `DescribeStream`.
|
177
177
|
#
|
178
178
|
# @!attribute [rw] stream_description
|
179
|
-
# The current status of the stream, the stream
|
180
|
-
# objects that comprise the stream, and
|
181
|
-
# available.
|
179
|
+
# The current status of the stream, the stream Amazon Resource Name
|
180
|
+
# (ARN), an array of shard objects that comprise the stream, and
|
181
|
+
# whether there are more shards available.
|
182
182
|
# @return [Types::StreamDescription]
|
183
183
|
#
|
184
184
|
# @see http://docs.aws.amazon.com/goto/WebAPI/kinesis-2013-12-02/DescribeStreamOutput AWS API Documentation
|
@@ -228,7 +228,7 @@ module Aws::Kinesis
|
|
228
228
|
# }
|
229
229
|
#
|
230
230
|
# @!attribute [rw] stream_name
|
231
|
-
# The name of the Kinesis stream for which to disable enhanced
|
231
|
+
# The name of the Kinesis data stream for which to disable enhanced
|
232
232
|
# monitoring.
|
233
233
|
# @return [String]
|
234
234
|
#
|
@@ -254,9 +254,9 @@ module Aws::Kinesis
|
|
254
254
|
#
|
255
255
|
# * `ALL`
|
256
256
|
#
|
257
|
-
# For more information, see [Monitoring the Amazon Kinesis
|
258
|
-
# Service with Amazon CloudWatch][1] in the *Amazon Kinesis
|
259
|
-
# Developer Guide*.
|
257
|
+
# For more information, see [Monitoring the Amazon Kinesis Data
|
258
|
+
# Streams Service with Amazon CloudWatch][1] in the *Amazon Kinesis
|
259
|
+
# Data Streams Developer Guide*.
|
260
260
|
#
|
261
261
|
#
|
262
262
|
#
|
@@ -307,9 +307,9 @@ module Aws::Kinesis
|
|
307
307
|
#
|
308
308
|
# * `ALL`
|
309
309
|
#
|
310
|
-
# For more information, see [Monitoring the Amazon Kinesis
|
311
|
-
# Service with Amazon CloudWatch][1] in the *Amazon Kinesis
|
312
|
-
# Developer Guide*.
|
310
|
+
# For more information, see [Monitoring the Amazon Kinesis Data
|
311
|
+
# Streams Service with Amazon CloudWatch][1] in the *Amazon Kinesis
|
312
|
+
# Data Streams Developer Guide*.
|
313
313
|
#
|
314
314
|
#
|
315
315
|
#
|
@@ -348,9 +348,9 @@ module Aws::Kinesis
|
|
348
348
|
#
|
349
349
|
# * `ALL`
|
350
350
|
#
|
351
|
-
# For more information, see [Monitoring the Amazon Kinesis
|
352
|
-
# Service with Amazon CloudWatch][1] in the *Amazon Kinesis
|
353
|
-
# Developer Guide*.
|
351
|
+
# For more information, see [Monitoring the Amazon Kinesis Data
|
352
|
+
# Streams Service with Amazon CloudWatch][1] in the *Amazon Kinesis
|
353
|
+
# Data Streams Developer Guide*.
|
354
354
|
#
|
355
355
|
#
|
356
356
|
#
|
@@ -368,7 +368,7 @@ module Aws::Kinesis
|
|
368
368
|
# DisableEnhancedMonitoring.
|
369
369
|
#
|
370
370
|
# @!attribute [rw] stream_name
|
371
|
-
# The name of the Kinesis stream.
|
371
|
+
# The name of the Kinesis data stream.
|
372
372
|
# @return [String]
|
373
373
|
#
|
374
374
|
# @!attribute [rw] current_shard_level_metrics
|
@@ -462,11 +462,12 @@ module Aws::Kinesis
|
|
462
462
|
# }
|
463
463
|
#
|
464
464
|
# @!attribute [rw] stream_name
|
465
|
-
# The name of the Amazon Kinesis stream.
|
465
|
+
# The name of the Amazon Kinesis data stream.
|
466
466
|
# @return [String]
|
467
467
|
#
|
468
468
|
# @!attribute [rw] shard_id
|
469
|
-
# The shard ID of the Kinesis Streams shard to get the iterator
|
469
|
+
# The shard ID of the Kinesis Data Streams shard to get the iterator
|
470
|
+
# for.
|
470
471
|
# @return [String]
|
471
472
|
#
|
472
473
|
# @!attribute [rw] shard_iterator_type
|
@@ -582,6 +583,124 @@ module Aws::Kinesis
|
|
582
583
|
include Aws::Structure
|
583
584
|
end
|
584
585
|
|
586
|
+
# @note When making an API call, you may pass ListShardsInput
|
587
|
+
# data as a hash:
|
588
|
+
#
|
589
|
+
# {
|
590
|
+
# stream_name: "StreamName",
|
591
|
+
# next_token: "NextToken",
|
592
|
+
# exclusive_start_shard_id: "ShardId",
|
593
|
+
# max_results: 1,
|
594
|
+
# stream_creation_timestamp: Time.now,
|
595
|
+
# }
|
596
|
+
#
|
597
|
+
# @!attribute [rw] stream_name
|
598
|
+
# The name of the data stream whose shards you want to list.
|
599
|
+
#
|
600
|
+
# You cannot specify this parameter if you specify the `NextToken`
|
601
|
+
# parameter.
|
602
|
+
# @return [String]
|
603
|
+
#
|
604
|
+
# @!attribute [rw] next_token
|
605
|
+
# When the number of shards in the data stream is greater than the
|
606
|
+
# default value for the `MaxResults` parameter, or if you explicitly
|
607
|
+
# specify a value for `MaxResults` that is less than the number of
|
608
|
+
# shards in the data stream, the response includes a pagination token
|
609
|
+
# named `NextToken`. You can specify this `NextToken` value in a
|
610
|
+
# subsequent call to `ListShards` to list the next set of shards.
|
611
|
+
#
|
612
|
+
# Don't specify `StreamName` or `StreamCreationTimestamp` if you
|
613
|
+
# specify `NextToken` because the latter unambiguously identifies the
|
614
|
+
# stream.
|
615
|
+
#
|
616
|
+
# You can optionally specify a value for the `MaxResults` parameter
|
617
|
+
# when you specify `NextToken`. If you specify a `MaxResults` value
|
618
|
+
# that is less than the number of shards that the operation returns if
|
619
|
+
# you don't specify `MaxResults`, the response will contain a new
|
620
|
+
# `NextToken` value. You can use the new `NextToken` value in a
|
621
|
+
# subsequent call to the `ListShards` operation.
|
622
|
+
#
|
623
|
+
# Tokens expire after 300 seconds. When you obtain a value for
|
624
|
+
# `NextToken` in the response to a call to `ListShards`, you have 300
|
625
|
+
# seconds to use that value. If you specify an expired token in a call
|
626
|
+
# to `ListShards`, you get `ExpiredNextTokenException`.
|
627
|
+
# @return [String]
|
628
|
+
#
|
629
|
+
# @!attribute [rw] exclusive_start_shard_id
|
630
|
+
# The ID of the shard to start the list with.
|
631
|
+
#
|
632
|
+
# If you don't specify this parameter, the default behavior is for
|
633
|
+
# `ListShards` to list the shards starting with the first one in the
|
634
|
+
# stream.
|
635
|
+
#
|
636
|
+
# You cannot specify this parameter if you specify `NextToken`.
|
637
|
+
# @return [String]
|
638
|
+
#
|
639
|
+
# @!attribute [rw] max_results
|
640
|
+
# The maximum number of shards to return in a single call to
|
641
|
+
# `ListShards`. The minimum value you can specify for this parameter
|
642
|
+
# is 1, and the maximum is 1,000, which is also the default.
|
643
|
+
#
|
644
|
+
# When the number of shards to be listed is greater than the value of
|
645
|
+
# `MaxResults`, the response contains a `NextToken` value that you can
|
646
|
+
# use in a subsequent call to `ListShards` to list the next set of
|
647
|
+
# shards.
|
648
|
+
# @return [Integer]
|
649
|
+
#
|
650
|
+
# @!attribute [rw] stream_creation_timestamp
|
651
|
+
# Specify this input parameter to distinguish data streams that have
|
652
|
+
# the same name. For example, if you create a data stream and then
|
653
|
+
# delete it, and you later create another data stream with the same
|
654
|
+
# name, you can use this input parameter to specify which of the two
|
655
|
+
# streams you want to list the shards for.
|
656
|
+
#
|
657
|
+
# You cannot specify this parameter if you specify the `NextToken`
|
658
|
+
# parameter.
|
659
|
+
# @return [Time]
|
660
|
+
#
|
661
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/kinesis-2013-12-02/ListShardsInput AWS API Documentation
|
662
|
+
#
|
663
|
+
class ListShardsInput < Struct.new(
|
664
|
+
:stream_name,
|
665
|
+
:next_token,
|
666
|
+
:exclusive_start_shard_id,
|
667
|
+
:max_results,
|
668
|
+
:stream_creation_timestamp)
|
669
|
+
include Aws::Structure
|
670
|
+
end
|
671
|
+
|
672
|
+
# @!attribute [rw] shards
|
673
|
+
# An array of JSON objects. Each object represents one shard and
|
674
|
+
# specifies the IDs of the shard, the shard's parent, and the shard
|
675
|
+
# that's adjacent to the shard's parent. Each object also contains
|
676
|
+
# the starting and ending hash keys and the starting and ending
|
677
|
+
# sequence numbers for the shard.
|
678
|
+
# @return [Array<Types::Shard>]
|
679
|
+
#
|
680
|
+
# @!attribute [rw] next_token
|
681
|
+
# When the number of shards in the data stream is greater than the
|
682
|
+
# default value for the `MaxResults` parameter, or if you explicitly
|
683
|
+
# specify a value for `MaxResults` that is less than the number of
|
684
|
+
# shards in the data stream, the response includes a pagination token
|
685
|
+
# named `NextToken`. You can specify this `NextToken` value in a
|
686
|
+
# subsequent call to `ListShards` to list the next set of shards. For
|
687
|
+
# more information about the use of this pagination token when calling
|
688
|
+
# the `ListShards` operation, see ListShardsInput$NextToken.
|
689
|
+
#
|
690
|
+
# Tokens expire after 300 seconds. When you obtain a value for
|
691
|
+
# `NextToken` in the response to a call to `ListShards`, you have 300
|
692
|
+
# seconds to use that value. If you specify an expired token in a call
|
693
|
+
# to `ListShards`, you get `ExpiredNextTokenException`.
|
694
|
+
# @return [String]
|
695
|
+
#
|
696
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/kinesis-2013-12-02/ListShardsOutput AWS API Documentation
|
697
|
+
#
|
698
|
+
class ListShardsOutput < Struct.new(
|
699
|
+
:shards,
|
700
|
+
:next_token)
|
701
|
+
include Aws::Structure
|
702
|
+
end
|
703
|
+
|
585
704
|
# Represents the input for `ListStreams`.
|
586
705
|
#
|
587
706
|
# @note When making an API call, you may pass ListStreamsInput
|
@@ -745,13 +864,13 @@ module Aws::Kinesis
|
|
745
864
|
# @!attribute [rw] partition_key
|
746
865
|
# Determines which shard in the stream the data record is assigned to.
|
747
866
|
# Partition keys are Unicode strings with a maximum length limit of
|
748
|
-
# 256 characters for each key. Amazon Kinesis uses the
|
749
|
-
# as input to a hash function that maps the partition
|
750
|
-
# associated data to a specific shard. Specifically, an MD5
|
751
|
-
# function is used to map partition keys to 128-bit integer
|
752
|
-
# to map associated data records to shards. As a result of
|
753
|
-
# hashing mechanism, all data records with the same partition key
|
754
|
-
# to the same shard within the stream.
|
867
|
+
# 256 characters for each key. Amazon Kinesis Data Streams uses the
|
868
|
+
# partition key as input to a hash function that maps the partition
|
869
|
+
# key and associated data to a specific shard. Specifically, an MD5
|
870
|
+
# hash function is used to map partition keys to 128-bit integer
|
871
|
+
# values and to map associated data records to shards. As a result of
|
872
|
+
# this hashing mechanism, all data records with the same partition key
|
873
|
+
# map to the same shard within the stream.
|
755
874
|
# @return [String]
|
756
875
|
#
|
757
876
|
# @!attribute [rw] explicit_hash_key
|
@@ -799,7 +918,7 @@ module Aws::Kinesis
|
|
799
918
|
# * `NONE`\: Do not encrypt the records in the stream.
|
800
919
|
#
|
801
920
|
# * `KMS`\: Use server-side encryption on the records in the stream
|
802
|
-
# using a customer-managed KMS key.
|
921
|
+
# using a customer-managed AWS KMS key.
|
803
922
|
# @return [String]
|
804
923
|
#
|
805
924
|
# @see http://docs.aws.amazon.com/goto/WebAPI/kinesis-2013-12-02/PutRecordOutput AWS API Documentation
|
@@ -865,7 +984,7 @@ module Aws::Kinesis
|
|
865
984
|
# * `NONE`\: Do not encrypt the records.
|
866
985
|
#
|
867
986
|
# * `KMS`\: Use server-side encryption on the records using a
|
868
|
-
# customer-managed KMS key.
|
987
|
+
# customer-managed AWS KMS key.
|
869
988
|
# @return [String]
|
870
989
|
#
|
871
990
|
# @see http://docs.aws.amazon.com/goto/WebAPI/kinesis-2013-12-02/PutRecordsOutput AWS API Documentation
|
@@ -903,13 +1022,13 @@ module Aws::Kinesis
|
|
903
1022
|
# @!attribute [rw] partition_key
|
904
1023
|
# Determines which shard in the stream the data record is assigned to.
|
905
1024
|
# Partition keys are Unicode strings with a maximum length limit of
|
906
|
-
# 256 characters for each key. Amazon Kinesis uses the
|
907
|
-
# as input to a hash function that maps the partition
|
908
|
-
# associated data to a specific shard. Specifically, an MD5
|
909
|
-
# function is used to map partition keys to 128-bit integer
|
910
|
-
# to map associated data records to shards. As a result of
|
911
|
-
# hashing mechanism, all data records with the same partition key
|
912
|
-
# to the same shard within the stream.
|
1025
|
+
# 256 characters for each key. Amazon Kinesis Data Streams uses the
|
1026
|
+
# partition key as input to a hash function that maps the partition
|
1027
|
+
# key and associated data to a specific shard. Specifically, an MD5
|
1028
|
+
# hash function is used to map partition keys to 128-bit integer
|
1029
|
+
# values and to map associated data records to shards. As a result of
|
1030
|
+
# this hashing mechanism, all data records with the same partition key
|
1031
|
+
# map to the same shard within the stream.
|
913
1032
|
# @return [String]
|
914
1033
|
#
|
915
1034
|
# @see http://docs.aws.amazon.com/goto/WebAPI/kinesis-2013-12-02/PutRecordsRequestEntry AWS API Documentation
|
@@ -959,7 +1078,7 @@ module Aws::Kinesis
|
|
959
1078
|
include Aws::Structure
|
960
1079
|
end
|
961
1080
|
|
962
|
-
# The unit of data of the Kinesis stream, which is composed of a
|
1081
|
+
# The unit of data of the Kinesis data stream, which is composed of a
|
963
1082
|
# sequence number, a partition key, and a data blob.
|
964
1083
|
#
|
965
1084
|
# @!attribute [rw] sequence_number
|
@@ -972,10 +1091,10 @@ module Aws::Kinesis
|
|
972
1091
|
#
|
973
1092
|
# @!attribute [rw] data
|
974
1093
|
# The data blob. The data in the blob is both opaque and immutable to
|
975
|
-
# Kinesis Streams, which does not inspect, interpret, or change
|
976
|
-
# data in the blob in any way. When the data blob (the payload
|
977
|
-
# base64-encoding) is added to the partition key size, the
|
978
|
-
# must not exceed the maximum record size (1 MB).
|
1094
|
+
# Kinesis Data Streams, which does not inspect, interpret, or change
|
1095
|
+
# the data in the blob in any way. When the data blob (the payload
|
1096
|
+
# before base64-encoding) is added to the partition key size, the
|
1097
|
+
# total size must not exceed the maximum record size (1 MB).
|
979
1098
|
# @return [String]
|
980
1099
|
#
|
981
1100
|
# @!attribute [rw] partition_key
|
@@ -989,7 +1108,7 @@ module Aws::Kinesis
|
|
989
1108
|
# * `NONE`\: Do not encrypt the records in the stream.
|
990
1109
|
#
|
991
1110
|
# * `KMS`\: Use server-side encryption on the records in the stream
|
992
|
-
# using a customer-managed KMS key.
|
1111
|
+
# using a customer-managed AWS KMS key.
|
993
1112
|
# @return [String]
|
994
1113
|
#
|
995
1114
|
# @see http://docs.aws.amazon.com/goto/WebAPI/kinesis-2013-12-02/Record AWS API Documentation
|
@@ -1049,7 +1168,7 @@ module Aws::Kinesis
|
|
1049
1168
|
include Aws::Structure
|
1050
1169
|
end
|
1051
1170
|
|
1052
|
-
# A uniquely identified group of data records in a Kinesis stream.
|
1171
|
+
# A uniquely identified group of data records in a Kinesis data stream.
|
1053
1172
|
#
|
1054
1173
|
# @!attribute [rw] shard_id
|
1055
1174
|
# The unique identifier of the shard within the stream.
|
@@ -1140,11 +1259,11 @@ module Aws::Kinesis
|
|
1140
1259
|
# @return [String]
|
1141
1260
|
#
|
1142
1261
|
# @!attribute [rw] key_id
|
1143
|
-
# The GUID for the customer-managed KMS key to use for encryption.
|
1262
|
+
# The GUID for the customer-managed AWS KMS key to use for encryption.
|
1144
1263
|
# This value can be a globally unique identifier, a fully specified
|
1145
|
-
# ARN to either an alias or a key, or an alias
|
1146
|
-
# "alias/".You can also use a master key owned by
|
1147
|
-
# specifying the alias `aws/kinesis`.
|
1264
|
+
# Amazon Resource Name (ARN) to either an alias or a key, or an alias
|
1265
|
+
# name prefixed by "alias/".You can also use a master key owned by
|
1266
|
+
# Kinesis Data Streams by specifying the alias `aws/kinesis`.
|
1148
1267
|
#
|
1149
1268
|
# * Key ARN example:
|
1150
1269
|
# `arn:aws:kms:us-east-1:123456789012:key/12345678-1234-1234-1234-123456789012`
|
@@ -1157,7 +1276,7 @@ module Aws::Kinesis
|
|
1157
1276
|
#
|
1158
1277
|
# * Alias name example: `alias/MyAliasName`
|
1159
1278
|
#
|
1160
|
-
# * Master key owned by Kinesis Streams: `alias/aws/kinesis`
|
1279
|
+
# * Master key owned by Kinesis Data Streams: `alias/aws/kinesis`
|
1161
1280
|
# @return [String]
|
1162
1281
|
#
|
1163
1282
|
# @see http://docs.aws.amazon.com/goto/WebAPI/kinesis-2013-12-02/StartStreamEncryptionInput AWS API Documentation
|
@@ -1187,11 +1306,11 @@ module Aws::Kinesis
|
|
1187
1306
|
# @return [String]
|
1188
1307
|
#
|
1189
1308
|
# @!attribute [rw] key_id
|
1190
|
-
# The GUID for the customer-managed KMS key to use for encryption.
|
1309
|
+
# The GUID for the customer-managed AWS KMS key to use for encryption.
|
1191
1310
|
# This value can be a globally unique identifier, a fully specified
|
1192
|
-
# ARN to either an alias or a key, or an alias
|
1193
|
-
# "alias/".You can also use a master key owned by
|
1194
|
-
# specifying the alias `aws/kinesis`.
|
1311
|
+
# Amazon Resource Name (ARN) to either an alias or a key, or an alias
|
1312
|
+
# name prefixed by "alias/".You can also use a master key owned by
|
1313
|
+
# Kinesis Data Streams by specifying the alias `aws/kinesis`.
|
1195
1314
|
#
|
1196
1315
|
# * Key ARN example:
|
1197
1316
|
# `arn:aws:kms:us-east-1:123456789012:key/12345678-1234-1234-1234-123456789012`
|
@@ -1204,7 +1323,7 @@ module Aws::Kinesis
|
|
1204
1323
|
#
|
1205
1324
|
# * Alias name example: `alias/MyAliasName`
|
1206
1325
|
#
|
1207
|
-
# * Master key owned by Kinesis Streams: `alias/aws/kinesis`
|
1326
|
+
# * Master key owned by Kinesis Data Streams: `alias/aws/kinesis`
|
1208
1327
|
# @return [String]
|
1209
1328
|
#
|
1210
1329
|
# @see http://docs.aws.amazon.com/goto/WebAPI/kinesis-2013-12-02/StopStreamEncryptionInput AWS API Documentation
|
@@ -1230,11 +1349,11 @@ module Aws::Kinesis
|
|
1230
1349
|
# The current status of the stream being described. The stream status
|
1231
1350
|
# is one of the following states:
|
1232
1351
|
#
|
1233
|
-
# * `CREATING` - The stream is being created. Kinesis Streams
|
1352
|
+
# * `CREATING` - The stream is being created. Kinesis Data Streams
|
1234
1353
|
# immediately returns and sets `StreamStatus` to `CREATING`.
|
1235
1354
|
#
|
1236
1355
|
# * `DELETING` - The stream is being deleted. The specified stream is
|
1237
|
-
# in the `DELETING` state until Kinesis Streams completes the
|
1356
|
+
# in the `DELETING` state until Kinesis Data Streams completes the
|
1238
1357
|
# deletion.
|
1239
1358
|
#
|
1240
1359
|
# * `ACTIVE` - The stream exists and is ready for read and write
|
@@ -1274,15 +1393,15 @@ module Aws::Kinesis
|
|
1274
1393
|
# * `NONE`\: Do not encrypt the records in the stream.
|
1275
1394
|
#
|
1276
1395
|
# * `KMS`\: Use server-side encryption on the records in the stream
|
1277
|
-
# using a customer-managed KMS key.
|
1396
|
+
# using a customer-managed AWS KMS key.
|
1278
1397
|
# @return [String]
|
1279
1398
|
#
|
1280
1399
|
# @!attribute [rw] key_id
|
1281
|
-
# The GUID for the customer-managed KMS key to use for encryption.
|
1400
|
+
# The GUID for the customer-managed AWS KMS key to use for encryption.
|
1282
1401
|
# This value can be a globally unique identifier, a fully specified
|
1283
1402
|
# ARN to either an alias or a key, or an alias name prefixed by
|
1284
|
-
# "alias/".You can also use a master key owned by Kinesis
|
1285
|
-
# specifying the alias `aws/kinesis`.
|
1403
|
+
# "alias/".You can also use a master key owned by Kinesis Data
|
1404
|
+
# Streams by specifying the alias `aws/kinesis`.
|
1286
1405
|
#
|
1287
1406
|
# * Key ARN example:
|
1288
1407
|
# `arn:aws:kms:us-east-1:123456789012:key/12345678-1234-1234-1234-123456789012`
|
@@ -1295,7 +1414,7 @@ module Aws::Kinesis
|
|
1295
1414
|
#
|
1296
1415
|
# * Alias name example: `alias/MyAliasName`
|
1297
1416
|
#
|
1298
|
-
# * Master key owned by Kinesis Streams: `alias/aws/kinesis`
|
1417
|
+
# * Master key owned by Kinesis Data Streams: `alias/aws/kinesis`
|
1299
1418
|
# @return [String]
|
1300
1419
|
#
|
1301
1420
|
# @see http://docs.aws.amazon.com/goto/WebAPI/kinesis-2013-12-02/StreamDescription AWS API Documentation
|
@@ -1328,11 +1447,11 @@ module Aws::Kinesis
|
|
1328
1447
|
# The current status of the stream being described. The stream status
|
1329
1448
|
# is one of the following states:
|
1330
1449
|
#
|
1331
|
-
# * `CREATING` - The stream is being created. Kinesis Streams
|
1450
|
+
# * `CREATING` - The stream is being created. Kinesis Data Streams
|
1332
1451
|
# immediately returns and sets `StreamStatus` to `CREATING`.
|
1333
1452
|
#
|
1334
1453
|
# * `DELETING` - The stream is being deleted. The specified stream is
|
1335
|
-
# in the `DELETING` state until Kinesis Streams completes the
|
1454
|
+
# in the `DELETING` state until Kinesis Data Streams completes the
|
1336
1455
|
# deletion.
|
1337
1456
|
#
|
1338
1457
|
# * `ACTIVE` - The stream exists and is ready for read and write
|
@@ -1365,11 +1484,11 @@ module Aws::Kinesis
|
|
1365
1484
|
# @return [String]
|
1366
1485
|
#
|
1367
1486
|
# @!attribute [rw] key_id
|
1368
|
-
# The GUID for the customer-managed KMS key to use for encryption.
|
1487
|
+
# The GUID for the customer-managed AWS KMS key to use for encryption.
|
1369
1488
|
# This value can be a globally unique identifier, a fully specified
|
1370
1489
|
# ARN to either an alias or a key, or an alias name prefixed by
|
1371
|
-
# "alias/".You can also use a master key owned by Kinesis
|
1372
|
-
# specifying the alias `aws/kinesis`.
|
1490
|
+
# "alias/".You can also use a master key owned by Kinesis Data
|
1491
|
+
# Streams by specifying the alias `aws/kinesis`.
|
1373
1492
|
#
|
1374
1493
|
# * Key ARN example:
|
1375
1494
|
# `arn:aws:kms:us-east-1:123456789012:key/12345678-1234-1234-1234-123456789012`
|
@@ -1382,7 +1501,7 @@ module Aws::Kinesis
|
|
1382
1501
|
#
|
1383
1502
|
# * Alias name example: `alias/MyAliasName`
|
1384
1503
|
#
|
1385
|
-
# * Master key owned by Kinesis: `alias/aws/kinesis`
|
1504
|
+
# * Master key owned by Kinesis Data Streams: `alias/aws/kinesis`
|
1386
1505
|
# @return [String]
|
1387
1506
|
#
|
1388
1507
|
# @!attribute [rw] open_shard_count
|