kinesisanalytics/aws.sdk.kotlin.services.kinesisanalytics/KinesisAnalyticsClient

KinesisAnalyticsClient

interface KinesisAnalyticsClient : SdkClient

Amazon Kinesis Analytics

Overview

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 /kinesisanalytics/latest/apiv2/Welcome.html.

This is the Amazon Kinesis Analytics v1 API Reference. The Amazon Kinesis Analytics Developer Guide provides additional information.

Properties

Link copied to clipboard
abstract override val config: KinesisAnalyticsClient.Config

KinesisAnalyticsClient's configuration

Functions

Link copied to clipboard
abstract suspend fun addApplicationCloudWatchLoggingOption(input: AddApplicationCloudWatchLoggingOptionRequest): AddApplicationCloudWatchLoggingOptionResponse

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 /kinesisanalytics/latest/apiv2/Welcome.html.

Link copied to clipboard
abstract suspend fun addApplicationInput(input: AddApplicationInputRequest): AddApplicationInputResponse

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 /kinesisanalytics/latest/apiv2/Welcome.html.

abstract suspend fun addApplicationInputProcessingConfiguration(input: AddApplicationInputProcessingConfigurationRequest): AddApplicationInputProcessingConfigurationResponse

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 /kinesisanalytics/latest/apiv2/Welcome.html.

Link copied to clipboard
abstract suspend fun addApplicationOutput(input: AddApplicationOutputRequest): AddApplicationOutputResponse

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 /kinesisanalytics/latest/apiv2/Welcome.html.

Link copied to clipboard
abstract suspend fun addApplicationReferenceDataSource(input: AddApplicationReferenceDataSourceRequest): AddApplicationReferenceDataSourceResponse

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 /kinesisanalytics/latest/apiv2/Welcome.html.

Link copied to clipboard
abstract suspend fun createApplication(input: CreateApplicationRequest): CreateApplicationResponse

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 /kinesisanalytics/latest/apiv2/Welcome.html.

Link copied to clipboard
abstract suspend fun deleteApplication(input: DeleteApplicationRequest): DeleteApplicationResponse

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 /kinesisanalytics/latest/apiv2/Welcome.html.

Link copied to clipboard
abstract suspend fun deleteApplicationCloudWatchLoggingOption(input: DeleteApplicationCloudWatchLoggingOptionRequest): DeleteApplicationCloudWatchLoggingOptionResponse

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 /kinesisanalytics/latest/apiv2/Welcome.html.

abstract suspend fun deleteApplicationInputProcessingConfiguration(input: DeleteApplicationInputProcessingConfigurationRequest): DeleteApplicationInputProcessingConfigurationResponse

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 /kinesisanalytics/latest/apiv2/Welcome.html.

Link copied to clipboard
abstract suspend fun deleteApplicationOutput(input: DeleteApplicationOutputRequest): DeleteApplicationOutputResponse

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 /kinesisanalytics/latest/apiv2/Welcome.html.

Link copied to clipboard
abstract suspend fun deleteApplicationReferenceDataSource(input: DeleteApplicationReferenceDataSourceRequest): DeleteApplicationReferenceDataSourceResponse

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 /kinesisanalytics/latest/apiv2/Welcome.html.

Link copied to clipboard
abstract suspend fun describeApplication(input: DescribeApplicationRequest): DescribeApplicationResponse

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 /kinesisanalytics/latest/apiv2/Welcome.html.

Link copied to clipboard
abstract suspend fun discoverInputSchema(input: DiscoverInputSchemaRequest = DiscoverInputSchemaRequest { }): DiscoverInputSchemaResponse

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 /kinesisanalytics/latest/apiv2/Welcome.html.

Link copied to clipboard
abstract suspend fun listApplications(input: ListApplicationsRequest = ListApplicationsRequest { }): ListApplicationsResponse

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 /kinesisanalytics/latest/apiv2/Welcome.html.

Link copied to clipboard
abstract suspend fun listTagsForResource(input: ListTagsForResourceRequest): ListTagsForResourceResponse

Retrieves the list of key-value tags assigned to the application. For more information, see Using Tagging.

Link copied to clipboard
abstract suspend fun startApplication(input: StartApplicationRequest): StartApplicationResponse

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 /kinesisanalytics/latest/apiv2/Welcome.html.

Link copied to clipboard
abstract suspend fun stopApplication(input: StopApplicationRequest): StopApplicationResponse

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 /kinesisanalytics/latest/apiv2/Welcome.html.

Link copied to clipboard
abstract suspend fun tagResource(input: TagResourceRequest): TagResourceResponse

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.

Link copied to clipboard
abstract suspend fun untagResource(input: UntagResourceRequest): UntagResourceResponse

Removes one or more tags from a Kinesis Analytics application. For more information, see Using Tagging.

Link copied to clipboard
abstract suspend fun updateApplication(input: UpdateApplicationRequest): UpdateApplicationResponse

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 /kinesisanalytics/latest/apiv2/Welcome.html.

Inherited functions

Link copied to clipboard
inline suspend fun KinesisAnalyticsClient.addApplicationCloudWatchLoggingOption(crossinline block: AddApplicationCloudWatchLoggingOptionRequest.Builder.() -> Unit): AddApplicationCloudWatchLoggingOptionResponse

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 /kinesisanalytics/latest/apiv2/Welcome.html.

Link copied to clipboard
inline suspend fun KinesisAnalyticsClient.addApplicationInput(crossinline block: AddApplicationInputRequest.Builder.() -> Unit): AddApplicationInputResponse

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 /kinesisanalytics/latest/apiv2/Welcome.html.

