Skip to content

Kinesis  >  Operations  >  enable_enhanced_monitoring

enable_enhanced_monitoring

Operation

enable_enhanced_monitoring async 

enable_enhanced_monitoring(input: EnableEnhancedMonitoringInput, plugins: list[Plugin] | None = None) -> EnableEnhancedMonitoringOutput

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

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.

Parameters:

Name Type Description Default
input EnableEnhancedMonitoringInput

An instance of EnableEnhancedMonitoringInput.

 required
plugins list[Plugin] | None

A list of callables that modify the configuration dynamically. Changes made by these plugins only apply for the duration of the operation execution and will not affect any other operation invocations.

 None

Returns:

Type Description
EnableEnhancedMonitoringOutput

An instance of EnableEnhancedMonitoringOutput.

Input

EnableEnhancedMonitoringInput dataclass

Bases: _SerdeShape

Represents the input for EnableEnhancedMonitoring.

Attributes

shard_level_metrics class-attribute instance-attribute 
shard_level_metrics: list[str] | None = ...

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.

stream_arn class-attribute instance-attribute 
stream_arn: str | None = ...

The ARN of the stream.

stream_id class-attribute instance-attribute 
stream_id: str | None = ...

Not Implemented. Reserved for future use.

stream_name class-attribute instance-attribute 
stream_name: str | None = ...

The name of the stream for which to enable enhanced monitoring.

Output

EnableEnhancedMonitoringOutput dataclass

Bases: _SerdeShape

Represents the output for EnableEnhancedMonitoring and DisableEnhancedMonitoring.

Attributes

current_shard_level_metrics class-attribute instance-attribute 
current_shard_level_metrics: list[str] | None = ...

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

desired_shard_level_metrics class-attribute instance-attribute 
desired_shard_level_metrics: list[str] | None = ...

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

response_metadata class-attribute instance-attribute 
response_metadata: ResponseMetadata = ...

Metadata about the response that produced this output. Use this to recover the request identifiers a service's support team needs in order to investigate a call. Members of the metadata are individually optional.

stream_arn class-attribute instance-attribute 
stream_arn: str | None = ...

The ARN of the stream.

stream_name class-attribute instance-attribute 
stream_name: str | None = ...

The name of the Kinesis data stream.