AddApplicationCloudWatchLoggingOption
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.
Request Syntax
{
"ApplicationName": "string
",
"CloudWatchLoggingOption": {
"LogStreamARN": "string
",
"RoleARN": "string
"
},
"CurrentApplicationVersionId": number
}
Request Parameters
The request accepts the following data in JSON format.
- ApplicationName
-
The Kinesis Analytics application name.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 128.
Pattern:
[a-zA-Z0-9_.-]+
Required: Yes
- CloudWatchLoggingOption
-
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
PutLogEvents
policy action enabled.Type: CloudWatchLoggingOption object
Required: Yes
- CurrentApplicationVersionId
-
The version ID of the Kinesis Analytics application.
Type: Long
Valid Range: Minimum value of 1. Maximum value of 999999999.
Required: Yes
Response Elements
If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body.
Errors
- ConcurrentModificationException
-
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.
HTTP Status Code: 400
- InvalidArgumentException
-
Specified input parameter value is invalid.
HTTP Status Code: 400
- ResourceInUseException
-
Application is not available for this operation.
HTTP Status Code: 400
- ResourceNotFoundException
-
Specified application can't be found.
HTTP Status Code: 400
- UnsupportedOperationException
-
The request was rejected because a specified parameter is not supported or a specified resource is not valid for this operation.
HTTP Status Code: 400
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following: