Type annotations for boto3.CloudWatch 1.14.0 service, generated by mypy-boto3-buider 2.1.0
Project description
mypy-boto3-cloudwatch
Type annotations for boto3.CloudWatch 1.14.0 service compatible with mypy, VSCode, PyCharm and other tools.
Generated by mypy-boto3-buider 2.1.0.
More information can be found on boto3-stubs page.
How to install
Make sure you have mypy installed and activated in your IDE.
Install boto3-stubs
for CloudWatch
service.
python -m pip install boto3-stubs[cloudwatch]
How to use
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
Typed dictionations
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, ...
def get_structure() -> AlarmHistoryItemTypeDef:
return {
...
}
Dynamic type annotations
mypy_boto3
command generates boto3.client/resource
type annotations for
mypy_boto3_cloudwatch
and other installed services.
# Run this command after you add or remove service packages
python -m mypy_boto3
Generated type annotations provide overloads for boto3.client
and boto3.resource
,
boto3.Session.client
and boto3.Session.resource
functions,
so explicit type annotations are not needed.
mypy
supports function overloads as expectedPyCharm
also supports function overloads, but consumes a lot of RAM, use carefully if you have many services installedVSCode
does not currently support function overloads, use explicit type annotations
import boto3
# Type is discovered correctly by mypy and PyCharm
# VSCode still needs explicit type annotations
client = boto3.client("cloudwatch")
resource = boto3.resource("cloudwatch")
session_client = boto3.Session().client("cloudwatch")
session_resource = boto3.Session().resource("cloudwatch")
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.14.0.1.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 0c9ce6c2d885723a38884aa9d8bf8e8908a1426830b603401e49f66e2b094d5a |
|
MD5 | 42811f39c9aa9acb1078068a4dd518ef |
|
BLAKE2b-256 | 10053de0370507fc7925f617b0c68b1777820671b40039af9cd8e7fd5bb92c3d |
Hashes for mypy_boto3_cloudwatch-1.14.0.1-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 86bd6dd0d1942763d62f096060c20acfa00708017964de44f48c1d382bdfbd74 |
|
MD5 | b7809dc8e034533449c6d34191e2f2cd |
|
BLAKE2b-256 | b583f2b10a8345ee52866c3ebba865f99b15295a527afcad221f7e5704adc3cd |