Kinesis / Client / enable_enhanced_monitoring

enable_enhanced_monitoring#

Kinesis.Client.enable_enhanced_monitoring(**kwargs)#

Enables enhanced Kinesis data stream monitoring for shard-level metrics.

Note

When invoking this API, it is recommended you use the StreamARN input parameter rather than the StreamName input parameter.

See also: AWS API Documentation

Request Syntax

response = client.enable_enhanced_monitoring(
    StreamName='string',
    ShardLevelMetrics=[
        'IncomingBytes'|'IncomingRecords'|'OutgoingBytes'|'OutgoingRecords'|'WriteProvisionedThroughputExceeded'|'ReadProvisionedThroughputExceeded'|'IteratorAgeMilliseconds'|'ALL',
    ],
    StreamARN='string'
)
Parameters:

  • StreamName (string) – The name of the stream for which to enable enhanced monitoring.

  • ShardLevelMetrics (list) –

    [REQUIRED]

    List of shard-level metrics to enable.

    The following are the valid shard-level metrics. The value “ ALL” enables every metric.

    • IncomingBytes

    • IncomingRecords

    • OutgoingBytes

    • OutgoingRecords

    • WriteProvisionedThroughputExceeded

    • ReadProvisionedThroughputExceeded

    • IteratorAgeMilliseconds

    • ALL

    For more information, see Monitoring the Amazon Kinesis Data Streams Service with Amazon CloudWatch in the Amazon Kinesis Data Streams Developer Guide.

    • (string) –

  • StreamARN (string) – The ARN of the stream.

Return type:

dict

Returns:

Response Syntax

{
    'StreamName': 'string',
    'CurrentShardLevelMetrics': [
        'IncomingBytes'|'IncomingRecords'|'OutgoingBytes'|'OutgoingRecords'|'WriteProvisionedThroughputExceeded'|'ReadProvisionedThroughputExceeded'|'IteratorAgeMilliseconds'|'ALL',
    ],
    'DesiredShardLevelMetrics': [
        'IncomingBytes'|'IncomingRecords'|'OutgoingBytes'|'OutgoingRecords'|'WriteProvisionedThroughputExceeded'|'ReadProvisionedThroughputExceeded'|'IteratorAgeMilliseconds'|'ALL',
    ],
    'StreamARN': 'string'
}

Response Structure

  • (dict) –

    Represents the output for EnableEnhancedMonitoring and DisableEnhancedMonitoring.

    • StreamName (string) –

      The name of the Kinesis data stream.

    • CurrentShardLevelMetrics (list) –

      Represents the current state of the metrics that are in the enhanced state before the operation.

      • (string) –

    • DesiredShardLevelMetrics (list) –

      Represents the list of all the metrics that would be in the enhanced state after the operation.

      • (string) –

    • StreamARN (string) –

      The ARN of the stream.

Exceptions

  • Kinesis.Client.exceptions.InvalidArgumentException

  • Kinesis.Client.exceptions.LimitExceededException

  • Kinesis.Client.exceptions.ResourceInUseException

  • Kinesis.Client.exceptions.ResourceNotFoundException

  • Kinesis.Client.exceptions.AccessDeniedException