AWS Kinesis · Schema

EnableEnhancedMonitoringInput

Represents the input for EnableEnhancedMonitoring.

AnalyticsApache FlinkBig DataData ProcessingReal-TimeStreamingVideo

Properties

Name Type Description
StreamName object
ShardLevelMetrics object
StreamARN object
View JSON Schema on GitHub

JSON Schema

kinesis-enableenhancedmonitoringinput-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/EnableEnhancedMonitoringInput",
  "title": "EnableEnhancedMonitoringInput",
  "type": "object",
  "required": [
    "ShardLevelMetrics"
  ],
  "properties": {
    "StreamName": {
      "allOf": [
        {
          "$ref": "#/components/schemas/StreamName"
        },
        {
          "description": "The name of the stream for which to enable enhanced monitoring."
        }
      ]
    },
    "ShardLevelMetrics": {
      "allOf": [
        {
          "$ref": "#/components/schemas/MetricsNameList"
        },
        {
          "description": "<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>"
        }
      ]
    },
    "StreamARN": {
      "allOf": [
        {
          "$ref": "#/components/schemas/StreamARN"
        },
        {
          "description": "The ARN of the stream."
        }
      ]
    }
  },
  "description": "Represents the input for <a>EnableEnhancedMonitoring</a>."
}