openapi: 3.0.0 info: version: '2018-05-23' x-release: v4 title: 'Amazon Kinesis Analytics #X Amz Target=KinesisAnalytics 20180523.AddApplicationCloudWatchLoggingOption #X Amz Target=KinesisAnalytics 20180523.AddApplicationCloudWatchLoggingOption #X Amz Target=KinesisAnalytics 20180523.AddApplicationInput API' description: Amazon Kinesis Data Analytics is a fully managed service that you can use to process and analyze streaming data using Java, SQL, or Scala. The service enables you to quickly author and run Java, SQL, or Scala code against streaming sources to perform time series analytics, feed real-time dashboards, and create real-time metrics. x-logo: url: https://twitter.com/awscloud/profile_image?size=original backgroundColor: '#FFFFFF' termsOfService: https://aws.amazon.com/service-terms/ contact: name: Mike Ralphson email: mike.ralphson@gmail.com url: https://github.com/mermade/aws2openapi x-twitter: PermittedSoc license: name: Apache 2.0 License url: http://www.apache.org/licenses/ x-providerName: amazonaws.com x-serviceName: kinesisanalyticsv2 x-aws-signingName: kinesisanalytics x-origin: - contentType: application/json url: https://raw.githubusercontent.com/aws/aws-sdk-js/master/apis/kinesisanalyticsv2-2018-05-23.normal.json converter: url: https://github.com/mermade/aws2openapi version: 1.0.0 x-apisguru-driver: external x-apiClientRegistration: url: https://portal.aws.amazon.com/gp/aws/developer/registration/index.html?nc2=h_ct x-apisguru-categories: - cloud x-preferred: true servers: - url: http://kinesisanalytics.{region}.amazonaws.com variables: region: description: The AWS region enum: - us-east-1 - us-east-2 - us-west-1 - us-west-2 - us-gov-west-1 - us-gov-east-1 - ca-central-1 - eu-north-1 - eu-west-1 - eu-west-2 - eu-west-3 - eu-central-1 - eu-south-1 - af-south-1 - ap-northeast-1 - ap-northeast-2 - ap-northeast-3 - ap-southeast-1 - ap-southeast-2 - ap-east-1 - ap-south-1 - sa-east-1 - me-south-1 default: us-east-1 description: The Kinesis Analytics V2 multi-region endpoint - url: https://kinesisanalytics.{region}.amazonaws.com variables: region: description: The AWS region enum: - us-east-1 - us-east-2 - us-west-1 - us-west-2 - us-gov-west-1 - us-gov-east-1 - ca-central-1 - eu-north-1 - eu-west-1 - eu-west-2 - eu-west-3 - eu-central-1 - eu-south-1 - af-south-1 - ap-northeast-1 - ap-northeast-2 - ap-northeast-3 - ap-southeast-1 - ap-southeast-2 - ap-east-1 - ap-south-1 - sa-east-1 - me-south-1 default: us-east-1 description: The Kinesis Analytics V2 multi-region endpoint - url: http://kinesisanalytics.{region}.amazonaws.com.cn variables: region: description: The AWS region enum: - cn-north-1 - cn-northwest-1 default: cn-north-1 description: The Kinesis Analytics V2 endpoint for China (Beijing) and China (Ningxia) - url: https://kinesisanalytics.{region}.amazonaws.com.cn variables: region: description: The AWS region enum: - cn-north-1 - cn-northwest-1 default: cn-north-1 description: The Kinesis Analytics V2 endpoint for China (Beijing) and China (Ningxia) security: - hmac: [] tags: - name: '#X Amz Target=KinesisAnalytics 20180523.AddApplicationInput' paths: /#X-Amz-Target=KinesisAnalytics_20180523.AddApplicationInput: parameters: - $ref: '#/components/parameters/X-Amz-Content-Sha256' - $ref: '#/components/parameters/X-Amz-Date' - $ref: '#/components/parameters/X-Amz-Algorithm' - $ref: '#/components/parameters/X-Amz-Credential' - $ref: '#/components/parameters/X-Amz-Security-Token' - $ref: '#/components/parameters/X-Amz-Signature' - $ref: '#/components/parameters/X-Amz-SignedHeaders' post: operationId: AddApplicationInput description:

