Examples

Index > DevOpsGuru > Examples

Auto-generated documentation for DevOpsGuru type annotations stubs module mypy-boto3-devops-guru.

Client

Implicit type annotations

Can be used with boto3-stubs[devops-guru] package installed.

Write your DevOpsGuru code as usual, type checking and code completion should work out of the box.

# DevOpsGuruClient usage example

from boto3.session import Session


session = Session()

client = session.client("devops-guru")  # (1)
result = client.add_notification_channel()  # (2)

1. client: DevOpsGuruClient
2. result: AddNotificationChannelResponseTypeDef

# DescribeOrganizationResourceCollectionHealthPaginator usage example

from boto3.session import Session


session = Session()
client = session.client("devops-guru")  # (1)

paginator = client.get_paginator("describe_organization_resource_collection_health")  # (2)
for item in paginator.paginate(...):
    print(item)  # (3)

1. client: DevOpsGuruClient
2. paginator: DescribeOrganizationResourceCollectionHealthPaginator
3. item: DescribeOrganizationResourceCollectionHealthResponseTypeDef

Explicit type annotations

With boto3-stubs-lite[devops-guru] or a standalone mypy_boto3_devops_guru package, you have to explicitly specify client: DevOpsGuruClient type annotation.

All other type annotations are optional, as types should be discovered automatically. However, these type annotations can be helpful in your functions and methods.

# DevOpsGuruClient usage example with type annotations

from boto3.session import Session

from mypy_boto3_devops_guru.client import DevOpsGuruClient
from mypy_boto3_devops_guru.type_defs import AddNotificationChannelResponseTypeDef
from mypy_boto3_devops_guru.type_defs import AddNotificationChannelRequestRequestTypeDef


session = Session()

client: DevOpsGuruClient = session.client("devops-guru")

kwargs: AddNotificationChannelRequestRequestTypeDef = {...}
result: AddNotificationChannelResponseTypeDef = client.add_notification_channel(**kwargs)

# DescribeOrganizationResourceCollectionHealthPaginator usage example with type annotations

from boto3.session import Session

from mypy_boto3_devops_guru.client import DevOpsGuruClient
from mypy_boto3_devops_guru.paginator import DescribeOrganizationResourceCollectionHealthPaginator
from mypy_boto3_devops_guru.type_defs import DescribeOrganizationResourceCollectionHealthResponseTypeDef


session = Session()
client: DevOpsGuruClient = session.client("devops-guru")

paginator: DescribeOrganizationResourceCollectionHealthPaginator = client.get_paginator("describe_organization_resource_collection_health")
for item in paginator.paginate(...):
    item: DescribeOrganizationResourceCollectionHealthResponseTypeDef
    print(item)