kinesisanalyticsv2/aws.sdk.kotlin.services.kinesisanalyticsv2/KinesisAnalyticsV2Client

KinesisAnalyticsV2Client

interface KinesisAnalyticsV2Client : SdkClient

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.

Types

Builder

class Builder : AbstractSdkClientBuilder<KinesisAnalyticsV2Client.Config, KinesisAnalyticsV2Client.Config.Builder, KinesisAnalyticsV2Client>

Companion

object Companion : AbstractAwsSdkClientFactory<KinesisAnalyticsV2Client.Config, KinesisAnalyticsV2Client.Config.Builder, KinesisAnalyticsV2Client, KinesisAnalyticsV2Client.Builder>

Config

class Config : AwsSdkClientConfig, CredentialsProviderConfig, HttpAuthConfig, HttpClientConfig, HttpEngineConfig, RetryClientConfig, RetryStrategyClientConfig, SdkClientConfig, TelemetryConfig

Properties

config

abstract override val config: KinesisAnalyticsV2Client.Config

KinesisAnalyticsV2Client's configuration

Functions

addApplicationCloudWatchLoggingOption

abstract suspend fun addApplicationCloudWatchLoggingOption(input: AddApplicationCloudWatchLoggingOptionRequest): AddApplicationCloudWatchLoggingOptionResponse

Adds an Amazon CloudWatch log stream to monitor application configuration errors.

addApplicationInput

abstract suspend fun addApplicationInput(input: AddApplicationInputRequest): AddApplicationInputResponse

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

addApplicationInputProcessingConfiguration

abstract suspend fun addApplicationInputProcessingConfiguration(input: AddApplicationInputProcessingConfigurationRequest): AddApplicationInputProcessingConfigurationResponse

Adds an InputProcessingConfiguration to a SQL-based Kinesis Data Analytics application. An input processor pre-processes records on the input stream before the application's SQL code executes. Currently, the only input processor available is Amazon Lambda.

addApplicationOutput

abstract suspend fun addApplicationOutput(input: AddApplicationOutputRequest): AddApplicationOutputResponse

Adds an external destination to your SQL-based Kinesis Data Analytics application.

addApplicationReferenceDataSource

abstract suspend fun addApplicationReferenceDataSource(input: AddApplicationReferenceDataSourceRequest): AddApplicationReferenceDataSourceResponse

Adds a reference data source to an existing SQL-based Kinesis Data Analytics application.

addApplicationVpcConfiguration

abstract suspend fun addApplicationVpcConfiguration(input: AddApplicationVpcConfigurationRequest): AddApplicationVpcConfigurationResponse

Adds a Virtual Private Cloud (VPC) configuration to the application. Applications can use VPCs to store and access resources securely.

createApplication

abstract suspend fun createApplication(input: CreateApplicationRequest): CreateApplicationResponse

Creates a Kinesis Data Analytics application. For information about creating a Kinesis Data Analytics application, see Creating an Application.

createApplicationPresignedUrl

abstract suspend fun createApplicationPresignedUrl(input: CreateApplicationPresignedUrlRequest): CreateApplicationPresignedUrlResponse

Creates and returns a URL that you can use to connect to an application's extension.

createApplicationSnapshot

abstract suspend fun createApplicationSnapshot(input: CreateApplicationSnapshotRequest): CreateApplicationSnapshotResponse

Creates a snapshot of the application's state data.

deleteApplication

abstract suspend fun deleteApplication(input: DeleteApplicationRequest): DeleteApplicationResponse

Deletes the specified application. Kinesis Data Analytics halts application execution and deletes the application.

deleteApplicationCloudWatchLoggingOption

abstract suspend fun deleteApplicationCloudWatchLoggingOption(input: DeleteApplicationCloudWatchLoggingOptionRequest): DeleteApplicationCloudWatchLoggingOptionResponse

Deletes an Amazon CloudWatch log stream from an Kinesis Data Analytics application.

deleteApplicationInputProcessingConfiguration

abstract suspend fun deleteApplicationInputProcessingConfiguration(input: DeleteApplicationInputProcessingConfigurationRequest): DeleteApplicationInputProcessingConfigurationResponse

Deletes an InputProcessingConfiguration from an input.

deleteApplicationOutput

abstract suspend fun deleteApplicationOutput(input: DeleteApplicationOutputRequest): DeleteApplicationOutputResponse

Deletes the output destination configuration from your SQL-based Kinesis Data Analytics application's configuration. Kinesis Data Analytics will no longer write data from the corresponding in-application stream to the external output destination.

deleteApplicationReferenceDataSource

abstract suspend fun deleteApplicationReferenceDataSource(input: DeleteApplicationReferenceDataSourceRequest): DeleteApplicationReferenceDataSourceResponse