Adds a streaming source to your SQL-based Kinesis Data Analytics application.

You can add a streaming source when you create an application, or you can use this operation to add a streaming source after you create an application. For more information, see CreateApplication.

Any configuration update, including adding a streaming source using this operation, results in a new version of the application. You can use the DescribeApplication operation to find the current application version.

responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/AddApplicationInputResponse' '480': description: ResourceNotFoundException content: application/json: schema: $ref: '#/components/schemas/ResourceNotFoundException' '481': description: ResourceInUseException content: application/json: schema: $ref: '#/components/schemas/ResourceInUseException' '482': description: InvalidArgumentException content: application/json: schema: $ref: '#/components/schemas/InvalidArgumentException' '483': description: ConcurrentModificationException content: application/json: schema: $ref: '#/components/schemas/ConcurrentModificationException' '484': description: CodeValidationException content: application/json: schema: $ref: '#/components/schemas/CodeValidationException' '485': description: InvalidRequestException content: application/json: schema: $ref: '#/components/schemas/InvalidRequestException' requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/AddApplicationInputRequest' parameters: - name: X-Amz-Target in: header required: true schema: type: string enum: - KinesisAnalytics_20180523.AddApplicationInput summary: Amazon Managed Service for Apache Flink Add Application Input tags: - '#X Amz Target=KinesisAnalytics 20180523.AddApplicationInput' components: schemas: RecordColumnDelimiter: type: string minLength: 1 maxLength: 1024 ResourceInUseException: {} SourceSchema: type: object required: - RecordFormat - RecordColumns properties: RecordFormat: allOf: - $ref: '#/components/schemas/RecordFormat' - description: Specifies the format of the records on the streaming source. RecordEncoding: allOf: - $ref: '#/components/schemas/RecordEncoding' - description: Specifies the encoding of the records in the streaming source. For example, UTF-8. RecordColumns: allOf: - $ref: '#/components/schemas/RecordColumns' - description: 'A list of RecordColumn objects. ' description: 'For a SQL-based Kinesis Data Analytics application, 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. ' Input: type: object required: - NamePrefix - InputSchema properties: NamePrefix: allOf: - $ref: '#/components/schemas/InAppStreamName' - description: 'The name prefix to use when creating an in-application stream. Suppose that you specify a prefix "MyInApplicationStream." Kinesis Data Analytics then creates one or more (as per the InputParallelism count you specified) in-application streams with the names "MyInApplicationStream_001," "MyInApplicationStream_002," and so on. ' InputProcessingConfiguration: allOf: - $ref: '#/components/schemas/InputProcessingConfiguration' - description: 'The InputProcessingConfiguration for the input. An input processor transforms records as they are received from the stream, before the application''s SQL code executes. Currently, the only input processing configuration available is InputLambdaProcessor. ' KinesisStreamsInput: allOf: - $ref: '#/components/schemas/KinesisStreamsInput' - description: 'If the streaming source is an Amazon Kinesis data stream, identifies the stream''s Amazon Resource Name (ARN). ' KinesisFirehoseInput: allOf: - $ref: '#/components/schemas/KinesisFirehoseInput' - description: If the streaming source is an Amazon Kinesis Data Firehose delivery stream, identifies the delivery stream's ARN. InputParallelism: allOf: - $ref: '#/components/schemas/InputParallelism' - description: 'Describes the number of in-application streams to create. ' InputSchema: allOf: - $ref: '#/components/schemas/SourceSchema' - description:

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.

description: 'When you configure the application input for a SQL-based Kinesis Data Analytics application, you specify the streaming source, the in-application stream name that is created, and the mapping between the two. ' KinesisStreamsInputDescription: type: object required: - ResourceARN properties: ResourceARN: allOf: - $ref: '#/components/schemas/ResourceARN' - description: The Amazon Resource Name (ARN) of the Kinesis data stream. RoleARN: allOf: - $ref: '#/components/schemas/RoleARN' - description:

