disable_enhanced_monitoring
¶
disable_enhanced_monitoring(
shard_level_metrics: MetricsNameList,
*,
config_overrides: Optional[KinesisClientConfig] = None,
stream_name: Optional[StreamName] = None,
stream_arn: Optional[StreamARN] = None,
stream_id: Optional[StreamId] = None,
) -> EnhancedMonitoringOutput
Disables enhanced monitoring.
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:
-
stream_name(Optional[StreamName], default:None) –The name of the Kinesis data stream for which to disable enhanced monitoring.
-
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(Optional[StreamARN], default:None) –The ARN of the stream.
-
stream_id(Optional[StreamId], default:None) –Not Implemented. Reserved for future use.
Raises:
-
AccessDeniedException–Specifies that you do not have the permissions required to perform this operation.
-
InvalidArgumentException–A specified parameter exceeds its restrictions, is not supported, or can't be used. For more information, see the returned message.
-
LimitExceededException–The requested resource exceeds the maximum number allowed, or the number of concurrent stream requests exceeds the maximum number allowed.
-
ResourceInUseException–The resource is not available for this operation. For successful operation, the resource must be in the
ACTIVEstate. -
ResourceNotFoundException–The requested resource could not be found. The stream might not be specified correctly.
-
UnknownServiceError–The service returned an error code this client does not model.