Hi there! Are you looking for the official Deno documentation? Try docs.deno.com for all your Deno learning needs.

Usage

import * as mod from "https://aws-api.deno.dev/v0.4/services/kinesisanalyticsv2.ts?docs=full";

§Classes

KinesisAnalyticsV2

§Interfaces

AddApplicationCloudWatchLoggingOptionRequest
AddApplicationCloudWatchLoggingOptionResponse
AddApplicationInputProcessingConfigurationRequest
AddApplicationInputProcessingConfigurationResponse
AddApplicationInputRequest
AddApplicationInputResponse
AddApplicationOutputRequest
AddApplicationOutputResponse
AddApplicationReferenceDataSourceRequest
AddApplicationReferenceDataSourceResponse
AddApplicationVpcConfigurationRequest
AddApplicationVpcConfigurationResponse
ApplicationCodeConfiguration

Describes code configuration for an application.

ApplicationCodeConfigurationDescription

Describes code configuration for an application.

ApplicationCodeConfigurationUpdate

Describes code configuration updates for an application. This is supported for a Flink-based Kinesis Data Analytics application or a SQL-based Kinesis Data Analytics application.

ApplicationConfiguration

Specifies the creation parameters for a Kinesis Data Analytics application.

ApplicationConfigurationDescription

Describes details about the application code and starting parameters for a Kinesis Data Analytics application.

ApplicationConfigurationUpdate

Describes updates to an application's configuration.

ApplicationDetail

Describes the application, including the application Amazon Resource Name (ARN), status, latest version, and input and output configurations.

ApplicationMaintenanceConfigurationDescription

The details of the maintenance configuration for the application.

ApplicationMaintenanceConfigurationUpdate

Describes the updated maintenance configuration for the application.

ApplicationRestoreConfiguration

Specifies the method and snapshot to use when restarting an application using previously saved application state.

ApplicationSnapshotConfiguration

Describes whether snapshots are enabled for a Flink-based Kinesis Data Analytics application.

ApplicationSnapshotConfigurationDescription

Describes whether snapshots are enabled for a Flink-based Kinesis Data Analytics application.

ApplicationSnapshotConfigurationUpdate

Describes updates to whether snapshots are enabled for a Flink-based Kinesis Data Analytics application.

ApplicationSummary

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

ApplicationVersionSummary

The summary of the application version.

CatalogConfiguration

The configuration parameters for the default Amazon Glue database. You use this database for SQL queries that you write in a Kinesis Data Analytics Studio notebook.

CatalogConfigurationDescription

The configuration parameters for the default Amazon Glue database. You use this database for Apache Flink SQL queries and table API transforms that you write in a Kinesis Data Analytics Studio notebook.

CatalogConfigurationUpdate

Updates to the configuration parameters for the default Amazon Glue database. You use this database for SQL queries that you write in a Kinesis Data Analytics Studio notebook.

CheckpointConfiguration

Describes an application's checkpointing configuration. Checkpointing is the process of persisting application state for fault tolerance. For more information, see Checkpoints for Fault Tolerance in the Apache Flink Documentation.

CheckpointConfigurationDescription

Describes checkpointing parameters for a Flink-based Kinesis Data Analytics application.

CheckpointConfigurationUpdate

Describes updates to the checkpointing parameters for a Flink-based Kinesis Data Analytics application.

CloudWatchLoggingOption

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

CloudWatchLoggingOptionDescription

Describes the Amazon CloudWatch logging option.

CloudWatchLoggingOptionUpdate

Describes the Amazon CloudWatch logging option updates.

CodeContent

Specifies either the application code, or the location of the application code, for a Flink-based Kinesis Data Analytics application.

CodeContentDescription

Describes details about the code of a Kinesis Data Analytics application.

CodeContentUpdate

Describes an update to the code of an application. Not supported for Apache Zeppelin.

CreateApplicationPresignedUrlRequest
CreateApplicationPresignedUrlResponse
CreateApplicationRequest
CreateApplicationResponse
CreateApplicationSnapshotRequest
CSVMappingParameters

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:

CustomArtifactConfiguration

Specifies dependency JARs, as well as JAR files that contain user-defined functions (UDF).