The ARN of the IAM role that Kinesis Data Analytics can assume to access the stream.

Provided for backward compatibility. Applications that are created with the current API version have an application-level service execution role rather than a resource-level role.

 description: 'For a SQL-based Kinesis Data Analytics application, describes the Kinesis data stream that is configured as the streaming source in the application input configuration. ' InputParallelismCount: type: integer minimum: 1 maximum: 64 InputProcessingConfiguration: type: object required: - InputLambdaProcessor properties: InputLambdaProcessor: allOf: - $ref: '#/components/schemas/InputLambdaProcessor' - description: The InputLambdaProcessor that is used to preprocess the records in the stream before being processed by your application code. description: For a SQL-based Kinesis Data Analytics application, describes 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 Amazon Lambda. InputDescription: type: object properties: InputId: allOf: - $ref: '#/components/schemas/Id' - description: 'The input ID that is associated with the application input. This is the ID that Kinesis Data Analytics assigns to each input configuration that you add to your application. ' NamePrefix: allOf: - $ref: '#/components/schemas/InAppStreamName' - description: The in-application name prefix. InAppStreamNames: allOf: - $ref: '#/components/schemas/InAppStreamNames' - description: 'Returns the in-application stream names that are mapped to the stream source. ' InputProcessingConfigurationDescription: allOf: - $ref: '#/components/schemas/InputProcessingConfigurationDescription' - description: 'The description of the preprocessor that executes on records in this input before the application''s code is run. ' KinesisStreamsInputDescription: allOf: - $ref: '#/components/schemas/KinesisStreamsInputDescription' - description: 'If a Kinesis data stream is configured as a streaming source, provides the Kinesis data stream''s Amazon Resource Name (ARN). ' KinesisFirehoseInputDescription: allOf: - $ref: '#/components/schemas/KinesisFirehoseInputDescription' - description: 'If a Kinesis Data Firehose delivery stream is configured as a streaming source, provides the delivery stream''s ARN. ' InputSchema: allOf: - $ref: '#/components/schemas/SourceSchema' - description: '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. ' InputParallelism: allOf: - $ref: '#/components/schemas/InputParallelism' - description: 'Describes the configured parallelism (number of in-application streams mapped to the streaming source). ' InputStartingPositionConfiguration: allOf: - $ref: '#/components/schemas/InputStartingPositionConfiguration' - description: The point at which the application is configured to read from the input stream. description: 'Describes the application input configuration for a SQL-based Kinesis Data Analytics application. ' KinesisStreamsInput: type: object required: - ResourceARN properties: ResourceARN: allOf: - $ref: '#/components/schemas/ResourceARN' - description: The ARN of the input Kinesis data stream to read. description: ' Identifies a Kinesis data stream as the streaming source. You provide the stream''s Amazon Resource Name (ARN).' RecordColumn: type: object required: - Name - SqlType properties: Name: allOf: - $ref: '#/components/schemas/RecordColumnName' - description: The name of the column that is created in the in-application input stream or reference table. Mapping: allOf: - $ref: '#/components/schemas/RecordColumnMapping' - description: A reference to the data element in the streaming input or the reference data source. SqlType: allOf: - $ref: '#/components/schemas/RecordColumnSqlType' - description: The type of column created in the in-application input stream or reference table. description:

For a SQL-based Kinesis Data Analytics application, 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.

AddApplicationInputResponse: type: object properties: ApplicationARN: allOf: - $ref: '#/components/schemas/ResourceARN' - description: The Amazon Resource Name (ARN) of the application. ApplicationVersionId: allOf: - $ref: '#/components/schemas/ApplicationVersionId' - description: Provides the current application version. InputDescriptions: allOf: - $ref: '#/components/schemas/InputDescriptions' - description: 'Describes the application input configuration. ' InAppStreamName: type: string pattern: '[^-\s<>&]*' minLength: 1 maxLength: 32 InputStartingPositionConfiguration: type: object properties: InputStartingPosition: allOf: - $ref: '#/components/schemas/InputStartingPosition' - description:

