OpsWorksCM module#
Index > OpsWorksCM
Auto-generated documentation for OpsWorksCM type annotations stubs module types-boto3-opsworkscm.
How to install#
Generate locally (recommended)#
You can generate type annotations for boto3
package locally with mypy_boto3_builder
.
Use uv for build isolation.
- Run mypy-boto3-builder in your package root directory:
uvx --with 'boto3==1.35.86' mypy_boto3_builder
- Select
boto3
AWS SDK. - Add
OpsWorksCM
service. - Use provided commands to install generated packages.
VSCode extension#
Add AWS Boto3
extension to your VSCode and run AWS boto3: Quick Start
command.
Click Modify
and select boto3 common
and OpsWorksCM
.
From PyPI with pip#
Install types-boto3
for OpsWorksCM
service.
# install with boto3 type annotations
python -m pip install 'types-boto3[opsworkscm]'
# Lite version does not provide session.client/resource overloads
# it is more RAM-friendly, but requires explicit type annotations
python -m pip install 'types-boto3-lite[opsworkscm]'
# standalone installation
python -m pip install types-boto3-opsworkscm
How to uninstall#
python -m pip uninstall -y types-boto3-opsworkscm
Usage#
Code samples can be found in Examples.
OpsWorksCMClient#
Type annotations and code completion for boto3.client("opsworkscm")
as OpsWorksCMClient
boto3 documentation
# OpsWorksCMClient usage example
from boto3.session import Session
from types_boto3_opsworkscm.client import OpsWorksCMClient
def get_client() -> OpsWorksCMClient:
return Session().client("opsworkscm")
Paginators#
Type annotations and code completion for paginators
from boto3.client("opsworkscm").get_paginator("...")
.
# DescribeBackupsPaginator usage example
from boto3.session import Session
from types_boto3_opsworkscm.paginator import DescribeBackupsPaginator
def get_describe_backups_paginator() -> DescribeBackupsPaginator:
return Session().client("opsworkscm").get_paginator("describe_backups"))
- DescribeBackupsPaginator
- DescribeEventsPaginator
- DescribeServersPaginator
- ListTagsForResourcePaginator
Waiters#
Type annotations and code completion for waiters
from boto3.client("opsworkscm").get_waiter("...")
.
# NodeAssociatedWaiter usage example
from boto3.session import Session
from types_boto3_opsworkscm.waiter import NodeAssociatedWaiter
def get_node_associated_waiter() -> NodeAssociatedWaiter:
return Session().client("opsworkscm").get_waiter("node_associated")
Literals#
Type annotations for literals used in methods and schema.
# BackupStatusType usage example
from types_boto3_opsworkscm.literals import BackupStatusType
def get_value() -> BackupStatusType:
return "DELETING"
- BackupStatusType
- BackupTypeType
- DescribeBackupsPaginatorName
- DescribeEventsPaginatorName
- DescribeServersPaginatorName
- ListTagsForResourcePaginatorName
- MaintenanceStatusType
- NodeAssociatedWaiterName
- NodeAssociationStatusType
- ServerStatusType
- OpsWorksCMServiceName
- ServiceName
- ResourceServiceName
- PaginatorName
- WaiterName
- RegionName
Type definitions#
Type annotations for type definitions used in methods and schema.
- AccountAttributeTypeDef
- EngineAttributeTypeDef
- ResponseMetadataTypeDef
- BackupTypeDef
- TagTypeDef
- DeleteBackupRequestRequestTypeDef
- DeleteServerRequestRequestTypeDef
- PaginatorConfigTypeDef
- DescribeBackupsRequestRequestTypeDef
- DescribeEventsRequestRequestTypeDef
- ServerEventTypeDef
- DescribeNodeAssociationStatusRequestRequestTypeDef
- WaiterConfigTypeDef
- DescribeServersRequestRequestTypeDef
- ListTagsForResourceRequestRequestTypeDef
- RestoreServerRequestRequestTypeDef
- UntagResourceRequestRequestTypeDef
- UpdateServerEngineAttributesRequestRequestTypeDef
- UpdateServerRequestRequestTypeDef
- AssociateNodeRequestRequestTypeDef
- DisassociateNodeRequestRequestTypeDef
- ExportServerEngineAttributeRequestRequestTypeDef
- ServerTypeDef
- StartMaintenanceRequestRequestTypeDef
- AssociateNodeResponseTypeDef
- DescribeAccountAttributesResponseTypeDef
- DescribeNodeAssociationStatusResponseTypeDef
- DisassociateNodeResponseTypeDef
- ExportServerEngineAttributeResponseTypeDef
- CreateBackupResponseTypeDef
- DescribeBackupsResponseTypeDef
- CreateBackupRequestRequestTypeDef
- CreateServerRequestRequestTypeDef
- ListTagsForResourceResponseTypeDef
- TagResourceRequestRequestTypeDef
- DescribeBackupsRequestPaginateTypeDef
- DescribeEventsRequestPaginateTypeDef
- DescribeServersRequestPaginateTypeDef
- ListTagsForResourceRequestPaginateTypeDef
- DescribeEventsResponseTypeDef
- DescribeNodeAssociationStatusRequestWaitTypeDef
- CreateServerResponseTypeDef
- DescribeServersResponseTypeDef
- RestoreServerResponseTypeDef
- StartMaintenanceResponseTypeDef
- UpdateServerEngineAttributesResponseTypeDef
- UpdateServerResponseTypeDef