After careful consideration, we have decided to discontinue Amazon Kinesis Data Analytics for SQL applications: 1. From **September 1, 2025**, we won't provide any bug fixes for Amazon Kinesis Data Analytics for SQL applications because we will have limited support for it, given the upcoming discontinuation. 2. From **October 15, 2025**, you will not be able to create new Kinesis Data Analytics for SQL applications. 3. We will delete your applications starting **January 27, 2026**. You will not be able to start or operate your Amazon Kinesis Data Analytics for SQL applications. Support will no longer be available for Amazon Kinesis Data Analytics for SQL from that time. For more information, see [Amazon Kinesis Data Analytics for SQL Applications discontinuation](discontinuation.md). # Actions The following actions are supported: + [AddApplicationCloudWatchLoggingOption](API_AddApplicationCloudWatchLoggingOption.md) + [AddApplicationInput](API_AddApplicationInput.md) + [AddApplicationInputProcessingConfiguration](API_AddApplicationInputProcessingConfiguration.md) + [AddApplicationOutput](API_AddApplicationOutput.md) + [AddApplicationReferenceDataSource](API_AddApplicationReferenceDataSource.md) + [CreateApplication](API_CreateApplication.md) + [DeleteApplication](API_DeleteApplication.md) + [DeleteApplicationCloudWatchLoggingOption](API_DeleteApplicationCloudWatchLoggingOption.md) + [DeleteApplicationInputProcessingConfiguration](API_DeleteApplicationInputProcessingConfiguration.md) + [DeleteApplicationOutput](API_DeleteApplicationOutput.md) + [DeleteApplicationReferenceDataSource](API_DeleteApplicationReferenceDataSource.md) + [DescribeApplication](API_DescribeApplication.md) + [DiscoverInputSchema](API_DiscoverInputSchema.md) + [ListApplications](API_ListApplications.md) + [ListTagsForResource](API_ListTagsForResource.md) + [StartApplication](API_StartApplication.md) + [StopApplication](API_StopApplication.md) + [TagResource](API_TagResource.md) + [UntagResource](API_UntagResource.md) + [UpdateApplication](API_UpdateApplication.md) # AddApplicationCloudWatchLoggingOption **Note** 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](/kinesisanalytics/latest/apiv2/Welcome.html). 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](https://docs.aws.amazon.com/kinesisanalytics/latest/dev/cloudwatch-logs.html). ## Request Syntax ``` { "ApplicationName": "string", "CloudWatchLoggingOption": { "LogStreamARN": "string", "RoleARN": "string" }, "CurrentApplicationVersionId": number } ``` ## Request Parameters The request accepts the following data in JSON format. ** [ApplicationName](#API_AddApplicationCloudWatchLoggingOption_RequestSyntax) ** The Kinesis Analytics application name. Type: String Length Constraints: Minimum length of 1. Maximum length of 128. Pattern: `[a-zA-Z0-9_.-]+` Required: Yes ** [CloudWatchLoggingOption](#API_AddApplicationCloudWatchLoggingOption_RequestSyntax) ** 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. Type: [CloudWatchLoggingOption](API_CloudWatchLoggingOption.md) object Required: Yes ** [CurrentApplicationVersionId](#API_AddApplicationCloudWatchLoggingOption_RequestSyntax) ** The version ID of the Kinesis Analytics application. Type: Long Valid Range: Minimum value of 1. Maximum value of 999999999. Required: Yes ## Response Elements If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body. ## Errors ** ConcurrentModificationException ** 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. ** message ** HTTP Status Code: 400 ** InvalidArgumentException ** Specified input parameter value is invalid. ** message ** HTTP Status Code: 400 ** ResourceInUseException ** Application is not available for this operation. ** message ** HTTP Status Code: 400 ** ResourceNotFoundException ** Specified application can't be found. ** message ** HTTP Status Code: 400 ** UnsupportedOperationException ** The request was rejected because a specified parameter is not supported or a specified resource is not valid for this operation. HTTP Status Code: 400 ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/kinesisanalytics-2015-08-14/AddApplicationCloudWatchLoggingOption) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/kinesisanalytics-2015-08-14/AddApplicationCloudWatchLoggingOption) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/kinesisanalytics-2015-08-14/AddApplicationCloudWatchLoggingOption) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/kinesisanalytics-2015-08-14/AddApplicationCloudWatchLoggingOption) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/kinesisanalytics-2015-08-14/AddApplicationCloudWatchLoggingOption) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/kinesisanalytics-2015-08-14/AddApplicationCloudWatchLoggingOption) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/kinesisanalytics-2015-08-14/AddApplicationCloudWatchLoggingOption) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/kinesisanalytics-2015-08-14/AddApplicationCloudWatchLoggingOption) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/kinesisanalytics-2015-08-14/AddApplicationCloudWatchLoggingOption) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/kinesisanalytics-2015-08-14/AddApplicationCloudWatchLoggingOption) # AddApplicationInput **Note** 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](/kinesisanalytics/latest/apiv2/Welcome.html). Adds a streaming source to your Amazon Kinesis application. For conceptual information, see [Configuring Application Input](https://docs.aws.amazon.com/kinesisanalytics/latest/dev/how-it-works-input.html). 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](https://docs.aws.amazon.com/kinesisanalytics/latest/dev/API_CreateApplication.html). Any configuration update, including adding a streaming source using this operation, results in a new version of the application. You can use the [DescribeApplication](https://docs.aws.amazon.com/kinesisanalytics/latest/dev/API_DescribeApplication.html) operation to find the current application version. This operation requires permissions to perform the `kinesisanalytics:AddApplicationInput` action. ## Request Syntax ``` { "ApplicationName": "string", "CurrentApplicationVersionId": number, "Input": { "InputParallelism": { "Count": number }, "InputProcessingConfiguration": { "InputLambdaProcessor": { "ResourceARN": "string", "RoleARN": "string" } }, "InputSchema": { "RecordColumns": [ { "Mapping": "string", "Name": "string", "SqlType": "string" } ], "RecordEncoding": "string", "RecordFormat": { "MappingParameters": { "CSVMappingParameters": { "RecordColumnDelimiter": "string", "RecordRowDelimiter": "string" }, "JSONMappingParameters": { "RecordRowPath": "string" } }, "RecordFormatType": "string" } }, "KinesisFirehoseInput": { "ResourceARN": "string", "RoleARN": "string" }, "KinesisStreamsInput": { "ResourceARN": "string", "RoleARN": "string" }, "NamePrefix": "string" } } ``` ## Request Parameters The request accepts the following data in JSON format. ** [ApplicationName](#API_AddApplicationInput_RequestSyntax) ** Name of your existing Amazon Kinesis Analytics application to which you want to add the streaming source. Type: String Length Constraints: Minimum length of 1. Maximum length of 128. Pattern: `[a-zA-Z0-9_.-]+` Required: Yes ** [CurrentApplicationVersionId](#API_AddApplicationInput_RequestSyntax) ** Current version of your Amazon Kinesis Analytics application. You can use the [DescribeApplication](https://docs.aws.amazon.com/kinesisanalytics/latest/dev/API_DescribeApplication.html) operation to find the current application version. Type: Long Valid Range: Minimum value of 1. Maximum value of 999999999. Required: Yes ** [Input](#API_AddApplicationInput_RequestSyntax) ** The [Input](https://docs.aws.amazon.com/kinesisanalytics/latest/dev/API_Input.html) to add. Type: [Input](API_Input.md) object Required: Yes ## Response Elements If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body. ## Errors ** CodeValidationException ** User-provided application code (query) is invalid. This can be a simple syntax error. ** message ** Test HTTP Status Code: 400 ** ConcurrentModificationException ** 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. ** message ** HTTP Status Code: 400 ** InvalidArgumentException ** Specified input parameter value is invalid. ** message ** HTTP Status Code: 400 ** ResourceInUseException ** Application is not available for this operation. ** message ** HTTP Status Code: 400 ** ResourceNotFoundException ** Specified application can't be found. ** message ** HTTP Status Code: 400 ** UnsupportedOperationException ** The request was rejected because a specified parameter is not supported or a specified resource is not valid for this operation. HTTP Status Code: 400 ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/kinesisanalytics-2015-08-14/AddApplicationInput) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/kinesisanalytics-2015-08-14/AddApplicationInput) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/kinesisanalytics-2015-08-14/AddApplicationInput) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/kinesisanalytics-2015-08-14/AddApplicationInput) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/kinesisanalytics-2015-08-14/AddApplicationInput) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/kinesisanalytics-2015-08-14/AddApplicationInput) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/kinesisanalytics-2015-08-14/AddApplicationInput) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/kinesisanalytics-2015-08-14/AddApplicationInput) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/kinesisanalytics-2015-08-14/AddApplicationInput) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/kinesisanalytics-2015-08-14/AddApplicationInput) # AddApplicationInputProcessingConfiguration **Note** 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](/kinesisanalytics/latest/apiv2/Welcome.html). Adds an [InputProcessingConfiguration](https://docs.aws.amazon.com/kinesisanalytics/latest/dev/API_InputProcessingConfiguration.html) 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](https://docs.aws.amazon.com/lambda/). ## Request Syntax ``` { "ApplicationName": "string", "CurrentApplicationVersionId": number, "InputId": "string", "InputProcessingConfiguration": { "InputLambdaProcessor": { "ResourceARN": "string", "RoleARN": "string" } } } ``` ## Request Parameters The request accepts the following data in JSON format. ** [ApplicationName](#API_AddApplicationInputProcessingConfiguration_RequestSyntax) ** Name of the application to which you want to add the input processing configuration. Type: String Length Constraints: Minimum length of 1. Maximum length of 128. Pattern: `[a-zA-Z0-9_.-]+` Required: Yes ** [CurrentApplicationVersionId](#API_AddApplicationInputProcessingConfiguration_RequestSyntax) ** Version of the application to which you want to add the input processing configuration. You can use the [DescribeApplication](https://docs.aws.amazon.com/kinesisanalytics/latest/dev/API_DescribeApplication.html) operation to get the current application version. If the version specified is not the current version, the `ConcurrentModificationException` is returned. Type: Long Valid Range: Minimum value of 1. Maximum value of 999999999. Required: Yes ** [InputId](#API_AddApplicationInputProcessingConfiguration_RequestSyntax) ** 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](https://docs.aws.amazon.com/kinesisanalytics/latest/dev/API_DescribeApplication.html) operation. Type: String Length Constraints: Minimum length of 1. Maximum length of 50. Pattern: `[a-zA-Z0-9_.-]+` Required: Yes ** [InputProcessingConfiguration](#API_AddApplicationInputProcessingConfiguration_RequestSyntax) ** The [InputProcessingConfiguration](https://docs.aws.amazon.com/kinesisanalytics/latest/dev/API_InputProcessingConfiguration.html) to add to the application. Type: [InputProcessingConfiguration](API_InputProcessingConfiguration.md) object Required: Yes ## Response Elements If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body. ## Errors ** ConcurrentModificationException ** 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. ** message ** HTTP Status Code: 400 ** InvalidArgumentException ** Specified input parameter value is invalid. ** message ** HTTP Status Code: 400 ** ResourceInUseException ** Application is not available for this operation. ** message ** HTTP Status Code: 400 ** ResourceNotFoundException ** Specified application can't be found. ** message ** HTTP Status Code: 400 ** UnsupportedOperationException ** The request was rejected because a specified parameter is not supported or a specified resource is not valid for this operation. HTTP Status Code: 400 ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/kinesisanalytics-2015-08-14/AddApplicationInputProcessingConfiguration) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/kinesisanalytics-2015-08-14/AddApplicationInputProcessingConfiguration) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/kinesisanalytics-2015-08-14/AddApplicationInputProcessingConfiguration) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/kinesisanalytics-2015-08-14/AddApplicationInputProcessingConfiguration) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/kinesisanalytics-2015-08-14/AddApplicationInputProcessingConfiguration) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/kinesisanalytics-2015-08-14/AddApplicationInputProcessingConfiguration) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/kinesisanalytics-2015-08-14/AddApplicationInputProcessingConfiguration) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/kinesisanalytics-2015-08-14/AddApplicationInputProcessingConfiguration) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/kinesisanalytics-2015-08-14/AddApplicationInputProcessingConfiguration) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/kinesisanalytics-2015-08-14/AddApplicationInputProcessingConfiguration) # AddApplicationOutput **Note** 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](/kinesisanalytics/latest/apiv2/Welcome.html). 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)](https://docs.aws.amazon.com/kinesisanalytics/latest/dev/how-it-works-output.html). Any configuration update, including adding a streaming source using this operation, results in a new version of the application. You can use the [DescribeApplication](https://docs.aws.amazon.com/kinesisanalytics/latest/dev/API_DescribeApplication.html) operation to find the current application version. For the limits on the number of application inputs and outputs you can configure, see [Limits](https://docs.aws.amazon.com/kinesisanalytics/latest/dev/limits.html). This operation requires permissions to perform the `kinesisanalytics:AddApplicationOutput` action. ## Request Syntax ``` { "ApplicationName": "string", "CurrentApplicationVersionId": number, "Output": { "DestinationSchema": { "RecordFormatType": "string" }, "KinesisFirehoseOutput": { "ResourceARN": "string", "RoleARN": "string" }, "KinesisStreamsOutput": { "ResourceARN": "string", "RoleARN": "string" }, "LambdaOutput": { "ResourceARN": "string", "RoleARN": "string" }, "Name": "string" } } ``` ## Request Parameters The request accepts the following data in JSON format. ** [ApplicationName](#API_AddApplicationOutput_RequestSyntax) ** Name of the application to which you want to add the output configuration. Type: String Length Constraints: Minimum length of 1. Maximum length of 128. Pattern: `[a-zA-Z0-9_.-]+` Required: Yes ** [CurrentApplicationVersionId](#API_AddApplicationOutput_RequestSyntax) ** Version of the application to which you want to add the output configuration. You can use the [DescribeApplication](https://docs.aws.amazon.com/kinesisanalytics/latest/dev/API_DescribeApplication.html) operation to get the current application version. If the version specified is not the current version, the `ConcurrentModificationException` is returned. Type: Long Valid Range: Minimum value of 1. Maximum value of 999999999. Required: Yes ** [Output](#API_AddApplicationOutput_RequestSyntax) ** 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. Type: [Output](API_Output.md) object Required: Yes ## Response Elements If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body. ## Errors ** ConcurrentModificationException ** 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. ** message ** HTTP Status Code: 400 ** InvalidArgumentException ** Specified input parameter value is invalid. ** message ** HTTP Status Code: 400 ** ResourceInUseException ** Application is not available for this operation. ** message ** HTTP Status Code: 400 ** ResourceNotFoundException ** Specified application can't be found. ** message ** HTTP Status Code: 400 ** UnsupportedOperationException ** The request was rejected because a specified parameter is not supported or a specified resource is not valid for this operation. HTTP Status Code: 400 ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/kinesisanalytics-2015-08-14/AddApplicationOutput) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/kinesisanalytics-2015-08-14/AddApplicationOutput) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/kinesisanalytics-2015-08-14/AddApplicationOutput) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/kinesisanalytics-2015-08-14/AddApplicationOutput) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/kinesisanalytics-2015-08-14/AddApplicationOutput) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/kinesisanalytics-2015-08-14/AddApplicationOutput) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/kinesisanalytics-2015-08-14/AddApplicationOutput) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/kinesisanalytics-2015-08-14/AddApplicationOutput) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/kinesisanalytics-2015-08-14/AddApplicationOutput) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/kinesisanalytics-2015-08-14/AddApplicationOutput) # AddApplicationReferenceDataSource **Note** 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](/kinesisanalytics/latest/apiv2/Welcome.html). 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](https://docs.aws.amazon.com/kinesisanalytics/latest/dev/how-it-works-input.html). For the limits on data sources you can add to your application, see [Limits](https://docs.aws.amazon.com/kinesisanalytics/latest/dev/limits.html). This operation requires permissions to perform the `kinesisanalytics:AddApplicationOutput` action. ## Request Syntax ``` { "ApplicationName": "string", "CurrentApplicationVersionId": number, "ReferenceDataSource": { "ReferenceSchema": { "RecordColumns": [ { "Mapping": "string", "Name": "string", "SqlType": "string" } ], "RecordEncoding": "string", "RecordFormat": { "MappingParameters": { "CSVMappingParameters": { "RecordColumnDelimiter": "string", "RecordRowDelimiter": "string" }, "JSONMappingParameters": { "RecordRowPath": "string" } }, "RecordFormatType": "string" } }, "S3ReferenceDataSource": { "BucketARN": "string", "FileKey": "string", "ReferenceRoleARN": "string" }, "TableName": "string" } } ``` ## Request Parameters The request accepts the following data in JSON format. ** [ApplicationName](#API_AddApplicationReferenceDataSource_RequestSyntax) ** Name of an existing application. Type: String Length Constraints: Minimum length of 1. Maximum length of 128. Pattern: `[a-zA-Z0-9_.-]+` Required: Yes ** [CurrentApplicationVersionId](#API_AddApplicationReferenceDataSource_RequestSyntax) ** Version of the application for which you are adding the reference data source. You can use the [DescribeApplication](https://docs.aws.amazon.com/kinesisanalytics/latest/dev/API_DescribeApplication.html) operation to get the current application version. If the version specified is not the current version, the `ConcurrentModificationException` is returned. Type: Long Valid Range: Minimum value of 1. Maximum value of 999999999. Required: Yes ** [ReferenceDataSource](#API_AddApplicationReferenceDataSource_RequestSyntax) ** 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. Type: [ReferenceDataSource](API_ReferenceDataSource.md) object Required: Yes ## Response Elements If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body. ## Errors ** ConcurrentModificationException ** 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. ** message ** HTTP Status Code: 400 ** InvalidArgumentException ** Specified input parameter value is invalid. ** message ** HTTP Status Code: 400 ** ResourceInUseException ** Application is not available for this operation. ** message ** HTTP Status Code: 400 ** ResourceNotFoundException ** Specified application can't be found. ** message ** HTTP Status Code: 400 ** UnsupportedOperationException ** The request was rejected because a specified parameter is not supported or a specified resource is not valid for this operation. HTTP Status Code: 400 ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/kinesisanalytics-2015-08-14/AddApplicationReferenceDataSource) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/kinesisanalytics-2015-08-14/AddApplicationReferenceDataSource) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/kinesisanalytics-2015-08-14/AddApplicationReferenceDataSource) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/kinesisanalytics-2015-08-14/AddApplicationReferenceDataSource) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/kinesisanalytics-2015-08-14/AddApplicationReferenceDataSource) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/kinesisanalytics-2015-08-14/AddApplicationReferenceDataSource) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/kinesisanalytics-2015-08-14/AddApplicationReferenceDataSource) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/kinesisanalytics-2015-08-14/AddApplicationReferenceDataSource) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/kinesisanalytics-2015-08-14/AddApplicationReferenceDataSource) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/kinesisanalytics-2015-08-14/AddApplicationReferenceDataSource) # CreateApplication **Note** 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](/kinesisanalytics/latest/apiv2/Welcome.html). 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](https://docs.aws.amazon.com/kinesisanalytics/latest/dev/how-it-works.html). 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](https://docs.aws.amazon.com/kinesisanalytics/latest/dev/getting-started.html). ## Request Syntax ``` { "ApplicationCode": "string", "ApplicationDescription": "string", "ApplicationName": "string", "CloudWatchLoggingOptions": [ { "LogStreamARN": "string", "RoleARN": "string" } ], "Inputs": [ { "InputParallelism": { "Count": number }, "InputProcessingConfiguration": { "InputLambdaProcessor": { "ResourceARN": "string", "RoleARN": "string" } }, "InputSchema": { "RecordColumns": [ { "Mapping": "string", "Name": "string", "SqlType": "string" } ], "RecordEncoding": "string", "RecordFormat": { "MappingParameters": { "CSVMappingParameters": { "RecordColumnDelimiter": "string", "RecordRowDelimiter": "string" }, "JSONMappingParameters": { "RecordRowPath": "string" } }, "RecordFormatType": "string" } }, "KinesisFirehoseInput": { "ResourceARN": "string", "RoleARN": "string" }, "KinesisStreamsInput": { "ResourceARN": "string", "RoleARN": "string" }, "NamePrefix": "string" } ], "Outputs": [ { "DestinationSchema": { "RecordFormatType": "string" }, "KinesisFirehoseOutput": { "ResourceARN": "string", "RoleARN": "string" }, "KinesisStreamsOutput": { "ResourceARN": "string", "RoleARN": "string" }, "LambdaOutput": { "ResourceARN": "string", "RoleARN": "string" }, "Name": "string" } ], "Tags": [ { "Key": "string", "Value": "string" } ] } ``` ## Request Parameters The request accepts the following data in JSON format. ** [ApplicationCode](#API_CreateApplication_RequestSyntax) ** 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](https://docs.aws.amazon.com/kinesisanalytics/latest/dev/how-it-works-app-code.html). 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. Type: String Length Constraints: Minimum length of 0. Maximum length of 102400. Required: No ** [ApplicationDescription](#API_CreateApplication_RequestSyntax) ** Summary description of the application. Type: String Length Constraints: Minimum length of 0. Maximum length of 1024. Required: No ** [ApplicationName](#API_CreateApplication_RequestSyntax) ** Name of your Amazon Kinesis Analytics application (for example, `sample-app`). Type: String Length Constraints: Minimum length of 1. Maximum length of 128. Pattern: `[a-zA-Z0-9_.-]+` Required: Yes ** [CloudWatchLoggingOptions](#API_CreateApplication_RequestSyntax) ** Use this parameter to configure a CloudWatch log stream to monitor application configuration errors. For more information, see [Working with Amazon CloudWatch Logs](https://docs.aws.amazon.com/kinesisanalytics/latest/dev/cloudwatch-logs.html). Type: Array of [CloudWatchLoggingOption](API_CloudWatchLoggingOption.md) objects Required: No ** [Inputs](#API_CreateApplication_RequestSyntax) ** 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. Type: Array of [Input](API_Input.md) objects Required: No ** [Outputs](#API_CreateApplication_RequestSyntax) ** 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. Type: Array of [Output](API_Output.md) objects Required: No ** [Tags](#API_CreateApplication_RequestSyntax) ** 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](https://docs.aws.amazon.com/kinesisanalytics/latest/dev/how-tagging.html). Type: Array of [Tag](API_Tag.md) objects Array Members: Minimum number of 1 item. Maximum number of 200 items. Required: No ## Response Syntax ``` { "ApplicationSummary": { "ApplicationARN": "string", "ApplicationName": "string", "ApplicationStatus": "string" } } ``` ## Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. ** [ApplicationSummary](#API_CreateApplication_ResponseSyntax) ** 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. Type: [ApplicationSummary](API_ApplicationSummary.md) object ## Errors ** CodeValidationException ** User-provided application code (query) is invalid. This can be a simple syntax error. ** message ** Test HTTP Status Code: 400 ** ConcurrentModificationException ** 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. ** message ** HTTP Status Code: 400 ** InvalidArgumentException ** Specified input parameter value is invalid. ** message ** HTTP Status Code: 400 ** LimitExceededException ** Exceeded the number of applications allowed. ** message ** HTTP Status Code: 400 ** ResourceInUseException ** Application is not available for this operation. ** message ** HTTP Status Code: 400 ** TooManyTagsException ** 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. HTTP Status Code: 400 ** UnsupportedOperationException ** The request was rejected because a specified parameter is not supported or a specified resource is not valid for this operation. HTTP Status Code: 400 ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/kinesisanalytics-2015-08-14/CreateApplication) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/kinesisanalytics-2015-08-14/CreateApplication) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/kinesisanalytics-2015-08-14/CreateApplication) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/kinesisanalytics-2015-08-14/CreateApplication) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/kinesisanalytics-2015-08-14/CreateApplication) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/kinesisanalytics-2015-08-14/CreateApplication) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/kinesisanalytics-2015-08-14/CreateApplication) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/kinesisanalytics-2015-08-14/CreateApplication) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/kinesisanalytics-2015-08-14/CreateApplication) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/kinesisanalytics-2015-08-14/CreateApplication) # DeleteApplication **Note** 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](/kinesisanalytics/latest/apiv2/Welcome.html). 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. ## Request Syntax ``` { "ApplicationName": "string", "CreateTimestamp": number } ``` ## Request Parameters The request accepts the following data in JSON format. ** [ApplicationName](#API_DeleteApplication_RequestSyntax) ** Name of the Amazon Kinesis Analytics application to delete. Type: String Length Constraints: Minimum length of 1. Maximum length of 128. Pattern: `[a-zA-Z0-9_.-]+` Required: Yes ** [CreateTimestamp](#API_DeleteApplication_RequestSyntax) ** You can use the `DescribeApplication` operation to get this value. Type: Timestamp Required: Yes ## Response Elements If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body. ## Errors ** ConcurrentModificationException ** 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. ** message ** HTTP Status Code: 400 ** ResourceInUseException ** Application is not available for this operation. ** message ** HTTP Status Code: 400 ** ResourceNotFoundException ** Specified application can't be found. ** message ** HTTP Status Code: 400 ** UnsupportedOperationException ** The request was rejected because a specified parameter is not supported or a specified resource is not valid for this operation. HTTP Status Code: 400 ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/kinesisanalytics-2015-08-14/DeleteApplication) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/kinesisanalytics-2015-08-14/DeleteApplication) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/kinesisanalytics-2015-08-14/DeleteApplication) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/kinesisanalytics-2015-08-14/DeleteApplication) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/kinesisanalytics-2015-08-14/DeleteApplication) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/kinesisanalytics-2015-08-14/DeleteApplication) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/kinesisanalytics-2015-08-14/DeleteApplication) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/kinesisanalytics-2015-08-14/DeleteApplication) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/kinesisanalytics-2015-08-14/DeleteApplication) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/kinesisanalytics-2015-08-14/DeleteApplication) # DeleteApplicationCloudWatchLoggingOption **Note** 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](/kinesisanalytics/latest/apiv2/Welcome.html). 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](https://docs.aws.amazon.com/kinesisanalytics/latest/dev/cloudwatch-logs.html). ## Request Syntax ``` { "ApplicationName": "string", "CloudWatchLoggingOptionId": "string", "CurrentApplicationVersionId": number } ``` ## Request Parameters The request accepts the following data in JSON format. ** [ApplicationName](#API_DeleteApplicationCloudWatchLoggingOption_RequestSyntax) ** The Kinesis Analytics application name. Type: String Length Constraints: Minimum length of 1. Maximum length of 128. Pattern: `[a-zA-Z0-9_.-]+` Required: Yes ** [CloudWatchLoggingOptionId](#API_DeleteApplicationCloudWatchLoggingOption_RequestSyntax) ** The `CloudWatchLoggingOptionId` of the CloudWatch logging option to delete. You can get the `CloudWatchLoggingOptionId` by using the [DescribeApplication](https://docs.aws.amazon.com/kinesisanalytics/latest/dev/API_DescribeApplication.html) operation. Type: String Length Constraints: Minimum length of 1. Maximum length of 50. Pattern: `[a-zA-Z0-9_.-]+` Required: Yes ** [CurrentApplicationVersionId](#API_DeleteApplicationCloudWatchLoggingOption_RequestSyntax) ** The version ID of the Kinesis Analytics application. Type: Long Valid Range: Minimum value of 1. Maximum value of 999999999. Required: Yes ## Response Elements If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body. ## Errors ** ConcurrentModificationException ** 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. ** message ** HTTP Status Code: 400 ** InvalidArgumentException ** Specified input parameter value is invalid. ** message ** HTTP Status Code: 400 ** ResourceInUseException ** Application is not available for this operation. ** message ** HTTP Status Code: 400 ** ResourceNotFoundException ** Specified application can't be found. ** message ** HTTP Status Code: 400 ** UnsupportedOperationException ** The request was rejected because a specified parameter is not supported or a specified resource is not valid for this operation. HTTP Status Code: 400 ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/kinesisanalytics-2015-08-14/DeleteApplicationCloudWatchLoggingOption) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/kinesisanalytics-2015-08-14/DeleteApplicationCloudWatchLoggingOption) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/kinesisanalytics-2015-08-14/DeleteApplicationCloudWatchLoggingOption) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/kinesisanalytics-2015-08-14/DeleteApplicationCloudWatchLoggingOption) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/kinesisanalytics-2015-08-14/DeleteApplicationCloudWatchLoggingOption) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/kinesisanalytics-2015-08-14/DeleteApplicationCloudWatchLoggingOption) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/kinesisanalytics-2015-08-14/DeleteApplicationCloudWatchLoggingOption) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/kinesisanalytics-2015-08-14/DeleteApplicationCloudWatchLoggingOption) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/kinesisanalytics-2015-08-14/DeleteApplicationCloudWatchLoggingOption) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/kinesisanalytics-2015-08-14/DeleteApplicationCloudWatchLoggingOption) # DeleteApplicationInputProcessingConfiguration **Note** 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](/kinesisanalytics/latest/apiv2/Welcome.html). Deletes an [InputProcessingConfiguration](https://docs.aws.amazon.com/kinesisanalytics/latest/dev/API_InputProcessingConfiguration.html) from an input. ## Request Syntax ``` { "ApplicationName": "string", "CurrentApplicationVersionId": number, "InputId": "string" } ``` ## Request Parameters The request accepts the following data in JSON format. ** [ApplicationName](#API_DeleteApplicationInputProcessingConfiguration_RequestSyntax) ** The Kinesis Analytics application name. Type: String Length Constraints: Minimum length of 1. Maximum length of 128. Pattern: `[a-zA-Z0-9_.-]+` Required: Yes ** [CurrentApplicationVersionId](#API_DeleteApplicationInputProcessingConfiguration_RequestSyntax) ** The version ID of the Kinesis Analytics application. Type: Long Valid Range: Minimum value of 1. Maximum value of 999999999. Required: Yes ** [InputId](#API_DeleteApplicationInputProcessingConfiguration_RequestSyntax) ** 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](https://docs.aws.amazon.com/kinesisanalytics/latest/dev/API_DescribeApplication.html) operation. Type: String Length Constraints: Minimum length of 1. Maximum length of 50. Pattern: `[a-zA-Z0-9_.-]+` Required: Yes ## Response Elements If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body. ## Errors ** ConcurrentModificationException ** 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. ** message ** HTTP Status Code: 400 ** InvalidArgumentException ** Specified input parameter value is invalid. ** message ** HTTP Status Code: 400 ** ResourceInUseException ** Application is not available for this operation. ** message ** HTTP Status Code: 400 ** ResourceNotFoundException ** Specified application can't be found. ** message ** HTTP Status Code: 400 ** UnsupportedOperationException ** The request was rejected because a specified parameter is not supported or a specified resource is not valid for this operation. HTTP Status Code: 400 ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/kinesisanalytics-2015-08-14/DeleteApplicationInputProcessingConfiguration) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/kinesisanalytics-2015-08-14/DeleteApplicationInputProcessingConfiguration) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/kinesisanalytics-2015-08-14/DeleteApplicationInputProcessingConfiguration) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/kinesisanalytics-2015-08-14/DeleteApplicationInputProcessingConfiguration) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/kinesisanalytics-2015-08-14/DeleteApplicationInputProcessingConfiguration) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/kinesisanalytics-2015-08-14/DeleteApplicationInputProcessingConfiguration) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/kinesisanalytics-2015-08-14/DeleteApplicationInputProcessingConfiguration) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/kinesisanalytics-2015-08-14/DeleteApplicationInputProcessingConfiguration) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/kinesisanalytics-2015-08-14/DeleteApplicationInputProcessingConfiguration) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/kinesisanalytics-2015-08-14/DeleteApplicationInputProcessingConfiguration) # DeleteApplicationOutput **Note** 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](/kinesisanalytics/latest/apiv2/Welcome.html). 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. ## Request Syntax ``` { "ApplicationName": "string", "CurrentApplicationVersionId": number, "OutputId": "string" } ``` ## Request Parameters The request accepts the following data in JSON format. ** [ApplicationName](#API_DeleteApplicationOutput_RequestSyntax) ** Amazon Kinesis Analytics application name. Type: String Length Constraints: Minimum length of 1. Maximum length of 128. Pattern: `[a-zA-Z0-9_.-]+` Required: Yes ** [CurrentApplicationVersionId](#API_DeleteApplicationOutput_RequestSyntax) ** Amazon Kinesis Analytics application version. You can use the [DescribeApplication](https://docs.aws.amazon.com/kinesisanalytics/latest/dev/API_DescribeApplication.html) operation to get the current application version. If the version specified is not the current version, the `ConcurrentModificationException` is returned. Type: Long Valid Range: Minimum value of 1. Maximum value of 999999999. Required: Yes ** [OutputId](#API_DeleteApplicationOutput_RequestSyntax) ** 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](https://docs.aws.amazon.com/kinesisanalytics/latest/dev/API_AddApplicationOutput.html) 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](https://docs.aws.amazon.com/kinesisanalytics/latest/dev/API_DescribeApplication.html) operation to get the specific `OutputId`. Type: String Length Constraints: Minimum length of 1. Maximum length of 50. Pattern: `[a-zA-Z0-9_.-]+` Required: Yes ## Response Elements If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body. ## Errors ** ConcurrentModificationException ** 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. ** message ** HTTP Status Code: 400 ** InvalidArgumentException ** Specified input parameter value is invalid. ** message ** HTTP Status Code: 400 ** ResourceInUseException ** Application is not available for this operation. ** message ** HTTP Status Code: 400 ** ResourceNotFoundException ** Specified application can't be found. ** message ** HTTP Status Code: 400 ** UnsupportedOperationException ** The request was rejected because a specified parameter is not supported or a specified resource is not valid for this operation. HTTP Status Code: 400 ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/kinesisanalytics-2015-08-14/DeleteApplicationOutput) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/kinesisanalytics-2015-08-14/DeleteApplicationOutput) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/kinesisanalytics-2015-08-14/DeleteApplicationOutput) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/kinesisanalytics-2015-08-14/DeleteApplicationOutput) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/kinesisanalytics-2015-08-14/DeleteApplicationOutput) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/kinesisanalytics-2015-08-14/DeleteApplicationOutput) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/kinesisanalytics-2015-08-14/DeleteApplicationOutput) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/kinesisanalytics-2015-08-14/DeleteApplicationOutput) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/kinesisanalytics-2015-08-14/DeleteApplicationOutput) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/kinesisanalytics-2015-08-14/DeleteApplicationOutput) # DeleteApplicationReferenceDataSource **Note** 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](/kinesisanalytics/latest/apiv2/Welcome.html). 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](https://docs.aws.amazon.com/kinesisanalytics/latest/dev/API_AddApplicationReferenceDataSource.html) operation. This operation requires permissions to perform the `kinesisanalytics.DeleteApplicationReferenceDataSource` action. ## Request Syntax ``` { "ApplicationName": "string", "CurrentApplicationVersionId": number, "ReferenceId": "string" } ``` ## Request Parameters The request accepts the following data in JSON format. ** [ApplicationName](#API_DeleteApplicationReferenceDataSource_RequestSyntax) ** Name of an existing application. Type: String Length Constraints: Minimum length of 1. Maximum length of 128. Pattern: `[a-zA-Z0-9_.-]+` Required: Yes ** [CurrentApplicationVersionId](#API_DeleteApplicationReferenceDataSource_RequestSyntax) ** Version of the application. You can use the [DescribeApplication](https://docs.aws.amazon.com/kinesisanalytics/latest/dev/API_DescribeApplication.html) operation to get the current application version. If the version specified is not the current version, the `ConcurrentModificationException` is returned. Type: Long Valid Range: Minimum value of 1. Maximum value of 999999999. Required: Yes ** [ReferenceId](#API_DeleteApplicationReferenceDataSource_RequestSyntax) ** ID of the reference data source. When you add a reference data source to your application using the [AddApplicationReferenceDataSource](https://docs.aws.amazon.com/kinesisanalytics/latest/dev/API_AddApplicationReferenceDataSource.html), Amazon Kinesis Analytics assigns an ID. You can use the [DescribeApplication](https://docs.aws.amazon.com/kinesisanalytics/latest/dev/API_DescribeApplication.html) operation to get the reference ID. Type: String Length Constraints: Minimum length of 1. Maximum length of 50. Pattern: `[a-zA-Z0-9_.-]+` Required: Yes ## Response Elements If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body. ## Errors ** ConcurrentModificationException ** 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. ** message ** HTTP Status Code: 400 ** InvalidArgumentException ** Specified input parameter value is invalid. ** message ** HTTP Status Code: 400 ** ResourceInUseException ** Application is not available for this operation. ** message ** HTTP Status Code: 400 ** ResourceNotFoundException ** Specified application can't be found. ** message ** HTTP Status Code: 400 ** UnsupportedOperationException ** The request was rejected because a specified parameter is not supported or a specified resource is not valid for this operation. HTTP Status Code: 400 ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/kinesisanalytics-2015-08-14/DeleteApplicationReferenceDataSource) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/kinesisanalytics-2015-08-14/DeleteApplicationReferenceDataSource) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/kinesisanalytics-2015-08-14/DeleteApplicationReferenceDataSource) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/kinesisanalytics-2015-08-14/DeleteApplicationReferenceDataSource) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/kinesisanalytics-2015-08-14/DeleteApplicationReferenceDataSource) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/kinesisanalytics-2015-08-14/DeleteApplicationReferenceDataSource) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/kinesisanalytics-2015-08-14/DeleteApplicationReferenceDataSource) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/kinesisanalytics-2015-08-14/DeleteApplicationReferenceDataSource) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/kinesisanalytics-2015-08-14/DeleteApplicationReferenceDataSource) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/kinesisanalytics-2015-08-14/DeleteApplicationReferenceDataSource) # DescribeApplication **Note** 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](/kinesisanalytics/latest/apiv2/Welcome.html). 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](https://docs.aws.amazon.com/kinesisanalytics/latest/dev/API_ListApplications.html) 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`. ## Request Syntax ``` { "ApplicationName": "string" } ``` ## Request Parameters The request accepts the following data in JSON format. ** [ApplicationName](#API_DescribeApplication_RequestSyntax) ** Name of the application. Type: String Length Constraints: Minimum length of 1. Maximum length of 128. Pattern: `[a-zA-Z0-9_.-]+` Required: Yes ## Response Syntax ``` { "ApplicationDetail": { "ApplicationARN": "string", "ApplicationCode": "string", "ApplicationDescription": "string", "ApplicationName": "string", "ApplicationStatus": "string", "ApplicationVersionId": number, "CloudWatchLoggingOptionDescriptions": [ { "CloudWatchLoggingOptionId": "string", "LogStreamARN": "string", "RoleARN": "string" } ], "CreateTimestamp": number, "InputDescriptions": [ { "InAppStreamNames": [ "string" ], "InputId": "string", "InputParallelism": { "Count": number }, "InputProcessingConfigurationDescription": { "InputLambdaProcessorDescription": { "ResourceARN": "string", "RoleARN": "string" } }, "InputSchema": { "RecordColumns": [ { "Mapping": "string", "Name": "string", "SqlType": "string" } ], "RecordEncoding": "string", "RecordFormat": { "MappingParameters": { "CSVMappingParameters": { "RecordColumnDelimiter": "string", "RecordRowDelimiter": "string" }, "JSONMappingParameters": { "RecordRowPath": "string" } }, "RecordFormatType": "string" } }, "InputStartingPositionConfiguration": { "InputStartingPosition": "string" }, "KinesisFirehoseInputDescription": { "ResourceARN": "string", "RoleARN": "string" }, "KinesisStreamsInputDescription": { "ResourceARN": "string", "RoleARN": "string" }, "NamePrefix": "string" } ], "LastUpdateTimestamp": number, "OutputDescriptions": [ { "DestinationSchema": { "RecordFormatType": "string" }, "KinesisFirehoseOutputDescription": { "ResourceARN": "string", "RoleARN": "string" }, "KinesisStreamsOutputDescription": { "ResourceARN": "string", "RoleARN": "string" }, "LambdaOutputDescription": { "ResourceARN": "string", "RoleARN": "string" }, "Name": "string", "OutputId": "string" } ], "ReferenceDataSourceDescriptions": [ { "ReferenceId": "string", "ReferenceSchema": { "RecordColumns": [ { "Mapping": "string", "Name": "string", "SqlType": "string" } ], "RecordEncoding": "string", "RecordFormat": { "MappingParameters": { "CSVMappingParameters": { "RecordColumnDelimiter": "string", "RecordRowDelimiter": "string" }, "JSONMappingParameters": { "RecordRowPath": "string" } }, "RecordFormatType": "string" } }, "S3ReferenceDataSourceDescription": { "BucketARN": "string", "FileKey": "string", "ReferenceRoleARN": "string" }, "TableName": "string" } ] } } ``` ## Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. ** [ApplicationDetail](#API_DescribeApplication_ResponseSyntax) ** Provides a description of the application, such as the application Amazon Resource Name (ARN), status, latest version, and input and output configuration details. Type: [ApplicationDetail](API_ApplicationDetail.md) object ## Errors ** ResourceNotFoundException ** Specified application can't be found. ** message ** HTTP Status Code: 400 ** UnsupportedOperationException ** The request was rejected because a specified parameter is not supported or a specified resource is not valid for this operation. HTTP Status Code: 400 ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/kinesisanalytics-2015-08-14/DescribeApplication) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/kinesisanalytics-2015-08-14/DescribeApplication) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/kinesisanalytics-2015-08-14/DescribeApplication) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/kinesisanalytics-2015-08-14/DescribeApplication) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/kinesisanalytics-2015-08-14/DescribeApplication) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/kinesisanalytics-2015-08-14/DescribeApplication) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/kinesisanalytics-2015-08-14/DescribeApplication) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/kinesisanalytics-2015-08-14/DescribeApplication) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/kinesisanalytics-2015-08-14/DescribeApplication) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/kinesisanalytics-2015-08-14/DescribeApplication) # DiscoverInputSchema **Note** 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](/kinesisanalytics/latest/apiv2/Welcome.html). 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](https://docs.aws.amazon.com/kinesisanalytics/latest/dev/how-it-works-input.html). 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. ## Request Syntax ``` { "InputProcessingConfiguration": { "InputLambdaProcessor": { "ResourceARN": "string", "RoleARN": "string" } }, "InputStartingPositionConfiguration": { "InputStartingPosition": "string" }, "ResourceARN": "string", "RoleARN": "string", "S3Configuration": { "BucketARN": "string", "FileKey": "string", "RoleARN": "string" } } ``` ## Request Parameters The request accepts the following data in JSON format. ** [InputProcessingConfiguration](#API_DiscoverInputSchema_RequestSyntax) ** The [InputProcessingConfiguration](https://docs.aws.amazon.com/kinesisanalytics/latest/dev/API_InputProcessingConfiguration.html) to use to preprocess the records before discovering the schema of the records. Type: [InputProcessingConfiguration](API_InputProcessingConfiguration.md) object Required: No ** [InputStartingPositionConfiguration](#API_DiscoverInputSchema_RequestSyntax) ** Point at which you want Amazon Kinesis Analytics to start reading records from the specified streaming source discovery purposes. Type: [InputStartingPositionConfiguration](API_InputStartingPositionConfiguration.md) object Required: No ** [ResourceARN](#API_DiscoverInputSchema_RequestSyntax) ** Amazon Resource Name (ARN) of the streaming source. Type: String Length Constraints: Minimum length of 1. Maximum length of 2048. Pattern: `arn:.*` Required: No ** [RoleARN](#API_DiscoverInputSchema_RequestSyntax) ** ARN of the IAM role that Amazon Kinesis Analytics can assume to access the stream on your behalf. Type: String Length Constraints: Minimum length of 1. Maximum length of 2048. Pattern: `arn:.*` Required: No ** [S3Configuration](#API_DiscoverInputSchema_RequestSyntax) ** Specify this parameter to discover a schema from data in an Amazon S3 object. Type: [S3Configuration](API_S3Configuration.md) object Required: No ## Response Syntax ``` { "InputSchema": { "RecordColumns": [ { "Mapping": "string", "Name": "string", "SqlType": "string" } ], "RecordEncoding": "string", "RecordFormat": { "MappingParameters": { "CSVMappingParameters": { "RecordColumnDelimiter": "string", "RecordRowDelimiter": "string" }, "JSONMappingParameters": { "RecordRowPath": "string" } }, "RecordFormatType": "string" } }, "ParsedInputRecords": [ [ "string" ] ], "ProcessedInputRecords": [ "string" ], "RawInputRecords": [ "string" ] } ``` ## Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. ** [InputSchema](#API_DiscoverInputSchema_ResponseSyntax) ** 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. Type: [SourceSchema](API_SourceSchema.md) object ** [ParsedInputRecords](#API_DiscoverInputSchema_ResponseSyntax) ** An array of elements, where each element corresponds to a row in a stream record (a stream record can have more than one row). Type: Array of arrays of strings ** [ProcessedInputRecords](#API_DiscoverInputSchema_ResponseSyntax) ** Stream data that was modified by the processor specified in the `InputProcessingConfiguration` parameter. Type: Array of strings ** [RawInputRecords](#API_DiscoverInputSchema_ResponseSyntax) ** Raw stream data that was sampled to infer the schema. Type: Array of strings ## Errors ** InvalidArgumentException ** Specified input parameter value is invalid. ** message ** HTTP Status Code: 400 ** ResourceProvisionedThroughputExceededException ** Discovery failed to get a record from the streaming source because of the Amazon Kinesis Streams ProvisionedThroughputExceededException. For more information, see [GetRecords](https://docs.aws.amazon.com/kinesis/latest/APIReference/API_GetRecords.html) in the Amazon Kinesis Streams API Reference. HTTP Status Code: 400 ** ServiceUnavailableException ** The service is unavailable. Back off and retry the operation. HTTP Status Code: 500 ** UnableToDetectSchemaException ** Data format is not valid. Amazon Kinesis Analytics is not able to detect schema for the given streaming source. HTTP Status Code: 400 ** UnsupportedOperationException ** The request was rejected because a specified parameter is not supported or a specified resource is not valid for this operation. HTTP Status Code: 400 ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/kinesisanalytics-2015-08-14/DiscoverInputSchema) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/kinesisanalytics-2015-08-14/DiscoverInputSchema) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/kinesisanalytics-2015-08-14/DiscoverInputSchema) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/kinesisanalytics-2015-08-14/DiscoverInputSchema) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/kinesisanalytics-2015-08-14/DiscoverInputSchema) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/kinesisanalytics-2015-08-14/DiscoverInputSchema) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/kinesisanalytics-2015-08-14/DiscoverInputSchema) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/kinesisanalytics-2015-08-14/DiscoverInputSchema) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/kinesisanalytics-2015-08-14/DiscoverInputSchema) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/kinesisanalytics-2015-08-14/DiscoverInputSchema) # ListApplications **Note** 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](/kinesisanalytics/latest/apiv2/Welcome.html). 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](https://docs.aws.amazon.com/kinesisanalytics/latest/dev/API_DescribeApplication.html). This operation requires permissions to perform the `kinesisanalytics:ListApplications` action. ## Request Syntax ``` { "ExclusiveStartApplicationName": "string", "Limit": number } ``` ## Request Parameters The request accepts the following data in JSON format. ** [ExclusiveStartApplicationName](#API_ListApplications_RequestSyntax) ** 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. Type: String Length Constraints: Minimum length of 1. Maximum length of 128. Pattern: `[a-zA-Z0-9_.-]+` Required: No ** [Limit](#API_ListApplications_RequestSyntax) ** Maximum number of applications to list. Type: Integer Valid Range: Minimum value of 1. Maximum value of 50. Required: No ## Response Syntax ``` { "ApplicationSummaries": [ { "ApplicationARN": "string", "ApplicationName": "string", "ApplicationStatus": "string" } ], "HasMoreApplications": boolean } ``` ## Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. ** [ApplicationSummaries](#API_ListApplications_ResponseSyntax) ** List of `ApplicationSummary` objects. Type: Array of [ApplicationSummary](API_ApplicationSummary.md) objects ** [HasMoreApplications](#API_ListApplications_ResponseSyntax) ** Returns true if there are more applications to retrieve. Type: Boolean ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/kinesisanalytics-2015-08-14/ListApplications) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/kinesisanalytics-2015-08-14/ListApplications) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/kinesisanalytics-2015-08-14/ListApplications) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/kinesisanalytics-2015-08-14/ListApplications) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/kinesisanalytics-2015-08-14/ListApplications) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/kinesisanalytics-2015-08-14/ListApplications) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/kinesisanalytics-2015-08-14/ListApplications) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/kinesisanalytics-2015-08-14/ListApplications) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/kinesisanalytics-2015-08-14/ListApplications) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/kinesisanalytics-2015-08-14/ListApplications) # ListTagsForResource Retrieves the list of key-value tags assigned to the application. For more information, see [Using Tagging](https://docs.aws.amazon.com/kinesisanalytics/latest/dev/how-tagging.html). ## Request Syntax ``` { "ResourceARN": "string" } ``` ## Request Parameters The request accepts the following data in JSON format. ** [ResourceARN](#API_ListTagsForResource_RequestSyntax) ** The ARN of the application for which to retrieve tags. Type: String Length Constraints: Minimum length of 1. Maximum length of 2048. Pattern: `arn:.*` Required: Yes ## Response Syntax ``` { "Tags": [ { "Key": "string", "Value": "string" } ] } ``` ## Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. ** [Tags](#API_ListTagsForResource_ResponseSyntax) ** The key-value tags assigned to the application. Type: Array of [Tag](API_Tag.md) objects Array Members: Minimum number of 1 item. Maximum number of 200 items. ## Errors ** ConcurrentModificationException ** 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. ** message ** HTTP Status Code: 400 ** InvalidArgumentException ** Specified input parameter value is invalid. ** message ** HTTP Status Code: 400 ** ResourceNotFoundException ** Specified application can't be found. ** message ** HTTP Status Code: 400 ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/kinesisanalytics-2015-08-14/ListTagsForResource) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/kinesisanalytics-2015-08-14/ListTagsForResource) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/kinesisanalytics-2015-08-14/ListTagsForResource) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/kinesisanalytics-2015-08-14/ListTagsForResource) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/kinesisanalytics-2015-08-14/ListTagsForResource) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/kinesisanalytics-2015-08-14/ListTagsForResource) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/kinesisanalytics-2015-08-14/ListTagsForResource) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/kinesisanalytics-2015-08-14/ListTagsForResource) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/kinesisanalytics-2015-08-14/ListTagsForResource) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/kinesisanalytics-2015-08-14/ListTagsForResource) # StartApplication **Note** 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](/kinesisanalytics/latest/apiv2/Welcome.html). 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](https://docs.aws.amazon.com/kinesisanalytics/latest/dev/API_DescribeApplication.html) operation. After you start the application, you can stop the application from processing the input by calling the [StopApplication](https://docs.aws.amazon.com/kinesisanalytics/latest/dev/API_StopApplication.html) operation. This operation requires permissions to perform the `kinesisanalytics:StartApplication` action. ## Request Syntax ``` { "ApplicationName": "string", "InputConfigurations": [ { "Id": "string", "InputStartingPositionConfiguration": { "InputStartingPosition": "string" } } ] } ``` ## Request Parameters The request accepts the following data in JSON format. ** [ApplicationName](#API_StartApplication_RequestSyntax) ** Name of the application. Type: String Length Constraints: Minimum length of 1. Maximum length of 128. Pattern: `[a-zA-Z0-9_.-]+` Required: Yes ** [InputConfigurations](#API_StartApplication_RequestSyntax) ** 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. Type: Array of [InputConfiguration](API_InputConfiguration.md) objects Required: Yes ## Response Elements If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body. ## Errors ** InvalidApplicationConfigurationException ** User-provided application configuration is not valid. ** message ** test HTTP Status Code: 400 ** InvalidArgumentException ** Specified input parameter value is invalid. ** message ** HTTP Status Code: 400 ** ResourceInUseException ** Application is not available for this operation. ** message ** HTTP Status Code: 400 ** ResourceNotFoundException ** Specified application can't be found. ** message ** HTTP Status Code: 400 ** UnsupportedOperationException ** The request was rejected because a specified parameter is not supported or a specified resource is not valid for this operation. HTTP Status Code: 400 ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/kinesisanalytics-2015-08-14/StartApplication) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/kinesisanalytics-2015-08-14/StartApplication) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/kinesisanalytics-2015-08-14/StartApplication) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/kinesisanalytics-2015-08-14/StartApplication) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/kinesisanalytics-2015-08-14/StartApplication) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/kinesisanalytics-2015-08-14/StartApplication) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/kinesisanalytics-2015-08-14/StartApplication) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/kinesisanalytics-2015-08-14/StartApplication) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/kinesisanalytics-2015-08-14/StartApplication) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/kinesisanalytics-2015-08-14/StartApplication) # StopApplication **Note** 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](/kinesisanalytics/latest/apiv2/Welcome.html). 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](https://docs.aws.amazon.com/kinesisanalytics/latest/dev/API_DescribeApplication.html) 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. ## Request Syntax ``` { "ApplicationName": "string" } ``` ## Request Parameters The request accepts the following data in JSON format. ** [ApplicationName](#API_StopApplication_RequestSyntax) ** Name of the running application to stop. Type: String Length Constraints: Minimum length of 1. Maximum length of 128. Pattern: `[a-zA-Z0-9_.-]+` Required: Yes ## Response Elements If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body. ## Errors ** ResourceInUseException ** Application is not available for this operation. ** message ** HTTP Status Code: 400 ** ResourceNotFoundException ** Specified application can't be found. ** message ** HTTP Status Code: 400 ** UnsupportedOperationException ** The request was rejected because a specified parameter is not supported or a specified resource is not valid for this operation. HTTP Status Code: 400 ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/kinesisanalytics-2015-08-14/StopApplication) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/kinesisanalytics-2015-08-14/StopApplication) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/kinesisanalytics-2015-08-14/StopApplication) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/kinesisanalytics-2015-08-14/StopApplication) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/kinesisanalytics-2015-08-14/StopApplication) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/kinesisanalytics-2015-08-14/StopApplication) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/kinesisanalytics-2015-08-14/StopApplication) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/kinesisanalytics-2015-08-14/StopApplication) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/kinesisanalytics-2015-08-14/StopApplication) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/kinesisanalytics-2015-08-14/StopApplication) # TagResource 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](https://docs.aws.amazon.com/kinesisanalytics/latest/dev/how-tagging.html). ## Request Syntax ``` { "ResourceARN": "string", "Tags": [ { "Key": "string", "Value": "string" } ] } ``` ## Request Parameters The request accepts the following data in JSON format. ** [ResourceARN](#API_TagResource_RequestSyntax) ** The ARN of the application to assign the tags. Type: String Length Constraints: Minimum length of 1. Maximum length of 2048. Pattern: `arn:.*` Required: Yes ** [Tags](#API_TagResource_RequestSyntax) ** The key-value tags to assign to the application. Type: Array of [Tag](API_Tag.md) objects Array Members: Minimum number of 1 item. Maximum number of 200 items. Required: Yes ## Response Elements If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body. ## Errors ** ConcurrentModificationException ** 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. ** message ** HTTP Status Code: 400 ** InvalidArgumentException ** Specified input parameter value is invalid. ** message ** HTTP Status Code: 400 ** ResourceInUseException ** Application is not available for this operation. ** message ** HTTP Status Code: 400 ** ResourceNotFoundException ** Specified application can't be found. ** message ** HTTP Status Code: 400 ** TooManyTagsException ** 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. HTTP Status Code: 400 ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/kinesisanalytics-2015-08-14/TagResource) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/kinesisanalytics-2015-08-14/TagResource) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/kinesisanalytics-2015-08-14/TagResource) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/kinesisanalytics-2015-08-14/TagResource) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/kinesisanalytics-2015-08-14/TagResource) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/kinesisanalytics-2015-08-14/TagResource) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/kinesisanalytics-2015-08-14/TagResource) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/kinesisanalytics-2015-08-14/TagResource) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/kinesisanalytics-2015-08-14/TagResource) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/kinesisanalytics-2015-08-14/TagResource) # UntagResource Removes one or more tags from a Kinesis Analytics application. For more information, see [Using Tagging](https://docs.aws.amazon.com/kinesisanalytics/latest/dev/how-tagging.html). ## Request Syntax ``` { "ResourceARN": "string", "TagKeys": [ "string" ] } ``` ## Request Parameters The request accepts the following data in JSON format. ** [ResourceARN](#API_UntagResource_RequestSyntax) ** The ARN of the Kinesis Analytics application from which to remove the tags. Type: String Length Constraints: Minimum length of 1. Maximum length of 2048. Pattern: `arn:.*` Required: Yes ** [TagKeys](#API_UntagResource_RequestSyntax) ** A list of keys of tags to remove from the specified application. Type: Array of strings Array Members: Minimum number of 1 item. Maximum number of 200 items. Length Constraints: Minimum length of 1. Maximum length of 128. Required: Yes ## Response Elements If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body. ## Errors ** ConcurrentModificationException ** 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. ** message ** HTTP Status Code: 400 ** InvalidArgumentException ** Specified input parameter value is invalid. ** message ** HTTP Status Code: 400 ** ResourceInUseException ** Application is not available for this operation. ** message ** HTTP Status Code: 400 ** ResourceNotFoundException ** Specified application can't be found. ** message ** HTTP Status Code: 400 ** TooManyTagsException ** 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. HTTP Status Code: 400 ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/kinesisanalytics-2015-08-14/UntagResource) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/kinesisanalytics-2015-08-14/UntagResource) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/kinesisanalytics-2015-08-14/UntagResource) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/kinesisanalytics-2015-08-14/UntagResource) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/kinesisanalytics-2015-08-14/UntagResource) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/kinesisanalytics-2015-08-14/UntagResource) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/kinesisanalytics-2015-08-14/UntagResource) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/kinesisanalytics-2015-08-14/UntagResource) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/kinesisanalytics-2015-08-14/UntagResource) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/kinesisanalytics-2015-08-14/UntagResource) # UpdateApplication **Note** 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](/kinesisanalytics/latest/apiv2/Welcome.html). 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. ## Request Syntax ``` { "ApplicationName": "string", "ApplicationUpdate": { "ApplicationCodeUpdate": "string", "CloudWatchLoggingOptionUpdates": [ { "CloudWatchLoggingOptionId": "string", "LogStreamARNUpdate": "string", "RoleARNUpdate": "string" } ], "InputUpdates": [ { "InputId": "string", "InputParallelismUpdate": { "CountUpdate": number }, "InputProcessingConfigurationUpdate": { "InputLambdaProcessorUpdate": { "ResourceARNUpdate": "string", "RoleARNUpdate": "string" } }, "InputSchemaUpdate": { "RecordColumnUpdates": [ { "Mapping": "string", "Name": "string", "SqlType": "string" } ], "RecordEncodingUpdate": "string", "RecordFormatUpdate": { "MappingParameters": { "CSVMappingParameters": { "RecordColumnDelimiter": "string", "RecordRowDelimiter": "string" }, "JSONMappingParameters": { "RecordRowPath": "string" } }, "RecordFormatType": "string" } }, "KinesisFirehoseInputUpdate": { "ResourceARNUpdate": "string", "RoleARNUpdate": "string" }, "KinesisStreamsInputUpdate": { "ResourceARNUpdate": "string", "RoleARNUpdate": "string" }, "NamePrefixUpdate": "string" } ], "OutputUpdates": [ { "DestinationSchemaUpdate": { "RecordFormatType": "string" }, "KinesisFirehoseOutputUpdate": { "ResourceARNUpdate": "string", "RoleARNUpdate": "string" }, "KinesisStreamsOutputUpdate": { "ResourceARNUpdate": "string", "RoleARNUpdate": "string" }, "LambdaOutputUpdate": { "ResourceARNUpdate": "string", "RoleARNUpdate": "string" }, "NameUpdate": "string", "OutputId": "string" } ], "ReferenceDataSourceUpdates": [ { "ReferenceId": "string", "ReferenceSchemaUpdate": { "RecordColumns": [ { "Mapping": "string", "Name": "string", "SqlType": "string" } ], "RecordEncoding": "string", "RecordFormat": { "MappingParameters": { "CSVMappingParameters": { "RecordColumnDelimiter": "string", "RecordRowDelimiter": "string" }, "JSONMappingParameters": { "RecordRowPath": "string" } }, "RecordFormatType": "string" } }, "S3ReferenceDataSourceUpdate": { "BucketARNUpdate": "string", "FileKeyUpdate": "string", "ReferenceRoleARNUpdate": "string" }, "TableNameUpdate": "string" } ] }, "CurrentApplicationVersionId": number } ``` ## Request Parameters The request accepts the following data in JSON format. ** [ApplicationName](#API_UpdateApplication_RequestSyntax) ** Name of the Amazon Kinesis Analytics application to update. Type: String Length Constraints: Minimum length of 1. Maximum length of 128. Pattern: `[a-zA-Z0-9_.-]+` Required: Yes ** [ApplicationUpdate](#API_UpdateApplication_RequestSyntax) ** Describes application updates. Type: [ApplicationUpdate](API_ApplicationUpdate.md) object Required: Yes ** [CurrentApplicationVersionId](#API_UpdateApplication_RequestSyntax) ** The current application version ID. You can use the [DescribeApplication](https://docs.aws.amazon.com/kinesisanalytics/latest/dev/API_DescribeApplication.html) operation to get this value. Type: Long Valid Range: Minimum value of 1. Maximum value of 999999999. Required: Yes ## Response Elements If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body. ## Errors ** CodeValidationException ** User-provided application code (query) is invalid. This can be a simple syntax error. ** message ** Test HTTP Status Code: 400 ** ConcurrentModificationException ** 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. ** message ** HTTP Status Code: 400 ** InvalidArgumentException ** Specified input parameter value is invalid. ** message ** HTTP Status Code: 400 ** ResourceInUseException ** Application is not available for this operation. ** message ** HTTP Status Code: 400 ** ResourceNotFoundException ** Specified application can't be found. ** message ** HTTP Status Code: 400 ** UnsupportedOperationException ** The request was rejected because a specified parameter is not supported or a specified resource is not valid for this operation. HTTP Status Code: 400 ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/kinesisanalytics-2015-08-14/UpdateApplication) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/kinesisanalytics-2015-08-14/UpdateApplication) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/kinesisanalytics-2015-08-14/UpdateApplication) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/kinesisanalytics-2015-08-14/UpdateApplication) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/kinesisanalytics-2015-08-14/UpdateApplication) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/kinesisanalytics-2015-08-14/UpdateApplication) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/kinesisanalytics-2015-08-14/UpdateApplication) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/kinesisanalytics-2015-08-14/UpdateApplication) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/kinesisanalytics-2015-08-14/UpdateApplication) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/kinesisanalytics-2015-08-14/UpdateApplication)