Type annotations for boto3.OpsWorksCM 1.14.23 service, generated by mypy-boto3-buider 2.2.0
Project description
mypy-boto3-opsworkscm
Type annotations for boto3.OpsWorksCM 1.14.23 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.23.0.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | d587464838f7144b8db7f1f1331c8e1a09935278eb055cb361540b4d4eafe054 |
|
MD5 | 34d1cca597cf339ce74eb1b2c3cc0cff |
|
BLAKE2b-256 | e96e08ea2b37379c72cf7cd7569f09534ea9a965c699bf5d4165355831e3c3b8 |
Hashes for mypy_boto3_opsworkscm-1.14.23.0-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 624445705a81bd4621990a7447ecd6a165265607389c4b74cfdfa1501baabfd2 |
|
MD5 | ebf143ba265d28ced571810b94da59ee |
|
BLAKE2b-256 | 13cfdc84de36068a07f5abd587e458a6b24b6424bfffea0d99dc31cc52b7f551 |