@aws-sdk/client-kinesis-analytics 3.35.0 → 3.38.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.
Files changed (194) hide show
  1. package/CHANGELOG.md +47 -0
  2. package/dist-cjs/KinesisAnalytics.js +0 -13
  3. package/dist-cjs/KinesisAnalyticsClient.js +0 -18
  4. package/dist-cjs/commands/AddApplicationCloudWatchLoggingOptionCommand.js +0 -31
  5. package/dist-cjs/commands/AddApplicationInputCommand.js +0 -41
  6. package/dist-cjs/commands/AddApplicationInputProcessingConfigurationCommand.js +0 -30
  7. package/dist-cjs/commands/AddApplicationOutputCommand.js +0 -44
  8. package/dist-cjs/commands/AddApplicationReferenceDataSourceCommand.js +0 -38
  9. package/dist-cjs/commands/CreateApplicationCommand.js +0 -51
  10. package/dist-cjs/commands/DeleteApplicationCloudWatchLoggingOptionCommand.js +0 -30
  11. package/dist-cjs/commands/DeleteApplicationCommand.js +0 -30
  12. package/dist-cjs/commands/DeleteApplicationInputProcessingConfigurationCommand.js +0 -28
  13. package/dist-cjs/commands/DeleteApplicationOutputCommand.js +0 -30
  14. package/dist-cjs/commands/DeleteApplicationReferenceDataSourceCommand.js +0 -33
  15. package/dist-cjs/commands/DescribeApplicationCommand.js +0 -34
  16. package/dist-cjs/commands/DiscoverInputSchemaCommand.js +0 -39
  17. package/dist-cjs/commands/ListApplicationsCommand.js +0 -41
  18. package/dist-cjs/commands/ListTagsForResourceCommand.js +0 -25
  19. package/dist-cjs/commands/StartApplicationCommand.js +0 -36
  20. package/dist-cjs/commands/StopApplicationCommand.js +0 -35
  21. package/dist-cjs/commands/TagResourceCommand.js +0 -26
  22. package/dist-cjs/commands/UntagResourceCommand.js +0 -25
  23. package/dist-cjs/commands/UpdateApplicationCommand.js +0 -34
  24. package/dist-cjs/commands/index.js +23 -0
  25. package/dist-cjs/endpoints.js +1 -2
  26. package/dist-cjs/index.js +3 -23
  27. package/dist-cjs/models/index.js +0 -1
  28. package/dist-cjs/models/models_0.js +0 -316
  29. package/dist-cjs/protocols/Aws_json1_1.js +0 -6
  30. package/dist-cjs/runtimeConfig.browser.js +1 -6
  31. package/dist-cjs/runtimeConfig.js +2 -7
  32. package/dist-cjs/runtimeConfig.native.js +0 -4
  33. package/dist-cjs/runtimeConfig.shared.js +0 -4
  34. package/dist-es/KinesisAnalytics.js +0 -1
  35. package/dist-es/KinesisAnalyticsClient.js +0 -1
  36. package/dist-es/commands/AddApplicationCloudWatchLoggingOptionCommand.js +0 -1
  37. package/dist-es/commands/AddApplicationInputCommand.js +0 -1
  38. package/dist-es/commands/AddApplicationInputProcessingConfigurationCommand.js +0 -1
  39. package/dist-es/commands/AddApplicationOutputCommand.js +0 -1
  40. package/dist-es/commands/AddApplicationReferenceDataSourceCommand.js +0 -1
  41. package/dist-es/commands/CreateApplicationCommand.js +0 -1
  42. package/dist-es/commands/DeleteApplicationCloudWatchLoggingOptionCommand.js +0 -1
  43. package/dist-es/commands/DeleteApplicationCommand.js +0 -1
  44. package/dist-es/commands/DeleteApplicationInputProcessingConfigurationCommand.js +0 -1
  45. package/dist-es/commands/DeleteApplicationOutputCommand.js +0 -1
  46. package/dist-es/commands/DeleteApplicationReferenceDataSourceCommand.js +0 -1
  47. package/dist-es/commands/DescribeApplicationCommand.js +0 -1
  48. package/dist-es/commands/DiscoverInputSchemaCommand.js +0 -1
  49. package/dist-es/commands/ListApplicationsCommand.js +0 -1
  50. package/dist-es/commands/ListTagsForResourceCommand.js +0 -1
  51. package/dist-es/commands/StartApplicationCommand.js +0 -1
  52. package/dist-es/commands/StopApplicationCommand.js +0 -1
  53. package/dist-es/commands/TagResourceCommand.js +0 -1
  54. package/dist-es/commands/UntagResourceCommand.js +0 -1
  55. package/dist-es/commands/UpdateApplicationCommand.js +0 -1
  56. package/dist-es/commands/index.js +20 -0
  57. package/dist-es/endpoints.js +1 -2
  58. package/dist-es/index.js +3 -23
  59. package/dist-es/models/index.js +0 -1
  60. package/dist-es/models/models_0.js +0 -1
  61. package/dist-es/protocols/Aws_json1_1.js +0 -1
  62. package/dist-es/runtimeConfig.browser.js +1 -2
  63. package/dist-es/runtimeConfig.js +2 -3
  64. package/dist-es/runtimeConfig.native.js +0 -1
  65. package/dist-es/runtimeConfig.shared.js +0 -1
  66. package/dist-types/commands/index.d.ts +20 -0
  67. package/dist-types/index.d.ts +3 -22
  68. package/dist-types/ts3.4/KinesisAnalytics.d.ts +21 -253
  69. package/dist-types/ts3.4/KinesisAnalyticsClient.d.ts +24 -98
  70. package/dist-types/ts3.4/commands/AddApplicationCloudWatchLoggingOptionCommand.d.ts +2 -26
  71. package/dist-types/ts3.4/commands/AddApplicationInputCommand.d.ts +2 -36
  72. package/dist-types/ts3.4/commands/AddApplicationInputProcessingConfigurationCommand.d.ts +2 -25
  73. package/dist-types/ts3.4/commands/AddApplicationOutputCommand.d.ts +2 -39
  74. package/dist-types/ts3.4/commands/AddApplicationReferenceDataSourceCommand.d.ts +2 -33
  75. package/dist-types/ts3.4/commands/CreateApplicationCommand.d.ts +2 -46
  76. package/dist-types/ts3.4/commands/DeleteApplicationCloudWatchLoggingOptionCommand.d.ts +2 -25
  77. package/dist-types/ts3.4/commands/DeleteApplicationCommand.d.ts +2 -25
  78. package/dist-types/ts3.4/commands/DeleteApplicationInputProcessingConfigurationCommand.d.ts +2 -23
  79. package/dist-types/ts3.4/commands/DeleteApplicationOutputCommand.d.ts +2 -25
  80. package/dist-types/ts3.4/commands/DeleteApplicationReferenceDataSourceCommand.d.ts +2 -28
  81. package/dist-types/ts3.4/commands/DescribeApplicationCommand.d.ts +2 -29
  82. package/dist-types/ts3.4/commands/DiscoverInputSchemaCommand.d.ts +2 -34
  83. package/dist-types/ts3.4/commands/ListApplicationsCommand.d.ts +2 -36
  84. package/dist-types/ts3.4/commands/ListTagsForResourceCommand.d.ts +2 -20
  85. package/dist-types/ts3.4/commands/StartApplicationCommand.d.ts +2 -31
  86. package/dist-types/ts3.4/commands/StopApplicationCommand.d.ts +2 -30
  87. package/dist-types/ts3.4/commands/TagResourceCommand.d.ts +2 -21
  88. package/dist-types/ts3.4/commands/UntagResourceCommand.d.ts +2 -20
  89. package/dist-types/ts3.4/commands/UpdateApplicationCommand.d.ts +2 -29
  90. package/dist-types/ts3.4/commands/index.d.ts +20 -0
  91. package/dist-types/ts3.4/index.d.ts +3 -22
  92. package/dist-types/ts3.4/models/models_0.d.ts +416 -1552
  93. package/dist-types/ts3.4/runtimeConfig.browser.d.ts +1 -3
  94. package/dist-types/ts3.4/runtimeConfig.d.ts +1 -3
  95. package/dist-types/ts3.4/runtimeConfig.native.d.ts +1 -3
  96. package/dist-types/ts3.4/runtimeConfig.shared.d.ts +1 -3
  97. package/package.json +33 -30
  98. package/dist-cjs/KinesisAnalytics.js.map +0 -1
  99. package/dist-cjs/KinesisAnalyticsClient.js.map +0 -1
  100. package/dist-cjs/commands/AddApplicationCloudWatchLoggingOptionCommand.js.map +0 -1
  101. package/dist-cjs/commands/AddApplicationInputCommand.js.map +0 -1
  102. package/dist-cjs/commands/AddApplicationInputProcessingConfigurationCommand.js.map +0 -1
  103. package/dist-cjs/commands/AddApplicationOutputCommand.js.map +0 -1
  104. package/dist-cjs/commands/AddApplicationReferenceDataSourceCommand.js.map +0 -1
  105. package/dist-cjs/commands/CreateApplicationCommand.js.map +0 -1
  106. package/dist-cjs/commands/DeleteApplicationCloudWatchLoggingOptionCommand.js.map +0 -1
  107. package/dist-cjs/commands/DeleteApplicationCommand.js.map +0 -1
  108. package/dist-cjs/commands/DeleteApplicationInputProcessingConfigurationCommand.js.map +0 -1
  109. package/dist-cjs/commands/DeleteApplicationOutputCommand.js.map +0 -1
  110. package/dist-cjs/commands/DeleteApplicationReferenceDataSourceCommand.js.map +0 -1
  111. package/dist-cjs/commands/DescribeApplicationCommand.js.map +0 -1
  112. package/dist-cjs/commands/DiscoverInputSchemaCommand.js.map +0 -1
  113. package/dist-cjs/commands/ListApplicationsCommand.js.map +0 -1
  114. package/dist-cjs/commands/ListTagsForResourceCommand.js.map +0 -1
  115. package/dist-cjs/commands/StartApplicationCommand.js.map +0 -1
  116. package/dist-cjs/commands/StopApplicationCommand.js.map +0 -1
  117. package/dist-cjs/commands/TagResourceCommand.js.map +0 -1
  118. package/dist-cjs/commands/UntagResourceCommand.js.map +0 -1
  119. package/dist-cjs/commands/UpdateApplicationCommand.js.map +0 -1
  120. package/dist-cjs/endpoints.js.map +0 -1
  121. package/dist-cjs/index.js.map +0 -1
  122. package/dist-cjs/models/index.js.map +0 -1
  123. package/dist-cjs/models/models_0.js.map +0 -1
  124. package/dist-cjs/protocols/Aws_json1_1.js.map +0 -1
  125. package/dist-cjs/runtimeConfig.browser.js.map +0 -1
  126. package/dist-cjs/runtimeConfig.js.map +0 -1
  127. package/dist-cjs/runtimeConfig.native.js.map +0 -1
  128. package/dist-cjs/runtimeConfig.shared.js.map +0 -1
  129. package/dist-es/KinesisAnalytics.js.map +0 -1
  130. package/dist-es/KinesisAnalyticsClient.js.map +0 -1
  131. package/dist-es/commands/AddApplicationCloudWatchLoggingOptionCommand.js.map +0 -1
  132. package/dist-es/commands/AddApplicationInputCommand.js.map +0 -1
  133. package/dist-es/commands/AddApplicationInputProcessingConfigurationCommand.js.map +0 -1
  134. package/dist-es/commands/AddApplicationOutputCommand.js.map +0 -1
  135. package/dist-es/commands/AddApplicationReferenceDataSourceCommand.js.map +0 -1
  136. package/dist-es/commands/CreateApplicationCommand.js.map +0 -1
  137. package/dist-es/commands/DeleteApplicationCloudWatchLoggingOptionCommand.js.map +0 -1
  138. package/dist-es/commands/DeleteApplicationCommand.js.map +0 -1
  139. package/dist-es/commands/DeleteApplicationInputProcessingConfigurationCommand.js.map +0 -1
  140. package/dist-es/commands/DeleteApplicationOutputCommand.js.map +0 -1
  141. package/dist-es/commands/DeleteApplicationReferenceDataSourceCommand.js.map +0 -1
  142. package/dist-es/commands/DescribeApplicationCommand.js.map +0 -1
  143. package/dist-es/commands/DiscoverInputSchemaCommand.js.map +0 -1
  144. package/dist-es/commands/ListApplicationsCommand.js.map +0 -1
  145. package/dist-es/commands/ListTagsForResourceCommand.js.map +0 -1
  146. package/dist-es/commands/StartApplicationCommand.js.map +0 -1
  147. package/dist-es/commands/StopApplicationCommand.js.map +0 -1
  148. package/dist-es/commands/TagResourceCommand.js.map +0 -1
  149. package/dist-es/commands/UntagResourceCommand.js.map +0 -1
  150. package/dist-es/commands/UpdateApplicationCommand.js.map +0 -1
  151. package/dist-es/endpoints.js.map +0 -1
  152. package/dist-es/index.js.map +0 -1
  153. package/dist-es/models/index.js.map +0 -1
  154. package/dist-es/models/models_0.js.map +0 -1
  155. package/dist-es/protocols/Aws_json1_1.js.map +0 -1
  156. package/dist-es/runtimeConfig.browser.js.map +0 -1
  157. package/dist-es/runtimeConfig.js.map +0 -1
  158. package/dist-es/runtimeConfig.native.js.map +0 -1
  159. package/dist-es/runtimeConfig.shared.js.map +0 -1
  160. package/jest.config.js +0 -4
  161. package/src/KinesisAnalytics.ts +0 -936
  162. package/src/KinesisAnalyticsClient.ts +0 -341
  163. package/src/commands/AddApplicationCloudWatchLoggingOptionCommand.ts +0 -113
  164. package/src/commands/AddApplicationInputCommand.ts +0 -111
  165. package/src/commands/AddApplicationInputProcessingConfigurationCommand.ts +0 -115
  166. package/src/commands/AddApplicationOutputCommand.ts +0 -114
  167. package/src/commands/AddApplicationReferenceDataSourceCommand.ts +0 -119
  168. package/src/commands/CreateApplicationCommand.ts +0 -121
  169. package/src/commands/DeleteApplicationCloudWatchLoggingOptionCommand.ts +0 -115
  170. package/src/commands/DeleteApplicationCommand.ts +0 -100
  171. package/src/commands/DeleteApplicationInputProcessingConfigurationCommand.ts +0 -113
  172. package/src/commands/DeleteApplicationOutputCommand.ts +0 -100
  173. package/src/commands/DeleteApplicationReferenceDataSourceCommand.ts +0 -114
  174. package/src/commands/DescribeApplicationCommand.ts +0 -104
  175. package/src/commands/DiscoverInputSchemaCommand.ts +0 -109
  176. package/src/commands/ListApplicationsCommand.ts +0 -111
  177. package/src/commands/ListTagsForResourceCommand.ts +0 -95
  178. package/src/commands/StartApplicationCommand.ts +0 -106
  179. package/src/commands/StopApplicationCommand.ts +0 -105
  180. package/src/commands/TagResourceCommand.ts +0 -96
  181. package/src/commands/UntagResourceCommand.ts +0 -95
  182. package/src/commands/UpdateApplicationCommand.ts +0 -104
  183. package/src/endpoints.ts +0 -57
  184. package/src/index.ts +0 -23
  185. package/src/models/index.ts +0 -1
  186. package/src/models/models_0.ts +0 -2899
  187. package/src/protocols/Aws_json1_1.ts +0 -3943
  188. package/src/runtimeConfig.browser.ts +0 -41
  189. package/src/runtimeConfig.native.ts +0 -17
  190. package/src/runtimeConfig.shared.ts +0 -17
  191. package/src/runtimeConfig.ts +0 -46
  192. package/tsconfig.es.json +0 -10
  193. package/tsconfig.json +0 -33
  194. package/tsconfig.types.json +0 -9
