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