Type annotations for boto3.CloudWatch 1.17.65 service, generated by mypy-boto3-buider 4.10.0
Project description
mypy-boto3-cloudwatch
Type annotations for boto3.CloudWatch 1.17.65 service compatible with VSCode, PyCharm, Emacs, Sublime Text, mypy, pyright and other tools.
Generated by mypy-boto3-buider 4.10.0.
More information can be found on boto3-stubs page and in mypy-boto3-cloudwatch docs
See how it helps to find and fix potential bugs:
How to install
Install boto3-stubs
for CloudWatch
service.
python -m pip install boto3-stubs[cloudwatch]
Usage
VSCode
- Install Python extension
- Install Pylance extension
- Set
Pylance
as your Python Language Server - Install
boto-stubs[cloudwatch]
in your environment:python -m pip install 'boto3-stubs[cloudwatch]'
Both type checking and auto-complete should work for CloudWatch
service. No
explicit type annotations required, write your boto3
code as usual.
PyCharm
- Install
boto-stubs[cloudwatch]
in your environment:python -m pip install 'boto3-stubs[cloudwatch]'
Both type checking and auto-complete should work for CloudWatch
service. No
explicit type annotations required, write your boto3
code as usual.
Auto-complete can be slow on big projects or if you have a lot of installed
boto3-stubs
submodules.
Other IDEs
Not tested, but as long as your IDE support mypy
or pyright
, everything
should work.
mypy
- Install
mypy
:python -m pip install mypy
- Install
boto-stubs[cloudwatch]
in your environment:python -m pip install 'boto3-stubs[cloudwatch]'
- Run
mypy
as usual
Type checking should work for CloudWatch
service. No explicit type
annotations required, write your boto3
code as usual.
pyright
- Install
pyright
:yarn global add pyright
- Install
boto-stubs[cloudwatch]
in your environment:python -m pip install 'boto3-stubs[cloudwatch]'
- Optionally, you can install
boto3-stubs
totypings
folder.
Type checking should work for CloudWatch
service. No explicit type
annotations required, write your boto3
code as usual.
Explicit type annotations
Client annotations
CloudWatchClient
provides annotations for boto3.client("cloudwatch")
.
import boto3
from mypy_boto3_cloudwatch import CloudWatchClient
client: CloudWatchClient = boto3.client("cloudwatch")
# now client usage is checked by mypy and IDE should provide code auto-complete
# works for session as well
session = boto3.session.Session(region="us-west-1")
session_client: CloudWatchClient = session.client("cloudwatch")
Paginators annotations
mypy_boto3_cloudwatch.paginator
module contains type annotations for all
paginators.
from mypy_boto3_cloudwatch import CloudWatchClient
from mypy_boto3_cloudwatch.paginator import (
DescribeAlarmHistoryPaginator,
DescribeAlarmsPaginator,
GetMetricDataPaginator,
ListDashboardsPaginator,
ListMetricsPaginator,
)
client: CloudWatchClient = boto3.client("cloudwatch")
# Explicit type annotations are optional here
# Type should be correctly discovered by mypy and IDEs
# VSCode requires explicit type annotations
describe_alarm_history_paginator: DescribeAlarmHistoryPaginator = client.get_paginator("describe_alarm_history")
describe_alarms_paginator: DescribeAlarmsPaginator = client.get_paginator("describe_alarms")
get_metric_data_paginator: GetMetricDataPaginator = client.get_paginator("get_metric_data")
list_dashboards_paginator: ListDashboardsPaginator = client.get_paginator("list_dashboards")
list_metrics_paginator: ListMetricsPaginator = client.get_paginator("list_metrics")
Waiters annotations
mypy_boto3_cloudwatch.waiter
module contains type annotations for all
waiters.
from mypy_boto3_cloudwatch import CloudWatchClient
from mypy_boto3_cloudwatch.waiter import (
AlarmExistsWaiter,
CompositeAlarmExistsWaiter,
)
client: CloudWatchClient = boto3.client("cloudwatch")
# Explicit type annotations are optional here
# Type should be correctly discovered by mypy and IDEs
# VSCode requires explicit type annotations
alarm_exists_waiter: AlarmExistsWaiter = client.get_waiter("alarm_exists")
composite_alarm_exists_waiter: CompositeAlarmExistsWaiter = client.get_waiter("composite_alarm_exists")
Service Resource annotations
CloudWatchServiceResource
provides annotations for
boto3.resource("cloudwatch")
.
from mypy_boto3_cloudwatch import CloudWatchServiceResource
resource: CloudWatchServiceResource = boto3.resource("cloudwatch")
# now resource usage is checked by mypy and IDE should provide code auto-complete
# works for session as well
session = boto3.session.Session(region="us-west-1")
session_resource: CloudWatchServiceResource = session.resource("cloudwatch")
Other resources annotations
mypy_boto3_cloudwatch.service_resource
module contains type annotations for
all resources.
from mypy_boto3_cloudwatch import CloudWatchServiceResource
from mypy_boto3_cloudwatch.service_resource import (
Alarm,
Metric,
)
resource: CloudWatchServiceResource = boto3.resource("cloudwatch")
# Explicit type annotations are optional here
# Type should be correctly discovered by mypy and IDEs
my_alarm: Alarm = resource.Alarm(...)
my_metric: Metric = resource.Metric(...)
Collections annotations
mypy_boto3_cloudwatch.service_resource
module contains type annotations for
all CloudWatchServiceResource
collections.
from mypy_boto3_cloudwatch import CloudWatchServiceResource
from mypy_boto3_cloudwatch.service_resource import (
ServiceResourceAlarmsCollection,
ServiceResourceMetricsCollection,
)
resource: CloudWatchServiceResource = boto3.resource("cloudwatch")
# Explicit type annotations are optional here
# Type should be correctly discovered by mypy and IDEs
alarms: cloudwatch_resources.ServiceResourceAlarmsCollection = resource.alarms
metrics: cloudwatch_resources.ServiceResourceMetricsCollection = resource.metrics
Literals
mypy_boto3_cloudwatch.literals
module contains literals extracted from shapes
that can be used in user code for type checking.
from mypy_boto3_cloudwatch.literals import (
AlarmExistsWaiterName,
AlarmType,
AnomalyDetectorStateValue,
ComparisonOperator,
CompositeAlarmExistsWaiterName,
DescribeAlarmHistoryPaginatorName,
DescribeAlarmsPaginatorName,
GetMetricDataPaginatorName,
HistoryItemType,
ListDashboardsPaginatorName,
ListMetricsPaginatorName,
MetricStreamOutputFormat,
RecentlyActive,
ScanBy,
StandardUnit,
StateValue,
Statistic,
StatusCode,
)
def check_value(value: AlarmExistsWaiterName) -> bool:
...
Typed dictionaries
mypy_boto3_cloudwatch.type_defs
module contains structures and shapes
assembled to typed dictionaries for additional type checking.
from mypy_boto3_cloudwatch.type_defs import (
AlarmHistoryItemTypeDef,
AnomalyDetectorConfigurationTypeDef,
AnomalyDetectorTypeDef,
CompositeAlarmTypeDef,
DashboardEntryTypeDef,
DashboardValidationMessageTypeDef,
DatapointTypeDef,
DeleteInsightRulesOutputTypeDef,
DescribeAlarmHistoryOutputTypeDef,
DescribeAlarmsForMetricOutputTypeDef,
DescribeAlarmsOutputTypeDef,
DescribeAnomalyDetectorsOutputTypeDef,
DescribeInsightRulesOutputTypeDef,
DimensionFilterTypeDef,
DimensionTypeDef,
DisableInsightRulesOutputTypeDef,
EnableInsightRulesOutputTypeDef,
GetDashboardOutputTypeDef,
GetInsightRuleReportOutputTypeDef,
GetMetricDataOutputTypeDef,
GetMetricStatisticsOutputTypeDef,
GetMetricStreamOutputTypeDef,
GetMetricWidgetImageOutputTypeDef,
InsightRuleContributorDatapointTypeDef,
InsightRuleContributorTypeDef,
InsightRuleMetricDatapointTypeDef,
InsightRuleTypeDef,
LabelOptionsTypeDef,
ListDashboardsOutputTypeDef,
ListMetricStreamsOutputTypeDef,
ListMetricsOutputTypeDef,
ListTagsForResourceOutputTypeDef,
MessageDataTypeDef,
MetricAlarmTypeDef,
MetricDataQueryTypeDef,
MetricDataResultTypeDef,
MetricDatumTypeDef,
MetricStatTypeDef,
MetricStreamEntryTypeDef,
MetricStreamFilterTypeDef,
MetricTypeDef,
PaginatorConfigTypeDef,
PartialFailureTypeDef,
PutDashboardOutputTypeDef,
PutMetricStreamOutputTypeDef,
RangeTypeDef,
ResponseMetadata,
StatisticSetTypeDef,
TagTypeDef,
WaiterConfigTypeDef,
)
def get_structure() -> AlarmHistoryItemTypeDef:
return {
...
}
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Hashes for mypy-boto3-cloudwatch-1.17.65.0.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 73f1bb21e3c599a8769a2c251c1d3ab5d246d29b9c5fee2b5fef7c642b5ceb6d |
|
MD5 | b3ab62877debf42ce64967fafbeb6719 |
|
BLAKE2b-256 | 7b4d55852d4de46cc1cf967b337d0e60e842ea10cc2cb3958163bd28f103dad2 |
Hashes for mypy_boto3_cloudwatch-1.17.65.0-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 91ab805ddb392329b8cfafbfbc496f4ab88d5a4fdcc57fe53b03e3f766c7db53 |
|
MD5 | bb4e4e197f3eb99bff65fbff67f63cbd |
|
BLAKE2b-256 | ef8bb264bd20eef261e072ce213a324f889033b77f39d856e99477eeb9a2a468 |