Skip to content

delete_application_output 

delete_application_output(
    application_name: ApplicationName,
    current_application_version_id: ApplicationVersionId,
    output_id: Id,
    *,
    config_overrides: Optional[KinesisAnalyticsV2ClientConfig] = None,
) -> 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.

Parameters:

  • application_name (ApplicationName) –

    The application name.

  • current_application_version_id (ApplicationVersionId) –

    The 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.

  • output_id (Id) –

    The ID of the configuration to delete. Each output configuration that is added to the application (either when the application is created or later) using the AddApplicationOutput operation has a unique ID. You need to provide the ID to uniquely identify the output configuration that you want to delete from the application configuration. You can use the DescribeApplication operation to get the specific OutputId.

Raises:

Source code in docs_src/capo_kinesis_analytics_v2/_services/kinesis_analytics_v2.py 
 982
 983
 984
 985
 986
 987
 988
 989
 990
 991
 992
 993
 994
 995
 996
 997
 998
 999
1000
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
def delete_application_output(
    self,
    application_name: "capo_kinesis_analytics_v2.types.application_name.ApplicationName",
    current_application_version_id: "capo_kinesis_analytics_v2.types.application_version_id.ApplicationVersionId",
    output_id: "capo_kinesis_analytics_v2.types.id.Id",
    *,
    config_overrides: Optional[KinesisAnalyticsV2ClientConfig] = None,
) -> "capo_kinesis_analytics_v2.types.delete_application_output_response.DeleteApplicationOutputResponse":
    """<p>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.</p>

    Args:
        application_name: <p>The application name.</p>
        current_application_version_id: <p>The 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>
        output_id: <p>The ID of the configuration to delete. Each output configuration that is added to the application (either when the application is created or later) using the <a>AddApplicationOutput</a> operation has a unique ID. You need to provide the ID to uniquely identify the output configuration that you want to delete from the application configuration. You can use the <a>DescribeApplication</a> operation to get the specific <code>OutputId</code>. </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_output_request.DeleteApplicationOutputRequest]",
    ) -> OperationResponse[
        "capo_kinesis_analytics_v2.types.delete_application_output_response.DeleteApplicationOutputResponse"
    ]:
        import capo_kinesis_analytics_v2._operations.kinesis_analytics_20180523.delete_application_output

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

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("DeleteApplicationOutput")
    )
    input_: capo_kinesis_analytics_v2.types.delete_application_output_request.DeleteApplicationOutputRequest = {
        "application_name": application_name,
        "current_application_version_id": current_application_version_id,
        "output_id": output_id,
    }

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