The starting position on the stream.

description: Describes the point at which the application reads from the streaming source. RecordFormatType: type: string enum: - JSON - CSV RecordColumns: type: array items: $ref: '#/components/schemas/RecordColumn' minItems: 1 maxItems: 1000 RecordColumnSqlType: type: string minLength: 1 maxLength: 100 InputParallelism: type: object properties: Count: allOf: - $ref: '#/components/schemas/InputParallelismCount' - description: The number of in-application streams to create. description: 'For a SQL-based Kinesis Data Analytics application, describes the number of in-application streams to create for a given streaming source. ' InvalidRequestException: {} Id: type: string pattern: '[a-zA-Z0-9_.-]+' minLength: 1 maxLength: 50 KinesisFirehoseInputDescription: type: object required: - ResourceARN properties: ResourceARN: allOf: - $ref: '#/components/schemas/ResourceARN' - description: The Amazon Resource Name (ARN) of the delivery stream. RoleARN: allOf: - $ref: '#/components/schemas/RoleARN' - description:

The ARN of the IAM role that Kinesis Data Analytics assumes to access the stream.

Provided for backward compatibility. Applications that are created with the current API version have an application-level service execution role rather than a resource-level role.

 description: 'Describes the Amazon Kinesis Data Firehose delivery stream that is configured as the streaming source in the application input configuration. ' InAppStreamNames: type: array items: $ref: '#/components/schemas/InAppStreamName' RecordRowPath: type: string pattern: ^(?=^\$)(?=^\S+$).*$ minLength: 1 maxLength: 65535 MappingParameters: type: object properties: JSONMappingParameters: allOf: - $ref: '#/components/schemas/JSONMappingParameters' - description: Provides additional mapping information when JSON is the record format on the streaming source. CSVMappingParameters: allOf: - $ref: '#/components/schemas/CSVMappingParameters' - description: Provides additional mapping information when the record format uses delimiters (for example, CSV). description: When you configure a SQL-based Kinesis Data Analytics application's 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. RoleARN: type: string pattern: arn:.* minLength: 1 maxLength: 2048 InputDescriptions: type: array items: $ref: '#/components/schemas/InputDescription' RecordEncoding: type: string pattern: UTF-8 minLength: 5 maxLength: 5 CSVMappingParameters: type: object required: - RecordRowDelimiter - RecordColumnDelimiter properties: RecordRowDelimiter: allOf: - $ref: '#/components/schemas/RecordRowDelimiter' - description: The row delimiter. For example, in a CSV format, '\n' is the typical row delimiter. RecordColumnDelimiter: allOf: - $ref: '#/components/schemas/RecordColumnDelimiter' - description: The column delimiter. For example, in a CSV format, a comma (",") is the typical column delimiter. description: '

For a SQL-based Kinesis Data Analytics application, 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 ''\n'' as the row delimiter and a comma (",") as the column delimiter:

"name1", "address1"

"name2", "address2"

' ConcurrentModificationException: {} InputLambdaProcessorDescription: type: object required: - ResourceARN properties: ResourceARN: allOf: - $ref: '#/components/schemas/ResourceARN' - description: '

The ARN of the Amazon 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: Amazon Lambda

' RoleARN: allOf: - $ref: '#/components/schemas/RoleARN' - description:

The ARN of the IAM role that is used to access the Amazon Lambda function.

