KinesisAnalytics / Client / delete_application_reference_data_source

delete_application_reference_data_source

KinesisAnalytics.Client.delete_application_reference_data_source(**kwargs)

Note

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 AddApplicationReferenceDataSource operation.

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

See also: AWS API Documentation

Request Syntax

response = client.delete_application_reference_data_source(
    ApplicationName='string',
    CurrentApplicationVersionId=123,
    ReferenceId='string'
)
Parameters:

  • ApplicationName (string) –

    [REQUIRED]

    Name of an existing application.

  • CurrentApplicationVersionId (integer) –

    [REQUIRED]

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

  • ReferenceId (string) –

    [REQUIRED]

    ID of the reference data source. When you add a reference data source to your application using the AddApplicationReferenceDataSource, Amazon Kinesis Analytics assigns an ID. You can use the DescribeApplication operation to get the reference ID.

Return type:

dict

Returns:

Response Syntax

{}

Response Structure

  • (dict) –

Exceptions

  • KinesisAnalytics.Client.exceptions.ResourceNotFoundException

  • KinesisAnalytics.Client.exceptions.ResourceInUseException

  • KinesisAnalytics.Client.exceptions.InvalidArgumentException

  • KinesisAnalytics.Client.exceptions.ConcurrentModificationException

  • KinesisAnalytics.Client.exceptions.UnsupportedOperationException