@aws-sdk/client-kinesis-analytics 3.533.0 → 3.540.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-cjs/endpoint/endpointResolver.js +4 -2
- package/dist-cjs/index.js +0 -3
- package/dist-es/endpoint/endpointResolver.js +3 -1
- package/dist-es/index.js +0 -1
- package/dist-types/KinesisAnalytics.d.ts +3 -1
- package/dist-types/KinesisAnalyticsClient.d.ts +1 -1
- package/dist-types/commands/AddApplicationCloudWatchLoggingOptionCommand.d.ts +2 -1
- package/dist-types/commands/AddApplicationInputCommand.d.ts +2 -1
- package/dist-types/commands/AddApplicationInputProcessingConfigurationCommand.d.ts +2 -1
- package/dist-types/commands/AddApplicationOutputCommand.d.ts +2 -1
- package/dist-types/commands/AddApplicationReferenceDataSourceCommand.d.ts +2 -1
- package/dist-types/commands/CreateApplicationCommand.d.ts +2 -1
- package/dist-types/commands/DeleteApplicationCloudWatchLoggingOptionCommand.d.ts +2 -1
- package/dist-types/commands/DeleteApplicationCommand.d.ts +2 -1
- package/dist-types/commands/DeleteApplicationInputProcessingConfigurationCommand.d.ts +2 -1
- package/dist-types/commands/DeleteApplicationOutputCommand.d.ts +2 -1
- package/dist-types/commands/DeleteApplicationReferenceDataSourceCommand.d.ts +2 -1
- package/dist-types/commands/DescribeApplicationCommand.d.ts +2 -1
- package/dist-types/commands/DiscoverInputSchemaCommand.d.ts +2 -1
- package/dist-types/commands/ListApplicationsCommand.d.ts +2 -1
- package/dist-types/commands/ListTagsForResourceCommand.d.ts +2 -1
- package/dist-types/commands/StartApplicationCommand.d.ts +2 -1
- package/dist-types/commands/StopApplicationCommand.d.ts +2 -1
- package/dist-types/commands/TagResourceCommand.d.ts +2 -1
- package/dist-types/commands/UntagResourceCommand.d.ts +2 -1
- package/dist-types/commands/UpdateApplicationCommand.d.ts +2 -1
- package/dist-types/index.d.ts +0 -1
- package/dist-types/models/models_0.d.ts +304 -304
- package/dist-types/ts3.4/KinesisAnalytics.d.ts +2 -0
- package/dist-types/ts3.4/commands/AddApplicationCloudWatchLoggingOptionCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/AddApplicationInputCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/AddApplicationInputProcessingConfigurationCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/AddApplicationOutputCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/AddApplicationReferenceDataSourceCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/CreateApplicationCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/DeleteApplicationCloudWatchLoggingOptionCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/DeleteApplicationCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/DeleteApplicationInputProcessingConfigurationCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/DeleteApplicationOutputCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/DeleteApplicationReferenceDataSourceCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/DescribeApplicationCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/DiscoverInputSchemaCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/ListApplicationsCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/ListTagsForResourceCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/StartApplicationCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/StopApplicationCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/TagResourceCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/UntagResourceCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/UpdateApplicationCommand.d.ts +9 -0
- package/dist-types/ts3.4/index.d.ts +0 -1
- package/package.json +40 -40
|
@@ -1,21 +1,21 @@
|
|
|
1
1
|
import { ExceptionOptionType as __ExceptionOptionType } from "@smithy/smithy-client";
|
|
2
2
|
import { KinesisAnalyticsServiceException as __BaseException } from "./KinesisAnalyticsServiceException";
|
|
3
3
|
/**
|
|
4
|
-
* @public
|
|
5
4
|
* <p>Provides a description of CloudWatch logging options, including the log stream
|
|
6
5
|
* Amazon Resource Name (ARN) and the role ARN.</p>
|
|
6
|
+
* @public
|
|
7
7
|
*/
|
|
8
8
|
export interface CloudWatchLoggingOption {
|
|
9
9
|
/**
|
|
10
|
-
* @public
|
|
11
10
|
* <p>ARN of the CloudWatch log to receive application messages.</p>
|
|
11
|
+
* @public
|
|
12
12
|
*/
|
|
13
13
|
LogStreamARN: string | undefined;
|
|
14
14
|
/**
|
|
15
|
-
* @public
|
|
16
15
|
* <p>IAM ARN of the role to use to send application messages. Note: To write application
|
|
17
16
|
* messages to CloudWatch, the IAM role that is used must have the
|
|
18
17
|
* <code>PutLogEvents</code> policy action enabled.</p>
|
|
18
|
+
* @public
|
|
19
19
|
*/
|
|
20
20
|
RoleARN: string | undefined;
|
|
21
21
|
}
|
|
@@ -24,20 +24,20 @@ export interface CloudWatchLoggingOption {
|
|
|
24
24
|
*/
|
|
25
25
|
export interface AddApplicationCloudWatchLoggingOptionRequest {
|
|
26
26
|
/**
|
|
27
|
-
* @public
|
|
28
27
|
* <p>The Kinesis Analytics application name.</p>
|
|
28
|
+
* @public
|
|
29
29
|
*/
|
|
30
30
|
ApplicationName: string | undefined;
|
|
31
31
|
/**
|
|
32
|
-
* @public
|
|
33
32
|
* <p>The version ID of the Kinesis Analytics application.</p>
|
|
33
|
+
* @public
|
|
34
34
|
*/
|
|
35
35
|
CurrentApplicationVersionId: number | undefined;
|
|
36
36
|
/**
|
|
37
|
-
* @public
|
|
38
37
|
* <p>Provides the CloudWatch log stream Amazon Resource Name (ARN) and the IAM role ARN.
|
|
39
38
|
* Note: To write application messages to CloudWatch, the IAM role that is used must have
|
|
40
39
|
* the <code>PutLogEvents</code> policy action enabled.</p>
|
|
40
|
+
* @public
|
|
41
41
|
*/
|
|
42
42
|
CloudWatchLoggingOption: CloudWatchLoggingOption | undefined;
|
|
43
43
|
}
|
|
@@ -47,8 +47,8 @@ export interface AddApplicationCloudWatchLoggingOptionRequest {
|
|
|
47
47
|
export interface AddApplicationCloudWatchLoggingOptionResponse {
|
|
48
48
|
}
|
|
49
49
|
/**
|
|
50
|
-
* @public
|
|
51
50
|
* <p>Exception thrown as a result of concurrent modification to an application. For example, two individuals attempting to edit the same application at the same time.</p>
|
|
51
|
+
* @public
|
|
52
52
|
*/
|
|
53
53
|
export declare class ConcurrentModificationException extends __BaseException {
|
|
54
54
|
readonly name: "ConcurrentModificationException";
|
|
@@ -59,8 +59,8 @@ export declare class ConcurrentModificationException extends __BaseException {
|
|
|
59
59
|
constructor(opts: __ExceptionOptionType<ConcurrentModificationException, __BaseException>);
|
|
60
60
|
}
|
|
61
61
|
/**
|
|
62
|
-
* @public
|
|
63
62
|
* <p>Specified input parameter value is invalid.</p>
|
|
63
|
+
* @public
|
|
64
64
|
*/
|
|
65
65
|
export declare class InvalidArgumentException extends __BaseException {
|
|
66
66
|
readonly name: "InvalidArgumentException";
|
|
@@ -71,8 +71,8 @@ export declare class InvalidArgumentException extends __BaseException {
|
|
|
71
71
|
constructor(opts: __ExceptionOptionType<InvalidArgumentException, __BaseException>);
|
|
72
72
|
}
|
|
73
73
|
/**
|
|
74
|
-
* @public
|
|
75
74
|
* <p>Application is not available for this operation.</p>
|
|
75
|
+
* @public
|
|
76
76
|
*/
|
|
77
77
|
export declare class ResourceInUseException extends __BaseException {
|
|
78
78
|
readonly name: "ResourceInUseException";
|
|
@@ -83,8 +83,8 @@ export declare class ResourceInUseException extends __BaseException {
|
|
|
83
83
|
constructor(opts: __ExceptionOptionType<ResourceInUseException, __BaseException>);
|
|
84
84
|
}
|
|
85
85
|
/**
|
|
86
|
-
* @public
|
|
87
86
|
* <p>Specified application can't be found.</p>
|
|
87
|
+
* @public
|
|
88
88
|
*/
|
|
89
89
|
export declare class ResourceNotFoundException extends __BaseException {
|
|
90
90
|
readonly name: "ResourceNotFoundException";
|
|
@@ -95,8 +95,8 @@ export declare class ResourceNotFoundException extends __BaseException {
|
|
|
95
95
|
constructor(opts: __ExceptionOptionType<ResourceNotFoundException, __BaseException>);
|
|
96
96
|
}
|
|
97
97
|
/**
|
|
98
|
-
* @public
|
|
99
98
|
* <p>The request was rejected because a specified parameter is not supported or a specified resource is not valid for this operation. </p>
|
|
99
|
+
* @public
|
|
100
100
|
*/
|
|
101
101
|
export declare class UnsupportedOperationException extends __BaseException {
|
|
102
102
|
readonly name: "UnsupportedOperationException";
|
|
@@ -107,85 +107,84 @@ export declare class UnsupportedOperationException extends __BaseException {
|
|
|
107
107
|
constructor(opts: __ExceptionOptionType<UnsupportedOperationException, __BaseException>);
|
|
108
108
|
}
|
|
109
109
|
/**
|
|
110
|
-
* @public
|
|
111
110
|
* <p>Describes the number of in-application streams to create for a given
|
|
112
111
|
* streaming source. For information about parallelism,
|
|
113
112
|
* see <a href="https://docs.aws.amazon.com/kinesisanalytics/latest/dev/how-it-works-input.html">Configuring Application Input</a>.
|
|
114
113
|
* </p>
|
|
114
|
+
* @public
|
|
115
115
|
*/
|
|
116
116
|
export interface InputParallelism {
|
|
117
117
|
/**
|
|
118
|
-
* @public
|
|
119
118
|
* <p>Number of in-application streams to create.
|
|
120
119
|
* For more information, see <a href="https://docs.aws.amazon.com/kinesisanalytics/latest/dev/limits.html">Limits</a>.
|
|
121
120
|
* </p>
|
|
121
|
+
* @public
|
|
122
122
|
*/
|
|
123
123
|
Count?: number;
|
|
124
124
|
}
|
|
125
125
|
/**
|
|
126
|
-
* @public
|
|
127
126
|
* <p>An object that contains the Amazon Resource Name (ARN) of the <a href="https://docs.aws.amazon.com/lambda/">AWS Lambda</a> function that
|
|
128
127
|
* is used to preprocess records in the stream, and the ARN of the IAM role that is used to
|
|
129
128
|
* access the AWS Lambda function. </p>
|
|
129
|
+
* @public
|
|
130
130
|
*/
|
|
131
131
|
export interface InputLambdaProcessor {
|
|
132
132
|
/**
|
|
133
|
-
* @public
|
|
134
133
|
* <p>The ARN of the <a href="https://docs.aws.amazon.com/lambda/">AWS Lambda</a> function that operates
|
|
135
134
|
* on records in the stream.</p>
|
|
136
135
|
* <note>
|
|
137
136
|
* <p>To specify an earlier version of the Lambda function than the latest, include the Lambda function version in the Lambda function ARN. For more information about Lambda ARNs, see <a href="/general/latest/gr/aws-arns-and-namespaces.html#arn-syntax-lambda">Example ARNs: AWS Lambda</a>
|
|
138
137
|
* </p>
|
|
139
138
|
* </note>
|
|
139
|
+
* @public
|
|
140
140
|
*/
|
|
141
141
|
ResourceARN: string | undefined;
|
|
142
142
|
/**
|
|
143
|
-
* @public
|
|
144
143
|
* <p>The ARN of the IAM role that is used to access the AWS Lambda function.</p>
|
|
144
|
+
* @public
|
|
145
145
|
*/
|
|
146
146
|
RoleARN: string | undefined;
|
|
147
147
|
}
|
|
148
148
|
/**
|
|
149
|
-
* @public
|
|
150
149
|
* <p>Provides a description of a processor that is used to preprocess the records in the
|
|
151
150
|
* stream before being processed by your application code. Currently, the only input
|
|
152
151
|
* processor available is <a href="https://docs.aws.amazon.com/lambda/">AWS
|
|
153
152
|
* Lambda</a>.</p>
|
|
153
|
+
* @public
|
|
154
154
|
*/
|
|
155
155
|
export interface InputProcessingConfiguration {
|
|
156
156
|
/**
|
|
157
|
-
* @public
|
|
158
157
|
* <p>The <a href="https://docs.aws.amazon.com/kinesisanalytics/latest/dev/API_InputLambdaProcessor.html">InputLambdaProcessor</a> that is used to preprocess the records
|
|
159
158
|
* in the stream before being processed by your application code.</p>
|
|
159
|
+
* @public
|
|
160
160
|
*/
|
|
161
161
|
InputLambdaProcessor: InputLambdaProcessor | undefined;
|
|
162
162
|
}
|
|
163
163
|
/**
|
|
164
|
-
* @public
|
|
165
164
|
* <p>Describes the mapping of each data element in the streaming
|
|
166
165
|
* source to the corresponding column in the in-application stream.</p>
|
|
167
166
|
* <p>Also used to describe the format of the reference data source.</p>
|
|
167
|
+
* @public
|
|
168
168
|
*/
|
|
169
169
|
export interface RecordColumn {
|
|
170
170
|
/**
|
|
171
|
-
* @public
|
|
172
171
|
* <p>Name of the column created in the in-application input stream or reference table.</p>
|
|
172
|
+
* @public
|
|
173
173
|
*/
|
|
174
174
|
Name: string | undefined;
|
|
175
175
|
/**
|
|
176
|
-
* @public
|
|
177
176
|
* <p>Reference to the data element in the streaming input or the reference data source. This element
|
|
178
177
|
* is required if the <a href="https://docs.aws.amazon.com/kinesisanalytics/latest/dev/API_RecordFormat.html#analytics-Type-RecordFormat-RecordFormatTypel">RecordFormatType</a> is <code>JSON</code>.</p>
|
|
178
|
+
* @public
|
|
179
179
|
*/
|
|
180
180
|
Mapping?: string;
|
|
181
181
|
/**
|
|
182
|
-
* @public
|
|
183
182
|
* <p>Type of column created in the in-application input stream or reference table.</p>
|
|
183
|
+
* @public
|
|
184
184
|
*/
|
|
185
185
|
SqlType: string | undefined;
|
|
186
186
|
}
|
|
187
187
|
/**
|
|
188
|
-
* @public
|
|
189
188
|
* <p>Provides additional mapping information when the record format
|
|
190
189
|
* uses delimiters, such as CSV. For example, the following sample records
|
|
191
190
|
* use CSV format, where the records use the <i>'\n'</i> as the row delimiter and a comma (",") as the column delimiter:
|
|
@@ -197,48 +196,49 @@ export interface RecordColumn {
|
|
|
197
196
|
* <p>
|
|
198
197
|
* <code>"name2", "address2"</code>
|
|
199
198
|
* </p>
|
|
199
|
+
* @public
|
|
200
200
|
*/
|
|
201
201
|
export interface CSVMappingParameters {
|
|
202
202
|
/**
|
|
203
|
-
* @public
|
|
204
203
|
* <p>Row delimiter. For example, in a CSV format, <i>'\n'</i> is the typical row delimiter.</p>
|
|
204
|
+
* @public
|
|
205
205
|
*/
|
|
206
206
|
RecordRowDelimiter: string | undefined;
|
|
207
207
|
/**
|
|
208
|
-
* @public
|
|
209
208
|
* <p>Column delimiter. For example, in a CSV format, a comma (",") is the typical column delimiter.</p>
|
|
209
|
+
* @public
|
|
210
210
|
*/
|
|
211
211
|
RecordColumnDelimiter: string | undefined;
|
|
212
212
|
}
|
|
213
213
|
/**
|
|
214
|
-
* @public
|
|
215
214
|
* <p>Provides additional mapping information when JSON is the record format on the streaming source.</p>
|
|
215
|
+
* @public
|
|
216
216
|
*/
|
|
217
217
|
export interface JSONMappingParameters {
|
|
218
218
|
/**
|
|
219
|
-
* @public
|
|
220
219
|
* <p>Path to the top-level parent that contains the records.</p>
|
|
220
|
+
* @public
|
|
221
221
|
*/
|
|
222
222
|
RecordRowPath: string | undefined;
|
|
223
223
|
}
|
|
224
224
|
/**
|
|
225
|
-
* @public
|
|
226
225
|
* <p>When configuring application input
|
|
227
226
|
* at the time of creating or updating an application,
|
|
228
227
|
* provides additional mapping information specific to
|
|
229
228
|
* the record format (such as JSON, CSV, or record fields delimited
|
|
230
229
|
* by some delimiter) on the streaming source.</p>
|
|
230
|
+
* @public
|
|
231
231
|
*/
|
|
232
232
|
export interface MappingParameters {
|
|
233
233
|
/**
|
|
234
|
-
* @public
|
|
235
234
|
* <p>Provides additional mapping information when JSON is the record format on the streaming source.</p>
|
|
235
|
+
* @public
|
|
236
236
|
*/
|
|
237
237
|
JSONMappingParameters?: JSONMappingParameters;
|
|
238
238
|
/**
|
|
239
|
-
* @public
|
|
240
239
|
* <p>Provides additional mapping information when the record format uses delimiters
|
|
241
240
|
* (for example, CSV).</p>
|
|
241
|
+
* @public
|
|
242
242
|
*/
|
|
243
243
|
CSVMappingParameters?: CSVMappingParameters;
|
|
244
244
|
}
|
|
@@ -255,168 +255,168 @@ export declare const RecordFormatType: {
|
|
|
255
255
|
*/
|
|
256
256
|
export type RecordFormatType = (typeof RecordFormatType)[keyof typeof RecordFormatType];
|
|
257
257
|
/**
|
|
258
|
-
* @public
|
|
259
258
|
* <p>
|
|
260
259
|
* Describes the record format and relevant mapping information that
|
|
261
260
|
* should be applied to schematize the records on the stream.
|
|
262
261
|
* </p>
|
|
262
|
+
* @public
|
|
263
263
|
*/
|
|
264
264
|
export interface RecordFormat {
|
|
265
265
|
/**
|
|
266
|
-
* @public
|
|
267
266
|
* <p>The type of record format.</p>
|
|
267
|
+
* @public
|
|
268
268
|
*/
|
|
269
269
|
RecordFormatType: RecordFormatType | undefined;
|
|
270
270
|
/**
|
|
271
|
-
* @public
|
|
272
271
|
* <p>When configuring application input at the time of creating or updating an application, provides additional mapping information specific to the record format (such as JSON, CSV, or record fields delimited by some delimiter) on the streaming source.</p>
|
|
272
|
+
* @public
|
|
273
273
|
*/
|
|
274
274
|
MappingParameters?: MappingParameters;
|
|
275
275
|
}
|
|
276
276
|
/**
|
|
277
|
-
* @public
|
|
278
277
|
* <p>Describes the format of the data in the streaming source, and how each data element maps to corresponding columns created in the in-application stream.</p>
|
|
278
|
+
* @public
|
|
279
279
|
*/
|
|
280
280
|
export interface SourceSchema {
|
|
281
281
|
/**
|
|
282
|
-
* @public
|
|
283
282
|
* <p>Specifies the format of the records on the streaming source.</p>
|
|
283
|
+
* @public
|
|
284
284
|
*/
|
|
285
285
|
RecordFormat: RecordFormat | undefined;
|
|
286
286
|
/**
|
|
287
|
-
* @public
|
|
288
287
|
* <p>Specifies the encoding of the records in the streaming source. For example, UTF-8.</p>
|
|
288
|
+
* @public
|
|
289
289
|
*/
|
|
290
290
|
RecordEncoding?: string;
|
|
291
291
|
/**
|
|
292
|
-
* @public
|
|
293
292
|
* <p>A list of <code>RecordColumn</code> objects.</p>
|
|
293
|
+
* @public
|
|
294
294
|
*/
|
|
295
295
|
RecordColumns: RecordColumn[] | undefined;
|
|
296
296
|
}
|
|
297
297
|
/**
|
|
298
|
-
* @public
|
|
299
298
|
* <p> Identifies an Amazon Kinesis Firehose delivery stream as the streaming source. You
|
|
300
299
|
* provide the delivery stream's Amazon Resource Name (ARN) and an IAM role ARN that
|
|
301
300
|
* enables Amazon Kinesis Analytics to access the stream on your behalf.</p>
|
|
301
|
+
* @public
|
|
302
302
|
*/
|
|
303
303
|
export interface KinesisFirehoseInput {
|
|
304
304
|
/**
|
|
305
|
-
* @public
|
|
306
305
|
* <p>ARN of the input delivery stream.</p>
|
|
306
|
+
* @public
|
|
307
307
|
*/
|
|
308
308
|
ResourceARN: string | undefined;
|
|
309
309
|
/**
|
|
310
|
-
* @public
|
|
311
310
|
* <p>ARN of the IAM role that Amazon Kinesis Analytics can assume to access the stream
|
|
312
311
|
* on your behalf. You need to make sure that the role has the necessary permissions to
|
|
313
312
|
* access the stream.</p>
|
|
313
|
+
* @public
|
|
314
314
|
*/
|
|
315
315
|
RoleARN: string | undefined;
|
|
316
316
|
}
|
|
317
317
|
/**
|
|
318
|
-
* @public
|
|
319
318
|
* <p> Identifies an Amazon Kinesis stream as the streaming source. You provide the
|
|
320
319
|
* stream's Amazon Resource Name (ARN) and an IAM role ARN that enables Amazon Kinesis
|
|
321
320
|
* Analytics to access the stream on your behalf.</p>
|
|
321
|
+
* @public
|
|
322
322
|
*/
|
|
323
323
|
export interface KinesisStreamsInput {
|
|
324
324
|
/**
|
|
325
|
-
* @public
|
|
326
325
|
* <p>ARN of the input Amazon Kinesis stream to read.</p>
|
|
326
|
+
* @public
|
|
327
327
|
*/
|
|
328
328
|
ResourceARN: string | undefined;
|
|
329
329
|
/**
|
|
330
|
-
* @public
|
|
331
330
|
* <p>ARN of the IAM role that Amazon Kinesis Analytics can assume to access the stream on your behalf. You need to grant the necessary permissions to this role.</p>
|
|
331
|
+
* @public
|
|
332
332
|
*/
|
|
333
333
|
RoleARN: string | undefined;
|
|
334
334
|
}
|
|
335
335
|
/**
|
|
336
|
-
* @public
|
|
337
336
|
* <p>When you configure the application input, you specify the streaming source, the
|
|
338
337
|
* in-application stream name that is created, and the mapping between the two.
|
|
339
338
|
* For more information,
|
|
340
339
|
* see <a href="https://docs.aws.amazon.com/kinesisanalytics/latest/dev/how-it-works-input.html">Configuring Application Input</a>. </p>
|
|
340
|
+
* @public
|
|
341
341
|
*/
|
|
342
342
|
export interface Input {
|
|
343
343
|
/**
|
|
344
|
-
* @public
|
|
345
344
|
* <p>Name prefix to use when creating an in-application stream. Suppose that you specify
|
|
346
345
|
* a prefix "MyInApplicationStream." Amazon Kinesis Analytics then creates one or more (as
|
|
347
346
|
* per the <code>InputParallelism</code> count you specified) in-application streams with
|
|
348
347
|
* names "MyInApplicationStream_001," "MyInApplicationStream_002," and so on. </p>
|
|
348
|
+
* @public
|
|
349
349
|
*/
|
|
350
350
|
NamePrefix: string | undefined;
|
|
351
351
|
/**
|
|
352
|
-
* @public
|
|
353
352
|
* <p>The <a href="https://docs.aws.amazon.com/kinesisanalytics/latest/dev/API_InputProcessingConfiguration.html">InputProcessingConfiguration</a> for the input. An input
|
|
354
353
|
* processor transforms records as they are received from the stream, before the
|
|
355
354
|
* application's SQL code executes. Currently, the only input processing configuration
|
|
356
355
|
* available is <a href="https://docs.aws.amazon.com/kinesisanalytics/latest/dev/API_InputLambdaProcessor.html">InputLambdaProcessor</a>.</p>
|
|
356
|
+
* @public
|
|
357
357
|
*/
|
|
358
358
|
InputProcessingConfiguration?: InputProcessingConfiguration;
|
|
359
359
|
/**
|
|
360
|
-
* @public
|
|
361
360
|
* <p>If the streaming source is an Amazon Kinesis stream,
|
|
362
361
|
* identifies the stream's Amazon Resource Name (ARN) and an IAM role
|
|
363
362
|
* that enables Amazon Kinesis Analytics to access the stream on your behalf.</p>
|
|
364
363
|
* <p>Note: Either <code>KinesisStreamsInput</code> or <code>KinesisFirehoseInput</code> is required.</p>
|
|
364
|
+
* @public
|
|
365
365
|
*/
|
|
366
366
|
KinesisStreamsInput?: KinesisStreamsInput;
|
|
367
367
|
/**
|
|
368
|
-
* @public
|
|
369
368
|
* <p>If the streaming source is an Amazon Kinesis Firehose delivery stream, identifies
|
|
370
369
|
* the delivery stream's ARN and an IAM role that enables Amazon Kinesis Analytics to
|
|
371
370
|
* access the stream on your behalf.</p>
|
|
372
371
|
* <p>Note: Either <code>KinesisStreamsInput</code> or <code>KinesisFirehoseInput</code> is required.</p>
|
|
372
|
+
* @public
|
|
373
373
|
*/
|
|
374
374
|
KinesisFirehoseInput?: KinesisFirehoseInput;
|
|
375
375
|
/**
|
|
376
|
-
* @public
|
|
377
376
|
* <p>Describes the number of in-application streams to create. </p>
|
|
378
377
|
* <p>Data from your source is routed to these in-application input streams.</p>
|
|
379
378
|
* <p> (see <a href="https://docs.aws.amazon.com/kinesisanalytics/latest/dev/how-it-works-input.html">Configuring Application Input</a>.</p>
|
|
379
|
+
* @public
|
|
380
380
|
*/
|
|
381
381
|
InputParallelism?: InputParallelism;
|
|
382
382
|
/**
|
|
383
|
-
* @public
|
|
384
383
|
* <p>Describes the format of the data in the streaming source, and how each data element maps to corresponding columns in the in-application stream that is being created.</p>
|
|
385
384
|
* <p>Also used to describe the format of the reference data source.</p>
|
|
385
|
+
* @public
|
|
386
386
|
*/
|
|
387
387
|
InputSchema: SourceSchema | undefined;
|
|
388
388
|
}
|
|
389
389
|
/**
|
|
390
|
-
* @public
|
|
391
390
|
* <p></p>
|
|
391
|
+
* @public
|
|
392
392
|
*/
|
|
393
393
|
export interface AddApplicationInputRequest {
|
|
394
394
|
/**
|
|
395
|
-
* @public
|
|
396
395
|
* <p>Name of your existing Amazon Kinesis Analytics application to which you want to add the streaming source.</p>
|
|
396
|
+
* @public
|
|
397
397
|
*/
|
|
398
398
|
ApplicationName: string | undefined;
|
|
399
399
|
/**
|
|
400
|
-
* @public
|
|
401
400
|
* <p>Current version of your Amazon Kinesis Analytics application. You can use the <a href="https://docs.aws.amazon.com/kinesisanalytics/latest/dev/API_DescribeApplication.html">DescribeApplication</a> operation
|
|
402
401
|
* to find the current application version.</p>
|
|
402
|
+
* @public
|
|
403
403
|
*/
|
|
404
404
|
CurrentApplicationVersionId: number | undefined;
|
|
405
405
|
/**
|
|
406
|
-
* @public
|
|
407
406
|
* <p>The <a href="https://docs.aws.amazon.com/kinesisanalytics/latest/dev/API_Input.html">Input</a> to add.</p>
|
|
407
|
+
* @public
|
|
408
408
|
*/
|
|
409
409
|
Input: Input | undefined;
|
|
410
410
|
}
|
|
411
411
|
/**
|
|
412
|
-
* @public
|
|
413
412
|
* <p></p>
|
|
413
|
+
* @public
|
|
414
414
|
*/
|
|
415
415
|
export interface AddApplicationInputResponse {
|
|
416
416
|
}
|
|
417
417
|
/**
|
|
418
|
-
* @public
|
|
419
418
|
* <p>User-provided application code (query) is invalid. This can be a simple syntax error.</p>
|
|
419
|
+
* @public
|
|
420
420
|
*/
|
|
421
421
|
export declare class CodeValidationException extends __BaseException {
|
|
422
422
|
readonly name: "CodeValidationException";
|
|
@@ -431,26 +431,26 @@ export declare class CodeValidationException extends __BaseException {
|
|
|
431
431
|
*/
|
|
432
432
|
export interface AddApplicationInputProcessingConfigurationRequest {
|
|
433
433
|
/**
|
|
434
|
-
* @public
|
|
435
434
|
* <p>Name of the application to which you want to add the input processing configuration.</p>
|
|
435
|
+
* @public
|
|
436
436
|
*/
|
|
437
437
|
ApplicationName: string | undefined;
|
|
438
438
|
/**
|
|
439
|
-
* @public
|
|
440
439
|
* <p>Version of the application to which you want to add the input processing configuration. You can use the <a href="https://docs.aws.amazon.com/kinesisanalytics/latest/dev/API_DescribeApplication.html">DescribeApplication</a>
|
|
441
440
|
* operation to get the current application version. If the version specified is not the current version, the
|
|
442
441
|
* <code>ConcurrentModificationException</code> is returned.</p>
|
|
442
|
+
* @public
|
|
443
443
|
*/
|
|
444
444
|
CurrentApplicationVersionId: number | undefined;
|
|
445
445
|
/**
|
|
446
|
-
* @public
|
|
447
446
|
* <p>The ID of the input configuration to add the input processing configuration to. You
|
|
448
447
|
* can get a list of the input IDs for an application using the <a href="https://docs.aws.amazon.com/kinesisanalytics/latest/dev/API_DescribeApplication.html">DescribeApplication</a> operation.</p>
|
|
448
|
+
* @public
|
|
449
449
|
*/
|
|
450
450
|
InputId: string | undefined;
|
|
451
451
|
/**
|
|
452
|
-
* @public
|
|
453
452
|
* <p>The <a href="https://docs.aws.amazon.com/kinesisanalytics/latest/dev/API_InputProcessingConfiguration.html">InputProcessingConfiguration</a> to add to the application.</p>
|
|
453
|
+
* @public
|
|
454
454
|
*/
|
|
455
455
|
InputProcessingConfiguration: InputProcessingConfiguration | undefined;
|
|
456
456
|
}
|
|
@@ -460,83 +460,82 @@ export interface AddApplicationInputProcessingConfigurationRequest {
|
|
|
460
460
|
export interface AddApplicationInputProcessingConfigurationResponse {
|
|
461
461
|
}
|
|
462
462
|
/**
|
|
463
|
-
* @public
|
|
464
463
|
* <p>Describes the data format when records are written to the destination.
|
|
465
464
|
* For more information,
|
|
466
465
|
* see <a href="https://docs.aws.amazon.com/kinesisanalytics/latest/dev/how-it-works-output.html">Configuring Application Output</a>.
|
|
467
466
|
*
|
|
468
467
|
*
|
|
469
468
|
* </p>
|
|
469
|
+
* @public
|
|
470
470
|
*/
|
|
471
471
|
export interface DestinationSchema {
|
|
472
472
|
/**
|
|
473
|
-
* @public
|
|
474
473
|
* <p>Specifies the format of the records on the output stream.</p>
|
|
474
|
+
* @public
|
|
475
475
|
*/
|
|
476
476
|
RecordFormatType: RecordFormatType | undefined;
|
|
477
477
|
}
|
|
478
478
|
/**
|
|
479
|
-
* @public
|
|
480
479
|
* <p>When configuring application output,
|
|
481
480
|
* identifies an Amazon Kinesis Firehose delivery stream as the destination.
|
|
482
481
|
* You provide the stream Amazon Resource Name (ARN) and an IAM role
|
|
483
482
|
* that enables Amazon Kinesis Analytics to write to the stream on your behalf.</p>
|
|
483
|
+
* @public
|
|
484
484
|
*/
|
|
485
485
|
export interface KinesisFirehoseOutput {
|
|
486
486
|
/**
|
|
487
|
-
* @public
|
|
488
487
|
* <p>ARN of the destination Amazon Kinesis Firehose delivery stream to write to.</p>
|
|
488
|
+
* @public
|
|
489
489
|
*/
|
|
490
490
|
ResourceARN: string | undefined;
|
|
491
491
|
/**
|
|
492
|
-
* @public
|
|
493
492
|
* <p>ARN of the IAM role that Amazon Kinesis Analytics can assume to write to the destination stream on your behalf. You need to grant the necessary permissions to this role.</p>
|
|
493
|
+
* @public
|
|
494
494
|
*/
|
|
495
495
|
RoleARN: string | undefined;
|
|
496
496
|
}
|
|
497
497
|
/**
|
|
498
|
-
* @public
|
|
499
498
|
* <p>When configuring application output, identifies an Amazon Kinesis stream as the
|
|
500
499
|
* destination. You provide the stream Amazon Resource Name (ARN) and also an IAM role ARN
|
|
501
500
|
* that Amazon Kinesis Analytics can use to write to the stream on your behalf.</p>
|
|
501
|
+
* @public
|
|
502
502
|
*/
|
|
503
503
|
export interface KinesisStreamsOutput {
|
|
504
504
|
/**
|
|
505
|
-
* @public
|
|
506
505
|
* <p>ARN of the destination Amazon Kinesis stream to write to.</p>
|
|
506
|
+
* @public
|
|
507
507
|
*/
|
|
508
508
|
ResourceARN: string | undefined;
|
|
509
509
|
/**
|
|
510
|
-
* @public
|
|
511
510
|
* <p>ARN of the IAM role that Amazon Kinesis Analytics can assume to write to the destination stream on your behalf. You need to grant the necessary permissions to this role.</p>
|
|
511
|
+
* @public
|
|
512
512
|
*/
|
|
513
513
|
RoleARN: string | undefined;
|
|
514
514
|
}
|
|
515
515
|
/**
|
|
516
|
-
* @public
|
|
517
516
|
* <p>When configuring application output, identifies an AWS Lambda function as the
|
|
518
517
|
* destination. You provide the function Amazon Resource Name (ARN) and also an IAM role
|
|
519
518
|
* ARN that Amazon Kinesis Analytics can use to write to the function on your behalf. </p>
|
|
519
|
+
* @public
|
|
520
520
|
*/
|
|
521
521
|
export interface LambdaOutput {
|
|
522
522
|
/**
|
|
523
|
-
* @public
|
|
524
523
|
* <p>Amazon Resource Name (ARN) of the destination Lambda function to write
|
|
525
524
|
* to.</p>
|
|
526
525
|
* <note>
|
|
527
526
|
* <p>To specify an earlier version of the Lambda function than the latest, include the Lambda function version in the Lambda function ARN. For more information about Lambda ARNs, see <a href="/general/latest/gr/aws-arns-and-namespaces.html#arn-syntax-lambda">Example ARNs: AWS Lambda</a>
|
|
528
527
|
* </p>
|
|
529
528
|
* </note>
|
|
529
|
+
* @public
|
|
530
530
|
*/
|
|
531
531
|
ResourceARN: string | undefined;
|
|
532
532
|
/**
|
|
533
|
-
* @public
|
|
534
533
|
* <p>ARN of the IAM role that Amazon Kinesis Analytics can assume to write to the destination function on your behalf. You need to grant the necessary permissions to this role. </p>
|
|
534
|
+
* @public
|
|
535
535
|
*/
|
|
536
536
|
RoleARN: string | undefined;
|
|
537
537
|
}
|
|
538
538
|
/**
|
|
539
|
-
* @public
|
|
540
539
|
* <p>
|
|
541
540
|
* Describes application output configuration in which you identify
|
|
542
541
|
* an in-application stream and a destination where you want the
|
|
@@ -549,142 +548,143 @@ export interface LambdaOutput {
|
|
|
549
548
|
* limitations, see
|
|
550
549
|
* <a href="https://docs.aws.amazon.com/kinesisanalytics/latest/dev/limits.html">Limits</a>.
|
|
551
550
|
* </p>
|
|
551
|
+
* @public
|
|
552
552
|
*/
|
|
553
553
|
export interface Output {
|
|
554
554
|
/**
|
|
555
|
-
* @public
|
|
556
555
|
* <p>Name of the in-application stream.</p>
|
|
556
|
+
* @public
|
|
557
557
|
*/
|
|
558
558
|
Name: string | undefined;
|
|
559
559
|
/**
|
|
560
|
-
* @public
|
|
561
560
|
* <p>Identifies an Amazon Kinesis stream
|
|
562
561
|
* as the destination.</p>
|
|
562
|
+
* @public
|
|
563
563
|
*/
|
|
564
564
|
KinesisStreamsOutput?: KinesisStreamsOutput;
|
|
565
565
|
/**
|
|
566
|
-
* @public
|
|
567
566
|
* <p>Identifies an Amazon Kinesis Firehose delivery stream as the destination.</p>
|
|
567
|
+
* @public
|
|
568
568
|
*/
|
|
569
569
|
KinesisFirehoseOutput?: KinesisFirehoseOutput;
|
|
570
570
|
/**
|
|
571
|
-
* @public
|
|
572
571
|
* <p>Identifies an AWS Lambda function as the destination.</p>
|
|
572
|
+
* @public
|
|
573
573
|
*/
|
|
574
574
|
LambdaOutput?: LambdaOutput;
|
|
575
575
|
/**
|
|
576
|
-
* @public
|
|
577
576
|
* <p>Describes the data format when records are written to the destination. For more information, see <a href="https://docs.aws.amazon.com/kinesisanalytics/latest/dev/how-it-works-output.html">Configuring Application Output</a>.</p>
|
|
577
|
+
* @public
|
|
578
578
|
*/
|
|
579
579
|
DestinationSchema: DestinationSchema | undefined;
|
|
580
580
|
}
|
|
581
581
|
/**
|
|
582
|
-
* @public
|
|
583
582
|
* <p></p>
|
|
583
|
+
* @public
|
|
584
584
|
*/
|
|
585
585
|
export interface AddApplicationOutputRequest {
|
|
586
586
|
/**
|
|
587
|
-
* @public
|
|
588
587
|
* <p>Name of the application to which you want to add the output configuration.</p>
|
|
588
|
+
* @public
|
|
589
589
|
*/
|
|
590
590
|
ApplicationName: string | undefined;
|
|
591
591
|
/**
|
|
592
|
-
* @public
|
|
593
592
|
* <p>Version of the application to which you want to add the output configuration. You
|
|
594
593
|
* can use the <a href="https://docs.aws.amazon.com/kinesisanalytics/latest/dev/API_DescribeApplication.html">DescribeApplication</a> operation to get the current
|
|
595
594
|
* application version. If the version specified is not the current version, the
|
|
596
595
|
* <code>ConcurrentModificationException</code> is returned. </p>
|
|
596
|
+
* @public
|
|
597
597
|
*/
|
|
598
598
|
CurrentApplicationVersionId: number | undefined;
|
|
599
599
|
/**
|
|
600
|
-
* @public
|
|
601
600
|
* <p>An array of objects, each describing one output configuration. In the output
|
|
602
601
|
* configuration, you specify the name of an in-application stream, a destination (that is,
|
|
603
602
|
* an Amazon Kinesis stream, an Amazon Kinesis Firehose delivery stream, or an AWS Lambda
|
|
604
603
|
* function), and record the formation to use when writing to the destination.</p>
|
|
604
|
+
* @public
|
|
605
605
|
*/
|
|
606
606
|
Output: Output | undefined;
|
|
607
607
|
}
|
|
608
608
|
/**
|
|
609
|
-
* @public
|
|
610
609
|
* <p></p>
|
|
610
|
+
* @public
|
|
611
611
|
*/
|
|
612
612
|
export interface AddApplicationOutputResponse {
|
|
613
613
|
}
|
|
614
614
|
/**
|
|
615
|
-
* @public
|
|
616
615
|
* <p>Identifies the S3 bucket and object that contains the reference data. Also identifies the IAM role Amazon Kinesis Analytics can assume to read this object on your behalf.</p>
|
|
617
616
|
* <p>An Amazon Kinesis Analytics application loads reference data only once. If the data changes,
|
|
618
617
|
* you call the <a href="https://docs.aws.amazon.com/kinesisanalytics/latest/dev/API_UpdateApplication.html">UpdateApplication</a> operation to trigger
|
|
619
618
|
* reloading of data into your application.</p>
|
|
619
|
+
* @public
|
|
620
620
|
*/
|
|
621
621
|
export interface S3ReferenceDataSource {
|
|
622
622
|
/**
|
|
623
|
-
* @public
|
|
624
623
|
* <p>Amazon Resource Name (ARN) of the S3 bucket.</p>
|
|
624
|
+
* @public
|
|
625
625
|
*/
|
|
626
626
|
BucketARN: string | undefined;
|
|
627
627
|
/**
|
|
628
|
-
* @public
|
|
629
628
|
* <p>Object key name containing reference data.</p>
|
|
629
|
+
* @public
|
|
630
630
|
*/
|
|
631
631
|
FileKey: string | undefined;
|
|
632
632
|
/**
|
|
633
|
-
* @public
|
|
634
633
|
* <p>ARN of the IAM role that the service can assume to read data on your behalf. This role must have permission for the <code>s3:GetObject</code> action on the object and trust policy that allows Amazon Kinesis Analytics service principal to assume this role.</p>
|
|
634
|
+
* @public
|
|
635
635
|
*/
|
|
636
636
|
ReferenceRoleARN: string | undefined;
|
|
637
637
|
}
|
|
638
638
|
/**
|
|
639
|
-
* @public
|
|
640
639
|
* <p>Describes the reference data source by providing the source information (S3 bucket name and object key name), the resulting in-application table name that is created, and the necessary schema to map the data elements in the Amazon S3 object to the in-application table.</p>
|
|
640
|
+
* @public
|
|
641
641
|
*/
|
|
642
642
|
export interface ReferenceDataSource {
|
|
643
643
|
/**
|
|
644
|
-
* @public
|
|
645
644
|
* <p>Name of the in-application table to create.</p>
|
|
645
|
+
* @public
|
|
646
646
|
*/
|
|
647
647
|
TableName: string | undefined;
|
|
648
648
|
/**
|
|
649
|
-
* @public
|
|
650
649
|
* <p>Identifies the S3 bucket and object that contains the reference data. Also identifies the IAM role Amazon Kinesis Analytics can assume to read this object on your behalf.
|
|
651
650
|
*
|
|
652
651
|
* An Amazon Kinesis Analytics application loads reference data only once. If the data changes, you call the <code>UpdateApplication</code> operation to trigger reloading of data into your application. </p>
|
|
652
|
+
* @public
|
|
653
653
|
*/
|
|
654
654
|
S3ReferenceDataSource?: S3ReferenceDataSource;
|
|
655
655
|
/**
|
|
656
|
-
* @public
|
|
657
656
|
* <p>Describes the format of the data in the streaming source, and how each data element maps to corresponding columns created in the in-application stream.</p>
|
|
657
|
+
* @public
|
|
658
658
|
*/
|
|
659
659
|
ReferenceSchema: SourceSchema | undefined;
|
|
660
660
|
}
|
|
661
661
|
/**
|
|
662
|
-
* @public
|
|
663
662
|
* <p></p>
|
|
663
|
+
* @public
|
|
664
664
|
*/
|
|
665
665
|
export interface AddApplicationReferenceDataSourceRequest {
|
|
666
666
|
/**
|
|
667
|
-
* @public
|
|
668
667
|
* <p>Name of an existing application.</p>
|
|
668
|
+
* @public
|
|
669
669
|
*/
|
|
670
670
|
ApplicationName: string | undefined;
|
|
671
671
|
/**
|
|
672
|
-
* @public
|
|
673
672
|
* <p>Version of the application for which you are adding the reference data source.
|
|
674
673
|
* You can use the <a href="https://docs.aws.amazon.com/kinesisanalytics/latest/dev/API_DescribeApplication.html">DescribeApplication</a> operation to get the current application version.
|
|
675
674
|
* If the version specified is not the current version, the
|
|
676
675
|
* <code>ConcurrentModificationException</code> is returned.</p>
|
|
676
|
+
* @public
|
|
677
677
|
*/
|
|
678
678
|
CurrentApplicationVersionId: number | undefined;
|
|
679
679
|
/**
|
|
680
|
-
* @public
|
|
681
680
|
* <p>The reference data source can be an object in your Amazon S3 bucket. Amazon Kinesis Analytics reads the object and copies the data into the in-application table that is created. You provide an S3 bucket, object key name, and the resulting in-application table that is created. You must also provide an IAM role with the necessary permissions that Amazon Kinesis Analytics can assume to read the object from your S3 bucket on your behalf.</p>
|
|
681
|
+
* @public
|
|
682
682
|
*/
|
|
683
683
|
ReferenceDataSource: ReferenceDataSource | undefined;
|
|
684
684
|
}
|
|
685
685
|
/**
|
|
686
|
-
* @public
|
|
687
686
|
* <p></p>
|
|
687
|
+
* @public
|
|
688
688
|
*/
|
|
689
689
|
export interface AddApplicationReferenceDataSourceResponse {
|
|
690
690
|
}
|
|
@@ -705,53 +705,53 @@ export declare const ApplicationStatus: {
|
|
|
705
705
|
*/
|
|
706
706
|
export type ApplicationStatus = (typeof ApplicationStatus)[keyof typeof ApplicationStatus];
|
|
707
707
|
/**
|
|
708
|
-
* @public
|
|
709
708
|
* <p>Description of the CloudWatch logging option.</p>
|
|
709
|
+
* @public
|
|
710
710
|
*/
|
|
711
711
|
export interface CloudWatchLoggingOptionDescription {
|
|
712
712
|
/**
|
|
713
|
-
* @public
|
|
714
713
|
* <p>ID of the CloudWatch logging option description.</p>
|
|
714
|
+
* @public
|
|
715
715
|
*/
|
|
716
716
|
CloudWatchLoggingOptionId?: string;
|
|
717
717
|
/**
|
|
718
|
-
* @public
|
|
719
718
|
* <p>ARN of the CloudWatch log to receive application messages.</p>
|
|
719
|
+
* @public
|
|
720
720
|
*/
|
|
721
721
|
LogStreamARN: string | undefined;
|
|
722
722
|
/**
|
|
723
|
-
* @public
|
|
724
723
|
* <p>IAM ARN of the role to use to send application messages. Note: To write application messages to CloudWatch, the IAM role used must have the <code>PutLogEvents</code> policy action enabled.</p>
|
|
724
|
+
* @public
|
|
725
725
|
*/
|
|
726
726
|
RoleARN: string | undefined;
|
|
727
727
|
}
|
|
728
728
|
/**
|
|
729
|
-
* @public
|
|
730
729
|
* <p>An object that contains the Amazon Resource Name (ARN) of the <a href="https://docs.aws.amazon.com/lambda/">AWS Lambda</a> function that
|
|
731
730
|
* is used to preprocess records in the stream, and the ARN of the IAM role that is used
|
|
732
731
|
* to access the AWS Lambda expression.</p>
|
|
732
|
+
* @public
|
|
733
733
|
*/
|
|
734
734
|
export interface InputLambdaProcessorDescription {
|
|
735
735
|
/**
|
|
736
|
-
* @public
|
|
737
736
|
* <p>The ARN of the <a href="https://docs.aws.amazon.com/lambda/">AWS Lambda</a> function that is used to preprocess the records in the stream.</p>
|
|
737
|
+
* @public
|
|
738
738
|
*/
|
|
739
739
|
ResourceARN?: string;
|
|
740
740
|
/**
|
|
741
|
-
* @public
|
|
742
741
|
* <p>The ARN of the IAM role that is used to access the AWS Lambda function.</p>
|
|
742
|
+
* @public
|
|
743
743
|
*/
|
|
744
744
|
RoleARN?: string;
|
|
745
745
|
}
|
|
746
746
|
/**
|
|
747
|
-
* @public
|
|
748
747
|
* <p>Provides configuration information about an input processor. Currently, the only input processor available is
|
|
749
748
|
* <a href="https://docs.aws.amazon.com/lambda/">AWS Lambda</a>.</p>
|
|
749
|
+
* @public
|
|
750
750
|
*/
|
|
751
751
|
export interface InputProcessingConfigurationDescription {
|
|
752
752
|
/**
|
|
753
|
-
* @public
|
|
754
753
|
* <p>Provides configuration information about the associated <a href="https://docs.aws.amazon.com/kinesisanalytics/latest/dev/API_InputLambdaProcessorDescription.html">InputLambdaProcessorDescription</a>.</p>
|
|
754
|
+
* @public
|
|
755
755
|
*/
|
|
756
756
|
InputLambdaProcessorDescription?: InputLambdaProcessorDescription;
|
|
757
757
|
}
|
|
@@ -769,13 +769,12 @@ export declare const InputStartingPosition: {
|
|
|
769
769
|
*/
|
|
770
770
|
export type InputStartingPosition = (typeof InputStartingPosition)[keyof typeof InputStartingPosition];
|
|
771
771
|
/**
|
|
772
|
-
* @public
|
|
773
772
|
* <p>Describes the point at which the application reads from
|
|
774
773
|
* the streaming source.</p>
|
|
774
|
+
* @public
|
|
775
775
|
*/
|
|
776
776
|
export interface InputStartingPositionConfiguration {
|
|
777
777
|
/**
|
|
778
|
-
* @public
|
|
779
778
|
* <p>The starting position on the stream.</p>
|
|
780
779
|
* <ul>
|
|
781
780
|
* <li>
|
|
@@ -796,768 +795,768 @@ export interface InputStartingPositionConfiguration {
|
|
|
796
795
|
* <code>LAST_STOPPED_POINT</code> - Resume reading from where the application last stopped reading.</p>
|
|
797
796
|
* </li>
|
|
798
797
|
* </ul>
|
|
798
|
+
* @public
|
|
799
799
|
*/
|
|
800
800
|
InputStartingPosition?: InputStartingPosition;
|
|
801
801
|
}
|
|
802
802
|
/**
|
|
803
|
-
* @public
|
|
804
803
|
* <p>
|
|
805
804
|
* Describes the Amazon Kinesis Firehose delivery stream that is configured as the streaming source
|
|
806
805
|
* in the application input configuration.
|
|
807
806
|
* </p>
|
|
807
|
+
* @public
|
|
808
808
|
*/
|
|
809
809
|
export interface KinesisFirehoseInputDescription {
|
|
810
810
|
/**
|
|
811
|
-
* @public
|
|
812
811
|
* <p>Amazon Resource Name (ARN) of the Amazon Kinesis Firehose delivery stream.</p>
|
|
812
|
+
* @public
|
|
813
813
|
*/
|
|
814
814
|
ResourceARN?: string;
|
|
815
815
|
/**
|
|
816
|
-
* @public
|
|
817
816
|
* <p>ARN of the IAM role that Amazon Kinesis Analytics assumes to access the stream.</p>
|
|
817
|
+
* @public
|
|
818
818
|
*/
|
|
819
819
|
RoleARN?: string;
|
|
820
820
|
}
|
|
821
821
|
/**
|
|
822
|
-
* @public
|
|
823
822
|
* <p>
|
|
824
823
|
* Describes the Amazon Kinesis stream that is configured as the streaming source
|
|
825
824
|
* in the application input configuration.
|
|
826
825
|
* </p>
|
|
826
|
+
* @public
|
|
827
827
|
*/
|
|
828
828
|
export interface KinesisStreamsInputDescription {
|
|
829
829
|
/**
|
|
830
|
-
* @public
|
|
831
830
|
* <p>Amazon Resource Name (ARN) of the Amazon Kinesis stream.</p>
|
|
831
|
+
* @public
|
|
832
832
|
*/
|
|
833
833
|
ResourceARN?: string;
|
|
834
834
|
/**
|
|
835
|
-
* @public
|
|
836
835
|
* <p>ARN of the IAM role that Amazon Kinesis Analytics can assume to access the stream.</p>
|
|
836
|
+
* @public
|
|
837
837
|
*/
|
|
838
838
|
RoleARN?: string;
|
|
839
839
|
}
|
|
840
840
|
/**
|
|
841
|
-
* @public
|
|
842
841
|
* <p>Describes the application input configuration.
|
|
843
842
|
* For more information,
|
|
844
843
|
* see <a href="https://docs.aws.amazon.com/kinesisanalytics/latest/dev/how-it-works-input.html">Configuring Application Input</a>.
|
|
845
844
|
* </p>
|
|
845
|
+
* @public
|
|
846
846
|
*/
|
|
847
847
|
export interface InputDescription {
|
|
848
848
|
/**
|
|
849
|
-
* @public
|
|
850
849
|
* <p>Input ID associated with the application input.
|
|
851
850
|
* This is the ID that Amazon Kinesis Analytics assigns to each
|
|
852
851
|
* input configuration you add to your application. </p>
|
|
852
|
+
* @public
|
|
853
853
|
*/
|
|
854
854
|
InputId?: string;
|
|
855
855
|
/**
|
|
856
|
-
* @public
|
|
857
856
|
* <p>In-application name prefix.</p>
|
|
857
|
+
* @public
|
|
858
858
|
*/
|
|
859
859
|
NamePrefix?: string;
|
|
860
860
|
/**
|
|
861
|
-
* @public
|
|
862
861
|
* <p>Returns the in-application stream names that are mapped to the
|
|
863
862
|
* stream source.</p>
|
|
863
|
+
* @public
|
|
864
864
|
*/
|
|
865
865
|
InAppStreamNames?: string[];
|
|
866
866
|
/**
|
|
867
|
-
* @public
|
|
868
867
|
* <p>The description of the preprocessor that executes on records in this input before the application's code is run.</p>
|
|
868
|
+
* @public
|
|
869
869
|
*/
|
|
870
870
|
InputProcessingConfigurationDescription?: InputProcessingConfigurationDescription;
|
|
871
871
|
/**
|
|
872
|
-
* @public
|
|
873
872
|
* <p>If an Amazon Kinesis stream is configured as streaming source, provides Amazon
|
|
874
873
|
* Kinesis stream's Amazon Resource Name (ARN) and an IAM role that enables Amazon Kinesis
|
|
875
874
|
* Analytics to access the stream on your behalf.</p>
|
|
875
|
+
* @public
|
|
876
876
|
*/
|
|
877
877
|
KinesisStreamsInputDescription?: KinesisStreamsInputDescription;
|
|
878
878
|
/**
|
|
879
|
-
* @public
|
|
880
879
|
* <p>If an Amazon Kinesis Firehose delivery stream is configured as a streaming source,
|
|
881
880
|
* provides the delivery stream's ARN and an IAM role that enables Amazon Kinesis Analytics
|
|
882
881
|
* to access the stream on your behalf.</p>
|
|
882
|
+
* @public
|
|
883
883
|
*/
|
|
884
884
|
KinesisFirehoseInputDescription?: KinesisFirehoseInputDescription;
|
|
885
885
|
/**
|
|
886
|
-
* @public
|
|
887
886
|
* <p>Describes the format of the data in the streaming source, and how each data element maps to corresponding
|
|
888
887
|
* columns in the in-application stream that is being created. </p>
|
|
888
|
+
* @public
|
|
889
889
|
*/
|
|
890
890
|
InputSchema?: SourceSchema;
|
|
891
891
|
/**
|
|
892
|
-
* @public
|
|
893
892
|
* <p>Describes the configured parallelism (number of in-application streams
|
|
894
893
|
* mapped to the streaming source).</p>
|
|
894
|
+
* @public
|
|
895
895
|
*/
|
|
896
896
|
InputParallelism?: InputParallelism;
|
|
897
897
|
/**
|
|
898
|
-
* @public
|
|
899
898
|
* <p>Point at which the application is configured to read from the input stream.</p>
|
|
899
|
+
* @public
|
|
900
900
|
*/
|
|
901
901
|
InputStartingPositionConfiguration?: InputStartingPositionConfiguration;
|
|
902
902
|
}
|
|
903
903
|
/**
|
|
904
|
-
* @public
|
|
905
904
|
* <p>
|
|
906
905
|
* For an application output, describes
|
|
907
906
|
* the Amazon Kinesis Firehose delivery stream configured as its destination.
|
|
908
907
|
* </p>
|
|
908
|
+
* @public
|
|
909
909
|
*/
|
|
910
910
|
export interface KinesisFirehoseOutputDescription {
|
|
911
911
|
/**
|
|
912
|
-
* @public
|
|
913
912
|
* <p>Amazon Resource Name (ARN) of the Amazon Kinesis Firehose delivery stream.</p>
|
|
913
|
+
* @public
|
|
914
914
|
*/
|
|
915
915
|
ResourceARN?: string;
|
|
916
916
|
/**
|
|
917
|
-
* @public
|
|
918
917
|
* <p>ARN of the IAM role that Amazon Kinesis Analytics can assume to access the stream.</p>
|
|
918
|
+
* @public
|
|
919
919
|
*/
|
|
920
920
|
RoleARN?: string;
|
|
921
921
|
}
|
|
922
922
|
/**
|
|
923
|
-
* @public
|
|
924
923
|
* <p>
|
|
925
924
|
* For an application output, describes
|
|
926
925
|
* the Amazon Kinesis stream configured as its destination.
|
|
927
926
|
* </p>
|
|
927
|
+
* @public
|
|
928
928
|
*/
|
|
929
929
|
export interface KinesisStreamsOutputDescription {
|
|
930
930
|
/**
|
|
931
|
-
* @public
|
|
932
931
|
* <p>Amazon Resource Name (ARN) of the Amazon Kinesis stream.</p>
|
|
932
|
+
* @public
|
|
933
933
|
*/
|
|
934
934
|
ResourceARN?: string;
|
|
935
935
|
/**
|
|
936
|
-
* @public
|
|
937
936
|
* <p>ARN of the IAM role that Amazon Kinesis Analytics can assume to access the stream.</p>
|
|
937
|
+
* @public
|
|
938
938
|
*/
|
|
939
939
|
RoleARN?: string;
|
|
940
940
|
}
|
|
941
941
|
/**
|
|
942
|
-
* @public
|
|
943
942
|
* <p>For an application output, describes the AWS Lambda function configured as its
|
|
944
943
|
* destination. </p>
|
|
944
|
+
* @public
|
|
945
945
|
*/
|
|
946
946
|
export interface LambdaOutputDescription {
|
|
947
947
|
/**
|
|
948
|
-
* @public
|
|
949
948
|
* <p>Amazon Resource Name (ARN) of the destination Lambda function.</p>
|
|
949
|
+
* @public
|
|
950
950
|
*/
|
|
951
951
|
ResourceARN?: string;
|
|
952
952
|
/**
|
|
953
|
-
* @public
|
|
954
953
|
* <p>ARN of the IAM role that Amazon Kinesis Analytics can assume to write to the destination function.</p>
|
|
954
|
+
* @public
|
|
955
955
|
*/
|
|
956
956
|
RoleARN?: string;
|
|
957
957
|
}
|
|
958
958
|
/**
|
|
959
|
-
* @public
|
|
960
959
|
* <p>Describes the application output configuration, which includes
|
|
961
960
|
* the in-application stream name and the destination where the stream data
|
|
962
961
|
* is written. The destination can be an Amazon Kinesis stream or an
|
|
963
962
|
* Amazon Kinesis Firehose delivery stream.
|
|
964
963
|
* </p>
|
|
964
|
+
* @public
|
|
965
965
|
*/
|
|
966
966
|
export interface OutputDescription {
|
|
967
967
|
/**
|
|
968
|
-
* @public
|
|
969
968
|
* <p>A unique identifier for the output configuration.</p>
|
|
969
|
+
* @public
|
|
970
970
|
*/
|
|
971
971
|
OutputId?: string;
|
|
972
972
|
/**
|
|
973
|
-
* @public
|
|
974
973
|
* <p>Name of the in-application stream configured as output.</p>
|
|
974
|
+
* @public
|
|
975
975
|
*/
|
|
976
976
|
Name?: string;
|
|
977
977
|
/**
|
|
978
|
-
* @public
|
|
979
978
|
* <p>Describes Amazon Kinesis stream configured as the
|
|
980
979
|
* destination where output is written.</p>
|
|
980
|
+
* @public
|
|
981
981
|
*/
|
|
982
982
|
KinesisStreamsOutputDescription?: KinesisStreamsOutputDescription;
|
|
983
983
|
/**
|
|
984
|
-
* @public
|
|
985
984
|
* <p>Describes the Amazon Kinesis Firehose delivery stream configured as the
|
|
986
985
|
* destination where output is written.</p>
|
|
986
|
+
* @public
|
|
987
987
|
*/
|
|
988
988
|
KinesisFirehoseOutputDescription?: KinesisFirehoseOutputDescription;
|
|
989
989
|
/**
|
|
990
|
-
* @public
|
|
991
990
|
* <p>Describes the AWS Lambda function configured as the destination where output is
|
|
992
991
|
* written.</p>
|
|
992
|
+
* @public
|
|
993
993
|
*/
|
|
994
994
|
LambdaOutputDescription?: LambdaOutputDescription;
|
|
995
995
|
/**
|
|
996
|
-
* @public
|
|
997
996
|
* <p>Data format used for writing data to the destination.</p>
|
|
997
|
+
* @public
|
|
998
998
|
*/
|
|
999
999
|
DestinationSchema?: DestinationSchema;
|
|
1000
1000
|
}
|
|
1001
1001
|
/**
|
|
1002
|
-
* @public
|
|
1003
1002
|
* <p>Provides the bucket name and object key name that stores the reference data.</p>
|
|
1003
|
+
* @public
|
|
1004
1004
|
*/
|
|
1005
1005
|
export interface S3ReferenceDataSourceDescription {
|
|
1006
1006
|
/**
|
|
1007
|
-
* @public
|
|
1008
1007
|
* <p>Amazon Resource Name (ARN) of the S3 bucket.</p>
|
|
1008
|
+
* @public
|
|
1009
1009
|
*/
|
|
1010
1010
|
BucketARN: string | undefined;
|
|
1011
1011
|
/**
|
|
1012
|
-
* @public
|
|
1013
1012
|
* <p>Amazon S3 object key name.</p>
|
|
1013
|
+
* @public
|
|
1014
1014
|
*/
|
|
1015
1015
|
FileKey: string | undefined;
|
|
1016
1016
|
/**
|
|
1017
|
-
* @public
|
|
1018
1017
|
* <p>ARN of the IAM role that Amazon Kinesis Analytics can assume to read the Amazon S3 object on your behalf to populate the in-application reference table.</p>
|
|
1018
|
+
* @public
|
|
1019
1019
|
*/
|
|
1020
1020
|
ReferenceRoleARN: string | undefined;
|
|
1021
1021
|
}
|
|
1022
1022
|
/**
|
|
1023
|
-
* @public
|
|
1024
1023
|
* <p>Describes the reference data source configured for an application.</p>
|
|
1024
|
+
* @public
|
|
1025
1025
|
*/
|
|
1026
1026
|
export interface ReferenceDataSourceDescription {
|
|
1027
1027
|
/**
|
|
1028
|
-
* @public
|
|
1029
1028
|
* <p>ID of the reference data source. This is the ID
|
|
1030
1029
|
* that Amazon Kinesis Analytics assigns when you add the reference data source
|
|
1031
1030
|
* to your application using the <a href="https://docs.aws.amazon.com/kinesisanalytics/latest/dev/API_AddApplicationReferenceDataSource.html">AddApplicationReferenceDataSource</a> operation.</p>
|
|
1031
|
+
* @public
|
|
1032
1032
|
*/
|
|
1033
1033
|
ReferenceId: string | undefined;
|
|
1034
1034
|
/**
|
|
1035
|
-
* @public
|
|
1036
1035
|
* <p>The in-application table name created by the specific reference data source configuration.</p>
|
|
1036
|
+
* @public
|
|
1037
1037
|
*/
|
|
1038
1038
|
TableName: string | undefined;
|
|
1039
1039
|
/**
|
|
1040
|
-
* @public
|
|
1041
1040
|
* <p>Provides the S3 bucket name, the object key name that contains the reference data. It also provides the Amazon Resource Name (ARN) of the IAM role that Amazon Kinesis Analytics can assume to read the Amazon S3 object and populate the in-application reference table.</p>
|
|
1041
|
+
* @public
|
|
1042
1042
|
*/
|
|
1043
1043
|
S3ReferenceDataSourceDescription: S3ReferenceDataSourceDescription | undefined;
|
|
1044
1044
|
/**
|
|
1045
|
-
* @public
|
|
1046
1045
|
* <p>Describes the format of the data in the streaming source, and how each data element maps to corresponding columns created in the in-application stream.</p>
|
|
1046
|
+
* @public
|
|
1047
1047
|
*/
|
|
1048
1048
|
ReferenceSchema?: SourceSchema;
|
|
1049
1049
|
}
|
|
1050
1050
|
/**
|
|
1051
|
-
* @public
|
|
1052
1051
|
* <note>
|
|
1053
1052
|
* <p>This documentation is for version 1 of the Amazon Kinesis Data Analytics API, which only supports SQL applications. Version 2 of the API supports SQL and Java applications. For more information about version 2, see <a href="/kinesisanalytics/latest/apiv2/Welcome.html">Amazon Kinesis Data Analytics API V2 Documentation</a>.</p>
|
|
1054
1053
|
* </note>
|
|
1055
1054
|
* <p>Provides a description of the application, including the application Amazon Resource Name (ARN), status, latest version, and input and output configuration.</p>
|
|
1055
|
+
* @public
|
|
1056
1056
|
*/
|
|
1057
1057
|
export interface ApplicationDetail {
|
|
1058
1058
|
/**
|
|
1059
|
-
* @public
|
|
1060
1059
|
* <p>Name of the application.</p>
|
|
1060
|
+
* @public
|
|
1061
1061
|
*/
|
|
1062
1062
|
ApplicationName: string | undefined;
|
|
1063
1063
|
/**
|
|
1064
|
-
* @public
|
|
1065
1064
|
* <p>Description of the application.</p>
|
|
1065
|
+
* @public
|
|
1066
1066
|
*/
|
|
1067
1067
|
ApplicationDescription?: string;
|
|
1068
1068
|
/**
|
|
1069
|
-
* @public
|
|
1070
1069
|
* <p>ARN of the application.</p>
|
|
1070
|
+
* @public
|
|
1071
1071
|
*/
|
|
1072
1072
|
ApplicationARN: string | undefined;
|
|
1073
1073
|
/**
|
|
1074
|
-
* @public
|
|
1075
1074
|
* <p>Status of the application.</p>
|
|
1075
|
+
* @public
|
|
1076
1076
|
*/
|
|
1077
1077
|
ApplicationStatus: ApplicationStatus | undefined;
|
|
1078
1078
|
/**
|
|
1079
|
-
* @public
|
|
1080
1079
|
* <p>Time stamp when the application version was created.</p>
|
|
1080
|
+
* @public
|
|
1081
1081
|
*/
|
|
1082
1082
|
CreateTimestamp?: Date;
|
|
1083
1083
|
/**
|
|
1084
|
-
* @public
|
|
1085
1084
|
* <p>Time stamp when the application was last updated.</p>
|
|
1085
|
+
* @public
|
|
1086
1086
|
*/
|
|
1087
1087
|
LastUpdateTimestamp?: Date;
|
|
1088
1088
|
/**
|
|
1089
|
-
* @public
|
|
1090
1089
|
* <p>Describes the application input configuration.
|
|
1091
1090
|
* For more information,
|
|
1092
1091
|
* see <a href="https://docs.aws.amazon.com/kinesisanalytics/latest/dev/how-it-works-input.html">Configuring Application Input</a>.
|
|
1093
1092
|
*
|
|
1094
1093
|
* </p>
|
|
1094
|
+
* @public
|
|
1095
1095
|
*/
|
|
1096
1096
|
InputDescriptions?: InputDescription[];
|
|
1097
1097
|
/**
|
|
1098
|
-
* @public
|
|
1099
1098
|
* <p>Describes the application output configuration.
|
|
1100
1099
|
* For more information,
|
|
1101
1100
|
* see <a href="https://docs.aws.amazon.com/kinesisanalytics/latest/dev/how-it-works-output.html">Configuring Application Output</a>.
|
|
1102
1101
|
*
|
|
1103
1102
|
* </p>
|
|
1103
|
+
* @public
|
|
1104
1104
|
*/
|
|
1105
1105
|
OutputDescriptions?: OutputDescription[];
|
|
1106
1106
|
/**
|
|
1107
|
-
* @public
|
|
1108
1107
|
* <p>Describes reference data sources configured for the application.
|
|
1109
1108
|
*
|
|
1110
1109
|
* For more information,
|
|
1111
1110
|
* see <a href="https://docs.aws.amazon.com/kinesisanalytics/latest/dev/how-it-works-input.html">Configuring Application Input</a>.
|
|
1112
1111
|
*
|
|
1113
1112
|
* </p>
|
|
1113
|
+
* @public
|
|
1114
1114
|
*/
|
|
1115
1115
|
ReferenceDataSourceDescriptions?: ReferenceDataSourceDescription[];
|
|
1116
1116
|
/**
|
|
1117
|
-
* @public
|
|
1118
1117
|
* <p>Describes the CloudWatch log streams that are configured to receive application
|
|
1119
1118
|
* messages. For more information about using CloudWatch log streams with Amazon Kinesis
|
|
1120
1119
|
* Analytics applications, see <a href="https://docs.aws.amazon.com/kinesisanalytics/latest/dev/cloudwatch-logs.html">Working with Amazon
|
|
1121
1120
|
* CloudWatch Logs</a>. </p>
|
|
1121
|
+
* @public
|
|
1122
1122
|
*/
|
|
1123
1123
|
CloudWatchLoggingOptionDescriptions?: CloudWatchLoggingOptionDescription[];
|
|
1124
1124
|
/**
|
|
1125
|
-
* @public
|
|
1126
1125
|
* <p>Returns the application code that you provided to perform data analysis on any of the in-application streams in your application.</p>
|
|
1126
|
+
* @public
|
|
1127
1127
|
*/
|
|
1128
1128
|
ApplicationCode?: string;
|
|
1129
1129
|
/**
|
|
1130
|
-
* @public
|
|
1131
1130
|
* <p>Provides the current application version.</p>
|
|
1131
|
+
* @public
|
|
1132
1132
|
*/
|
|
1133
1133
|
ApplicationVersionId: number | undefined;
|
|
1134
1134
|
}
|
|
1135
1135
|
/**
|
|
1136
|
-
* @public
|
|
1137
1136
|
* <note>
|
|
1138
1137
|
* <p>This documentation is for version 1 of the Amazon Kinesis Data Analytics API, which only supports SQL applications. Version 2 of the API supports SQL and Java applications. For more information about version 2, see <a href="/kinesisanalytics/latest/apiv2/Welcome.html">Amazon Kinesis Data Analytics API V2 Documentation</a>.</p>
|
|
1139
1138
|
* </note>
|
|
1140
1139
|
* <p>Provides application summary information, including the application Amazon Resource Name (ARN), name, and status.</p>
|
|
1140
|
+
* @public
|
|
1141
1141
|
*/
|
|
1142
1142
|
export interface ApplicationSummary {
|
|
1143
1143
|
/**
|
|
1144
|
-
* @public
|
|
1145
1144
|
* <p>Name of the application.</p>
|
|
1145
|
+
* @public
|
|
1146
1146
|
*/
|
|
1147
1147
|
ApplicationName: string | undefined;
|
|
1148
1148
|
/**
|
|
1149
|
-
* @public
|
|
1150
1149
|
* <p>ARN of the application.</p>
|
|
1150
|
+
* @public
|
|
1151
1151
|
*/
|
|
1152
1152
|
ApplicationARN: string | undefined;
|
|
1153
1153
|
/**
|
|
1154
|
-
* @public
|
|
1155
1154
|
* <p>Status of the application.</p>
|
|
1155
|
+
* @public
|
|
1156
1156
|
*/
|
|
1157
1157
|
ApplicationStatus: ApplicationStatus | undefined;
|
|
1158
1158
|
}
|
|
1159
1159
|
/**
|
|
1160
|
-
* @public
|
|
1161
1160
|
* <p>Describes CloudWatch logging option updates.</p>
|
|
1161
|
+
* @public
|
|
1162
1162
|
*/
|
|
1163
1163
|
export interface CloudWatchLoggingOptionUpdate {
|
|
1164
1164
|
/**
|
|
1165
|
-
* @public
|
|
1166
1165
|
* <p>ID of the CloudWatch logging option to update</p>
|
|
1166
|
+
* @public
|
|
1167
1167
|
*/
|
|
1168
1168
|
CloudWatchLoggingOptionId: string | undefined;
|
|
1169
1169
|
/**
|
|
1170
|
-
* @public
|
|
1171
1170
|
* <p>ARN of the CloudWatch log to receive application messages.</p>
|
|
1171
|
+
* @public
|
|
1172
1172
|
*/
|
|
1173
1173
|
LogStreamARNUpdate?: string;
|
|
1174
1174
|
/**
|
|
1175
|
-
* @public
|
|
1176
1175
|
* <p>IAM ARN of the role to use to send application messages. Note: To write application messages to CloudWatch, the IAM role used must have the <code>PutLogEvents</code> policy action enabled.</p>
|
|
1176
|
+
* @public
|
|
1177
1177
|
*/
|
|
1178
1178
|
RoleARNUpdate?: string;
|
|
1179
1179
|
}
|
|
1180
1180
|
/**
|
|
1181
|
-
* @public
|
|
1182
1181
|
* <p>Provides updates to the parallelism count.</p>
|
|
1182
|
+
* @public
|
|
1183
1183
|
*/
|
|
1184
1184
|
export interface InputParallelismUpdate {
|
|
1185
1185
|
/**
|
|
1186
|
-
* @public
|
|
1187
1186
|
* <p>Number of in-application streams to create for the specified
|
|
1188
1187
|
* streaming source.</p>
|
|
1188
|
+
* @public
|
|
1189
1189
|
*/
|
|
1190
1190
|
CountUpdate?: number;
|
|
1191
1191
|
}
|
|
1192
1192
|
/**
|
|
1193
|
-
* @public
|
|
1194
1193
|
* <p>Represents an update to the <a href="https://docs.aws.amazon.com/kinesisanalytics/latest/dev/API_InputLambdaProcessor.html">InputLambdaProcessor</a> that is used to preprocess the records in the stream.</p>
|
|
1194
|
+
* @public
|
|
1195
1195
|
*/
|
|
1196
1196
|
export interface InputLambdaProcessorUpdate {
|
|
1197
1197
|
/**
|
|
1198
|
-
* @public
|
|
1199
1198
|
* <p>The Amazon Resource Name (ARN) of the new <a href="https://docs.aws.amazon.com/lambda/">AWS Lambda</a> function that
|
|
1200
1199
|
* is used to preprocess the records in the stream.</p>
|
|
1201
1200
|
* <note>
|
|
1202
1201
|
* <p>To specify an earlier version of the Lambda function than the latest, include the Lambda function version in the Lambda function ARN. For more information about Lambda ARNs, see <a href="/general/latest/gr/aws-arns-and-namespaces.html#arn-syntax-lambda">Example ARNs: AWS Lambda</a>
|
|
1203
1202
|
* </p>
|
|
1204
1203
|
* </note>
|
|
1204
|
+
* @public
|
|
1205
1205
|
*/
|
|
1206
1206
|
ResourceARNUpdate?: string;
|
|
1207
1207
|
/**
|
|
1208
|
-
* @public
|
|
1209
1208
|
* <p>The ARN of the new IAM role that is used to access the AWS Lambda
|
|
1210
1209
|
* function.</p>
|
|
1210
|
+
* @public
|
|
1211
1211
|
*/
|
|
1212
1212
|
RoleARNUpdate?: string;
|
|
1213
1213
|
}
|
|
1214
1214
|
/**
|
|
1215
|
-
* @public
|
|
1216
1215
|
* <p>Describes updates to an <a href="https://docs.aws.amazon.com/kinesisanalytics/latest/dev/API_InputProcessingConfiguration.html">InputProcessingConfiguration</a>. </p>
|
|
1216
|
+
* @public
|
|
1217
1217
|
*/
|
|
1218
1218
|
export interface InputProcessingConfigurationUpdate {
|
|
1219
1219
|
/**
|
|
1220
|
-
* @public
|
|
1221
1220
|
* <p>Provides update information for an <a href="https://docs.aws.amazon.com/kinesisanalytics/latest/dev/API_InputLambdaProcessor.html">InputLambdaProcessor</a>.</p>
|
|
1221
|
+
* @public
|
|
1222
1222
|
*/
|
|
1223
1223
|
InputLambdaProcessorUpdate: InputLambdaProcessorUpdate | undefined;
|
|
1224
1224
|
}
|
|
1225
1225
|
/**
|
|
1226
|
-
* @public
|
|
1227
1226
|
* <p>Describes updates for the application's input schema.</p>
|
|
1227
|
+
* @public
|
|
1228
1228
|
*/
|
|
1229
1229
|
export interface InputSchemaUpdate {
|
|
1230
1230
|
/**
|
|
1231
|
-
* @public
|
|
1232
1231
|
* <p>Specifies the format of the records on the streaming source.</p>
|
|
1232
|
+
* @public
|
|
1233
1233
|
*/
|
|
1234
1234
|
RecordFormatUpdate?: RecordFormat;
|
|
1235
1235
|
/**
|
|
1236
|
-
* @public
|
|
1237
1236
|
* <p>Specifies the encoding of the records in the streaming source. For example, UTF-8.</p>
|
|
1237
|
+
* @public
|
|
1238
1238
|
*/
|
|
1239
1239
|
RecordEncodingUpdate?: string;
|
|
1240
1240
|
/**
|
|
1241
|
-
* @public
|
|
1242
1241
|
* <p>A list of <code>RecordColumn</code> objects. Each object describes the mapping
|
|
1243
1242
|
* of the streaming source element to the corresponding column in the in-application stream. </p>
|
|
1243
|
+
* @public
|
|
1244
1244
|
*/
|
|
1245
1245
|
RecordColumnUpdates?: RecordColumn[];
|
|
1246
1246
|
}
|
|
1247
1247
|
/**
|
|
1248
|
-
* @public
|
|
1249
1248
|
* <p>When updating application input configuration, provides information about an
|
|
1250
1249
|
* Amazon Kinesis Firehose delivery stream as the streaming source.</p>
|
|
1250
|
+
* @public
|
|
1251
1251
|
*/
|
|
1252
1252
|
export interface KinesisFirehoseInputUpdate {
|
|
1253
1253
|
/**
|
|
1254
|
-
* @public
|
|
1255
1254
|
* <p>Amazon Resource Name (ARN) of the input Amazon Kinesis Firehose delivery stream to
|
|
1256
1255
|
* read.</p>
|
|
1256
|
+
* @public
|
|
1257
1257
|
*/
|
|
1258
1258
|
ResourceARNUpdate?: string;
|
|
1259
1259
|
/**
|
|
1260
|
-
* @public
|
|
1261
1260
|
* <p>ARN of the IAM role that Amazon Kinesis Analytics can assume to access the stream
|
|
1262
1261
|
* on your behalf. You need to grant the necessary permissions to this role.</p>
|
|
1262
|
+
* @public
|
|
1263
1263
|
*/
|
|
1264
1264
|
RoleARNUpdate?: string;
|
|
1265
1265
|
}
|
|
1266
1266
|
/**
|
|
1267
|
-
* @public
|
|
1268
1267
|
* <p>When updating application input configuration, provides information about an
|
|
1269
1268
|
* Amazon Kinesis stream as the streaming source.</p>
|
|
1269
|
+
* @public
|
|
1270
1270
|
*/
|
|
1271
1271
|
export interface KinesisStreamsInputUpdate {
|
|
1272
1272
|
/**
|
|
1273
|
-
* @public
|
|
1274
1273
|
* <p>Amazon Resource Name (ARN) of the input Amazon Kinesis stream to read.</p>
|
|
1274
|
+
* @public
|
|
1275
1275
|
*/
|
|
1276
1276
|
ResourceARNUpdate?: string;
|
|
1277
1277
|
/**
|
|
1278
|
-
* @public
|
|
1279
1278
|
* <p>ARN of the IAM role that Amazon Kinesis Analytics can assume to access the stream on your behalf. You need to grant the necessary permissions to this role.</p>
|
|
1279
|
+
* @public
|
|
1280
1280
|
*/
|
|
1281
1281
|
RoleARNUpdate?: string;
|
|
1282
1282
|
}
|
|
1283
1283
|
/**
|
|
1284
|
-
* @public
|
|
1285
1284
|
* <p>Describes updates to a specific input configuration (identified by the
|
|
1286
1285
|
* <code>InputId</code> of an application). </p>
|
|
1286
|
+
* @public
|
|
1287
1287
|
*/
|
|
1288
1288
|
export interface InputUpdate {
|
|
1289
1289
|
/**
|
|
1290
|
-
* @public
|
|
1291
1290
|
* <p>Input ID of the application input to be updated.</p>
|
|
1291
|
+
* @public
|
|
1292
1292
|
*/
|
|
1293
1293
|
InputId: string | undefined;
|
|
1294
1294
|
/**
|
|
1295
|
-
* @public
|
|
1296
1295
|
* <p>Name prefix for in-application streams that Amazon Kinesis Analytics creates
|
|
1297
1296
|
* for the specific streaming source.</p>
|
|
1297
|
+
* @public
|
|
1298
1298
|
*/
|
|
1299
1299
|
NamePrefixUpdate?: string;
|
|
1300
1300
|
/**
|
|
1301
|
-
* @public
|
|
1302
1301
|
* <p>Describes updates for an input processing configuration.</p>
|
|
1302
|
+
* @public
|
|
1303
1303
|
*/
|
|
1304
1304
|
InputProcessingConfigurationUpdate?: InputProcessingConfigurationUpdate;
|
|
1305
1305
|
/**
|
|
1306
|
-
* @public
|
|
1307
1306
|
* <p>If an Amazon Kinesis stream is the streaming source to be updated, provides an
|
|
1308
1307
|
* updated stream Amazon Resource Name (ARN) and IAM role ARN.</p>
|
|
1308
|
+
* @public
|
|
1309
1309
|
*/
|
|
1310
1310
|
KinesisStreamsInputUpdate?: KinesisStreamsInputUpdate;
|
|
1311
1311
|
/**
|
|
1312
|
-
* @public
|
|
1313
1312
|
* <p>If an Amazon Kinesis Firehose delivery stream is the streaming source to be
|
|
1314
1313
|
* updated, provides an updated stream ARN and IAM role ARN.</p>
|
|
1314
|
+
* @public
|
|
1315
1315
|
*/
|
|
1316
1316
|
KinesisFirehoseInputUpdate?: KinesisFirehoseInputUpdate;
|
|
1317
1317
|
/**
|
|
1318
|
-
* @public
|
|
1319
1318
|
* <p>Describes the data format on the streaming source, and
|
|
1320
1319
|
* how record elements on the streaming source map to columns of the in-application stream that is created.</p>
|
|
1320
|
+
* @public
|
|
1321
1321
|
*/
|
|
1322
1322
|
InputSchemaUpdate?: InputSchemaUpdate;
|
|
1323
1323
|
/**
|
|
1324
|
-
* @public
|
|
1325
1324
|
* <p>Describes the parallelism updates (the number in-application
|
|
1326
1325
|
* streams Amazon Kinesis Analytics creates for the specific streaming source).</p>
|
|
1326
|
+
* @public
|
|
1327
1327
|
*/
|
|
1328
1328
|
InputParallelismUpdate?: InputParallelismUpdate;
|
|
1329
1329
|
}
|
|
1330
1330
|
/**
|
|
1331
|
-
* @public
|
|
1332
1331
|
* <p>
|
|
1333
1332
|
* When updating an output configuration using the
|
|
1334
1333
|
* <a href="https://docs.aws.amazon.com/kinesisanalytics/latest/dev/API_UpdateApplication.html">UpdateApplication</a> operation,
|
|
1335
1334
|
* provides information about an Amazon Kinesis Firehose delivery stream configured as
|
|
1336
1335
|
* the destination.
|
|
1337
1336
|
* </p>
|
|
1337
|
+
* @public
|
|
1338
1338
|
*/
|
|
1339
1339
|
export interface KinesisFirehoseOutputUpdate {
|
|
1340
1340
|
/**
|
|
1341
|
-
* @public
|
|
1342
1341
|
* <p>Amazon Resource Name (ARN) of the Amazon Kinesis Firehose delivery stream to write to.</p>
|
|
1342
|
+
* @public
|
|
1343
1343
|
*/
|
|
1344
1344
|
ResourceARNUpdate?: string;
|
|
1345
1345
|
/**
|
|
1346
|
-
* @public
|
|
1347
1346
|
* <p>ARN of the IAM role that Amazon Kinesis Analytics can assume to access the stream
|
|
1348
1347
|
* on your behalf. You need to grant the necessary permissions to this role.</p>
|
|
1348
|
+
* @public
|
|
1349
1349
|
*/
|
|
1350
1350
|
RoleARNUpdate?: string;
|
|
1351
1351
|
}
|
|
1352
1352
|
/**
|
|
1353
|
-
* @public
|
|
1354
1353
|
* <p>
|
|
1355
1354
|
* When updating an output configuration using the
|
|
1356
1355
|
* <a href="https://docs.aws.amazon.com/kinesisanalytics/latest/dev/API_UpdateApplication.html">UpdateApplication</a> operation,
|
|
1357
1356
|
* provides information about an Amazon Kinesis stream configured as
|
|
1358
1357
|
* the destination.
|
|
1359
1358
|
* </p>
|
|
1359
|
+
* @public
|
|
1360
1360
|
*/
|
|
1361
1361
|
export interface KinesisStreamsOutputUpdate {
|
|
1362
1362
|
/**
|
|
1363
|
-
* @public
|
|
1364
1363
|
* <p>Amazon Resource Name (ARN) of the Amazon Kinesis stream where you want to write the output.</p>
|
|
1364
|
+
* @public
|
|
1365
1365
|
*/
|
|
1366
1366
|
ResourceARNUpdate?: string;
|
|
1367
1367
|
/**
|
|
1368
|
-
* @public
|
|
1369
1368
|
* <p>ARN of the IAM role that Amazon Kinesis Analytics can assume to access the stream on your behalf. You need to grant the necessary permissions to this role.</p>
|
|
1369
|
+
* @public
|
|
1370
1370
|
*/
|
|
1371
1371
|
RoleARNUpdate?: string;
|
|
1372
1372
|
}
|
|
1373
1373
|
/**
|
|
1374
|
-
* @public
|
|
1375
1374
|
* <p>When updating an output configuration using the <a href="https://docs.aws.amazon.com/kinesisanalytics/latest/dev/API_UpdateApplication.html">UpdateApplication</a>
|
|
1376
1375
|
* operation, provides information about an AWS Lambda function configured as the
|
|
1377
1376
|
* destination.</p>
|
|
1377
|
+
* @public
|
|
1378
1378
|
*/
|
|
1379
1379
|
export interface LambdaOutputUpdate {
|
|
1380
1380
|
/**
|
|
1381
|
-
* @public
|
|
1382
1381
|
* <p>Amazon Resource Name (ARN) of the destination Lambda function.</p>
|
|
1383
1382
|
* <note>
|
|
1384
1383
|
* <p>To specify an earlier version of the Lambda function than the latest, include the Lambda function version in the Lambda function ARN. For more information about Lambda ARNs, see <a href="/general/latest/gr/aws-arns-and-namespaces.html#arn-syntax-lambda">Example ARNs: AWS Lambda</a>
|
|
1385
1384
|
* </p>
|
|
1386
1385
|
* </note>
|
|
1386
|
+
* @public
|
|
1387
1387
|
*/
|
|
1388
1388
|
ResourceARNUpdate?: string;
|
|
1389
1389
|
/**
|
|
1390
|
-
* @public
|
|
1391
1390
|
* <p>ARN of the IAM role that Amazon Kinesis Analytics can assume to write to the destination function on your behalf. You need to grant the necessary permissions to this role. </p>
|
|
1391
|
+
* @public
|
|
1392
1392
|
*/
|
|
1393
1393
|
RoleARNUpdate?: string;
|
|
1394
1394
|
}
|
|
1395
1395
|
/**
|
|
1396
|
-
* @public
|
|
1397
1396
|
* <p>
|
|
1398
1397
|
* Describes updates to the output configuration identified by
|
|
1399
1398
|
* the <code>OutputId</code>.
|
|
1400
1399
|
* </p>
|
|
1400
|
+
* @public
|
|
1401
1401
|
*/
|
|
1402
1402
|
export interface OutputUpdate {
|
|
1403
1403
|
/**
|
|
1404
|
-
* @public
|
|
1405
1404
|
* <p>Identifies the specific output configuration that you want to update.</p>
|
|
1405
|
+
* @public
|
|
1406
1406
|
*/
|
|
1407
1407
|
OutputId: string | undefined;
|
|
1408
1408
|
/**
|
|
1409
|
-
* @public
|
|
1410
1409
|
* <p>If you want to specify a different in-application stream
|
|
1411
1410
|
* for this output configuration, use this field to
|
|
1412
1411
|
* specify the new in-application stream name.</p>
|
|
1412
|
+
* @public
|
|
1413
1413
|
*/
|
|
1414
1414
|
NameUpdate?: string;
|
|
1415
1415
|
/**
|
|
1416
|
-
* @public
|
|
1417
1416
|
* <p>Describes an Amazon Kinesis stream as the destination for the output.</p>
|
|
1417
|
+
* @public
|
|
1418
1418
|
*/
|
|
1419
1419
|
KinesisStreamsOutputUpdate?: KinesisStreamsOutputUpdate;
|
|
1420
1420
|
/**
|
|
1421
|
-
* @public
|
|
1422
1421
|
* <p>Describes an Amazon Kinesis Firehose delivery stream as the destination for the
|
|
1423
1422
|
* output.</p>
|
|
1423
|
+
* @public
|
|
1424
1424
|
*/
|
|
1425
1425
|
KinesisFirehoseOutputUpdate?: KinesisFirehoseOutputUpdate;
|
|
1426
1426
|
/**
|
|
1427
|
-
* @public
|
|
1428
1427
|
* <p>Describes an AWS Lambda function as the destination for the output.</p>
|
|
1428
|
+
* @public
|
|
1429
1429
|
*/
|
|
1430
1430
|
LambdaOutputUpdate?: LambdaOutputUpdate;
|
|
1431
1431
|
/**
|
|
1432
|
-
* @public
|
|
1433
1432
|
* <p>Describes the data format when records are written to the destination. For more information, see <a href="https://docs.aws.amazon.com/kinesisanalytics/latest/dev/how-it-works-output.html">Configuring Application Output</a>.</p>
|
|
1433
|
+
* @public
|
|
1434
1434
|
*/
|
|
1435
1435
|
DestinationSchemaUpdate?: DestinationSchema;
|
|
1436
1436
|
}
|
|
1437
1437
|
/**
|
|
1438
|
-
* @public
|
|
1439
1438
|
* <p>Describes the S3 bucket name, object key name, and IAM role that Amazon Kinesis Analytics can assume to read the Amazon S3 object on your behalf and populate the in-application reference table.</p>
|
|
1439
|
+
* @public
|
|
1440
1440
|
*/
|
|
1441
1441
|
export interface S3ReferenceDataSourceUpdate {
|
|
1442
1442
|
/**
|
|
1443
|
-
* @public
|
|
1444
1443
|
* <p>Amazon Resource Name (ARN) of the S3 bucket.</p>
|
|
1444
|
+
* @public
|
|
1445
1445
|
*/
|
|
1446
1446
|
BucketARNUpdate?: string;
|
|
1447
1447
|
/**
|
|
1448
|
-
* @public
|
|
1449
1448
|
* <p>Object key name.</p>
|
|
1449
|
+
* @public
|
|
1450
1450
|
*/
|
|
1451
1451
|
FileKeyUpdate?: string;
|
|
1452
1452
|
/**
|
|
1453
|
-
* @public
|
|
1454
1453
|
* <p>ARN of the IAM role that Amazon Kinesis Analytics can assume to read the Amazon S3 object and populate the in-application.</p>
|
|
1454
|
+
* @public
|
|
1455
1455
|
*/
|
|
1456
1456
|
ReferenceRoleARNUpdate?: string;
|
|
1457
1457
|
}
|
|
1458
1458
|
/**
|
|
1459
|
-
* @public
|
|
1460
1459
|
* <p>When you update a reference data source configuration for an application, this object provides all the updated values (such as the source bucket name and object key name), the in-application table name that is created, and updated mapping information that maps the data in the Amazon S3 object to the in-application reference table that is created.</p>
|
|
1460
|
+
* @public
|
|
1461
1461
|
*/
|
|
1462
1462
|
export interface ReferenceDataSourceUpdate {
|
|
1463
1463
|
/**
|
|
1464
|
-
* @public
|
|
1465
1464
|
* <p>ID of the reference data source being updated. You can use the
|
|
1466
1465
|
* <a href="https://docs.aws.amazon.com/kinesisanalytics/latest/dev/API_DescribeApplication.html">DescribeApplication</a> operation to get this value.</p>
|
|
1466
|
+
* @public
|
|
1467
1467
|
*/
|
|
1468
1468
|
ReferenceId: string | undefined;
|
|
1469
1469
|
/**
|
|
1470
|
-
* @public
|
|
1471
1470
|
* <p>In-application table name that is created by this update.</p>
|
|
1471
|
+
* @public
|
|
1472
1472
|
*/
|
|
1473
1473
|
TableNameUpdate?: string;
|
|
1474
1474
|
/**
|
|
1475
|
-
* @public
|
|
1476
1475
|
* <p>Describes the S3 bucket name, object key name, and IAM role that Amazon Kinesis Analytics can assume to read the Amazon S3 object on your behalf and populate the in-application reference table.</p>
|
|
1476
|
+
* @public
|
|
1477
1477
|
*/
|
|
1478
1478
|
S3ReferenceDataSourceUpdate?: S3ReferenceDataSourceUpdate;
|
|
1479
1479
|
/**
|
|
1480
|
-
* @public
|
|
1481
1480
|
* <p>Describes the format of the data in the streaming source, and how each data element maps to corresponding columns created in the in-application stream. </p>
|
|
1481
|
+
* @public
|
|
1482
1482
|
*/
|
|
1483
1483
|
ReferenceSchemaUpdate?: SourceSchema;
|
|
1484
1484
|
}
|
|
1485
1485
|
/**
|
|
1486
|
-
* @public
|
|
1487
1486
|
* <p>Describes updates to apply to an existing Amazon Kinesis Analytics application.</p>
|
|
1487
|
+
* @public
|
|
1488
1488
|
*/
|
|
1489
1489
|
export interface ApplicationUpdate {
|
|
1490
1490
|
/**
|
|
1491
|
-
* @public
|
|
1492
1491
|
* <p>Describes application input configuration updates.</p>
|
|
1492
|
+
* @public
|
|
1493
1493
|
*/
|
|
1494
1494
|
InputUpdates?: InputUpdate[];
|
|
1495
1495
|
/**
|
|
1496
|
-
* @public
|
|
1497
1496
|
* <p>Describes application code updates.</p>
|
|
1497
|
+
* @public
|
|
1498
1498
|
*/
|
|
1499
1499
|
ApplicationCodeUpdate?: string;
|
|
1500
1500
|
/**
|
|
1501
|
-
* @public
|
|
1502
1501
|
* <p>Describes application output configuration updates.</p>
|
|
1502
|
+
* @public
|
|
1503
1503
|
*/
|
|
1504
1504
|
OutputUpdates?: OutputUpdate[];
|
|
1505
1505
|
/**
|
|
1506
|
-
* @public
|
|
1507
1506
|
* <p>Describes application reference data source updates.</p>
|
|
1507
|
+
* @public
|
|
1508
1508
|
*/
|
|
1509
1509
|
ReferenceDataSourceUpdates?: ReferenceDataSourceUpdate[];
|
|
1510
1510
|
/**
|
|
1511
|
-
* @public
|
|
1512
1511
|
* <p>Describes application CloudWatch logging option updates.</p>
|
|
1512
|
+
* @public
|
|
1513
1513
|
*/
|
|
1514
1514
|
CloudWatchLoggingOptionUpdates?: CloudWatchLoggingOptionUpdate[];
|
|
1515
1515
|
}
|
|
1516
1516
|
/**
|
|
1517
|
-
* @public
|
|
1518
1517
|
* <p>A key-value pair (the value is optional) that you can define and assign to AWS resources. If you specify a tag that already exists, the tag value is replaced with the value that you specify in the request. Note that
|
|
1519
1518
|
* the maximum number of application tags includes system tags. The maximum number of user-defined application tags is 50.
|
|
1520
1519
|
* For more information, see <a href="https://docs.aws.amazon.com/kinesisanalytics/latest/dev/how-tagging.html">Using Tagging</a>.</p>
|
|
1520
|
+
* @public
|
|
1521
1521
|
*/
|
|
1522
1522
|
export interface Tag {
|
|
1523
1523
|
/**
|
|
1524
|
-
* @public
|
|
1525
1524
|
* <p>The key of the key-value tag.</p>
|
|
1525
|
+
* @public
|
|
1526
1526
|
*/
|
|
1527
1527
|
Key: string | undefined;
|
|
1528
1528
|
/**
|
|
1529
|
-
* @public
|
|
1530
1529
|
* <p>The value of the key-value tag. The value is optional.</p>
|
|
1530
|
+
* @public
|
|
1531
1531
|
*/
|
|
1532
1532
|
Value?: string;
|
|
1533
1533
|
}
|
|
1534
1534
|
/**
|
|
1535
|
-
* @public
|
|
1536
1535
|
* <p>TBD</p>
|
|
1536
|
+
* @public
|
|
1537
1537
|
*/
|
|
1538
1538
|
export interface CreateApplicationRequest {
|
|
1539
1539
|
/**
|
|
1540
|
-
* @public
|
|
1541
1540
|
* <p>Name of your Amazon Kinesis Analytics application (for example, <code>sample-app</code>).</p>
|
|
1541
|
+
* @public
|
|
1542
1542
|
*/
|
|
1543
1543
|
ApplicationName: string | undefined;
|
|
1544
1544
|
/**
|
|
1545
|
-
* @public
|
|
1546
1545
|
* <p>Summary description of the application.</p>
|
|
1546
|
+
* @public
|
|
1547
1547
|
*/
|
|
1548
1548
|
ApplicationDescription?: string;
|
|
1549
1549
|
/**
|
|
1550
|
-
* @public
|
|
1551
1550
|
* <p>Use this parameter to configure the application input.</p>
|
|
1552
1551
|
* <p>You can configure your application to receive input from a single streaming source. In this configuration, you map this streaming source to an in-application stream that is created. Your application code can then query the in-application stream like a table (you can think of it as a constantly updating table).</p>
|
|
1553
1552
|
* <p>For the streaming source, you provide its Amazon Resource Name (ARN) and format of
|
|
1554
1553
|
* data on the stream (for example, JSON, CSV, etc.). You also must provide an IAM role
|
|
1555
1554
|
* that Amazon Kinesis Analytics can assume to read this stream on your behalf.</p>
|
|
1556
1555
|
* <p>To create the in-application stream, you need to specify a schema to transform your data into a schematized version used in SQL. In the schema, you provide the necessary mapping of the data elements in the streaming source to record columns in the in-app stream.</p>
|
|
1556
|
+
* @public
|
|
1557
1557
|
*/
|
|
1558
1558
|
Inputs?: Input[];
|
|
1559
1559
|
/**
|
|
1560
|
-
* @public
|
|
1561
1560
|
* <p>You can configure application output to write data from any of the in-application streams to up to three destinations.</p>
|
|
1562
1561
|
* <p>These destinations can be Amazon Kinesis streams, Amazon Kinesis Firehose delivery
|
|
1563
1562
|
* streams, AWS Lambda destinations, or any combination of the three.</p>
|
|
@@ -1566,17 +1565,17 @@ export interface CreateApplicationRequest {
|
|
|
1566
1565
|
* <p>In the output configuration, you also provide the output stream or Lambda function ARN. For stream destinations, you provide the format
|
|
1567
1566
|
* of data in the stream (for example, JSON, CSV). You also must provide an IAM role that
|
|
1568
1567
|
* Amazon Kinesis Analytics can assume to write to the stream or Lambda function on your behalf.</p>
|
|
1568
|
+
* @public
|
|
1569
1569
|
*/
|
|
1570
1570
|
Outputs?: Output[];
|
|
1571
1571
|
/**
|
|
1572
|
-
* @public
|
|
1573
1572
|
* <p>Use this parameter to configure a CloudWatch log stream to monitor application
|
|
1574
1573
|
* configuration errors. For more information, see <a href="https://docs.aws.amazon.com/kinesisanalytics/latest/dev/cloudwatch-logs.html">Working with Amazon
|
|
1575
1574
|
* CloudWatch Logs</a>.</p>
|
|
1575
|
+
* @public
|
|
1576
1576
|
*/
|
|
1577
1577
|
CloudWatchLoggingOptions?: CloudWatchLoggingOption[];
|
|
1578
1578
|
/**
|
|
1579
|
-
* @public
|
|
1580
1579
|
* <p>One or more SQL statements that read input data, transform it, and generate output.
|
|
1581
1580
|
* For example, you can write a SQL statement that reads data from one in-application
|
|
1582
1581
|
* stream, generates a running average of the number of advertisement clicks by vendor, and
|
|
@@ -1594,31 +1593,32 @@ export interface CreateApplicationRequest {
|
|
|
1594
1593
|
* if your <code>Outputs</code> defines output streams named
|
|
1595
1594
|
* <code>ExampleOutputStream1</code> and <code>ExampleOutputStream2</code>,
|
|
1596
1595
|
* then your application code must create these streams. </p>
|
|
1596
|
+
* @public
|
|
1597
1597
|
*/
|
|
1598
1598
|
ApplicationCode?: string;
|
|
1599
1599
|
/**
|
|
1600
|
-
* @public
|
|
1601
1600
|
* <p>A list of one or more tags to assign to the application. A tag is a key-value pair that identifies an application. Note that the maximum number of application tags includes system tags. The maximum number of user-defined application tags is 50.
|
|
1602
1601
|
* For more information, see <a href="https://docs.aws.amazon.com/kinesisanalytics/latest/dev/how-tagging.html">Using Tagging</a>.</p>
|
|
1602
|
+
* @public
|
|
1603
1603
|
*/
|
|
1604
1604
|
Tags?: Tag[];
|
|
1605
1605
|
}
|
|
1606
1606
|
/**
|
|
1607
|
-
* @public
|
|
1608
1607
|
* <p>TBD</p>
|
|
1608
|
+
* @public
|
|
1609
1609
|
*/
|
|
1610
1610
|
export interface CreateApplicationResponse {
|
|
1611
1611
|
/**
|
|
1612
|
-
* @public
|
|
1613
1612
|
* <p>In response to your <code>CreateApplication</code> request, Amazon Kinesis Analytics returns a
|
|
1614
1613
|
* response with a summary of the application it created, including the application Amazon Resource Name (ARN),
|
|
1615
1614
|
* name, and status.</p>
|
|
1615
|
+
* @public
|
|
1616
1616
|
*/
|
|
1617
1617
|
ApplicationSummary: ApplicationSummary | undefined;
|
|
1618
1618
|
}
|
|
1619
1619
|
/**
|
|
1620
|
-
* @public
|
|
1621
1620
|
* <p>Exceeded the number of applications allowed.</p>
|
|
1621
|
+
* @public
|
|
1622
1622
|
*/
|
|
1623
1623
|
export declare class LimitExceededException extends __BaseException {
|
|
1624
1624
|
readonly name: "LimitExceededException";
|
|
@@ -1629,8 +1629,8 @@ export declare class LimitExceededException extends __BaseException {
|
|
|
1629
1629
|
constructor(opts: __ExceptionOptionType<LimitExceededException, __BaseException>);
|
|
1630
1630
|
}
|
|
1631
1631
|
/**
|
|
1632
|
-
* @public
|
|
1633
1632
|
* <p>Application created with too many tags, or too many tags added to an application. Note that the maximum number of application tags includes system tags. The maximum number of user-defined application tags is 50.</p>
|
|
1633
|
+
* @public
|
|
1634
1634
|
*/
|
|
1635
1635
|
export declare class TooManyTagsException extends __BaseException {
|
|
1636
1636
|
readonly name: "TooManyTagsException";
|
|
@@ -1641,26 +1641,26 @@ export declare class TooManyTagsException extends __BaseException {
|
|
|
1641
1641
|
constructor(opts: __ExceptionOptionType<TooManyTagsException, __BaseException>);
|
|
1642
1642
|
}
|
|
1643
1643
|
/**
|
|
1644
|
-
* @public
|
|
1645
1644
|
* <p></p>
|
|
1645
|
+
* @public
|
|
1646
1646
|
*/
|
|
1647
1647
|
export interface DeleteApplicationRequest {
|
|
1648
1648
|
/**
|
|
1649
|
-
* @public
|
|
1650
1649
|
* <p>Name of the Amazon Kinesis Analytics application to delete.</p>
|
|
1650
|
+
* @public
|
|
1651
1651
|
*/
|
|
1652
1652
|
ApplicationName: string | undefined;
|
|
1653
1653
|
/**
|
|
1654
|
-
* @public
|
|
1655
1654
|
* <p>
|
|
1656
1655
|
* You can use the <code>DescribeApplication</code> operation to get this value.
|
|
1657
1656
|
* </p>
|
|
1657
|
+
* @public
|
|
1658
1658
|
*/
|
|
1659
1659
|
CreateTimestamp: Date | undefined;
|
|
1660
1660
|
}
|
|
1661
1661
|
/**
|
|
1662
|
-
* @public
|
|
1663
1662
|
* <p></p>
|
|
1663
|
+
* @public
|
|
1664
1664
|
*/
|
|
1665
1665
|
export interface DeleteApplicationResponse {
|
|
1666
1666
|
}
|
|
@@ -1669,19 +1669,19 @@ export interface DeleteApplicationResponse {
|
|
|
1669
1669
|
*/
|
|
1670
1670
|
export interface DeleteApplicationCloudWatchLoggingOptionRequest {
|
|
1671
1671
|
/**
|
|
1672
|
-
* @public
|
|
1673
1672
|
* <p>The Kinesis Analytics application name.</p>
|
|
1673
|
+
* @public
|
|
1674
1674
|
*/
|
|
1675
1675
|
ApplicationName: string | undefined;
|
|
1676
1676
|
/**
|
|
1677
|
-
* @public
|
|
1678
1677
|
* <p>The version ID of the Kinesis Analytics application.</p>
|
|
1678
|
+
* @public
|
|
1679
1679
|
*/
|
|
1680
1680
|
CurrentApplicationVersionId: number | undefined;
|
|
1681
1681
|
/**
|
|
1682
|
-
* @public
|
|
1683
1682
|
* <p>The <code>CloudWatchLoggingOptionId</code> of the CloudWatch logging option to
|
|
1684
1683
|
* delete. You can get the <code>CloudWatchLoggingOptionId</code> by using the <a href="https://docs.aws.amazon.com/kinesisanalytics/latest/dev/API_DescribeApplication.html">DescribeApplication</a> operation. </p>
|
|
1684
|
+
* @public
|
|
1685
1685
|
*/
|
|
1686
1686
|
CloudWatchLoggingOptionId: string | undefined;
|
|
1687
1687
|
}
|
|
@@ -1695,19 +1695,19 @@ export interface DeleteApplicationCloudWatchLoggingOptionResponse {
|
|
|
1695
1695
|
*/
|
|
1696
1696
|
export interface DeleteApplicationInputProcessingConfigurationRequest {
|
|
1697
1697
|
/**
|
|
1698
|
-
* @public
|
|
1699
1698
|
* <p>The Kinesis Analytics application name.</p>
|
|
1699
|
+
* @public
|
|
1700
1700
|
*/
|
|
1701
1701
|
ApplicationName: string | undefined;
|
|
1702
1702
|
/**
|
|
1703
|
-
* @public
|
|
1704
1703
|
* <p>The version ID of the Kinesis Analytics application.</p>
|
|
1704
|
+
* @public
|
|
1705
1705
|
*/
|
|
1706
1706
|
CurrentApplicationVersionId: number | undefined;
|
|
1707
1707
|
/**
|
|
1708
|
-
* @public
|
|
1709
1708
|
* <p>The ID of the input configuration from which to delete the input processing
|
|
1710
1709
|
* configuration. You can get a list of the input IDs for an application by using the <a href="https://docs.aws.amazon.com/kinesisanalytics/latest/dev/API_DescribeApplication.html">DescribeApplication</a> operation.</p>
|
|
1710
|
+
* @public
|
|
1711
1711
|
*/
|
|
1712
1712
|
InputId: string | undefined;
|
|
1713
1713
|
}
|
|
@@ -1717,26 +1717,25 @@ export interface DeleteApplicationInputProcessingConfigurationRequest {
|
|
|
1717
1717
|
export interface DeleteApplicationInputProcessingConfigurationResponse {
|
|
1718
1718
|
}
|
|
1719
1719
|
/**
|
|
1720
|
-
* @public
|
|
1721
1720
|
* <p></p>
|
|
1721
|
+
* @public
|
|
1722
1722
|
*/
|
|
1723
1723
|
export interface DeleteApplicationOutputRequest {
|
|
1724
1724
|
/**
|
|
1725
|
-
* @public
|
|
1726
1725
|
* <p>Amazon Kinesis Analytics application name.</p>
|
|
1726
|
+
* @public
|
|
1727
1727
|
*/
|
|
1728
1728
|
ApplicationName: string | undefined;
|
|
1729
1729
|
/**
|
|
1730
|
-
* @public
|
|
1731
1730
|
* <p>Amazon Kinesis Analytics application version.
|
|
1732
1731
|
* You can use the <a href="https://docs.aws.amazon.com/kinesisanalytics/latest/dev/API_DescribeApplication.html">DescribeApplication</a> operation to get the current application version.
|
|
1733
1732
|
* If the version specified is not the current version, the
|
|
1734
1733
|
* <code>ConcurrentModificationException</code> is returned.
|
|
1735
1734
|
* </p>
|
|
1735
|
+
* @public
|
|
1736
1736
|
*/
|
|
1737
1737
|
CurrentApplicationVersionId: number | undefined;
|
|
1738
1738
|
/**
|
|
1739
|
-
* @public
|
|
1740
1739
|
* <p>The ID of the configuration to delete.
|
|
1741
1740
|
* Each output configuration that is added to the application, either when the application is
|
|
1742
1741
|
* created or later using the <a href="https://docs.aws.amazon.com/kinesisanalytics/latest/dev/API_AddApplicationOutput.html">AddApplicationOutput</a> operation, has a unique ID.
|
|
@@ -1745,12 +1744,13 @@ export interface DeleteApplicationOutputRequest {
|
|
|
1745
1744
|
* You can use the <a href="https://docs.aws.amazon.com/kinesisanalytics/latest/dev/API_DescribeApplication.html">DescribeApplication</a> operation to get the specific
|
|
1746
1745
|
* <code>OutputId</code>.
|
|
1747
1746
|
* </p>
|
|
1747
|
+
* @public
|
|
1748
1748
|
*/
|
|
1749
1749
|
OutputId: string | undefined;
|
|
1750
1750
|
}
|
|
1751
1751
|
/**
|
|
1752
|
-
* @public
|
|
1753
1752
|
* <p></p>
|
|
1753
|
+
* @public
|
|
1754
1754
|
*/
|
|
1755
1755
|
export interface DeleteApplicationOutputResponse {
|
|
1756
1756
|
}
|
|
@@ -1759,25 +1759,25 @@ export interface DeleteApplicationOutputResponse {
|
|
|
1759
1759
|
*/
|
|
1760
1760
|
export interface DeleteApplicationReferenceDataSourceRequest {
|
|
1761
1761
|
/**
|
|
1762
|
-
* @public
|
|
1763
1762
|
* <p>Name of an existing application.</p>
|
|
1763
|
+
* @public
|
|
1764
1764
|
*/
|
|
1765
1765
|
ApplicationName: string | undefined;
|
|
1766
1766
|
/**
|
|
1767
|
-
* @public
|
|
1768
1767
|
* <p>Version of the application.
|
|
1769
1768
|
* You can use the <a href="https://docs.aws.amazon.com/kinesisanalytics/latest/dev/API_DescribeApplication.html">DescribeApplication</a> operation to get the current application version.
|
|
1770
1769
|
* If the version specified
|
|
1771
1770
|
* is not the current version, the <code>ConcurrentModificationException</code> is returned.</p>
|
|
1771
|
+
* @public
|
|
1772
1772
|
*/
|
|
1773
1773
|
CurrentApplicationVersionId: number | undefined;
|
|
1774
1774
|
/**
|
|
1775
|
-
* @public
|
|
1776
1775
|
* <p>ID of the reference data source. When you add a reference data source to your
|
|
1777
1776
|
* application using the
|
|
1778
1777
|
* <a href="https://docs.aws.amazon.com/kinesisanalytics/latest/dev/API_AddApplicationReferenceDataSource.html">AddApplicationReferenceDataSource</a>, Amazon Kinesis Analytics assigns an ID.
|
|
1779
1778
|
* You can use the <a href="https://docs.aws.amazon.com/kinesisanalytics/latest/dev/API_DescribeApplication.html">DescribeApplication</a> operation to get the reference ID.
|
|
1780
1779
|
* </p>
|
|
1780
|
+
* @public
|
|
1781
1781
|
*/
|
|
1782
1782
|
ReferenceId: string | undefined;
|
|
1783
1783
|
}
|
|
@@ -1787,47 +1787,47 @@ export interface DeleteApplicationReferenceDataSourceRequest {
|
|
|
1787
1787
|
export interface DeleteApplicationReferenceDataSourceResponse {
|
|
1788
1788
|
}
|
|
1789
1789
|
/**
|
|
1790
|
-
* @public
|
|
1791
1790
|
* <p></p>
|
|
1791
|
+
* @public
|
|
1792
1792
|
*/
|
|
1793
1793
|
export interface DescribeApplicationRequest {
|
|
1794
1794
|
/**
|
|
1795
|
-
* @public
|
|
1796
1795
|
* <p>Name of the application.</p>
|
|
1796
|
+
* @public
|
|
1797
1797
|
*/
|
|
1798
1798
|
ApplicationName: string | undefined;
|
|
1799
1799
|
}
|
|
1800
1800
|
/**
|
|
1801
|
-
* @public
|
|
1802
1801
|
* <p></p>
|
|
1802
|
+
* @public
|
|
1803
1803
|
*/
|
|
1804
1804
|
export interface DescribeApplicationResponse {
|
|
1805
1805
|
/**
|
|
1806
|
-
* @public
|
|
1807
1806
|
* <p>Provides a description of the application, such as the application Amazon Resource Name (ARN), status, latest version, and input and output configuration details.</p>
|
|
1807
|
+
* @public
|
|
1808
1808
|
*/
|
|
1809
1809
|
ApplicationDetail: ApplicationDetail | undefined;
|
|
1810
1810
|
}
|
|
1811
1811
|
/**
|
|
1812
|
-
* @public
|
|
1813
1812
|
* <p>Provides a description of an Amazon S3 data source, including the Amazon Resource
|
|
1814
1813
|
* Name (ARN) of the S3 bucket, the ARN of the IAM role that is used to access the bucket,
|
|
1815
1814
|
* and the name of the Amazon S3 object that contains the data.</p>
|
|
1815
|
+
* @public
|
|
1816
1816
|
*/
|
|
1817
1817
|
export interface S3Configuration {
|
|
1818
1818
|
/**
|
|
1819
|
-
* @public
|
|
1820
1819
|
* <p>IAM ARN of the role used to access the data.</p>
|
|
1820
|
+
* @public
|
|
1821
1821
|
*/
|
|
1822
1822
|
RoleARN: string | undefined;
|
|
1823
1823
|
/**
|
|
1824
|
-
* @public
|
|
1825
1824
|
* <p>ARN of the S3 bucket that contains the data.</p>
|
|
1825
|
+
* @public
|
|
1826
1826
|
*/
|
|
1827
1827
|
BucketARN: string | undefined;
|
|
1828
1828
|
/**
|
|
1829
|
-
* @public
|
|
1830
1829
|
* <p>The name of the object that contains the data.</p>
|
|
1830
|
+
* @public
|
|
1831
1831
|
*/
|
|
1832
1832
|
FileKey: string | undefined;
|
|
1833
1833
|
}
|
|
@@ -1836,65 +1836,65 @@ export interface S3Configuration {
|
|
|
1836
1836
|
*/
|
|
1837
1837
|
export interface DiscoverInputSchemaRequest {
|
|
1838
1838
|
/**
|
|
1839
|
-
* @public
|
|
1840
1839
|
* <p>Amazon Resource Name (ARN) of the streaming source.</p>
|
|
1840
|
+
* @public
|
|
1841
1841
|
*/
|
|
1842
1842
|
ResourceARN?: string;
|
|
1843
1843
|
/**
|
|
1844
|
-
* @public
|
|
1845
1844
|
* <p>ARN of the IAM role that Amazon Kinesis Analytics can assume to access the stream on your behalf.</p>
|
|
1845
|
+
* @public
|
|
1846
1846
|
*/
|
|
1847
1847
|
RoleARN?: string;
|
|
1848
1848
|
/**
|
|
1849
|
-
* @public
|
|
1850
1849
|
* <p>Point at which you want Amazon Kinesis Analytics to start reading records from the specified streaming source discovery purposes.</p>
|
|
1850
|
+
* @public
|
|
1851
1851
|
*/
|
|
1852
1852
|
InputStartingPositionConfiguration?: InputStartingPositionConfiguration;
|
|
1853
1853
|
/**
|
|
1854
|
-
* @public
|
|
1855
1854
|
* <p>Specify this parameter to discover a schema from data in an Amazon S3
|
|
1856
1855
|
* object.</p>
|
|
1856
|
+
* @public
|
|
1857
1857
|
*/
|
|
1858
1858
|
S3Configuration?: S3Configuration;
|
|
1859
1859
|
/**
|
|
1860
|
-
* @public
|
|
1861
1860
|
* <p>The <a href="https://docs.aws.amazon.com/kinesisanalytics/latest/dev/API_InputProcessingConfiguration.html">InputProcessingConfiguration</a> to use to preprocess the records before discovering the schema of the records.</p>
|
|
1861
|
+
* @public
|
|
1862
1862
|
*/
|
|
1863
1863
|
InputProcessingConfiguration?: InputProcessingConfiguration;
|
|
1864
1864
|
}
|
|
1865
1865
|
/**
|
|
1866
|
-
* @public
|
|
1867
1866
|
* <p></p>
|
|
1867
|
+
* @public
|
|
1868
1868
|
*/
|
|
1869
1869
|
export interface DiscoverInputSchemaResponse {
|
|
1870
1870
|
/**
|
|
1871
|
-
* @public
|
|
1872
1871
|
* <p>Schema inferred from the streaming source. It identifies the format of the data in the streaming source and how each data element maps to corresponding columns in the in-application stream that you can create.</p>
|
|
1872
|
+
* @public
|
|
1873
1873
|
*/
|
|
1874
1874
|
InputSchema?: SourceSchema;
|
|
1875
1875
|
/**
|
|
1876
|
-
* @public
|
|
1877
1876
|
* <p>An array of elements, where each element corresponds to a row in a stream record (a stream record can have more than one row).</p>
|
|
1877
|
+
* @public
|
|
1878
1878
|
*/
|
|
1879
1879
|
ParsedInputRecords?: string[][];
|
|
1880
1880
|
/**
|
|
1881
|
-
* @public
|
|
1882
1881
|
* <p>Stream data that was modified by the processor specified in the <code>InputProcessingConfiguration</code> parameter.</p>
|
|
1882
|
+
* @public
|
|
1883
1883
|
*/
|
|
1884
1884
|
ProcessedInputRecords?: string[];
|
|
1885
1885
|
/**
|
|
1886
|
-
* @public
|
|
1887
1886
|
* <p>Raw stream data that was sampled to infer the schema.</p>
|
|
1887
|
+
* @public
|
|
1888
1888
|
*/
|
|
1889
1889
|
RawInputRecords?: string[];
|
|
1890
1890
|
}
|
|
1891
1891
|
/**
|
|
1892
|
-
* @public
|
|
1893
1892
|
* <p>Discovery failed to get a record from the
|
|
1894
1893
|
* streaming source because of the Amazon Kinesis Streams
|
|
1895
1894
|
* ProvisionedThroughputExceededException. For more information,
|
|
1896
1895
|
* see <a href="https://docs.aws.amazon.com/kinesis/latest/APIReference/API_GetRecords.html">GetRecords</a>
|
|
1897
1896
|
* in the Amazon Kinesis Streams API Reference.</p>
|
|
1897
|
+
* @public
|
|
1898
1898
|
*/
|
|
1899
1899
|
export declare class ResourceProvisionedThroughputExceededException extends __BaseException {
|
|
1900
1900
|
readonly name: "ResourceProvisionedThroughputExceededException";
|
|
@@ -1905,8 +1905,8 @@ export declare class ResourceProvisionedThroughputExceededException extends __Ba
|
|
|
1905
1905
|
constructor(opts: __ExceptionOptionType<ResourceProvisionedThroughputExceededException, __BaseException>);
|
|
1906
1906
|
}
|
|
1907
1907
|
/**
|
|
1908
|
-
* @public
|
|
1909
1908
|
* <p>The service is unavailable. Back off and retry the operation. </p>
|
|
1909
|
+
* @public
|
|
1910
1910
|
*/
|
|
1911
1911
|
export declare class ServiceUnavailableException extends __BaseException {
|
|
1912
1912
|
readonly name: "ServiceUnavailableException";
|
|
@@ -1917,9 +1917,9 @@ export declare class ServiceUnavailableException extends __BaseException {
|
|
|
1917
1917
|
constructor(opts: __ExceptionOptionType<ServiceUnavailableException, __BaseException>);
|
|
1918
1918
|
}
|
|
1919
1919
|
/**
|
|
1920
|
-
* @public
|
|
1921
1920
|
* <p>Data format is not valid. Amazon Kinesis Analytics is not able to detect schema for
|
|
1922
1921
|
* the given streaming source.</p>
|
|
1922
|
+
* @public
|
|
1923
1923
|
*/
|
|
1924
1924
|
export declare class UnableToDetectSchemaException extends __BaseException {
|
|
1925
1925
|
readonly name: "UnableToDetectSchemaException";
|
|
@@ -1932,28 +1932,28 @@ export declare class UnableToDetectSchemaException extends __BaseException {
|
|
|
1932
1932
|
constructor(opts: __ExceptionOptionType<UnableToDetectSchemaException, __BaseException>);
|
|
1933
1933
|
}
|
|
1934
1934
|
/**
|
|
1935
|
-
* @public
|
|
1936
1935
|
* <p>When you start your application,
|
|
1937
1936
|
* you provide this configuration, which identifies the input source and the point
|
|
1938
1937
|
* in the input source at which you want the application to start processing records.</p>
|
|
1938
|
+
* @public
|
|
1939
1939
|
*/
|
|
1940
1940
|
export interface InputConfiguration {
|
|
1941
1941
|
/**
|
|
1942
|
-
* @public
|
|
1943
1942
|
* <p>Input source ID. You can get this ID by calling
|
|
1944
1943
|
* the <a href="https://docs.aws.amazon.com/kinesisanalytics/latest/dev/API_DescribeApplication.html">DescribeApplication</a> operation.</p>
|
|
1944
|
+
* @public
|
|
1945
1945
|
*/
|
|
1946
1946
|
Id: string | undefined;
|
|
1947
1947
|
/**
|
|
1948
|
-
* @public
|
|
1949
1948
|
* <p>Point at which you want the application to start processing
|
|
1950
1949
|
* records from the streaming source.</p>
|
|
1950
|
+
* @public
|
|
1951
1951
|
*/
|
|
1952
1952
|
InputStartingPositionConfiguration: InputStartingPositionConfiguration | undefined;
|
|
1953
1953
|
}
|
|
1954
1954
|
/**
|
|
1955
|
-
* @public
|
|
1956
1955
|
* <p>User-provided application configuration is not valid.</p>
|
|
1956
|
+
* @public
|
|
1957
1957
|
*/
|
|
1958
1958
|
export declare class InvalidApplicationConfigurationException extends __BaseException {
|
|
1959
1959
|
readonly name: "InvalidApplicationConfigurationException";
|
|
@@ -1964,34 +1964,34 @@ export declare class InvalidApplicationConfigurationException extends __BaseExce
|
|
|
1964
1964
|
constructor(opts: __ExceptionOptionType<InvalidApplicationConfigurationException, __BaseException>);
|
|
1965
1965
|
}
|
|
1966
1966
|
/**
|
|
1967
|
-
* @public
|
|
1968
1967
|
* <p></p>
|
|
1968
|
+
* @public
|
|
1969
1969
|
*/
|
|
1970
1970
|
export interface ListApplicationsRequest {
|
|
1971
1971
|
/**
|
|
1972
|
-
* @public
|
|
1973
1972
|
* <p>Maximum number of applications to list.</p>
|
|
1973
|
+
* @public
|
|
1974
1974
|
*/
|
|
1975
1975
|
Limit?: number;
|
|
1976
1976
|
/**
|
|
1977
|
-
* @public
|
|
1978
1977
|
* <p>Name of the application to start the list with. When using pagination to retrieve the list, you don't need to specify this parameter in the first request. However, in subsequent requests, you add the last application name from the previous response to get the next page of applications.</p>
|
|
1978
|
+
* @public
|
|
1979
1979
|
*/
|
|
1980
1980
|
ExclusiveStartApplicationName?: string;
|
|
1981
1981
|
}
|
|
1982
1982
|
/**
|
|
1983
|
-
* @public
|
|
1984
1983
|
* <p></p>
|
|
1984
|
+
* @public
|
|
1985
1985
|
*/
|
|
1986
1986
|
export interface ListApplicationsResponse {
|
|
1987
1987
|
/**
|
|
1988
|
-
* @public
|
|
1989
1988
|
* <p>List of <code>ApplicationSummary</code> objects. </p>
|
|
1989
|
+
* @public
|
|
1990
1990
|
*/
|
|
1991
1991
|
ApplicationSummaries: ApplicationSummary[] | undefined;
|
|
1992
1992
|
/**
|
|
1993
|
-
* @public
|
|
1994
1993
|
* <p>Returns true if there are more applications to retrieve.</p>
|
|
1994
|
+
* @public
|
|
1995
1995
|
*/
|
|
1996
1996
|
HasMoreApplications: boolean | undefined;
|
|
1997
1997
|
}
|
|
@@ -2000,8 +2000,8 @@ export interface ListApplicationsResponse {
|
|
|
2000
2000
|
*/
|
|
2001
2001
|
export interface ListTagsForResourceRequest {
|
|
2002
2002
|
/**
|
|
2003
|
-
* @public
|
|
2004
2003
|
* <p>The ARN of the application for which to retrieve tags.</p>
|
|
2004
|
+
* @public
|
|
2005
2005
|
*/
|
|
2006
2006
|
ResourceARN: string | undefined;
|
|
2007
2007
|
}
|
|
@@ -2010,47 +2010,47 @@ export interface ListTagsForResourceRequest {
|
|
|
2010
2010
|
*/
|
|
2011
2011
|
export interface ListTagsForResourceResponse {
|
|
2012
2012
|
/**
|
|
2013
|
-
* @public
|
|
2014
2013
|
* <p>The key-value tags assigned to the application.</p>
|
|
2014
|
+
* @public
|
|
2015
2015
|
*/
|
|
2016
2016
|
Tags?: Tag[];
|
|
2017
2017
|
}
|
|
2018
2018
|
/**
|
|
2019
|
-
* @public
|
|
2020
2019
|
* <p></p>
|
|
2020
|
+
* @public
|
|
2021
2021
|
*/
|
|
2022
2022
|
export interface StartApplicationRequest {
|
|
2023
2023
|
/**
|
|
2024
|
-
* @public
|
|
2025
2024
|
* <p>Name of the application.</p>
|
|
2025
|
+
* @public
|
|
2026
2026
|
*/
|
|
2027
2027
|
ApplicationName: string | undefined;
|
|
2028
2028
|
/**
|
|
2029
|
-
* @public
|
|
2030
2029
|
* <p>Identifies the specific input, by ID, that the application starts consuming. Amazon Kinesis Analytics starts reading the streaming source associated with the input. You can also specify where in the streaming source you want Amazon Kinesis Analytics to start reading.</p>
|
|
2030
|
+
* @public
|
|
2031
2031
|
*/
|
|
2032
2032
|
InputConfigurations: InputConfiguration[] | undefined;
|
|
2033
2033
|
}
|
|
2034
2034
|
/**
|
|
2035
|
-
* @public
|
|
2036
2035
|
* <p></p>
|
|
2036
|
+
* @public
|
|
2037
2037
|
*/
|
|
2038
2038
|
export interface StartApplicationResponse {
|
|
2039
2039
|
}
|
|
2040
2040
|
/**
|
|
2041
|
-
* @public
|
|
2042
2041
|
* <p></p>
|
|
2042
|
+
* @public
|
|
2043
2043
|
*/
|
|
2044
2044
|
export interface StopApplicationRequest {
|
|
2045
2045
|
/**
|
|
2046
|
-
* @public
|
|
2047
2046
|
* <p>Name of the running application to stop.</p>
|
|
2047
|
+
* @public
|
|
2048
2048
|
*/
|
|
2049
2049
|
ApplicationName: string | undefined;
|
|
2050
2050
|
}
|
|
2051
2051
|
/**
|
|
2052
|
-
* @public
|
|
2053
2052
|
* <p></p>
|
|
2053
|
+
* @public
|
|
2054
2054
|
*/
|
|
2055
2055
|
export interface StopApplicationResponse {
|
|
2056
2056
|
}
|
|
@@ -2059,13 +2059,13 @@ export interface StopApplicationResponse {
|
|
|
2059
2059
|
*/
|
|
2060
2060
|
export interface TagResourceRequest {
|
|
2061
2061
|
/**
|
|
2062
|
-
* @public
|
|
2063
2062
|
* <p>The ARN of the application to assign the tags.</p>
|
|
2063
|
+
* @public
|
|
2064
2064
|
*/
|
|
2065
2065
|
ResourceARN: string | undefined;
|
|
2066
2066
|
/**
|
|
2067
|
-
* @public
|
|
2068
2067
|
* <p>The key-value tags to assign to the application.</p>
|
|
2068
|
+
* @public
|
|
2069
2069
|
*/
|
|
2070
2070
|
Tags: Tag[] | undefined;
|
|
2071
2071
|
}
|
|
@@ -2079,13 +2079,13 @@ export interface TagResourceResponse {
|
|
|
2079
2079
|
*/
|
|
2080
2080
|
export interface UntagResourceRequest {
|
|
2081
2081
|
/**
|
|
2082
|
-
* @public
|
|
2083
2082
|
* <p>The ARN of the Kinesis Analytics application from which to remove the tags.</p>
|
|
2083
|
+
* @public
|
|
2084
2084
|
*/
|
|
2085
2085
|
ResourceARN: string | undefined;
|
|
2086
2086
|
/**
|
|
2087
|
-
* @public
|
|
2088
2087
|
* <p>A list of keys of tags to remove from the specified application.</p>
|
|
2088
|
+
* @public
|
|
2089
2089
|
*/
|
|
2090
2090
|
TagKeys: string[] | undefined;
|
|
2091
2091
|
}
|
|
@@ -2099,19 +2099,19 @@ export interface UntagResourceResponse {
|
|
|
2099
2099
|
*/
|
|
2100
2100
|
export interface UpdateApplicationRequest {
|
|
2101
2101
|
/**
|
|
2102
|
-
* @public
|
|
2103
2102
|
* <p>Name of the Amazon Kinesis Analytics application to update.</p>
|
|
2103
|
+
* @public
|
|
2104
2104
|
*/
|
|
2105
2105
|
ApplicationName: string | undefined;
|
|
2106
2106
|
/**
|
|
2107
|
-
* @public
|
|
2108
2107
|
* <p>The current application version ID. You can use the
|
|
2109
2108
|
* <a href="https://docs.aws.amazon.com/kinesisanalytics/latest/dev/API_DescribeApplication.html">DescribeApplication</a> operation to get this value.</p>
|
|
2109
|
+
* @public
|
|
2110
2110
|
*/
|
|
2111
2111
|
CurrentApplicationVersionId: number | undefined;
|
|
2112
2112
|
/**
|
|
2113
|
-
* @public
|
|
2114
2113
|
* <p>Describes application updates.</p>
|
|
2114
|
+
* @public
|
|
2115
2115
|
*/
|
|
2116
2116
|
ApplicationUpdate: ApplicationUpdate | undefined;
|
|
2117
2117
|
}
|