Skip to content

DisableEnhancedMonitoringInput

Source code in docs_src/capo_kinesis/types/disable_enhanced_monitoring_input.py 
16
17
18
19
20
21
22
23
24
class DisableEnhancedMonitoringInput(TypedDict, closed=True):
    stream_name: NotRequired["capo_kinesis.types.stream_name.StreamName"]
    """<p>The name of the Kinesis data stream for which to disable enhanced monitoring.</p>"""
    shard_level_metrics: "capo_kinesis.types.metrics_name_list.MetricsNameList"
    """<p>List of shard-level metrics to disable.</p> <p>The following are the valid shard-level metrics. The value "<code>ALL</code>" disables every metric.</p> <ul> <li> <p> <code>IncomingBytes</code> </p> </li> <li> <p> <code>IncomingRecords</code> </p> </li> <li> <p> <code>OutgoingBytes</code> </p> </li> <li> <p> <code>OutgoingRecords</code> </p> </li> <li> <p> <code>WriteProvisionedThroughputExceeded</code> </p> </li> <li> <p> <code>ReadProvisionedThroughputExceeded</code> </p> </li> <li> <p> <code>IteratorAgeMilliseconds</code> </p> </li> <li> <p> <code>ALL</code> </p> </li> </ul> <p>For more information, see <a href="https://docs.aws.amazon.com/kinesis/latest/dev/monitoring-with-cloudwatch.html">Monitoring the Amazon Kinesis Data Streams Service with Amazon CloudWatch</a> in the <i>Amazon Kinesis Data Streams Developer Guide</i>.</p>"""
    stream_arn: NotRequired["capo_kinesis.types.stream_arn.StreamARN"]
    """<p>The ARN of the stream.</p>"""
    stream_id: NotRequired["capo_kinesis.types.stream_id.StreamId"]
    """<p>Not Implemented. Reserved for future use.</p>"""

shard_level_metrics instance-attribute 

shard_level_metrics: MetricsNameList

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.

stream_arn instance-attribute 

stream_arn: NotRequired[StreamARN]

The ARN of the stream.

stream_id instance-attribute 

stream_id: NotRequired[StreamId]

Not Implemented. Reserved for future use.

stream_name instance-attribute 

stream_name: NotRequired[StreamName]

The name of the Kinesis data stream for which to disable enhanced monitoring.