KinesisAnalyticsV2 / Client / add_application_cloud_watch_logging_option

add_application_cloud_watch_logging_option#

KinesisAnalyticsV2.Client.add_application_cloud_watch_logging_option(**kwargs)#

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

See also: AWS API Documentation

Request Syntax

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

  • ApplicationName (string) –

    [REQUIRED]

    The Kinesis Data Analytics application name.

  • CurrentApplicationVersionId (integer) – 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.

  • CloudWatchLoggingOption (dict) –

    [REQUIRED]

    Provides the Amazon CloudWatch log stream Amazon Resource Name (ARN).

    • LogStreamARN (string) – [REQUIRED]

      The ARN of the CloudWatch log to receive application messages.

  • ConditionalToken (string) – 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.

Return type:

dict

Returns:

Response Syntax

{
    'ApplicationARN': 'string',
    'ApplicationVersionId': 123,
    'CloudWatchLoggingOptionDescriptions': [
        {
            'CloudWatchLoggingOptionId': 'string',
            'LogStreamARN': 'string',
            'RoleARN': 'string'
        },
    ]
}

Response Structure

  • (dict) –

    • ApplicationARN (string) –

      The application’s ARN.

    • ApplicationVersionId (integer) –

      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.

    • CloudWatchLoggingOptionDescriptions (list) –

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

      • (dict) –

        Describes the Amazon CloudWatch logging option.

        • CloudWatchLoggingOptionId (string) –

          The ID of the CloudWatch logging option description.

        • LogStreamARN (string) –

          The Amazon Resource Name (ARN) of the CloudWatch log to receive application messages.

        • RoleARN (string) –

          The IAM ARN of the role to use to send application messages.

          Note

          Provided for backward compatibility. Applications created with the current API version have an application-level service execution role rather than a resource-level role.

Exceptions

  • KinesisAnalyticsV2.Client.exceptions.ResourceNotFoundException

  • KinesisAnalyticsV2.Client.exceptions.ResourceInUseException

  • KinesisAnalyticsV2.Client.exceptions.InvalidArgumentException

  • KinesisAnalyticsV2.Client.exceptions.ConcurrentModificationException

  • KinesisAnalyticsV2.Client.exceptions.InvalidRequestException

  • KinesisAnalyticsV2.Client.exceptions.InvalidApplicationConfigurationException