@@ -1,2899 +0,0 @@
1
- import { MetadataBearer as $MetadataBearer, SmithyException as __SmithyException } from "@aws-sdk/types";
2
-
3
- /**
4
- * <p>Provides a description of CloudWatch logging options, including the log stream
5
- * Amazon Resource Name (ARN) and the role ARN.</p>
6
- */
7
- export interface CloudWatchLoggingOption {
8
- /**
9
- * <p>ARN of the CloudWatch log to receive application messages.</p>
10
- */
11
- LogStreamARN: string | undefined;
12
-
13
- /**
14
- * <p>IAM ARN of the role to use to send application messages. Note: To write application
15
- * messages to CloudWatch, the IAM role that is used must have the
16
- * <code>PutLogEvents</code> policy action enabled.</p>
17
- */
18
- RoleARN: string | undefined;
19
- }
20
-
21
- export namespace CloudWatchLoggingOption {
22
- /**
23
- * @internal
24
- */
25
- export const filterSensitiveLog = (obj: CloudWatchLoggingOption): any => ({
26
- ...obj,
27
- });
28
- }
29
-
30
- export interface AddApplicationCloudWatchLoggingOptionRequest {
31
- /**
32
- * <p>The Kinesis Analytics application name.</p>
33
- */
34
- ApplicationName: string | undefined;
35
-
36
- /**
37
- * <p>The version ID of the Kinesis Analytics application.</p>
38
- */
39
- CurrentApplicationVersionId: number | undefined;
40
-
41
- /**
42
- * <p>Provides the CloudWatch log stream Amazon Resource Name (ARN) and the IAM role ARN.
43
- * Note: To write application messages to CloudWatch, the IAM role that is used must have
44
- * the <code>PutLogEvents</code> policy action enabled.</p>
45
- */
46
- CloudWatchLoggingOption: CloudWatchLoggingOption | undefined;
47
- }
48
-
49
- export namespace AddApplicationCloudWatchLoggingOptionRequest {
50
- /**
51
- * @internal
52
- */
53
- export const filterSensitiveLog = (obj: AddApplicationCloudWatchLoggingOptionRequest): any => ({
54
- ...obj,
55
- });
56
- }
57
-
58
- export interface AddApplicationCloudWatchLoggingOptionResponse {}
59
-
60
- export namespace AddApplicationCloudWatchLoggingOptionResponse {
61
- /**
62
- * @internal
63
- */
64
- export const filterSensitiveLog = (obj: AddApplicationCloudWatchLoggingOptionResponse): any => ({
65
- ...obj,
66
- });
67
- }
68
-
69
- /**
70
- * <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>
71
- */
72
- export interface ConcurrentModificationException extends __SmithyException, $MetadataBearer {
73
- name: "ConcurrentModificationException";
74
- $fault: "client";
75
- /**
76
- * <p></p>
77
- */
78
- message?: string;
79
- }
80
-
81
- export namespace ConcurrentModificationException {
82
- /**
83
- * @internal
84
- */
85
- export const filterSensitiveLog = (obj: ConcurrentModificationException): any => ({
86
- ...obj,
87
- });
88
- }
89
-
90
- /**
91
- * <p>Specified input parameter value is invalid.</p>
92
- */
93
- export interface InvalidArgumentException extends __SmithyException, $MetadataBearer {
94
- name: "InvalidArgumentException";
95
- $fault: "client";
96
- /**
97
- * <p></p>
98
- */
99
- message?: string;
100
- }
101
-
102
- export namespace InvalidArgumentException {
103
- /**
104
- * @internal
105
- */
106
- export const filterSensitiveLog = (obj: InvalidArgumentException): any => ({
107
- ...obj,
108
- });
109
- }
110
-
111
- /**
112
- * <p>Application is not available for this operation.</p>
113
- */
114
- export interface ResourceInUseException extends __SmithyException, $MetadataBearer {
115
- name: "ResourceInUseException";
116
- $fault: "client";
117
- /**
118
- * <p></p>
119
- */
120
- message?: string;
121
- }
122
-
123
- export namespace ResourceInUseException {
124
- /**
125
- * @internal
126
- */
127
- export const filterSensitiveLog = (obj: ResourceInUseException): any => ({
128
- ...obj,
129
- });
130
- }
131
-
132
- /**
133
- * <p>Specified application can't be found.</p>
134
- */
135
- export interface ResourceNotFoundException extends __SmithyException, $MetadataBearer {
136
- name: "ResourceNotFoundException";
137
- $fault: "client";
138
- /**
139
- * <p></p>
140
- */
141
- message?: string;
142
- }
143
-
144
- export namespace ResourceNotFoundException {
145
- /**
146
- * @internal
147
- */
148
- export const filterSensitiveLog = (obj: ResourceNotFoundException): any => ({
149
- ...obj,
150
- });
151
- }
152
-
153
- /**
154
- * <p>The request was rejected because a specified parameter is not supported or a specified resource is not valid for this operation. </p>
155
- */
156
- export interface UnsupportedOperationException extends __SmithyException, $MetadataBearer {
157
- name: "UnsupportedOperationException";
158
- $fault: "client";
159
- message?: string;
160
- }
161
-
162
- export namespace UnsupportedOperationException {
163
- /**
164
- * @internal
165
- */
166
- export const filterSensitiveLog = (obj: UnsupportedOperationException): any => ({
167
- ...obj,
168
- });
169
- }
170
-
171
- /**
172
- * <p>Describes the number of in-application streams to create for a given
173
- * streaming source. For information about parallelism,
174
- * see <a href="https://docs.aws.amazon.com/kinesisanalytics/latest/dev/how-it-works-input.html">Configuring Application Input</a>.
175
- * </p>
176
- */
177
- export interface InputParallelism {
178
- /**
179
- * <p>Number of in-application streams to create.
180
- * For more information, see <a href="https://docs.aws.amazon.com/kinesisanalytics/latest/dev/limits.html">Limits</a>.
181
- * </p>
182
- */
183
- Count?: number;
184
- }
185
-
186
- export namespace InputParallelism {
187
- /**
188
- * @internal
189
- */
190
- export const filterSensitiveLog = (obj: InputParallelism): any => ({
191
- ...obj,
192
- });
193
- }
194
-
195
- /**
196
- * <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
197
- * is used to preprocess records in the stream, and the ARN of the IAM role that is used to
198
- * access the AWS Lambda function. </p>
199
- */
200
- export interface InputLambdaProcessor {
201
- /**
202
- * <p>The ARN of the <a href="https://docs.aws.amazon.com/lambda/">AWS Lambda</a> function that operates
203
- * on records in the stream.</p>
204
- * <note>
205
- * <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>
206
- * </p>
207
- * </note>
208
- */
209
- ResourceARN: string | undefined;
210
-
211
- /**
212
- * <p>The ARN of the IAM role that is used to access the AWS Lambda function.</p>
213
- */
214
- RoleARN: string | undefined;
215
- }
216
-
217
- export namespace InputLambdaProcessor {
218
- /**
219
- * @internal
220
- */
221
- export const filterSensitiveLog = (obj: InputLambdaProcessor): any => ({
222
- ...obj,
223
- });
224
- }
225
-
226
- /**
227
- * <p>Provides a description of a processor that is used to preprocess the records in the
228
- * stream before being processed by your application code. Currently, the only input
229
- * processor available is <a href="https://docs.aws.amazon.com/lambda/">AWS
230
- * Lambda</a>.</p>
231
- */
232
- export interface InputProcessingConfiguration {
233
- /**
234
- * <p>The <a href="https://docs.aws.amazon.com/kinesisanalytics/latest/dev/API_InputLambdaProcessor.html">InputLambdaProcessor</a> that is used to preprocess the records
235
- * in the stream before being processed by your application code.</p>
236
- */
237
- InputLambdaProcessor: InputLambdaProcessor | undefined;
238
- }
239
-
240
- export namespace InputProcessingConfiguration {
241
- /**
242
- * @internal
243
- */
244
- export const filterSensitiveLog = (obj: InputProcessingConfiguration): any => ({
245
- ...obj,
246
- });
247
- }
248
-
249
- /**
250
- * <p>Describes the mapping of each data element in the streaming
251
- * source to the corresponding column in the in-application stream.</p>
252
- * <p>Also used to describe the format of the reference data source.</p>
253
- */
254
- export interface RecordColumn {
255
- /**
256
- * <p>Name of the column created in the in-application input stream or reference table.</p>
257
- */
258
- Name: string | undefined;
259
-
260
- /**
261
- * <p>Reference to the data element in the streaming input or the reference data source. This element
262
- * 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>
263
- */
264
- Mapping?: string;
265
-
266
- /**
267
- * <p>Type of column created in the in-application input stream or reference table.</p>
268
- */
269
- SqlType: string | undefined;
270
- }
271
-
272
- export namespace RecordColumn {
273
- /**
274
- * @internal
275
- */
276
- export const filterSensitiveLog = (obj: RecordColumn): any => ({
277
- ...obj,
278
- });
279
- }
280
-
281
- /**
282
- * <p>Provides additional mapping information when the record format
283
- * uses delimiters, such as CSV. For example, the following sample records
284
- * use CSV format, where the records use the <i>'\n'</i> as the row delimiter and a comma (",") as the column delimiter:
285
- * </p>
286
- *
287
- * <p>
288
- * <code>"name1", "address1"</code>
289
- * </p>
290
- * <p>
291
- * <code>"name2", "address2"</code>
292
- * </p>
293
- */
294
- export interface CSVMappingParameters {
295
- /**
296
- * <p>Row delimiter. For example, in a CSV format, <i>'\n'</i> is the typical row delimiter.</p>
297
- */
298
- RecordRowDelimiter: string | undefined;
299
-
300
- /**
301
- * <p>Column delimiter. For example, in a CSV format, a comma (",") is the typical column delimiter.</p>
302
- */
303
- RecordColumnDelimiter: string | undefined;
304
- }
305
-
306
- export namespace CSVMappingParameters {
307
- /**
308
- * @internal
309
- */
310
- export const filterSensitiveLog = (obj: CSVMappingParameters): any => ({
311
- ...obj,
312
- });
313
- }
314
-
315
- /**
316
- * <p>Provides additional mapping information when JSON is the record format on the streaming source.</p>
317
- */
318
- export interface JSONMappingParameters {
319
- /**
320
- * <p>Path to the top-level parent that contains the records.</p>
321
- */
322
- RecordRowPath: string | undefined;
323
- }
324
-
325
- export namespace JSONMappingParameters {
326
- /**
327
- * @internal
328
- */
329
- export const filterSensitiveLog = (obj: JSONMappingParameters): any => ({
330
- ...obj,
331
- });
332
- }
333
-
334
- /**
335
- * <p>When configuring application input
336
- * at the time of creating or updating an application,
337
- * provides additional mapping information specific to
338
- * the record format (such as JSON, CSV, or record fields delimited
339
- * by some delimiter) on the streaming source.</p>
340
- */
341
- export interface MappingParameters {
342
- /**
343
- * <p>Provides additional mapping information when JSON is the record format on the streaming source.</p>
344
- */
345
- JSONMappingParameters?: JSONMappingParameters;
346
-
347
- /**
348
- * <p>Provides additional mapping information when the record format uses delimiters
349
- * (for example, CSV).</p>
350
- */
351
- CSVMappingParameters?: CSVMappingParameters;
352
- }
353
-
354
- export namespace MappingParameters {
355
- /**
356
- * @internal
357
- */
358
- export const filterSensitiveLog = (obj: MappingParameters): any => ({
359
- ...obj,
360
- });
361
- }
362
-
363
- export enum RecordFormatType {
364
- CSV = "CSV",
365
- JSON = "JSON",
366
- }
367
-
368
- /**
369
- * <p>
370
- * Describes the record format and relevant mapping information that
371
- * should be applied to schematize the records on the stream.
372
- * </p>
373
- */
374
- export interface RecordFormat {
375
- /**
376
- * <p>The type of record format.</p>
377
- */
378
- RecordFormatType: RecordFormatType | string | undefined;
379
-
380
- /**
381
- * <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>
382
- */
383
- MappingParameters?: MappingParameters;
384
- }
385
-
386
- export namespace RecordFormat {
387
- /**
388
- * @internal
389
- */
390
- export const filterSensitiveLog = (obj: RecordFormat): any => ({
391
- ...obj,
392
- });
393
- }
394
-
395
- /**
396
- * <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>
397
- */
398
- export interface SourceSchema {
399
- /**
400
- * <p>Specifies the format of the records on the streaming source.</p>
401
- */
402
- RecordFormat: RecordFormat | undefined;
403
-
404
- /**
405
- * <p>Specifies the encoding of the records in the streaming source. For example, UTF-8.</p>
406
- */
407
- RecordEncoding?: string;
408
-
409
- /**
410
- * <p>A list of <code>RecordColumn</code> objects.</p>
411
- */
412
- RecordColumns: RecordColumn[] | undefined;
413
- }
414
-
415
- export namespace SourceSchema {
416
- /**
417
- * @internal
418
- */
419
- export const filterSensitiveLog = (obj: SourceSchema): any => ({
420
- ...obj,
421
- });
422
- }
423
-
424
- /**
425
- * <p> Identifies an Amazon Kinesis Firehose delivery stream as the streaming source. You
426
- * provide the delivery stream's Amazon Resource Name (ARN) and an IAM role ARN that
427
- * enables Amazon Kinesis Analytics to access the stream on your behalf.</p>
428
- */
429
- export interface KinesisFirehoseInput {
430
- /**
431
- * <p>ARN of the input delivery stream.</p>
432
- */
433
- ResourceARN: string | undefined;
434
-
435
- /**
436
- * <p>ARN of the IAM role that Amazon Kinesis Analytics can assume to access the stream
437
- * on your behalf. You need to make sure that the role has the necessary permissions to
438
- * access the stream.</p>
439
- */
440
- RoleARN: string | undefined;
441
- }
442
-
443
- export namespace KinesisFirehoseInput {
444
- /**
445
- * @internal
446
- */
447
- export const filterSensitiveLog = (obj: KinesisFirehoseInput): any => ({
448
- ...obj,
449
- });
450
- }
451
-
452
- /**
453
- * <p> Identifies an Amazon Kinesis stream as the streaming source. You provide the
454
- * stream's Amazon Resource Name (ARN) and an IAM role ARN that enables Amazon Kinesis
455
- * Analytics to access the stream on your behalf.</p>
456
- */
457
- export interface KinesisStreamsInput {
458
- /**
459
- * <p>ARN of the input Amazon Kinesis stream to read.</p>
460
- */
461
- ResourceARN: string | undefined;
462
-
463
- /**
464
- * <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>
465
- */
466
- RoleARN: string | undefined;
467
- }
468
-
469
- export namespace KinesisStreamsInput {
470
- /**
471
- * @internal
472
- */
473
- export const filterSensitiveLog = (obj: KinesisStreamsInput): any => ({
474
- ...obj,
475
- });
476
- }
477
-
478
- /**
479
- * <p>When you configure the application input, you specify the streaming source, the
480
- * in-application stream name that is created, and the mapping between the two.
481
- * For more information,
482
- * see <a href="https://docs.aws.amazon.com/kinesisanalytics/latest/dev/how-it-works-input.html">Configuring Application Input</a>. </p>
483
- */
484
- export interface Input {
485
- /**
486
- * <p>Name prefix to use when creating an in-application stream. Suppose that you specify
487
- * a prefix "MyInApplicationStream." Amazon Kinesis Analytics then creates one or more (as
488
- * per the <code>InputParallelism</code> count you specified) in-application streams with
489
- * names "MyInApplicationStream_001," "MyInApplicationStream_002," and so on. </p>
490
- */
491
- NamePrefix: string | undefined;
492
-
493
- /**
494
- * <p>The <a href="https://docs.aws.amazon.com/kinesisanalytics/latest/dev/API_InputProcessingConfiguration.html">InputProcessingConfiguration</a> for the input. An input
495
- * processor transforms records as they are received from the stream, before the
496
- * application's SQL code executes. Currently, the only input processing configuration
497
- * available is <a href="https://docs.aws.amazon.com/kinesisanalytics/latest/dev/API_InputLambdaProcessor.html">InputLambdaProcessor</a>.</p>
498
- */
499
- InputProcessingConfiguration?: InputProcessingConfiguration;
500
-
501
- /**
502
- * <p>If the streaming source is an Amazon Kinesis stream,
503
- * identifies the stream's Amazon Resource Name (ARN) and an IAM role
504
- * that enables Amazon Kinesis Analytics to access the stream on your behalf.</p>
505
- * <p>Note: Either <code>KinesisStreamsInput</code> or <code>KinesisFirehoseInput</code> is required.</p>
506
- */
507
- KinesisStreamsInput?: KinesisStreamsInput;
508
-
509
- /**
510
- * <p>If the streaming source is an Amazon Kinesis Firehose delivery stream, identifies
511
- * the delivery stream's ARN and an IAM role that enables Amazon Kinesis Analytics to
512
- * access the stream on your behalf.</p>
513
- * <p>Note: Either <code>KinesisStreamsInput</code> or <code>KinesisFirehoseInput</code> is required.</p>
514
- */
515
- KinesisFirehoseInput?: KinesisFirehoseInput;
516
-
517
- /**
518
- * <p>Describes the number of in-application streams to create. </p>
519
- * <p>Data from your source is routed to these in-application input streams.</p>
520
- * <p> (see <a href="https://docs.aws.amazon.com/kinesisanalytics/latest/dev/how-it-works-input.html">Configuring Application Input</a>.</p>
521
- */
522
- InputParallelism?: InputParallelism;
523
-
524
- /**
525
- * <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>
526
- * <p>Also used to describe the format of the reference data source.</p>
527
- */
528
- InputSchema: SourceSchema | undefined;
529
- }
530
-
531
- export namespace Input {
532
- /**
533
- * @internal
534
- */
535
- export const filterSensitiveLog = (obj: Input): any => ({
536
- ...obj,
537
- });
538
- }
539
-
540
- /**
541
- * <p></p>
542
- */
543
- export interface AddApplicationInputRequest {
544
- /**
545
- * <p>Name of your existing Amazon Kinesis Analytics application to which you want to add the streaming source.</p>
546
- */
547
- ApplicationName: string | undefined;
548
-
549
- /**
550
- * <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
551
- * to find the current application version.</p>
552
- */
553
- CurrentApplicationVersionId: number | undefined;
554
-
555
- /**
556
- * <p>The <a href="https://docs.aws.amazon.com/kinesisanalytics/latest/dev/API_Input.html">Input</a> to add.</p>
557
- */
558
- Input: Input | undefined;
559
- }
560
-
561
- export namespace AddApplicationInputRequest {
562
- /**
563
- * @internal
564
- */
565
- export const filterSensitiveLog = (obj: AddApplicationInputRequest): any => ({
566
- ...obj,
567
- });
568
- }
569
-
570
- /**
571
- * <p></p>
572
- */
573
- export interface AddApplicationInputResponse {}
574
-
575
- export namespace AddApplicationInputResponse {
576
- /**
577
- * @internal
578
- */
579
- export const filterSensitiveLog = (obj: AddApplicationInputResponse): any => ({
580
- ...obj,
581
- });
582
- }
583
-
584
- /**
585
- * <p>User-provided application code (query) is invalid. This can be a simple syntax error.</p>
586
- */
587
- export interface CodeValidationException extends __SmithyException, $MetadataBearer {
588
- name: "CodeValidationException";
589
- $fault: "client";
590
- /**
591
- * <p>Test</p>
592
- */
593
- message?: string;
594
- }
595
-
596
- export namespace CodeValidationException {
597
- /**
598
- * @internal
599
- */
600
- export const filterSensitiveLog = (obj: CodeValidationException): any => ({
601
- ...obj,
602
- });
603
- }
604
-
605
- export interface AddApplicationInputProcessingConfigurationRequest {
606
- /**
607
- * <p>Name of the application to which you want to add the input processing configuration.</p>
608
- */
609
- ApplicationName: string | undefined;
610
-
611
- /**
612
- * <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>
613
- * operation to get the current application version. If the version specified is not the current version, the
614
- * <code>ConcurrentModificationException</code> is returned.</p>
615
- */
616
- CurrentApplicationVersionId: number | undefined;
617
-
618
- /**
619
- * <p>The ID of the input configuration to add the input processing configuration to. You
620
- * 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>
621
- */
622
- InputId: string | undefined;
623
-
624
- /**
625
- * <p>The <a href="https://docs.aws.amazon.com/kinesisanalytics/latest/dev/API_InputProcessingConfiguration.html">InputProcessingConfiguration</a> to add to the application.</p>
626
- */
627
- InputProcessingConfiguration: InputProcessingConfiguration | undefined;
628
- }
629
-
630
- export namespace AddApplicationInputProcessingConfigurationRequest {
631
- /**
632
- * @internal
633
- */
634
- export const filterSensitiveLog = (obj: AddApplicationInputProcessingConfigurationRequest): any => ({
635
- ...obj,
636
- });
637
- }
638
-
639
- export interface AddApplicationInputProcessingConfigurationResponse {}
640
-
641
- export namespace AddApplicationInputProcessingConfigurationResponse {
642
- /**
643
- * @internal
644
- */
645
- export const filterSensitiveLog = (obj: AddApplicationInputProcessingConfigurationResponse): any => ({
646
- ...obj,
647
- });
648
- }
649
-
650
- /**
651
- * <p>Describes the data format when records are written to the destination.
652
- * For more information,
653
- * see <a href="https://docs.aws.amazon.com/kinesisanalytics/latest/dev/how-it-works-output.html">Configuring Application Output</a>.
654
- *
655
- *
656
- * </p>
657
- */
658
- export interface DestinationSchema {
659
- /**
660
- * <p>Specifies the format of the records on the output stream.</p>
661
- */
662
- RecordFormatType: RecordFormatType | string | undefined;
663
- }
664
-
665
- export namespace DestinationSchema {
666
- /**
667
- * @internal
668
- */
669
- export const filterSensitiveLog = (obj: DestinationSchema): any => ({
670
- ...obj,
671
- });
672
- }
673
-
674
- /**
675
- * <p>When configuring application output,
676
- * identifies an Amazon Kinesis Firehose delivery stream as the destination.
677
- * You provide the stream Amazon Resource Name (ARN) and an IAM role
678
- * that enables Amazon Kinesis Analytics to write to the stream on your behalf.</p>
679
- */
680
- export interface KinesisFirehoseOutput {
681
- /**
682
- * <p>ARN of the destination Amazon Kinesis Firehose delivery stream to write to.</p>
683
- */
684
- ResourceARN: string | undefined;
685
-
686
- /**
687
- * <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>
688
- */
689
- RoleARN: string | undefined;
690
- }
691
-
692
- export namespace KinesisFirehoseOutput {
693
- /**
694
- * @internal
695
- */
696
- export const filterSensitiveLog = (obj: KinesisFirehoseOutput): any => ({
697
- ...obj,
698
- });
699
- }
700
-
701
- /**
702
- * <p>When configuring application output, identifies an Amazon Kinesis stream as the
703
- * destination. You provide the stream Amazon Resource Name (ARN) and also an IAM role ARN
704
- * that Amazon Kinesis Analytics can use to write to the stream on your behalf.</p>
705
- */
706
- export interface KinesisStreamsOutput {
707
- /**
708
- * <p>ARN of the destination Amazon Kinesis stream to write to.</p>
709
- */
710
- ResourceARN: string | undefined;
711
-
712
- /**
713
- * <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>
714
- */
715
- RoleARN: string | undefined;
716
- }
717
-
718
- export namespace KinesisStreamsOutput {
719
- /**
720
- * @internal
721
- */
722
- export const filterSensitiveLog = (obj: KinesisStreamsOutput): any => ({
723
- ...obj,
724
- });
725
- }
726
-
727
- /**
728
- * <p>When configuring application output, identifies an AWS Lambda function as the
729
- * destination. You provide the function Amazon Resource Name (ARN) and also an IAM role
730
- * ARN that Amazon Kinesis Analytics can use to write to the function on your behalf. </p>
731
- */
732
- export interface LambdaOutput {
733
- /**
734
- * <p>Amazon Resource Name (ARN) of the destination Lambda function to write
735
- * to.</p>
736
- * <note>
737
- * <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>
738
- * </p>
739
- * </note>
740
- */
741
- ResourceARN: string | undefined;
742
-
743
- /**
744
- * <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>
745
- */
746
- RoleARN: string | undefined;
747
- }
748
-
749
- export namespace LambdaOutput {
750
- /**
751
- * @internal
752
- */
753
- export const filterSensitiveLog = (obj: LambdaOutput): any => ({
754
- ...obj,
755
- });
756
- }
757
-
758
- /**
759
- * <p>
760
- * Describes application output configuration in which you identify
761
- * an in-application stream and a destination where you want the
762
- * in-application stream data to be written. The destination can be
763
- * an Amazon Kinesis stream or an Amazon Kinesis Firehose delivery stream.
764
- * </p>
765
- *
766
- * <p></p>
767
- * <p>For limits on how many destinations an application can write and other
768
- * limitations, see
769
- * <a href="https://docs.aws.amazon.com/kinesisanalytics/latest/dev/limits.html">Limits</a>.
770
- * </p>
771
- */
772
- export interface Output {
773
- /**
774
- * <p>Name of the in-application stream.</p>
775
- */
776
- Name: string | undefined;
777
-
778
- /**
779
- * <p>Identifies an Amazon Kinesis stream
780
- * as the destination.</p>
781
- */
782
- KinesisStreamsOutput?: KinesisStreamsOutput;
783
-
784
- /**
785
- * <p>Identifies an Amazon Kinesis Firehose delivery stream as the destination.</p>
786
- */
787
- KinesisFirehoseOutput?: KinesisFirehoseOutput;
788
-
789
- /**
790
- * <p>Identifies an AWS Lambda function as the destination.</p>
791
- */
792
- LambdaOutput?: LambdaOutput;
793
-
794
- /**
795
- * <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>
796
- */
797
- DestinationSchema: DestinationSchema | undefined;
798
- }
799
-
800
- export namespace Output {
801
- /**
802
- * @internal
803
- */
804
- export const filterSensitiveLog = (obj: Output): any => ({
805
- ...obj,
806
- });
807
- }
808
-
809
- /**
810
- * <p></p>
811
- */
812
- export interface AddApplicationOutputRequest {
813
- /**
814
- * <p>Name of the application to which you want to add the output configuration.</p>
815
- */
816
- ApplicationName: string | undefined;
817
-
818
- /**
819
- * <p>Version of the application to which you want to add the output configuration. You
820
- * can use the <a href="https://docs.aws.amazon.com/kinesisanalytics/latest/dev/API_DescribeApplication.html">DescribeApplication</a> operation to get the current
821
- * application version. If the version specified is not the current version, the
822
- * <code>ConcurrentModificationException</code> is returned. </p>
823
- */
824
- CurrentApplicationVersionId: number | undefined;
825
-
826
- /**
827
- * <p>An array of objects, each describing one output configuration. In the output
828
- * configuration, you specify the name of an in-application stream, a destination (that is,
829
- * an Amazon Kinesis stream, an Amazon Kinesis Firehose delivery stream, or an AWS Lambda
830
- * function), and record the formation to use when writing to the destination.</p>
831
- */
832
- Output: Output | undefined;
833
- }
834
-
835
- export namespace AddApplicationOutputRequest {
836
- /**
837
- * @internal
838
- */
839
- export const filterSensitiveLog = (obj: AddApplicationOutputRequest): any => ({
840
- ...obj,
841
- });
842
- }
843
-
844
- /**
845
- * <p></p>
846
- */
847
- export interface AddApplicationOutputResponse {}
848
-
849
- export namespace AddApplicationOutputResponse {
850
- /**
851
- * @internal
852
- */
853
- export const filterSensitiveLog = (obj: AddApplicationOutputResponse): any => ({
854
- ...obj,
855
- });
856
- }
857
-
858
- /**
859
- * <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>
860
- * <p>An Amazon Kinesis Analytics application loads reference data only once. If the data changes,
861
- * you call the <a href="https://docs.aws.amazon.com/kinesisanalytics/latest/dev/API_UpdateApplication.html">UpdateApplication</a> operation to trigger
862
- * reloading of data into your application.</p>
863
- */
864
- export interface S3ReferenceDataSource {
865
- /**
866
- * <p>Amazon Resource Name (ARN) of the S3 bucket.</p>
867
- */
868
- BucketARN: string | undefined;
869
-
870
- /**
871
- * <p>Object key name containing reference data.</p>
872
- */
873
- FileKey: string | undefined;
874
-
875
- /**
876
- * <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>
877
- */
878
- ReferenceRoleARN: string | undefined;
879
- }
880
-
881
- export namespace S3ReferenceDataSource {
882
- /**
883
- * @internal
884
- */
885
- export const filterSensitiveLog = (obj: S3ReferenceDataSource): any => ({
886
- ...obj,
887
- });
888
- }
889
-
890
- /**
891
- * <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>
892
- */
893
- export interface ReferenceDataSource {
894
- /**
895
- * <p>Name of the in-application table to create.</p>
896
- */
897
- TableName: string | undefined;
898
-
899
- /**
900
- * <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.
901
- *
902
- * 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>
903
- */
904
- S3ReferenceDataSource?: S3ReferenceDataSource;
905
-
906
- /**
907
- * <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>
908
- */
909
- ReferenceSchema: SourceSchema | undefined;
910
- }
911
-
912
- export namespace ReferenceDataSource {
913
- /**
914
- * @internal
915
- */
916
- export const filterSensitiveLog = (obj: ReferenceDataSource): any => ({
917
- ...obj,
918
- });
919
- }
920
-
921
- /**
922
- * <p></p>
923
- */
924
- export interface AddApplicationReferenceDataSourceRequest {
925
- /**
926
- * <p>Name of an existing application.</p>
927
- */
928
- ApplicationName: string | undefined;
929
-
930
- /**
931
- * <p>Version of the application for which you are adding the reference data source.
932
- * 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.
933
- * If the version specified is not the current version, the
934
- * <code>ConcurrentModificationException</code> is returned.</p>
935
- */
936
- CurrentApplicationVersionId: number | undefined;
937
-
938
- /**
939
- * <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>
940
- */
941
- ReferenceDataSource: ReferenceDataSource | undefined;
942
- }
943
-
944
- export namespace AddApplicationReferenceDataSourceRequest {
945
- /**
946
- * @internal
947
- */
948
- export const filterSensitiveLog = (obj: AddApplicationReferenceDataSourceRequest): any => ({
949
- ...obj,
950
- });
951
- }
952
-
953
- /**
954
- * <p></p>
955
- */
956
- export interface AddApplicationReferenceDataSourceResponse {}
957
-
958
- export namespace AddApplicationReferenceDataSourceResponse {
959
- /**
960
- * @internal
961
- */
962
- export const filterSensitiveLog = (obj: AddApplicationReferenceDataSourceResponse): any => ({
963
- ...obj,
964
- });
965
- }
966
-
967
- export enum ApplicationStatus {
968
- DELETING = "DELETING",
969
- READY = "READY",
970
- RUNNING = "RUNNING",
971
- STARTING = "STARTING",
972
- STOPPING = "STOPPING",
973
- UPDATING = "UPDATING",
974
- }
975
-
976
- /**
977
- * <p>Description of the CloudWatch logging option.</p>
978
- */
979
- export interface CloudWatchLoggingOptionDescription {
980
- /**
981
- * <p>ID of the CloudWatch logging option description.</p>
982
- */
983
- CloudWatchLoggingOptionId?: string;
984
-
985
- /**
986
- * <p>ARN of the CloudWatch log to receive application messages.</p>
987
- */
988
- LogStreamARN: string | undefined;
989
-
990
- /**
991
- * <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>
992
- */
993
- RoleARN: string | undefined;
994
- }
995
-
996
- export namespace CloudWatchLoggingOptionDescription {
997
- /**
998
- * @internal
999
- */
1000
- export const filterSensitiveLog = (obj: CloudWatchLoggingOptionDescription): any => ({
1001
- ...obj,
1002
- });
1003
- }
1004
-
1005
- /**
1006
- * <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
1007
- * is used to preprocess records in the stream, and the ARN of the IAM role that is used
1008
- * to access the AWS Lambda expression.</p>
1009
- */
1010
- export interface InputLambdaProcessorDescription {
1011
- /**
1012
- * <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>
1013
- */
1014
- ResourceARN?: string;
1015
-
1016
- /**
1017
- * <p>The ARN of the IAM role that is used to access the AWS Lambda function.</p>
1018
- */
1019
- RoleARN?: string;
1020
- }
1021
-
1022
- export namespace InputLambdaProcessorDescription {
1023
- /**
1024
- * @internal
1025
- */
1026
- export const filterSensitiveLog = (obj: InputLambdaProcessorDescription): any => ({
1027
- ...obj,
1028
- });
1029
- }
1030
-
1031
- /**
1032
- * <p>Provides configuration information about an input processor. Currently, the only input processor available is
1033
- * <a href="https://docs.aws.amazon.com/lambda/">AWS Lambda</a>.</p>
1034
- */
1035
- export interface InputProcessingConfigurationDescription {
1036
- /**
1037
- * <p>Provides configuration information about the associated <a href="https://docs.aws.amazon.com/kinesisanalytics/latest/dev/API_InputLambdaProcessorDescription.html">InputLambdaProcessorDescription</a>.</p>
1038
- */
1039
- InputLambdaProcessorDescription?: InputLambdaProcessorDescription;
1040
- }
1041
-
1042
- export namespace InputProcessingConfigurationDescription {
1043
- /**
1044
- * @internal
1045
- */
1046
- export const filterSensitiveLog = (obj: InputProcessingConfigurationDescription): any => ({
1047
- ...obj,
1048
- });
1049
- }
1050
-
1051
- export enum InputStartingPosition {
1052
- LAST_STOPPED_POINT = "LAST_STOPPED_POINT",
1053
- NOW = "NOW",
1054
- TRIM_HORIZON = "TRIM_HORIZON",
1055
- }
1056
-
1057
- /**
1058
- * <p>Describes the point at which the application reads from
1059
- * the streaming source.</p>
1060
- */
1061
- export interface InputStartingPositionConfiguration {
1062
- /**
1063
- * <p>The starting position on the stream.</p>
1064
- * <ul>
1065
- * <li>
1066
- * <p>
1067
- * <code>NOW</code> - Start reading just after the most recent record in the
1068
- * stream, start at the request time stamp that the customer issued.</p>
1069
- *
1070
- *
1071
- * </li>
1072
- * <li>
1073
- * <p>
1074
- * <code>TRIM_HORIZON</code> - Start reading at the last untrimmed record in the stream,
1075
- * which is the oldest record available in the stream. This option is not available
1076
- * for an Amazon Kinesis Firehose delivery stream.</p>
1077
- * </li>
1078
- * <li>
1079
- * <p>
1080
- * <code>LAST_STOPPED_POINT</code> - Resume reading from where the application last stopped reading.</p>
1081
- * </li>
1082
- * </ul>
1083
- */
1084
- InputStartingPosition?: InputStartingPosition | string;
1085
- }
1086
-
1087
- export namespace InputStartingPositionConfiguration {
1088
- /**
1089
- * @internal
1090
- */
1091
- export const filterSensitiveLog = (obj: InputStartingPositionConfiguration): any => ({
1092
- ...obj,
1093
- });
1094
- }
1095
-
1096
- /**
1097
- * <p>
1098
- * Describes the Amazon Kinesis Firehose delivery stream that is configured as the streaming source
1099
- * in the application input configuration.
1100
- * </p>
1101
- */
1102
- export interface KinesisFirehoseInputDescription {
1103
- /**
1104
- * <p>Amazon Resource Name (ARN) of the Amazon Kinesis Firehose delivery stream.</p>
1105
- */
1106
- ResourceARN?: string;
1107
-
1108
- /**
1109
- * <p>ARN of the IAM role that Amazon Kinesis Analytics assumes to access the stream.</p>
1110
- */
1111
- RoleARN?: string;
1112
- }
1113
-
1114
- export namespace KinesisFirehoseInputDescription {
1115
- /**
1116
- * @internal
1117
- */
1118
- export const filterSensitiveLog = (obj: KinesisFirehoseInputDescription): any => ({
1119
- ...obj,
1120
- });
1121
- }
1122
-
1123
- /**
1124
- * <p>
1125
- * Describes the Amazon Kinesis stream that is configured as the streaming source
1126
- * in the application input configuration.
1127
- * </p>
1128
- */
1129
- export interface KinesisStreamsInputDescription {
1130
- /**
1131
- * <p>Amazon Resource Name (ARN) of the Amazon Kinesis stream.</p>
1132
- */
1133
- ResourceARN?: string;
1134
-
1135
- /**
1136
- * <p>ARN of the IAM role that Amazon Kinesis Analytics can assume to access the stream.</p>
1137
- */
1138
- RoleARN?: string;
1139
- }
1140
-
1141
- export namespace KinesisStreamsInputDescription {
1142
- /**
1143
- * @internal
1144
- */
1145
- export const filterSensitiveLog = (obj: KinesisStreamsInputDescription): any => ({
1146
- ...obj,
1147
- });
1148
- }
1149
-
1150
- /**
1151
- * <p>Describes the application input configuration.
1152
- * For more information,
1153
- * see <a href="https://docs.aws.amazon.com/kinesisanalytics/latest/dev/how-it-works-input.html">Configuring Application Input</a>.
1154
- * </p>
1155
- */
1156
- export interface InputDescription {
1157
- /**
1158
- * <p>Input ID associated with the application input.
1159
- * This is the ID that Amazon Kinesis Analytics assigns to each
1160
- * input configuration you add to your application. </p>
1161
- */
1162
- InputId?: string;
1163
-
1164
- /**
1165
- * <p>In-application name prefix.</p>
1166
- */
1167
- NamePrefix?: string;
1168
-
1169
- /**
1170
- * <p>Returns the in-application stream names that are mapped to the
1171
- * stream source.</p>
1172
- */
1173
- InAppStreamNames?: string[];
1174
-
1175
- /**
1176
- * <p>The description of the preprocessor that executes on records in this input before the application's code is run.</p>
1177
- */
1178
- InputProcessingConfigurationDescription?: InputProcessingConfigurationDescription;
1179
-
1180
- /**
1181
- * <p>If an Amazon Kinesis stream is configured as streaming source, provides Amazon
1182
- * Kinesis stream's Amazon Resource Name (ARN) and an IAM role that enables Amazon Kinesis
1183
- * Analytics to access the stream on your behalf.</p>
1184
- */
1185
- KinesisStreamsInputDescription?: KinesisStreamsInputDescription;
1186
-
1187
- /**
1188
- * <p>If an Amazon Kinesis Firehose delivery stream is configured as a streaming source,
1189
- * provides the delivery stream's ARN and an IAM role that enables Amazon Kinesis Analytics
1190
- * to access the stream on your behalf.</p>
1191
- */
1192
- KinesisFirehoseInputDescription?: KinesisFirehoseInputDescription;
1193
-
1194
- /**
1195
- * <p>Describes the format of the data in the streaming source, and how each data element maps to corresponding
1196
- * columns in the in-application stream that is being created. </p>
1197
- */
1198
- InputSchema?: SourceSchema;
1199
-
1200
- /**
1201
- * <p>Describes the configured parallelism (number of in-application streams
1202
- * mapped to the streaming source).</p>
1203
- */
1204
- InputParallelism?: InputParallelism;
1205
-
1206
- /**
1207
- * <p>Point at which the application is configured to read from the input stream.</p>
1208
- */
1209
- InputStartingPositionConfiguration?: InputStartingPositionConfiguration;
1210
- }
1211
-
1212
- export namespace InputDescription {
1213
- /**
1214
- * @internal
1215
- */
1216
- export const filterSensitiveLog = (obj: InputDescription): any => ({
1217
- ...obj,
1218
- });
1219
- }
1220
-
1221
- /**
1222
- * <p>
1223
- * For an application output, describes
1224
- * the Amazon Kinesis Firehose delivery stream configured as its destination.
1225
- * </p>
1226
- */
1227
- export interface KinesisFirehoseOutputDescription {
1228
- /**
1229
- * <p>Amazon Resource Name (ARN) of the Amazon Kinesis Firehose delivery stream.</p>
1230
- */
1231
- ResourceARN?: string;
1232
-
1233
- /**
1234
- * <p>ARN of the IAM role that Amazon Kinesis Analytics can assume to access the stream.</p>
1235
- */
1236
- RoleARN?: string;
1237
- }
1238
-
1239
- export namespace KinesisFirehoseOutputDescription {
1240
- /**
1241
- * @internal
1242
- */
1243
- export const filterSensitiveLog = (obj: KinesisFirehoseOutputDescription): any => ({
1244
- ...obj,
1245
- });
1246
- }
1247
-
1248
- /**
1249
- * <p>
1250
- * For an application output, describes
1251
- * the Amazon Kinesis stream configured as its destination.
1252
- * </p>
1253
- */
1254
- export interface KinesisStreamsOutputDescription {
1255
- /**
1256
- * <p>Amazon Resource Name (ARN) of the Amazon Kinesis stream.</p>
1257
- */
1258
- ResourceARN?: string;
1259
-
1260
- /**
1261
- * <p>ARN of the IAM role that Amazon Kinesis Analytics can assume to access the stream.</p>
1262
- */
1263
- RoleARN?: string;
1264
- }
1265
-
1266
- export namespace KinesisStreamsOutputDescription {
1267
- /**
1268
- * @internal
1269
- */
1270
- export const filterSensitiveLog = (obj: KinesisStreamsOutputDescription): any => ({
1271
- ...obj,
1272
- });
1273
- }
1274
-
1275
- /**
1276
- * <p>For an application output, describes the AWS Lambda function configured as its
1277
- * destination. </p>
1278
- */
1279
- export interface LambdaOutputDescription {
1280
- /**
1281
- * <p>Amazon Resource Name (ARN) of the destination Lambda function.</p>
1282
- */
1283
- ResourceARN?: string;
1284
-
1285
- /**
1286
- * <p>ARN of the IAM role that Amazon Kinesis Analytics can assume to write to the destination function.</p>
1287
- */
1288
- RoleARN?: string;
1289
- }
1290
-
1291
- export namespace LambdaOutputDescription {
1292
- /**
1293
- * @internal
1294
- */
1295
- export const filterSensitiveLog = (obj: LambdaOutputDescription): any => ({
1296
- ...obj,
1297
- });
1298
- }
1299
-
1300
- /**
1301
- * <p>Describes the application output configuration, which includes
1302
- * the in-application stream name and the destination where the stream data
1303
- * is written. The destination can be an Amazon Kinesis stream or an
1304
- * Amazon Kinesis Firehose delivery stream.
1305
- * </p>
1306
- */
1307
- export interface OutputDescription {
1308
- /**
1309
- * <p>A unique identifier for the output configuration.</p>
1310
- */
1311
- OutputId?: string;
1312
-
1313
- /**
1314
- * <p>Name of the in-application stream configured as output.</p>
1315
- */
1316
- Name?: string;
1317
-
1318
- /**
1319
- * <p>Describes Amazon Kinesis stream configured as the
1320
- * destination where output is written.</p>
1321
- */
1322
- KinesisStreamsOutputDescription?: KinesisStreamsOutputDescription;
1323
-
1324
- /**
1325
- * <p>Describes the Amazon Kinesis Firehose delivery stream configured as the
1326
- * destination where output is written.</p>
1327
- */
1328
- KinesisFirehoseOutputDescription?: KinesisFirehoseOutputDescription;
1329
-
1330
- /**
1331
- * <p>Describes the AWS Lambda function configured as the destination where output is
1332
- * written.</p>
1333
- */
1334
- LambdaOutputDescription?: LambdaOutputDescription;
1335
-
1336
- /**
1337
- * <p>Data format used for writing data to the destination.</p>
1338
- */
1339
- DestinationSchema?: DestinationSchema;
1340
- }
1341
-
1342
- export namespace OutputDescription {
1343
- /**
1344
- * @internal
1345
- */
1346
- export const filterSensitiveLog = (obj: OutputDescription): any => ({
1347
- ...obj,
1348
- });
1349
- }
1350
-
1351
- /**
1352
- * <p>Provides the bucket name and object key name that stores the reference data.</p>
1353
- */
1354
- export interface S3ReferenceDataSourceDescription {
1355
- /**
1356
- * <p>Amazon Resource Name (ARN) of the S3 bucket.</p>
1357
- */
1358
- BucketARN: string | undefined;
1359
-
1360
- /**
1361
- * <p>Amazon S3 object key name.</p>
1362
- */
1363
- FileKey: string | undefined;
1364
-
1365
- /**
1366
- * <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>
1367
- */
1368
- ReferenceRoleARN: string | undefined;
1369
- }
1370
-
1371
- export namespace S3ReferenceDataSourceDescription {
1372
- /**
1373
- * @internal
1374
- */
1375
- export const filterSensitiveLog = (obj: S3ReferenceDataSourceDescription): any => ({
1376
- ...obj,
1377
- });
1378
- }
1379
-
1380
- /**
1381
- * <p>Describes the reference data source configured for an application.</p>
1382
- */
1383
- export interface ReferenceDataSourceDescription {
1384
- /**
1385
- * <p>ID of the reference data source. This is the ID
1386
- * that Amazon Kinesis Analytics assigns when you add the reference data source
1387
- * to your application using the <a href="https://docs.aws.amazon.com/kinesisanalytics/latest/dev/API_AddApplicationReferenceDataSource.html">AddApplicationReferenceDataSource</a> operation.</p>
1388
- */
1389
- ReferenceId: string | undefined;
1390
-
1391
- /**
1392
- * <p>The in-application table name created by the specific reference data source configuration.</p>
1393
- */
1394
- TableName: string | undefined;
1395
-
1396
- /**
1397
- * <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>
1398
- */
1399
- S3ReferenceDataSourceDescription: S3ReferenceDataSourceDescription | undefined;
1400
-
1401
- /**
1402
- * <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>
1403
- */
1404
- ReferenceSchema?: SourceSchema;
1405
- }
1406
-
1407
- export namespace ReferenceDataSourceDescription {
1408
- /**
1409
- * @internal
1410
- */
1411
- export const filterSensitiveLog = (obj: ReferenceDataSourceDescription): any => ({
1412
- ...obj,
1413
- });
1414
- }
1415
-
1416
- /**
1417
- * <note>
1418
- * <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>
1419
- * </note>
1420
- * <p>Provides a description of the application, including the application Amazon Resource Name (ARN), status, latest version, and input and output configuration.</p>
1421
- */
1422
- export interface ApplicationDetail {
1423
- /**
1424
- * <p>Name of the application.</p>
1425
- */
1426
- ApplicationName: string | undefined;
1427
-
1428
- /**
1429
- * <p>Description of the application.</p>
1430
- */
1431
- ApplicationDescription?: string;
1432
-
1433
- /**
1434
- * <p>ARN of the application.</p>
1435
- */
1436
- ApplicationARN: string | undefined;
1437
-
1438
- /**
1439
- * <p>Status of the application.</p>
1440
- */
1441
- ApplicationStatus: ApplicationStatus | string | undefined;
1442
-
1443
- /**
1444
- * <p>Time stamp when the application version was created.</p>
1445
- */
1446
- CreateTimestamp?: Date;
1447
-
1448
- /**
1449
- * <p>Time stamp when the application was last updated.</p>
1450
- */
1451
- LastUpdateTimestamp?: Date;
1452
-
1453
- /**
1454
- * <p>Describes the application input configuration.
1455
- * For more information,
1456
- * see <a href="https://docs.aws.amazon.com/kinesisanalytics/latest/dev/how-it-works-input.html">Configuring Application Input</a>.
1457
- *
1458
- * </p>
1459
- */
1460
- InputDescriptions?: InputDescription[];
1461
-
1462
- /**
1463
- * <p>Describes the application output configuration.
1464
- * For more information,
1465
- * see <a href="https://docs.aws.amazon.com/kinesisanalytics/latest/dev/how-it-works-output.html">Configuring Application Output</a>.
1466
- *
1467
- * </p>
1468
- */
1469
- OutputDescriptions?: OutputDescription[];
1470
-
1471
- /**
1472
- * <p>Describes reference data sources configured for the application.
1473
- *
1474
- * For more information,
1475
- * see <a href="https://docs.aws.amazon.com/kinesisanalytics/latest/dev/how-it-works-input.html">Configuring Application Input</a>.
1476
- *
1477
- * </p>
1478
- */
1479
- ReferenceDataSourceDescriptions?: ReferenceDataSourceDescription[];
1480
-
1481
- /**
1482
- * <p>Describes the CloudWatch log streams that are configured to receive application
1483
- * messages. For more information about using CloudWatch log streams with Amazon Kinesis
1484
- * Analytics applications, see <a href="https://docs.aws.amazon.com/kinesisanalytics/latest/dev/cloudwatch-logs.html">Working with Amazon
1485
- * CloudWatch Logs</a>. </p>
1486
- */
1487
- CloudWatchLoggingOptionDescriptions?: CloudWatchLoggingOptionDescription[];
1488
-
1489
- /**
1490
- * <p>Returns the application code that you provided to perform data analysis on any of the in-application streams in your application.</p>
1491
- */
1492
- ApplicationCode?: string;
1493
-
1494
- /**
1495
- * <p>Provides the current application version.</p>
1496
- */
1497
- ApplicationVersionId: number | undefined;
1498
- }
1499
-
1500
- export namespace ApplicationDetail {
1501
- /**
1502
- * @internal
1503
- */
1504
- export const filterSensitiveLog = (obj: ApplicationDetail): any => ({
1505
- ...obj,
1506
- });
1507
- }
1508
-
1509
- /**
1510
- * <note>
1511
- * <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>
1512
- * </note>
1513
- * <p>Provides application summary information, including the application Amazon Resource Name (ARN), name, and status.</p>
1514
- */
1515
- export interface ApplicationSummary {
1516
- /**
1517
- * <p>Name of the application.</p>
1518
- */
1519
- ApplicationName: string | undefined;
1520
-
1521
- /**
1522
- * <p>ARN of the application.</p>
1523
- */
1524
- ApplicationARN: string | undefined;
1525
-
1526
- /**
1527
- * <p>Status of the application.</p>
1528
- */
1529
- ApplicationStatus: ApplicationStatus | string | undefined;
1530
- }
1531
-
1532
- export namespace ApplicationSummary {
1533
- /**
1534
- * @internal
1535
- */
1536
- export const filterSensitiveLog = (obj: ApplicationSummary): any => ({
1537
- ...obj,
1538
- });
1539
- }
1540
-
1541
- /**
1542
- * <p>Describes CloudWatch logging option updates.</p>
1543
- */
1544
- export interface CloudWatchLoggingOptionUpdate {
1545
- /**
1546
- * <p>ID of the CloudWatch logging option to update</p>
1547
- */
1548
- CloudWatchLoggingOptionId: string | undefined;
1549
-
1550
- /**
1551
- * <p>ARN of the CloudWatch log to receive application messages.</p>
1552
- */
1553
- LogStreamARNUpdate?: string;
1554
-
1555
- /**
1556
- * <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>
1557
- */
1558
- RoleARNUpdate?: string;
1559
- }
1560
-
1561
- export namespace CloudWatchLoggingOptionUpdate {
1562
- /**
1563
- * @internal
1564
- */
1565
- export const filterSensitiveLog = (obj: CloudWatchLoggingOptionUpdate): any => ({
1566
- ...obj,
1567
- });
1568
- }
1569
-
1570
- /**
1571
- * <p>Provides updates to the parallelism count.</p>
1572
- */
1573
- export interface InputParallelismUpdate {
1574
- /**
1575
- * <p>Number of in-application streams to create for the specified
1576
- * streaming source.</p>
1577
- */
1578
- CountUpdate?: number;
1579
- }
1580
-
1581
- export namespace InputParallelismUpdate {
1582
- /**
1583
- * @internal
1584
- */
1585
- export const filterSensitiveLog = (obj: InputParallelismUpdate): any => ({
1586
- ...obj,
1587
- });
1588
- }
1589
-
1590
- /**
1591
- * <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>
1592
- */
1593
- export interface InputLambdaProcessorUpdate {
1594
- /**
1595
- * <p>The Amazon Resource Name (ARN) of the new <a href="https://docs.aws.amazon.com/lambda/">AWS Lambda</a> function that
1596
- * is used to preprocess the records in the stream.</p>
1597
- * <note>
1598
- * <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>
1599
- * </p>
1600
- * </note>
1601
- */
1602
- ResourceARNUpdate?: string;
1603
-
1604
- /**
1605
- * <p>The ARN of the new IAM role that is used to access the AWS Lambda
1606
- * function.</p>
1607
- */
1608
- RoleARNUpdate?: string;
1609
- }
1610
-
1611
- export namespace InputLambdaProcessorUpdate {
1612
- /**
1613
- * @internal
1614
- */
1615
- export const filterSensitiveLog = (obj: InputLambdaProcessorUpdate): any => ({
1616
- ...obj,
1617
- });
1618
- }
1619
-
1620
- /**
1621
- * <p>Describes updates to an <a href="https://docs.aws.amazon.com/kinesisanalytics/latest/dev/API_InputProcessingConfiguration.html">InputProcessingConfiguration</a>. </p>
1622
- */
1623
- export interface InputProcessingConfigurationUpdate {
1624
- /**
1625
- * <p>Provides update information for an <a href="https://docs.aws.amazon.com/kinesisanalytics/latest/dev/API_InputLambdaProcessor.html">InputLambdaProcessor</a>.</p>
1626
- */
1627
- InputLambdaProcessorUpdate: InputLambdaProcessorUpdate | undefined;
1628
- }
1629
-
1630
- export namespace InputProcessingConfigurationUpdate {
1631
- /**
1632
- * @internal
1633
- */
1634
- export const filterSensitiveLog = (obj: InputProcessingConfigurationUpdate): any => ({
1635
- ...obj,
1636
- });
1637
- }
1638
-
1639
- /**
1640
- * <p>Describes updates for the application's input schema.</p>
1641
- */
1642
- export interface InputSchemaUpdate {
1643
- /**
1644
- * <p>Specifies the format of the records on the streaming source.</p>
1645
- */
1646
- RecordFormatUpdate?: RecordFormat;
1647
-
1648
- /**
1649
- * <p>Specifies the encoding of the records in the streaming source. For example, UTF-8.</p>
1650
- */
1651
- RecordEncodingUpdate?: string;
1652
-
1653
- /**
1654
- * <p>A list of <code>RecordColumn</code> objects. Each object describes the mapping
1655
- * of the streaming source element to the corresponding column in the in-application stream. </p>
1656
- */
1657
- RecordColumnUpdates?: RecordColumn[];
1658
- }
1659
-
1660
- export namespace InputSchemaUpdate {
1661
- /**
1662
- * @internal
1663
- */
1664
- export const filterSensitiveLog = (obj: InputSchemaUpdate): any => ({
1665
- ...obj,
1666
- });
1667
- }
1668
-
1669
- /**
1670
- * <p>When updating application input configuration, provides information about an
1671
- * Amazon Kinesis Firehose delivery stream as the streaming source.</p>
1672
- */
1673
- export interface KinesisFirehoseInputUpdate {
1674
- /**
1675
- * <p>Amazon Resource Name (ARN) of the input Amazon Kinesis Firehose delivery stream to
1676
- * read.</p>
1677
- */
1678
- ResourceARNUpdate?: string;
1679
-
1680
- /**
1681
- * <p>ARN of the IAM role that Amazon Kinesis Analytics can assume to access the stream
1682
- * on your behalf. You need to grant the necessary permissions to this role.</p>
1683
- */
1684
- RoleARNUpdate?: string;
1685
- }
1686
-
1687
- export namespace KinesisFirehoseInputUpdate {
1688
- /**
1689
- * @internal
1690
- */
1691
- export const filterSensitiveLog = (obj: KinesisFirehoseInputUpdate): any => ({
1692
- ...obj,
1693
- });
1694
- }
1695
-
1696
- /**
1697
- * <p>When updating application input configuration, provides information about an
1698
- * Amazon Kinesis stream as the streaming source.</p>
1699
- */
1700
- export interface KinesisStreamsInputUpdate {
1701
- /**
1702
- * <p>Amazon Resource Name (ARN) of the input Amazon Kinesis stream to read.</p>
1703
- */
1704
- ResourceARNUpdate?: string;
1705
-
1706
- /**
1707
- * <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>
1708
- */
1709
- RoleARNUpdate?: string;
1710
- }
1711
-
1712
- export namespace KinesisStreamsInputUpdate {
1713
- /**
1714
- * @internal
1715
- */
1716
- export const filterSensitiveLog = (obj: KinesisStreamsInputUpdate): any => ({
1717
- ...obj,
1718
- });
1719
- }
1720
-
1721
- /**
1722
- * <p>Describes updates to a specific input configuration (identified by the
1723
- * <code>InputId</code> of an application). </p>
1724
- */
1725
- export interface InputUpdate {
1726
- /**
1727
- * <p>Input ID of the application input to be updated.</p>
1728
- */
1729
- InputId: string | undefined;
1730
-
1731
- /**
1732
- * <p>Name prefix for in-application streams that Amazon Kinesis Analytics creates
1733
- * for the specific streaming source.</p>
1734
- */
1735
- NamePrefixUpdate?: string;
1736
-
1737
- /**
1738
- * <p>Describes updates for an input processing configuration.</p>
1739
- */
1740
- InputProcessingConfigurationUpdate?: InputProcessingConfigurationUpdate;
1741
-
1742
- /**
1743
- * <p>If an Amazon Kinesis stream is the streaming source to be updated, provides an
1744
- * updated stream Amazon Resource Name (ARN) and IAM role ARN.</p>
1745
- */
1746
- KinesisStreamsInputUpdate?: KinesisStreamsInputUpdate;
1747
-
1748
- /**
1749
- * <p>If an Amazon Kinesis Firehose delivery stream is the streaming source to be
1750
- * updated, provides an updated stream ARN and IAM role ARN.</p>
1751
- */
1752
- KinesisFirehoseInputUpdate?: KinesisFirehoseInputUpdate;
1753
-
1754
- /**
1755
- * <p>Describes the data format on the streaming source, and
1756
- * how record elements on the streaming source map to columns of the in-application stream that is created.</p>
1757
- */
1758
- InputSchemaUpdate?: InputSchemaUpdate;
1759
-
1760
- /**
1761
- * <p>Describes the parallelism updates (the number in-application
1762
- * streams Amazon Kinesis Analytics creates for the specific streaming source).</p>
1763
- */
1764
- InputParallelismUpdate?: InputParallelismUpdate;
1765
- }
1766
-
1767
- export namespace InputUpdate {
1768
- /**
1769
- * @internal
1770
- */
1771
- export const filterSensitiveLog = (obj: InputUpdate): any => ({
1772
- ...obj,
1773
- });
1774
- }
1775
-
1776
- /**
1777
- * <p>
1778
- * When updating an output configuration using the
1779
- * <a href="https://docs.aws.amazon.com/kinesisanalytics/latest/dev/API_UpdateApplication.html">UpdateApplication</a> operation,
1780
- * provides information about an Amazon Kinesis Firehose delivery stream configured as
1781
- * the destination.
1782
- * </p>
1783
- */
1784
- export interface KinesisFirehoseOutputUpdate {
1785
- /**
1786
- * <p>Amazon Resource Name (ARN) of the Amazon Kinesis Firehose delivery stream to write to.</p>
1787
- */
1788
- ResourceARNUpdate?: string;
1789
-
1790
- /**
1791
- * <p>ARN of the IAM role that Amazon Kinesis Analytics can assume to access the stream
1792
- * on your behalf. You need to grant the necessary permissions to this role.</p>
1793
- */
1794
- RoleARNUpdate?: string;
1795
- }
1796
-
1797
- export namespace KinesisFirehoseOutputUpdate {
1798
- /**
1799
- * @internal
1800
- */
1801
- export const filterSensitiveLog = (obj: KinesisFirehoseOutputUpdate): any => ({
1802
- ...obj,
1803
- });
1804
- }
1805
-
1806
- /**
1807
- * <p>
1808
- * When updating an output configuration using the
1809
- * <a href="https://docs.aws.amazon.com/kinesisanalytics/latest/dev/API_UpdateApplication.html">UpdateApplication</a> operation,
1810
- * provides information about an Amazon Kinesis stream configured as
1811
- * the destination.
1812
- * </p>
1813
- */
1814
- export interface KinesisStreamsOutputUpdate {
1815
- /**
1816
- * <p>Amazon Resource Name (ARN) of the Amazon Kinesis stream where you want to write the output.</p>
1817
- */
1818
- ResourceARNUpdate?: string;
1819
-
1820
- /**
1821
- * <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>
1822
- */
1823
- RoleARNUpdate?: string;
1824
- }
1825
-
1826
- export namespace KinesisStreamsOutputUpdate {
1827
- /**
1828
- * @internal
1829
- */
1830
- export const filterSensitiveLog = (obj: KinesisStreamsOutputUpdate): any => ({
1831
- ...obj,
1832
- });
1833
- }
1834
-
1835
- /**
1836
- * <p>When updating an output configuration using the <a href="https://docs.aws.amazon.com/kinesisanalytics/latest/dev/API_UpdateApplication.html">UpdateApplication</a>
1837
- * operation, provides information about an AWS Lambda function configured as the
1838
- * destination.</p>
1839
- */
1840
- export interface LambdaOutputUpdate {
1841
- /**
1842
- * <p>Amazon Resource Name (ARN) of the destination Lambda function.</p>
1843
- * <note>
1844
- * <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>
1845
- * </p>
1846
- * </note>
1847
- */
1848
- ResourceARNUpdate?: string;
1849
-
1850
- /**
1851
- * <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>
1852
- */
1853
- RoleARNUpdate?: string;
1854
- }
1855
-
1856
- export namespace LambdaOutputUpdate {
1857
- /**
1858
- * @internal
1859
- */
1860
- export const filterSensitiveLog = (obj: LambdaOutputUpdate): any => ({
1861
- ...obj,
1862
- });
1863
- }
1864
-
1865
- /**
1866
- * <p>
1867
- * Describes updates to the output configuration identified by
1868
- * the <code>OutputId</code>.
1869
- * </p>
1870
- */
1871
- export interface OutputUpdate {
1872
- /**
1873
- * <p>Identifies the specific output configuration that you want to update.</p>
1874
- */
1875
- OutputId: string | undefined;
1876
-
1877
- /**
1878
- * <p>If you want to specify a different in-application stream
1879
- * for this output configuration, use this field to
1880
- * specify the new in-application stream name.</p>
1881
- */
1882
- NameUpdate?: string;
1883
-
1884
- /**
1885
- * <p>Describes an Amazon Kinesis stream as the destination for the output.</p>
1886
- */
1887
- KinesisStreamsOutputUpdate?: KinesisStreamsOutputUpdate;
1888
-
1889
- /**
1890
- * <p>Describes an Amazon Kinesis Firehose delivery stream as the destination for the
1891
- * output.</p>
1892
- */
1893
- KinesisFirehoseOutputUpdate?: KinesisFirehoseOutputUpdate;
1894
-
1895
- /**
1896
- * <p>Describes an AWS Lambda function as the destination for the output.</p>
1897
- */
1898
- LambdaOutputUpdate?: LambdaOutputUpdate;
1899
-
1900
- /**
1901
- * <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>
1902
- */
1903
- DestinationSchemaUpdate?: DestinationSchema;
1904
- }
1905
-
1906
- export namespace OutputUpdate {
1907
- /**
1908
- * @internal
1909
- */
1910
- export const filterSensitiveLog = (obj: OutputUpdate): any => ({
1911
- ...obj,
1912
- });
1913
- }
1914
-
1915
- /**
1916
- * <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>
1917
- */
1918
- export interface S3ReferenceDataSourceUpdate {
1919
- /**
1920
- * <p>Amazon Resource Name (ARN) of the S3 bucket.</p>
1921
- */
1922
- BucketARNUpdate?: string;
1923
-
1924
- /**
1925
- * <p>Object key name.</p>
1926
- */
1927
- FileKeyUpdate?: string;
1928
-
1929
- /**
1930
- * <p>ARN of the IAM role that Amazon Kinesis Analytics can assume to read the Amazon S3 object and populate the in-application.</p>
1931
- */
1932
- ReferenceRoleARNUpdate?: string;
1933
- }
1934
-
1935
- export namespace S3ReferenceDataSourceUpdate {
1936
- /**
1937
- * @internal
1938
- */
1939
- export const filterSensitiveLog = (obj: S3ReferenceDataSourceUpdate): any => ({
1940
- ...obj,
1941
- });
1942
- }
1943
-
1944
- /**
1945
- * <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>
1946
- */
1947
- export interface ReferenceDataSourceUpdate {
1948
- /**
1949
- * <p>ID of the reference data source being updated. You can use the
1950
- * <a href="https://docs.aws.amazon.com/kinesisanalytics/latest/dev/API_DescribeApplication.html">DescribeApplication</a> operation to get this value.</p>
1951
- */
1952
- ReferenceId: string | undefined;
1953
-
1954
- /**
1955
- * <p>In-application table name that is created by this update.</p>
1956
- */
1957
- TableNameUpdate?: string;
1958
-
1959
- /**
1960
- * <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>
1961
- */
1962
- S3ReferenceDataSourceUpdate?: S3ReferenceDataSourceUpdate;
1963
-
1964
- /**
1965
- * <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>
1966
- */
1967
- ReferenceSchemaUpdate?: SourceSchema;
1968
- }
1969
-
1970
- export namespace ReferenceDataSourceUpdate {
1971
- /**
1972
- * @internal
1973
- */
1974
- export const filterSensitiveLog = (obj: ReferenceDataSourceUpdate): any => ({
1975
- ...obj,
1976
- });
1977
- }
1978
-
1979
- /**
1980
- * <p>Describes updates to apply to an existing Amazon Kinesis Analytics application.</p>
1981
- */
1982
- export interface ApplicationUpdate {
1983
- /**
1984
- * <p>Describes application input configuration updates.</p>
1985
- */
1986
- InputUpdates?: InputUpdate[];
1987
-
1988
- /**
1989
- * <p>Describes application code updates.</p>
1990
- */
1991
- ApplicationCodeUpdate?: string;
1992
-
1993
- /**
1994
- * <p>Describes application output configuration updates.</p>
1995
- */
1996
- OutputUpdates?: OutputUpdate[];
1997
-
1998
- /**
1999
- * <p>Describes application reference data source updates.</p>
2000
- */
2001
- ReferenceDataSourceUpdates?: ReferenceDataSourceUpdate[];
2002
-
2003
- /**
2004
- * <p>Describes application CloudWatch logging option updates.</p>
2005
- */
2006
- CloudWatchLoggingOptionUpdates?: CloudWatchLoggingOptionUpdate[];
2007
- }
2008
-
2009
- export namespace ApplicationUpdate {
2010
- /**
2011
- * @internal
2012
- */
2013
- export const filterSensitiveLog = (obj: ApplicationUpdate): any => ({
2014
- ...obj,
2015
- });
2016
- }
2017
-
2018
- /**
2019
- * <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
2020
- * the maximum number of application tags includes system tags. The maximum number of user-defined application tags is 50.
2021
- * For more information, see <a href="https://docs.aws.amazon.com/kinesisanalytics/latest/dev/how-tagging.html">Using Tagging</a>.</p>
2022
- */
2023
- export interface Tag {
2024
- /**
2025
- * <p>The key of the key-value tag.</p>
2026
- */
2027
- Key: string | undefined;
2028
-
2029
- /**
2030
- * <p>The value of the key-value tag. The value is optional.</p>
2031
- */
2032
- Value?: string;
2033
- }
2034
-
2035
- export namespace Tag {
2036
- /**
2037
- * @internal
2038
- */
2039
- export const filterSensitiveLog = (obj: Tag): any => ({
2040
- ...obj,
2041
- });
2042
- }
2043
-
2044
- /**
2045
- * <p>TBD</p>
2046
- */
2047
- export interface CreateApplicationRequest {
2048
- /**
2049
- * <p>Name of your Amazon Kinesis Analytics application (for example, <code>sample-app</code>).</p>
2050
- */
2051
- ApplicationName: string | undefined;
2052
-
2053
- /**
2054
- * <p>Summary description of the application.</p>
2055
- */
2056
- ApplicationDescription?: string;
2057
-
2058
- /**
2059
- * <p>Use this parameter to configure the application input.</p>
2060
- * <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>
2061
- * <p>For the streaming source, you provide its Amazon Resource Name (ARN) and format of
2062
- * data on the stream (for example, JSON, CSV, etc.). You also must provide an IAM role
2063
- * that Amazon Kinesis Analytics can assume to read this stream on your behalf.</p>
2064
- * <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>
2065
- */
2066
- Inputs?: Input[];
2067
-
2068
- /**
2069
- * <p>You can configure application output to write data from any of the in-application streams to up to three destinations.</p>
2070
- * <p>These destinations can be Amazon Kinesis streams, Amazon Kinesis Firehose delivery
2071
- * streams, AWS Lambda destinations, or any combination of the three.</p>
2072
- * <p>In the configuration, you specify the in-application stream name, the destination stream or Lambda function Amazon Resource Name (ARN), and the format to use when writing data. You must also provide an IAM role that Amazon Kinesis Analytics can assume to write to the
2073
- * destination stream or Lambda function on your behalf.</p>
2074
- * <p>In the output configuration, you also provide the output stream or Lambda function ARN. For stream destinations, you provide the format
2075
- * of data in the stream (for example, JSON, CSV). You also must provide an IAM role that
2076
- * Amazon Kinesis Analytics can assume to write to the stream or Lambda function on your behalf.</p>
2077
- */
2078
- Outputs?: Output[];
2079
-
2080
- /**
2081
- * <p>Use this parameter to configure a CloudWatch log stream to monitor application
2082
- * configuration errors. For more information, see <a href="https://docs.aws.amazon.com/kinesisanalytics/latest/dev/cloudwatch-logs.html">Working with Amazon
2083
- * CloudWatch Logs</a>.</p>
2084
- */
2085
- CloudWatchLoggingOptions?: CloudWatchLoggingOption[];
2086
-
2087
- /**
2088
- * <p>One or more SQL statements that read input data, transform it, and generate output.
2089
- * For example, you can write a SQL statement that reads data from one in-application
2090
- * stream, generates a running average of the number of advertisement clicks by vendor, and
2091
- * insert resulting rows in another in-application stream using pumps. For more information
2092
- * about the typical pattern, see <a href="https://docs.aws.amazon.com/kinesisanalytics/latest/dev/how-it-works-app-code.html">Application
2093
- * Code</a>. </p>
2094
- *
2095
- * <p>You can provide such series of SQL statements,
2096
- * where output of one statement can be
2097
- * used as the input for the next statement. You store
2098
- * intermediate results by creating in-application streams and pumps.</p>
2099
- *
2100
- * <p>Note that the application code must create the streams with names
2101
- * specified in the <code>Outputs</code>. For example,
2102
- * if your <code>Outputs</code> defines output streams named
2103
- * <code>ExampleOutputStream1</code> and <code>ExampleOutputStream2</code>,
2104
- * then your application code must create these streams. </p>
2105
- */
2106
- ApplicationCode?: string;
2107
-
2108
- /**
2109
- * <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.
2110
- * For more information, see <a href="https://docs.aws.amazon.com/kinesisanalytics/latest/dev/how-tagging.html">Using Tagging</a>.</p>
2111
- */
2112
- Tags?: Tag[];
2113
- }
2114
-
2115
- export namespace CreateApplicationRequest {
2116
- /**
2117
- * @internal
2118
- */
2119
- export const filterSensitiveLog = (obj: CreateApplicationRequest): any => ({
2120
- ...obj,
2121
- });
2122
- }
2123
-
2124
- /**
2125
- * <p>TBD</p>
2126
- */
2127
- export interface CreateApplicationResponse {
2128
- /**
2129
- * <p>In response to your <code>CreateApplication</code> request, Amazon Kinesis Analytics returns a
2130
- * response with a summary of the application it created, including the application Amazon Resource Name (ARN),
2131
- * name, and status.</p>
2132
- */
2133
- ApplicationSummary: ApplicationSummary | undefined;
2134
- }
2135
-
2136
- export namespace CreateApplicationResponse {
2137
- /**
2138
- * @internal
2139
- */
2140
- export const filterSensitiveLog = (obj: CreateApplicationResponse): any => ({
2141
- ...obj,
2142
- });
2143
- }
2144
-
2145
- /**
2146
- * <p>Exceeded the number of applications allowed.</p>
2147
- */
2148
- export interface LimitExceededException extends __SmithyException, $MetadataBearer {
2149
- name: "LimitExceededException";
2150
- $fault: "client";
2151
- /**
2152
- * <p></p>
2153
- */
2154
- message?: string;
2155
- }
2156
-
2157
- export namespace LimitExceededException {
2158
- /**
2159
- * @internal
2160
- */
2161
- export const filterSensitiveLog = (obj: LimitExceededException): any => ({
2162
- ...obj,
2163
- });
2164
- }
2165
-
2166
- /**
2167
- * <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>
2168
- */
2169
- export interface TooManyTagsException extends __SmithyException, $MetadataBearer {
2170
- name: "TooManyTagsException";
2171
- $fault: "client";
2172
- message?: string;
2173
- }
2174
-
2175
- export namespace TooManyTagsException {
2176
- /**
2177
- * @internal
2178
- */
2179
- export const filterSensitiveLog = (obj: TooManyTagsException): any => ({
2180
- ...obj,
2181
- });
2182
- }
2183
-
2184
- /**
2185
- * <p></p>
2186
- */
2187
- export interface DeleteApplicationRequest {
2188
- /**
2189
- * <p>Name of the Amazon Kinesis Analytics application to delete.</p>
2190
- */
2191
- ApplicationName: string | undefined;
2192
-
2193
- /**
2194
- * <p>
2195
- * You can use the <code>DescribeApplication</code> operation to get this value.
2196
- * </p>
2197
- */
2198
- CreateTimestamp: Date | undefined;
2199
- }
2200
-
2201
- export namespace DeleteApplicationRequest {
2202
- /**
2203
- * @internal
2204
- */
2205
- export const filterSensitiveLog = (obj: DeleteApplicationRequest): any => ({
2206
- ...obj,
2207
- });
2208
- }
2209
-
2210
- /**
2211
- * <p></p>
2212
- */
2213
- export interface DeleteApplicationResponse {}
2214
-
2215
- export namespace DeleteApplicationResponse {
2216
- /**
2217
- * @internal
2218
- */
2219
- export const filterSensitiveLog = (obj: DeleteApplicationResponse): any => ({
2220
- ...obj,
2221
- });
2222
- }
2223
-
2224
- export interface DeleteApplicationCloudWatchLoggingOptionRequest {
2225
- /**
2226
- * <p>The Kinesis Analytics application name.</p>
2227
- */
2228
- ApplicationName: string | undefined;
2229
-
2230
- /**
2231
- * <p>The version ID of the Kinesis Analytics application.</p>
2232
- */
2233
- CurrentApplicationVersionId: number | undefined;
2234
-
2235
- /**
2236
- * <p>The <code>CloudWatchLoggingOptionId</code> of the CloudWatch logging option to
2237
- * 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>
2238
- */
2239
- CloudWatchLoggingOptionId: string | undefined;
2240
- }
2241
-
2242
- export namespace DeleteApplicationCloudWatchLoggingOptionRequest {
2243
- /**
2244
- * @internal
2245
- */
2246
- export const filterSensitiveLog = (obj: DeleteApplicationCloudWatchLoggingOptionRequest): any => ({
2247
- ...obj,
2248
- });
2249
- }
2250
-
2251
- export interface DeleteApplicationCloudWatchLoggingOptionResponse {}
2252
-
2253
- export namespace DeleteApplicationCloudWatchLoggingOptionResponse {
2254
- /**
2255
- * @internal
2256
- */
2257
- export const filterSensitiveLog = (obj: DeleteApplicationCloudWatchLoggingOptionResponse): any => ({
2258
- ...obj,
2259
- });
2260
- }
2261
-
2262
- export interface DeleteApplicationInputProcessingConfigurationRequest {
2263
- /**
2264
- * <p>The Kinesis Analytics application name.</p>
2265
- */
2266
- ApplicationName: string | undefined;
2267
-
2268
- /**
2269
- * <p>The version ID of the Kinesis Analytics application.</p>
2270
- */
2271
- CurrentApplicationVersionId: number | undefined;
2272
-
2273
- /**
2274
- * <p>The ID of the input configuration from which to delete the input processing
2275
- * 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>
2276
- */
2277
- InputId: string | undefined;
2278
- }
2279
-
2280
- export namespace DeleteApplicationInputProcessingConfigurationRequest {
2281
- /**
2282
- * @internal
2283
- */
2284
- export const filterSensitiveLog = (obj: DeleteApplicationInputProcessingConfigurationRequest): any => ({
2285
- ...obj,
2286
- });
2287
- }
2288
-
2289
- export interface DeleteApplicationInputProcessingConfigurationResponse {}
2290
-
2291
- export namespace DeleteApplicationInputProcessingConfigurationResponse {
2292
- /**
2293
- * @internal
2294
- */
2295
- export const filterSensitiveLog = (obj: DeleteApplicationInputProcessingConfigurationResponse): any => ({
2296
- ...obj,
2297
- });
2298
- }
2299
-
2300
- /**
2301
- * <p></p>
2302
- */
2303
- export interface DeleteApplicationOutputRequest {
2304
- /**
2305
- * <p>Amazon Kinesis Analytics application name.</p>
2306
- */
2307
- ApplicationName: string | undefined;
2308
-
2309
- /**
2310
- * <p>Amazon Kinesis Analytics application version.
2311
- * 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.
2312
- * If the version specified is not the current version, the
2313
- * <code>ConcurrentModificationException</code> is returned.
2314
- * </p>
2315
- */
2316
- CurrentApplicationVersionId: number | undefined;
2317
-
2318
- /**
2319
- * <p>The ID of the configuration to delete.
2320
- * Each output configuration that is added to the application, either when the application is
2321
- * 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.
2322
- * You need to provide the ID to uniquely identify the output configuration that you want to
2323
- * delete from the application configuration.
2324
- * You can use the <a href="https://docs.aws.amazon.com/kinesisanalytics/latest/dev/API_DescribeApplication.html">DescribeApplication</a> operation to get the specific
2325
- * <code>OutputId</code>.
2326
- * </p>
2327
- */
2328
- OutputId: string | undefined;
2329
- }
2330
-
2331
- export namespace DeleteApplicationOutputRequest {
2332
- /**
2333
- * @internal
2334
- */
2335
- export const filterSensitiveLog = (obj: DeleteApplicationOutputRequest): any => ({
2336
- ...obj,
2337
- });
2338
- }
2339
-
2340
- /**
2341
- * <p></p>
2342
- */
2343
- export interface DeleteApplicationOutputResponse {}
2344
-
2345
- export namespace DeleteApplicationOutputResponse {
2346
- /**
2347
- * @internal
2348
- */
2349
- export const filterSensitiveLog = (obj: DeleteApplicationOutputResponse): any => ({
2350
- ...obj,
2351
- });
2352
- }
2353
-
2354
- export interface DeleteApplicationReferenceDataSourceRequest {
2355
- /**
2356
- * <p>Name of an existing application.</p>
2357
- */
2358
- ApplicationName: string | undefined;
2359
-
2360
- /**
2361
- * <p>Version of the application.
2362
- * 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.
2363
- * If the version specified
2364
- * is not the current version, the <code>ConcurrentModificationException</code> is returned.</p>
2365
- */
2366
- CurrentApplicationVersionId: number | undefined;
2367
-
2368
- /**
2369
- * <p>ID of the reference data source. When you add a reference data source to your
2370
- * application using the
2371
- * <a href="https://docs.aws.amazon.com/kinesisanalytics/latest/dev/API_AddApplicationReferenceDataSource.html">AddApplicationReferenceDataSource</a>, Amazon Kinesis Analytics assigns an ID.
2372
- * 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.
2373
- * </p>
2374
- */
2375
- ReferenceId: string | undefined;
2376
- }
2377
-
2378
- export namespace DeleteApplicationReferenceDataSourceRequest {
2379
- /**
2380
- * @internal
2381
- */
2382
- export const filterSensitiveLog = (obj: DeleteApplicationReferenceDataSourceRequest): any => ({
2383
- ...obj,
2384
- });
2385
- }
2386
-
2387
- export interface DeleteApplicationReferenceDataSourceResponse {}
2388
-
2389
- export namespace DeleteApplicationReferenceDataSourceResponse {
2390
- /**
2391
- * @internal
2392
- */
2393
- export const filterSensitiveLog = (obj: DeleteApplicationReferenceDataSourceResponse): any => ({
2394
- ...obj,
2395
- });
2396
- }
2397
-
2398
- /**
2399
- * <p></p>
2400
- */
2401
- export interface DescribeApplicationRequest {
2402
- /**
2403
- * <p>Name of the application.</p>
2404
- */
2405
- ApplicationName: string | undefined;
2406
- }
2407
-
2408
- export namespace DescribeApplicationRequest {
2409
- /**
2410
- * @internal
2411
- */
2412
- export const filterSensitiveLog = (obj: DescribeApplicationRequest): any => ({
2413
- ...obj,
2414
- });
2415
- }
2416
-
2417
- /**
2418
- * <p></p>
2419
- */
2420
- export interface DescribeApplicationResponse {
2421
- /**
2422
- * <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>
2423
- */
2424
- ApplicationDetail: ApplicationDetail | undefined;
2425
- }
2426
-
2427
- export namespace DescribeApplicationResponse {
2428
- /**
2429
- * @internal
2430
- */
2431
- export const filterSensitiveLog = (obj: DescribeApplicationResponse): any => ({
2432
- ...obj,
2433
- });
2434
- }
2435
-
2436
- /**
2437
- * <p>Provides a description of an Amazon S3 data source, including the Amazon Resource
2438
- * Name (ARN) of the S3 bucket, the ARN of the IAM role that is used to access the bucket,
2439
- * and the name of the Amazon S3 object that contains the data.</p>
2440
- */
2441
- export interface S3Configuration {
2442
- /**
2443
- * <p>IAM ARN of the role used to access the data.</p>
2444
- */
2445
- RoleARN: string | undefined;
2446
-
2447
- /**
2448
- * <p>ARN of the S3 bucket that contains the data.</p>
2449
- */
2450
- BucketARN: string | undefined;
2451
-
2452
- /**
2453
- * <p>The name of the object that contains the data.</p>
2454
- */
2455
- FileKey: string | undefined;
2456
- }
2457
-
2458
- export namespace S3Configuration {
2459
- /**
2460
- * @internal
2461
- */
2462
- export const filterSensitiveLog = (obj: S3Configuration): any => ({
2463
- ...obj,
2464
- });
2465
- }
2466
-
2467
- export interface DiscoverInputSchemaRequest {
2468
- /**
2469
- * <p>Amazon Resource Name (ARN) of the streaming source.</p>
2470
- */
2471
- ResourceARN?: string;
2472
-
2473
- /**
2474
- * <p>ARN of the IAM role that Amazon Kinesis Analytics can assume to access the stream on your behalf.</p>
2475
- */
2476
- RoleARN?: string;
2477
-
2478
- /**
2479
- * <p>Point at which you want Amazon Kinesis Analytics to start reading records from the specified streaming source discovery purposes.</p>
2480
- */
2481
- InputStartingPositionConfiguration?: InputStartingPositionConfiguration;
2482
-
2483
- /**
2484
- * <p>Specify this parameter to discover a schema from data in an Amazon S3
2485
- * object.</p>
2486
- */
2487
- S3Configuration?: S3Configuration;
2488
-
2489
- /**
2490
- * <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>
2491
- */
2492
- InputProcessingConfiguration?: InputProcessingConfiguration;
2493
- }
2494
-
2495
- export namespace DiscoverInputSchemaRequest {
2496
- /**
2497
- * @internal
2498
- */
2499
- export const filterSensitiveLog = (obj: DiscoverInputSchemaRequest): any => ({
2500
- ...obj,
2501
- });
2502
- }
2503
-
2504
- /**
2505
- * <p></p>
2506
- */
2507
- export interface DiscoverInputSchemaResponse {
2508
- /**
2509
- * <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>
2510
- */
2511
- InputSchema?: SourceSchema;
2512
-
2513
- /**
2514
- * <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>
2515
- */
2516
- ParsedInputRecords?: string[][];
2517
-
2518
- /**
2519
- * <p>Stream data that was modified by the processor specified in the <code>InputProcessingConfiguration</code> parameter.</p>
2520
- */
2521
- ProcessedInputRecords?: string[];
2522
-
2523
- /**
2524
- * <p>Raw stream data that was sampled to infer the schema.</p>
2525
- */
2526
- RawInputRecords?: string[];
2527
- }
2528
-
2529
- export namespace DiscoverInputSchemaResponse {
2530
- /**
2531
- * @internal
2532
- */
2533
- export const filterSensitiveLog = (obj: DiscoverInputSchemaResponse): any => ({
2534
- ...obj,
2535
- });
2536
- }
2537
-
2538
- /**
2539
- * <p>Discovery failed to get a record from the
2540
- * streaming source because of the Amazon Kinesis Streams
2541
- * ProvisionedThroughputExceededException. For more information,
2542
- * see <a href="https://docs.aws.amazon.com/kinesis/latest/APIReference/API_GetRecords.html">GetRecords</a>
2543
- * in the Amazon Kinesis Streams API Reference.</p>
2544
- */
2545
- export interface ResourceProvisionedThroughputExceededException extends __SmithyException, $MetadataBearer {
2546
- name: "ResourceProvisionedThroughputExceededException";
2547
- $fault: "client";
2548
- message?: string;
2549
- }
2550
-
2551
- export namespace ResourceProvisionedThroughputExceededException {
2552
- /**
2553
- * @internal
2554
- */
2555
- export const filterSensitiveLog = (obj: ResourceProvisionedThroughputExceededException): any => ({
2556
- ...obj,
2557
- });
2558
- }
2559
-
2560
- /**
2561
- * <p>The service is unavailable. Back off and retry the operation. </p>
2562
- */
2563
- export interface ServiceUnavailableException extends __SmithyException, $MetadataBearer {
2564
- name: "ServiceUnavailableException";
2565
- $fault: "server";
2566
- message?: string;
2567
- }
2568
-
2569
- export namespace ServiceUnavailableException {
2570
- /**
2571
- * @internal
2572
- */
2573
- export const filterSensitiveLog = (obj: ServiceUnavailableException): any => ({
2574
- ...obj,
2575
- });
2576
- }
2577
-
2578
- /**
2579
- * <p>Data format is not valid. Amazon Kinesis Analytics is not able to detect schema for
2580
- * the given streaming source.</p>
2581
- */
2582
- export interface UnableToDetectSchemaException extends __SmithyException, $MetadataBearer {
2583
- name: "UnableToDetectSchemaException";
2584
- $fault: "client";
2585
- message?: string;
2586
- RawInputRecords?: string[];
2587
- ProcessedInputRecords?: string[];
2588
- }
2589
-
2590
- export namespace UnableToDetectSchemaException {
2591
- /**
2592
- * @internal
2593
- */
2594
- export const filterSensitiveLog = (obj: UnableToDetectSchemaException): any => ({
2595
- ...obj,
2596
- });
2597
- }
2598
-
2599
- /**
2600
- * <p>When you start your application,
2601
- * you provide this configuration, which identifies the input source and the point
2602
- * in the input source at which you want the application to start processing records.</p>
2603
- */
2604
- export interface InputConfiguration {
2605
- /**
2606
- * <p>Input source ID. You can get this ID by calling
2607
- * the <a href="https://docs.aws.amazon.com/kinesisanalytics/latest/dev/API_DescribeApplication.html">DescribeApplication</a> operation.</p>
2608
- */
2609
- Id: string | undefined;
2610
-
2611
- /**
2612
- * <p>Point at which you want the application to start processing
2613
- * records from the streaming source.</p>
2614
- */
2615
- InputStartingPositionConfiguration: InputStartingPositionConfiguration | undefined;
2616
- }
2617
-
2618
- export namespace InputConfiguration {
2619
- /**
2620
- * @internal
2621
- */
2622
- export const filterSensitiveLog = (obj: InputConfiguration): any => ({
2623
- ...obj,
2624
- });
2625
- }
2626
-
2627
- /**
2628
- * <p>User-provided application configuration is not valid.</p>
2629
- */
2630
- export interface InvalidApplicationConfigurationException extends __SmithyException, $MetadataBearer {
2631
- name: "InvalidApplicationConfigurationException";
2632
- $fault: "client";
2633
- /**
2634
- * <p>test</p>
2635
- */
2636
- message?: string;
2637
- }
2638
-
2639
- export namespace InvalidApplicationConfigurationException {
2640
- /**
2641
- * @internal
2642
- */
2643
- export const filterSensitiveLog = (obj: InvalidApplicationConfigurationException): any => ({
2644
- ...obj,
2645
- });
2646
- }
2647
-
2648
- /**
2649
- * <p></p>
2650
- */
2651
- export interface ListApplicationsRequest {
2652
- /**
2653
- * <p>Maximum number of applications to list.</p>
2654
- */
2655
- Limit?: number;
2656
-
2657
- /**
2658
- * <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>
2659
- */
2660
- ExclusiveStartApplicationName?: string;
2661
- }
2662
-
2663
- export namespace ListApplicationsRequest {
2664
- /**
2665
- * @internal
2666
- */
2667
- export const filterSensitiveLog = (obj: ListApplicationsRequest): any => ({
2668
- ...obj,
2669
- });
2670
- }
2671
-
2672
- /**
2673
- * <p></p>
2674
- */
2675
- export interface ListApplicationsResponse {
2676
- /**
2677
- * <p>List of <code>ApplicationSummary</code> objects. </p>
2678
- */
2679
- ApplicationSummaries: ApplicationSummary[] | undefined;
2680
-
2681
- /**
2682
- * <p>Returns true if there are more applications to retrieve.</p>
2683
- */
2684
- HasMoreApplications: boolean | undefined;
2685
- }
2686
-
2687
- export namespace ListApplicationsResponse {
2688
- /**
2689
- * @internal
2690
- */
2691
- export const filterSensitiveLog = (obj: ListApplicationsResponse): any => ({
2692
- ...obj,
2693
- });
2694
- }
2695
-
2696
- export interface ListTagsForResourceRequest {
2697
- /**
2698
- * <p>The ARN of the application for which to retrieve tags.</p>
2699
- */
2700
- ResourceARN: string | undefined;
2701
- }
2702
-
2703
- export namespace ListTagsForResourceRequest {
2704
- /**
2705
- * @internal
2706
- */
2707
- export const filterSensitiveLog = (obj: ListTagsForResourceRequest): any => ({
2708
- ...obj,
2709
- });
2710
- }
2711
-
2712
- export interface ListTagsForResourceResponse {
2713
- /**
2714
- * <p>The key-value tags assigned to the application.</p>
2715
- */
2716
- Tags?: Tag[];
2717
- }
2718
-
2719
- export namespace ListTagsForResourceResponse {
2720
- /**
2721
- * @internal
2722
- */
2723
- export const filterSensitiveLog = (obj: ListTagsForResourceResponse): any => ({
2724
- ...obj,
2725
- });
2726
- }
2727
-
2728
- /**
2729
- * <p></p>
2730
- */
2731
- export interface StartApplicationRequest {
2732
- /**
2733
- * <p>Name of the application.</p>
2734
- */
2735
- ApplicationName: string | undefined;
2736
-
2737
- /**
2738
- * <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>
2739
- */
2740
- InputConfigurations: InputConfiguration[] | undefined;
2741
- }
2742
-
2743
- export namespace StartApplicationRequest {
2744
- /**
2745
- * @internal
2746
- */
2747
- export const filterSensitiveLog = (obj: StartApplicationRequest): any => ({
2748
- ...obj,
2749
- });
2750
- }
2751
-
2752
- /**
2753
- * <p></p>
2754
- */
2755
- export interface StartApplicationResponse {}
2756
-
2757
- export namespace StartApplicationResponse {
2758
- /**
2759
- * @internal
2760
- */
2761
- export const filterSensitiveLog = (obj: StartApplicationResponse): any => ({
2762
- ...obj,
2763
- });
2764
- }
2765
-
2766
- /**
2767
- * <p></p>
2768
- */
2769
- export interface StopApplicationRequest {
2770
- /**
2771
- * <p>Name of the running application to stop.</p>
2772
- */
2773
- ApplicationName: string | undefined;
2774
- }
2775
-
2776
- export namespace StopApplicationRequest {
2777
- /**
2778
- * @internal
2779
- */
2780
- export const filterSensitiveLog = (obj: StopApplicationRequest): any => ({
2781
- ...obj,
2782
- });
2783
- }
2784
-
2785
- /**
2786
- * <p></p>
2787
- */
2788
- export interface StopApplicationResponse {}
2789
-
2790
- export namespace StopApplicationResponse {
2791
- /**
2792
- * @internal
2793
- */
2794
- export const filterSensitiveLog = (obj: StopApplicationResponse): any => ({
2795
- ...obj,
2796
- });
2797
- }
2798
-
2799
- export interface TagResourceRequest {
2800
- /**
2801
- * <p>The ARN of the application to assign the tags.</p>
2802
- */
2803
- ResourceARN: string | undefined;
2804
-
2805
- /**
2806
- * <p>The key-value tags to assign to the application.</p>
2807
- */
2808
- Tags: Tag[] | undefined;
2809
- }
2810
-
2811
- export namespace TagResourceRequest {
2812
- /**
2813
- * @internal
2814
- */
2815
- export const filterSensitiveLog = (obj: TagResourceRequest): any => ({
2816
- ...obj,
2817
- });
2818
- }
2819
-
2820
- export interface TagResourceResponse {}
2821
-
2822
- export namespace TagResourceResponse {
2823
- /**
2824
- * @internal
2825
- */
2826
- export const filterSensitiveLog = (obj: TagResourceResponse): any => ({
2827
- ...obj,
2828
- });
2829
- }
2830
-
2831
- export interface UntagResourceRequest {
2832
- /**
2833
- * <p>The ARN of the Kinesis Analytics application from which to remove the tags.</p>
2834
- */
2835
- ResourceARN: string | undefined;
2836
-
2837
- /**
2838
- * <p>A list of keys of tags to remove from the specified application.</p>
2839
- */
2840
- TagKeys: string[] | undefined;
2841
- }
2842
-
2843
- export namespace UntagResourceRequest {
2844
- /**
2845
- * @internal
2846
- */
2847
- export const filterSensitiveLog = (obj: UntagResourceRequest): any => ({
2848
- ...obj,
2849
- });
2850
- }
2851
-
2852
- export interface UntagResourceResponse {}
2853
-
2854
- export namespace UntagResourceResponse {
2855
- /**
2856
- * @internal
2857
- */
2858
- export const filterSensitiveLog = (obj: UntagResourceResponse): any => ({
2859
- ...obj,
2860
- });
2861
- }
2862
-
2863
- export interface UpdateApplicationRequest {
2864
- /**
2865
- * <p>Name of the Amazon Kinesis Analytics application to update.</p>
2866
- */
2867
- ApplicationName: string | undefined;
2868
-
2869
- /**
2870
- * <p>The current application version ID. You can use the
2871
- * <a href="https://docs.aws.amazon.com/kinesisanalytics/latest/dev/API_DescribeApplication.html">DescribeApplication</a> operation to get this value.</p>
2872
- */
2873
- CurrentApplicationVersionId: number | undefined;
2874
-
2875
- /**
2876
- * <p>Describes application updates.</p>
2877
- */
2878
- ApplicationUpdate: ApplicationUpdate | undefined;
2879
- }
2880
-
2881
- export namespace UpdateApplicationRequest {
2882
- /**
2883
- * @internal
2884
- */
2885
- export const filterSensitiveLog = (obj: UpdateApplicationRequest): any => ({
2886
- ...obj,
2887
- });
2888
- }
2889
-
2890
- export interface UpdateApplicationResponse {}
2891
-
2892
- export namespace UpdateApplicationResponse {
2893
- /**
2894
- * @internal
2895
- */
2896
- export const filterSensitiveLog = (obj: UpdateApplicationResponse): any => ({
2897
- ...obj,
2898
- });
2899
- }