KinesisAnalytics / Client / delete_application_output

delete_application_output#

KinesisAnalytics.Client.delete_application_output(**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 output destination configuration from your application configuration. Amazon Kinesis Analytics will no longer write data from the corresponding in-application stream to the external output destination.

This operation requires permissions to perform the kinesisanalytics:DeleteApplicationOutput action.

See also: AWS API Documentation

Request Syntax

response = client.delete_application_output(
    ApplicationName='string',
    CurrentApplicationVersionId=123,
    OutputId='string'
)
Parameters:

  • ApplicationName (string) –

    [REQUIRED]

    Amazon Kinesis Analytics application name.

  • CurrentApplicationVersionId (integer) –

    [REQUIRED]

    Amazon Kinesis Analytics 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.

  • OutputId (string) –

    [REQUIRED]

    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.

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