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).

# API Reference
<a name="API_Reference"></a>

**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 Managed Service for Apache Flink API V2 Documentation](https://docs.aws.amazon.com//managed-flink/latest/apiv2/Welcome.html).

You can use the AWS CLI to explore the Amazon Kinesis Data Analytics API. This guide provides [Getting Started with Amazon Kinesis Data Analytics for SQL Applications](getting-started.md) exercises that use the AWS CLI.

**Topics**
+ [Actions](API_Operations.md)
+ [Data Types](API_Types.md)

# Actions
<a name="API_Operations"></a>

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
<a name="API_AddApplicationCloudWatchLoggingOption"></a>

**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
<a name="API_AddApplicationCloudWatchLoggingOption_RequestSyntax"></a>

```
{
   "ApplicationName": "string",
   "CloudWatchLoggingOption": { 
      "LogStreamARN": "string",
      "RoleARN": "string"
   },
   "CurrentApplicationVersionId": number
}
```

## Request Parameters
<a name="API_AddApplicationCloudWatchLoggingOption_RequestParameters"></a>

The request accepts the following data in JSON format.

 ** [ApplicationName](#API_AddApplicationCloudWatchLoggingOption_RequestSyntax) **   <a name="analytics-AddApplicationCloudWatchLoggingOption-request-ApplicationName"></a>
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) **   <a name="analytics-AddApplicationCloudWatchLoggingOption-request-CloudWatchLoggingOption"></a>
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) **   <a name="analytics-AddApplicationCloudWatchLoggingOption-request-CurrentApplicationVersionId"></a>
The version ID of the Kinesis Analytics application.  
Type: Long  
Valid Range: Minimum value of 1. Maximum value of 999999999.  
Required: Yes

## Response Elements
<a name="API_AddApplicationCloudWatchLoggingOption_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body.

## Errors
<a name="API_AddApplicationCloudWatchLoggingOption_Errors"></a>

 ** 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
<a name="API_AddApplicationCloudWatchLoggingOption_SeeAlso"></a>

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
<a name="API_AddApplicationInput"></a>

**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
<a name="API_AddApplicationInput_RequestSyntax"></a>

```
{
   "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
<a name="API_AddApplicationInput_RequestParameters"></a>

The request accepts the following data in JSON format.

 ** [ApplicationName](#API_AddApplicationInput_RequestSyntax) **   <a name="analytics-AddApplicationInput-request-ApplicationName"></a>
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) **   <a name="analytics-AddApplicationInput-request-CurrentApplicationVersionId"></a>
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) **   <a name="analytics-AddApplicationInput-request-Input"></a>
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
<a name="API_AddApplicationInput_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body.

## Errors
<a name="API_AddApplicationInput_Errors"></a>

 ** 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
<a name="API_AddApplicationInput_SeeAlso"></a>

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
<a name="API_AddApplicationInputProcessingConfiguration"></a>

**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
<a name="API_AddApplicationInputProcessingConfiguration_RequestSyntax"></a>

```
{
   "ApplicationName": "string",
   "CurrentApplicationVersionId": number,
   "InputId": "string",
   "InputProcessingConfiguration": { 
      "InputLambdaProcessor": { 
         "ResourceARN": "string",
         "RoleARN": "string"
      }
   }
}
```

## Request Parameters
<a name="API_AddApplicationInputProcessingConfiguration_RequestParameters"></a>

The request accepts the following data in JSON format.

 ** [ApplicationName](#API_AddApplicationInputProcessingConfiguration_RequestSyntax) **   <a name="analytics-AddApplicationInputProcessingConfiguration-request-ApplicationName"></a>
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) **   <a name="analytics-AddApplicationInputProcessingConfiguration-request-CurrentApplicationVersionId"></a>
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) **   <a name="analytics-AddApplicationInputProcessingConfiguration-request-InputId"></a>
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) **   <a name="analytics-AddApplicationInputProcessingConfiguration-request-InputProcessingConfiguration"></a>
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
<a name="API_AddApplicationInputProcessingConfiguration_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body.

## Errors
<a name="API_AddApplicationInputProcessingConfiguration_Errors"></a>

 ** 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
<a name="API_AddApplicationInputProcessingConfiguration_SeeAlso"></a>

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
<a name="API_AddApplicationOutput"></a>

**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
<a name="API_AddApplicationOutput_RequestSyntax"></a>

```
{
   "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
<a name="API_AddApplicationOutput_RequestParameters"></a>

The request accepts the following data in JSON format.

 ** [ApplicationName](#API_AddApplicationOutput_RequestSyntax) **   <a name="analytics-AddApplicationOutput-request-ApplicationName"></a>
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) **   <a name="analytics-AddApplicationOutput-request-CurrentApplicationVersionId"></a>
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) **   <a name="analytics-AddApplicationOutput-request-Output"></a>
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
<a name="API_AddApplicationOutput_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body.

## Errors
<a name="API_AddApplicationOutput_Errors"></a>

 ** 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
<a name="API_AddApplicationOutput_SeeAlso"></a>

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
<a name="API_AddApplicationReferenceDataSource"></a>

**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
<a name="API_AddApplicationReferenceDataSource_RequestSyntax"></a>

```
{
   "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
<a name="API_AddApplicationReferenceDataSource_RequestParameters"></a>

The request accepts the following data in JSON format.

 ** [ApplicationName](#API_AddApplicationReferenceDataSource_RequestSyntax) **   <a name="analytics-AddApplicationReferenceDataSource-request-ApplicationName"></a>
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) **   <a name="analytics-AddApplicationReferenceDataSource-request-CurrentApplicationVersionId"></a>
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) **   <a name="analytics-AddApplicationReferenceDataSource-request-ReferenceDataSource"></a>
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
<a name="API_AddApplicationReferenceDataSource_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body.

## Errors
<a name="API_AddApplicationReferenceDataSource_Errors"></a>

 ** 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
<a name="API_AddApplicationReferenceDataSource_SeeAlso"></a>

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
<a name="API_CreateApplication"></a>

**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
<a name="API_CreateApplication_RequestSyntax"></a>

```
{
   "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
<a name="API_CreateApplication_RequestParameters"></a>

The request accepts the following data in JSON format.

 ** [ApplicationCode](#API_CreateApplication_RequestSyntax) **   <a name="analytics-CreateApplication-request-ApplicationCode"></a>
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) **   <a name="analytics-CreateApplication-request-ApplicationDescription"></a>
Summary description of the application.  
Type: String  
Length Constraints: Minimum length of 0. Maximum length of 1024.  
Required: No

 ** [ApplicationName](#API_CreateApplication_RequestSyntax) **   <a name="analytics-CreateApplication-request-ApplicationName"></a>
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) **   <a name="analytics-CreateApplication-request-CloudWatchLoggingOptions"></a>
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) **   <a name="analytics-CreateApplication-request-Inputs"></a>
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) **   <a name="analytics-CreateApplication-request-Outputs"></a>
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 name="analytics-CreateApplication-request-Tags"></a>
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
<a name="API_CreateApplication_ResponseSyntax"></a>

```
{
   "ApplicationSummary": { 
      "ApplicationARN": "string",
      "ApplicationName": "string",
      "ApplicationStatus": "string"
   }
}
```

## Response Elements
<a name="API_CreateApplication_ResponseElements"></a>

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) **   <a name="analytics-CreateApplication-response-ApplicationSummary"></a>
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
<a name="API_CreateApplication_Errors"></a>

 ** 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
<a name="API_CreateApplication_SeeAlso"></a>

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
<a name="API_DeleteApplication"></a>

**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
<a name="API_DeleteApplication_RequestSyntax"></a>

```
{
   "ApplicationName": "string",
   "CreateTimestamp": number
}
```

## Request Parameters
<a name="API_DeleteApplication_RequestParameters"></a>

The request accepts the following data in JSON format.

 ** [ApplicationName](#API_DeleteApplication_RequestSyntax) **   <a name="analytics-DeleteApplication-request-ApplicationName"></a>
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) **   <a name="analytics-DeleteApplication-request-CreateTimestamp"></a>
 You can use the `DescribeApplication` operation to get this value.   
Type: Timestamp  
Required: Yes

## Response Elements
<a name="API_DeleteApplication_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body.

## Errors
<a name="API_DeleteApplication_Errors"></a>

 ** 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
<a name="API_DeleteApplication_SeeAlso"></a>

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
<a name="API_DeleteApplicationCloudWatchLoggingOption"></a>

**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
<a name="API_DeleteApplicationCloudWatchLoggingOption_RequestSyntax"></a>

```
{
   "ApplicationName": "string",
   "CloudWatchLoggingOptionId": "string",
   "CurrentApplicationVersionId": number
}
```

## Request Parameters
<a name="API_DeleteApplicationCloudWatchLoggingOption_RequestParameters"></a>

The request accepts the following data in JSON format.

 ** [ApplicationName](#API_DeleteApplicationCloudWatchLoggingOption_RequestSyntax) **   <a name="analytics-DeleteApplicationCloudWatchLoggingOption-request-ApplicationName"></a>
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) **   <a name="analytics-DeleteApplicationCloudWatchLoggingOption-request-CloudWatchLoggingOptionId"></a>
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) **   <a name="analytics-DeleteApplicationCloudWatchLoggingOption-request-CurrentApplicationVersionId"></a>
The version ID of the Kinesis Analytics application.  
Type: Long  
Valid Range: Minimum value of 1. Maximum value of 999999999.  
Required: Yes

## Response Elements
<a name="API_DeleteApplicationCloudWatchLoggingOption_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body.

## Errors
<a name="API_DeleteApplicationCloudWatchLoggingOption_Errors"></a>

 ** 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
<a name="API_DeleteApplicationCloudWatchLoggingOption_SeeAlso"></a>

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
<a name="API_DeleteApplicationInputProcessingConfiguration"></a>

**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
<a name="API_DeleteApplicationInputProcessingConfiguration_RequestSyntax"></a>

```
{
   "ApplicationName": "string",
   "CurrentApplicationVersionId": number,
   "InputId": "string"
}
```

## Request Parameters
<a name="API_DeleteApplicationInputProcessingConfiguration_RequestParameters"></a>

The request accepts the following data in JSON format.

 ** [ApplicationName](#API_DeleteApplicationInputProcessingConfiguration_RequestSyntax) **   <a name="analytics-DeleteApplicationInputProcessingConfiguration-request-ApplicationName"></a>
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) **   <a name="analytics-DeleteApplicationInputProcessingConfiguration-request-CurrentApplicationVersionId"></a>
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) **   <a name="analytics-DeleteApplicationInputProcessingConfiguration-request-InputId"></a>
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
<a name="API_DeleteApplicationInputProcessingConfiguration_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body.

## Errors
<a name="API_DeleteApplicationInputProcessingConfiguration_Errors"></a>

 ** 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
<a name="API_DeleteApplicationInputProcessingConfiguration_SeeAlso"></a>

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
<a name="API_DeleteApplicationOutput"></a>

**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
<a name="API_DeleteApplicationOutput_RequestSyntax"></a>

```
{
   "ApplicationName": "string",
   "CurrentApplicationVersionId": number,
   "OutputId": "string"
}
```

## Request Parameters
<a name="API_DeleteApplicationOutput_RequestParameters"></a>

The request accepts the following data in JSON format.

 ** [ApplicationName](#API_DeleteApplicationOutput_RequestSyntax) **   <a name="analytics-DeleteApplicationOutput-request-ApplicationName"></a>
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) **   <a name="analytics-DeleteApplicationOutput-request-CurrentApplicationVersionId"></a>
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) **   <a name="analytics-DeleteApplicationOutput-request-OutputId"></a>
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
<a name="API_DeleteApplicationOutput_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body.

## Errors
<a name="API_DeleteApplicationOutput_Errors"></a>

 ** 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
<a name="API_DeleteApplicationOutput_SeeAlso"></a>

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
<a name="API_DeleteApplicationReferenceDataSource"></a>

**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
<a name="API_DeleteApplicationReferenceDataSource_RequestSyntax"></a>

```
{
   "ApplicationName": "string",
   "CurrentApplicationVersionId": number,
   "ReferenceId": "string"
}
```

## Request Parameters
<a name="API_DeleteApplicationReferenceDataSource_RequestParameters"></a>

The request accepts the following data in JSON format.

 ** [ApplicationName](#API_DeleteApplicationReferenceDataSource_RequestSyntax) **   <a name="analytics-DeleteApplicationReferenceDataSource-request-ApplicationName"></a>
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) **   <a name="analytics-DeleteApplicationReferenceDataSource-request-CurrentApplicationVersionId"></a>
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) **   <a name="analytics-DeleteApplicationReferenceDataSource-request-ReferenceId"></a>
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
<a name="API_DeleteApplicationReferenceDataSource_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body.

## Errors
<a name="API_DeleteApplicationReferenceDataSource_Errors"></a>

 ** 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
