disable_enhanced_monitoring
async
¶
disable_enhanced_monitoring(
shard_level_metrics: MetricsNameList,
*,
config_overrides: Optional[AsyncKinesisClientConfig] = 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.
Source code in docs_src/capo_kinesis/_services/async_kinesis.py
1191 1192 1193 1194 1195 1196 1197 1198 1199 1200 1201 1202 1203 1204 1205 1206 1207 1208 1209 1210 1211 1212 1213 1214 1215 1216 1217 1218 1219 1220 1221 1222 1223 1224 1225 1226 1227 1228 1229 1230 1231 1232 1233 1234 1235 1236 1237 1238 1239 1240 1241 1242 1243 1244 1245 1246 1247 1248 1249 1250 1251 | |