Deletes a reference data source configuration from the specified SQL-based Kinesis Data Analytics application's configuration.

deleteApplicationSnapshot

abstract suspend fun deleteApplicationSnapshot(input: DeleteApplicationSnapshotRequest): DeleteApplicationSnapshotResponse

Deletes a snapshot of application state.

deleteApplicationVpcConfiguration

abstract suspend fun deleteApplicationVpcConfiguration(input: DeleteApplicationVpcConfigurationRequest): DeleteApplicationVpcConfigurationResponse

Removes a VPC configuration from a Kinesis Data Analytics application.

describeApplication

abstract suspend fun describeApplication(input: DescribeApplicationRequest): DescribeApplicationResponse

Returns information about a specific Kinesis Data Analytics application.

describeApplicationSnapshot

abstract suspend fun describeApplicationSnapshot(input: DescribeApplicationSnapshotRequest): DescribeApplicationSnapshotResponse

Returns information about a snapshot of application state data.

describeApplicationVersion

abstract suspend fun describeApplicationVersion(input: DescribeApplicationVersionRequest): DescribeApplicationVersionResponse

Provides a detailed description of a specified version of the application. To see a list of all the versions of an application, invoke the ListApplicationVersions operation.

discoverInputSchema

abstract suspend fun discoverInputSchema(input: DiscoverInputSchemaRequest): DiscoverInputSchemaResponse

Infers a schema for a SQL-based Kinesis Data Analytics application by evaluating sample records on the specified streaming source (Kinesis data stream or Kinesis Data Firehose delivery stream) or Amazon S3 object. In the response, the operation returns the inferred schema and also the sample records that the operation used to infer the schema.

listApplications

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

Returns a list of Kinesis Data Analytics applications in your account. For each application, the response includes the application name, Amazon Resource Name (ARN), and status.

listApplicationSnapshots

abstract suspend fun listApplicationSnapshots(input: ListApplicationSnapshotsRequest): ListApplicationSnapshotsResponse

Lists information about the current application snapshots.

listApplicationVersions

abstract suspend fun listApplicationVersions(input: ListApplicationVersionsRequest): ListApplicationVersionsResponse

Lists all the versions for the specified application, including versions that were rolled back. The response also includes a summary of the configuration associated with each version.

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.

rollbackApplication

abstract suspend fun rollbackApplication(input: RollbackApplicationRequest): RollbackApplicationResponse

Reverts the application to the previous running version. You can roll back an application if you suspect it is stuck in a transient status.

startApplication

abstract suspend fun startApplication(input: StartApplicationRequest): StartApplicationResponse

Starts the specified Kinesis Data Analytics application. After creating an application, you must exclusively call this operation to start your application.

stopApplication

abstract suspend fun stopApplication(input: StopApplicationRequest): StopApplicationResponse

Stops the application from processing data. You can stop an application only if it is in the running status, unless you set the Force parameter to true.

tagResource

abstract suspend fun tagResource(input: TagResourceRequest): TagResourceResponse

Adds one or more key-value tags to a Kinesis Data 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 Data Analytics application. For more information, see Using Tagging.

updateApplication

abstract suspend fun updateApplication(input: UpdateApplicationRequest): UpdateApplicationResponse

Updates an existing Kinesis Data Analytics application. Using this operation, you can update application code, input configuration, and output configuration.

updateApplicationMaintenanceConfiguration

abstract suspend fun updateApplicationMaintenanceConfiguration(input: UpdateApplicationMaintenanceConfigurationRequest): UpdateApplicationMaintenanceConfigurationResponse

Updates the maintenance configuration of the Kinesis Data Analytics application.

Inherited functions

addApplicationCloudWatchLoggingOption

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

Adds an Amazon CloudWatch log stream to monitor application configuration errors.

addApplicationInput

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

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

addApplicationInputProcessingConfiguration

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

addApplicationOutput

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

Adds an external destination to your SQL-based Kinesis Data Analytics application.

addApplicationReferenceDataSource

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

Adds a reference data source to an existing SQL-based Kinesis Data Analytics application.

addApplicationVpcConfiguration

inline suspend fun KinesisAnalyticsV2Client.addApplicationVpcConfiguration(crossinline block: AddApplicationVpcConfigurationRequest.Builder.() -> Unit): AddApplicationVpcConfigurationResponse

Adds a Virtual Private Cloud (VPC) configuration to the application. Applications can use VPCs to store and access resources securely.

expect abstract fun close()

createApplication

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

Creates a Kinesis Data Analytics application. For information about creating a Kinesis Data Analytics application, see Creating an Application.

createApplicationPresignedUrl