inline suspend fun KinesisAnalyticsClient.addApplicationInputProcessingConfiguration(crossinline block: AddApplicationInputProcessingConfigurationRequest.Builder.() -> Unit): AddApplicationInputProcessingConfigurationResponse

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 /kinesisanalytics/latest/apiv2/Welcome.html.

Link copied to clipboard
inline suspend fun KinesisAnalyticsClient.addApplicationOutput(crossinline block: AddApplicationOutputRequest.Builder.() -> Unit): AddApplicationOutputResponse

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 /kinesisanalytics/latest/apiv2/Welcome.html.

Link copied to clipboard
inline suspend fun KinesisAnalyticsClient.addApplicationReferenceDataSource(crossinline block: AddApplicationReferenceDataSourceRequest.Builder.() -> Unit): AddApplicationReferenceDataSourceResponse

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 /kinesisanalytics/latest/apiv2/Welcome.html.

Link copied to clipboard
expect abstract fun close()
Link copied to clipboard
inline suspend fun KinesisAnalyticsClient.createApplication(crossinline block: CreateApplicationRequest.Builder.() -> Unit): CreateApplicationResponse

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 /kinesisanalytics/latest/apiv2/Welcome.html.

Link copied to clipboard
inline suspend fun KinesisAnalyticsClient.deleteApplication(crossinline block: DeleteApplicationRequest.Builder.() -> Unit): DeleteApplicationResponse

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 /kinesisanalytics/latest/apiv2/Welcome.html.

Link copied to clipboard
inline suspend fun KinesisAnalyticsClient.deleteApplicationCloudWatchLoggingOption(crossinline block: DeleteApplicationCloudWatchLoggingOptionRequest.Builder.() -> Unit): DeleteApplicationCloudWatchLoggingOptionResponse

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 /kinesisanalytics/latest/apiv2/Welcome.html.

inline suspend fun KinesisAnalyticsClient.deleteApplicationInputProcessingConfiguration(crossinline block: DeleteApplicationInputProcessingConfigurationRequest.Builder.() -> Unit): DeleteApplicationInputProcessingConfigurationResponse

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 /kinesisanalytics/latest/apiv2/Welcome.html.

Link copied to clipboard
inline suspend fun KinesisAnalyticsClient.deleteApplicationOutput(crossinline block: DeleteApplicationOutputRequest.Builder.() -> Unit): DeleteApplicationOutputResponse

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 /kinesisanalytics/latest/apiv2/Welcome.html.

Link copied to clipboard
inline suspend fun KinesisAnalyticsClient.deleteApplicationReferenceDataSource(crossinline block: DeleteApplicationReferenceDataSourceRequest.Builder.() -> Unit): DeleteApplicationReferenceDataSourceResponse

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 /kinesisanalytics/latest/apiv2/Welcome.html.

Link copied to clipboard
inline suspend fun KinesisAnalyticsClient.describeApplication(crossinline block: DescribeApplicationRequest.Builder.() -> Unit): DescribeApplicationResponse

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 /kinesisanalytics/latest/apiv2/Welcome.html.

Link copied to clipboard
inline suspend fun KinesisAnalyticsClient.discoverInputSchema(crossinline block: DiscoverInputSchemaRequest.Builder.() -> Unit): DiscoverInputSchemaResponse

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 /kinesisanalytics/latest/apiv2/Welcome.html.

Link copied to clipboard
inline suspend fun KinesisAnalyticsClient.listApplications(crossinline block: ListApplicationsRequest.Builder.() -> Unit): ListApplicationsResponse

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 /kinesisanalytics/latest/apiv2/Welcome.html.

Link copied to clipboard
inline suspend fun KinesisAnalyticsClient.listTagsForResource(crossinline block: ListTagsForResourceRequest.Builder.() -> Unit): ListTagsForResourceResponse

Retrieves the list of key-value tags assigned to the application. For more information, see Using Tagging.

Link copied to clipboard
inline suspend fun KinesisAnalyticsClient.startApplication(crossinline block: StartApplicationRequest.Builder.() -> Unit): StartApplicationResponse

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 /kinesisanalytics/latest/apiv2/Welcome.html.

Link copied to clipboard
inline suspend fun KinesisAnalyticsClient.stopApplication(crossinline block: StopApplicationRequest.Builder.() -> Unit): StopApplicationResponse

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 /kinesisanalytics/latest/apiv2/Welcome.html.

Link copied to clipboard
inline suspend fun KinesisAnalyticsClient.tagResource(crossinline block: TagResourceRequest.Builder.() -> Unit): TagResourceResponse

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.

Link copied to clipboard
inline suspend fun KinesisAnalyticsClient.untagResource(crossinline block: UntagResourceRequest.Builder.() -> Unit): UntagResourceResponse

Removes one or more tags from a Kinesis Analytics application. For more information, see Using Tagging.

Link copied to clipboard
inline suspend fun KinesisAnalyticsClient.updateApplication(crossinline block: UpdateApplicationRequest.Builder.() -> Unit): UpdateApplicationResponse

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 /kinesisanalytics/latest/apiv2/Welcome.html.

Link copied to clipboard
fun KinesisAnalyticsClient.withConfig(block: KinesisAnalyticsClient.Config.Builder.() -> Unit): KinesisAnalyticsClient

Create a copy of the client with one or more configuration values overridden. This method allows the caller to perform scoped config overrides for one or more client operations.