Skip to content

Disables enhanced monitoring

Description

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.

Usage

kinesis_disable_enhanced_monitoring(StreamName, ShardLevelMetrics,
  StreamARN, StreamId)

Arguments

  • StreamName

    The name of the Kinesis data stream for which to disable enhanced monitoring.

  • ShardLevelMetrics

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

  • 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$disable_enhanced_monitoring(
  StreamName = "string",
  ShardLevelMetrics = list(
    "IncomingBytes"|"IncomingRecords"|"OutgoingBytes"|"OutgoingRecords"|"WriteProvisionedThroughputExceeded"|"ReadProvisionedThroughputExceeded"|"IteratorAgeMilliseconds"|"ALL"
  ),
  StreamARN = "string",
  StreamId = "string"
)