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

KinesisAnalyticsClient

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.

Types

Builder

class Builder

Companion

object Companion

Config

class Config

Properties

config

abstract val config: KinesisAnalyticsClient.Config

KinesisAnalyticsClient's configuration

Functions

addApplicationCloudWatchLoggingOption

abstract suspend fun addApplicationCloudWatchLoggingOption(input: AddApplicationCloudWatchLoggingOptionRequest): AddApplicationCloudWatchLoggingOptionResponse

addApplicationInput

abstract suspend fun addApplicationInput(input: AddApplicationInputRequest): AddApplicationInputResponse

addApplicationInputProcessingConfiguration

abstract suspend fun addApplicationInputProcessingConfiguration(input: AddApplicationInputProcessingConfigurationRequest): AddApplicationInputProcessingConfigurationResponse

addApplicationOutput

abstract suspend fun addApplicationOutput(input: AddApplicationOutputRequest): AddApplicationOutputResponse

addApplicationReferenceDataSource

abstract suspend fun addApplicationReferenceDataSource(input: AddApplicationReferenceDataSourceRequest): AddApplicationReferenceDataSourceResponse

createApplication

abstract suspend fun createApplication(input: CreateApplicationRequest): CreateApplicationResponse

deleteApplication

abstract suspend fun deleteApplication(input: DeleteApplicationRequest): DeleteApplicationResponse

deleteApplicationCloudWatchLoggingOption

abstract suspend fun deleteApplicationCloudWatchLoggingOption(input: DeleteApplicationCloudWatchLoggingOptionRequest): DeleteApplicationCloudWatchLoggingOptionResponse

deleteApplicationInputProcessingConfiguration

abstract suspend fun deleteApplicationInputProcessingConfiguration(input: DeleteApplicationInputProcessingConfigurationRequest): DeleteApplicationInputProcessingConfigurationResponse

deleteApplicationOutput

abstract suspend fun deleteApplicationOutput(input: DeleteApplicationOutputRequest): DeleteApplicationOutputResponse

deleteApplicationReferenceDataSource

abstract suspend fun deleteApplicationReferenceDataSource(input: DeleteApplicationReferenceDataSourceRequest): DeleteApplicationReferenceDataSourceResponse

describeApplication

abstract suspend fun describeApplication(input: DescribeApplicationRequest): DescribeApplicationResponse

discoverInputSchema

abstract suspend fun discoverInputSchema(input: DiscoverInputSchemaRequest = DiscoverInputSchemaRequest { }): DiscoverInputSchemaResponse

listApplications

abstract suspend fun listApplications(input: ListApplicationsRequest = ListApplicationsRequest { }): ListApplicationsResponse

listTagsForResource

abstract suspend fun listTagsForResource(input: ListTagsForResourceRequest): ListTagsForResourceResponse

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

startApplication

abstract suspend fun startApplication(input: StartApplicationRequest): StartApplicationResponse

stopApplication

abstract suspend fun stopApplication(input: StopApplicationRequest): StopApplicationResponse

tagResource

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.

untagResource

abstract suspend fun untagResource(input: UntagResourceRequest): UntagResourceResponse

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

updateApplication

abstract suspend fun updateApplication(input: UpdateApplicationRequest): UpdateApplicationResponse

Inherited functions

addApplicationCloudWatchLoggingOption

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

addApplicationInput

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

addApplicationInputProcessingConfiguration

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

addApplicationOutput

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

addApplicationReferenceDataSource

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

createApplication

inline suspend fun KinesisAnalyticsClient.createApplication(crossinline block: CreateApplicationRequest.Builder.() -> Unit): CreateApplicationResponse

deleteApplication

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

deleteApplicationCloudWatchLoggingOption

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

deleteApplicationInputProcessingConfiguration

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

deleteApplicationOutput

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

deleteApplicationReferenceDataSource

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

describeApplication

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

discoverInputSchema

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

listApplications

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

listTagsForResource

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.

startApplication

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

stopApplication

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

tagResource

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

untagResource

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.

updateApplication

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

withConfig

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.