Type annotations for boto3.OpsWorksCM 1.14.5 service, generated by mypy-boto3-buider 2.2.0
Project description
mypy-boto3-opsworkscm
Type annotations for boto3.OpsWorksCM 1.14.5 service compatible with mypy, VSCode, PyCharm and other tools.
Generated by mypy-boto3-buider 2.2.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 OpsWorksCM
service.
python -m pip install boto3-stubs[opsworkscm]
How to use
Client annotations
OpsWorksCMClient
provides annotations for boto3.client("opsworkscm")
.
import boto3
from mypy_boto3_opsworkscm import OpsWorksCMClient
from mypy_boto3_opsworkscm.paginator import (
DescribeBackupsPaginator,
DescribeEventsPaginator,
DescribeServersPaginator,
ListTagsForResourcePaginator,
)
from mypy_boto3_opsworkscm.type_defs import AccountAttributeTypeDef, ...
from mypy_boto3_opsworkscm.waiter import NodeAssociatedWaiter
client: OpsWorksCMClient = boto3.client("opsworkscm")
# 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: OpsWorksCMClient = session.client("opsworkscm")
Paginators annotations
mypy_boto3_opsworkscm.paginator
module contains type annotations for all paginators.
client: OpsWorksCMClient = boto3.client("opsworkscm")
# Explicit type annotations are optional here
# Type should be correctly discovered by mypy and IDEs
# VSCode requires explicit type annotations
describe_backups_paginator: DescribeBackupsPaginator = client.get_paginator("describe_backups")
describe_events_paginator: DescribeEventsPaginator = client.get_paginator("describe_events")
describe_servers_paginator: DescribeServersPaginator = client.get_paginator("describe_servers")
list_tags_for_resource_paginator: ListTagsForResourcePaginator = client.get_paginator("list_tags_for_resource")
Waiters annotations
mypy_boto3_opsworkscm.waiter
module contains type annotations for all waiters.
client: OpsWorksCMClient = boto3.client("opsworkscm")
# Explicit type annotations are optional here
# Type should be correctly discovered by mypy and IDEs
# VSCode requires explicit type annotations
node_associated_waiter: NodeAssociatedWaiter = client.get_waiter("node_associated")
Typed dictionations
mypy_boto3_opsworkscm.type_defs
module contains structures and shapes assembled
to typed dictionaries for additional type checking.
def get_structure() -> AccountAttributeTypeDef:
return {
...
}
Dynamic type annotations
mypy_boto3
command generates boto3.client/resource
type annotations for
mypy_boto3_opsworkscm
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
# Type is discovered correctly by mypy and PyCharm
# VSCode still needs explicit type annotations
client = boto3.client("opsworkscm")
session_client = boto3.Session().client("opsworkscm")
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-opsworkscm-1.14.5.0.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 0f0aff9dbc5fb9fb58347d1a2911a033bed3a2cb15bba016a1418438a8576b73 |
|
MD5 | a9d7b636b5f7406fa70ef43fb2889e96 |
|
BLAKE2b-256 | 46a2d0b3ddbf9a89aecde089a222ec77d97cb7050edca04ece86e96e3d07e83f |
Hashes for mypy_boto3_opsworkscm-1.14.5.0-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | b0d99deef28d4778f5ab17c9a4aa810bea46c50572e94b4496aba0a4a0273fba |
|
MD5 | 2f0a986b638d9ef9b43e840fa177ff7f |
|
BLAKE2b-256 | 453aa3015f8a773d210f58e1e7278d1f1fd44130f66498fad4f063c2343fe7d5 |