Enables enhanced Kinesis data stream monitoring for shard-level metrics.
See also: AWS API Documentation
See ‘aws help’ for descriptions of global parameters.
enable-enhanced-monitoring
--stream-name <value>
--shard-level-metrics <value>
[--cli-input-json | --cli-input-yaml]
[--generate-cli-skeleton <value>]
--stream-name
(string)
The name of the stream for which to enable enhanced monitoring.
--shard-level-metrics
(list)
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 .
(string)
Syntax:
"string" "string" ...
Where valid values are:
IncomingBytes
IncomingRecords
OutgoingBytes
OutgoingRecords
WriteProvisionedThroughputExceeded
ReadProvisionedThroughputExceeded
IteratorAgeMilliseconds
ALL
--cli-input-json
| --cli-input-yaml
(string)
Reads arguments from the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton
. If other arguments are provided on the command line, those values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally. This may not be specified along with --cli-input-yaml
.
--generate-cli-skeleton
(string)
Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value input
, prints a sample input JSON that can be used as an argument for --cli-input-json
. Similarly, if provided yaml-input
it will print a sample input YAML that can be used with --cli-input-yaml
. If provided with the value output
, it validates the command inputs and returns a sample output JSON for that command.
See ‘aws help’ for descriptions of global parameters.
To enable enhanced monitoring for shard-level metrics
The following enable-enhanced-monitoring
example enables enhanced Kinesis data stream monitoring for shard-level metrics.
aws kinesis enable-enhanced-monitoring \
--stream-name samplestream \
--shard-level-metrics ALL
Output:
{
"StreamName": "samplestream",
"CurrentShardLevelMetrics": [],
"DesiredShardLevelMetrics": [
"IncomingBytes",
"OutgoingRecords",
"IteratorAgeMilliseconds",
"IncomingRecords",
"ReadProvisionedThroughputExceeded",
"WriteProvisionedThroughputExceeded",
"OutgoingBytes"
]
}
For more information, see Monitoring Streams in Amazon Kinesis Data Streams in the Amazon Kinesis Data Streams Developer Guide.
StreamName -> (string)
The name of the Kinesis data stream.
CurrentShardLevelMetrics -> (list)
Represents the current state of the metrics that are in the enhanced state before the operation.
(string)
DesiredShardLevelMetrics -> (list)
Represents the list of all the metrics that would be in the enhanced state after the operation.
(string)