inline suspend fun KinesisAnalyticsV2Client.createApplicationPresignedUrl(crossinline block: CreateApplicationPresignedUrlRequest.Builder.() -> Unit): CreateApplicationPresignedUrlResponse

Creates and returns a URL that you can use to connect to an application's extension.

createApplicationSnapshot

inline suspend fun KinesisAnalyticsV2Client.createApplicationSnapshot(crossinline block: CreateApplicationSnapshotRequest.Builder.() -> Unit): CreateApplicationSnapshotResponse

Creates a snapshot of the application's state data.

deleteApplication

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

Deletes the specified application. Kinesis Data Analytics halts application execution and deletes the application.

deleteApplicationCloudWatchLoggingOption

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

Deletes an Amazon CloudWatch log stream from an Kinesis Data Analytics application.

deleteApplicationInputProcessingConfiguration

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

Deletes an InputProcessingConfiguration from an input.

deleteApplicationOutput

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

deleteApplicationReferenceDataSource

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

Deletes a reference data source configuration from the specified SQL-based Kinesis Data Analytics application's configuration.

deleteApplicationSnapshot

inline suspend fun KinesisAnalyticsV2Client.deleteApplicationSnapshot(crossinline block: DeleteApplicationSnapshotRequest.Builder.() -> Unit): DeleteApplicationSnapshotResponse

Deletes a snapshot of application state.

deleteApplicationVpcConfiguration

inline suspend fun KinesisAnalyticsV2Client.deleteApplicationVpcConfiguration(crossinline block: DeleteApplicationVpcConfigurationRequest.Builder.() -> Unit): DeleteApplicationVpcConfigurationResponse

Removes a VPC configuration from a Kinesis Data Analytics application.

describeApplication

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

Returns information about a specific Kinesis Data Analytics application.

describeApplicationSnapshot

inline suspend fun KinesisAnalyticsV2Client.describeApplicationSnapshot(crossinline block: DescribeApplicationSnapshotRequest.Builder.() -> Unit): DescribeApplicationSnapshotResponse

Returns information about a snapshot of application state data.

describeApplicationVersion

inline suspend fun KinesisAnalyticsV2Client.describeApplicationVersion(crossinline block: DescribeApplicationVersionRequest.Builder.() -> Unit): DescribeApplicationVersionResponse

Provides a detailed description of a specified version of the application. To see a list of all the versions of an application, invoke the ListApplicationVersions operation.

discoverInputSchema

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

listApplications

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

Returns a list of Kinesis Data Analytics applications in your account. For each application, the response includes the application name, Amazon Resource Name (ARN), and status.

listApplicationSnapshots

inline suspend fun KinesisAnalyticsV2Client.listApplicationSnapshots(crossinline block: ListApplicationSnapshotsRequest.Builder.() -> Unit): ListApplicationSnapshotsResponse

Lists information about the current application snapshots.

listApplicationVersions

inline suspend fun KinesisAnalyticsV2Client.listApplicationVersions(crossinline block: ListApplicationVersionsRequest.Builder.() -> Unit): ListApplicationVersionsResponse

Lists all the versions for the specified application, including versions that were rolled back. The response also includes a summary of the configuration associated with each version.

listTagsForResource

inline suspend fun KinesisAnalyticsV2Client.listTagsForResource(crossinline block: ListTagsForResourceRequest.Builder.() -> Unit): ListTagsForResourceResponse

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

rollbackApplication

inline suspend fun KinesisAnalyticsV2Client.rollbackApplication(crossinline block: RollbackApplicationRequest.Builder.() -> Unit): RollbackApplicationResponse

Reverts the application to the previous running version. You can roll back an application if you suspect it is stuck in a transient status.

startApplication

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

Starts the specified Kinesis Data Analytics application. After creating an application, you must exclusively call this operation to start your application.

stopApplication

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

Stops the application from processing data. You can stop an application only if it is in the running status, unless you set the Force parameter to true.

tagResource

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

untagResource

inline suspend fun KinesisAnalyticsV2Client.untagResource(crossinline block: UntagResourceRequest.Builder.() -> Unit): UntagResourceResponse

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

updateApplication

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

Updates an existing Kinesis Data Analytics application. Using this operation, you can update application code, input configuration, and output configuration.

updateApplicationMaintenanceConfiguration

inline suspend fun KinesisAnalyticsV2Client.updateApplicationMaintenanceConfiguration(crossinline block: UpdateApplicationMaintenanceConfigurationRequest.Builder.() -> Unit): UpdateApplicationMaintenanceConfigurationResponse

Updates the maintenance configuration of the Kinesis Data Analytics application.

withConfig

fun KinesisAnalyticsV2Client.withConfig(block: KinesisAnalyticsV2Client.Config.Builder.() -> Unit): KinesisAnalyticsV2Client

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.