CustomArtifactConfigurationDescription

Specifies a dependency JAR or a JAR of user-defined functions.

DeleteApplicationCloudWatchLoggingOptionRequest
DeleteApplicationCloudWatchLoggingOptionResponse
DeleteApplicationInputProcessingConfigurationRequest
DeleteApplicationInputProcessingConfigurationResponse
DeleteApplicationOutputRequest
DeleteApplicationOutputResponse
DeleteApplicationReferenceDataSourceRequest
DeleteApplicationReferenceDataSourceResponse
DeleteApplicationRequest
DeleteApplicationSnapshotRequest
DeleteApplicationVpcConfigurationRequest
DeleteApplicationVpcConfigurationResponse
DeployAsApplicationConfiguration

The information required to deploy a Kinesis Data Analytics Studio notebook as an application with durable state.

DeployAsApplicationConfigurationDescription

The configuration information required to deploy an Amazon Data Analytics Studio notebook as an application with durable state.

DeployAsApplicationConfigurationUpdate

Updates to the configuration information required to deploy an Amazon Data Analytics Studio notebook as an application with durable state.

DescribeApplicationRequest
DescribeApplicationResponse
DescribeApplicationSnapshotRequest
DescribeApplicationSnapshotResponse
DescribeApplicationVersionRequest
DescribeApplicationVersionResponse
DestinationSchema

Describes the data format when records are written to the destination in a SQL-based Kinesis Data Analytics application.

DiscoverInputSchemaRequest
DiscoverInputSchemaResponse
EnvironmentProperties

Describes execution properties for a Flink-based Kinesis Data Analytics application.

EnvironmentPropertyDescriptions

Describes the execution properties for an Apache Flink runtime.

EnvironmentPropertyUpdates

Describes updates to the execution property groups for a Flink-based Kinesis Data Analytics application or a Studio notebook.

FlinkApplicationConfiguration

Describes configuration parameters for a Flink-based Kinesis Data Analytics application or a Studio notebook.

FlinkApplicationConfigurationDescription

Describes configuration parameters for a Flink-based Kinesis Data Analytics application.

FlinkApplicationConfigurationUpdate

Describes updates to the configuration parameters for a Flink-based Kinesis Data Analytics application.

FlinkRunConfiguration

Describes the starting parameters for a Flink-based Kinesis Data Analytics application.

GlueDataCatalogConfiguration

The configuration of the Glue Data Catalog that you use for Apache Flink SQL queries and table API transforms that you write in an application.

GlueDataCatalogConfigurationDescription

The configuration of the Glue Data Catalog that you use for Apache Flink SQL queries and table API transforms that you write in an application.

GlueDataCatalogConfigurationUpdate

Updates to the configuration of the Glue Data Catalog that you use for SQL queries that you write in a Kinesis Data Analytics Studio notebook.

Input

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.

InputDescription

Describes the application input configuration for a SQL-based Kinesis Data Analytics application.

InputLambdaProcessor

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.

InputLambdaProcessorDescription

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.

InputLambdaProcessorUpdate

For a SQL-based Kinesis Data Analytics application, represents an update to the "InputLambdaProcessor" that is used to preprocess the records in the stream.

InputParallelism

For a SQL-based Kinesis Data Analytics application, describes the number of in-application streams to create for a given streaming source.

InputParallelismUpdate

For a SQL-based Kinesis Data Analytics application, provides updates to the parallelism count.

InputProcessingConfiguration

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.

InputProcessingConfigurationDescription

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.

InputProcessingConfigurationUpdate

For a SQL-based Kinesis Data Analytics application, describes updates to an "InputProcessingConfiguration".

InputSchemaUpdate

Describes updates for an SQL-based Kinesis Data Analytics application's input schema.

InputStartingPositionConfiguration

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

InputUpdate

For a SQL-based Kinesis Data Analytics application, describes updates to a specific input configuration (identified by the InputId of an application).

JSONMappingParameters

For a SQL-based Kinesis Data Analytics application, provides additional mapping information when JSON is the record format on the streaming source.

KinesisFirehoseInput

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

KinesisFirehoseInputDescription

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

