mypy-boto3-opsworkscm
Advanced tools
Type annotations for boto3 OpsWorksCM 1.36.0 service generated with mypy-boto3-builder 8.8.0
Type annotations for boto3 OpsWorksCM 1.36.0 compatible with VSCode, PyCharm, Emacs, Sublime Text, mypy, pyright and other tools.
Generated with mypy-boto3-builder 8.8.0.
More information can be found on boto3-stubs page and in mypy-boto3-opsworkscm docs.
See how it helps you find and fix potential bugs:
You can generate type annotations for boto3 package locally with
mypy_boto3_builder. Use
uv for build
isolation.
uvx --with 'boto3==1.36.0' mypy_boto3_builderboto3-stubs AWS SDK.OpsWorksCM service.Add
AWS Boto3
extension to your VSCode and run AWS boto3: Quick Start command.
Click Modify and select boto3 common and OpsWorksCM.
Install boto3-stubs for OpsWorksCM service.
# install with boto3 type annotations
python -m pip install 'boto3-stubs[opsworkscm]'
# Lite version does not provide session.client/resource overloads
# it is more RAM-friendly, but requires explicit type annotations
python -m pip install 'boto3-stubs-lite[opsworkscm]'
# standalone installation
python -m pip install mypy-boto3-opsworkscm
python -m pip uninstall -y mypy-boto3-opsworkscm
Pylance as your Python Language Serverboto3-stubs[opsworkscm] in your environment:python -m pip install 'boto3-stubs[opsworkscm]'
Both type checking and code completion should now work. No explicit type
annotations required, write your boto3 code as usual.
⚠️ Due to slow PyCharm performance on
Literaloverloads (issue PY-40997), it is recommended to use boto3-stubs-lite until the issue is resolved.
⚠️ If you experience slow performance and high CPU usage, try to disable
PyCharmtype checker and use mypy or pyright instead.
⚠️ To continue using
PyCharmtype checker, you can try to replaceboto3-stubswith boto3-stubs-lite:
pip uninstall boto3-stubs
pip install boto3-stubs-lite
Install boto3-stubs[opsworkscm] in your environment:
python -m pip install 'boto3-stubs[opsworkscm]'
Both type checking and code completion should now work.
boto3-stubs with services you use in your environment:python -m pip install 'boto3-stubs[opsworkscm]'
(use-package lsp-pyright
:ensure t
:hook (python-mode . (lambda ()
(require 'lsp-pyright)
(lsp))) ; or lsp-deferred
:init (when (executable-find "python3")
(setq lsp-pyright-python-executable-cmd "python3"))
)
boto3-stubsType checking should now work. No explicit type annotations required, write
your boto3 code as usual.
boto3-stubs[opsworkscm] with services you use in your environment:python -m pip install 'boto3-stubs[opsworkscm]'
Type checking should now work. No explicit type annotations required, write
your boto3 code as usual.
Not tested, but as long as your IDE supports mypy or pyright, everything
should work.
mypy: python -m pip install mypyboto3-stubs[opsworkscm] in your environment:python -m pip install 'boto3-stubs[opsworkscm]'
Type checking should now work. No explicit type annotations required, write
your boto3 code as usual.
pyright: npm i -g pyrightboto3-stubs[opsworkscm] in your environment:python -m pip install 'boto3-stubs[opsworkscm]'
Optionally, you can install boto3-stubs to typings directory.
Type checking should now work. No explicit type annotations required, write
your boto3 code as usual.
It is totally safe to use TYPE_CHECKING flag in order to avoid
mypy-boto3-opsworkscm dependency in production. However, there is an issue in
pylint that it complains about undefined variables. To fix it, set all types
to object in non-TYPE_CHECKING mode.
from typing import TYPE_CHECKING
if TYPE_CHECKING:
from mypy_boto3_ec2 import EC2Client, EC2ServiceResource
from mypy_boto3_ec2.waiters import BundleTaskCompleteWaiter
from mypy_boto3_ec2.paginators import DescribeVolumesPaginator
else:
EC2Client = object
EC2ServiceResource = object
BundleTaskCompleteWaiter = object
DescribeVolumesPaginator = object
...
OpsWorksCMClient provides annotations for boto3.client("opsworkscm").
from boto3.session import Session
from mypy_boto3_opsworkscm import OpsWorksCMClient
client: OpsWorksCMClient = Session().client("opsworkscm")
# now client usage is checked by mypy and IDE should provide code completion
mypy_boto3_opsworkscm.paginator module contains type annotations for all
paginators.
from boto3.session import Session
from mypy_boto3_opsworkscm import OpsWorksCMClient
from mypy_boto3_opsworkscm.paginator import (
DescribeBackupsPaginator,
DescribeEventsPaginator,
DescribeServersPaginator,
ListTagsForResourcePaginator,
)
client: OpsWorksCMClient = Session().client("opsworkscm")
# Explicit type annotations are optional here
# Types should be correctly discovered by mypy and IDEs
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"
)
mypy_boto3_opsworkscm.waiter module contains type annotations for all
waiters.
from boto3.session import Session
from mypy_boto3_opsworkscm import OpsWorksCMClient
from mypy_boto3_opsworkscm.waiter import NodeAssociatedWaiter
client: OpsWorksCMClient = Session().client("opsworkscm")
# Explicit type annotations are optional here
# Types should be correctly discovered by mypy and IDEs
node_associated_waiter: NodeAssociatedWaiter = client.get_waiter("node_associated")
mypy_boto3_opsworkscm.literals module contains literals extracted from shapes
that can be used in user code for type checking.
Full list of OpsWorksCM Literals can be found in
docs.
from mypy_boto3_opsworkscm.literals import BackupStatusType
def check_value(value: BackupStatusType) -> bool: ...
mypy_boto3_opsworkscm.type_defs module contains structures and shapes
assembled to typed dictionaries and unions for additional type checking.
Full list of OpsWorksCM TypeDefs can be found in
docs.
from mypy_boto3_opsworkscm.type_defs import AccountAttributeTypeDef
def get_value() -> AccountAttributeTypeDef:
return {...}
Fully automated
mypy-boto3-builder carefully
generates type annotations for each service, patiently waiting for boto3
updates. It delivers drop-in type annotations for you and makes sure that:
boto3 services are covered.boto3 service gets valid type
annotations extracted from botocore schemas.boto3, botocore, aiobotocore and aioboto3
librariesmypy, pyright, VSCode, PyCharm, Sublime Text and Emacs
compatibilityClient, ServiceResource, Resource, Waiter Paginator type
annotations for each serviceTypeDefs for each serviceLiterals for each serviceboto3.client and boto3.resource callssession.client and session.resource callsclient.get_waiter and client.get_paginator
callsServiceResource and Resource collectionsaiobotocore.Session.create_client callsBuilder changelog can be found in Releases.
mypy-boto3-opsworkscm version is the same as related boto3 version and
follows PEP 440 format.
All services type annotations can be found in boto3 docs
This package is auto-generated. Please reports any bugs or request new features in mypy-boto3-builder repository.
FAQs
Type annotations for boto3 OpsWorksCM 1.36.0 service generated with mypy-boto3-builder 8.8.0
We found that mypy-boto3-opsworkscm demonstrated a healthy version release cadence and project activity because the last version was released less than a year ago. It has 1 open source maintainer collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Security News
Fluent Assertions is facing backlash after dropping the Apache license for a commercial model, leaving users blindsided and questioning contributor rights.
Research
Security News
Socket researchers uncover the risks of a malicious Python package targeting Discord developers.
Security News
The UK is proposing a bold ban on ransomware payments by public entities to disrupt cybercrime, protect critical services, and lead global cybersecurity efforts.