Sign in

v1

latestOpenAPI 3.0.0Apache 2.0 License2026-07-1428127159.3 KB

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

When invoking this API, it is recommended you use the StreamARN input parameter rather than the StreamName input parameter.

post/#X-Amz-Target=Kinesis_20131202.EnableEnhancedMonitoring

Headers

X-Amz-Target'Kinesis_20131202.EnableEnhancedMonitoring' required

Request body

StreamNamestring

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

ShardLevelMetricsMetricsName[] required
<p>List of shard-level metrics to enable.</p> <p>The following are the valid shard-level metrics. The value "<code>ALL</code>" enables 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>
StreamARNstring

The ARN of the stream.

Response

Success

StreamNamestring

The name of the Kinesis data stream.

CurrentShardLevelMetricsMetricsName[]

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

DesiredShardLevelMetricsMetricsName[]

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

StreamARNstring

The ARN of the stream.