<a name="API_DeleteApplicationReferenceDataSource_SeeAlso"></a>

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
<a name="API_DescribeApplication"></a>

**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
<a name="API_DescribeApplication_RequestSyntax"></a>

```
{
   "ApplicationName": "string"
}
```

## Request Parameters
<a name="API_DescribeApplication_RequestParameters"></a>

The request accepts the following data in JSON format.

 ** [ApplicationName](#API_DescribeApplication_RequestSyntax) **   <a name="analytics-DescribeApplication-request-ApplicationName"></a>
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
<a name="API_DescribeApplication_ResponseSyntax"></a>

```
{
   "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
<a name="API_DescribeApplication_ResponseElements"></a>

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) **   <a name="analytics-DescribeApplication-response-ApplicationDetail"></a>
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
<a name="API_DescribeApplication_Errors"></a>

 ** 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
<a name="API_DescribeApplication_SeeAlso"></a>

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
<a name="API_DiscoverInputSchema"></a>

**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
<a name="API_DiscoverInputSchema_RequestSyntax"></a>

```
{
   "InputProcessingConfiguration": { 
      "InputLambdaProcessor": { 
         "ResourceARN": "string",
         "RoleARN": "string"
      }
   },
   "InputStartingPositionConfiguration": { 
      "InputStartingPosition": "string"
   },
   "ResourceARN": "string",
   "RoleARN": "string",
   "S3Configuration": { 
      "BucketARN": "string",
      "FileKey": "string",
      "RoleARN": "string"
   }
}
```

## Request Parameters
<a name="API_DiscoverInputSchema_RequestParameters"></a>

The request accepts the following data in JSON format.

 ** [InputProcessingConfiguration](#API_DiscoverInputSchema_RequestSyntax) **   <a name="analytics-DiscoverInputSchema-request-InputProcessingConfiguration"></a>
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) **   <a name="analytics-DiscoverInputSchema-request-InputStartingPositionConfiguration"></a>
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) **   <a name="analytics-DiscoverInputSchema-request-ResourceARN"></a>
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) **   <a name="analytics-DiscoverInputSchema-request-RoleARN"></a>
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) **   <a name="analytics-DiscoverInputSchema-request-S3Configuration"></a>
Specify this parameter to discover a schema from data in an Amazon S3 object.  
Type: [S3Configuration](API_S3Configuration.md) object  
Required: No

## Response Syntax
<a name="API_DiscoverInputSchema_ResponseSyntax"></a>

```
{
   "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
<a name="API_DiscoverInputSchema_ResponseElements"></a>

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) **   <a name="analytics-DiscoverInputSchema-response-InputSchema"></a>
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) **   <a name="analytics-DiscoverInputSchema-response-ParsedInputRecords"></a>
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) **   <a name="analytics-DiscoverInputSchema-response-ProcessedInputRecords"></a>
Stream data that was modified by the processor specified in the `InputProcessingConfiguration` parameter.  
Type: Array of strings

 ** [RawInputRecords](#API_DiscoverInputSchema_ResponseSyntax) **   <a name="analytics-DiscoverInputSchema-response-RawInputRecords"></a>
Raw stream data that was sampled to infer the schema.  
Type: Array of strings

## Errors
<a name="API_DiscoverInputSchema_Errors"></a>

 ** 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
<a name="API_DiscoverInputSchema_SeeAlso"></a>

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
<a name="API_ListApplications"></a>

**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
<a name="API_ListApplications_RequestSyntax"></a>

```
{
   "ExclusiveStartApplicationName": "string",
   "Limit": number
}
```

## Request Parameters
<a name="API_ListApplications_RequestParameters"></a>

The request accepts the following data in JSON format.

 ** [ExclusiveStartApplicationName](#API_ListApplications_RequestSyntax) **   <a name="analytics-ListApplications-request-ExclusiveStartApplicationName"></a>
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) **   <a name="analytics-ListApplications-request-Limit"></a>
Maximum number of applications to list.  
Type: Integer  
Valid Range: Minimum value of 1. Maximum value of 50.  
Required: No

## Response Syntax
<a name="API_ListApplications_ResponseSyntax"></a>

```
{
   "ApplicationSummaries": [ 
      { 
         "ApplicationARN": "string",
         "ApplicationName": "string",
         "ApplicationStatus": "string"
      }
   ],
   "HasMoreApplications": boolean
}
```

## Response Elements
<a name="API_ListApplications_ResponseElements"></a>

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) **   <a name="analytics-ListApplications-response-ApplicationSummaries"></a>
List of `ApplicationSummary` objects.   
Type: Array of [ApplicationSummary](API_ApplicationSummary.md) objects

 ** [HasMoreApplications](#API_ListApplications_ResponseSyntax) **   <a name="analytics-ListApplications-response-HasMoreApplications"></a>
Returns true if there are more applications to retrieve.  
Type: Boolean

## See Also
<a name="API_ListApplications_SeeAlso"></a>

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
<a name="API_ListTagsForResource"></a>

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
<a name="API_ListTagsForResource_RequestSyntax"></a>

```
{
   "ResourceARN": "string"
}
```

## Request Parameters
<a name="API_ListTagsForResource_RequestParameters"></a>

The request accepts the following data in JSON format.

 ** [ResourceARN](#API_ListTagsForResource_RequestSyntax) **   <a name="analytics-ListTagsForResource-request-ResourceARN"></a>
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
<a name="API_ListTagsForResource_ResponseSyntax"></a>

```
{
   "Tags": [ 
      { 
         "Key": "string",
         "Value": "string"
      }
   ]
}
```

## Response Elements
<a name="API_ListTagsForResource_ResponseElements"></a>

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) **   <a name="analytics-ListTagsForResource-response-Tags"></a>
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
<a name="API_ListTagsForResource_Errors"></a>

 ** 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
<a name="API_ListTagsForResource_SeeAlso"></a>

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
<a name="API_StartApplication"></a>

**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
<a name="API_StartApplication_RequestSyntax"></a>

```
{
   "ApplicationName": "string",
   "InputConfigurations": [ 
      { 
         "Id": "string",
         "InputStartingPositionConfiguration": { 
            "InputStartingPosition": "string"
         }
      }
   ]
}
```

## Request Parameters
<a name="API_StartApplication_RequestParameters"></a>

The request accepts the following data in JSON format.

 ** [ApplicationName](#API_StartApplication_RequestSyntax) **   <a name="analytics-StartApplication-request-ApplicationName"></a>
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) **   <a name="analytics-StartApplication-request-InputConfigurations"></a>
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
<a name="API_StartApplication_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body.

## Errors
<a name="API_StartApplication_Errors"></a>

 ** 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
<a name="API_StartApplication_SeeAlso"></a>

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
<a name="API_StopApplication"></a>

**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
<a name="API_StopApplication_RequestSyntax"></a>

```
{
   "ApplicationName": "string"
}
```

## Request Parameters
<a name="API_StopApplication_RequestParameters"></a>

The request accepts the following data in JSON format.

 ** [ApplicationName](#API_StopApplication_RequestSyntax) **   <a name="analytics-StopApplication-request-ApplicationName"></a>
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
<a name="API_StopApplication_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body.

## Errors
<a name="API_StopApplication_Errors"></a>

 ** 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
<a name="API_StopApplication_SeeAlso"></a>

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
<a name="API_TagResource"></a>

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
<a name="API_TagResource_RequestSyntax"></a>

```
{
   "ResourceARN": "string",
   "Tags": [ 
      { 
         "Key": "string",
         "Value": "string"
      }
   ]
}
```

## Request Parameters
<a name="API_TagResource_RequestParameters"></a>

The request accepts the following data in JSON format.

 ** [ResourceARN](#API_TagResource_RequestSyntax) **   <a name="analytics-TagResource-request-ResourceARN"></a>
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) **   <a name="analytics-TagResource-request-Tags"></a>
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
<a name="API_TagResource_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body.

## Errors
<a name="API_TagResource_Errors"></a>

 ** 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
<a name="API_TagResource_SeeAlso"></a>

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
<a name="API_UntagResource"></a>

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
<a name="API_UntagResource_RequestSyntax"></a>

```
{
   "ResourceARN": "string",
   "TagKeys": [ "string" ]
}
```

## Request Parameters
<a name="API_UntagResource_RequestParameters"></a>

The request accepts the following data in JSON format.

 ** [ResourceARN](#API_UntagResource_RequestSyntax) **   <a name="analytics-UntagResource-request-ResourceARN"></a>
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 name="analytics-UntagResource-request-TagKeys"></a>
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
<a name="API_UntagResource_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body.

## Errors
<a name="API_UntagResource_Errors"></a>

 ** 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
<a name="API_UntagResource_SeeAlso"></a>

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
<a name="API_UpdateApplication"></a>

**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
<a name="API_UpdateApplication_RequestSyntax"></a>

```
{
   "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
<a name="API_UpdateApplication_RequestParameters"></a>

The request accepts the following data in JSON format.

 ** [ApplicationName](#API_UpdateApplication_RequestSyntax) **   <a name="analytics-UpdateApplication-request-ApplicationName"></a>
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) **   <a name="analytics-UpdateApplication-request-ApplicationUpdate"></a>
Describes application updates.  
Type: [ApplicationUpdate](API_ApplicationUpdate.md) object  
Required: Yes

 ** [CurrentApplicationVersionId](#API_UpdateApplication_RequestSyntax) **   <a name="analytics-UpdateApplication-request-CurrentApplicationVersionId"></a>
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
<a name="API_UpdateApplication_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body.

## Errors
<a name="API_UpdateApplication_Errors"></a>

 ** 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
<a name="API_UpdateApplication_SeeAlso"></a>

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) 

# Data Types
<a name="API_Types"></a>

The following data types are supported:
+  [ApplicationDetail](API_ApplicationDetail.md) 
+  [ApplicationSummary](API_ApplicationSummary.md) 
+  [ApplicationUpdate](API_ApplicationUpdate.md) 
+  [CloudWatchLoggingOption](API_CloudWatchLoggingOption.md) 
+  [CloudWatchLoggingOptionDescription](API_CloudWatchLoggingOptionDescription.md) 
+  [CloudWatchLoggingOptionUpdate](API_CloudWatchLoggingOptionUpdate.md) 
+  [CSVMappingParameters](API_CSVMappingParameters.md) 
+  [DestinationSchema](API_DestinationSchema.md) 
+  [Input](API_Input.md) 
+  [InputConfiguration](API_InputConfiguration.md) 
+  [InputDescription](API_InputDescription.md) 
+  [InputLambdaProcessor](API_InputLambdaProcessor.md) 
+  [InputLambdaProcessorDescription](API_InputLambdaProcessorDescription.md) 
+  [InputLambdaProcessorUpdate](API_InputLambdaProcessorUpdate.md) 
+  [InputParallelism](API_InputParallelism.md) 
+  [InputParallelismUpdate](API_InputParallelismUpdate.md) 
+  [InputProcessingConfiguration](API_InputProcessingConfiguration.md) 
+  [InputProcessingConfigurationDescription](API_InputProcessingConfigurationDescription.md) 
+  [InputProcessingConfigurationUpdate](API_InputProcessingConfigurationUpdate.md) 
+  [InputSchemaUpdate](API_InputSchemaUpdate.md) 
+  [InputStartingPositionConfiguration](API_InputStartingPositionConfiguration.md) 
+  [InputUpdate](API_InputUpdate.md) 
+  [JSONMappingParameters](API_JSONMappingParameters.md) 
+  [KinesisFirehoseInput](API_KinesisFirehoseInput.md) 
+  [KinesisFirehoseInputDescription](API_KinesisFirehoseInputDescription.md) 
+  [KinesisFirehoseInputUpdate](API_KinesisFirehoseInputUpdate.md) 
+  [KinesisFirehoseOutput](API_KinesisFirehoseOutput.md) 
+  [KinesisFirehoseOutputDescription](API_KinesisFirehoseOutputDescription.md) 
+  [KinesisFirehoseOutputUpdate](API_KinesisFirehoseOutputUpdate.md) 
+  [KinesisStreamsInput](API_KinesisStreamsInput.md) 
+  [KinesisStreamsInputDescription](API_KinesisStreamsInputDescription.md) 
+  [KinesisStreamsInputUpdate](API_KinesisStreamsInputUpdate.md) 
+  [KinesisStreamsOutput](API_KinesisStreamsOutput.md) 
+  [KinesisStreamsOutputDescription](API_KinesisStreamsOutputDescription.md) 
+  [KinesisStreamsOutputUpdate](API_KinesisStreamsOutputUpdate.md) 
+  [LambdaOutput](API_LambdaOutput.md) 
+  [LambdaOutputDescription](API_LambdaOutputDescription.md) 
+  [LambdaOutputUpdate](API_LambdaOutputUpdate.md) 
+  [MappingParameters](API_MappingParameters.md) 
+  [Output](API_Output.md) 
+  [OutputDescription](API_OutputDescription.md) 
+  [OutputUpdate](API_OutputUpdate.md) 
+  [RecordColumn](API_RecordColumn.md) 
+  [RecordFormat](API_RecordFormat.md) 
+  [ReferenceDataSource](API_ReferenceDataSource.md) 
+  [ReferenceDataSourceDescription](API_ReferenceDataSourceDescription.md) 
+  [ReferenceDataSourceUpdate](API_ReferenceDataSourceUpdate.md) 
+  [S3Configuration](API_S3Configuration.md) 
+  [S3ReferenceDataSource](API_S3ReferenceDataSource.md) 
+  [S3ReferenceDataSourceDescription](API_S3ReferenceDataSourceDescription.md) 
+  [S3ReferenceDataSourceUpdate](API_S3ReferenceDataSourceUpdate.md) 
+  [SourceSchema](API_SourceSchema.md) 
+  [Tag](API_Tag.md) 

# ApplicationDetail
<a name="API_ApplicationDetail"></a>

**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).

Provides a description of the application, including the application Amazon Resource Name (ARN), status, latest version, and input and output configuration.

## Contents
<a name="API_ApplicationDetail_Contents"></a>

 ** ApplicationARN **   <a name="analytics-Type-ApplicationDetail-ApplicationARN"></a>
ARN of the application.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 2048.  
Pattern: `arn:.*`   
Required: Yes

 ** ApplicationName **   <a name="analytics-Type-ApplicationDetail-ApplicationName"></a>
Name of the application.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 128.  
Pattern: `[a-zA-Z0-9_.-]+`   
Required: Yes

 ** ApplicationStatus **   <a name="analytics-Type-ApplicationDetail-ApplicationStatus"></a>
Status of the application.  
Type: String  
Valid Values: `DELETING | STARTING | STOPPING | READY | RUNNING | UPDATING | AUTOSCALING`   
Required: Yes

 ** ApplicationVersionId **   <a name="analytics-Type-ApplicationDetail-ApplicationVersionId"></a>
Provides the current application version.  
Type: Long  
Valid Range: Minimum value of 1. Maximum value of 999999999.  
Required: Yes

 ** ApplicationCode **   <a name="analytics-Type-ApplicationDetail-ApplicationCode"></a>
Returns the application code that you provided to perform data analysis on any of the in-application streams in your application.  
Type: String  
Length Constraints: Minimum length of 0. Maximum length of 102400.  
Required: No

 ** ApplicationDescription **   <a name="analytics-Type-ApplicationDetail-ApplicationDescription"></a>
Description of the application.  
Type: String  
Length Constraints: Minimum length of 0. Maximum length of 1024.  
Required: No

 ** CloudWatchLoggingOptionDescriptions **   <a name="analytics-Type-ApplicationDetail-CloudWatchLoggingOptionDescriptions"></a>
Describes the CloudWatch log streams that are configured to receive application messages. For more information about using CloudWatch log streams with Amazon Kinesis Analytics applications, see [Working with Amazon CloudWatch Logs](https://docs.aws.amazon.com/kinesisanalytics/latest/dev/cloudwatch-logs.html).   
Type: Array of [CloudWatchLoggingOptionDescription](API_CloudWatchLoggingOptionDescription.md) objects  
Required: No

 ** CreateTimestamp **   <a name="analytics-Type-ApplicationDetail-CreateTimestamp"></a>
Time stamp when the application version was created.  
Type: Timestamp  
Required: No

 ** InputDescriptions **   <a name="analytics-Type-ApplicationDetail-InputDescriptions"></a>
Describes the application input configuration. For more information, see [Configuring Application Input](https://docs.aws.amazon.com/kinesisanalytics/latest/dev/how-it-works-input.html).   
Type: Array of [InputDescription](API_InputDescription.md) objects  
Required: No

 ** LastUpdateTimestamp **   <a name="analytics-Type-ApplicationDetail-LastUpdateTimestamp"></a>
Time stamp when the application was last updated.  
Type: Timestamp  
Required: No

 ** OutputDescriptions **   <a name="analytics-Type-ApplicationDetail-OutputDescriptions"></a>
Describes the application output configuration. For more information, see [Configuring Application Output](https://docs.aws.amazon.com/kinesisanalytics/latest/dev/how-it-works-output.html).   
Type: Array of [OutputDescription](API_OutputDescription.md) objects  
Required: No

 ** ReferenceDataSourceDescriptions **   <a name="analytics-Type-ApplicationDetail-ReferenceDataSourceDescriptions"></a>
Describes reference data sources configured for the application. For more information, see [Configuring Application Input](https://docs.aws.amazon.com/kinesisanalytics/latest/dev/how-it-works-input.html).   
Type: Array of [ReferenceDataSourceDescription](API_ReferenceDataSourceDescription.md) objects  
Required: No

## See Also
<a name="API_ApplicationDetail_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/kinesisanalytics-2015-08-14/ApplicationDetail) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/kinesisanalytics-2015-08-14/ApplicationDetail) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/kinesisanalytics-2015-08-14/ApplicationDetail) 

# ApplicationSummary
<a name="API_ApplicationSummary"></a>

**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).

Provides application summary information, including the application Amazon Resource Name (ARN), name, and status.

## Contents
<a name="API_ApplicationSummary_Contents"></a>

 ** ApplicationARN **   <a name="analytics-Type-ApplicationSummary-ApplicationARN"></a>
ARN of the application.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 2048.  
Pattern: `arn:.*`   
Required: Yes

 ** ApplicationName **   <a name="analytics-Type-ApplicationSummary-ApplicationName"></a>
Name of the application.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 128.  
Pattern: `[a-zA-Z0-9_.-]+`   
Required: Yes

 ** ApplicationStatus **   <a name="analytics-Type-ApplicationSummary-ApplicationStatus"></a>
Status of the application.  
Type: String  
Valid Values: `DELETING | STARTING | STOPPING | READY | RUNNING | UPDATING | AUTOSCALING`   
Required: Yes

## See Also
<a name="API_ApplicationSummary_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/kinesisanalytics-2015-08-14/ApplicationSummary) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/kinesisanalytics-2015-08-14/ApplicationSummary) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/kinesisanalytics-2015-08-14/ApplicationSummary) 

# ApplicationUpdate
<a name="API_ApplicationUpdate"></a>

Describes updates to apply to an existing Amazon Kinesis Analytics application.

## Contents
<a name="API_ApplicationUpdate_Contents"></a>

 ** ApplicationCodeUpdate **   <a name="analytics-Type-ApplicationUpdate-ApplicationCodeUpdate"></a>
Describes application code updates.  
Type: String  
Length Constraints: Minimum length of 0. Maximum length of 102400.  
Required: No

 ** CloudWatchLoggingOptionUpdates **   <a name="analytics-Type-ApplicationUpdate-CloudWatchLoggingOptionUpdates"></a>
Describes application CloudWatch logging option updates.  
Type: Array of [CloudWatchLoggingOptionUpdate](API_CloudWatchLoggingOptionUpdate.md) objects  
Required: No

 ** InputUpdates **   <a name="analytics-Type-ApplicationUpdate-InputUpdates"></a>
Describes application input configuration updates.  
Type: Array of [InputUpdate](API_InputUpdate.md) objects  
Required: No

 ** OutputUpdates **   <a name="analytics-Type-ApplicationUpdate-OutputUpdates"></a>
Describes application output configuration updates.  
Type: Array of [OutputUpdate](API_OutputUpdate.md) objects  
Required: No

 ** ReferenceDataSourceUpdates **   <a name="analytics-Type-ApplicationUpdate-ReferenceDataSourceUpdates"></a>
Describes application reference data source updates.  
Type: Array of [ReferenceDataSourceUpdate](API_ReferenceDataSourceUpdate.md) objects  
Required: No

## See Also
<a name="API_ApplicationUpdate_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/kinesisanalytics-2015-08-14/ApplicationUpdate) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/kinesisanalytics-2015-08-14/ApplicationUpdate) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/kinesisanalytics-2015-08-14/ApplicationUpdate) 

# CloudWatchLoggingOption
<a name="API_CloudWatchLoggingOption"></a>

Provides a description of CloudWatch logging options, including the log stream Amazon Resource Name (ARN) and the role ARN.

## Contents
<a name="API_CloudWatchLoggingOption_Contents"></a>

 ** LogStreamARN **   <a name="analytics-Type-CloudWatchLoggingOption-LogStreamARN"></a>
ARN of the CloudWatch log to receive application messages.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 2048.  
Pattern: `arn:.*`   
Required: Yes

 ** RoleARN **   <a name="analytics-Type-CloudWatchLoggingOption-RoleARN"></a>
IAM ARN of the role to use to send application messages. Note: To write application messages to CloudWatch, the IAM role that is used must have the `PutLogEvents` policy action enabled.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 2048.  
Pattern: `arn:.*`   
Required: Yes

## See Also
<a name="API_CloudWatchLoggingOption_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/kinesisanalytics-2015-08-14/CloudWatchLoggingOption) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/kinesisanalytics-2015-08-14/CloudWatchLoggingOption) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/kinesisanalytics-2015-08-14/CloudWatchLoggingOption) 

# CloudWatchLoggingOptionDescription
<a name="API_CloudWatchLoggingOptionDescription"></a>

Description of the CloudWatch logging option.

## Contents
<a name="API_CloudWatchLoggingOptionDescription_Contents"></a>

 ** LogStreamARN **   <a name="analytics-Type-CloudWatchLoggingOptionDescription-LogStreamARN"></a>
ARN of the CloudWatch log to receive application messages.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 2048.  
Pattern: `arn:.*`   
Required: Yes

 ** RoleARN **   <a name="analytics-Type-CloudWatchLoggingOptionDescription-RoleARN"></a>
IAM ARN of the role to use to send application messages. Note: To write application messages to CloudWatch, the IAM role used must have the `PutLogEvents` policy action enabled.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 2048.  
Pattern: `arn:.*`   
Required: Yes

 ** CloudWatchLoggingOptionId **   <a name="analytics-Type-CloudWatchLoggingOptionDescription-CloudWatchLoggingOptionId"></a>
ID of the CloudWatch logging option description.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 50.  
Pattern: `[a-zA-Z0-9_.-]+`   
Required: No

## See Also
<a name="API_CloudWatchLoggingOptionDescription_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/kinesisanalytics-2015-08-14/CloudWatchLoggingOptionDescription) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/kinesisanalytics-2015-08-14/CloudWatchLoggingOptionDescription) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/kinesisanalytics-2015-08-14/CloudWatchLoggingOptionDescription) 

# CloudWatchLoggingOptionUpdate
<a name="API_CloudWatchLoggingOptionUpdate"></a>

Describes CloudWatch logging option updates.

## Contents
<a name="API_CloudWatchLoggingOptionUpdate_Contents"></a>

 ** CloudWatchLoggingOptionId **   <a name="analytics-Type-CloudWatchLoggingOptionUpdate-CloudWatchLoggingOptionId"></a>
ID of the CloudWatch logging option to update  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 50.  
Pattern: `[a-zA-Z0-9_.-]+`   
Required: Yes

 ** LogStreamARNUpdate **   <a name="analytics-Type-CloudWatchLoggingOptionUpdate-LogStreamARNUpdate"></a>
ARN of the CloudWatch log to receive application messages.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 2048.  
Pattern: `arn:.*`   
Required: No

 ** RoleARNUpdate **   <a name="analytics-Type-CloudWatchLoggingOptionUpdate-RoleARNUpdate"></a>
IAM ARN of the role to use to send application messages. Note: To write application messages to CloudWatch, the IAM role used must have the `PutLogEvents` policy action enabled.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 2048.  
Pattern: `arn:.*`   
Required: No

## See Also
<a name="API_CloudWatchLoggingOptionUpdate_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/kinesisanalytics-2015-08-14/CloudWatchLoggingOptionUpdate) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/kinesisanalytics-2015-08-14/CloudWatchLoggingOptionUpdate) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/kinesisanalytics-2015-08-14/CloudWatchLoggingOptionUpdate) 

# CSVMappingParameters
<a name="API_CSVMappingParameters"></a>

Provides additional mapping information when the record format uses delimiters, such as CSV. For example, the following sample records use CSV format, where the records use the *'\$1n'* as the row delimiter and a comma (",") as the column delimiter: 

 `"name1", "address1"` 

 `"name2", "address2"` 

## Contents
<a name="API_CSVMappingParameters_Contents"></a>

 ** RecordColumnDelimiter **   <a name="analytics-Type-CSVMappingParameters-RecordColumnDelimiter"></a>
Column delimiter. For example, in a CSV format, a comma (",") is the typical column delimiter.  
Type: String  
Length Constraints: Minimum length of 1.  
Required: Yes

 ** RecordRowDelimiter **   <a name="analytics-Type-CSVMappingParameters-RecordRowDelimiter"></a>
Row delimiter. For example, in a CSV format, *'\$1n'* is the typical row delimiter.  
Type: String  
Length Constraints: Minimum length of 1.  
Required: Yes

## See Also
<a name="API_CSVMappingParameters_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/kinesisanalytics-2015-08-14/CSVMappingParameters) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/kinesisanalytics-2015-08-14/CSVMappingParameters) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/kinesisanalytics-2015-08-14/CSVMappingParameters) 

# DestinationSchema
<a name="API_DestinationSchema"></a>

Describes the data format when records are written to the destination. For more information, see [Configuring Application Output](https://docs.aws.amazon.com/kinesisanalytics/latest/dev/how-it-works-output.html). 

## Contents
<a name="API_DestinationSchema_Contents"></a>

 ** RecordFormatType **   <a name="analytics-Type-DestinationSchema-RecordFormatType"></a>
Specifies the format of the records on the output stream.  
Type: String  
Valid Values: `JSON | CSV`   
Required: Yes

## See Also
<a name="API_DestinationSchema_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/kinesisanalytics-2015-08-14/DestinationSchema) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/kinesisanalytics-2015-08-14/DestinationSchema) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/kinesisanalytics-2015-08-14/DestinationSchema) 

# Input
<a name="API_Input"></a>

When you configure the application input, you specify the streaming source, the in-application stream name that is created, and the mapping between the two. For more information, see [Configuring Application Input](https://docs.aws.amazon.com/kinesisanalytics/latest/dev/how-it-works-input.html). 

## Contents
<a name="API_Input_Contents"></a>

 ** InputSchema **   <a name="analytics-Type-Input-InputSchema"></a>
Describes the format of the data in the streaming source, and how each data element maps to corresponding columns in the in-application stream that is being created.  
Also used to describe the format of the reference data source.  
Type: [SourceSchema](API_SourceSchema.md) object  
Required: Yes

 ** NamePrefix **   <a name="analytics-Type-Input-NamePrefix"></a>
Name prefix to use when creating an in-application stream. Suppose that you specify a prefix "MyInApplicationStream." Amazon Kinesis Analytics then creates one or more (as per the `InputParallelism` count you specified) in-application streams with names "MyInApplicationStream\$1001," "MyInApplicationStream\$1002," and so on.   
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 32.  
Required: Yes

 ** InputParallelism **   <a name="analytics-Type-Input-InputParallelism"></a>
Describes the number of in-application streams to create.   
Data from your source is routed to these in-application input streams.  
 (see [Configuring Application Input](https://docs.aws.amazon.com/kinesisanalytics/latest/dev/how-it-works-input.html).  
Type: [InputParallelism](API_InputParallelism.md) object  
Required: No

 ** InputProcessingConfiguration **   <a name="analytics-Type-Input-InputProcessingConfiguration"></a>
The [InputProcessingConfiguration](https://docs.aws.amazon.com/kinesisanalytics/latest/dev/API_InputProcessingConfiguration.html) for the input. An input processor transforms records as they are received from the stream, before the application's SQL code executes. Currently, the only input processing configuration available is [InputLambdaProcessor](https://docs.aws.amazon.com/kinesisanalytics/latest/dev/API_InputLambdaProcessor.html).  
Type: [InputProcessingConfiguration](API_InputProcessingConfiguration.md) object  
Required: No

 ** KinesisFirehoseInput **   <a name="analytics-Type-Input-KinesisFirehoseInput"></a>
If the streaming source is an Amazon Kinesis Firehose delivery stream, identifies the delivery stream's ARN and an IAM role that enables Amazon Kinesis Analytics to access the stream on your behalf.  
Note: Either `KinesisStreamsInput` or `KinesisFirehoseInput` is required.  
Type: [KinesisFirehoseInput](API_KinesisFirehoseInput.md) object  
Required: No

 ** KinesisStreamsInput **   <a name="analytics-Type-Input-KinesisStreamsInput"></a>
If the streaming source is an Amazon Kinesis stream, identifies the stream's Amazon Resource Name (ARN) and an IAM role that enables Amazon Kinesis Analytics to access the stream on your behalf.  
Note: Either `KinesisStreamsInput` or `KinesisFirehoseInput` is required.  
Type: [KinesisStreamsInput](API_KinesisStreamsInput.md) object  
Required: No

## See Also
<a name="API_Input_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/kinesisanalytics-2015-08-14/Input) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/kinesisanalytics-2015-08-14/Input) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/kinesisanalytics-2015-08-14/Input) 

# InputConfiguration
<a name="API_InputConfiguration"></a>

When you start your application, you provide this configuration, which identifies the input source and the point in the input source at which you want the application to start processing records.

## Contents
<a name="API_InputConfiguration_Contents"></a>

 ** Id **   <a name="analytics-Type-InputConfiguration-Id"></a>
Input source ID. You can get this ID by calling 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

 ** InputStartingPositionConfiguration **   <a name="analytics-Type-InputConfiguration-InputStartingPositionConfiguration"></a>
Point at which you want the application to start processing records from the streaming source.  
Type: [InputStartingPositionConfiguration](API_InputStartingPositionConfiguration.md) object  
Required: Yes

## See Also
<a name="API_InputConfiguration_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/kinesisanalytics-2015-08-14/InputConfiguration) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/kinesisanalytics-2015-08-14/InputConfiguration) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/kinesisanalytics-2015-08-14/InputConfiguration) 

# InputDescription
<a name="API_InputDescription"></a>

Describes the application input configuration. For more information, see [Configuring Application Input](https://docs.aws.amazon.com/kinesisanalytics/latest/dev/how-it-works-input.html). 

## Contents
<a name="API_InputDescription_Contents"></a>

 ** InAppStreamNames **   <a name="analytics-Type-InputDescription-InAppStreamNames"></a>
Returns the in-application stream names that are mapped to the stream source.  
Type: Array of strings  
Length Constraints: Minimum length of 1. Maximum length of 32.  
Required: No

 ** InputId **   <a name="analytics-Type-InputDescription-InputId"></a>
Input ID associated with the application input. This is the ID that Amazon Kinesis Analytics assigns to each input configuration you add to your application.   
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 50.  
Pattern: `[a-zA-Z0-9_.-]+`   
Required: No

 ** InputParallelism **   <a name="analytics-Type-InputDescription-InputParallelism"></a>
Describes the configured parallelism (number of in-application streams mapped to the streaming source).  
Type: [InputParallelism](API_InputParallelism.md) object  
Required: No

 ** InputProcessingConfigurationDescription **   <a name="analytics-Type-InputDescription-InputProcessingConfigurationDescription"></a>
The description of the preprocessor that executes on records in this input before the application's code is run.  
Type: [InputProcessingConfigurationDescription](API_InputProcessingConfigurationDescription.md) object  
Required: No

 ** InputSchema **   <a name="analytics-Type-InputDescription-InputSchema"></a>
Describes the format of the data in the streaming source, and how each data element maps to corresponding columns in the in-application stream that is being created.   
Type: [SourceSchema](API_SourceSchema.md) object  
Required: No

 ** InputStartingPositionConfiguration **   <a name="analytics-Type-InputDescription-InputStartingPositionConfiguration"></a>
Point at which the application is configured to read from the input stream.  
Type: [InputStartingPositionConfiguration](API_InputStartingPositionConfiguration.md) object  
Required: No

 ** KinesisFirehoseInputDescription **   <a name="analytics-Type-InputDescription-KinesisFirehoseInputDescription"></a>
If an Amazon Kinesis Firehose delivery stream is configured as a streaming source, provides the delivery stream's ARN and an IAM role that enables Amazon Kinesis Analytics to access the stream on your behalf.  
Type: [KinesisFirehoseInputDescription](API_KinesisFirehoseInputDescription.md) object  
Required: No

 ** KinesisStreamsInputDescription **   <a name="analytics-Type-InputDescription-KinesisStreamsInputDescription"></a>
If an Amazon Kinesis stream is configured as streaming source, provides Amazon Kinesis stream's Amazon Resource Name (ARN) and an IAM role that enables Amazon Kinesis Analytics to access the stream on your behalf.  
Type: [KinesisStreamsInputDescription](API_KinesisStreamsInputDescription.md) object  
Required: No

 ** NamePrefix **   <a name="analytics-Type-InputDescription-NamePrefix"></a>
In-application name prefix.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 32.  
Required: No

## See Also
<a name="API_InputDescription_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/kinesisanalytics-2015-08-14/InputDescription) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/kinesisanalytics-2015-08-14/InputDescription) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/kinesisanalytics-2015-08-14/InputDescription) 

# InputLambdaProcessor
<a name="API_InputLambdaProcessor"></a>

An object that contains the Amazon Resource Name (ARN) of the [AWS Lambda](https://docs.aws.amazon.com/lambda/) function that is used to preprocess records in the stream, and the ARN of the IAM role that is used to access the AWS Lambda function. 

## Contents
<a name="API_InputLambdaProcessor_Contents"></a>

 ** ResourceARN **   <a name="analytics-Type-InputLambdaProcessor-ResourceARN"></a>
The ARN of the [AWS Lambda](https://docs.aws.amazon.com/lambda/) function that operates on records in the stream.  
To specify an earlier version of the Lambda function than the latest, include the Lambda function version in the Lambda function ARN. For more information about Lambda ARNs, see [Example ARNs: AWS Lambda](/general/latest/gr/aws-arns-and-namespaces.html#arn-syntax-lambda) 
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 2048.  
Pattern: `arn:.*`   
Required: Yes

 ** RoleARN **   <a name="analytics-Type-InputLambdaProcessor-RoleARN"></a>
The ARN of the IAM role that is used to access the AWS Lambda function.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 2048.  
Pattern: `arn:.*`   
Required: Yes

## See Also
<a name="API_InputLambdaProcessor_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/kinesisanalytics-2015-08-14/InputLambdaProcessor) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/kinesisanalytics-2015-08-14/InputLambdaProcessor) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/kinesisanalytics-2015-08-14/InputLambdaProcessor) 

# InputLambdaProcessorDescription
<a name="API_InputLambdaProcessorDescription"></a>

An object that contains the Amazon Resource Name (ARN) of the [AWS Lambda](https://docs.aws.amazon.com/lambda/) function that is used to preprocess records in the stream, and the ARN of the IAM role that is used to access the AWS Lambda expression.

## Contents
<a name="API_InputLambdaProcessorDescription_Contents"></a>

 ** ResourceARN **   <a name="analytics-Type-InputLambdaProcessorDescription-ResourceARN"></a>
The ARN of the [AWS Lambda](https://docs.aws.amazon.com/lambda/) function that is used to preprocess the records in the stream.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 2048.  
Pattern: `arn:.*`   
Required: No

 ** RoleARN **   <a name="analytics-Type-InputLambdaProcessorDescription-RoleARN"></a>
The ARN of the IAM role that is used to access the AWS Lambda function.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 2048.  
Pattern: `arn:.*`   
Required: No

## See Also
<a name="API_InputLambdaProcessorDescription_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/kinesisanalytics-2015-08-14/InputLambdaProcessorDescription) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/kinesisanalytics-2015-08-14/InputLambdaProcessorDescription) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/kinesisanalytics-2015-08-14/InputLambdaProcessorDescription) 

# InputLambdaProcessorUpdate
<a name="API_InputLambdaProcessorUpdate"></a>

Represents an update to the [InputLambdaProcessor](https://docs.aws.amazon.com/kinesisanalytics/latest/dev/API_InputLambdaProcessor.html) that is used to preprocess the records in the stream.

## Contents
<a name="API_InputLambdaProcessorUpdate_Contents"></a>

 ** ResourceARNUpdate **   <a name="analytics-Type-InputLambdaProcessorUpdate-ResourceARNUpdate"></a>
The Amazon Resource Name (ARN) of the new [AWS Lambda](https://docs.aws.amazon.com/lambda/) function that is used to preprocess the records in the stream.  
To specify an earlier version of the Lambda function than the latest, include the Lambda function version in the Lambda function ARN. For more information about Lambda ARNs, see [Example ARNs: AWS Lambda](/general/latest/gr/aws-arns-and-namespaces.html#arn-syntax-lambda) 
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 2048.  
Pattern: `arn:.*`   
Required: No

 ** RoleARNUpdate **   <a name="analytics-Type-InputLambdaProcessorUpdate-RoleARNUpdate"></a>
The ARN of the new IAM role that is used to access the AWS Lambda function.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 2048.  
Pattern: `arn:.*`   
Required: No

## See Also
<a name="API_InputLambdaProcessorUpdate_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/kinesisanalytics-2015-08-14/InputLambdaProcessorUpdate) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/kinesisanalytics-2015-08-14/InputLambdaProcessorUpdate) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/kinesisanalytics-2015-08-14/InputLambdaProcessorUpdate) 

# InputParallelism
<a name="API_InputParallelism"></a>

Describes the number of in-application streams to create for a given streaming source. For information about parallelism, see [Configuring Application Input](https://docs.aws.amazon.com/kinesisanalytics/latest/dev/how-it-works-input.html). 

## Contents
<a name="API_InputParallelism_Contents"></a>

 ** Count **   <a name="analytics-Type-InputParallelism-Count"></a>
Number of in-application streams to create. For more information, see [Limits](https://docs.aws.amazon.com/kinesisanalytics/latest/dev/limits.html).   
Type: Integer  
Valid Range: Minimum value of 1. Maximum value of 64.  
Required: No

## See Also
<a name="API_InputParallelism_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/kinesisanalytics-2015-08-14/InputParallelism) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/kinesisanalytics-2015-08-14/InputParallelism) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/kinesisanalytics-2015-08-14/InputParallelism) 

# InputParallelismUpdate
<a name="API_InputParallelismUpdate"></a>

Provides updates to the parallelism count.

## Contents
<a name="API_InputParallelismUpdate_Contents"></a>

 ** CountUpdate **   <a name="analytics-Type-InputParallelismUpdate-CountUpdate"></a>
Number of in-application streams to create for the specified streaming source.  
Type: Integer  
Valid Range: Minimum value of 1. Maximum value of 64.  
Required: No

## See Also
<a name="API_InputParallelismUpdate_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/kinesisanalytics-2015-08-14/InputParallelismUpdate) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/kinesisanalytics-2015-08-14/InputParallelismUpdate) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/kinesisanalytics-2015-08-14/InputParallelismUpdate) 

# InputProcessingConfiguration
<a name="API_InputProcessingConfiguration"></a>

Provides a description of a processor that is used to preprocess the records in the stream before being processed by your application code. Currently, the only input processor available is [AWS Lambda](https://docs.aws.amazon.com/lambda/).

## Contents
<a name="API_InputProcessingConfiguration_Contents"></a>

 ** InputLambdaProcessor **   <a name="analytics-Type-InputProcessingConfiguration-InputLambdaProcessor"></a>
The [InputLambdaProcessor](https://docs.aws.amazon.com/kinesisanalytics/latest/dev/API_InputLambdaProcessor.html) that is used to preprocess the records in the stream before being processed by your application code.  
Type: [InputLambdaProcessor](API_InputLambdaProcessor.md) object  
Required: Yes

## See Also
<a name="API_InputProcessingConfiguration_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/kinesisanalytics-2015-08-14/InputProcessingConfiguration) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/kinesisanalytics-2015-08-14/InputProcessingConfiguration) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/kinesisanalytics-2015-08-14/InputProcessingConfiguration) 

# InputProcessingConfigurationDescription
<a name="API_InputProcessingConfigurationDescription"></a>

Provides configuration information about an input processor. Currently, the only input processor available is [AWS Lambda](https://docs.aws.amazon.com/lambda/).

## Contents
<a name="API_InputProcessingConfigurationDescription_Contents"></a>

 ** InputLambdaProcessorDescription **   <a name="analytics-Type-InputProcessingConfigurationDescription-InputLambdaProcessorDescription"></a>
Provides configuration information about the associated [InputLambdaProcessorDescription](https://docs.aws.amazon.com/kinesisanalytics/latest/dev/API_InputLambdaProcessorDescription.html).  
Type: [InputLambdaProcessorDescription](API_InputLambdaProcessorDescription.md) object  
Required: No

## See Also
<a name="API_InputProcessingConfigurationDescription_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/kinesisanalytics-2015-08-14/InputProcessingConfigurationDescription) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/kinesisanalytics-2015-08-14/InputProcessingConfigurationDescription) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/kinesisanalytics-2015-08-14/InputProcessingConfigurationDescription) 

# InputProcessingConfigurationUpdate
<a name="API_InputProcessingConfigurationUpdate"></a>

Describes updates to an [InputProcessingConfiguration](https://docs.aws.amazon.com/kinesisanalytics/latest/dev/API_InputProcessingConfiguration.html). 

## Contents
<a name="API_InputProcessingConfigurationUpdate_Contents"></a>

 ** InputLambdaProcessorUpdate **   <a name="analytics-Type-InputProcessingConfigurationUpdate-InputLambdaProcessorUpdate"></a>
Provides update information for an [InputLambdaProcessor](https://docs.aws.amazon.com/kinesisanalytics/latest/dev/API_InputLambdaProcessor.html).  
Type: [InputLambdaProcessorUpdate](API_InputLambdaProcessorUpdate.md) object  
Required: Yes

## See Also
<a name="API_InputProcessingConfigurationUpdate_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/kinesisanalytics-2015-08-14/InputProcessingConfigurationUpdate) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/kinesisanalytics-2015-08-14/InputProcessingConfigurationUpdate) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/kinesisanalytics-2015-08-14/InputProcessingConfigurationUpdate) 

# InputSchemaUpdate
<a name="API_InputSchemaUpdate"></a>

Describes updates for the application's input schema.

## Contents
<a name="API_InputSchemaUpdate_Contents"></a>

 ** RecordColumnUpdates **   <a name="analytics-Type-InputSchemaUpdate-RecordColumnUpdates"></a>
A list of `RecordColumn` objects. Each object describes the mapping of the streaming source element to the corresponding column in the in-application stream.   
Type: Array of [RecordColumn](API_RecordColumn.md) objects  
Array Members: Minimum number of 1 item. Maximum number of 1000 items.  
Required: No

 ** RecordEncodingUpdate **   <a name="analytics-Type-InputSchemaUpdate-RecordEncodingUpdate"></a>
Specifies the encoding of the records in the streaming source. For example, UTF-8.  
Type: String  
Pattern: `UTF-8`   
Required: No

 ** RecordFormatUpdate **   <a name="analytics-Type-InputSchemaUpdate-RecordFormatUpdate"></a>
Specifies the format of the records on the streaming source.  
Type: [RecordFormat](API_RecordFormat.md) object  
Required: No

## See Also
<a name="API_InputSchemaUpdate_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/kinesisanalytics-2015-08-14/InputSchemaUpdate) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/kinesisanalytics-2015-08-14/InputSchemaUpdate) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/kinesisanalytics-2015-08-14/InputSchemaUpdate) 

# InputStartingPositionConfiguration
<a name="API_InputStartingPositionConfiguration"></a>

Describes the point at which the application reads from the streaming source.

## Contents
<a name="API_InputStartingPositionConfiguration_Contents"></a>

 ** InputStartingPosition **   <a name="analytics-Type-InputStartingPositionConfiguration-InputStartingPosition"></a>
The starting position on the stream.  
+  `NOW` - Start reading just after the most recent record in the stream, start at the request time stamp that the customer issued.
+  `TRIM_HORIZON` - Start reading at the last untrimmed record in the stream, which is the oldest record available in the stream. This option is not available for an Amazon Kinesis Firehose delivery stream.
+  `LAST_STOPPED_POINT` - Resume reading from where the application last stopped reading.
Type: String  
Valid Values: `NOW | TRIM_HORIZON | LAST_STOPPED_POINT`   
Required: No

## See Also
<a name="API_InputStartingPositionConfiguration_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/kinesisanalytics-2015-08-14/InputStartingPositionConfiguration) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/kinesisanalytics-2015-08-14/InputStartingPositionConfiguration) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/kinesisanalytics-2015-08-14/InputStartingPositionConfiguration) 

# InputUpdate
<a name="API_InputUpdate"></a>

Describes updates to a specific input configuration (identified by the `InputId` of an application). 

## Contents
<a name="API_InputUpdate_Contents"></a>

 ** InputId **   <a name="analytics-Type-InputUpdate-InputId"></a>
Input ID of the application input to be updated.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 50.  
Pattern: `[a-zA-Z0-9_.-]+`   
Required: Yes

 ** InputParallelismUpdate **   <a name="analytics-Type-InputUpdate-InputParallelismUpdate"></a>
Describes the parallelism updates (the number in-application streams Amazon Kinesis Analytics creates for the specific streaming source).  
Type: [InputParallelismUpdate](API_InputParallelismUpdate.md) object  
Required: No

 ** InputProcessingConfigurationUpdate **   <a name="analytics-Type-InputUpdate-InputProcessingConfigurationUpdate"></a>
Describes updates for an input processing configuration.  
Type: [InputProcessingConfigurationUpdate](API_InputProcessingConfigurationUpdate.md) object  
Required: No

 ** InputSchemaUpdate **   <a name="analytics-Type-InputUpdate-InputSchemaUpdate"></a>
Describes the data format on the streaming source, and how record elements on the streaming source map to columns of the in-application stream that is created.  
Type: [InputSchemaUpdate](API_InputSchemaUpdate.md) object  
Required: No

 ** KinesisFirehoseInputUpdate **   <a name="analytics-Type-InputUpdate-KinesisFirehoseInputUpdate"></a>
If an Amazon Kinesis Firehose delivery stream is the streaming source to be updated, provides an updated stream ARN and IAM role ARN.  
Type: [KinesisFirehoseInputUpdate](API_KinesisFirehoseInputUpdate.md) object  
Required: No

 ** KinesisStreamsInputUpdate **   <a name="analytics-Type-InputUpdate-KinesisStreamsInputUpdate"></a>
If an Amazon Kinesis stream is the streaming source to be updated, provides an updated stream Amazon Resource Name (ARN) and IAM role ARN.  
Type: [KinesisStreamsInputUpdate](API_KinesisStreamsInputUpdate.md) object  
Required: No

 ** NamePrefixUpdate **   <a name="analytics-Type-InputUpdate-NamePrefixUpdate"></a>
Name prefix for in-application streams that Amazon Kinesis Analytics creates for the specific streaming source.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 32.  
Required: No

## See Also
<a name="API_InputUpdate_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/kinesisanalytics-2015-08-14/InputUpdate) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/kinesisanalytics-2015-08-14/InputUpdate) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/kinesisanalytics-2015-08-14/InputUpdate) 

# JSONMappingParameters
<a name="API_JSONMappingParameters"></a>

Provides additional mapping information when JSON is the record format on the streaming source.

## Contents
<a name="API_JSONMappingParameters_Contents"></a>

 ** RecordRowPath **   <a name="analytics-Type-JSONMappingParameters-RecordRowPath"></a>
Path to the top-level parent that contains the records.  
Type: String  
Length Constraints: Minimum length of 1.  
Required: Yes

## See Also
<a name="API_JSONMappingParameters_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/kinesisanalytics-2015-08-14/JSONMappingParameters) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/kinesisanalytics-2015-08-14/JSONMappingParameters) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/kinesisanalytics-2015-08-14/JSONMappingParameters) 

# KinesisFirehoseInput
<a name="API_KinesisFirehoseInput"></a>

 Identifies an Amazon Kinesis Firehose delivery stream as the streaming source. You provide the delivery stream's Amazon Resource Name (ARN) and an IAM role ARN that enables Amazon Kinesis Analytics to access the stream on your behalf.

## Contents
<a name="API_KinesisFirehoseInput_Contents"></a>

 ** ResourceARN **   <a name="analytics-Type-KinesisFirehoseInput-ResourceARN"></a>
ARN of the input delivery stream.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 2048.  
Pattern: `arn:.*`   
Required: Yes

 ** RoleARN **   <a name="analytics-Type-KinesisFirehoseInput-RoleARN"></a>
ARN of the IAM role that Amazon Kinesis Analytics can assume to access the stream on your behalf. You need to make sure that the role has the necessary permissions to access the stream.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 2048.  
Pattern: `arn:.*`   
Required: Yes

## See Also
<a name="API_KinesisFirehoseInput_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/kinesisanalytics-2015-08-14/KinesisFirehoseInput) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/kinesisanalytics-2015-08-14/KinesisFirehoseInput) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/kinesisanalytics-2015-08-14/KinesisFirehoseInput) 

# KinesisFirehoseInputDescription
<a name="API_KinesisFirehoseInputDescription"></a>

 Describes the Amazon Kinesis Firehose delivery stream that is configured as the streaming source in the application input configuration. 

## Contents
<a name="API_KinesisFirehoseInputDescription_Contents"></a>

 ** ResourceARN **   <a name="analytics-Type-KinesisFirehoseInputDescription-ResourceARN"></a>
Amazon Resource Name (ARN) of the Amazon Kinesis Firehose delivery stream.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 2048.  
Pattern: `arn:.*`   
Required: No

 ** RoleARN **   <a name="analytics-Type-KinesisFirehoseInputDescription-RoleARN"></a>
ARN of the IAM role that Amazon Kinesis Analytics assumes to access the stream.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 2048.  
Pattern: `arn:.*`   
Required: No

## See Also
<a name="API_KinesisFirehoseInputDescription_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/kinesisanalytics-2015-08-14/KinesisFirehoseInputDescription) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/kinesisanalytics-2015-08-14/KinesisFirehoseInputDescription) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/kinesisanalytics-2015-08-14/KinesisFirehoseInputDescription) 

# KinesisFirehoseInputUpdate
<a name="API_KinesisFirehoseInputUpdate"></a>

When updating application input configuration, provides information about an Amazon Kinesis Firehose delivery stream as the streaming source.

## Contents
<a name="API_KinesisFirehoseInputUpdate_Contents"></a>

 ** ResourceARNUpdate **   <a name="analytics-Type-KinesisFirehoseInputUpdate-ResourceARNUpdate"></a>
Amazon Resource Name (ARN) of the input Amazon Kinesis Firehose delivery stream to read.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 2048.  
Pattern: `arn:.*`   
Required: No

 ** RoleARNUpdate **   <a name="analytics-Type-KinesisFirehoseInputUpdate-RoleARNUpdate"></a>
ARN of the IAM role that Amazon Kinesis Analytics can assume to access the stream on your behalf. You need to grant the necessary permissions to this role.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 2048.  
Pattern: `arn:.*`   
Required: No

## See Also
<a name="API_KinesisFirehoseInputUpdate_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/kinesisanalytics-2015-08-14/KinesisFirehoseInputUpdate) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/kinesisanalytics-2015-08-14/KinesisFirehoseInputUpdate) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/kinesisanalytics-2015-08-14/KinesisFirehoseInputUpdate) 

# KinesisFirehoseOutput
<a name="API_KinesisFirehoseOutput"></a>

When configuring application output, identifies an Amazon Kinesis Firehose delivery stream as the destination. You provide the stream Amazon Resource Name (ARN) and an IAM role that enables Amazon Kinesis Analytics to write to the stream on your behalf.

## Contents
<a name="API_KinesisFirehoseOutput_Contents"></a>

 ** ResourceARN **   <a name="analytics-Type-KinesisFirehoseOutput-ResourceARN"></a>
ARN of the destination Amazon Kinesis Firehose delivery stream to write to.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 2048.  
Pattern: `arn:.*`   
Required: Yes

 ** RoleARN **   <a name="analytics-Type-KinesisFirehoseOutput-RoleARN"></a>
ARN of the IAM role that Amazon Kinesis Analytics can assume to write to the destination stream on your behalf. You need to grant the necessary permissions to this role.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 2048.  
Pattern: `arn:.*`   
Required: Yes

## See Also
<a name="API_KinesisFirehoseOutput_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/kinesisanalytics-2015-08-14/KinesisFirehoseOutput) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/kinesisanalytics-2015-08-14/KinesisFirehoseOutput) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/kinesisanalytics-2015-08-14/KinesisFirehoseOutput) 

# KinesisFirehoseOutputDescription
<a name="API_KinesisFirehoseOutputDescription"></a>

 For an application output, describes the Amazon Kinesis Firehose delivery stream configured as its destination. 

## Contents
<a name="API_KinesisFirehoseOutputDescription_Contents"></a>

 ** ResourceARN **   <a name="analytics-Type-KinesisFirehoseOutputDescription-ResourceARN"></a>
Amazon Resource Name (ARN) of the Amazon Kinesis Firehose delivery stream.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 2048.  
Pattern: `arn:.*`   
Required: No

 ** RoleARN **   <a name="analytics-Type-KinesisFirehoseOutputDescription-RoleARN"></a>
ARN of the IAM role that Amazon Kinesis Analytics can assume to access the stream.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 2048.  
Pattern: `arn:.*`   
Required: No

## See Also
<a name="API_KinesisFirehoseOutputDescription_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/kinesisanalytics-2015-08-14/KinesisFirehoseOutputDescription) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/kinesisanalytics-2015-08-14/KinesisFirehoseOutputDescription) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/kinesisanalytics-2015-08-14/KinesisFirehoseOutputDescription) 

# KinesisFirehoseOutputUpdate
<a name="API_KinesisFirehoseOutputUpdate"></a>

 When updating an output configuration using the [UpdateApplication](https://docs.aws.amazon.com/kinesisanalytics/latest/dev/API_UpdateApplication.html) operation, provides information about an Amazon Kinesis Firehose delivery stream configured as the destination. 

## Contents
<a name="API_KinesisFirehoseOutputUpdate_Contents"></a>

 ** ResourceARNUpdate **   <a name="analytics-Type-KinesisFirehoseOutputUpdate-ResourceARNUpdate"></a>
Amazon Resource Name (ARN) of the Amazon Kinesis Firehose delivery stream to write to.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 2048.  
Pattern: `arn:.*`   
Required: No

 ** RoleARNUpdate **   <a name="analytics-Type-KinesisFirehoseOutputUpdate-RoleARNUpdate"></a>
ARN of the IAM role that Amazon Kinesis Analytics can assume to access the stream on your behalf. You need to grant the necessary permissions to this role.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 2048.  
Pattern: `arn:.*`   
Required: No

## See Also
<a name="API_KinesisFirehoseOutputUpdate_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/kinesisanalytics-2015-08-14/KinesisFirehoseOutputUpdate) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/kinesisanalytics-2015-08-14/KinesisFirehoseOutputUpdate) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/kinesisanalytics-2015-08-14/KinesisFirehoseOutputUpdate) 

# KinesisStreamsInput
<a name="API_KinesisStreamsInput"></a>

 Identifies an Amazon Kinesis stream as the streaming source. You provide the stream's Amazon Resource Name (ARN) and an IAM role ARN that enables Amazon Kinesis Analytics to access the stream on your behalf.

## Contents
<a name="API_KinesisStreamsInput_Contents"></a>

 ** ResourceARN **   <a name="analytics-Type-KinesisStreamsInput-ResourceARN"></a>
ARN of the input Amazon Kinesis stream to read.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 2048.  
Pattern: `arn:.*`   
Required: Yes

 ** RoleARN **   <a name="analytics-Type-KinesisStreamsInput-RoleARN"></a>
ARN of the IAM role that Amazon Kinesis Analytics can assume to access the stream on your behalf. You need to grant the necessary permissions to this role.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 2048.  
Pattern: `arn:.*`   
Required: Yes

## See Also
<a name="API_KinesisStreamsInput_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/kinesisanalytics-2015-08-14/KinesisStreamsInput) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/kinesisanalytics-2015-08-14/KinesisStreamsInput) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/kinesisanalytics-2015-08-14/KinesisStreamsInput) 

# KinesisStreamsInputDescription
<a name="API_KinesisStreamsInputDescription"></a>

 Describes the Amazon Kinesis stream that is configured as the streaming source in the application input configuration. 

## Contents
<a name="API_KinesisStreamsInputDescription_Contents"></a>

 ** ResourceARN **   <a name="analytics-Type-KinesisStreamsInputDescription-ResourceARN"></a>
Amazon Resource Name (ARN) of the Amazon Kinesis stream.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 2048.  
Pattern: `arn:.*`   
Required: No

 ** RoleARN **   <a name="analytics-Type-KinesisStreamsInputDescription-RoleARN"></a>
ARN of the IAM role that Amazon Kinesis Analytics can assume to access the stream.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 2048.  
Pattern: `arn:.*`   
Required: No

## See Also
<a name="API_KinesisStreamsInputDescription_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/kinesisanalytics-2015-08-14/KinesisStreamsInputDescription) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/kinesisanalytics-2015-08-14/KinesisStreamsInputDescription) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/kinesisanalytics-2015-08-14/KinesisStreamsInputDescription) 

# KinesisStreamsInputUpdate
<a name="API_KinesisStreamsInputUpdate"></a>

When updating application input configuration, provides information about an Amazon Kinesis stream as the streaming source.

## Contents
<a name="API_KinesisStreamsInputUpdate_Contents"></a>

 ** ResourceARNUpdate **   <a name="analytics-Type-KinesisStreamsInputUpdate-ResourceARNUpdate"></a>
Amazon Resource Name (ARN) of the input Amazon Kinesis stream to read.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 2048.  
Pattern: `arn:.*`   
Required: No

 ** RoleARNUpdate **   <a name="analytics-Type-KinesisStreamsInputUpdate-RoleARNUpdate"></a>
ARN of the IAM role that Amazon Kinesis Analytics can assume to access the stream on your behalf. You need to grant the necessary permissions to this role.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 2048.  
Pattern: `arn:.*`   
Required: No

## See Also
<a name="API_KinesisStreamsInputUpdate_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/kinesisanalytics-2015-08-14/KinesisStreamsInputUpdate) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/kinesisanalytics-2015-08-14/KinesisStreamsInputUpdate) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/kinesisanalytics-2015-08-14/KinesisStreamsInputUpdate) 

# KinesisStreamsOutput
<a name="API_KinesisStreamsOutput"></a>

When configuring application output, identifies an Amazon Kinesis stream as the destination. You provide the stream Amazon Resource Name (ARN) and also an IAM role ARN that Amazon Kinesis Analytics can use to write to the stream on your behalf.

## Contents
<a name="API_KinesisStreamsOutput_Contents"></a>

 ** ResourceARN **   <a name="analytics-Type-KinesisStreamsOutput-ResourceARN"></a>
ARN of the destination Amazon Kinesis stream to write to.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 2048.  
Pattern: `arn:.*`   
Required: Yes

 ** RoleARN **   <a name="analytics-Type-KinesisStreamsOutput-RoleARN"></a>
ARN of the IAM role that Amazon Kinesis Analytics can assume to write to the destination stream on your behalf. You need to grant the necessary permissions to this role.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 2048.  
Pattern: `arn:.*`   
Required: Yes

## See Also
<a name="API_KinesisStreamsOutput_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/kinesisanalytics-2015-08-14/KinesisStreamsOutput) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/kinesisanalytics-2015-08-14/KinesisStreamsOutput) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/kinesisanalytics-2015-08-14/KinesisStreamsOutput) 

# KinesisStreamsOutputDescription
<a name="API_KinesisStreamsOutputDescription"></a>

 For an application output, describes the Amazon Kinesis stream configured as its destination. 

## Contents
<a name="API_KinesisStreamsOutputDescription_Contents"></a>

 ** ResourceARN **   <a name="analytics-Type-KinesisStreamsOutputDescription-ResourceARN"></a>
Amazon Resource Name (ARN) of the Amazon Kinesis stream.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 2048.  
Pattern: `arn:.*`   
Required: No

 ** RoleARN **   <a name="analytics-Type-KinesisStreamsOutputDescription-RoleARN"></a>
ARN of the IAM role that Amazon Kinesis Analytics can assume to access the stream.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 2048.  
Pattern: `arn:.*`   
Required: No

## See Also
<a name="API_KinesisStreamsOutputDescription_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/kinesisanalytics-2015-08-14/KinesisStreamsOutputDescription) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/kinesisanalytics-2015-08-14/KinesisStreamsOutputDescription) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/kinesisanalytics-2015-08-14/KinesisStreamsOutputDescription) 

# KinesisStreamsOutputUpdate
<a name="API_KinesisStreamsOutputUpdate"></a>

 When updating an output configuration using the [UpdateApplication](https://docs.aws.amazon.com/kinesisanalytics/latest/dev/API_UpdateApplication.html) operation, provides information about an Amazon Kinesis stream configured as the destination. 

## Contents
<a name="API_KinesisStreamsOutputUpdate_Contents"></a>

 ** ResourceARNUpdate **   <a name="analytics-Type-KinesisStreamsOutputUpdate-ResourceARNUpdate"></a>
Amazon Resource Name (ARN) of the Amazon Kinesis stream where you want to write the output.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 2048.  
Pattern: `arn:.*`   
Required: No

 ** RoleARNUpdate **   <a name="analytics-Type-KinesisStreamsOutputUpdate-RoleARNUpdate"></a>
ARN of the IAM role that Amazon Kinesis Analytics can assume to access the stream on your behalf. You need to grant the necessary permissions to this role.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 2048.  
Pattern: `arn:.*`   
Required: No

## See Also
<a name="API_KinesisStreamsOutputUpdate_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/kinesisanalytics-2015-08-14/KinesisStreamsOutputUpdate) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/kinesisanalytics-2015-08-14/KinesisStreamsOutputUpdate) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/kinesisanalytics-2015-08-14/KinesisStreamsOutputUpdate) 

# LambdaOutput
<a name="API_LambdaOutput"></a>

When configuring application output, identifies an AWS Lambda function as the destination. You provide the function Amazon Resource Name (ARN) and also an IAM role ARN that Amazon Kinesis Analytics can use to write to the function on your behalf. 

## Contents
<a name="API_LambdaOutput_Contents"></a>

 ** ResourceARN **   <a name="analytics-Type-LambdaOutput-ResourceARN"></a>
Amazon Resource Name (ARN) of the destination Lambda function to write to.  
To specify an earlier version of the Lambda function than the latest, include the Lambda function version in the Lambda function ARN. For more information about Lambda ARNs, see [Example ARNs: AWS Lambda](/general/latest/gr/aws-arns-and-namespaces.html#arn-syntax-lambda) 
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 2048.  
Pattern: `arn:.*`   
Required: Yes

 ** RoleARN **   <a name="analytics-Type-LambdaOutput-RoleARN"></a>
ARN of the IAM role that Amazon Kinesis Analytics can assume to write to the destination function on your behalf. You need to grant the necessary permissions to this role.   
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 2048.  
Pattern: `arn:.*`   
Required: Yes

## See Also
<a name="API_LambdaOutput_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/kinesisanalytics-2015-08-14/LambdaOutput) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/kinesisanalytics-2015-08-14/LambdaOutput) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/kinesisanalytics-2015-08-14/LambdaOutput) 

# LambdaOutputDescription
<a name="API_LambdaOutputDescription"></a>

For an application output, describes the AWS Lambda function configured as its destination. 

## Contents
<a name="API_LambdaOutputDescription_Contents"></a>

 ** ResourceARN **   <a name="analytics-Type-LambdaOutputDescription-ResourceARN"></a>
Amazon Resource Name (ARN) of the destination Lambda function.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 2048.  
Pattern: `arn:.*`   
Required: No

 ** RoleARN **   <a name="analytics-Type-LambdaOutputDescription-RoleARN"></a>
ARN of the IAM role that Amazon Kinesis Analytics can assume to write to the destination function.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 2048.  
Pattern: `arn:.*`   
Required: No

## See Also
<a name="API_LambdaOutputDescription_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/kinesisanalytics-2015-08-14/LambdaOutputDescription) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/kinesisanalytics-2015-08-14/LambdaOutputDescription) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/kinesisanalytics-2015-08-14/LambdaOutputDescription) 

# LambdaOutputUpdate
<a name="API_LambdaOutputUpdate"></a>

When updating an output configuration using the [UpdateApplication](https://docs.aws.amazon.com/kinesisanalytics/latest/dev/API_UpdateApplication.html) operation, provides information about an AWS Lambda function configured as the destination.

## Contents
<a name="API_LambdaOutputUpdate_Contents"></a>

 ** ResourceARNUpdate **   <a name="analytics-Type-LambdaOutputUpdate-ResourceARNUpdate"></a>
Amazon Resource Name (ARN) of the destination Lambda function.  
To specify an earlier version of the Lambda function than the latest, include the Lambda function version in the Lambda function ARN. For more information about Lambda ARNs, see [Example ARNs: AWS Lambda](/general/latest/gr/aws-arns-and-namespaces.html#arn-syntax-lambda) 
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 2048.  
Pattern: `arn:.*`   
Required: No

 ** RoleARNUpdate **   <a name="analytics-Type-LambdaOutputUpdate-RoleARNUpdate"></a>
ARN of the IAM role that Amazon Kinesis Analytics can assume to write to the destination function on your behalf. You need to grant the necessary permissions to this role.   
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 2048.  
Pattern: `arn:.*`   
Required: No

## See Also
<a name="API_LambdaOutputUpdate_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/kinesisanalytics-2015-08-14/LambdaOutputUpdate) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/kinesisanalytics-2015-08-14/LambdaOutputUpdate) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/kinesisanalytics-2015-08-14/LambdaOutputUpdate) 

# MappingParameters
<a name="API_MappingParameters"></a>

When configuring application input at the time of creating or updating an application, provides additional mapping information specific to the record format (such as JSON, CSV, or record fields delimited by some delimiter) on the streaming source.

## Contents
<a name="API_MappingParameters_Contents"></a>

 ** CSVMappingParameters **   <a name="analytics-Type-MappingParameters-CSVMappingParameters"></a>
Provides additional mapping information when the record format uses delimiters (for example, CSV).  
Type: [CSVMappingParameters](API_CSVMappingParameters.md) object  
Required: No

 ** JSONMappingParameters **   <a name="analytics-Type-MappingParameters-JSONMappingParameters"></a>
Provides additional mapping information when JSON is the record format on the streaming source.  
Type: [JSONMappingParameters](API_JSONMappingParameters.md) object  
Required: No

## See Also
<a name="API_MappingParameters_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/kinesisanalytics-2015-08-14/MappingParameters) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/kinesisanalytics-2015-08-14/MappingParameters) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/kinesisanalytics-2015-08-14/MappingParameters) 

# Output
<a name="API_Output"></a>

 Describes application output configuration in which you identify an in-application stream and a destination where you want the in-application stream data to be written. The destination can be an Amazon Kinesis stream or an Amazon Kinesis Firehose delivery stream. 



For limits on how many destinations an application can write and other limitations, see [Limits](https://docs.aws.amazon.com/kinesisanalytics/latest/dev/limits.html). 

## Contents
<a name="API_Output_Contents"></a>

 ** DestinationSchema **   <a name="analytics-Type-Output-DestinationSchema"></a>
Describes the data format when records are written to the destination. For more information, see [Configuring Application Output](https://docs.aws.amazon.com/kinesisanalytics/latest/dev/how-it-works-output.html).  
Type: [DestinationSchema](API_DestinationSchema.md) object  
Required: Yes

 ** Name **   <a name="analytics-Type-Output-Name"></a>
Name of the in-application stream.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 32.  
Required: Yes

 ** KinesisFirehoseOutput **   <a name="analytics-Type-Output-KinesisFirehoseOutput"></a>
Identifies an Amazon Kinesis Firehose delivery stream as the destination.  
Type: [KinesisFirehoseOutput](API_KinesisFirehoseOutput.md) object  
Required: No

 ** KinesisStreamsOutput **   <a name="analytics-Type-Output-KinesisStreamsOutput"></a>
Identifies an Amazon Kinesis stream as the destination.  
Type: [KinesisStreamsOutput](API_KinesisStreamsOutput.md) object  
Required: No

 ** LambdaOutput **   <a name="analytics-Type-Output-LambdaOutput"></a>
Identifies an AWS Lambda function as the destination.  
Type: [LambdaOutput](API_LambdaOutput.md) object  
Required: No

## See Also
<a name="API_Output_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/kinesisanalytics-2015-08-14/Output) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/kinesisanalytics-2015-08-14/Output) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/kinesisanalytics-2015-08-14/Output) 

# OutputDescription
<a name="API_OutputDescription"></a>

Describes the application output configuration, which includes the in-application stream name and the destination where the stream data is written. The destination can be an Amazon Kinesis stream or an Amazon Kinesis Firehose delivery stream. 

## Contents
<a name="API_OutputDescription_Contents"></a>

 ** DestinationSchema **   <a name="analytics-Type-OutputDescription-DestinationSchema"></a>
Data format used for writing data to the destination.  
Type: [DestinationSchema](API_DestinationSchema.md) object  
Required: No

 ** KinesisFirehoseOutputDescription **   <a name="analytics-Type-OutputDescription-KinesisFirehoseOutputDescription"></a>
Describes the Amazon Kinesis Firehose delivery stream configured as the destination where output is written.  
Type: [KinesisFirehoseOutputDescription](API_KinesisFirehoseOutputDescription.md) object  
Required: No

 ** KinesisStreamsOutputDescription **   <a name="analytics-Type-OutputDescription-KinesisStreamsOutputDescription"></a>
Describes Amazon Kinesis stream configured as the destination where output is written.  
Type: [KinesisStreamsOutputDescription](API_KinesisStreamsOutputDescription.md) object  
Required: No

 ** LambdaOutputDescription **   <a name="analytics-Type-OutputDescription-LambdaOutputDescription"></a>
Describes the AWS Lambda function configured as the destination where output is written.  
Type: [LambdaOutputDescription](API_LambdaOutputDescription.md) object  
Required: No

 ** Name **   <a name="analytics-Type-OutputDescription-Name"></a>
Name of the in-application stream configured as output.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 32.  
Required: No

 ** OutputId **   <a name="analytics-Type-OutputDescription-OutputId"></a>
A unique identifier for the output configuration.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 50.  
Pattern: `[a-zA-Z0-9_.-]+`   
Required: No

## See Also
<a name="API_OutputDescription_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/kinesisanalytics-2015-08-14/OutputDescription) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/kinesisanalytics-2015-08-14/OutputDescription) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/kinesisanalytics-2015-08-14/OutputDescription) 

# OutputUpdate
<a name="API_OutputUpdate"></a>

 Describes updates to the output configuration identified by the `OutputId`. 

## Contents
<a name="API_OutputUpdate_Contents"></a>

 ** OutputId **   <a name="analytics-Type-OutputUpdate-OutputId"></a>
Identifies the specific output configuration that you want to update.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 50.  
Pattern: `[a-zA-Z0-9_.-]+`   
Required: Yes

 ** DestinationSchemaUpdate **   <a name="analytics-Type-OutputUpdate-DestinationSchemaUpdate"></a>
Describes the data format when records are written to the destination. For more information, see [Configuring Application Output](https://docs.aws.amazon.com/kinesisanalytics/latest/dev/how-it-works-output.html).  
Type: [DestinationSchema](API_DestinationSchema.md) object  
Required: No

 ** KinesisFirehoseOutputUpdate **   <a name="analytics-Type-OutputUpdate-KinesisFirehoseOutputUpdate"></a>
Describes an Amazon Kinesis Firehose delivery stream as the destination for the output.  
Type: [KinesisFirehoseOutputUpdate](API_KinesisFirehoseOutputUpdate.md) object  
Required: No

 ** KinesisStreamsOutputUpdate **   <a name="analytics-Type-OutputUpdate-KinesisStreamsOutputUpdate"></a>
Describes an Amazon Kinesis stream as the destination for the output.  
Type: [KinesisStreamsOutputUpdate](API_KinesisStreamsOutputUpdate.md) object  
Required: No

 ** LambdaOutputUpdate **   <a name="analytics-Type-OutputUpdate-LambdaOutputUpdate"></a>
Describes an AWS Lambda function as the destination for the output.  
Type: [LambdaOutputUpdate](API_LambdaOutputUpdate.md) object  
Required: No

 ** NameUpdate **   <a name="analytics-Type-OutputUpdate-NameUpdate"></a>
If you want to specify a different in-application stream for this output configuration, use this field to specify the new in-application stream name.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 32.  
Required: No

## See Also
<a name="API_OutputUpdate_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/kinesisanalytics-2015-08-14/OutputUpdate) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/kinesisanalytics-2015-08-14/OutputUpdate) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/kinesisanalytics-2015-08-14/OutputUpdate) 

# RecordColumn
<a name="API_RecordColumn"></a>

Describes the mapping of each data element in the streaming source to the corresponding column in the in-application stream.

Also used to describe the format of the reference data source.

## Contents
<a name="API_RecordColumn_Contents"></a>

 ** Name **   <a name="analytics-Type-RecordColumn-Name"></a>
Name of the column created in the in-application input stream or reference table.  
Type: String  
Required: Yes

 ** SqlType **   <a name="analytics-Type-RecordColumn-SqlType"></a>
Type of column created in the in-application input stream or reference table.  
Type: String  
Length Constraints: Minimum length of 1.  
Required: Yes

 ** Mapping **   <a name="analytics-Type-RecordColumn-Mapping"></a>
Reference to the data element in the streaming input or the reference data source. This element is required if the [RecordFormatType](https://docs.aws.amazon.com/kinesisanalytics/latest/dev/API_RecordFormat.html#analytics-Type-RecordFormat-RecordFormatTypel) is `JSON`.  
Type: String  
Required: No

## See Also
<a name="API_RecordColumn_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/kinesisanalytics-2015-08-14/RecordColumn) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/kinesisanalytics-2015-08-14/RecordColumn) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/kinesisanalytics-2015-08-14/RecordColumn) 

# RecordFormat
<a name="API_RecordFormat"></a>

 Describes the record format and relevant mapping information that should be applied to schematize the records on the stream. 

## Contents
<a name="API_RecordFormat_Contents"></a>

 ** RecordFormatType **   <a name="analytics-Type-RecordFormat-RecordFormatType"></a>
The type of record format.  
Type: String  
Valid Values: `JSON | CSV`   
Required: Yes

 ** MappingParameters **   <a name="analytics-Type-RecordFormat-MappingParameters"></a>
When configuring application input at the time of creating or updating an application, provides additional mapping information specific to the record format (such as JSON, CSV, or record fields delimited by some delimiter) on the streaming source.  
Type: [MappingParameters](API_MappingParameters.md) object  
Required: No

## See Also
<a name="API_RecordFormat_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/kinesisanalytics-2015-08-14/RecordFormat) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/kinesisanalytics-2015-08-14/RecordFormat) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/kinesisanalytics-2015-08-14/RecordFormat) 

# ReferenceDataSource
<a name="API_ReferenceDataSource"></a>

Describes the reference data source by providing the source information (S3 bucket name and object key name), the resulting in-application table name that is created, and the necessary schema to map the data elements in the Amazon S3 object to the in-application table.

## Contents
<a name="API_ReferenceDataSource_Contents"></a>

 ** ReferenceSchema **   <a name="analytics-Type-ReferenceDataSource-ReferenceSchema"></a>
Describes the format of the data in the streaming source, and how each data element maps to corresponding columns created in the in-application stream.  
Type: [SourceSchema](API_SourceSchema.md) object  
Required: Yes

 ** TableName **   <a name="analytics-Type-ReferenceDataSource-TableName"></a>
Name of the in-application table to create.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 32.  
Required: Yes

 ** S3ReferenceDataSource **   <a name="analytics-Type-ReferenceDataSource-S3ReferenceDataSource"></a>
Identifies the S3 bucket and object that contains the reference data. Also identifies the IAM role Amazon Kinesis Analytics can assume to read this object on your behalf. An Amazon Kinesis Analytics application loads reference data only once. If the data changes, you call the `UpdateApplication` operation to trigger reloading of data into your application.   
Type: [S3ReferenceDataSource](API_S3ReferenceDataSource.md) object  
Required: No

## See Also
<a name="API_ReferenceDataSource_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/kinesisanalytics-2015-08-14/ReferenceDataSource) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/kinesisanalytics-2015-08-14/ReferenceDataSource) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/kinesisanalytics-2015-08-14/ReferenceDataSource) 

# ReferenceDataSourceDescription
<a name="API_ReferenceDataSourceDescription"></a>

Describes the reference data source configured for an application.

## Contents
<a name="API_ReferenceDataSourceDescription_Contents"></a>

 ** ReferenceId **   <a name="analytics-Type-ReferenceDataSourceDescription-ReferenceId"></a>
ID of the reference data source. This is the ID that Amazon Kinesis Analytics assigns when you add the reference data source to your application using the [AddApplicationReferenceDataSource](https://docs.aws.amazon.com/kinesisanalytics/latest/dev/API_AddApplicationReferenceDataSource.html) operation.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 50.  
Pattern: `[a-zA-Z0-9_.-]+`   
Required: Yes

 ** S3ReferenceDataSourceDescription **   <a name="analytics-Type-ReferenceDataSourceDescription-S3ReferenceDataSourceDescription"></a>
Provides the S3 bucket name, the object key name that contains the reference data. It also provides the Amazon Resource Name (ARN) of the IAM role that Amazon Kinesis Analytics can assume to read the Amazon S3 object and populate the in-application reference table.  
Type: [S3ReferenceDataSourceDescription](API_S3ReferenceDataSourceDescription.md) object  
Required: Yes

 ** TableName **   <a name="analytics-Type-ReferenceDataSourceDescription-TableName"></a>
The in-application table name created by the specific reference data source configuration.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 32.  
Required: Yes

 ** ReferenceSchema **   <a name="analytics-Type-ReferenceDataSourceDescription-ReferenceSchema"></a>
Describes the format of the data in the streaming source, and how each data element maps to corresponding columns created in the in-application stream.  
Type: [SourceSchema](API_SourceSchema.md) object  
Required: No

## See Also
<a name="API_ReferenceDataSourceDescription_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/kinesisanalytics-2015-08-14/ReferenceDataSourceDescription) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/kinesisanalytics-2015-08-14/ReferenceDataSourceDescription) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/kinesisanalytics-2015-08-14/ReferenceDataSourceDescription) 

# ReferenceDataSourceUpdate
<a name="API_ReferenceDataSourceUpdate"></a>

When you update a reference data source configuration for an application, this object provides all the updated values (such as the source bucket name and object key name), the in-application table name that is created, and updated mapping information that maps the data in the Amazon S3 object to the in-application reference table that is created.

## Contents
<a name="API_ReferenceDataSourceUpdate_Contents"></a>

 ** ReferenceId **   <a name="analytics-Type-ReferenceDataSourceUpdate-ReferenceId"></a>
ID of the reference data source being updated. You can use the [DescribeApplication](https://docs.aws.amazon.com/kinesisanalytics/latest/dev/API_DescribeApplication.html) operation to get this value.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 50.  
Pattern: `[a-zA-Z0-9_.-]+`   
Required: Yes

 ** ReferenceSchemaUpdate **   <a name="analytics-Type-ReferenceDataSourceUpdate-ReferenceSchemaUpdate"></a>
Describes the format of the data in the streaming source, and how each data element maps to corresponding columns created in the in-application stream.   
Type: [SourceSchema](API_SourceSchema.md) object  
Required: No

 ** S3ReferenceDataSourceUpdate **   <a name="analytics-Type-ReferenceDataSourceUpdate-S3ReferenceDataSourceUpdate"></a>
Describes the S3 bucket name, object key name, and IAM role that Amazon Kinesis Analytics can assume to read the Amazon S3 object on your behalf and populate the in-application reference table.  
Type: [S3ReferenceDataSourceUpdate](API_S3ReferenceDataSourceUpdate.md) object  
Required: No

 ** TableNameUpdate **   <a name="analytics-Type-ReferenceDataSourceUpdate-TableNameUpdate"></a>
In-application table name that is created by this update.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 32.  
Required: No

## See Also
<a name="API_ReferenceDataSourceUpdate_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/kinesisanalytics-2015-08-14/ReferenceDataSourceUpdate) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/kinesisanalytics-2015-08-14/ReferenceDataSourceUpdate) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/kinesisanalytics-2015-08-14/ReferenceDataSourceUpdate) 

# S3Configuration
<a name="API_S3Configuration"></a>

Provides a description of an Amazon S3 data source, including the Amazon Resource Name (ARN) of the S3 bucket, the ARN of the IAM role that is used to access the bucket, and the name of the Amazon S3 object that contains the data.

## Contents
<a name="API_S3Configuration_Contents"></a>

 ** BucketARN **   <a name="analytics-Type-S3Configuration-BucketARN"></a>
ARN of the S3 bucket that contains the data.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 2048.  
Pattern: `arn:.*`   
Required: Yes

 ** FileKey **   <a name="analytics-Type-S3Configuration-FileKey"></a>
The name of the object that contains the data.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 1024.  
Required: Yes

 ** RoleARN **   <a name="analytics-Type-S3Configuration-RoleARN"></a>
IAM ARN of the role used to access the data.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 2048.  
Pattern: `arn:.*`   
Required: Yes

## See Also
<a name="API_S3Configuration_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/kinesisanalytics-2015-08-14/S3Configuration) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/kinesisanalytics-2015-08-14/S3Configuration) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/kinesisanalytics-2015-08-14/S3Configuration) 

# S3ReferenceDataSource
<a name="API_S3ReferenceDataSource"></a>

Identifies the S3 bucket and object that contains the reference data. Also identifies the IAM role Amazon Kinesis Analytics can assume to read this object on your behalf.

An Amazon Kinesis Analytics application loads reference data only once. If the data changes, you call the [UpdateApplication](https://docs.aws.amazon.com/kinesisanalytics/latest/dev/API_UpdateApplication.html) operation to trigger reloading of data into your application.

## Contents
<a name="API_S3ReferenceDataSource_Contents"></a>

 ** BucketARN **   <a name="analytics-Type-S3ReferenceDataSource-BucketARN"></a>
Amazon Resource Name (ARN) of the S3 bucket.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 2048.  
Pattern: `arn:.*`   
Required: Yes

 ** FileKey **   <a name="analytics-Type-S3ReferenceDataSource-FileKey"></a>
Object key name containing reference data.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 1024.  
Required: Yes

 ** ReferenceRoleARN **   <a name="analytics-Type-S3ReferenceDataSource-ReferenceRoleARN"></a>
ARN of the IAM role that the service can assume to read data on your behalf. This role must have permission for the `s3:GetObject` action on the object and trust policy that allows Amazon Kinesis Analytics service principal to assume this role.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 2048.  
Pattern: `arn:.*`   
Required: Yes

## See Also
<a name="API_S3ReferenceDataSource_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/kinesisanalytics-2015-08-14/S3ReferenceDataSource) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/kinesisanalytics-2015-08-14/S3ReferenceDataSource) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/kinesisanalytics-2015-08-14/S3ReferenceDataSource) 

# S3ReferenceDataSourceDescription
<a name="API_S3ReferenceDataSourceDescription"></a>

Provides the bucket name and object key name that stores the reference data.

## Contents
<a name="API_S3ReferenceDataSourceDescription_Contents"></a>

 ** BucketARN **   <a name="analytics-Type-S3ReferenceDataSourceDescription-BucketARN"></a>
Amazon Resource Name (ARN) of the S3 bucket.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 2048.  
Pattern: `arn:.*`   
Required: Yes

 ** FileKey **   <a name="analytics-Type-S3ReferenceDataSourceDescription-FileKey"></a>
Amazon S3 object key name.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 1024.  
Required: Yes

 ** ReferenceRoleARN **   <a name="analytics-Type-S3ReferenceDataSourceDescription-ReferenceRoleARN"></a>
ARN of the IAM role that Amazon Kinesis Analytics can assume to read the Amazon S3 object on your behalf to populate the in-application reference table.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 2048.  
Pattern: `arn:.*`   
Required: Yes

## See Also
<a name="API_S3ReferenceDataSourceDescription_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/kinesisanalytics-2015-08-14/S3ReferenceDataSourceDescription) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/kinesisanalytics-2015-08-14/S3ReferenceDataSourceDescription) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/kinesisanalytics-2015-08-14/S3ReferenceDataSourceDescription) 

# S3ReferenceDataSourceUpdate
<a name="API_S3ReferenceDataSourceUpdate"></a>

Describes the S3 bucket name, object key name, and IAM role that Amazon Kinesis Analytics can assume to read the Amazon S3 object on your behalf and populate the in-application reference table.

## Contents
<a name="API_S3ReferenceDataSourceUpdate_Contents"></a>

 ** BucketARNUpdate **   <a name="analytics-Type-S3ReferenceDataSourceUpdate-BucketARNUpdate"></a>
Amazon Resource Name (ARN) of the S3 bucket.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 2048.  
Pattern: `arn:.*`   
Required: No

 ** FileKeyUpdate **   <a name="analytics-Type-S3ReferenceDataSourceUpdate-FileKeyUpdate"></a>
Object key name.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 1024.  
Required: No

 ** ReferenceRoleARNUpdate **   <a name="analytics-Type-S3ReferenceDataSourceUpdate-ReferenceRoleARNUpdate"></a>
ARN of the IAM role that Amazon Kinesis Analytics can assume to read the Amazon S3 object and populate the in-application.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 2048.  
Pattern: `arn:.*`   
Required: No

## See Also
<a name="API_S3ReferenceDataSourceUpdate_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/kinesisanalytics-2015-08-14/S3ReferenceDataSourceUpdate) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/kinesisanalytics-2015-08-14/S3ReferenceDataSourceUpdate) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/kinesisanalytics-2015-08-14/S3ReferenceDataSourceUpdate) 

# SourceSchema
<a name="API_SourceSchema"></a>

Describes the format of the data in the streaming source, and how each data element maps to corresponding columns created in the in-application stream.

## Contents
<a name="API_SourceSchema_Contents"></a>

 ** RecordColumns **   <a name="analytics-Type-SourceSchema-RecordColumns"></a>
A list of `RecordColumn` objects.  
Type: Array of [RecordColumn](API_RecordColumn.md) objects  
Array Members: Minimum number of 1 item. Maximum number of 1000 items.  
Required: Yes

 ** RecordFormat **   <a name="analytics-Type-SourceSchema-RecordFormat"></a>
Specifies the format of the records on the streaming source.  
Type: [RecordFormat](API_RecordFormat.md) object  
Required: Yes

 ** RecordEncoding **   <a name="analytics-Type-SourceSchema-RecordEncoding"></a>
Specifies the encoding of the records in the streaming source. For example, UTF-8.  
Type: String  
Pattern: `UTF-8`   
Required: No

## See Also
<a name="API_SourceSchema_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/kinesisanalytics-2015-08-14/SourceSchema) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/kinesisanalytics-2015-08-14/SourceSchema) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/kinesisanalytics-2015-08-14/SourceSchema) 

# Tag
<a name="API_Tag"></a>

A key-value pair (the value is optional) that you can define and assign to AWS resources. If you specify a tag that already exists, the tag value is replaced with the value that you specify in the request. Note that 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).

## Contents
<a name="API_Tag_Contents"></a>

 ** Key **   <a name="analytics-Type-Tag-Key"></a>
The key of the key-value tag.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 128.  
Required: Yes

 ** Value **   <a name="analytics-Type-Tag-Value"></a>
The value of the key-value tag. The value is optional.  
Type: String  
Length Constraints: Minimum length of 0. Maximum length of 256.  
Required: No

## See Also
<a name="API_Tag_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/kinesisanalytics-2015-08-14/Tag) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/kinesisanalytics-2015-08-14/Tag) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/kinesisanalytics-2015-08-14/Tag)