CloudWatchServiceResource
Index > CloudWatch > CloudWatchServiceResource
Auto-generated documentation for CloudWatch type annotations stubs module mypy-boto3-cloudwatch.
CloudWatchServiceResource
Type annotations and code completion for boto3.resource("cloudwatch")
, included resources and collections.
boto3 documentation
from mypy_boto3_cloudwatch.service_resource import CloudWatchServiceResource
def get_cloudwatch_resource() -> CloudWatchServiceResource:
return boto3.resource("cloudwatch")
Attributes
-
meta
: CloudWatchResourceMeta -
alarms
: ServiceResourceAlarmsCollection -
metrics
: ServiceResourceMetricsCollection
Collections
ServiceResourceAlarmsCollection
Provides access to Alarm resource.
Type annotations and code completion for boto3.resource("cloudwatch").alarms
collection.
boto3 documentation
from mypy_boto3_cloudwatch.service_resource import ServiceResourceAlarmsCollection
def get_collection() -> ServiceResourceAlarmsCollection:
return boto3.resource("cloudwatch").alarms
ServiceResourceMetricsCollection
Provides access to Metric resource.
Type annotations and code completion for boto3.resource("cloudwatch").metrics
collection.
boto3 documentation
from mypy_boto3_cloudwatch.service_resource import ServiceResourceMetricsCollection
def get_collection() -> ServiceResourceMetricsCollection:
return boto3.resource("cloudwatch").metrics
Methods
CloudWatchServiceResource.Alarm method
Creates a Alarm resource.
Type annotations and code completion for boto3.resource("cloudwatch").Alarm
method.
boto3 documentation
kwargs: ServiceResourceAlarmRequestTypeDef = { # (1)
"name": ...,
}
parent.Alarm(**kwargs)
CloudWatchServiceResource.Metric method
Creates a Metric resource.
Type annotations and code completion for boto3.resource("cloudwatch").Metric
method.
boto3 documentation
kwargs: ServiceResourceMetricRequestTypeDef = { # (1)
"namespace": ...,
"name": ...,
}
parent.Metric(**kwargs)
CloudWatchServiceResource.get_available_subresources method
Returns a list of all the available sub-resources for this Resource.
Type annotations and code completion for boto3.resource("cloudwatch").get_available_subresources
method.
boto3 documentation
Alarm
Type annotations and code completion for boto3.resource("cloudwatch").Alarm
class.
boto3 documentation
from mypy_boto3_cloudwatch.service_resource import Alarm
def get_resource() -> Alarm:
return boto3.resource("cloudwatch").Alarm(...)
Alarm attributes
alarm_name
:str
alarm_arn
:str
alarm_description
:str
alarm_configuration_updated_timestamp
:datetime
actions_enabled
:bool
ok_actions
:List
[str
]alarm_actions
:List
[str
]insufficient_data_actions
:List
[str
]state_value
: StateValueTypestate_reason
:str
state_reason_data
:str
state_updated_timestamp
:datetime
metric_name
:str
namespace
:str
statistic
: StatisticTypeextended_statistic
:str
dimensions
:List
[DimensionTypeDef]period
:int
unit
: StandardUnitTypeevaluation_periods
:int
datapoints_to_alarm
:int
threshold
:float
comparison_operator
: ComparisonOperatorTypetreat_missing_data
:str
evaluate_low_sample_count_percentile
:str
metrics
:List
[MetricDataQueryTypeDef]threshold_metric_id
:str
evaluation_state
:Literal['PARTIAL_DATA']
(see EvaluationStateType)state_transitioned_timestamp
:datetime
name
:str
metric
: Metric
Alarm methods
Alarm.delete method
Deletes the specified alarms.
Type annotations and code completion for boto3.resource("cloudwatch").delete
method.
boto3 documentation
Alarm.describe_history method
Retrieves the history for the specified alarm.
Type annotations and code completion for boto3.resource("cloudwatch").describe_history
method.
boto3 documentation
def describe_history(
self,
*,
AlarmTypes: Sequence[AlarmTypeType] = ..., # (1)
HistoryItemType: HistoryItemTypeType = ..., # (2)
StartDate: Union[datetime, str] = ...,
EndDate: Union[datetime, str] = ...,
MaxRecords: int = ...,
NextToken: str = ...,
ScanBy: ScanByType = ..., # (3)
) -> DescribeAlarmHistoryOutputTypeDef: # (4)
...
- See AlarmTypeType
- See HistoryItemTypeType
- See ScanByType
- See DescribeAlarmHistoryOutputTypeDef
kwargs: DescribeAlarmHistoryInputAlarmDescribeHistoryTypeDef = { # (1)
"AlarmTypes": ...,
}
parent.describe_history(**kwargs)
Alarm.disable_actions method
Disables the actions for the specified alarms.
Type annotations and code completion for boto3.resource("cloudwatch").disable_actions
method.
boto3 documentation
Alarm.enable_actions method
Enables the actions for the specified alarms.
Type annotations and code completion for boto3.resource("cloudwatch").enable_actions
method.
boto3 documentation
Alarm.get_available_subresources method
Returns a list of all the available sub-resources for this Resource.
Type annotations and code completion for boto3.resource("cloudwatch").get_available_subresources
method.
boto3 documentation
Alarm.load method
Calls meth:CloudWatch.Client.describe_alarms
to update the attributes of
the Alarm resource.
Type annotations and code completion for boto3.resource("cloudwatch").load
method.
boto3 documentation
Alarm.reload method
Calls meth:CloudWatch.Client.describe_alarms
to update the attributes of
the Alarm resource.
Type annotations and code completion for boto3.resource("cloudwatch").reload
method.
boto3 documentation
Alarm.set_state method
Temporarily sets the state of an alarm for testing purposes.
Type annotations and code completion for boto3.resource("cloudwatch").set_state
method.
boto3 documentation
def set_state(
self,
*,
StateValue: StateValueType, # (1)
StateReason: str,
StateReasonData: str = ...,
) -> None:
...
- See StateValueType
kwargs: SetAlarmStateInputAlarmSetStateTypeDef = { # (1)
"StateValue": ...,
"StateReason": ...,
}
parent.set_state(**kwargs)
Metric
Type annotations and code completion for boto3.resource("cloudwatch").Metric
class.
boto3 documentation
from mypy_boto3_cloudwatch.service_resource import Metric
def get_resource() -> Metric:
return boto3.resource("cloudwatch").Metric(...)
Metric attributes
metric_name
:str
dimensions
:List
[DimensionTypeDef]namespace
:str
name
:str
alarms
: MetricAlarmsCollection
Metric collections
Metric.alarms
Provides access to Alarm resource.
Type annotations and code completion for boto3.resource("cloudwatch").Metric(...).alarms
collection.
boto3 documentation
from mypy_boto3_cloudwatch.service_resource import MetricAlarmsCollection
def get_collection() -> MetricAlarmsCollection:
resource = boto3.resource("cloudwatch").Metric(...)
return resource.alarms
Metric methods
Metric.get_available_subresources method
Returns a list of all the available sub-resources for this Resource.
Type annotations and code completion for boto3.resource("cloudwatch").get_available_subresources
method.
boto3 documentation
Metric.get_statistics method
Gets statistics for the specified metric.
Type annotations and code completion for boto3.resource("cloudwatch").get_statistics
method.
boto3 documentation
def get_statistics(
self,
*,
StartTime: Union[datetime, str],
EndTime: Union[datetime, str],
Period: int,
Dimensions: Sequence[DimensionTypeDef] = ..., # (1)
Statistics: Sequence[StatisticType] = ..., # (2)
ExtendedStatistics: Sequence[str] = ...,
Unit: StandardUnitType = ..., # (3)
) -> GetMetricStatisticsOutputTypeDef: # (4)
...
kwargs: GetMetricStatisticsInputMetricGetStatisticsTypeDef = { # (1)
"StartTime": ...,
"EndTime": ...,
"Period": ...,
}
parent.get_statistics(**kwargs)
Metric.load method
Calls meth:CloudWatch.Client.list_metrics
to update the attributes of the
Metric resource.
Type annotations and code completion for boto3.resource("cloudwatch").load
method.
boto3 documentation
Metric.put_alarm method
Creates or updates an alarm and associates it with the specified metric, metric math expression, anomaly detection model, or Metrics Insights query.
Type annotations and code completion for boto3.resource("cloudwatch").put_alarm
method.
boto3 documentation
def put_alarm(
self,
*,
AlarmName: str,
EvaluationPeriods: int,
ComparisonOperator: ComparisonOperatorType, # (1)
AlarmDescription: str = ...,
ActionsEnabled: bool = ...,
OKActions: Sequence[str] = ...,
AlarmActions: Sequence[str] = ...,
InsufficientDataActions: Sequence[str] = ...,
Statistic: StatisticType = ..., # (2)
ExtendedStatistic: str = ...,
Dimensions: Sequence[DimensionTypeDef] = ..., # (3)
Period: int = ...,
Unit: StandardUnitType = ..., # (4)
DatapointsToAlarm: int = ...,
Threshold: float = ...,
TreatMissingData: str = ...,
EvaluateLowSampleCountPercentile: str = ...,
Metrics: Sequence[MetricDataQueryTypeDef] = ..., # (5)
Tags: Sequence[TagTypeDef] = ..., # (6)
ThresholdMetricId: str = ...,
) -> Alarm:
...
- See ComparisonOperatorType
- See StatisticType
- See DimensionTypeDef
- See StandardUnitType
- See MetricDataQueryTypeDef
- See TagTypeDef
kwargs: PutMetricAlarmInputMetricPutAlarmTypeDef = { # (1)
"AlarmName": ...,
"EvaluationPeriods": ...,
"ComparisonOperator": ...,
}
parent.put_alarm(**kwargs)
Metric.put_data method
Publishes metric data points to Amazon CloudWatch.
Type annotations and code completion for boto3.resource("cloudwatch").put_data
method.
boto3 documentation
Metric.reload method
Calls meth:CloudWatch.Client.list_metrics
to update the attributes of the
Metric resource.
Type annotations and code completion for boto3.resource("cloudwatch").reload
method.
boto3 documentation