KinesisFirehoseInputUpdate

For a SQL-based Kinesis Data Analytics application, when updating application input configuration, provides information about a Kinesis Data Firehose delivery stream as the streaming source.

KinesisFirehoseOutput

For a SQL-based Kinesis Data Analytics application, when configuring application output, identifies a Kinesis Data Firehose delivery stream as the destination. You provide the stream Amazon Resource Name (ARN) of the delivery stream.

KinesisFirehoseOutputDescription

For a SQL-based Kinesis Data Analytics application's output, describes the Kinesis Data Firehose delivery stream that is configured as its destination.

KinesisFirehoseOutputUpdate

For a SQL-based Kinesis Data Analytics application, when updating an output configuration using the "UpdateApplication" operation, provides information about a Kinesis Data Firehose delivery stream that is configured as the destination.

KinesisStreamsInput

Identifies a Kinesis data stream as the streaming source. You provide the stream's Amazon Resource Name (ARN).

KinesisStreamsInputDescription

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.

KinesisStreamsInputUpdate

When you update the input configuration for a SQL-based Kinesis Data Analytics application, provides information about a Kinesis stream as the streaming source.

KinesisStreamsOutput

When you configure a SQL-based Kinesis Data Analytics application's output, identifies a Kinesis data stream as the destination. You provide the stream Amazon Resource Name (ARN).

KinesisStreamsOutputDescription

For an SQL-based Kinesis Data Analytics application's output, describes the Kinesis data stream that is configured as its destination.

KinesisStreamsOutputUpdate

When you update a SQL-based Kinesis Data Analytics application's output configuration using the "UpdateApplication" operation, provides information about a Kinesis data stream that is configured as the destination.

LambdaOutput

When you configure a SQL-based Kinesis Data Analytics application's output, identifies an Amazon Lambda function as the destination. You provide the function Amazon Resource Name (ARN) of the Lambda function.

LambdaOutputDescription

For a SQL-based Kinesis Data Analytics application's output, describes the Amazon Lambda function that is configured as its destination.

LambdaOutputUpdate

When you update an SQL-based Kinesis Data Analytics application's output configuration using the "UpdateApplication" operation, provides information about an Amazon Lambda function that is configured as the destination.

ListApplicationSnapshotsRequest
ListApplicationSnapshotsResponse
ListApplicationsRequest
ListApplicationsResponse
ListApplicationVersionsRequest
ListApplicationVersionsResponse
ListTagsForResourceRequest
ListTagsForResourceResponse
MappingParameters

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.

MavenReference

The information required to specify a Maven reference. You can use Maven references to specify dependency JAR files.

MonitoringConfiguration

Describes configuration parameters for Amazon CloudWatch logging for an application. For more information about CloudWatch logging, see Monitoring.

MonitoringConfigurationDescription

Describes configuration parameters for CloudWatch logging for an application.

MonitoringConfigurationUpdate

Describes updates to configuration parameters for Amazon CloudWatch logging for an application.

Output

Describes a SQL-based Kinesis Data Analytics application's 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 a Kinesis data stream or a Kinesis Data Firehose delivery stream.

OutputDescription

For a SQL-based Kinesis Data Analytics application, 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 a Kinesis data stream or a Kinesis Data Firehose delivery stream.

OutputUpdate

For a SQL-based Kinesis Data Analytics application, describes updates to the output configuration identified by the OutputId.

ParallelismConfiguration

Describes parameters for how a Flink-based Kinesis Data Analytics application executes multiple tasks simultaneously. For more information about parallelism, see Parallel Execution in the Apache Flink Documentation.

ParallelismConfigurationDescription

Describes parameters for how a Flink-based Kinesis Data Analytics application executes multiple tasks simultaneously.

ParallelismConfigurationUpdate

Describes updates to parameters for how an application executes multiple tasks simultaneously.

PropertyGroup

Property key-value pairs passed into an application.

RecordColumn

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.

RecordFormat

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.

ReferenceDataSource

