enable_enhanced_monitoring¶
Operation¶
enable_enhanced_monitoring
¶
enable_enhanced_monitoring(request: EnableEnhancedMonitoringInput | EnableEnhancedMonitoringInputDict | None = None, /, *, plugins: list[Plugin] | None = None, **kwargs: Unpack[EnableEnhancedMonitoringInputDict]) -> EnableEnhancedMonitoringOutput
Enables enhanced Kinesis data stream monitoring for shard-level metrics.
Note
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.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
request
|
EnableEnhancedMonitoringInput | EnableEnhancedMonitoringInputDict | None
|
The input as a model or dictionary. Pass this or keyword arguments, not both. |
None
|
plugins
|
list[Plugin] | None
|
A list of callables that modify the configuration dynamically. Changes made by these plugins only apply for the duration of the operation execution and will not affect any other operation invocations. |
None
|
**kwargs
|
Unpack[EnableEnhancedMonitoringInputDict]
|
The input fields as keyword arguments. |
{}
|
Returns:
| Type | Description |
|---|---|
EnableEnhancedMonitoringOutput
|
An instance of |
enable_enhanced_monitoring
async
¶
enable_enhanced_monitoring(request: EnableEnhancedMonitoringInput | EnableEnhancedMonitoringInputDict | None = None, /, *, plugins: list[Plugin] | None = None, **kwargs: Unpack[EnableEnhancedMonitoringInputDict]) -> EnableEnhancedMonitoringOutput
Enables enhanced Kinesis data stream monitoring for shard-level metrics.
Note
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.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
request
|
EnableEnhancedMonitoringInput | EnableEnhancedMonitoringInputDict | None
|
The input as a model or dictionary. Pass this or keyword arguments, not both. |
None
|
plugins
|
list[Plugin] | None
|
A list of callables that modify the configuration dynamically. Changes made by these plugins only apply for the duration of the operation execution and will not affect any other operation invocations. |
None
|
**kwargs
|
Unpack[EnableEnhancedMonitoringInputDict]
|
The input fields as keyword arguments. |
{}
|
Returns:
| Type | Description |
|---|---|
EnableEnhancedMonitoringOutput
|
An instance of |
Input¶
Pass the input as keyword arguments, a positional dictionary, or a positional model object. Pass plugins separately as a keyword argument.
EnableEnhancedMonitoringInputDict
¶
Bases: TypedDict
Dictionary form of EnableEnhancedMonitoringInput.
Attributes¶
shard_level_metrics
instance-attribute
¶
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.
EnableEnhancedMonitoringInput
dataclass
¶
Bases: _SerdeShape
Represents the input for EnableEnhancedMonitoring.
Attributes¶
shard_level_metrics
class-attribute
instance-attribute
¶
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.
Output¶
EnableEnhancedMonitoringOutput
dataclass
¶
Bases: _SerdeShape
Represents the output for EnableEnhancedMonitoring and DisableEnhancedMonitoring.
Attributes¶
current_shard_level_metrics
class-attribute
instance-attribute
¶
Represents the current state of the metrics that are in the enhanced state before the operation.
desired_shard_level_metrics
class-attribute
instance-attribute
¶
Represents the list of all the metrics that would be in the enhanced state after the operation.
response_metadata
class-attribute
instance-attribute
¶
Metadata about the response that produced this output. Use this to recover the request identifiers a service's support team needs in order to investigate a call. Members of the metadata are individually optional.