Kinesis / Client / disable_enhanced_monitoring

disable_enhanced_monitoring#

Kinesis.Client.disable_enhanced_monitoring(**kwargs)#

Disables enhanced monitoring.

Note

When invoking this API, you must use either the StreamARN or the StreamName parameter, or both. It is recommended that you use the StreamARN input parameter when you invoke this API.

See also: AWS API Documentation

Request Syntax

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

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

  • ShardLevelMetrics (list) –

    [REQUIRED]

    List of shard-level metrics to disable.

    The following are the valid shard-level metrics. The value “ ALL” disables 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