UNPKG

86.9 kBTypeScriptView Raw
1import {Request} from '../lib/request';
2import {Response} from '../lib/response';
3import {AWSError} from '../lib/error';
4import {Service} from '../lib/service';
5import {ServiceConfigurationOptions} from '../lib/service';
6import {ConfigBase as Config} from '../lib/config';
7interface Blob {}
8declare class KinesisAnalytics extends Service {
9 /**
10 * Constructs a service object. This object has one method for each API operation.
11 */
12 constructor(options?: KinesisAnalytics.Types.ClientConfiguration)
13 config: Config & KinesisAnalytics.Types.ClientConfiguration;
14 /**
15 * 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 Amazon Kinesis Data Analytics API V2 Documentation. Adds a CloudWatch log stream to monitor application configuration errors. For more information about using CloudWatch log streams with Amazon Kinesis Analytics applications, see Working with Amazon CloudWatch Logs.
16 */
17 addApplicationCloudWatchLoggingOption(params: KinesisAnalytics.Types.AddApplicationCloudWatchLoggingOptionRequest, callback?: (err: AWSError, data: KinesisAnalytics.Types.AddApplicationCloudWatchLoggingOptionResponse) => void): Request<KinesisAnalytics.Types.AddApplicationCloudWatchLoggingOptionResponse, AWSError>;
18 /**
19 * 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 Amazon Kinesis Data Analytics API V2 Documentation. Adds a CloudWatch log stream to monitor application configuration errors. For more information about using CloudWatch log streams with Amazon Kinesis Analytics applications, see Working with Amazon CloudWatch Logs.
20 */
21 addApplicationCloudWatchLoggingOption(callback?: (err: AWSError, data: KinesisAnalytics.Types.AddApplicationCloudWatchLoggingOptionResponse) => void): Request<KinesisAnalytics.Types.AddApplicationCloudWatchLoggingOptionResponse, AWSError>;
22 /**
23 * 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 Amazon Kinesis Data Analytics API V2 Documentation. Adds a streaming source to your Amazon Kinesis application. For conceptual information, see Configuring Application Input. You can add a streaming source either when you create an application or you can use this operation to add a streaming source after you create an application. For more information, see CreateApplication. Any configuration update, including adding a streaming source using this operation, results in a new version of the application. You can use the DescribeApplication operation to find the current application version. This operation requires permissions to perform the kinesisanalytics:AddApplicationInput action.
24 */
25 addApplicationInput(params: KinesisAnalytics.Types.AddApplicationInputRequest, callback?: (err: AWSError, data: KinesisAnalytics.Types.AddApplicationInputResponse) => void): Request<KinesisAnalytics.Types.AddApplicationInputResponse, AWSError>;
26 /**
27 * 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 Amazon Kinesis Data Analytics API V2 Documentation. Adds a streaming source to your Amazon Kinesis application. For conceptual information, see Configuring Application Input. You can add a streaming source either when you create an application or you can use this operation to add a streaming source after you create an application. For more information, see CreateApplication. Any configuration update, including adding a streaming source using this operation, results in a new version of the application. You can use the DescribeApplication operation to find the current application version. This operation requires permissions to perform the kinesisanalytics:AddApplicationInput action.
28 */
29 addApplicationInput(callback?: (err: AWSError, data: KinesisAnalytics.Types.AddApplicationInputResponse) => void): Request<KinesisAnalytics.Types.AddApplicationInputResponse, AWSError>;
30 /**
31 * 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 Amazon Kinesis Data Analytics API V2 Documentation. Adds an InputProcessingConfiguration to an application. An input processor preprocesses records on the input stream before the application's SQL code executes. Currently, the only input processor available is AWS Lambda.
32 */
33 addApplicationInputProcessingConfiguration(params: KinesisAnalytics.Types.AddApplicationInputProcessingConfigurationRequest, callback?: (err: AWSError, data: KinesisAnalytics.Types.AddApplicationInputProcessingConfigurationResponse) => void): Request<KinesisAnalytics.Types.AddApplicationInputProcessingConfigurationResponse, AWSError>;
34 /**
35 * 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 Amazon Kinesis Data Analytics API V2 Documentation. Adds an InputProcessingConfiguration to an application. An input processor preprocesses records on the input stream before the application's SQL code executes. Currently, the only input processor available is AWS Lambda.
36 */
37 addApplicationInputProcessingConfiguration(callback?: (err: AWSError, data: KinesisAnalytics.Types.AddApplicationInputProcessingConfigurationResponse) => void): Request<KinesisAnalytics.Types.AddApplicationInputProcessingConfigurationResponse, AWSError>;
38 /**
39 * 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 Amazon Kinesis Data Analytics API V2 Documentation. Adds an external destination to your Amazon Kinesis Analytics application. If you want Amazon Kinesis Analytics to deliver data from an in-application stream within your application to an external destination (such as an Amazon Kinesis stream, an Amazon Kinesis Firehose delivery stream, or an AWS Lambda function), you add the relevant configuration to your application using this operation. You can configure one or more outputs for your application. Each output configuration maps an in-application stream and an external destination. You can use one of the output configurations to deliver data from your in-application error stream to an external destination so that you can analyze the errors. For more information, see Understanding Application Output (Destination). Any configuration update, including adding a streaming source using this operation, results in a new version of the application. You can use the DescribeApplication operation to find the current application version. For the limits on the number of application inputs and outputs you can configure, see Limits. This operation requires permissions to perform the kinesisanalytics:AddApplicationOutput action.
40 */
41 addApplicationOutput(params: KinesisAnalytics.Types.AddApplicationOutputRequest, callback?: (err: AWSError, data: KinesisAnalytics.Types.AddApplicationOutputResponse) => void): Request<KinesisAnalytics.Types.AddApplicationOutputResponse, AWSError>;
42 /**
43 * 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 Amazon Kinesis Data Analytics API V2 Documentation. Adds an external destination to your Amazon Kinesis Analytics application. If you want Amazon Kinesis Analytics to deliver data from an in-application stream within your application to an external destination (such as an Amazon Kinesis stream, an Amazon Kinesis Firehose delivery stream, or an AWS Lambda function), you add the relevant configuration to your application using this operation. You can configure one or more outputs for your application. Each output configuration maps an in-application stream and an external destination. You can use one of the output configurations to deliver data from your in-application error stream to an external destination so that you can analyze the errors. For more information, see Understanding Application Output (Destination). Any configuration update, including adding a streaming source using this operation, results in a new version of the application. You can use the DescribeApplication operation to find the current application version. For the limits on the number of application inputs and outputs you can configure, see Limits. This operation requires permissions to perform the kinesisanalytics:AddApplicationOutput action.
44 */
45 addApplicationOutput(callback?: (err: AWSError, data: KinesisAnalytics.Types.AddApplicationOutputResponse) => void): Request<KinesisAnalytics.Types.AddApplicationOutputResponse, AWSError>;
46 /**
47 * 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 Amazon Kinesis Data Analytics API V2 Documentation. Adds a reference data source to an existing application. Amazon Kinesis Analytics reads reference data (that is, an Amazon S3 object) and creates an in-application table within your application. In the request, you provide the source (S3 bucket name and object key name), name of the in-application table to create, and the necessary mapping information that describes how data in Amazon S3 object maps to columns in the resulting in-application table. For conceptual information, see Configuring Application Input. For the limits on data sources you can add to your application, see Limits. This operation requires permissions to perform the kinesisanalytics:AddApplicationOutput action.
48 */
49 addApplicationReferenceDataSource(params: KinesisAnalytics.Types.AddApplicationReferenceDataSourceRequest, callback?: (err: AWSError, data: KinesisAnalytics.Types.AddApplicationReferenceDataSourceResponse) => void): Request<KinesisAnalytics.Types.AddApplicationReferenceDataSourceResponse, AWSError>;
50 /**
51 * 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 Amazon Kinesis Data Analytics API V2 Documentation. Adds a reference data source to an existing application. Amazon Kinesis Analytics reads reference data (that is, an Amazon S3 object) and creates an in-application table within your application. In the request, you provide the source (S3 bucket name and object key name), name of the in-application table to create, and the necessary mapping information that describes how data in Amazon S3 object maps to columns in the resulting in-application table. For conceptual information, see Configuring Application Input. For the limits on data sources you can add to your application, see Limits. This operation requires permissions to perform the kinesisanalytics:AddApplicationOutput action.
52 */
53 addApplicationReferenceDataSource(callback?: (err: AWSError, data: KinesisAnalytics.Types.AddApplicationReferenceDataSourceResponse) => void): Request<KinesisAnalytics.Types.AddApplicationReferenceDataSourceResponse, AWSError>;
54 /**
55 * 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 Amazon Kinesis Data Analytics API V2 Documentation. Creates an Amazon Kinesis Analytics application. You can configure each application with one streaming source as input, application code to process the input, and up to three destinations where you want Amazon Kinesis Analytics to write the output data from your application. For an overview, see How it Works. In the input configuration, you map the streaming source to an in-application stream, which you can think of as a constantly updating table. In the mapping, you must provide a schema for the in-application stream and map each data column in the in-application stream to a data element in the streaming source. Your application code is one or more SQL statements that read input data, transform it, and generate output. Your application code can create one or more SQL artifacts like SQL streams or pumps. In the output configuration, you can configure the application to write data from in-application streams created in your applications to up to three destinations. To read data from your source stream or write data to destination streams, Amazon Kinesis Analytics needs your permissions. You grant these permissions by creating IAM roles. This operation requires permissions to perform the kinesisanalytics:CreateApplication action. For introductory exercises to create an Amazon Kinesis Analytics application, see Getting Started.
56 */
57 createApplication(params: KinesisAnalytics.Types.CreateApplicationRequest, callback?: (err: AWSError, data: KinesisAnalytics.Types.CreateApplicationResponse) => void): Request<KinesisAnalytics.Types.CreateApplicationResponse, AWSError>;
58 /**
59 * 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 Amazon Kinesis Data Analytics API V2 Documentation. Creates an Amazon Kinesis Analytics application. You can configure each application with one streaming source as input, application code to process the input, and up to three destinations where you want Amazon Kinesis Analytics to write the output data from your application. For an overview, see How it Works. In the input configuration, you map the streaming source to an in-application stream, which you can think of as a constantly updating table. In the mapping, you must provide a schema for the in-application stream and map each data column in the in-application stream to a data element in the streaming source. Your application code is one or more SQL statements that read input data, transform it, and generate output. Your application code can create one or more SQL artifacts like SQL streams or pumps. In the output configuration, you can configure the application to write data from in-application streams created in your applications to up to three destinations. To read data from your source stream or write data to destination streams, Amazon Kinesis Analytics needs your permissions. You grant these permissions by creating IAM roles. This operation requires permissions to perform the kinesisanalytics:CreateApplication action. For introductory exercises to create an Amazon Kinesis Analytics application, see Getting Started.
60 */
61 createApplication(callback?: (err: AWSError, data: KinesisAnalytics.Types.CreateApplicationResponse) => void): Request<KinesisAnalytics.Types.CreateApplicationResponse, AWSError>;
62 /**
63 * 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 Amazon Kinesis Data Analytics API V2 Documentation. Deletes the specified application. Amazon Kinesis Analytics halts application execution and deletes the application, including any application artifacts (such as in-application streams, reference table, and application code). This operation requires permissions to perform the kinesisanalytics:DeleteApplication action.
64 */
65 deleteApplication(params: KinesisAnalytics.Types.DeleteApplicationRequest, callback?: (err: AWSError, data: KinesisAnalytics.Types.DeleteApplicationResponse) => void): Request<KinesisAnalytics.Types.DeleteApplicationResponse, AWSError>;
66 /**
67 * 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 Amazon Kinesis Data Analytics API V2 Documentation. Deletes the specified application. Amazon Kinesis Analytics halts application execution and deletes the application, including any application artifacts (such as in-application streams, reference table, and application code). This operation requires permissions to perform the kinesisanalytics:DeleteApplication action.
68 */
69 deleteApplication(callback?: (err: AWSError, data: KinesisAnalytics.Types.DeleteApplicationResponse) => void): Request<KinesisAnalytics.Types.DeleteApplicationResponse, AWSError>;
70 /**
71 * 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 Amazon Kinesis Data Analytics API V2 Documentation. Deletes a CloudWatch log stream from an application. For more information about using CloudWatch log streams with Amazon Kinesis Analytics applications, see Working with Amazon CloudWatch Logs.
72 */
73 deleteApplicationCloudWatchLoggingOption(params: KinesisAnalytics.Types.DeleteApplicationCloudWatchLoggingOptionRequest, callback?: (err: AWSError, data: KinesisAnalytics.Types.DeleteApplicationCloudWatchLoggingOptionResponse) => void): Request<KinesisAnalytics.Types.DeleteApplicationCloudWatchLoggingOptionResponse, AWSError>;
74 /**
75 * 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 Amazon Kinesis Data Analytics API V2 Documentation. Deletes a CloudWatch log stream from an application. For more information about using CloudWatch log streams with Amazon Kinesis Analytics applications, see Working with Amazon CloudWatch Logs.
76 */
77 deleteApplicationCloudWatchLoggingOption(callback?: (err: AWSError, data: KinesisAnalytics.Types.DeleteApplicationCloudWatchLoggingOptionResponse) => void): Request<KinesisAnalytics.Types.DeleteApplicationCloudWatchLoggingOptionResponse, AWSError>;
78 /**
79 * 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 Amazon Kinesis Data Analytics API V2 Documentation. Deletes an InputProcessingConfiguration from an input.
80 */
81 deleteApplicationInputProcessingConfiguration(params: KinesisAnalytics.Types.DeleteApplicationInputProcessingConfigurationRequest, callback?: (err: AWSError, data: KinesisAnalytics.Types.DeleteApplicationInputProcessingConfigurationResponse) => void): Request<KinesisAnalytics.Types.DeleteApplicationInputProcessingConfigurationResponse, AWSError>;
82 /**
83 * 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 Amazon Kinesis Data Analytics API V2 Documentation. Deletes an InputProcessingConfiguration from an input.
84 */
85 deleteApplicationInputProcessingConfiguration(callback?: (err: AWSError, data: KinesisAnalytics.Types.DeleteApplicationInputProcessingConfigurationResponse) => void): Request<KinesisAnalytics.Types.DeleteApplicationInputProcessingConfigurationResponse, AWSError>;
86 /**
87 * 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 Amazon Kinesis Data Analytics API V2 Documentation. Deletes output destination configuration from your application configuration. Amazon Kinesis Analytics will no longer write data from the corresponding in-application stream to the external output destination. This operation requires permissions to perform the kinesisanalytics:DeleteApplicationOutput action.
88 */
89 deleteApplicationOutput(params: KinesisAnalytics.Types.DeleteApplicationOutputRequest, callback?: (err: AWSError, data: KinesisAnalytics.Types.DeleteApplicationOutputResponse) => void): Request<KinesisAnalytics.Types.DeleteApplicationOutputResponse, AWSError>;
90 /**
91 * 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 Amazon Kinesis Data Analytics API V2 Documentation. Deletes output destination configuration from your application configuration. Amazon Kinesis Analytics will no longer write data from the corresponding in-application stream to the external output destination. This operation requires permissions to perform the kinesisanalytics:DeleteApplicationOutput action.
92 */
93 deleteApplicationOutput(callback?: (err: AWSError, data: KinesisAnalytics.Types.DeleteApplicationOutputResponse) => void): Request<KinesisAnalytics.Types.DeleteApplicationOutputResponse, AWSError>;
94 /**
95 * 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 Amazon Kinesis Data Analytics API V2 Documentation. Deletes a reference data source configuration from the specified application configuration. If the application is running, Amazon Kinesis Analytics immediately removes the in-application table that you created using the AddApplicationReferenceDataSource operation. This operation requires permissions to perform the kinesisanalytics.DeleteApplicationReferenceDataSource action.
96 */
97 deleteApplicationReferenceDataSource(params: KinesisAnalytics.Types.DeleteApplicationReferenceDataSourceRequest, callback?: (err: AWSError, data: KinesisAnalytics.Types.DeleteApplicationReferenceDataSourceResponse) => void): Request<KinesisAnalytics.Types.DeleteApplicationReferenceDataSourceResponse, AWSError>;
98 /**
99 * 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 Amazon Kinesis Data Analytics API V2 Documentation. Deletes a reference data source configuration from the specified application configuration. If the application is running, Amazon Kinesis Analytics immediately removes the in-application table that you created using the AddApplicationReferenceDataSource operation. This operation requires permissions to perform the kinesisanalytics.DeleteApplicationReferenceDataSource action.
100 */
101 deleteApplicationReferenceDataSource(callback?: (err: AWSError, data: KinesisAnalytics.Types.DeleteApplicationReferenceDataSourceResponse) => void): Request<KinesisAnalytics.Types.DeleteApplicationReferenceDataSourceResponse, AWSError>;
102 /**
103 * 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 Amazon Kinesis Data Analytics API V2 Documentation. Returns information about a specific Amazon Kinesis Analytics application. If you want to retrieve a list of all applications in your account, use the ListApplications operation. This operation requires permissions to perform the kinesisanalytics:DescribeApplication action. You can use DescribeApplication to get the current application versionId, which you need to call other operations such as Update.
104 */
105 describeApplication(params: KinesisAnalytics.Types.DescribeApplicationRequest, callback?: (err: AWSError, data: KinesisAnalytics.Types.DescribeApplicationResponse) => void): Request<KinesisAnalytics.Types.DescribeApplicationResponse, AWSError>;
106 /**
107 * 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 Amazon Kinesis Data Analytics API V2 Documentation. Returns information about a specific Amazon Kinesis Analytics application. If you want to retrieve a list of all applications in your account, use the ListApplications operation. This operation requires permissions to perform the kinesisanalytics:DescribeApplication action. You can use DescribeApplication to get the current application versionId, which you need to call other operations such as Update.
108 */
109 describeApplication(callback?: (err: AWSError, data: KinesisAnalytics.Types.DescribeApplicationResponse) => void): Request<KinesisAnalytics.Types.DescribeApplicationResponse, AWSError>;
110 /**
111 * 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 Amazon Kinesis Data Analytics API V2 Documentation. Infers a schema by evaluating sample records on the specified streaming source (Amazon Kinesis stream or Amazon Kinesis Firehose delivery stream) or S3 object. In the response, the operation returns the inferred schema and also the sample records that the operation used to infer the schema. You can use the inferred schema when configuring a streaming source for your application. For conceptual information, see Configuring Application Input. Note that when you create an application using the Amazon Kinesis Analytics console, the console uses this operation to infer a schema and show it in the console user interface. This operation requires permissions to perform the kinesisanalytics:DiscoverInputSchema action.
112 */
113 discoverInputSchema(params: KinesisAnalytics.Types.DiscoverInputSchemaRequest, callback?: (err: AWSError, data: KinesisAnalytics.Types.DiscoverInputSchemaResponse) => void): Request<KinesisAnalytics.Types.DiscoverInputSchemaResponse, AWSError>;
114 /**
115 * 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 Amazon Kinesis Data Analytics API V2 Documentation. Infers a schema by evaluating sample records on the specified streaming source (Amazon Kinesis stream or Amazon Kinesis Firehose delivery stream) or S3 object. In the response, the operation returns the inferred schema and also the sample records that the operation used to infer the schema. You can use the inferred schema when configuring a streaming source for your application. For conceptual information, see Configuring Application Input. Note that when you create an application using the Amazon Kinesis Analytics console, the console uses this operation to infer a schema and show it in the console user interface. This operation requires permissions to perform the kinesisanalytics:DiscoverInputSchema action.
116 */
117 discoverInputSchema(callback?: (err: AWSError, data: KinesisAnalytics.Types.DiscoverInputSchemaResponse) => void): Request<KinesisAnalytics.Types.DiscoverInputSchemaResponse, AWSError>;
118 /**
119 * 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 Amazon Kinesis Data Analytics API V2 Documentation. Returns a list of Amazon Kinesis Analytics applications in your account. For each application, the response includes the application name, Amazon Resource Name (ARN), and status. If the response returns the HasMoreApplications value as true, you can send another request by adding the ExclusiveStartApplicationName in the request body, and set the value of this to the last application name from the previous response. If you want detailed information about a specific application, use DescribeApplication. This operation requires permissions to perform the kinesisanalytics:ListApplications action.
120 */
121 listApplications(params: KinesisAnalytics.Types.ListApplicationsRequest, callback?: (err: AWSError, data: KinesisAnalytics.Types.ListApplicationsResponse) => void): Request<KinesisAnalytics.Types.ListApplicationsResponse, AWSError>;
122 /**
123 * 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 Amazon Kinesis Data Analytics API V2 Documentation. Returns a list of Amazon Kinesis Analytics applications in your account. For each application, the response includes the application name, Amazon Resource Name (ARN), and status. If the response returns the HasMoreApplications value as true, you can send another request by adding the ExclusiveStartApplicationName in the request body, and set the value of this to the last application name from the previous response. If you want detailed information about a specific application, use DescribeApplication. This operation requires permissions to perform the kinesisanalytics:ListApplications action.
124 */
125 listApplications(callback?: (err: AWSError, data: KinesisAnalytics.Types.ListApplicationsResponse) => void): Request<KinesisAnalytics.Types.ListApplicationsResponse, AWSError>;
126 /**
127 * Retrieves the list of key-value tags assigned to the application. For more information, see Using Tagging.
128 */
129 listTagsForResource(params: KinesisAnalytics.Types.ListTagsForResourceRequest, callback?: (err: AWSError, data: KinesisAnalytics.Types.ListTagsForResourceResponse) => void): Request<KinesisAnalytics.Types.ListTagsForResourceResponse, AWSError>;
130 /**
131 * Retrieves the list of key-value tags assigned to the application. For more information, see Using Tagging.
132 */
133 listTagsForResource(callback?: (err: AWSError, data: KinesisAnalytics.Types.ListTagsForResourceResponse) => void): Request<KinesisAnalytics.Types.ListTagsForResourceResponse, AWSError>;
134 /**
135 * 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 Amazon Kinesis Data Analytics API V2 Documentation. Starts the specified Amazon Kinesis Analytics application. After creating an application, you must exclusively call this operation to start your application. After the application starts, it begins consuming the input data, processes it, and writes the output to the configured destination. The application status must be READY for you to start an application. You can get the application status in the console or using the DescribeApplication operation. After you start the application, you can stop the application from processing the input by calling the StopApplication operation. This operation requires permissions to perform the kinesisanalytics:StartApplication action.
136 */
137 startApplication(params: KinesisAnalytics.Types.StartApplicationRequest, callback?: (err: AWSError, data: KinesisAnalytics.Types.StartApplicationResponse) => void): Request<KinesisAnalytics.Types.StartApplicationResponse, AWSError>;
138 /**
139 * 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 Amazon Kinesis Data Analytics API V2 Documentation. Starts the specified Amazon Kinesis Analytics application. After creating an application, you must exclusively call this operation to start your application. After the application starts, it begins consuming the input data, processes it, and writes the output to the configured destination. The application status must be READY for you to start an application. You can get the application status in the console or using the DescribeApplication operation. After you start the application, you can stop the application from processing the input by calling the StopApplication operation. This operation requires permissions to perform the kinesisanalytics:StartApplication action.
140 */
141 startApplication(callback?: (err: AWSError, data: KinesisAnalytics.Types.StartApplicationResponse) => void): Request<KinesisAnalytics.Types.StartApplicationResponse, AWSError>;
142 /**
143 * 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 Amazon Kinesis Data Analytics API V2 Documentation. Stops the application from processing input data. You can stop an application only if it is in the running state. You can use the DescribeApplication operation to find the application state. After the application is stopped, Amazon Kinesis Analytics stops reading data from the input, the application stops processing data, and there is no output written to the destination. This operation requires permissions to perform the kinesisanalytics:StopApplication action.
144 */
145 stopApplication(params: KinesisAnalytics.Types.StopApplicationRequest, callback?: (err: AWSError, data: KinesisAnalytics.Types.StopApplicationResponse) => void): Request<KinesisAnalytics.Types.StopApplicationResponse, AWSError>;
146 /**
147 * 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 Amazon Kinesis Data Analytics API V2 Documentation. Stops the application from processing input data. You can stop an application only if it is in the running state. You can use the DescribeApplication operation to find the application state. After the application is stopped, Amazon Kinesis Analytics stops reading data from the input, the application stops processing data, and there is no output written to the destination. This operation requires permissions to perform the kinesisanalytics:StopApplication action.
148 */
149 stopApplication(callback?: (err: AWSError, data: KinesisAnalytics.Types.StopApplicationResponse) => void): Request<KinesisAnalytics.Types.StopApplicationResponse, AWSError>;
150 /**
151 * Adds one or more key-value tags to a Kinesis Analytics application. Note that the maximum number of application tags includes system tags. The maximum number of user-defined application tags is 50. For more information, see Using Tagging.
152 */
153 tagResource(params: KinesisAnalytics.Types.TagResourceRequest, callback?: (err: AWSError, data: KinesisAnalytics.Types.TagResourceResponse) => void): Request<KinesisAnalytics.Types.TagResourceResponse, AWSError>;
154 /**
155 * Adds one or more key-value tags to a Kinesis Analytics application. Note that the maximum number of application tags includes system tags. The maximum number of user-defined application tags is 50. For more information, see Using Tagging.
156 */
157 tagResource(callback?: (err: AWSError, data: KinesisAnalytics.Types.TagResourceResponse) => void): Request<KinesisAnalytics.Types.TagResourceResponse, AWSError>;
158 /**
159 * Removes one or more tags from a Kinesis Analytics application. For more information, see Using Tagging.
160 */
161 untagResource(params: KinesisAnalytics.Types.UntagResourceRequest, callback?: (err: AWSError, data: KinesisAnalytics.Types.UntagResourceResponse) => void): Request<KinesisAnalytics.Types.UntagResourceResponse, AWSError>;
162 /**
163 * Removes one or more tags from a Kinesis Analytics application. For more information, see Using Tagging.
164 */
165 untagResource(callback?: (err: AWSError, data: KinesisAnalytics.Types.UntagResourceResponse) => void): Request<KinesisAnalytics.Types.UntagResourceResponse, AWSError>;
166 /**
167 * 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 Amazon Kinesis Data Analytics API V2 Documentation. Updates an existing Amazon Kinesis Analytics application. Using this API, you can update application code, input configuration, and output configuration. Note that Amazon Kinesis Analytics updates the CurrentApplicationVersionId each time you update your application. This operation requires permission for the kinesisanalytics:UpdateApplication action.
168 */
169 updateApplication(params: KinesisAnalytics.Types.UpdateApplicationRequest, callback?: (err: AWSError, data: KinesisAnalytics.Types.UpdateApplicationResponse) => void): Request<KinesisAnalytics.Types.UpdateApplicationResponse, AWSError>;
170 /**
171 * 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 Amazon Kinesis Data Analytics API V2 Documentation. Updates an existing Amazon Kinesis Analytics application. Using this API, you can update application code, input configuration, and output configuration. Note that Amazon Kinesis Analytics updates the CurrentApplicationVersionId each time you update your application. This operation requires permission for the kinesisanalytics:UpdateApplication action.
172 */
173 updateApplication(callback?: (err: AWSError, data: KinesisAnalytics.Types.UpdateApplicationResponse) => void): Request<KinesisAnalytics.Types.UpdateApplicationResponse, AWSError>;
174}
175declare namespace KinesisAnalytics {
176 export interface AddApplicationCloudWatchLoggingOptionRequest {
177 /**
178 * The Kinesis Analytics application name.
179 */
180 ApplicationName: ApplicationName;
181 /**
182 * The version ID of the Kinesis Analytics application.
183 */
184 CurrentApplicationVersionId: ApplicationVersionId;
185 /**
186 * Provides the CloudWatch log stream Amazon Resource Name (ARN) and the IAM role ARN. Note: To write application messages to CloudWatch, the IAM role that is used must have the PutLogEvents policy action enabled.
187 */
188 CloudWatchLoggingOption: CloudWatchLoggingOption;
189 }
190 export interface AddApplicationCloudWatchLoggingOptionResponse {
191 }
192 export interface AddApplicationInputProcessingConfigurationRequest {
193 /**
194 * Name of the application to which you want to add the input processing configuration.
195 */
196 ApplicationName: ApplicationName;
197 /**
198 * Version of the application to which you want to add the input processing configuration. You can use the DescribeApplication operation to get the current application version. If the version specified is not the current version, the ConcurrentModificationException is returned.
199 */
200 CurrentApplicationVersionId: ApplicationVersionId;
201 /**
202 * The ID of the input configuration to add the input processing configuration to. You can get a list of the input IDs for an application using the DescribeApplication operation.
203 */
204 InputId: Id;
205 /**
206 * The InputProcessingConfiguration to add to the application.
207 */
208 InputProcessingConfiguration: InputProcessingConfiguration;
209 }
210 export interface AddApplicationInputProcessingConfigurationResponse {
211 }
212 export interface AddApplicationInputRequest {
213 /**
214 * Name of your existing Amazon Kinesis Analytics application to which you want to add the streaming source.
215 */
216 ApplicationName: ApplicationName;
217 /**
218 * Current version of your Amazon Kinesis Analytics application. You can use the DescribeApplication operation to find the current application version.
219 */
220 CurrentApplicationVersionId: ApplicationVersionId;
221 /**
222 * The Input to add.
223 */
224 Input: Input;
225 }
226 export interface AddApplicationInputResponse {
227 }
228 export interface AddApplicationOutputRequest {
229 /**
230 * Name of the application to which you want to add the output configuration.
231 */
232 ApplicationName: ApplicationName;
233 /**
234 * Version of the application to which you want to add the output configuration. You can use the DescribeApplication operation to get the current application version. If the version specified is not the current version, the ConcurrentModificationException is returned.
235 */
236 CurrentApplicationVersionId: ApplicationVersionId;
237 /**
238 * An array of objects, each describing one output configuration. In the output configuration, you specify the name of an in-application stream, a destination (that is, an Amazon Kinesis stream, an Amazon Kinesis Firehose delivery stream, or an AWS Lambda function), and record the formation to use when writing to the destination.
239 */
240 Output: Output;
241 }
242 export interface AddApplicationOutputResponse {
243 }
244 export interface AddApplicationReferenceDataSourceRequest {
245 /**
246 * Name of an existing application.
247 */
248 ApplicationName: ApplicationName;
249 /**
250 * Version of the application for which you are adding the reference data source. You can use the DescribeApplication operation to get the current application version. If the version specified is not the current version, the ConcurrentModificationException is returned.
251 */
252 CurrentApplicationVersionId: ApplicationVersionId;
253 /**
254 * 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.
255 */
256 ReferenceDataSource: ReferenceDataSource;
257 }
258 export interface AddApplicationReferenceDataSourceResponse {
259 }
260 export type ApplicationCode = string;
261 export type ApplicationDescription = string;
262 export interface ApplicationDetail {
263 /**
264 * Name of the application.
265 */
266 ApplicationName: ApplicationName;
267 /**
268 * Description of the application.
269 */
270 ApplicationDescription?: ApplicationDescription;
271 /**
272 * ARN of the application.
273 */
274 ApplicationARN: ResourceARN;
275 /**
276 * Status of the application.
277 */
278 ApplicationStatus: ApplicationStatus;
279 /**
280 * Time stamp when the application version was created.
281 */
282 CreateTimestamp?: Timestamp;
283 /**
284 * Time stamp when the application was last updated.
285 */
286 LastUpdateTimestamp?: Timestamp;
287 /**
288 * Describes the application input configuration. For more information, see Configuring Application Input.
289 */
290 InputDescriptions?: InputDescriptions;
291 /**
292 * Describes the application output configuration. For more information, see Configuring Application Output.
293 */
294 OutputDescriptions?: OutputDescriptions;
295 /**
296 * Describes reference data sources configured for the application. For more information, see Configuring Application Input.
297 */
298 ReferenceDataSourceDescriptions?: ReferenceDataSourceDescriptions;
299 /**
300 * Describes the CloudWatch log streams that are configured to receive application messages. For more information about using CloudWatch log streams with Amazon Kinesis Analytics applications, see Working with Amazon CloudWatch Logs.
301 */
302 CloudWatchLoggingOptionDescriptions?: CloudWatchLoggingOptionDescriptions;
303 /**
304 * Returns the application code that you provided to perform data analysis on any of the in-application streams in your application.
305 */
306 ApplicationCode?: ApplicationCode;
307 /**
308 * Provides the current application version.
309 */
310 ApplicationVersionId: ApplicationVersionId;
311 }
312 export type ApplicationName = string;
313 export type ApplicationStatus = "DELETING"|"STARTING"|"STOPPING"|"READY"|"RUNNING"|"UPDATING"|string;
314 export type ApplicationSummaries = ApplicationSummary[];
315 export interface ApplicationSummary {
316 /**
317 * Name of the application.
318 */
319 ApplicationName: ApplicationName;
320 /**
321 * ARN of the application.
322 */
323 ApplicationARN: ResourceARN;
324 /**
325 * Status of the application.
326 */
327 ApplicationStatus: ApplicationStatus;
328 }
329 export interface ApplicationUpdate {
330 /**
331 * Describes application input configuration updates.
332 */
333 InputUpdates?: InputUpdates;
334 /**
335 * Describes application code updates.
336 */
337 ApplicationCodeUpdate?: ApplicationCode;
338 /**
339 * Describes application output configuration updates.
340 */
341 OutputUpdates?: OutputUpdates;
342 /**
343 * Describes application reference data source updates.
344 */
345 ReferenceDataSourceUpdates?: ReferenceDataSourceUpdates;
346 /**
347 * Describes application CloudWatch logging option updates.
348 */
349 CloudWatchLoggingOptionUpdates?: CloudWatchLoggingOptionUpdates;
350 }
351 export type ApplicationVersionId = number;
352 export type BooleanObject = boolean;
353 export type BucketARN = string;
354 export interface CSVMappingParameters {
355 /**
356 * Row delimiter. For example, in a CSV format, '\n' is the typical row delimiter.
357 */
358 RecordRowDelimiter: RecordRowDelimiter;
359 /**
360 * Column delimiter. For example, in a CSV format, a comma (",") is the typical column delimiter.
361 */
362 RecordColumnDelimiter: RecordColumnDelimiter;
363 }
364 export interface CloudWatchLoggingOption {
365 /**
366 * ARN of the CloudWatch log to receive application messages.
367 */
368 LogStreamARN: LogStreamARN;
369 /**
370 * IAM ARN of the role to use to send application messages. Note: To write application messages to CloudWatch, the IAM role that is used must have the PutLogEvents policy action enabled.
371 */
372 RoleARN: RoleARN;
373 }
374 export interface CloudWatchLoggingOptionDescription {
375 /**
376 * ID of the CloudWatch logging option description.
377 */
378 CloudWatchLoggingOptionId?: Id;
379 /**
380 * ARN of the CloudWatch log to receive application messages.
381 */
382 LogStreamARN: LogStreamARN;
383 /**
384 * 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 PutLogEvents policy action enabled.
385 */
386 RoleARN: RoleARN;
387 }
388 export type CloudWatchLoggingOptionDescriptions = CloudWatchLoggingOptionDescription[];
389 export interface CloudWatchLoggingOptionUpdate {
390 /**
391 * ID of the CloudWatch logging option to update
392 */
393 CloudWatchLoggingOptionId: Id;
394 /**
395 * ARN of the CloudWatch log to receive application messages.
396 */
397 LogStreamARNUpdate?: LogStreamARN;
398 /**
399 * 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 PutLogEvents policy action enabled.
400 */
401 RoleARNUpdate?: RoleARN;
402 }
403 export type CloudWatchLoggingOptionUpdates = CloudWatchLoggingOptionUpdate[];
404 export type CloudWatchLoggingOptions = CloudWatchLoggingOption[];
405 export interface CreateApplicationRequest {
406 /**
407 * Name of your Amazon Kinesis Analytics application (for example, sample-app).
408 */
409 ApplicationName: ApplicationName;
410 /**
411 * Summary description of the application.
412 */
413 ApplicationDescription?: ApplicationDescription;
414 /**
415 * Use this parameter to configure the application input. 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). For the streaming source, you provide its Amazon Resource Name (ARN) and format of data on the stream (for example, JSON, CSV, etc.). You also must provide an IAM role that Amazon Kinesis Analytics can assume to read this stream on your behalf. 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.
416 */
417 Inputs?: Inputs;
418 /**
419 * You can configure application output to write data from any of the in-application streams to up to three destinations. These destinations can be Amazon Kinesis streams, Amazon Kinesis Firehose delivery streams, AWS Lambda destinations, or any combination of the three. 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 destination stream or Lambda function on your behalf. In the output configuration, you also provide the output stream or Lambda function ARN. For stream destinations, you provide the format of data in the stream (for example, JSON, CSV). You also must provide an IAM role that Amazon Kinesis Analytics can assume to write to the stream or Lambda function on your behalf.
420 */
421 Outputs?: Outputs;
422 /**
423 * Use this parameter to configure a CloudWatch log stream to monitor application configuration errors. For more information, see Working with Amazon CloudWatch Logs.
424 */
425 CloudWatchLoggingOptions?: CloudWatchLoggingOptions;
426 /**
427 * One or more SQL statements that read input data, transform it, and generate output. For example, you can write a SQL statement that reads data from one in-application stream, generates a running average of the number of advertisement clicks by vendor, and insert resulting rows in another in-application stream using pumps. For more information about the typical pattern, see Application Code. You can provide such series of SQL statements, where output of one statement can be used as the input for the next statement. You store intermediate results by creating in-application streams and pumps. Note that the application code must create the streams with names specified in the Outputs. For example, if your Outputs defines output streams named ExampleOutputStream1 and ExampleOutputStream2, then your application code must create these streams.
428 */
429 ApplicationCode?: ApplicationCode;
430 /**
431 * 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. For more information, see Using Tagging.
432 */
433 Tags?: Tags;
434 }
435 export interface CreateApplicationResponse {
436 /**
437 * In response to your CreateApplication request, Amazon Kinesis Analytics returns a response with a summary of the application it created, including the application Amazon Resource Name (ARN), name, and status.
438 */
439 ApplicationSummary: ApplicationSummary;
440 }
441 export interface DeleteApplicationCloudWatchLoggingOptionRequest {
442 /**
443 * The Kinesis Analytics application name.
444 */
445 ApplicationName: ApplicationName;
446 /**
447 * The version ID of the Kinesis Analytics application.
448 */
449 CurrentApplicationVersionId: ApplicationVersionId;
450 /**
451 * The CloudWatchLoggingOptionId of the CloudWatch logging option to delete. You can get the CloudWatchLoggingOptionId by using the DescribeApplication operation.
452 */
453 CloudWatchLoggingOptionId: Id;
454 }
455 export interface DeleteApplicationCloudWatchLoggingOptionResponse {
456 }
457 export interface DeleteApplicationInputProcessingConfigurationRequest {
458 /**
459 * The Kinesis Analytics application name.
460 */
461 ApplicationName: ApplicationName;
462 /**
463 * The version ID of the Kinesis Analytics application.
464 */
465 CurrentApplicationVersionId: ApplicationVersionId;
466 /**
467 * The ID of the input configuration from which to delete the input processing configuration. You can get a list of the input IDs for an application by using the DescribeApplication operation.
468 */
469 InputId: Id;
470 }
471 export interface DeleteApplicationInputProcessingConfigurationResponse {
472 }
473 export interface DeleteApplicationOutputRequest {
474 /**
475 * Amazon Kinesis Analytics application name.
476 */
477 ApplicationName: ApplicationName;
478 /**
479 * Amazon Kinesis Analytics application version. You can use the DescribeApplication operation to get the current application version. If the version specified is not the current version, the ConcurrentModificationException is returned.
480 */
481 CurrentApplicationVersionId: ApplicationVersionId;
482 /**
483 * The ID of the configuration to delete. Each output configuration that is added to the application, either when the application is created or later using the AddApplicationOutput operation, has a unique ID. You need to provide the ID to uniquely identify the output configuration that you want to delete from the application configuration. You can use the DescribeApplication operation to get the specific OutputId.
484 */
485 OutputId: Id;
486 }
487 export interface DeleteApplicationOutputResponse {
488 }
489 export interface DeleteApplicationReferenceDataSourceRequest {
490 /**
491 * Name of an existing application.
492 */
493 ApplicationName: ApplicationName;
494 /**
495 * Version of the application. You can use the DescribeApplication operation to get the current application version. If the version specified is not the current version, the ConcurrentModificationException is returned.
496 */
497 CurrentApplicationVersionId: ApplicationVersionId;
498 /**
499 * ID of the reference data source. When you add a reference data source to your application using the AddApplicationReferenceDataSource, Amazon Kinesis Analytics assigns an ID. You can use the DescribeApplication operation to get the reference ID.
500 */
501 ReferenceId: Id;
502 }
503 export interface DeleteApplicationReferenceDataSourceResponse {
504 }
505 export interface DeleteApplicationRequest {
506 /**
507 * Name of the Amazon Kinesis Analytics application to delete.
508 */
509 ApplicationName: ApplicationName;
510 /**
511 * You can use the DescribeApplication operation to get this value.
512 */
513 CreateTimestamp: Timestamp;
514 }
515 export interface DeleteApplicationResponse {
516 }
517 export interface DescribeApplicationRequest {
518 /**
519 * Name of the application.
520 */
521 ApplicationName: ApplicationName;
522 }
523 export interface DescribeApplicationResponse {
524 /**
525 * Provides a description of the application, such as the application Amazon Resource Name (ARN), status, latest version, and input and output configuration details.
526 */
527 ApplicationDetail: ApplicationDetail;
528 }
529 export interface DestinationSchema {
530 /**
531 * Specifies the format of the records on the output stream.
532 */
533 RecordFormatType: RecordFormatType;
534 }
535 export interface DiscoverInputSchemaRequest {
536 /**
537 * Amazon Resource Name (ARN) of the streaming source.
538 */
539 ResourceARN?: ResourceARN;
540 /**
541 * ARN of the IAM role that Amazon Kinesis Analytics can assume to access the stream on your behalf.
542 */
543 RoleARN?: RoleARN;
544 /**
545 * Point at which you want Amazon Kinesis Analytics to start reading records from the specified streaming source discovery purposes.
546 */
547 InputStartingPositionConfiguration?: InputStartingPositionConfiguration;
548 /**
549 * Specify this parameter to discover a schema from data in an Amazon S3 object.
550 */
551 S3Configuration?: S3Configuration;
552 /**
553 * The InputProcessingConfiguration to use to preprocess the records before discovering the schema of the records.
554 */
555 InputProcessingConfiguration?: InputProcessingConfiguration;
556 }
557 export interface DiscoverInputSchemaResponse {
558 /**
559 * 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.
560 */
561 InputSchema?: SourceSchema;
562 /**
563 * An array of elements, where each element corresponds to a row in a stream record (a stream record can have more than one row).
564 */
565 ParsedInputRecords?: ParsedInputRecords;
566 /**
567 * Stream data that was modified by the processor specified in the InputProcessingConfiguration parameter.
568 */
569 ProcessedInputRecords?: ProcessedInputRecords;
570 /**
571 * Raw stream data that was sampled to infer the schema.
572 */
573 RawInputRecords?: RawInputRecords;
574 }
575 export type FileKey = string;
576 export type Id = string;
577 export type InAppStreamName = string;
578 export type InAppStreamNames = InAppStreamName[];
579 export type InAppTableName = string;
580 export interface Input {
581 /**
582 * Name prefix to use when creating an in-application stream. Suppose that you specify a prefix "MyInApplicationStream." Amazon Kinesis Analytics then creates one or more (as per the InputParallelism count you specified) in-application streams with names "MyInApplicationStream_001," "MyInApplicationStream_002," and so on.
583 */
584 NamePrefix: InAppStreamName;
585 /**
586 * The InputProcessingConfiguration for the input. An input processor transforms records as they are received from the stream, before the application's SQL code executes. Currently, the only input processing configuration available is InputLambdaProcessor.
587 */
588 InputProcessingConfiguration?: InputProcessingConfiguration;
589 /**
590 * If the streaming source is an Amazon Kinesis stream, identifies the stream's Amazon Resource Name (ARN) and an IAM role that enables Amazon Kinesis Analytics to access the stream on your behalf. Note: Either KinesisStreamsInput or KinesisFirehoseInput is required.
591 */
592 KinesisStreamsInput?: KinesisStreamsInput;
593 /**
594 * If the streaming source is an Amazon Kinesis Firehose delivery stream, identifies the delivery stream's ARN and an IAM role that enables Amazon Kinesis Analytics to access the stream on your behalf. Note: Either KinesisStreamsInput or KinesisFirehoseInput is required.
595 */
596 KinesisFirehoseInput?: KinesisFirehoseInput;
597 /**
598 * Describes the number of in-application streams to create. Data from your source is routed to these in-application input streams. (see Configuring Application Input.
599 */
600 InputParallelism?: InputParallelism;
601 /**
602 * 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. Also used to describe the format of the reference data source.
603 */
604 InputSchema: SourceSchema;
605 }
606 export interface InputConfiguration {
607 /**
608 * Input source ID. You can get this ID by calling the DescribeApplication operation.
609 */
610 Id: Id;
611 /**
612 * Point at which you want the application to start processing records from the streaming source.
613 */
614 InputStartingPositionConfiguration: InputStartingPositionConfiguration;
615 }
616 export type InputConfigurations = InputConfiguration[];
617 export interface InputDescription {
618 /**
619 * Input ID associated with the application input. This is the ID that Amazon Kinesis Analytics assigns to each input configuration you add to your application.
620 */
621 InputId?: Id;
622 /**
623 * In-application name prefix.
624 */
625 NamePrefix?: InAppStreamName;
626 /**
627 * Returns the in-application stream names that are mapped to the stream source.
628 */
629 InAppStreamNames?: InAppStreamNames;
630 /**
631 * The description of the preprocessor that executes on records in this input before the application's code is run.
632 */
633 InputProcessingConfigurationDescription?: InputProcessingConfigurationDescription;
634 /**
635 * If an Amazon Kinesis stream is configured as streaming source, provides Amazon Kinesis stream's Amazon Resource Name (ARN) and an IAM role that enables Amazon Kinesis Analytics to access the stream on your behalf.
636 */
637 KinesisStreamsInputDescription?: KinesisStreamsInputDescription;
638 /**
639 * If an Amazon Kinesis Firehose delivery stream is configured as a streaming source, provides the delivery stream's ARN and an IAM role that enables Amazon Kinesis Analytics to access the stream on your behalf.
640 */
641 KinesisFirehoseInputDescription?: KinesisFirehoseInputDescription;
642 /**
643 * 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.
644 */
645 InputSchema?: SourceSchema;
646 /**
647 * Describes the configured parallelism (number of in-application streams mapped to the streaming source).
648 */
649 InputParallelism?: InputParallelism;
650 /**
651 * Point at which the application is configured to read from the input stream.
652 */
653 InputStartingPositionConfiguration?: InputStartingPositionConfiguration;
654 }
655 export type InputDescriptions = InputDescription[];
656 export interface InputLambdaProcessor {
657 /**
658 * The ARN of the AWS Lambda function that operates on records in the stream. 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 Example ARNs: AWS Lambda
659 */
660 ResourceARN: ResourceARN;
661 /**
662 * The ARN of the IAM role that is used to access the AWS Lambda function.
663 */
664 RoleARN: RoleARN;
665 }
666 export interface InputLambdaProcessorDescription {
667 /**
668 * The ARN of the AWS Lambda function that is used to preprocess the records in the stream.
669 */
670 ResourceARN?: ResourceARN;
671 /**
672 * The ARN of the IAM role that is used to access the AWS Lambda function.
673 */
674 RoleARN?: RoleARN;
675 }
676 export interface InputLambdaProcessorUpdate {
677 /**
678 * The Amazon Resource Name (ARN) of the new AWS Lambda function that is used to preprocess the records in the stream. 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 Example ARNs: AWS Lambda
679 */
680 ResourceARNUpdate?: ResourceARN;
681 /**
682 * The ARN of the new IAM role that is used to access the AWS Lambda function.
683 */
684 RoleARNUpdate?: RoleARN;
685 }
686 export interface InputParallelism {
687 /**
688 * Number of in-application streams to create. For more information, see Limits.
689 */
690 Count?: InputParallelismCount;
691 }
692 export type InputParallelismCount = number;
693 export interface InputParallelismUpdate {
694 /**
695 * Number of in-application streams to create for the specified streaming source.
696 */
697 CountUpdate?: InputParallelismCount;
698 }
699 export interface InputProcessingConfiguration {
700 /**
701 * The InputLambdaProcessor that is used to preprocess the records in the stream before being processed by your application code.
702 */
703 InputLambdaProcessor: InputLambdaProcessor;
704 }
705 export interface InputProcessingConfigurationDescription {
706 /**
707 * Provides configuration information about the associated InputLambdaProcessorDescription.
708 */
709 InputLambdaProcessorDescription?: InputLambdaProcessorDescription;
710 }
711 export interface InputProcessingConfigurationUpdate {
712 /**
713 * Provides update information for an InputLambdaProcessor.
714 */
715 InputLambdaProcessorUpdate: InputLambdaProcessorUpdate;
716 }
717 export interface InputSchemaUpdate {
718 /**
719 * Specifies the format of the records on the streaming source.
720 */
721 RecordFormatUpdate?: RecordFormat;
722 /**
723 * Specifies the encoding of the records in the streaming source. For example, UTF-8.
724 */
725 RecordEncodingUpdate?: RecordEncoding;
726 /**
727 * A list of RecordColumn objects. Each object describes the mapping of the streaming source element to the corresponding column in the in-application stream.
728 */
729 RecordColumnUpdates?: RecordColumns;
730 }
731 export type InputStartingPosition = "NOW"|"TRIM_HORIZON"|"LAST_STOPPED_POINT"|string;
732 export interface InputStartingPositionConfiguration {
733 /**
734 * The starting position on the stream. NOW - Start reading just after the most recent record in the stream, start at the request time stamp that the customer issued. TRIM_HORIZON - Start reading at the last untrimmed record in the stream, which is the oldest record available in the stream. This option is not available for an Amazon Kinesis Firehose delivery stream. LAST_STOPPED_POINT - Resume reading from where the application last stopped reading.
735 */
736 InputStartingPosition?: InputStartingPosition;
737 }
738 export interface InputUpdate {
739 /**
740 * Input ID of the application input to be updated.
741 */
742 InputId: Id;
743 /**
744 * Name prefix for in-application streams that Amazon Kinesis Analytics creates for the specific streaming source.
745 */
746 NamePrefixUpdate?: InAppStreamName;
747 /**
748 * Describes updates for an input processing configuration.
749 */
750 InputProcessingConfigurationUpdate?: InputProcessingConfigurationUpdate;
751 /**
752 * If an Amazon Kinesis stream is the streaming source to be updated, provides an updated stream Amazon Resource Name (ARN) and IAM role ARN.
753 */
754 KinesisStreamsInputUpdate?: KinesisStreamsInputUpdate;
755 /**
756 * If an Amazon Kinesis Firehose delivery stream is the streaming source to be updated, provides an updated stream ARN and IAM role ARN.
757 */
758 KinesisFirehoseInputUpdate?: KinesisFirehoseInputUpdate;
759 /**
760 * Describes the data format on the streaming source, and how record elements on the streaming source map to columns of the in-application stream that is created.
761 */
762 InputSchemaUpdate?: InputSchemaUpdate;
763 /**
764 * Describes the parallelism updates (the number in-application streams Amazon Kinesis Analytics creates for the specific streaming source).
765 */
766 InputParallelismUpdate?: InputParallelismUpdate;
767 }
768 export type InputUpdates = InputUpdate[];
769 export type Inputs = Input[];
770 export interface JSONMappingParameters {
771 /**
772 * Path to the top-level parent that contains the records.
773 */
774 RecordRowPath: RecordRowPath;
775 }
776 export type KinesisAnalyticsARN = string;
777 export interface KinesisFirehoseInput {
778 /**
779 * ARN of the input delivery stream.
780 */
781 ResourceARN: ResourceARN;
782 /**
783 * ARN of the IAM role that Amazon Kinesis Analytics can assume to access the stream on your behalf. You need to make sure that the role has the necessary permissions to access the stream.
784 */
785 RoleARN: RoleARN;
786 }
787 export interface KinesisFirehoseInputDescription {
788 /**
789 * Amazon Resource Name (ARN) of the Amazon Kinesis Firehose delivery stream.
790 */
791 ResourceARN?: ResourceARN;
792 /**
793 * ARN of the IAM role that Amazon Kinesis Analytics assumes to access the stream.
794 */
795 RoleARN?: RoleARN;
796 }
797 export interface KinesisFirehoseInputUpdate {
798 /**
799 * Amazon Resource Name (ARN) of the input Amazon Kinesis Firehose delivery stream to read.
800 */
801 ResourceARNUpdate?: ResourceARN;
802 /**
803 * 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.
804 */
805 RoleARNUpdate?: RoleARN;
806 }
807 export interface KinesisFirehoseOutput {
808 /**
809 * ARN of the destination Amazon Kinesis Firehose delivery stream to write to.
810 */
811 ResourceARN: ResourceARN;
812 /**
813 * 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.
814 */
815 RoleARN: RoleARN;
816 }
817 export interface KinesisFirehoseOutputDescription {
818 /**
819 * Amazon Resource Name (ARN) of the Amazon Kinesis Firehose delivery stream.
820 */
821 ResourceARN?: ResourceARN;
822 /**
823 * ARN of the IAM role that Amazon Kinesis Analytics can assume to access the stream.
824 */
825 RoleARN?: RoleARN;
826 }
827 export interface KinesisFirehoseOutputUpdate {
828 /**
829 * Amazon Resource Name (ARN) of the Amazon Kinesis Firehose delivery stream to write to.
830 */
831 ResourceARNUpdate?: ResourceARN;
832 /**
833 * 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.
834 */
835 RoleARNUpdate?: RoleARN;
836 }
837 export interface KinesisStreamsInput {
838 /**
839 * ARN of the input Amazon Kinesis stream to read.
840 */
841 ResourceARN: ResourceARN;
842 /**
843 * 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.
844 */
845 RoleARN: RoleARN;
846 }
847 export interface KinesisStreamsInputDescription {
848 /**
849 * Amazon Resource Name (ARN) of the Amazon Kinesis stream.
850 */
851 ResourceARN?: ResourceARN;
852 /**
853 * ARN of the IAM role that Amazon Kinesis Analytics can assume to access the stream.
854 */
855 RoleARN?: RoleARN;
856 }
857 export interface KinesisStreamsInputUpdate {
858 /**
859 * Amazon Resource Name (ARN) of the input Amazon Kinesis stream to read.
860 */
861 ResourceARNUpdate?: ResourceARN;
862 /**
863 * 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.
864 */
865 RoleARNUpdate?: RoleARN;
866 }
867 export interface KinesisStreamsOutput {
868 /**
869 * ARN of the destination Amazon Kinesis stream to write to.
870 */
871 ResourceARN: ResourceARN;
872 /**
873 * 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.
874 */
875 RoleARN: RoleARN;
876 }
877 export interface KinesisStreamsOutputDescription {
878 /**
879 * Amazon Resource Name (ARN) of the Amazon Kinesis stream.
880 */
881 ResourceARN?: ResourceARN;
882 /**
883 * ARN of the IAM role that Amazon Kinesis Analytics can assume to access the stream.
884 */
885 RoleARN?: RoleARN;
886 }
887 export interface KinesisStreamsOutputUpdate {
888 /**
889 * Amazon Resource Name (ARN) of the Amazon Kinesis stream where you want to write the output.
890 */
891 ResourceARNUpdate?: ResourceARN;
892 /**
893 * 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.
894 */
895 RoleARNUpdate?: RoleARN;
896 }
897 export interface LambdaOutput {
898 /**
899 * Amazon Resource Name (ARN) of the destination Lambda function to write to. 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 Example ARNs: AWS Lambda
900 */
901 ResourceARN: ResourceARN;
902 /**
903 * 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.
904 */
905 RoleARN: RoleARN;
906 }
907 export interface LambdaOutputDescription {
908 /**
909 * Amazon Resource Name (ARN) of the destination Lambda function.
910 */
911 ResourceARN?: ResourceARN;
912 /**
913 * ARN of the IAM role that Amazon Kinesis Analytics can assume to write to the destination function.
914 */
915 RoleARN?: RoleARN;
916 }
917 export interface LambdaOutputUpdate {
918 /**
919 * Amazon Resource Name (ARN) of the destination Lambda function. 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 Example ARNs: AWS Lambda
920 */
921 ResourceARNUpdate?: ResourceARN;
922 /**
923 * 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.
924 */
925 RoleARNUpdate?: RoleARN;
926 }
927 export type ListApplicationsInputLimit = number;
928 export interface ListApplicationsRequest {
929 /**
930 * Maximum number of applications to list.
931 */
932 Limit?: ListApplicationsInputLimit;
933 /**
934 * 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.
935 */
936 ExclusiveStartApplicationName?: ApplicationName;
937 }
938 export interface ListApplicationsResponse {
939 /**
940 * List of ApplicationSummary objects.
941 */
942 ApplicationSummaries: ApplicationSummaries;
943 /**
944 * Returns true if there are more applications to retrieve.
945 */
946 HasMoreApplications: BooleanObject;
947 }
948 export interface ListTagsForResourceRequest {
949 /**
950 * The ARN of the application for which to retrieve tags.
951 */
952 ResourceARN: KinesisAnalyticsARN;
953 }
954 export interface ListTagsForResourceResponse {
955 /**
956 * The key-value tags assigned to the application.
957 */
958 Tags?: Tags;
959 }
960 export type LogStreamARN = string;
961 export interface MappingParameters {
962 /**
963 * Provides additional mapping information when JSON is the record format on the streaming source.
964 */
965 JSONMappingParameters?: JSONMappingParameters;
966 /**
967 * Provides additional mapping information when the record format uses delimiters (for example, CSV).
968 */
969 CSVMappingParameters?: CSVMappingParameters;
970 }
971 export interface Output {
972 /**
973 * Name of the in-application stream.
974 */
975 Name: InAppStreamName;
976 /**
977 * Identifies an Amazon Kinesis stream as the destination.
978 */
979 KinesisStreamsOutput?: KinesisStreamsOutput;
980 /**
981 * Identifies an Amazon Kinesis Firehose delivery stream as the destination.
982 */
983 KinesisFirehoseOutput?: KinesisFirehoseOutput;
984 /**
985 * Identifies an AWS Lambda function as the destination.
986 */
987 LambdaOutput?: LambdaOutput;
988 /**
989 * Describes the data format when records are written to the destination. For more information, see Configuring Application Output.
990 */
991 DestinationSchema: DestinationSchema;
992 }
993 export interface OutputDescription {
994 /**
995 * A unique identifier for the output configuration.
996 */
997 OutputId?: Id;
998 /**
999 * Name of the in-application stream configured as output.
1000 */
1001 Name?: InAppStreamName;
1002 /**
1003 * Describes Amazon Kinesis stream configured as the destination where output is written.
1004 */
1005 KinesisStreamsOutputDescription?: KinesisStreamsOutputDescription;
1006 /**
1007 * Describes the Amazon Kinesis Firehose delivery stream configured as the destination where output is written.
1008 */
1009 KinesisFirehoseOutputDescription?: KinesisFirehoseOutputDescription;
1010 /**
1011 * Describes the AWS Lambda function configured as the destination where output is written.
1012 */
1013 LambdaOutputDescription?: LambdaOutputDescription;
1014 /**
1015 * Data format used for writing data to the destination.
1016 */
1017 DestinationSchema?: DestinationSchema;
1018 }
1019 export type OutputDescriptions = OutputDescription[];
1020 export interface OutputUpdate {
1021 /**
1022 * Identifies the specific output configuration that you want to update.
1023 */
1024 OutputId: Id;
1025 /**
1026 * If you want to specify a different in-application stream for this output configuration, use this field to specify the new in-application stream name.
1027 */
1028 NameUpdate?: InAppStreamName;
1029 /**
1030 * Describes an Amazon Kinesis stream as the destination for the output.
1031 */
1032 KinesisStreamsOutputUpdate?: KinesisStreamsOutputUpdate;
1033 /**
1034 * Describes an Amazon Kinesis Firehose delivery stream as the destination for the output.
1035 */
1036 KinesisFirehoseOutputUpdate?: KinesisFirehoseOutputUpdate;
1037 /**
1038 * Describes an AWS Lambda function as the destination for the output.
1039 */
1040 LambdaOutputUpdate?: LambdaOutputUpdate;
1041 /**
1042 * Describes the data format when records are written to the destination. For more information, see Configuring Application Output.
1043 */
1044 DestinationSchemaUpdate?: DestinationSchema;
1045 }
1046 export type OutputUpdates = OutputUpdate[];
1047 export type Outputs = Output[];
1048 export type ParsedInputRecord = ParsedInputRecordField[];
1049 export type ParsedInputRecordField = string;
1050 export type ParsedInputRecords = ParsedInputRecord[];
1051 export type ProcessedInputRecord = string;
1052 export type ProcessedInputRecords = ProcessedInputRecord[];
1053 export type RawInputRecord = string;
1054 export type RawInputRecords = RawInputRecord[];
1055 export interface RecordColumn {
1056 /**
1057 * Name of the column created in the in-application input stream or reference table.
1058 */
1059 Name: RecordColumnName;
1060 /**
1061 * Reference to the data element in the streaming input or the reference data source. This element is required if the RecordFormatType is JSON.
1062 */
1063 Mapping?: RecordColumnMapping;
1064 /**
1065 * Type of column created in the in-application input stream or reference table.
1066 */
1067 SqlType: RecordColumnSqlType;
1068 }
1069 export type RecordColumnDelimiter = string;
1070 export type RecordColumnMapping = string;
1071 export type RecordColumnName = string;
1072 export type RecordColumnSqlType = string;
1073 export type RecordColumns = RecordColumn[];
1074 export type RecordEncoding = string;
1075 export interface RecordFormat {
1076 /**
1077 * The type of record format.
1078 */
1079 RecordFormatType: RecordFormatType;
1080 /**
1081 * 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.
1082 */
1083 MappingParameters?: MappingParameters;
1084 }
1085 export type RecordFormatType = "JSON"|"CSV"|string;
1086 export type RecordRowDelimiter = string;
1087 export type RecordRowPath = string;
1088 export interface ReferenceDataSource {
1089 /**
1090 * Name of the in-application table to create.
1091 */
1092 TableName: InAppTableName;
1093 /**
1094 * 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. An Amazon Kinesis Analytics application loads reference data only once. If the data changes, you call the UpdateApplication operation to trigger reloading of data into your application.
1095 */
1096 S3ReferenceDataSource?: S3ReferenceDataSource;
1097 /**
1098 * 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.
1099 */
1100 ReferenceSchema: SourceSchema;
1101 }
1102 export interface ReferenceDataSourceDescription {
1103 /**
1104 * ID of the reference data source. This is the ID that Amazon Kinesis Analytics assigns when you add the reference data source to your application using the AddApplicationReferenceDataSource operation.
1105 */
1106 ReferenceId: Id;
1107 /**
1108 * The in-application table name created by the specific reference data source configuration.
1109 */
1110 TableName: InAppTableName;
1111 /**
1112 * 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.
1113 */
1114 S3ReferenceDataSourceDescription: S3ReferenceDataSourceDescription;
1115 /**
1116 * 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.
1117 */
1118 ReferenceSchema?: SourceSchema;
1119 }
1120 export type ReferenceDataSourceDescriptions = ReferenceDataSourceDescription[];
1121 export interface ReferenceDataSourceUpdate {
1122 /**
1123 * ID of the reference data source being updated. You can use the DescribeApplication operation to get this value.
1124 */
1125 ReferenceId: Id;
1126 /**
1127 * In-application table name that is created by this update.
1128 */
1129 TableNameUpdate?: InAppTableName;
1130 /**
1131 * 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.
1132 */
1133 S3ReferenceDataSourceUpdate?: S3ReferenceDataSourceUpdate;
1134 /**
1135 * 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.
1136 */
1137 ReferenceSchemaUpdate?: SourceSchema;
1138 }
1139 export type ReferenceDataSourceUpdates = ReferenceDataSourceUpdate[];
1140 export type ResourceARN = string;
1141 export type RoleARN = string;
1142 export interface S3Configuration {
1143 /**
1144 * IAM ARN of the role used to access the data.
1145 */
1146 RoleARN: RoleARN;
1147 /**
1148 * ARN of the S3 bucket that contains the data.
1149 */
1150 BucketARN: BucketARN;
1151 /**
1152 * The name of the object that contains the data.
1153 */
1154 FileKey: FileKey;
1155 }
1156 export interface S3ReferenceDataSource {
1157 /**
1158 * Amazon Resource Name (ARN) of the S3 bucket.
1159 */
1160 BucketARN: BucketARN;
1161 /**
1162 * Object key name containing reference data.
1163 */
1164 FileKey: FileKey;
1165 /**
1166 * ARN of the IAM role that the service can assume to read data on your behalf. This role must have permission for the s3:GetObject action on the object and trust policy that allows Amazon Kinesis Analytics service principal to assume this role.
1167 */
1168 ReferenceRoleARN: RoleARN;
1169 }
1170 export interface S3ReferenceDataSourceDescription {
1171 /**
1172 * Amazon Resource Name (ARN) of the S3 bucket.
1173 */
1174 BucketARN: BucketARN;
1175 /**
1176 * Amazon S3 object key name.
1177 */
1178 FileKey: FileKey;
1179 /**
1180 * 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.
1181 */
1182 ReferenceRoleARN: RoleARN;
1183 }
1184 export interface S3ReferenceDataSourceUpdate {
1185 /**
1186 * Amazon Resource Name (ARN) of the S3 bucket.
1187 */
1188 BucketARNUpdate?: BucketARN;
1189 /**
1190 * Object key name.
1191 */
1192 FileKeyUpdate?: FileKey;
1193 /**
1194 * ARN of the IAM role that Amazon Kinesis Analytics can assume to read the Amazon S3 object and populate the in-application.
1195 */
1196 ReferenceRoleARNUpdate?: RoleARN;
1197 }
1198 export interface SourceSchema {
1199 /**
1200 * Specifies the format of the records on the streaming source.
1201 */
1202 RecordFormat: RecordFormat;
1203 /**
1204 * Specifies the encoding of the records in the streaming source. For example, UTF-8.
1205 */
1206 RecordEncoding?: RecordEncoding;
1207 /**
1208 * A list of RecordColumn objects.
1209 */
1210 RecordColumns: RecordColumns;
1211 }
1212 export interface StartApplicationRequest {
1213 /**
1214 * Name of the application.
1215 */
1216 ApplicationName: ApplicationName;
1217 /**
1218 * 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.
1219 */
1220 InputConfigurations: InputConfigurations;
1221 }
1222 export interface StartApplicationResponse {
1223 }
1224 export interface StopApplicationRequest {
1225 /**
1226 * Name of the running application to stop.
1227 */
1228 ApplicationName: ApplicationName;
1229 }
1230 export interface StopApplicationResponse {
1231 }
1232 export interface Tag {
1233 /**
1234 * The key of the key-value tag.
1235 */
1236 Key: TagKey;
1237 /**
1238 * The value of the key-value tag. The value is optional.
1239 */
1240 Value?: TagValue;
1241 }
1242 export type TagKey = string;
1243 export type TagKeys = TagKey[];
1244 export interface TagResourceRequest {
1245 /**
1246 * The ARN of the application to assign the tags.
1247 */
1248 ResourceARN: KinesisAnalyticsARN;
1249 /**
1250 * The key-value tags to assign to the application.
1251 */
1252 Tags: Tags;
1253 }
1254 export interface TagResourceResponse {
1255 }
1256 export type TagValue = string;
1257 export type Tags = Tag[];
1258 export type Timestamp = Date;
1259 export interface UntagResourceRequest {
1260 /**
1261 * The ARN of the Kinesis Analytics application from which to remove the tags.
1262 */
1263 ResourceARN: KinesisAnalyticsARN;
1264 /**
1265 * A list of keys of tags to remove from the specified application.
1266 */
1267 TagKeys: TagKeys;
1268 }
1269 export interface UntagResourceResponse {
1270 }
1271 export interface UpdateApplicationRequest {
1272 /**
1273 * Name of the Amazon Kinesis Analytics application to update.
1274 */
1275 ApplicationName: ApplicationName;
1276 /**
1277 * The current application version ID. You can use the DescribeApplication operation to get this value.
1278 */
1279 CurrentApplicationVersionId: ApplicationVersionId;
1280 /**
1281 * Describes application updates.
1282 */
1283 ApplicationUpdate: ApplicationUpdate;
1284 }
1285 export interface UpdateApplicationResponse {
1286 }
1287 /**
1288 * A string in YYYY-MM-DD format that represents the latest possible API version that can be used in this service. Specify 'latest' to use the latest possible version.
1289 */
1290 export type apiVersion = "2015-08-14"|"latest"|string;
1291 export interface ClientApiVersions {
1292 /**
1293 * A string in YYYY-MM-DD format that represents the latest possible API version that can be used in this service. Specify 'latest' to use the latest possible version.
1294 */
1295 apiVersion?: apiVersion;
1296 }
1297 export type ClientConfiguration = ServiceConfigurationOptions & ClientApiVersions;
1298 /**
1299 * Contains interfaces for use with the KinesisAnalytics client.
1300 */
1301 export import Types = KinesisAnalytics;
1302}
1303export = KinesisAnalytics;