Provided for backward compatibility. Applications that are created with the current API version have an application-level service execution role rather than a resource-level role.

 description: For a SQL-based Kinesis Data Analytics application, an object that contains the Amazon Resource Name (ARN) of the Amazon Lambda function that is used to preprocess records in the stream. KinesisFirehoseInput: type: object required: - ResourceARN properties: ResourceARN: allOf: - $ref: '#/components/schemas/ResourceARN' - description: The Amazon Resource Name (ARN) of the delivery stream. description: For a SQL-based Kinesis Data Analytics application, identifies a Kinesis Data Firehose delivery stream as the streaming source. You provide the delivery stream's Amazon Resource Name (ARN). RecordColumnMapping: type: string minLength: 0 maxLength: 65535 InvalidArgumentException: {} JSONMappingParameters: type: object required: - RecordRowPath properties: RecordRowPath: allOf: - $ref: '#/components/schemas/RecordRowPath' - description: The path to the top-level parent that contains the records. description: For a SQL-based Kinesis Data Analytics application, provides additional mapping information when JSON is the record format on the streaming source. InputProcessingConfigurationDescription: type: object properties: InputLambdaProcessorDescription: allOf: - $ref: '#/components/schemas/InputLambdaProcessorDescription' - description: 'Provides configuration information about the associated InputLambdaProcessorDescription ' description: For a SQL-based Kinesis Data Analytics application, provides the configuration information about an input processor. Currently, the only input processor available is Amazon Lambda. AddApplicationInputRequest: type: object required: - ApplicationName - CurrentApplicationVersionId - Input title: AddApplicationInputRequest properties: ApplicationName: allOf: - $ref: '#/components/schemas/ApplicationName' - description: The name of your existing application to which you want to add the streaming source. CurrentApplicationVersionId: allOf: - $ref: '#/components/schemas/ApplicationVersionId' - description: The current version of your application. You must provide the ApplicationVersionID or the ConditionalToken.You can use the DescribeApplication operation to find the current application version. Input: allOf: - $ref: '#/components/schemas/Input' - description: The Input to add. ResourceARN: type: string pattern: arn:.* minLength: 1 maxLength: 2048 RecordFormat: type: object required: - RecordFormatType properties: RecordFormatType: allOf: - $ref: '#/components/schemas/RecordFormatType' - description: The type of record format. MappingParameters: allOf: - $ref: '#/components/schemas/MappingParameters' - description: When you configure 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. description: ' For a SQL-based Kinesis Data Analytics application, describes the record format and relevant mapping information that should be applied to schematize the records on the stream. ' InputLambdaProcessor: type: object required: - ResourceARN properties: ResourceARN: allOf: - $ref: '#/components/schemas/ResourceARN' - description: '

The ARN of the Amazon 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: Amazon Lambda

' description: 'An object that contains the Amazon Resource Name (ARN) of the Amazon Lambda function that is used to preprocess records in the stream in a SQL-based Kinesis Data Analytics application. ' RecordRowDelimiter: type: string minLength: 1 maxLength: 1024 ApplicationVersionId: type: integer minimum: 1 maximum: 999999999 InputStartingPosition: type: string enum: - NOW - TRIM_HORIZON - LAST_STOPPED_POINT ApplicationName: type: string pattern: '[a-zA-Z0-9_.-]+' minLength: 1 maxLength: 128 CodeValidationException: {} ResourceNotFoundException: {} RecordColumnName: type: string pattern: '[^-\s<>&]*' minLength: 1 maxLength: 256 parameters: X-Amz-Content-Sha256: name: X-Amz-Content-Sha256 in: header schema: type: string required: false X-Amz-Algorithm: name: X-Amz-Algorithm in: header schema: type: string required: false X-Amz-Credential: name: X-Amz-Credential in: header schema: type: string required: false X-Amz-Security-Token: name: X-Amz-Security-Token in: header schema: type: string required: false X-Amz-Signature: name: X-Amz-Signature in: header schema: type: string required: false X-Amz-Date: name: X-Amz-Date in: header schema: type: string required: false X-Amz-SignedHeaders: name: X-Amz-SignedHeaders in: header schema: type: string required: false securitySchemes: hmac: type: apiKey name: Authorization in: header description: Amazon Signature authorization v4 x-amazon-apigateway-authtype: awsSigv4 externalDocs: description: Amazon Web Services documentation url: https://docs.aws.amazon.com/kinesisanalytics/ x-hasEquivalentPaths: true