Delete Application Reference Data Source

kinesisanalytics_delete_application_reference_data_source

R Documentation

This documentation is for version 1 of the Amazon Kinesis Data Analytics API, which only supports SQL applications¶

Description¶

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 Amazon Kinesis Data Analytics API V2 Documentation.

Deletes a reference data source configuration from the specified application configuration.

If the application is running, Amazon Kinesis Analytics immediately removes the in-application table that you created using the add_application_reference_data_source operation.

This operation requires permissions to perform the kinesisanalytics.DeleteApplicationReferenceDataSource action.

Usage¶

kinesisanalytics_delete_application_reference_data_source(
  ApplicationName, CurrentApplicationVersionId, ReferenceId)

Arguments¶

ApplicationName

[required] Name of an existing application.

CurrentApplicationVersionId

[required] Version of the application. You can use the describe_application operation to get the current application version. If the version specified is not the current version, the ConcurrentModificationException is returned.

ReferenceId

[required] ID of the reference data source. When you add a reference data source to your application using the add_application_reference_data_source, Amazon Kinesis Analytics assigns an ID. You can use the describe_application operation to get the reference ID.

Value¶

An empty list.

Request syntax¶

svc$delete_application_reference_data_source(
  ApplicationName = "string",
  CurrentApplicationVersionId = 123,
  ReferenceId = "string"
)