cloudwatch¶
cloudwatch alarm alarm-history¶
Usage
usage: symp cloudwatch alarm alarm-history
[-f {adaptive_table,json,shell,table,value,yaml}]
[-c COLUMN] [--max-width <integer>]
[--noindent] [--prefix PREFIX]
[-m [NAME=VALUE [NAME=VALUE ...]]]
[--sorting-by SORTING_BY]
[--marker MARKER] [--limit LIMIT]
[--alarm-name ALARM_NAME]
[--start-date START_DATE]
[--end-date END_DATE]
[--history-item-type HISTORY_ITEM_TYPE]
[--order ORDER]
Description
Get alarm history.
Returns
Returns dict: Alarm history
Optional
optional arguments:
-h, --help show this help message and exit
--sorting-by SORTING_BY
The field by which to sort
--marker MARKER Specify the first entity that you wan to retrieve
--limit LIMIT Specify the number of entities that you want to retrieve
--alarm-name ALARM_NAME
The name for the alarm. The maximum length is 255 characters
--start-date START_DATE
The starting date to retrieve alarm history
--end-date END_DATE The ending date to retrieve alarm history
--history-item-type HISTORY_ITEM_TYPE
The type of alarm history item. Valid values are-
configuration_update, state_update, action
--order ORDER The sorting order for get response, Default value: ascending
cloudwatch alarm create¶
Usage
usage: symp cloudwatch alarm create
[-f {adaptive_table,json,shell,table,value,yaml}]
[-c COLUMN] [--max-width <integer>]
[--noindent] [--prefix PREFIX]
[-m [NAME=VALUE [NAME=VALUE ...]]]
[--dimensions DIMENSIONS]
[--evaluation-periods EVALUATION_PERIODS]
[--ok-actions OK_ACTIONS] [--unit UNIT]
[--actions-enabled ACTIONS_ENABLED]
[--description DESCRIPTION]
[--alarm-actions ALARM_ACTIONS]
[--project-id PROJECT_ID]
[--insufficient-data-actions INSUFFICIENT_DATA_ACTIONS]
[--extended-statistic EXTENDED_STATISTIC]
[--evaluate-low-sample-count-percentile EVALUATE_LOW_SAMPLE_COUNT_PERCENTILE]
[--treat-missing-data TREAT_MISSING_DATA]
[--namespace NAMESPACE]
[--datapoints-to-alarm DATAPOINTS_TO_ALARM]
name metric_name comparison_operator
period threshold statistic
Description
Creates a new alarm object.
Returns
Returns dict: Created record
Mandatory
positional arguments:
name Alarm name
metric_name The name of the metric associated with the alarm
comparison_operator Comparison operator one of:
GreaterThanOrEqualToThreshold/GreaterThanThreshold/LessThanThreshold/LessThanOrEqualToThreshold
period The period, in seconds, over which the statistic is applied
threshold The value to compare with the specified statistic
statistic The statistic for the metric associated with the alarm, other than percentile
(Minimum/Maximum/Sum/Average/SampleCount)
Optional
optional arguments:
-h, --help show this help message and exit
--dimensions DIMENSIONS
The dimensions for the metric associated with the alarm. Examples
(list) --
The dimensions for the metric associated with the alarm
(dict) --
Expands the identity of a metric
Name (string) --
The name of the dimension
Value (string) --
The value representing the dimension measurement
--evaluation-periods EVALUATION_PERIODS
The number of periods over which data is compared to the specified threshold (default 1)
--ok-actions OK_ACTIONS
The actions to execute when this alarm transitions to the OK state from any other state
(list) --
actions
(dict) --
Expands the identity of a action
type (string/enum) --
- sns
- autoscaling
id (string/uuid) --
(string) -- id of type
--unit UNIT The unit of the metric associated with the alarm.(TODO add options)
--actions-enabled ACTIONS_ENABLED
Indicates whether actions should be executed during any changes to the alarm state
--description DESCRIPTION
Alarm description
--alarm-actions ALARM_ACTIONS
List of alarm actions
(list) --
actions
(dict) --
Expands the identity of a action
type (string/enum) --
- sns
- autoscaling
id (string/uuid) --
(string) -- id of type
--project-id PROJECT_ID
Project id
--insufficient-data-actions INSUFFICIENT_DATA_ACTIONS
List of insufficient data actions
(list) --
actions
(dict) --
Expands the identity of a action
type (string/enum) --
- sns
- autoscaling
id (string/uuid) --
(string) -- id of type
--extended-statistic EXTENDED_STATISTIC
Add description
--evaluate-low-sample-count-percentile EVALUATE_LOW_SAMPLE_COUNT_PERCENTILE
No usage
--treat-missing-data TREAT_MISSING_DATA
How to treat missing data
--namespace NAMESPACE
Namespace for what alarm was created
--datapoints-to-alarm DATAPOINTS_TO_ALARM
The number of datapoints that must be breaching to trigger the alarm
cloudwatch alarm delete¶
Usage
usage: symp cloudwatch alarm delete
[-f {adaptive_table,json,shell,table,value,yaml}]
[-c COLUMN] [--max-width <integer>]
[--noindent] [--prefix PREFIX]
[-m [NAME=VALUE [NAME=VALUE ...]]]
alarm_id
Description
Deletes a single alarm object based on the ID supplied.
Mandatory
positional arguments:
alarm_id ID of the requested alarm object
Optional
optional arguments:
-h, --help show this help message and exit
cloudwatch alarm disable-actions¶
Usage
usage: symp cloudwatch alarm disable-actions
[-f {adaptive_table,json,shell,table,value,yaml}]
[-c COLUMN]
[--max-width <integer>]
[--noindent] [--prefix PREFIX]
[-m [NAME=VALUE [NAME=VALUE ...]]]
--alarms [--alarms ...]
Description
Disable actions for given alarms.
Mandatory
positional arguments:
--alarms List of alarm ids
Optional
optional arguments:
-h, --help show this help message and exit
cloudwatch alarm enable-actions¶
Usage
usage: symp cloudwatch alarm enable-actions
[-f {adaptive_table,json,shell,table,value,yaml}]
[-c COLUMN]
[--max-width <integer>]
[--noindent] [--prefix PREFIX]
[-m [NAME=VALUE [NAME=VALUE ...]]]
--alarms [--alarms ...]
Description
Disable actions for given alarms.
Mandatory
positional arguments:
--alarms List of alarm ids
Optional
optional arguments:
-h, --help show this help message and exit
cloudwatch alarm get¶
Usage
usage: symp cloudwatch alarm get
[-f {adaptive_table,json,shell,table,value,yaml}]
[-c COLUMN] [--max-width <integer>]
[--noindent] [--prefix PREFIX]
[-m [NAME=VALUE [NAME=VALUE ...]]]
alarm_id
Description
Returns a alarm based on a alarm ID.
Returns
Returns dict: Alarm response
Mandatory
positional arguments:
alarm_id ID of the requested alarm object
Optional
optional arguments:
-h, --help show this help message and exit
cloudwatch alarm list¶
Usage
usage: symp cloudwatch alarm list
[-f {adaptive_table,csv,json,table,value,yaml}]
[-c COLUMN] [--max-width <integer>]
[--noindent]
[--quote {all,minimal,none,nonnumeric}]
[-m [NAME=VALUE [NAME=VALUE ...]]]
[--sort-by SORT_BY] [--order ORDER]
[--marker MARKER] [--limit LIMIT]
[--project-id PROJECT_ID]
[--alarm-names [ALARM_NAMES [ALARM_NAMES ...]]]
[--alarm-name-prefix ALARM_NAME_PREFIX]
[--action-prefix ACTION_PREFIX]
[--state STATE]
[--alarm-ids [ALARM_IDS [ALARM_IDS ...]]]
[--kwargs KWARGS]
Description
Returns all alarm objects.
Returns
Returns list: Alarm objects
Optional
optional arguments:
-h, --help show this help message and exit
--sort-by SORT_BY Sort by field
--order ORDER Order for return result "ascending" or "descending"
--marker MARKER Offset for next call
--limit LIMIT Max number of metrics to return
--project-id PROJECT_ID
Project if
--alarm-names [ALARM_NAMES [ALARM_NAMES ...]]
Names of the alarms to filter by
--alarm-name-prefix ALARM_NAME_PREFIX
Prefix of alarm names
--action-prefix ACTION_PREFIX
Actions prefix
--state STATE Filter by state
--alarm-ids [ALARM_IDS [ALARM_IDS ...]]
List of alarm ids
--kwargs KWARGS Extra arguments, a dict as a JSON string
cloudwatch alarm set-state¶
Usage
usage: symp cloudwatch alarm set-state
[-f {adaptive_table,json,shell,table,value,yaml}]
[-c COLUMN] [--max-width <integer>]
[--noindent] [--prefix PREFIX]
[-m [NAME=VALUE [NAME=VALUE ...]]]
[--state-reason-data STATE_REASON_DATA]
alarm_id state state_reason
Description
Change state of alarm.
Returns
Returns dict: Updated record
Mandatory
positional arguments:
alarm_id Alarm id to change state
state Desired state (OK, ALARM, INSUFFICIENT_DATA)
state_reason State change reason
Optional
optional arguments:
-h, --help show this help message and exit
--state-reason-data STATE_REASON_DATA
State reason data
cloudwatch alarm update¶
Usage
usage: symp cloudwatch alarm update
[-f {adaptive_table,json,shell,table,value,yaml}]
[-c COLUMN] [--max-width <integer>]
[--noindent] [--prefix PREFIX]
[-m [NAME=VALUE [NAME=VALUE ...]]]
[--fields FIELDS]
alarm_id
Description
Creates a new alarm object.
Returns
Returns dict: Updated record
Mandatory
positional arguments:
alarm_id Alarm id to update
Optional
optional arguments:
-h, --help show this help message and exit
--fields FIELDS Extra arguments, a dict as a JSON string
cloudwatch metric list¶
Usage
usage: symp cloudwatch metric list
[-f {adaptive_table,csv,json,table,value,yaml}]
[-c COLUMN] [--max-width <integer>]
[--noindent]
[--quote {all,minimal,none,nonnumeric}]
[-m [NAME=VALUE [NAME=VALUE ...]]]
[--order ORDER] [--limit LIMIT]
[--sort-by SORT_BY]
[--metric-name METRIC_NAME]
[--namespace NAMESPACE]
[--dimensions DIMENSIONS] [--kwargs KWARGS]
Description
List of possible metrics.
Returns
Returns list: List of metrics
Optional
optional arguments:
-h, --help show this help message and exit
--order ORDER Order for return result "ascending" or "descending"
--limit LIMIT Max number of metrics to return
--sort-by SORT_BY Sort by field
--metric-name METRIC_NAME
Metric name to filter by
--namespace NAMESPACE
Namespace to filter by
--dimensions DIMENSIONS
Dimension to filter by. Must be list of dicts as [{"name": <name>, "value": <value>}]
--kwargs KWARGS Extra arguments, a dict as a JSON string