Skip to content

Enables enhanced Kinesis data stream monitoring for shard-level metrics

Description

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

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.

Usage

kinesis_enable_enhanced_monitoring(StreamName, ShardLevelMetrics,
  StreamARN, StreamId)

Arguments

  • StreamName

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

  • ShardLevelMetrics

    [required] 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.

  • StreamARN

    The ARN of the stream.

  • StreamId

    Not Implemented. Reserved for future use.

Value

A list with the following syntax:

list(
  StreamName = "string",
  CurrentShardLevelMetrics = list(
    "IncomingBytes"|"IncomingRecords"|"OutgoingBytes"|"OutgoingRecords"|"WriteProvisionedThroughputExceeded"|"ReadProvisionedThroughputExceeded"|"IteratorAgeMilliseconds"|"ALL"
  ),
  DesiredShardLevelMetrics = list(
    "IncomingBytes"|"IncomingRecords"|"OutgoingBytes"|"OutgoingRecords"|"WriteProvisionedThroughputExceeded"|"ReadProvisionedThroughputExceeded"|"IteratorAgeMilliseconds"|"ALL"
  ),
  StreamARN = "string"
)

Request syntax

svc$enable_enhanced_monitoring(
  StreamName = "string",
  ShardLevelMetrics = list(
    "IncomingBytes"|"IncomingRecords"|"OutgoingBytes"|"OutgoingRecords"|"WriteProvisionedThroughputExceeded"|"ReadProvisionedThroughputExceeded"|"IteratorAgeMilliseconds"|"ALL"
  ),
  StreamARN = "string",
  StreamId = "string"
)