Skip to content

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

Usage example
from mypy_boto3_cloudwatch.service_resource import CloudWatchServiceResource

def get_cloudwatch_resource() -> CloudWatchServiceResource:
    return boto3.resource("cloudwatch")

Attributes

Collections

ServiceResourceAlarmsCollection

Provides access to Alarm resource.

Type annotations and code completion for boto3.resource("cloudwatch").alarms collection. boto3 documentation

Usage example
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

Usage example
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

Method definition
def Alarm(
    self,
    name: str,
) -> Alarm:
    ...
Usage example with kwargs
kwargs: ServiceResourceAlarmRequestTypeDef = {  # (1)
    "name": ...,
}

parent.Alarm(**kwargs)
  1. See ServiceResourceAlarmRequestTypeDef

CloudWatchServiceResource.Metric method

Creates a Metric resource.

Type annotations and code completion for boto3.resource("cloudwatch").Metric method. boto3 documentation

Method definition
def Metric(
    self,
    namespace: str,
    name: str,
) -> Metric:
    ...
Usage example with kwargs
kwargs: ServiceResourceMetricRequestTypeDef = {  # (1)
    "namespace": ...,
    "name": ...,
}

parent.Metric(**kwargs)
  1. See ServiceResourceMetricRequestTypeDef

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

Method definition
def get_available_subresources(
    self,
) -> Sequence[str]:
    ...

Alarm

Type annotations and code completion for boto3.resource("cloudwatch").Alarm class. boto3 documentation

Usage example
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: StateValueType
  • state_reason: str
  • state_reason_data: str
  • state_updated_timestamp: datetime
  • metric_name: str
  • namespace: str
  • statistic: StatisticType
  • extended_statistic: str
  • dimensions: List[DimensionTypeDef]
  • period: int
  • unit: StandardUnitType
  • evaluation_periods: int
  • datapoints_to_alarm: int
  • threshold: float
  • comparison_operator: ComparisonOperatorType
  • treat_missing_data: str
  • evaluate_low_sample_count_percentile: str
  • metrics: List[MetricDataQueryTypeDef]
  • threshold_metric_id: str
  • 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

Method definition
def delete(
    self,
) -> None:
    ...

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

Method definition
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)
    ...
  1. See AlarmTypeType
  2. See HistoryItemTypeType
  3. See ScanByType
  4. See DescribeAlarmHistoryOutputTypeDef
Usage example with kwargs
kwargs: DescribeAlarmHistoryInputAlarmDescribeHistoryTypeDef = {  # (1)
    "AlarmTypes": ...,
}

parent.describe_history(**kwargs)
  1. See DescribeAlarmHistoryInputAlarmDescribeHistoryTypeDef

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

Method definition
def disable_actions(
    self,
) -> None:
    ...

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

Method definition
def enable_actions(
    self,
) -> None:
    ...

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

Method definition
def get_available_subresources(
    self,
) -> Sequence[str]:
    ...

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

Method definition
def load(
    self,
) -> None:
    ...

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

Method definition
def reload(
    self,
) -> None:
    ...

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

Method definition
def set_state(
    self,
    *,
    StateValue: StateValueType,  # (1)
    StateReason: str,
    StateReasonData: str = ...,
) -> None:
    ...
  1. See StateValueType
Usage example with kwargs
kwargs: SetAlarmStateInputAlarmSetStateTypeDef = {  # (1)
    "StateValue": ...,
    "StateReason": ...,
}

parent.set_state(**kwargs)
  1. See SetAlarmStateInputAlarmSetStateTypeDef

Metric

Type annotations and code completion for boto3.resource("cloudwatch").Metric class. boto3 documentation

Usage example
from mypy_boto3_cloudwatch.service_resource import Metric

def get_resource() -> Metric:
    return boto3.resource("cloudwatch").Metric(...)

Metric attributes

Metric collections

Metric.alarms

Provides access to Alarm resource.

Type annotations and code completion for boto3.resource("cloudwatch").Metric(...).alarms collection. boto3 documentation

Usage example
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

Method definition
def get_available_subresources(
    self,
) -> Sequence[str]:
    ...

Metric.get_statistics method

Gets statistics for the specified metric.

Type annotations and code completion for boto3.resource("cloudwatch").get_statistics method. boto3 documentation

Method definition
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)
    ...
  1. See DimensionTypeDef
  2. See StatisticType
  3. See StandardUnitType
  4. See GetMetricStatisticsOutputTypeDef
Usage example with kwargs
kwargs: GetMetricStatisticsInputMetricGetStatisticsTypeDef = {  # (1)
    "StartTime": ...,
    "EndTime": ...,
    "Period": ...,
}

parent.get_statistics(**kwargs)
  1. See GetMetricStatisticsInputMetricGetStatisticsTypeDef

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

Method definition
def load(
    self,
) -> None:
    ...

Metric.put_alarm method

Creates or updates an alarm and associates it with the specified metric, metric math expression, or anomaly detection model.

Type annotations and code completion for boto3.resource("cloudwatch").put_alarm method. boto3 documentation

Method definition
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:
    ...
  1. See ComparisonOperatorType
  2. See StatisticType
  3. See DimensionTypeDef
  4. See StandardUnitType
  5. See MetricDataQueryTypeDef
  6. See TagTypeDef
Usage example with kwargs
kwargs: PutMetricAlarmInputMetricPutAlarmTypeDef = {  # (1)
    "AlarmName": ...,
    "EvaluationPeriods": ...,
    "ComparisonOperator": ...,
}

parent.put_alarm(**kwargs)
  1. See PutMetricAlarmInputMetricPutAlarmTypeDef

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

Method definition
def put_data(
    self,
) -> None:
    ...

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

Method definition
def reload(
    self,
) -> None:
    ...