aws-sdk-dynamodbstreams 1.0.0.rc1 → 1.0.0.rc2
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/lib/aws-sdk-dynamodbstreams.rb +2 -2
- data/lib/aws-sdk-dynamodbstreams/client.rb +397 -346
- data/lib/aws-sdk-dynamodbstreams/client_api.rb +240 -236
- data/lib/aws-sdk-dynamodbstreams/errors.rb +4 -13
- data/lib/aws-sdk-dynamodbstreams/resource.rb +12 -14
- data/lib/aws-sdk-dynamodbstreams/types.rb +652 -553
- metadata +2 -2
@@ -1,23 +1,14 @@
|
|
1
1
|
# WARNING ABOUT GENERATED CODE
|
2
2
|
#
|
3
|
-
# This file is generated. See the contributing for
|
3
|
+
# This file is generated. See the contributing guide for more information:
|
4
4
|
# https://github.com/aws/aws-sdk-ruby/blob/master/CONTRIBUTING.md
|
5
5
|
#
|
6
6
|
# WARNING ABOUT GENERATED CODE
|
7
7
|
|
8
|
-
module Aws
|
9
|
-
module
|
10
|
-
module Errors
|
8
|
+
module Aws::DynamoDBStreams
|
9
|
+
module Errors
|
11
10
|
|
12
|
-
|
11
|
+
extend Aws::Errors::DynamicErrors
|
13
12
|
|
14
|
-
# Raised when calling #load or #data on a resource class that can not be
|
15
|
-
# loaded. This can happen when:
|
16
|
-
#
|
17
|
-
# * A resource class has identifiers, but no data attributes.
|
18
|
-
# * Resource data is only available when making an API call that
|
19
|
-
# enumerates all resources of that type.
|
20
|
-
class ResourceNotLoadable < RuntimeError; end
|
21
|
-
end
|
22
13
|
end
|
23
14
|
end
|
@@ -1,25 +1,23 @@
|
|
1
1
|
# WARNING ABOUT GENERATED CODE
|
2
2
|
#
|
3
|
-
# This file is generated. See the contributing for
|
3
|
+
# This file is generated. See the contributing guide for more information:
|
4
4
|
# https://github.com/aws/aws-sdk-ruby/blob/master/CONTRIBUTING.md
|
5
5
|
#
|
6
6
|
# WARNING ABOUT GENERATED CODE
|
7
7
|
|
8
|
-
module Aws
|
9
|
-
|
10
|
-
class Resource
|
8
|
+
module Aws::DynamoDBStreams
|
9
|
+
class Resource
|
11
10
|
|
12
|
-
|
13
|
-
|
14
|
-
|
15
|
-
|
16
|
-
|
17
|
-
|
18
|
-
# @return [Client]
|
19
|
-
def client
|
20
|
-
@client
|
21
|
-
end
|
11
|
+
# @param options ({})
|
12
|
+
# @option options [Client] :client
|
13
|
+
def initialize(options = {})
|
14
|
+
@client = options[:client] || Client.new(options)
|
15
|
+
end
|
22
16
|
|
17
|
+
# @return [Client]
|
18
|
+
def client
|
19
|
+
@client
|
23
20
|
end
|
21
|
+
|
24
22
|
end
|
25
23
|
end
|
@@ -1,579 +1,678 @@
|
|
1
1
|
# WARNING ABOUT GENERATED CODE
|
2
2
|
#
|
3
|
-
# This file is generated. See the contributing for
|
3
|
+
# This file is generated. See the contributing guide for more information:
|
4
4
|
# https://github.com/aws/aws-sdk-ruby/blob/master/CONTRIBUTING.md
|
5
5
|
#
|
6
6
|
# WARNING ABOUT GENERATED CODE
|
7
7
|
|
8
|
-
module Aws
|
9
|
-
module
|
10
|
-
module Types
|
8
|
+
module Aws::DynamoDBStreams
|
9
|
+
module Types
|
11
10
|
|
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
|
-
|
11
|
+
# Represents the data for an attribute. You can set one, and only one,
|
12
|
+
# of the elements.
|
13
|
+
#
|
14
|
+
# Each attribute in an item is a name-value pair. An attribute can be
|
15
|
+
# single-valued or multi-valued set. For example, a book item can have
|
16
|
+
# title and authors attributes. Each book has one title but can have
|
17
|
+
# many authors. The multi-valued attribute is a set; duplicate values
|
18
|
+
# are not allowed.
|
19
|
+
#
|
20
|
+
# @!attribute [rw] s
|
21
|
+
# A String data type.
|
22
|
+
# @return [String]
|
23
|
+
#
|
24
|
+
# @!attribute [rw] n
|
25
|
+
# A Number data type.
|
26
|
+
# @return [String]
|
27
|
+
#
|
28
|
+
# @!attribute [rw] b
|
29
|
+
# A Binary data type.
|
30
|
+
# @return [String]
|
31
|
+
#
|
32
|
+
# @!attribute [rw] ss
|
33
|
+
# A String Set data type.
|
34
|
+
# @return [Array<String>]
|
35
|
+
#
|
36
|
+
# @!attribute [rw] ns
|
37
|
+
# A Number Set data type.
|
38
|
+
# @return [Array<String>]
|
39
|
+
#
|
40
|
+
# @!attribute [rw] bs
|
41
|
+
# A Binary Set data type.
|
42
|
+
# @return [Array<String>]
|
43
|
+
#
|
44
|
+
# @!attribute [rw] m
|
45
|
+
# A Map data type.
|
46
|
+
# @return [Hash<String,Types::AttributeValue>]
|
47
|
+
#
|
48
|
+
# @!attribute [rw] l
|
49
|
+
# A List data type.
|
50
|
+
# @return [Array<Types::AttributeValue>]
|
51
|
+
#
|
52
|
+
# @!attribute [rw] null
|
53
|
+
# A Null data type.
|
54
|
+
# @return [Boolean]
|
55
|
+
#
|
56
|
+
# @!attribute [rw] bool
|
57
|
+
# A Boolean data type.
|
58
|
+
# @return [Boolean]
|
59
|
+
#
|
60
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/streams-dynamodb-2012-08-10/AttributeValue AWS API Documentation
|
61
|
+
#
|
62
|
+
class AttributeValue < Struct.new(
|
63
|
+
:s,
|
64
|
+
:n,
|
65
|
+
:b,
|
66
|
+
:ss,
|
67
|
+
:ns,
|
68
|
+
:bs,
|
69
|
+
:m,
|
70
|
+
:l,
|
71
|
+
:null,
|
72
|
+
:bool)
|
73
|
+
include Aws::Structure
|
74
|
+
end
|
72
75
|
|
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
|
-
|
76
|
+
# Represents the input of a `DescribeStream` operation.
|
77
|
+
#
|
78
|
+
# @note When making an API call, you may pass DescribeStreamInput
|
79
|
+
# data as a hash:
|
80
|
+
#
|
81
|
+
# {
|
82
|
+
# stream_arn: "StreamArn", # required
|
83
|
+
# limit: 1,
|
84
|
+
# exclusive_start_shard_id: "ShardId",
|
85
|
+
# }
|
86
|
+
#
|
87
|
+
# @!attribute [rw] stream_arn
|
88
|
+
# The Amazon Resource Name (ARN) for the stream.
|
89
|
+
# @return [String]
|
90
|
+
#
|
91
|
+
# @!attribute [rw] limit
|
92
|
+
# The maximum number of shard objects to return. The upper limit is
|
93
|
+
# 100.
|
94
|
+
# @return [Integer]
|
95
|
+
#
|
96
|
+
# @!attribute [rw] exclusive_start_shard_id
|
97
|
+
# The shard ID of the first item that this operation will evaluate.
|
98
|
+
# Use the value that was returned for `LastEvaluatedShardId` in the
|
99
|
+
# previous operation.
|
100
|
+
# @return [String]
|
101
|
+
#
|
102
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/streams-dynamodb-2012-08-10/DescribeStreamInput AWS API Documentation
|
103
|
+
#
|
104
|
+
class DescribeStreamInput < Struct.new(
|
105
|
+
:stream_arn,
|
106
|
+
:limit,
|
107
|
+
:exclusive_start_shard_id)
|
108
|
+
include Aws::Structure
|
109
|
+
end
|
102
110
|
|
103
|
-
|
104
|
-
|
105
|
-
|
106
|
-
|
107
|
-
|
108
|
-
|
109
|
-
|
110
|
-
|
111
|
-
|
112
|
-
|
113
|
-
|
111
|
+
# Represents the output of a `DescribeStream` operation.
|
112
|
+
#
|
113
|
+
# @!attribute [rw] stream_description
|
114
|
+
# A complete description of the stream, including its creation date
|
115
|
+
# and time, the DynamoDB table associated with the stream, the shard
|
116
|
+
# IDs within the stream, and the beginning and ending sequence numbers
|
117
|
+
# of stream records within the shards.
|
118
|
+
# @return [Types::StreamDescription]
|
119
|
+
#
|
120
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/streams-dynamodb-2012-08-10/DescribeStreamOutput AWS API Documentation
|
121
|
+
#
|
122
|
+
class DescribeStreamOutput < Struct.new(
|
123
|
+
:stream_description)
|
124
|
+
include Aws::Structure
|
125
|
+
end
|
114
126
|
|
115
|
-
|
116
|
-
|
117
|
-
|
118
|
-
|
119
|
-
|
120
|
-
|
121
|
-
|
122
|
-
|
123
|
-
|
124
|
-
|
125
|
-
|
126
|
-
|
127
|
-
|
128
|
-
|
129
|
-
|
130
|
-
|
131
|
-
|
132
|
-
|
133
|
-
|
134
|
-
|
135
|
-
|
136
|
-
|
137
|
-
|
127
|
+
# Represents the input of a `GetRecords` operation.
|
128
|
+
#
|
129
|
+
# @note When making an API call, you may pass GetRecordsInput
|
130
|
+
# data as a hash:
|
131
|
+
#
|
132
|
+
# {
|
133
|
+
# shard_iterator: "ShardIterator", # required
|
134
|
+
# limit: 1,
|
135
|
+
# }
|
136
|
+
#
|
137
|
+
# @!attribute [rw] shard_iterator
|
138
|
+
# A shard iterator that was retrieved from a previous GetShardIterator
|
139
|
+
# operation. This iterator can be used to access the stream records in
|
140
|
+
# this shard.
|
141
|
+
# @return [String]
|
142
|
+
#
|
143
|
+
# @!attribute [rw] limit
|
144
|
+
# The maximum number of records to return from the shard. The upper
|
145
|
+
# limit is 1000.
|
146
|
+
# @return [Integer]
|
147
|
+
#
|
148
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/streams-dynamodb-2012-08-10/GetRecordsInput AWS API Documentation
|
149
|
+
#
|
150
|
+
class GetRecordsInput < Struct.new(
|
151
|
+
:shard_iterator,
|
152
|
+
:limit)
|
153
|
+
include Aws::Structure
|
154
|
+
end
|
138
155
|
|
139
|
-
|
140
|
-
|
141
|
-
|
142
|
-
|
143
|
-
|
144
|
-
|
145
|
-
|
146
|
-
|
147
|
-
|
148
|
-
|
149
|
-
|
150
|
-
|
151
|
-
|
152
|
-
|
153
|
-
|
154
|
-
|
156
|
+
# Represents the output of a `GetRecords` operation.
|
157
|
+
#
|
158
|
+
# @!attribute [rw] records
|
159
|
+
# The stream records from the shard, which were retrieved using the
|
160
|
+
# shard iterator.
|
161
|
+
# @return [Array<Types::Record>]
|
162
|
+
#
|
163
|
+
# @!attribute [rw] next_shard_iterator
|
164
|
+
# The next position in the shard from which to start sequentially
|
165
|
+
# reading stream records. If set to `null`, the shard has been closed
|
166
|
+
# and the requested iterator will not return any more data.
|
167
|
+
# @return [String]
|
168
|
+
#
|
169
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/streams-dynamodb-2012-08-10/GetRecordsOutput AWS API Documentation
|
170
|
+
#
|
171
|
+
class GetRecordsOutput < Struct.new(
|
172
|
+
:records,
|
173
|
+
:next_shard_iterator)
|
174
|
+
include Aws::Structure
|
175
|
+
end
|
155
176
|
|
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
|
-
|
177
|
+
# Represents the input of a `GetShardIterator` operation.
|
178
|
+
#
|
179
|
+
# @note When making an API call, you may pass GetShardIteratorInput
|
180
|
+
# data as a hash:
|
181
|
+
#
|
182
|
+
# {
|
183
|
+
# stream_arn: "StreamArn", # required
|
184
|
+
# shard_id: "ShardId", # required
|
185
|
+
# shard_iterator_type: "TRIM_HORIZON", # required, accepts TRIM_HORIZON, LATEST, AT_SEQUENCE_NUMBER, AFTER_SEQUENCE_NUMBER
|
186
|
+
# sequence_number: "SequenceNumber",
|
187
|
+
# }
|
188
|
+
#
|
189
|
+
# @!attribute [rw] stream_arn
|
190
|
+
# The Amazon Resource Name (ARN) for the stream.
|
191
|
+
# @return [String]
|
192
|
+
#
|
193
|
+
# @!attribute [rw] shard_id
|
194
|
+
# The identifier of the shard. The iterator will be returned for this
|
195
|
+
# shard ID.
|
196
|
+
# @return [String]
|
197
|
+
#
|
198
|
+
# @!attribute [rw] shard_iterator_type
|
199
|
+
# Determines how the shard iterator is used to start reading stream
|
200
|
+
# records from the shard:
|
201
|
+
#
|
202
|
+
# * `AT_SEQUENCE_NUMBER` - Start reading exactly from the position
|
203
|
+
# denoted by a specific sequence number.
|
204
|
+
#
|
205
|
+
# * `AFTER_SEQUENCE_NUMBER` - Start reading right after the position
|
206
|
+
# denoted by a specific sequence number.
|
207
|
+
#
|
208
|
+
# * `TRIM_HORIZON` - Start reading at the last (untrimmed) stream
|
209
|
+
# record, which is the oldest record in the shard. In DynamoDB
|
210
|
+
# Streams, there is a 24 hour limit on data retention. Stream
|
211
|
+
# records whose age exceeds this limit are subject to removal
|
212
|
+
# (trimming) from the stream.
|
213
|
+
#
|
214
|
+
# * `LATEST` - Start reading just after the most recent stream record
|
215
|
+
# in the shard, so that you always read the most recent data in the
|
216
|
+
# shard.
|
217
|
+
# @return [String]
|
218
|
+
#
|
219
|
+
# @!attribute [rw] sequence_number
|
220
|
+
# The sequence number of a stream record in the shard from which to
|
221
|
+
# start reading.
|
222
|
+
# @return [String]
|
223
|
+
#
|
224
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/streams-dynamodb-2012-08-10/GetShardIteratorInput AWS API Documentation
|
225
|
+
#
|
226
|
+
class GetShardIteratorInput < Struct.new(
|
227
|
+
:stream_arn,
|
228
|
+
:shard_id,
|
229
|
+
:shard_iterator_type,
|
230
|
+
:sequence_number)
|
231
|
+
include Aws::Structure
|
232
|
+
end
|
207
233
|
|
208
|
-
|
209
|
-
|
210
|
-
|
211
|
-
|
212
|
-
|
213
|
-
|
214
|
-
|
215
|
-
|
216
|
-
|
217
|
-
|
234
|
+
# Represents the output of a `GetShardIterator` operation.
|
235
|
+
#
|
236
|
+
# @!attribute [rw] shard_iterator
|
237
|
+
# The position in the shard from which to start reading stream records
|
238
|
+
# sequentially. A shard iterator specifies this position using the
|
239
|
+
# sequence number of a stream record in a shard.
|
240
|
+
# @return [String]
|
241
|
+
#
|
242
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/streams-dynamodb-2012-08-10/GetShardIteratorOutput AWS API Documentation
|
243
|
+
#
|
244
|
+
class GetShardIteratorOutput < Struct.new(
|
245
|
+
:shard_iterator)
|
246
|
+
include Aws::Structure
|
247
|
+
end
|
218
248
|
|
219
|
-
|
220
|
-
|
221
|
-
|
222
|
-
|
223
|
-
|
224
|
-
|
225
|
-
|
226
|
-
|
227
|
-
|
228
|
-
|
229
|
-
|
230
|
-
|
231
|
-
|
232
|
-
|
233
|
-
|
234
|
-
|
235
|
-
|
236
|
-
|
237
|
-
# by the sort key value.
|
238
|
-
#
|
239
|
-
# </note>
|
240
|
-
# @!attribute [rw] attribute_name
|
241
|
-
# The name of a key attribute.
|
242
|
-
# @return [String]
|
243
|
-
#
|
244
|
-
# @!attribute [rw] key_type
|
245
|
-
# The attribute data, consisting of the data type and the attribute
|
246
|
-
# value itself.
|
247
|
-
# @return [String]
|
248
|
-
class KeySchemaElement < Struct.new(
|
249
|
-
:attribute_name,
|
250
|
-
:key_type)
|
251
|
-
include Aws::Structure
|
252
|
-
end
|
249
|
+
# Contains details about the type of identity that made the request.
|
250
|
+
#
|
251
|
+
# @!attribute [rw] principal_id
|
252
|
+
# A unique identifier for the entity that made the call. For Time To
|
253
|
+
# Live, the principalId is "dynamodb.amazonaws.com".
|
254
|
+
# @return [String]
|
255
|
+
#
|
256
|
+
# @!attribute [rw] type
|
257
|
+
# The type of the identity. For Time To Live, the type is "Service".
|
258
|
+
# @return [String]
|
259
|
+
#
|
260
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/streams-dynamodb-2012-08-10/Identity AWS API Documentation
|
261
|
+
#
|
262
|
+
class Identity < Struct.new(
|
263
|
+
:principal_id,
|
264
|
+
:type)
|
265
|
+
include Aws::Structure
|
266
|
+
end
|
253
267
|
|
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
|
-
|
268
|
+
# Represents *a single element* of a key schema. A key schema specifies
|
269
|
+
# the attributes that make up the primary key of a table, or the key
|
270
|
+
# attributes of an index.
|
271
|
+
#
|
272
|
+
# A `KeySchemaElement` represents exactly one attribute of the primary
|
273
|
+
# key. For example, a simple primary key (partition key) would be
|
274
|
+
# represented by one `KeySchemaElement`. A composite primary key
|
275
|
+
# (partition key and sort key) would require one `KeySchemaElement` for
|
276
|
+
# the partition key, and another `KeySchemaElement` for the sort key.
|
277
|
+
#
|
278
|
+
# <note markdown="1"> The partition key of an item is also known as its *hash attribute*.
|
279
|
+
# The term "hash attribute" derives from DynamoDB's usage of an
|
280
|
+
# internal hash function to evenly distribute data items across
|
281
|
+
# partitions, based on their partition key values.
|
282
|
+
#
|
283
|
+
# The sort key of an item is also known as its *range attribute*. The
|
284
|
+
# term "range attribute" derives from the way DynamoDB stores items
|
285
|
+
# with the same partition key physically close together, in sorted order
|
286
|
+
# by the sort key value.
|
287
|
+
#
|
288
|
+
# </note>
|
289
|
+
#
|
290
|
+
# @!attribute [rw] attribute_name
|
291
|
+
# The name of a key attribute.
|
292
|
+
# @return [String]
|
293
|
+
#
|
294
|
+
# @!attribute [rw] key_type
|
295
|
+
# The attribute data, consisting of the data type and the attribute
|
296
|
+
# value itself.
|
297
|
+
# @return [String]
|
298
|
+
#
|
299
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/streams-dynamodb-2012-08-10/KeySchemaElement AWS API Documentation
|
300
|
+
#
|
301
|
+
class KeySchemaElement < Struct.new(
|
302
|
+
:attribute_name,
|
303
|
+
:key_type)
|
304
|
+
include Aws::Structure
|
305
|
+
end
|
283
306
|
|
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
|
-
|
307
|
+
# Represents the input of a `ListStreams` operation.
|
308
|
+
#
|
309
|
+
# @note When making an API call, you may pass ListStreamsInput
|
310
|
+
# data as a hash:
|
311
|
+
#
|
312
|
+
# {
|
313
|
+
# table_name: "TableName",
|
314
|
+
# limit: 1,
|
315
|
+
# exclusive_start_stream_arn: "StreamArn",
|
316
|
+
# }
|
317
|
+
#
|
318
|
+
# @!attribute [rw] table_name
|
319
|
+
# If this parameter is provided, then only the streams associated with
|
320
|
+
# this table name are returned.
|
321
|
+
# @return [String]
|
322
|
+
#
|
323
|
+
# @!attribute [rw] limit
|
324
|
+
# The maximum number of streams to return. The upper limit is 100.
|
325
|
+
# @return [Integer]
|
326
|
+
#
|
327
|
+
# @!attribute [rw] exclusive_start_stream_arn
|
328
|
+
# The ARN (Amazon Resource Name) of the first item that this operation
|
329
|
+
# will evaluate. Use the value that was returned for
|
330
|
+
# `LastEvaluatedStreamArn` in the previous operation.
|
331
|
+
# @return [String]
|
332
|
+
#
|
333
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/streams-dynamodb-2012-08-10/ListStreamsInput AWS API Documentation
|
334
|
+
#
|
335
|
+
class ListStreamsInput < Struct.new(
|
336
|
+
:table_name,
|
337
|
+
:limit,
|
338
|
+
:exclusive_start_stream_arn)
|
339
|
+
include Aws::Structure
|
340
|
+
end
|
309
341
|
|
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
|
-
# The AWS service from which the stream record originated. For
|
340
|
-
# DynamoDB Streams, this is *aws:dynamodb*.
|
341
|
-
# @return [String]
|
342
|
-
#
|
343
|
-
# @!attribute [rw] aws_region
|
344
|
-
# The region in which the *GetRecords* request was received.
|
345
|
-
# @return [String]
|
346
|
-
#
|
347
|
-
# @!attribute [rw] dynamodb
|
348
|
-
# The main body of the stream record, containing all of the
|
349
|
-
# DynamoDB-specific fields.
|
350
|
-
# @return [Types::StreamRecord]
|
351
|
-
class Record < Struct.new(
|
352
|
-
:event_id,
|
353
|
-
:event_name,
|
354
|
-
:event_version,
|
355
|
-
:event_source,
|
356
|
-
:aws_region,
|
357
|
-
:dynamodb)
|
358
|
-
include Aws::Structure
|
359
|
-
end
|
342
|
+
# Represents the output of a `ListStreams` operation.
|
343
|
+
#
|
344
|
+
# @!attribute [rw] streams
|
345
|
+
# A list of stream descriptors associated with the current account and
|
346
|
+
# endpoint.
|
347
|
+
# @return [Array<Types::Stream>]
|
348
|
+
#
|
349
|
+
# @!attribute [rw] last_evaluated_stream_arn
|
350
|
+
# The stream ARN of the item where the operation stopped, inclusive of
|
351
|
+
# the previous result set. Use this value to start a new operation,
|
352
|
+
# excluding this value in the new request.
|
353
|
+
#
|
354
|
+
# If `LastEvaluatedStreamArn` is empty, then the "last page" of
|
355
|
+
# results has been processed and there is no more data to be
|
356
|
+
# retrieved.
|
357
|
+
#
|
358
|
+
# If `LastEvaluatedStreamArn` is not empty, it does not necessarily
|
359
|
+
# mean that there is more data in the result set. The only way to know
|
360
|
+
# when you have reached the end of the result set is when
|
361
|
+
# `LastEvaluatedStreamArn` is empty.
|
362
|
+
# @return [String]
|
363
|
+
#
|
364
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/streams-dynamodb-2012-08-10/ListStreamsOutput AWS API Documentation
|
365
|
+
#
|
366
|
+
class ListStreamsOutput < Struct.new(
|
367
|
+
:streams,
|
368
|
+
:last_evaluated_stream_arn)
|
369
|
+
include Aws::Structure
|
370
|
+
end
|
360
371
|
|
361
|
-
|
362
|
-
|
363
|
-
|
364
|
-
|
365
|
-
|
366
|
-
|
367
|
-
|
368
|
-
|
369
|
-
|
370
|
-
|
371
|
-
|
372
|
-
|
373
|
-
|
374
|
-
|
372
|
+
# A description of a unique event within a stream.
|
373
|
+
#
|
374
|
+
# @!attribute [rw] event_id
|
375
|
+
# A globally unique identifier for the event that was recorded in this
|
376
|
+
# stream record.
|
377
|
+
# @return [String]
|
378
|
+
#
|
379
|
+
# @!attribute [rw] event_name
|
380
|
+
# The type of data modification that was performed on the DynamoDB
|
381
|
+
# table:
|
382
|
+
#
|
383
|
+
# * `INSERT` - a new item was added to the table.
|
384
|
+
#
|
385
|
+
# * `MODIFY` - one or more of an existing item's attributes were
|
386
|
+
# modified.
|
387
|
+
#
|
388
|
+
# * `REMOVE` - the item was deleted from the table
|
389
|
+
# @return [String]
|
390
|
+
#
|
391
|
+
# @!attribute [rw] event_version
|
392
|
+
# The version number of the stream record format. This number is
|
393
|
+
# updated whenever the structure of `Record` is modified.
|
394
|
+
#
|
395
|
+
# Client applications must not assume that `eventVersion` will remain
|
396
|
+
# at a particular value, as this number is subject to change at any
|
397
|
+
# time. In general, `eventVersion` will only increase as the low-level
|
398
|
+
# DynamoDB Streams API evolves.
|
399
|
+
# @return [String]
|
400
|
+
#
|
401
|
+
# @!attribute [rw] event_source
|
402
|
+
# The AWS service from which the stream record originated. For
|
403
|
+
# DynamoDB Streams, this is `aws:dynamodb`.
|
404
|
+
# @return [String]
|
405
|
+
#
|
406
|
+
# @!attribute [rw] aws_region
|
407
|
+
# The region in which the `GetRecords` request was received.
|
408
|
+
# @return [String]
|
409
|
+
#
|
410
|
+
# @!attribute [rw] dynamodb
|
411
|
+
# The main body of the stream record, containing all of the
|
412
|
+
# DynamoDB-specific fields.
|
413
|
+
# @return [Types::StreamRecord]
|
414
|
+
#
|
415
|
+
# @!attribute [rw] user_identity
|
416
|
+
# Items that are deleted by the Time to Live process after expiration
|
417
|
+
# have the following fields:
|
418
|
+
#
|
419
|
+
# * Records\[\].userIdentity.type
|
420
|
+
#
|
421
|
+
# "Service"
|
422
|
+
#
|
423
|
+
# * Records\[\].userIdentity.principalId
|
424
|
+
#
|
425
|
+
# "dynamodb.amazonaws.com"
|
426
|
+
# @return [Types::Identity]
|
427
|
+
#
|
428
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/streams-dynamodb-2012-08-10/Record AWS API Documentation
|
429
|
+
#
|
430
|
+
class Record < Struct.new(
|
431
|
+
:event_id,
|
432
|
+
:event_name,
|
433
|
+
:event_version,
|
434
|
+
:event_source,
|
435
|
+
:aws_region,
|
436
|
+
:dynamodb,
|
437
|
+
:user_identity)
|
438
|
+
include Aws::Structure
|
439
|
+
end
|
375
440
|
|
376
|
-
|
377
|
-
|
378
|
-
|
379
|
-
|
380
|
-
|
381
|
-
|
382
|
-
|
383
|
-
|
384
|
-
|
385
|
-
|
386
|
-
|
387
|
-
|
388
|
-
|
389
|
-
|
390
|
-
|
391
|
-
|
392
|
-
|
393
|
-
|
441
|
+
# The beginning and ending sequence numbers for the stream records
|
442
|
+
# contained within a shard.
|
443
|
+
#
|
444
|
+
# @!attribute [rw] starting_sequence_number
|
445
|
+
# The first sequence number.
|
446
|
+
# @return [String]
|
447
|
+
#
|
448
|
+
# @!attribute [rw] ending_sequence_number
|
449
|
+
# The last sequence number.
|
450
|
+
# @return [String]
|
451
|
+
#
|
452
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/streams-dynamodb-2012-08-10/SequenceNumberRange AWS API Documentation
|
453
|
+
#
|
454
|
+
class SequenceNumberRange < Struct.new(
|
455
|
+
:starting_sequence_number,
|
456
|
+
:ending_sequence_number)
|
457
|
+
include Aws::Structure
|
458
|
+
end
|
394
459
|
|
395
|
-
|
396
|
-
|
397
|
-
|
398
|
-
|
399
|
-
|
400
|
-
|
401
|
-
|
402
|
-
|
403
|
-
|
404
|
-
|
405
|
-
|
406
|
-
|
407
|
-
|
408
|
-
|
409
|
-
|
410
|
-
|
411
|
-
|
412
|
-
|
413
|
-
|
414
|
-
|
415
|
-
|
416
|
-
|
417
|
-
# @return [String]
|
418
|
-
class Stream < Struct.new(
|
419
|
-
:stream_arn,
|
420
|
-
:table_name,
|
421
|
-
:stream_label)
|
422
|
-
include Aws::Structure
|
423
|
-
end
|
460
|
+
# A uniquely identified group of stream records within a stream.
|
461
|
+
#
|
462
|
+
# @!attribute [rw] shard_id
|
463
|
+
# The system-generated identifier for this shard.
|
464
|
+
# @return [String]
|
465
|
+
#
|
466
|
+
# @!attribute [rw] sequence_number_range
|
467
|
+
# The range of possible sequence numbers for the shard.
|
468
|
+
# @return [Types::SequenceNumberRange]
|
469
|
+
#
|
470
|
+
# @!attribute [rw] parent_shard_id
|
471
|
+
# The shard ID of the current shard's parent.
|
472
|
+
# @return [String]
|
473
|
+
#
|
474
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/streams-dynamodb-2012-08-10/Shard AWS API Documentation
|
475
|
+
#
|
476
|
+
class Shard < Struct.new(
|
477
|
+
:shard_id,
|
478
|
+
:sequence_number_range,
|
479
|
+
:parent_shard_id)
|
480
|
+
include Aws::Structure
|
481
|
+
end
|
424
482
|
|
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
|
-
# @!attribute [rw] stream_view_type
|
460
|
-
# Indicates the format of the records within this stream:
|
461
|
-
#
|
462
|
-
# * `KEYS_ONLY` - only the key attributes of items that were modified
|
463
|
-
# in the DynamoDB table.
|
464
|
-
#
|
465
|
-
# * `NEW_IMAGE` - entire items from the table, as they appeared after
|
466
|
-
# they were modified.
|
467
|
-
#
|
468
|
-
# * `OLD_IMAGE` - entire items from the table, as they appeared before
|
469
|
-
# they were modified.
|
470
|
-
#
|
471
|
-
# * `NEW_AND_OLD_IMAGES` - both the new and the old images of the
|
472
|
-
# items from the table.
|
473
|
-
# @return [String]
|
474
|
-
#
|
475
|
-
# @!attribute [rw] creation_request_date_time
|
476
|
-
# The date and time when the request to create this stream was issued.
|
477
|
-
# @return [Time]
|
478
|
-
#
|
479
|
-
# @!attribute [rw] table_name
|
480
|
-
# The DynamoDB table with which the stream is associated.
|
481
|
-
# @return [String]
|
482
|
-
#
|
483
|
-
# @!attribute [rw] key_schema
|
484
|
-
# The key attribute(s) of the stream's DynamoDB table.
|
485
|
-
# @return [Array<Types::KeySchemaElement>]
|
486
|
-
#
|
487
|
-
# @!attribute [rw] shards
|
488
|
-
# The shards that comprise the stream.
|
489
|
-
# @return [Array<Types::Shard>]
|
490
|
-
#
|
491
|
-
# @!attribute [rw] last_evaluated_shard_id
|
492
|
-
# The shard ID of the item where the operation stopped, inclusive of
|
493
|
-
# the previous result set. Use this value to start a new operation,
|
494
|
-
# excluding this value in the new request.
|
495
|
-
#
|
496
|
-
# If `LastEvaluatedShardId` is empty, then the "last page" of
|
497
|
-
# results has been processed and there is currently no more data to be
|
498
|
-
# retrieved.
|
499
|
-
#
|
500
|
-
# If `LastEvaluatedShardId` is not empty, it does not necessarily mean
|
501
|
-
# that there is more data in the result set. The only way to know when
|
502
|
-
# you have reached the end of the result set is when
|
503
|
-
# `LastEvaluatedShardId` is empty.
|
504
|
-
# @return [String]
|
505
|
-
class StreamDescription < Struct.new(
|
506
|
-
:stream_arn,
|
507
|
-
:stream_label,
|
508
|
-
:stream_status,
|
509
|
-
:stream_view_type,
|
510
|
-
:creation_request_date_time,
|
511
|
-
:table_name,
|
512
|
-
:key_schema,
|
513
|
-
:shards,
|
514
|
-
:last_evaluated_shard_id)
|
515
|
-
include Aws::Structure
|
516
|
-
end
|
483
|
+
# Represents all of the data describing a particular stream.
|
484
|
+
#
|
485
|
+
# @!attribute [rw] stream_arn
|
486
|
+
# The Amazon Resource Name (ARN) for the stream.
|
487
|
+
# @return [String]
|
488
|
+
#
|
489
|
+
# @!attribute [rw] table_name
|
490
|
+
# The DynamoDB table with which the stream is associated.
|
491
|
+
# @return [String]
|
492
|
+
#
|
493
|
+
# @!attribute [rw] stream_label
|
494
|
+
# A timestamp, in ISO 8601 format, for this stream.
|
495
|
+
#
|
496
|
+
# Note that `LatestStreamLabel` is not a unique identifier for the
|
497
|
+
# stream, because it is possible that a stream from another table
|
498
|
+
# might have the same timestamp. However, the combination of the
|
499
|
+
# following three elements is guaranteed to be unique:
|
500
|
+
#
|
501
|
+
# * the AWS customer ID.
|
502
|
+
#
|
503
|
+
# * the table name
|
504
|
+
#
|
505
|
+
# * the `StreamLabel`
|
506
|
+
# @return [String]
|
507
|
+
#
|
508
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/streams-dynamodb-2012-08-10/Stream AWS API Documentation
|
509
|
+
#
|
510
|
+
class Stream < Struct.new(
|
511
|
+
:stream_arn,
|
512
|
+
:table_name,
|
513
|
+
:stream_label)
|
514
|
+
include Aws::Structure
|
515
|
+
end
|
517
516
|
|
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
|
-
|
517
|
+
# Represents all of the data describing a particular stream.
|
518
|
+
#
|
519
|
+
# @!attribute [rw] stream_arn
|
520
|
+
# The Amazon Resource Name (ARN) for the stream.
|
521
|
+
# @return [String]
|
522
|
+
#
|
523
|
+
# @!attribute [rw] stream_label
|
524
|
+
# A timestamp, in ISO 8601 format, for this stream.
|
525
|
+
#
|
526
|
+
# Note that `LatestStreamLabel` is not a unique identifier for the
|
527
|
+
# stream, because it is possible that a stream from another table
|
528
|
+
# might have the same timestamp. However, the combination of the
|
529
|
+
# following three elements is guaranteed to be unique:
|
530
|
+
#
|
531
|
+
# * the AWS customer ID.
|
532
|
+
#
|
533
|
+
# * the table name
|
534
|
+
#
|
535
|
+
# * the `StreamLabel`
|
536
|
+
# @return [String]
|
537
|
+
#
|
538
|
+
# @!attribute [rw] stream_status
|
539
|
+
# Indicates the current status of the stream:
|
540
|
+
#
|
541
|
+
# * `ENABLING` - Streams is currently being enabled on the DynamoDB
|
542
|
+
# table.
|
543
|
+
#
|
544
|
+
# * `ENABLED` - the stream is enabled.
|
545
|
+
#
|
546
|
+
# * `DISABLING` - Streams is currently being disabled on the DynamoDB
|
547
|
+
# table.
|
548
|
+
#
|
549
|
+
# * `DISABLED` - the stream is disabled.
|
550
|
+
# @return [String]
|
551
|
+
#
|
552
|
+
# @!attribute [rw] stream_view_type
|
553
|
+
# Indicates the format of the records within this stream:
|
554
|
+
#
|
555
|
+
# * `KEYS_ONLY` - only the key attributes of items that were modified
|
556
|
+
# in the DynamoDB table.
|
557
|
+
#
|
558
|
+
# * `NEW_IMAGE` - entire items from the table, as they appeared after
|
559
|
+
# they were modified.
|
560
|
+
#
|
561
|
+
# * `OLD_IMAGE` - entire items from the table, as they appeared before
|
562
|
+
# they were modified.
|
563
|
+
#
|
564
|
+
# * `NEW_AND_OLD_IMAGES` - both the new and the old images of the
|
565
|
+
# items from the table.
|
566
|
+
# @return [String]
|
567
|
+
#
|
568
|
+
# @!attribute [rw] creation_request_date_time
|
569
|
+
# The date and time when the request to create this stream was issued.
|
570
|
+
# @return [Time]
|
571
|
+
#
|
572
|
+
# @!attribute [rw] table_name
|
573
|
+
# The DynamoDB table with which the stream is associated.
|
574
|
+
# @return [String]
|
575
|
+
#
|
576
|
+
# @!attribute [rw] key_schema
|
577
|
+
# The key attribute(s) of the stream's DynamoDB table.
|
578
|
+
# @return [Array<Types::KeySchemaElement>]
|
579
|
+
#
|
580
|
+
# @!attribute [rw] shards
|
581
|
+
# The shards that comprise the stream.
|
582
|
+
# @return [Array<Types::Shard>]
|
583
|
+
#
|
584
|
+
# @!attribute [rw] last_evaluated_shard_id
|
585
|
+
# The shard ID of the item where the operation stopped, inclusive of
|
586
|
+
# the previous result set. Use this value to start a new operation,
|
587
|
+
# excluding this value in the new request.
|
588
|
+
#
|
589
|
+
# If `LastEvaluatedShardId` is empty, then the "last page" of
|
590
|
+
# results has been processed and there is currently no more data to be
|
591
|
+
# retrieved.
|
592
|
+
#
|
593
|
+
# If `LastEvaluatedShardId` is not empty, it does not necessarily mean
|
594
|
+
# that there is more data in the result set. The only way to know when
|
595
|
+
# you have reached the end of the result set is when
|
596
|
+
# `LastEvaluatedShardId` is empty.
|
597
|
+
# @return [String]
|
598
|
+
#
|
599
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/streams-dynamodb-2012-08-10/StreamDescription AWS API Documentation
|
600
|
+
#
|
601
|
+
class StreamDescription < Struct.new(
|
602
|
+
:stream_arn,
|
603
|
+
:stream_label,
|
604
|
+
:stream_status,
|
605
|
+
:stream_view_type,
|
606
|
+
:creation_request_date_time,
|
607
|
+
:table_name,
|
608
|
+
:key_schema,
|
609
|
+
:shards,
|
610
|
+
:last_evaluated_shard_id)
|
611
|
+
include Aws::Structure
|
612
|
+
end
|
576
613
|
|
614
|
+
# A description of a single data modification that was performed on an
|
615
|
+
# item in a DynamoDB table.
|
616
|
+
#
|
617
|
+
# @!attribute [rw] approximate_creation_date_time
|
618
|
+
# The approximate date and time when the stream record was created, in
|
619
|
+
# [UNIX epoch time][1] format.
|
620
|
+
#
|
621
|
+
#
|
622
|
+
#
|
623
|
+
# [1]: http://www.epochconverter.com/
|
624
|
+
# @return [Time]
|
625
|
+
#
|
626
|
+
# @!attribute [rw] keys
|
627
|
+
# The primary key attribute(s) for the DynamoDB item that was
|
628
|
+
# modified.
|
629
|
+
# @return [Hash<String,Types::AttributeValue>]
|
630
|
+
#
|
631
|
+
# @!attribute [rw] new_image
|
632
|
+
# The item in the DynamoDB table as it appeared after it was modified.
|
633
|
+
# @return [Hash<String,Types::AttributeValue>]
|
634
|
+
#
|
635
|
+
# @!attribute [rw] old_image
|
636
|
+
# The item in the DynamoDB table as it appeared before it was
|
637
|
+
# modified.
|
638
|
+
# @return [Hash<String,Types::AttributeValue>]
|
639
|
+
#
|
640
|
+
# @!attribute [rw] sequence_number
|
641
|
+
# The sequence number of the stream record.
|
642
|
+
# @return [String]
|
643
|
+
#
|
644
|
+
# @!attribute [rw] size_bytes
|
645
|
+
# The size of the stream record, in bytes.
|
646
|
+
# @return [Integer]
|
647
|
+
#
|
648
|
+
# @!attribute [rw] stream_view_type
|
649
|
+
# The type of data from the modified DynamoDB item that was captured
|
650
|
+
# in this stream record:
|
651
|
+
#
|
652
|
+
# * `KEYS_ONLY` - only the key attributes of the modified item.
|
653
|
+
#
|
654
|
+
# * `NEW_IMAGE` - the entire item, as it appeared after it was
|
655
|
+
# modified.
|
656
|
+
#
|
657
|
+
# * `OLD_IMAGE` - the entire item, as it appeared before it was
|
658
|
+
# modified.
|
659
|
+
#
|
660
|
+
# * `NEW_AND_OLD_IMAGES` - both the new and the old item images of the
|
661
|
+
# item.
|
662
|
+
# @return [String]
|
663
|
+
#
|
664
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/streams-dynamodb-2012-08-10/StreamRecord AWS API Documentation
|
665
|
+
#
|
666
|
+
class StreamRecord < Struct.new(
|
667
|
+
:approximate_creation_date_time,
|
668
|
+
:keys,
|
669
|
+
:new_image,
|
670
|
+
:old_image,
|
671
|
+
:sequence_number,
|
672
|
+
:size_bytes,
|
673
|
+
:stream_view_type)
|
674
|
+
include Aws::Structure
|
577
675
|
end
|
676
|
+
|
578
677
|
end
|
579
678
|
end
|