add_application_cloud_watch_logging_option

KinesisAnalytics.Client.add_application_cloud_watch_logging_option(**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.

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.

See also: AWS API Documentation

Request Syntax

response = client.add_application_cloud_watch_logging_option(
    ApplicationName='string',
    CurrentApplicationVersionId=123,
    CloudWatchLoggingOption={
        'LogStreamARN': 'string',
        'RoleARN': 'string'
    }
)

Parameters

• ApplicationName (string) --

  [REQUIRED]

  The Kinesis Analytics application name.

• CurrentApplicationVersionId (integer) --

  [REQUIRED]

  The version ID of the Kinesis Analytics application.

• CloudWatchLoggingOption (dict) --

  [REQUIRED]

  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.

  • LogStreamARN (string) -- [REQUIRED]

    ARN of the CloudWatch log to receive application messages.

  • RoleARN (string) -- [REQUIRED]

    IAM ARN of the role to use to send application messages. Note: To write application messages to CloudWatch, the IAM role that is used must have the PutLogEvents policy action enabled.

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