For a SQL-based Kinesis Data Analytics application, describes the reference data source by providing the source information (Amazon 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.

ReferenceDataSourceDescription

For a SQL-based Kinesis Data Analytics application, describes the reference data source configured for an application.

ReferenceDataSourceUpdate

When you update a reference data source configuration for a SQL-based Kinesis Data Analytics 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.

RollbackApplicationRequest
RollbackApplicationResponse
RunConfiguration

Describes the starting parameters for an Kinesis Data Analytics application.

RunConfigurationDescription

Describes the starting properties for a Kinesis Data Analytics application.

RunConfigurationUpdate

Describes the updates to the starting parameters for a Kinesis Data Analytics application.

S3ApplicationCodeLocationDescription

Describes the location of an application's code stored in an S3 bucket.

S3Configuration

For a SQL-based Kinesis Data Analytics application, provides a description of an Amazon S3 data source, including the Amazon Resource Name (ARN) of the S3 bucket and the name of the Amazon S3 object that contains the data.

S3ContentBaseLocation

The S3 bucket that holds the application information.

S3ContentBaseLocationDescription

The description of the S3 base location that holds the application.

S3ContentBaseLocationUpdate

The information required to update the S3 base location that holds the application.

S3ContentLocation

For a Kinesis Data Analytics application provides a description of an Amazon S3 object, including the Amazon Resource Name (ARN) of the S3 bucket, the name of the Amazon S3 object that contains the data, and the version number of the Amazon S3 object that contains the data.

S3ContentLocationUpdate

Describes an update for the Amazon S3 code content location for an application.

S3ReferenceDataSource

For a SQL-based Kinesis Data Analytics application, identifies the Amazon S3 bucket and object that contains the reference data.

S3ReferenceDataSourceDescription

For a SQL-based Kinesis Data Analytics application, provides the bucket name and object key name that stores the reference data.

S3ReferenceDataSourceUpdate

For a SQL-based Kinesis Data Analytics application, describes the Amazon S3 bucket name and object key name for an in-application reference table.

SnapshotDetails

Provides details about a snapshot of application state.

SourceSchema

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.

SqlApplicationConfiguration

Describes the inputs, outputs, and reference data sources for a SQL-based Kinesis Data Analytics application.

SqlApplicationConfigurationDescription

Describes the inputs, outputs, and reference data sources for a SQL-based Kinesis Data Analytics application.

SqlApplicationConfigurationUpdate

Describes updates to the input streams, destination streams, and reference data sources for a SQL-based Kinesis Data Analytics application.

SqlRunConfiguration

Describes the starting parameters for a SQL-based Kinesis Data Analytics application.

StartApplicationRequest
StopApplicationRequest
Tag

A key-value pair (the value is optional) that you can define and assign to Amazon 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.

TagResourceRequest
UntagResourceRequest
UpdateApplicationMaintenanceConfigurationRequest
UpdateApplicationMaintenanceConfigurationResponse
UpdateApplicationRequest
UpdateApplicationResponse
VpcConfiguration

Describes the parameters of a VPC used by the application.

VpcConfigurationDescription

Describes the parameters of a VPC used by the application.

VpcConfigurationUpdate

Describes updates to the VPC configuration used by the application.

ZeppelinApplicationConfiguration

The configuration of a Kinesis Data Analytics Studio notebook.

ZeppelinApplicationConfigurationDescription

The configuration of a Kinesis Data Analytics Studio notebook.

ZeppelinApplicationConfigurationUpdate

Updates to the configuration of Kinesis Data Analytics Studio notebook.

ZeppelinMonitoringConfiguration

Describes configuration parameters for Amazon CloudWatch logging for a Kinesis Data Analytics Studio notebook. For more information about CloudWatch logging, see Monitoring.

ZeppelinMonitoringConfigurationDescription

The monitoring configuration for Apache Zeppelin within a Kinesis Data Analytics Studio notebook.

ZeppelinMonitoringConfigurationUpdate

Updates to the monitoring configuration for Apache Zeppelin within a Kinesis Data Analytics Studio notebook.

§Type Aliases

ApplicationMode
ApplicationRestoreType
ApplicationStatus
ArtifactType
CodeContentType
ConfigurationType
InputStartingPosition
LogLevel
MetricsLevel
RecordFormatType
RuntimeEnvironment
SnapshotStatus
UrlType