Skip to content

delete_application_reference_data_source

delete_application_reference_data_source(
    application_name: ApplicationName,
    current_application_version_id: ApplicationVersionId,
    reference_id: Id,
    *,
    config_overrides: Optional[KinesisAnalyticsV2ClientConfig] = None,
) -> DeleteApplicationReferenceDataSourceResponse

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

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

Parameters:

  • application_name (ApplicationName) –

    The name of an existing application.

  • current_application_version_id (ApplicationVersionId) –

    The current application version. 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.

  • reference_id (Id) –

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

Raises:

Source code in docs_src/capo_kinesis_analytics_v2/_services/kinesis_analytics_v2.py
def delete_application_reference_data_source(
    self,
    application_name: "capo_kinesis_analytics_v2.types.application_name.ApplicationName",
    current_application_version_id: "capo_kinesis_analytics_v2.types.application_version_id.ApplicationVersionId",
    reference_id: "capo_kinesis_analytics_v2.types.id.Id",
    *,
    config_overrides: Optional[KinesisAnalyticsV2ClientConfig] = None,
) -> "capo_kinesis_analytics_v2.types.delete_application_reference_data_source_response.DeleteApplicationReferenceDataSourceResponse":
    """<p>Deletes a reference data source configuration from the specified SQL-based Kinesis Data Analytics application's configuration.</p> <p>If the application is running, Kinesis Data Analytics immediately removes the in-application table that you created using the <a>AddApplicationReferenceDataSource</a> operation. </p>

    Args:
        application_name: <p>The name of an existing application.</p>
        current_application_version_id: <p>The current application version. You can use the <a>DescribeApplication</a> operation to get the current application version. If the version specified is not the current version, the <code>ConcurrentModificationException</code> is returned.</p>
        reference_id: <p>The ID of the reference data source. When you add a reference data source to your application using the <a>AddApplicationReferenceDataSource</a>, Kinesis Data Analytics assigns an ID. You can use the <a>DescribeApplication</a> operation to get the reference ID. </p>

    Raises:
        capo_kinesis_analytics_v2.errors.concurrent_modification_exception.ConcurrentModificationException: <p>Exception thrown as a result of concurrent modifications to an application. This error can be the result of attempting to modify an application without using the current application ID.</p>
        capo_kinesis_analytics_v2.errors.invalid_argument_exception.InvalidArgumentException: <p>The specified input parameter value is not valid.</p>
        capo_kinesis_analytics_v2.errors.invalid_request_exception.InvalidRequestException: <p>The request JSON is not valid for the operation.</p>
        capo_kinesis_analytics_v2.errors.resource_in_use_exception.ResourceInUseException: <p>The application is not available for this operation.</p>
        capo_kinesis_analytics_v2.errors.resource_not_found_exception.ResourceNotFoundException: <p>Specified application can't be found.</p>
        capo_kinesis_analytics_v2.errors.UnknownServiceError: The service returned an error code this client does not model.
    """

    def _handler(
        req: "OperationRequest[capo_kinesis_analytics_v2.types.delete_application_reference_data_source_request.DeleteApplicationReferenceDataSourceRequest]",
    ) -> OperationResponse[
        "capo_kinesis_analytics_v2.types.delete_application_reference_data_source_response.DeleteApplicationReferenceDataSourceResponse"
    ]:
        import capo_kinesis_analytics_v2._operations.kinesis_analytics_20180523.delete_application_reference_data_source

        output, http_response = (
            capo_kinesis_analytics_v2._operations.kinesis_analytics_20180523.delete_application_reference_data_source.delete_application_reference_data_source(
                req.options, req.input
            )
        )
        return OperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("DeleteApplicationReferenceDataSource")
    )
    input_: capo_kinesis_analytics_v2.types.delete_application_reference_data_source_request.DeleteApplicationReferenceDataSourceRequest = {
        "application_name": application_name,
        "current_application_version_id": current_application_version_id,
        "reference_id": reference_id,
    }

    response = execute_pipeline(
        OperationRequest(input=input_, options=options_),
        handler=_handler,
        interceptors=list(interceptors_),
    )
    response.response.close()
    return response.output