Skip to content

Commit

Permalink
Add RETURN block data for remaining response params
Browse files Browse the repository at this point in the history
  • Loading branch information
mandar242 committed Sep 7, 2022
1 parent f27e506 commit 8378ed3
Showing 1 changed file with 79 additions and 47 deletions.
126 changes: 79 additions & 47 deletions plugins/modules/cloudwatch_metric_alarm_info.py
Original file line number Diff line number Diff line change
Expand Up @@ -92,50 +92,55 @@
type: list
elements: dict
contains:
actions_enabled:
description: Indicates whether actions should be executed during any changes to the alarm state.
alarm_name:
description: Unique name for the alarm.
returned: always
type: str
alarm_arn:
description: The Amazon Resource Name (ARN) of the alarm.
returned: always
type: str
alarm_configuration_updated_timestamp:
description: The time stamp of the last update to the alarm configuration.
returned: always
type: str
alarm_description:
description: The description of the alarm.
returned: always
type: str
alarm_name:
description: Unique name for the alarm.
alarm_configuration_updated_timestamp:
description: The time stamp of the last update to the alarm configuration.
returned: always
type: str
comparison_operator:
description: The arithmetic operation to use when comparing the specified statistic and threshold.
actions_enabled:
description: Indicates whether actions should be executed during any changes to the alarm state.
returned: always
type: str
dimensions:
description: The dimensions for the metric.
type: bool
ok_actions:
description: The actions to execute when this alarm transitions to an OK state from any other state.
returned: always
type: list
elements: dict
contains:
name:
description: The name of the dimension.
returned: always
type: str
value:
description: The value of the dimension.
returned: always
type: str
evaluation_period:
description: The number of periods over which data is compared to the specified threshold.
elements: str
alarm_actions:
description: The actions to execute when this alarm transitions to an ALARM state from any other state.
returned: always
type: str
type: list
elements: str
insufficient_data_actions:
description: The actions to execute when this alarm transitions to the INSUFFICIENT_DATA state from any other state.
description: The actions to execute when this alarm transitions to an INSUFFICIENT_DATA state from any other state.
returned: always
type: list
elements: str
state_value:
description: The state value for the alarm.
returned: always
type: str
state_reason:
description: An explanation for the alarm state, in text format.
returned: always
type: str
state_reason_data:
description: An explanation for the alarm state, in JSON format.
returned: always
type: str
state_updated_timestamp:
description: The time stamp of the last update to the alarm state.
returned: always
type: str
metric_name:
Expand All @@ -148,48 +153,75 @@
- Determines the category it will appear under in CloudWatch.
returned: always
type: str
ok_actions:
description: The actions to execute when this alarm transitions to an OK state from any other state.
statistic:
description: The statistic for the metric associated with the alarm, other than percentile.
returned: always
type: str
extended_statistic:
description: The percentile statistic for the metric associated with the alarm.
returned: always
type: str
dimensions:
description: The dimensions for the metric.
returned: always
type: list
elements: dict
contains:
name:
description: The name of the dimension.
returned: always
type: str
value:
description: The value of the dimension.
returned: always
type: str
period:
description:
- The length, in seconds, used each time the metric specified in MetricName is evaluated.
- Valid values are 10, 30, and any multiple of 60.
returned: always
type: int
state_reason:
description: An explanation for the alarm state, in text format.
returned: always
type: str
state_reason_data:
description: An explanation for the alarm state, in JSON format.
returned: always
type: str
state_updated_timestamp:
description: The time stamp of the last update to the alarm state.
unit:
description: Unit used when storing the metric
returned: always
type: str
state_value:
description: The state value for the alarm.
evaluation_period:
description: The number of periods over which data is compared to the specified threshold.
returned: always
type: str
statistic:
description: The statistic for the metric associated with the alarm, other than percentile.
type: int
datapoints_to_alarm:
description: The number of data points that must be breaching to trigger the alarm.
returned: always
type: str
type: int
threshold:
description: The value to compare with the specified statistic.
returned: always
type: float
comparison_operator:
description: The arithmetic operation to use when comparing the specified statistic and threshold.
returned: always
type: str
treat_missing_data:
description: Sets how alarm is to handle missing data points.
returned: always
type: str
unit:
description: Unit used when storing the metric
evaluate_low_sample_count_percentile:
description:
- Used only for alarms based on percentiles.
- If I(ignore), the alarm state does not change during periods with too few data points to be statistically significant.
- If I(evaluate) or this parameter is not used, the alarm is always evaluated and possibly changes state.
returned: always
type: str
metrics:
description: An array of MetricDataQuery structures, used in an alarm based on a metric math expression.
returned: always
type: list
elements: dict
threshold_metric_id:
description: This is the ID of the ANOMALY_DETECTION_BAND function used as the threshold for the alarm.
returned: always
type: str
'''


Expand Down

0 comments on commit 8378ed3

Please sign in to comment.