- Navigation GuideYou are on a Command (operation) page with structural examples. Use the navigation breadcrumb if you would like to return to the Client landing page.
DeleteApplicationOutputCommand
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.
Example Syntax
Use a bare-bones client and the command you need to make an API call.
import { KinesisAnalyticsClient, DeleteApplicationOutputCommand } from "@aws-sdk/client-kinesis-analytics"; // ES Modules import
// const { KinesisAnalyticsClient, DeleteApplicationOutputCommand } = require("@aws-sdk/client-kinesis-analytics"); // CommonJS import
const client = new KinesisAnalyticsClient(config);
const input = { // DeleteApplicationOutputRequest
ApplicationName: "STRING_VALUE", // required
CurrentApplicationVersionId: Number("long"), // required
OutputId: "STRING_VALUE", // required
};
const command = new DeleteApplicationOutputCommand(input);
const response = await client.send(command);
// {};
DeleteApplicationOutputCommand Input
Parameter | Type | Description |
|---|
Parameter | Type | Description |
|---|---|---|
ApplicationNameRequired | string | undefined | Amazon Kinesis Analytics application name. |
CurrentApplicationVersionIdRequired | number | undefined | 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 |
OutputIdRequired | string | undefined | 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 |
DeleteApplicationOutputCommand Output
Parameter | Type | Description |
|---|
Parameter | Type | Description |
|---|---|---|
$metadataRequired | ResponseMetadata | Metadata pertaining to this request. |
Throws
Name | Fault | Details |
|---|
Name | Fault | Details |
|---|---|---|
| ConcurrentModificationException | client | Exception thrown as a result of concurrent modification to an application. For example, two individuals attempting to edit the same application at the same time. |
| InvalidArgumentException | client | Specified input parameter value is invalid. |
| ResourceInUseException | client | Application is not available for this operation. |
| ResourceNotFoundException | client | Specified application can't be found. |
| UnsupportedOperationException | client | The request was rejected because a specified parameter is not supported or a specified resource is not valid for this operation. |
| KinesisAnalyticsServiceException | Base exception class for all service exceptions from KinesisAnalytics service. |