@aws-sdk/client-dynamodb-streams 3.296.0 → 3.297.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.
- package/dist-types/DynamoDBStreams.d.ts +5 -0
- package/dist-types/DynamoDBStreamsClient.d.ts +24 -4
- package/dist-types/commands/DescribeStreamCommand.d.ts +16 -0
- package/dist-types/commands/GetRecordsCommand.d.ts +16 -0
- package/dist-types/commands/GetShardIteratorCommand.d.ts +16 -0
- package/dist-types/commands/ListStreamsCommand.d.ts +16 -0
- package/dist-types/models/DynamoDBStreamsServiceException.d.ts +2 -0
- package/dist-types/models/models_0.d.ts +42 -2
- package/package.json +3 -3
|
@@ -5,6 +5,7 @@ import { GetShardIteratorCommandInput, GetShardIteratorCommandOutput } from "./c
|
|
|
5
5
|
import { ListStreamsCommandInput, ListStreamsCommandOutput } from "./commands/ListStreamsCommand";
|
|
6
6
|
import { DynamoDBStreamsClient } from "./DynamoDBStreamsClient";
|
|
7
7
|
/**
|
|
8
|
+
* @public
|
|
8
9
|
* <fullname>Amazon DynamoDB</fullname>
|
|
9
10
|
*
|
|
10
11
|
* <p>Amazon DynamoDB Streams provides API actions for accessing streams and processing
|
|
@@ -14,6 +15,7 @@ import { DynamoDBStreamsClient } from "./DynamoDBStreamsClient";
|
|
|
14
15
|
*/
|
|
15
16
|
export declare class DynamoDBStreams extends DynamoDBStreamsClient {
|
|
16
17
|
/**
|
|
18
|
+
* @public
|
|
17
19
|
* <p>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.</p>
|
|
18
20
|
* <note>
|
|
19
21
|
* <p>You can call <code>DescribeStream</code> at a maximum rate of 10 times per second.</p>
|
|
@@ -28,6 +30,7 @@ export declare class DynamoDBStreams extends DynamoDBStreamsClient {
|
|
|
28
30
|
describeStream(args: DescribeStreamCommandInput, cb: (err: any, data?: DescribeStreamCommandOutput) => void): void;
|
|
29
31
|
describeStream(args: DescribeStreamCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeStreamCommandOutput) => void): void;
|
|
30
32
|
/**
|
|
33
|
+
* @public
|
|
31
34
|
* <p>Retrieves the stream records from a given shard.</p>
|
|
32
35
|
* <p>Specify a shard iterator using the <code>ShardIterator</code> parameter. The shard iterator
|
|
33
36
|
* specifies the position in the shard from which you want to start reading stream records
|
|
@@ -44,6 +47,7 @@ export declare class DynamoDBStreams extends DynamoDBStreamsClient {
|
|
|
44
47
|
getRecords(args: GetRecordsCommandInput, cb: (err: any, data?: GetRecordsCommandOutput) => void): void;
|
|
45
48
|
getRecords(args: GetRecordsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetRecordsCommandOutput) => void): void;
|
|
46
49
|
/**
|
|
50
|
+
* @public
|
|
47
51
|
* <p>Returns a shard iterator. A shard iterator provides information
|
|
48
52
|
* about how to retrieve the stream records from within a shard. Use
|
|
49
53
|
* the shard iterator in a subsequent
|
|
@@ -57,6 +61,7 @@ export declare class DynamoDBStreams extends DynamoDBStreamsClient {
|
|
|
57
61
|
getShardIterator(args: GetShardIteratorCommandInput, cb: (err: any, data?: GetShardIteratorCommandOutput) => void): void;
|
|
58
62
|
getShardIterator(args: GetShardIteratorCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetShardIteratorCommandOutput) => void): void;
|
|
59
63
|
/**
|
|
64
|
+
* @public
|
|
60
65
|
* <p>Returns an array of stream ARNs associated with the current account and endpoint. If the
|
|
61
66
|
* <code>TableName</code> parameter is present, then <code>ListStreams</code> will return only the
|
|
62
67
|
* streams ARNs for that table.</p>
|
|
@@ -12,15 +12,24 @@ import { GetRecordsCommandInput, GetRecordsCommandOutput } from "./commands/GetR
|
|
|
12
12
|
import { GetShardIteratorCommandInput, GetShardIteratorCommandOutput } from "./commands/GetShardIteratorCommand";
|
|
13
13
|
import { ListStreamsCommandInput, ListStreamsCommandOutput } from "./commands/ListStreamsCommand";
|
|
14
14
|
import { ClientInputEndpointParameters, ClientResolvedEndpointParameters, EndpointParameters } from "./endpoint/EndpointParameters";
|
|
15
|
+
/**
|
|
16
|
+
* @public
|
|
17
|
+
*/
|
|
15
18
|
export type ServiceInputTypes = DescribeStreamCommandInput | GetRecordsCommandInput | GetShardIteratorCommandInput | ListStreamsCommandInput;
|
|
19
|
+
/**
|
|
20
|
+
* @public
|
|
21
|
+
*/
|
|
16
22
|
export type ServiceOutputTypes = DescribeStreamCommandOutput | GetRecordsCommandOutput | GetShardIteratorCommandOutput | ListStreamsCommandOutput;
|
|
23
|
+
/**
|
|
24
|
+
* @public
|
|
25
|
+
*/
|
|
17
26
|
export interface ClientDefaults extends Partial<__SmithyResolvedConfiguration<__HttpHandlerOptions>> {
|
|
18
27
|
/**
|
|
19
28
|
* The HTTP handler to use. Fetch in browser and Https in Nodejs.
|
|
20
29
|
*/
|
|
21
30
|
requestHandler?: __HttpHandler;
|
|
22
31
|
/**
|
|
23
|
-
* A constructor for a class implementing the {@link
|
|
32
|
+
* A constructor for a class implementing the {@link @aws-sdk/types#ChecksumConstructor} interface
|
|
24
33
|
* that computes the SHA-256 HMAC or checksum of a string or binary buffer.
|
|
25
34
|
* @internal
|
|
26
35
|
*/
|
|
@@ -110,23 +119,34 @@ export interface ClientDefaults extends Partial<__SmithyResolvedConfiguration<__
|
|
|
110
119
|
*/
|
|
111
120
|
logger?: __Logger;
|
|
112
121
|
/**
|
|
113
|
-
* The {@link
|
|
122
|
+
* The {@link @aws-sdk/smithy-client#DefaultsMode} that will be used to determine how certain default configuration options are resolved in the SDK.
|
|
114
123
|
*/
|
|
115
124
|
defaultsMode?: __DefaultsMode | __Provider<__DefaultsMode>;
|
|
116
125
|
}
|
|
126
|
+
/**
|
|
127
|
+
* @public
|
|
128
|
+
*/
|
|
117
129
|
type DynamoDBStreamsClientConfigType = Partial<__SmithyConfiguration<__HttpHandlerOptions>> & ClientDefaults & RegionInputConfig & EndpointInputConfig<EndpointParameters> & RetryInputConfig & HostHeaderInputConfig & AwsAuthInputConfig & UserAgentInputConfig & ClientInputEndpointParameters;
|
|
118
130
|
/**
|
|
119
|
-
*
|
|
131
|
+
* @public
|
|
132
|
+
*
|
|
133
|
+
* The configuration interface of DynamoDBStreamsClient class constructor that set the region, credentials and other options.
|
|
120
134
|
*/
|
|
121
135
|
export interface DynamoDBStreamsClientConfig extends DynamoDBStreamsClientConfigType {
|
|
122
136
|
}
|
|
137
|
+
/**
|
|
138
|
+
* @public
|
|
139
|
+
*/
|
|
123
140
|
type DynamoDBStreamsClientResolvedConfigType = __SmithyResolvedConfiguration<__HttpHandlerOptions> & Required<ClientDefaults> & RegionResolvedConfig & EndpointResolvedConfig<EndpointParameters> & RetryResolvedConfig & HostHeaderResolvedConfig & AwsAuthResolvedConfig & UserAgentResolvedConfig & ClientResolvedEndpointParameters;
|
|
124
141
|
/**
|
|
125
|
-
*
|
|
142
|
+
* @public
|
|
143
|
+
*
|
|
144
|
+
* The resolved configuration interface of DynamoDBStreamsClient class. This is resolved and normalized from the {@link DynamoDBStreamsClientConfig | constructor configuration interface}.
|
|
126
145
|
*/
|
|
127
146
|
export interface DynamoDBStreamsClientResolvedConfig extends DynamoDBStreamsClientResolvedConfigType {
|
|
128
147
|
}
|
|
129
148
|
/**
|
|
149
|
+
* @public
|
|
130
150
|
* <fullname>Amazon DynamoDB</fullname>
|
|
131
151
|
*
|
|
132
152
|
* <p>Amazon DynamoDB Streams provides API actions for accessing streams and processing
|
|
@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
|
|
|
4
4
|
import { DynamoDBStreamsClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../DynamoDBStreamsClient";
|
|
5
5
|
import { DescribeStreamInput, DescribeStreamOutput } from "../models/models_0";
|
|
6
6
|
/**
|
|
7
|
+
* @public
|
|
8
|
+
*
|
|
7
9
|
* The input for {@link DescribeStreamCommand}.
|
|
8
10
|
*/
|
|
9
11
|
export interface DescribeStreamCommandInput extends DescribeStreamInput {
|
|
10
12
|
}
|
|
11
13
|
/**
|
|
14
|
+
* @public
|
|
15
|
+
*
|
|
12
16
|
* The output of {@link DescribeStreamCommand}.
|
|
13
17
|
*/
|
|
14
18
|
export interface DescribeStreamCommandOutput extends DescribeStreamOutput, __MetadataBearer {
|
|
15
19
|
}
|
|
16
20
|
/**
|
|
21
|
+
* @public
|
|
17
22
|
* <p>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.</p>
|
|
18
23
|
* <note>
|
|
19
24
|
* <p>You can call <code>DescribeStream</code> at a maximum rate of 10 times per second.</p>
|
|
@@ -33,6 +38,8 @@ export interface DescribeStreamCommandOutput extends DescribeStreamOutput, __Met
|
|
|
33
38
|
* const response = await client.send(command);
|
|
34
39
|
* ```
|
|
35
40
|
*
|
|
41
|
+
* @param DescribeStreamCommandInput - {@link DescribeStreamCommandInput}
|
|
42
|
+
* @returns {@link DescribeStreamCommandOutput}
|
|
36
43
|
* @see {@link DescribeStreamCommandInput} for command's `input` shape.
|
|
37
44
|
* @see {@link DescribeStreamCommandOutput} for command's `response` shape.
|
|
38
45
|
* @see {@link DynamoDBStreamsClientResolvedConfig | config} for DynamoDBStreamsClient's `config` shape.
|
|
@@ -115,11 +122,20 @@ export interface DescribeStreamCommandOutput extends DescribeStreamOutput, __Met
|
|
|
115
122
|
export declare class DescribeStreamCommand extends $Command<DescribeStreamCommandInput, DescribeStreamCommandOutput, DynamoDBStreamsClientResolvedConfig> {
|
|
116
123
|
readonly input: DescribeStreamCommandInput;
|
|
117
124
|
static getEndpointParameterInstructions(): EndpointParameterInstructions;
|
|
125
|
+
/**
|
|
126
|
+
* @public
|
|
127
|
+
*/
|
|
118
128
|
constructor(input: DescribeStreamCommandInput);
|
|
119
129
|
/**
|
|
120
130
|
* @internal
|
|
121
131
|
*/
|
|
122
132
|
resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: DynamoDBStreamsClientResolvedConfig, options?: __HttpHandlerOptions): Handler<DescribeStreamCommandInput, DescribeStreamCommandOutput>;
|
|
133
|
+
/**
|
|
134
|
+
* @internal
|
|
135
|
+
*/
|
|
123
136
|
private serialize;
|
|
137
|
+
/**
|
|
138
|
+
* @internal
|
|
139
|
+
*/
|
|
124
140
|
private deserialize;
|
|
125
141
|
}
|
|
@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
|
|
|
4
4
|
import { DynamoDBStreamsClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../DynamoDBStreamsClient";
|
|
5
5
|
import { GetRecordsInput, GetRecordsOutput } from "../models/models_0";
|
|
6
6
|
/**
|
|
7
|
+
* @public
|
|
8
|
+
*
|
|
7
9
|
* The input for {@link GetRecordsCommand}.
|
|
8
10
|
*/
|
|
9
11
|
export interface GetRecordsCommandInput extends GetRecordsInput {
|
|
10
12
|
}
|
|
11
13
|
/**
|
|
14
|
+
* @public
|
|
15
|
+
*
|
|
12
16
|
* The output of {@link GetRecordsCommand}.
|
|
13
17
|
*/
|
|
14
18
|
export interface GetRecordsCommandOutput extends GetRecordsOutput, __MetadataBearer {
|
|
15
19
|
}
|
|
16
20
|
/**
|
|
21
|
+
* @public
|
|
17
22
|
* <p>Retrieves the stream records from a given shard.</p>
|
|
18
23
|
* <p>Specify a shard iterator using the <code>ShardIterator</code> parameter. The shard iterator
|
|
19
24
|
* specifies the position in the shard from which you want to start reading stream records
|
|
@@ -35,6 +40,8 @@ export interface GetRecordsCommandOutput extends GetRecordsOutput, __MetadataBea
|
|
|
35
40
|
* const response = await client.send(command);
|
|
36
41
|
* ```
|
|
37
42
|
*
|
|
43
|
+
* @param GetRecordsCommandInput - {@link GetRecordsCommandInput}
|
|
44
|
+
* @returns {@link GetRecordsCommandOutput}
|
|
38
45
|
* @see {@link GetRecordsCommandInput} for command's `input` shape.
|
|
39
46
|
* @see {@link GetRecordsCommandOutput} for command's `response` shape.
|
|
40
47
|
* @see {@link DynamoDBStreamsClientResolvedConfig | config} for DynamoDBStreamsClient's `config` shape.
|
|
@@ -165,11 +172,20 @@ export interface GetRecordsCommandOutput extends GetRecordsOutput, __MetadataBea
|
|
|
165
172
|
export declare class GetRecordsCommand extends $Command<GetRecordsCommandInput, GetRecordsCommandOutput, DynamoDBStreamsClientResolvedConfig> {
|
|
166
173
|
readonly input: GetRecordsCommandInput;
|
|
167
174
|
static getEndpointParameterInstructions(): EndpointParameterInstructions;
|
|
175
|
+
/**
|
|
176
|
+
* @public
|
|
177
|
+
*/
|
|
168
178
|
constructor(input: GetRecordsCommandInput);
|
|
169
179
|
/**
|
|
170
180
|
* @internal
|
|
171
181
|
*/
|
|
172
182
|
resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: DynamoDBStreamsClientResolvedConfig, options?: __HttpHandlerOptions): Handler<GetRecordsCommandInput, GetRecordsCommandOutput>;
|
|
183
|
+
/**
|
|
184
|
+
* @internal
|
|
185
|
+
*/
|
|
173
186
|
private serialize;
|
|
187
|
+
/**
|
|
188
|
+
* @internal
|
|
189
|
+
*/
|
|
174
190
|
private deserialize;
|
|
175
191
|
}
|
|
@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
|
|
|
4
4
|
import { DynamoDBStreamsClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../DynamoDBStreamsClient";
|
|
5
5
|
import { GetShardIteratorInput, GetShardIteratorOutput } from "../models/models_0";
|
|
6
6
|
/**
|
|
7
|
+
* @public
|
|
8
|
+
*
|
|
7
9
|
* The input for {@link GetShardIteratorCommand}.
|
|
8
10
|
*/
|
|
9
11
|
export interface GetShardIteratorCommandInput extends GetShardIteratorInput {
|
|
10
12
|
}
|
|
11
13
|
/**
|
|
14
|
+
* @public
|
|
15
|
+
*
|
|
12
16
|
* The output of {@link GetShardIteratorCommand}.
|
|
13
17
|
*/
|
|
14
18
|
export interface GetShardIteratorCommandOutput extends GetShardIteratorOutput, __MetadataBearer {
|
|
15
19
|
}
|
|
16
20
|
/**
|
|
21
|
+
* @public
|
|
17
22
|
* <p>Returns a shard iterator. A shard iterator provides information
|
|
18
23
|
* about how to retrieve the stream records from within a shard. Use
|
|
19
24
|
* the shard iterator in a subsequent
|
|
@@ -32,6 +37,8 @@ export interface GetShardIteratorCommandOutput extends GetShardIteratorOutput, _
|
|
|
32
37
|
* const response = await client.send(command);
|
|
33
38
|
* ```
|
|
34
39
|
*
|
|
40
|
+
* @param GetShardIteratorCommandInput - {@link GetShardIteratorCommandInput}
|
|
41
|
+
* @returns {@link GetShardIteratorCommandOutput}
|
|
35
42
|
* @see {@link GetShardIteratorCommandInput} for command's `input` shape.
|
|
36
43
|
* @see {@link GetShardIteratorCommandOutput} for command's `response` shape.
|
|
37
44
|
* @see {@link DynamoDBStreamsClientResolvedConfig | config} for DynamoDBStreamsClient's `config` shape.
|
|
@@ -81,11 +88,20 @@ export interface GetShardIteratorCommandOutput extends GetShardIteratorOutput, _
|
|
|
81
88
|
export declare class GetShardIteratorCommand extends $Command<GetShardIteratorCommandInput, GetShardIteratorCommandOutput, DynamoDBStreamsClientResolvedConfig> {
|
|
82
89
|
readonly input: GetShardIteratorCommandInput;
|
|
83
90
|
static getEndpointParameterInstructions(): EndpointParameterInstructions;
|
|
91
|
+
/**
|
|
92
|
+
* @public
|
|
93
|
+
*/
|
|
84
94
|
constructor(input: GetShardIteratorCommandInput);
|
|
85
95
|
/**
|
|
86
96
|
* @internal
|
|
87
97
|
*/
|
|
88
98
|
resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: DynamoDBStreamsClientResolvedConfig, options?: __HttpHandlerOptions): Handler<GetShardIteratorCommandInput, GetShardIteratorCommandOutput>;
|
|
99
|
+
/**
|
|
100
|
+
* @internal
|
|
101
|
+
*/
|
|
89
102
|
private serialize;
|
|
103
|
+
/**
|
|
104
|
+
* @internal
|
|
105
|
+
*/
|
|
90
106
|
private deserialize;
|
|
91
107
|
}
|
|
@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
|
|
|
4
4
|
import { DynamoDBStreamsClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../DynamoDBStreamsClient";
|
|
5
5
|
import { ListStreamsInput, ListStreamsOutput } from "../models/models_0";
|
|
6
6
|
/**
|
|
7
|
+
* @public
|
|
8
|
+
*
|
|
7
9
|
* The input for {@link ListStreamsCommand}.
|
|
8
10
|
*/
|
|
9
11
|
export interface ListStreamsCommandInput extends ListStreamsInput {
|
|
10
12
|
}
|
|
11
13
|
/**
|
|
14
|
+
* @public
|
|
15
|
+
*
|
|
12
16
|
* The output of {@link ListStreamsCommand}.
|
|
13
17
|
*/
|
|
14
18
|
export interface ListStreamsCommandOutput extends ListStreamsOutput, __MetadataBearer {
|
|
15
19
|
}
|
|
16
20
|
/**
|
|
21
|
+
* @public
|
|
17
22
|
* <p>Returns an array of stream ARNs associated with the current account and endpoint. If the
|
|
18
23
|
* <code>TableName</code> parameter is present, then <code>ListStreams</code> will return only the
|
|
19
24
|
* streams ARNs for that table.</p>
|
|
@@ -30,6 +35,8 @@ export interface ListStreamsCommandOutput extends ListStreamsOutput, __MetadataB
|
|
|
30
35
|
* const response = await client.send(command);
|
|
31
36
|
* ```
|
|
32
37
|
*
|
|
38
|
+
* @param ListStreamsCommandInput - {@link ListStreamsCommandInput}
|
|
39
|
+
* @returns {@link ListStreamsCommandOutput}
|
|
33
40
|
* @see {@link ListStreamsCommandInput} for command's `input` shape.
|
|
34
41
|
* @see {@link ListStreamsCommandOutput} for command's `response` shape.
|
|
35
42
|
* @see {@link DynamoDBStreamsClientResolvedConfig | config} for DynamoDBStreamsClient's `config` shape.
|
|
@@ -77,11 +84,20 @@ export interface ListStreamsCommandOutput extends ListStreamsOutput, __MetadataB
|
|
|
77
84
|
export declare class ListStreamsCommand extends $Command<ListStreamsCommandInput, ListStreamsCommandOutput, DynamoDBStreamsClientResolvedConfig> {
|
|
78
85
|
readonly input: ListStreamsCommandInput;
|
|
79
86
|
static getEndpointParameterInstructions(): EndpointParameterInstructions;
|
|
87
|
+
/**
|
|
88
|
+
* @public
|
|
89
|
+
*/
|
|
80
90
|
constructor(input: ListStreamsCommandInput);
|
|
81
91
|
/**
|
|
82
92
|
* @internal
|
|
83
93
|
*/
|
|
84
94
|
resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: DynamoDBStreamsClientResolvedConfig, options?: __HttpHandlerOptions): Handler<ListStreamsCommandInput, ListStreamsCommandOutput>;
|
|
95
|
+
/**
|
|
96
|
+
* @internal
|
|
97
|
+
*/
|
|
85
98
|
private serialize;
|
|
99
|
+
/**
|
|
100
|
+
* @internal
|
|
101
|
+
*/
|
|
86
102
|
private deserialize;
|
|
87
103
|
}
|
|
@@ -1,5 +1,7 @@
|
|
|
1
1
|
import { ServiceException as __ServiceException, ServiceExceptionOptions as __ServiceExceptionOptions } from "@aws-sdk/smithy-client";
|
|
2
2
|
/**
|
|
3
|
+
* @public
|
|
4
|
+
*
|
|
3
5
|
* Base exception class for all service exceptions from DynamoDBStreams service.
|
|
4
6
|
*/
|
|
5
7
|
export declare class DynamoDBStreamsServiceException extends __ServiceException {
|
|
@@ -1,6 +1,7 @@
|
|
|
1
1
|
import { ExceptionOptionType as __ExceptionOptionType } from "@aws-sdk/smithy-client";
|
|
2
2
|
import { DynamoDBStreamsServiceException as __BaseException } from "./DynamoDBStreamsServiceException";
|
|
3
3
|
/**
|
|
4
|
+
* @public
|
|
4
5
|
* <p>Represents the input of a <code>DescribeStream</code> operation.</p>
|
|
5
6
|
*/
|
|
6
7
|
export interface DescribeStreamInput {
|
|
@@ -18,11 +19,15 @@ export interface DescribeStreamInput {
|
|
|
18
19
|
*/
|
|
19
20
|
ExclusiveStartShardId?: string;
|
|
20
21
|
}
|
|
22
|
+
/**
|
|
23
|
+
* @public
|
|
24
|
+
*/
|
|
21
25
|
export declare enum KeyType {
|
|
22
26
|
HASH = "HASH",
|
|
23
27
|
RANGE = "RANGE"
|
|
24
28
|
}
|
|
25
29
|
/**
|
|
30
|
+
* @public
|
|
26
31
|
* <p>Represents <i>a single element</i> of a key schema. A key schema specifies
|
|
27
32
|
* the attributes that make up the primary key of a table, or the key attributes of an
|
|
28
33
|
* index.</p>
|
|
@@ -66,6 +71,7 @@ export interface KeySchemaElement {
|
|
|
66
71
|
KeyType: KeyType | string | undefined;
|
|
67
72
|
}
|
|
68
73
|
/**
|
|
74
|
+
* @public
|
|
69
75
|
* <p>The beginning and ending sequence numbers for the stream records contained within a shard.</p>
|
|
70
76
|
*/
|
|
71
77
|
export interface SequenceNumberRange {
|
|
@@ -79,6 +85,7 @@ export interface SequenceNumberRange {
|
|
|
79
85
|
EndingSequenceNumber?: string;
|
|
80
86
|
}
|
|
81
87
|
/**
|
|
88
|
+
* @public
|
|
82
89
|
* <p>A uniquely identified group of stream records within a stream.</p>
|
|
83
90
|
*/
|
|
84
91
|
export interface Shard {
|
|
@@ -95,12 +102,18 @@ export interface Shard {
|
|
|
95
102
|
*/
|
|
96
103
|
ParentShardId?: string;
|
|
97
104
|
}
|
|
105
|
+
/**
|
|
106
|
+
* @public
|
|
107
|
+
*/
|
|
98
108
|
export declare enum StreamStatus {
|
|
99
109
|
DISABLED = "DISABLED",
|
|
100
110
|
DISABLING = "DISABLING",
|
|
101
111
|
ENABLED = "ENABLED",
|
|
102
112
|
ENABLING = "ENABLING"
|
|
103
113
|
}
|
|
114
|
+
/**
|
|
115
|
+
* @public
|
|
116
|
+
*/
|
|
104
117
|
export declare enum StreamViewType {
|
|
105
118
|
KEYS_ONLY = "KEYS_ONLY",
|
|
106
119
|
NEW_AND_OLD_IMAGES = "NEW_AND_OLD_IMAGES",
|
|
@@ -108,6 +121,7 @@ export declare enum StreamViewType {
|
|
|
108
121
|
OLD_IMAGE = "OLD_IMAGE"
|
|
109
122
|
}
|
|
110
123
|
/**
|
|
124
|
+
* @public
|
|
111
125
|
* <p>Represents all of the data describing a particular stream.</p>
|
|
112
126
|
*/
|
|
113
127
|
export interface StreamDescription {
|
|
@@ -205,6 +219,7 @@ export interface StreamDescription {
|
|
|
205
219
|
LastEvaluatedShardId?: string;
|
|
206
220
|
}
|
|
207
221
|
/**
|
|
222
|
+
* @public
|
|
208
223
|
* <p>Represents the output of a <code>DescribeStream</code> operation.</p>
|
|
209
224
|
*/
|
|
210
225
|
export interface DescribeStreamOutput {
|
|
@@ -214,6 +229,7 @@ export interface DescribeStreamOutput {
|
|
|
214
229
|
StreamDescription?: StreamDescription;
|
|
215
230
|
}
|
|
216
231
|
/**
|
|
232
|
+
* @public
|
|
217
233
|
* <p>An error occurred on the server side.</p>
|
|
218
234
|
*/
|
|
219
235
|
export declare class InternalServerError extends __BaseException {
|
|
@@ -225,6 +241,7 @@ export declare class InternalServerError extends __BaseException {
|
|
|
225
241
|
constructor(opts: __ExceptionOptionType<InternalServerError, __BaseException>);
|
|
226
242
|
}
|
|
227
243
|
/**
|
|
244
|
+
* @public
|
|
228
245
|
* <p>The operation tried to access a nonexistent table or index. The resource
|
|
229
246
|
* might not be specified correctly, or its status might not be
|
|
230
247
|
* <code>ACTIVE</code>.</p>
|
|
@@ -238,6 +255,7 @@ export declare class ResourceNotFoundException extends __BaseException {
|
|
|
238
255
|
constructor(opts: __ExceptionOptionType<ResourceNotFoundException, __BaseException>);
|
|
239
256
|
}
|
|
240
257
|
/**
|
|
258
|
+
* @public
|
|
241
259
|
* <p>The shard iterator has expired and can no longer be used to retrieve stream records. A shard
|
|
242
260
|
* iterator expires 15 minutes after it is retrieved using the <code>GetShardIterator</code>
|
|
243
261
|
* action.</p>
|
|
@@ -251,6 +269,7 @@ export declare class ExpiredIteratorException extends __BaseException {
|
|
|
251
269
|
constructor(opts: __ExceptionOptionType<ExpiredIteratorException, __BaseException>);
|
|
252
270
|
}
|
|
253
271
|
/**
|
|
272
|
+
* @public
|
|
254
273
|
* <p>Represents the input of a <code>GetRecords</code> operation.</p>
|
|
255
274
|
*/
|
|
256
275
|
export interface GetRecordsInput {
|
|
@@ -263,12 +282,16 @@ export interface GetRecordsInput {
|
|
|
263
282
|
*/
|
|
264
283
|
Limit?: number;
|
|
265
284
|
}
|
|
285
|
+
/**
|
|
286
|
+
* @public
|
|
287
|
+
*/
|
|
266
288
|
export declare enum OperationType {
|
|
267
289
|
INSERT = "INSERT",
|
|
268
290
|
MODIFY = "MODIFY",
|
|
269
291
|
REMOVE = "REMOVE"
|
|
270
292
|
}
|
|
271
293
|
/**
|
|
294
|
+
* @public
|
|
272
295
|
* <p>Contains details about the type of identity that made the request.</p>
|
|
273
296
|
*/
|
|
274
297
|
export interface Identity {
|
|
@@ -283,6 +306,7 @@ export interface Identity {
|
|
|
283
306
|
Type?: string;
|
|
284
307
|
}
|
|
285
308
|
/**
|
|
309
|
+
* @public
|
|
286
310
|
* <p>There is no limit to the number of daily on-demand backups that can be taken. </p>
|
|
287
311
|
* <p>For most purposes, up to 500 simultaneous table operations are allowed per account. These operations
|
|
288
312
|
* include <code>CreateTable</code>, <code>UpdateTable</code>,
|
|
@@ -304,6 +328,7 @@ export declare class LimitExceededException extends __BaseException {
|
|
|
304
328
|
constructor(opts: __ExceptionOptionType<LimitExceededException, __BaseException>);
|
|
305
329
|
}
|
|
306
330
|
/**
|
|
331
|
+
* @public
|
|
307
332
|
* <p>The operation attempted to read past the oldest stream record in a shard.</p>
|
|
308
333
|
* <p>In DynamoDB Streams, there is a 24 hour limit on data retention. Stream records whose age exceeds this limit are subject to removal (trimming) from the stream. You might receive a TrimmedDataAccessException if:</p>
|
|
309
334
|
* <ul>
|
|
@@ -325,6 +350,9 @@ export declare class TrimmedDataAccessException extends __BaseException {
|
|
|
325
350
|
*/
|
|
326
351
|
constructor(opts: __ExceptionOptionType<TrimmedDataAccessException, __BaseException>);
|
|
327
352
|
}
|
|
353
|
+
/**
|
|
354
|
+
* @public
|
|
355
|
+
*/
|
|
328
356
|
export declare enum ShardIteratorType {
|
|
329
357
|
AFTER_SEQUENCE_NUMBER = "AFTER_SEQUENCE_NUMBER",
|
|
330
358
|
AT_SEQUENCE_NUMBER = "AT_SEQUENCE_NUMBER",
|
|
@@ -332,6 +360,7 @@ export declare enum ShardIteratorType {
|
|
|
332
360
|
TRIM_HORIZON = "TRIM_HORIZON"
|
|
333
361
|
}
|
|
334
362
|
/**
|
|
363
|
+
* @public
|
|
335
364
|
* <p>Represents the input of a <code>GetShardIterator</code> operation.</p>
|
|
336
365
|
*/
|
|
337
366
|
export interface GetShardIteratorInput {
|
|
@@ -377,6 +406,7 @@ export interface GetShardIteratorInput {
|
|
|
377
406
|
SequenceNumber?: string;
|
|
378
407
|
}
|
|
379
408
|
/**
|
|
409
|
+
* @public
|
|
380
410
|
* <p>Represents the output of a <code>GetShardIterator</code> operation.</p>
|
|
381
411
|
*/
|
|
382
412
|
export interface GetShardIteratorOutput {
|
|
@@ -386,6 +416,7 @@ export interface GetShardIteratorOutput {
|
|
|
386
416
|
ShardIterator?: string;
|
|
387
417
|
}
|
|
388
418
|
/**
|
|
419
|
+
* @public
|
|
389
420
|
* <p>Represents the input of a <code>ListStreams</code> operation.</p>
|
|
390
421
|
*/
|
|
391
422
|
export interface ListStreamsInput {
|
|
@@ -405,6 +436,7 @@ export interface ListStreamsInput {
|
|
|
405
436
|
ExclusiveStartStreamArn?: string;
|
|
406
437
|
}
|
|
407
438
|
/**
|
|
439
|
+
* @public
|
|
408
440
|
* <p>Represents all of the data describing a particular stream.</p>
|
|
409
441
|
*/
|
|
410
442
|
export interface _Stream {
|
|
@@ -437,6 +469,7 @@ export interface _Stream {
|
|
|
437
469
|
StreamLabel?: string;
|
|
438
470
|
}
|
|
439
471
|
/**
|
|
472
|
+
* @public
|
|
440
473
|
* <p>Represents the output of a <code>ListStreams</code> operation.</p>
|
|
441
474
|
*/
|
|
442
475
|
export interface ListStreamsOutput {
|
|
@@ -455,12 +488,16 @@ export interface ListStreamsOutput {
|
|
|
455
488
|
LastEvaluatedStreamArn?: string;
|
|
456
489
|
}
|
|
457
490
|
/**
|
|
491
|
+
* @public
|
|
458
492
|
* <p>Represents the data for an attribute.</p>
|
|
459
493
|
* <p>Each attribute value is described as a name-value pair. The name is the data type, and the value is the data itself.</p>
|
|
460
494
|
* <p>For more information, see <a href="https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/HowItWorks.NamingRulesDataTypes.html#HowItWorks.DataTypes">Data Types</a> in the
|
|
461
495
|
* <i>Amazon DynamoDB Developer Guide</i>.</p>
|
|
462
496
|
*/
|
|
463
497
|
export type AttributeValue = AttributeValue.BMember | AttributeValue.BOOLMember | AttributeValue.BSMember | AttributeValue.LMember | AttributeValue.MMember | AttributeValue.NMember | AttributeValue.NSMember | AttributeValue.NULLMember | AttributeValue.SMember | AttributeValue.SSMember | AttributeValue.$UnknownMember;
|
|
498
|
+
/**
|
|
499
|
+
* @public
|
|
500
|
+
*/
|
|
464
501
|
export declare namespace AttributeValue {
|
|
465
502
|
/**
|
|
466
503
|
* <p>An attribute of type String. For example:</p>
|
|
@@ -581,7 +618,7 @@ export declare namespace AttributeValue {
|
|
|
581
618
|
/**
|
|
582
619
|
* <p>An attribute of type Map. For example:</p>
|
|
583
620
|
* <p>
|
|
584
|
-
* <code>"M": {"Name": {"S": "Joe"}, "Age": {"N": "35"}}</code>
|
|
621
|
+
* <code>"M": \{"Name": \{"S": "Joe"\}, "Age": \{"N": "35"\}\}</code>
|
|
585
622
|
* </p>
|
|
586
623
|
*/
|
|
587
624
|
interface MMember {
|
|
@@ -600,7 +637,7 @@ export declare namespace AttributeValue {
|
|
|
600
637
|
/**
|
|
601
638
|
* <p>An attribute of type List. For example:</p>
|
|
602
639
|
* <p>
|
|
603
|
-
* <code>"L": [ {"S": "Cookies"} , {"S": "Coffee"}, {"N": "3.14159"}]</code>
|
|
640
|
+
* <code>"L": [ \{"S": "Cookies"\} , \{"S": "Coffee"\}, \{"N": "3.14159"\}]</code>
|
|
604
641
|
* </p>
|
|
605
642
|
*/
|
|
606
643
|
interface LMember {
|
|
@@ -683,6 +720,7 @@ export declare namespace AttributeValue {
|
|
|
683
720
|
const visit: <T>(value: AttributeValue, visitor: Visitor<T>) => T;
|
|
684
721
|
}
|
|
685
722
|
/**
|
|
723
|
+
* @public
|
|
686
724
|
* <p>A description of a single data modification that was performed on an item in a DynamoDB table.</p>
|
|
687
725
|
*/
|
|
688
726
|
export interface StreamRecord {
|
|
@@ -734,6 +772,7 @@ export interface StreamRecord {
|
|
|
734
772
|
StreamViewType?: StreamViewType | string;
|
|
735
773
|
}
|
|
736
774
|
/**
|
|
775
|
+
* @public
|
|
737
776
|
* <p>A description of a unique event within a stream.</p>
|
|
738
777
|
*/
|
|
739
778
|
export interface _Record {
|
|
@@ -794,6 +833,7 @@ export interface _Record {
|
|
|
794
833
|
userIdentity?: Identity;
|
|
795
834
|
}
|
|
796
835
|
/**
|
|
836
|
+
* @public
|
|
797
837
|
* <p>Represents the output of a <code>GetRecords</code> operation.</p>
|
|
798
838
|
*/
|
|
799
839
|
export interface GetRecordsOutput {
|
package/package.json
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@aws-sdk/client-dynamodb-streams",
|
|
3
3
|
"description": "AWS SDK for JavaScript Dynamodb Streams Client for Node.js, Browser and React Native",
|
|
4
|
-
"version": "3.
|
|
4
|
+
"version": "3.297.0",
|
|
5
5
|
"scripts": {
|
|
6
6
|
"build": "concurrently 'yarn:build:cjs' 'yarn:build:es' 'yarn:build:types'",
|
|
7
7
|
"build:cjs": "tsc -p tsconfig.cjs.json",
|
|
@@ -20,9 +20,9 @@
|
|
|
20
20
|
"dependencies": {
|
|
21
21
|
"@aws-crypto/sha256-browser": "3.0.0",
|
|
22
22
|
"@aws-crypto/sha256-js": "3.0.0",
|
|
23
|
-
"@aws-sdk/client-sts": "3.
|
|
23
|
+
"@aws-sdk/client-sts": "3.297.0",
|
|
24
24
|
"@aws-sdk/config-resolver": "3.296.0",
|
|
25
|
-
"@aws-sdk/credential-provider-node": "3.
|
|
25
|
+
"@aws-sdk/credential-provider-node": "3.297.0",
|
|
26
26
|
"@aws-sdk/fetch-http-handler": "3.296.0",
|
|
27
27
|
"@aws-sdk/hash-node": "3.296.0",
|
|
28
28
|
"@aws-sdk/invalid-dependency": "3.296.0",
|