- 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.
AddApplicationCloudWatchLoggingOptionCommand
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 .
Adds a CloudWatch log stream to monitor application configuration errors. For more information about using CloudWatch log streams with Amazon Kinesis Analytics applications, see Working with Amazon CloudWatch Logs .
Example Syntax
Use a bare-bones client and the command you need to make an API call.
import { KinesisAnalyticsClient, AddApplicationCloudWatchLoggingOptionCommand } from "@aws-sdk/client-kinesis-analytics"; // ES Modules import
// const { KinesisAnalyticsClient, AddApplicationCloudWatchLoggingOptionCommand } = require("@aws-sdk/client-kinesis-analytics"); // CommonJS import
const client = new KinesisAnalyticsClient(config);
const input = { // AddApplicationCloudWatchLoggingOptionRequest
ApplicationName: "STRING_VALUE", // required
CurrentApplicationVersionId: Number("long"), // required
CloudWatchLoggingOption: { // CloudWatchLoggingOption
LogStreamARN: "STRING_VALUE", // required
RoleARN: "STRING_VALUE", // required
},
};
const command = new AddApplicationCloudWatchLoggingOptionCommand(input);
const response = await client.send(command);
// {};
AddApplicationCloudWatchLoggingOptionCommand Input
Parameter | Type | Description |
|---|
Parameter | Type | Description |
|---|---|---|
ApplicationNameRequired | string | undefined | The Kinesis Analytics application name. |
CloudWatchLoggingOptionRequired | CloudWatchLoggingOption | undefined | Provides the CloudWatch log stream Amazon Resource Name (ARN) and the IAM role ARN. Note: To write application messages to CloudWatch, the IAM role that is used must have the |
CurrentApplicationVersionIdRequired | number | undefined | The version ID of the Kinesis Analytics application. |
AddApplicationCloudWatchLoggingOptionCommand 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. |