Request Syntax Request Parameters Response Syntax Response Elements Errors See Also

AddApplicationCloudWatchLoggingOption

Adds an Amazon CloudWatch log stream to monitor application configuration errors.

Request Syntax


{
   "ApplicationName": "string",
   "CloudWatchLoggingOption": { 
      "LogStreamARN": "string"
   },
   "ConditionalToken": "string",
   "CurrentApplicationVersionId": number
}

Request Parameters

The request accepts the following data in JSON format.

ApplicationName

The Kinesis Data 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 Amazon CloudWatch log stream Amazon Resource Name (ARN).

Type: CloudWatchLoggingOption object

Required: Yes

ConditionalToken

A value you use to implement strong concurrency for application updates. You must provide the CurrentApplicationVersionId or the ConditionalToken. You get the application's current ConditionalToken using DescribeApplication. For better concurrency support, use the ConditionalToken parameter instead of CurrentApplicationVersionId.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 512.

Pattern: [a-zA-Z0-9-_+/=]+

Required: No

CurrentApplicationVersionId

The version ID of the SQL-based Kinesis Data Analytics application. You must provide the CurrentApplicationVersionId or the ConditionalToken.You can retrieve the application version ID using DescribeApplication. For better concurrency support, use the ConditionalToken parameter instead of CurrentApplicationVersionId.

Type: Long

Valid Range: Minimum value of 1. Maximum value of 999999999.

Required: No

Response Syntax


{
   "ApplicationARN": "string",
   "ApplicationVersionId": number,
   "CloudWatchLoggingOptionDescriptions": [ 
      { 
         "CloudWatchLoggingOptionId": "string",
         "LogStreamARN": "string",
         "RoleARN": "string"
      }
   ],
   "OperationId": "string"
}

Response Elements

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

ApplicationARN

The application's ARN.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 2048.

Pattern: arn:.*

ApplicationVersionId

The new version ID of the SQL-based Kinesis Data Analytics application. Kinesis Data Analytics updates the ApplicationVersionId each time you change the CloudWatch logging options.

Type: Long

Valid Range: Minimum value of 1. Maximum value of 999999999.

CloudWatchLoggingOptionDescriptions

The descriptions of the current CloudWatch logging options for the SQL-based Kinesis Data Analytics application.

Type: Array of CloudWatchLoggingOptionDescription objects

OperationId

The operation ID that can be used to track the request.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 64.

Errors

ConcurrentModificationException

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.

HTTP Status Code: 400

InvalidApplicationConfigurationException

The user-provided application configuration is not valid.

HTTP Status Code: 400

InvalidArgumentException

The specified input parameter value is not valid.

HTTP Status Code: 400

InvalidRequestException

The request JSON is not valid for the operation.

HTTP Status Code: 400

ResourceInUseException

The application is not available for this operation.

HTTP Status Code: 400

ResourceNotFoundException

Specified application can't be found.

HTTP Status Code: 400