Skip to content

Examples#

Index > Greengrass > Examples

Auto-generated documentation for Greengrass type annotations stubs module mypy-boto3-greengrass.

Client#

Implicit type annotations#

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

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

Client method usage example#

# GreengrassClient usage example

from boto3.session import Session


session = Session()

client = session.client("greengrass")  # (1)
result = client.associate_role_to_group()  # (2)
  1. client: GreengrassClient
  2. result: AssociateRoleToGroupResponseTypeDef

Paginator usage example#

# ListBulkDeploymentDetailedReportsPaginator usage example

from boto3.session import Session


session = Session()
client = session.client("greengrass")  # (1)

paginator = client.get_paginator("list_bulk_deployment_detailed_reports")  # (2)
for item in paginator.paginate(...):
    print(item)  # (3)
  1. client: GreengrassClient
  2. paginator: ListBulkDeploymentDetailedReportsPaginator
  3. item: ListBulkDeploymentDetailedReportsResponseTypeDef

Explicit type annotations#

With boto3-stubs-lite[greengrass] or a standalone mypy_boto3_greengrass package, you have to explicitly specify client: GreengrassClient 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.

Client method usage example#

# GreengrassClient usage example with type annotations

from boto3.session import Session

from mypy_boto3_greengrass.client import GreengrassClient
from mypy_boto3_greengrass.type_defs import AssociateRoleToGroupResponseTypeDef
from mypy_boto3_greengrass.type_defs import AssociateRoleToGroupRequestTypeDef


session = Session()

client: GreengrassClient = session.client("greengrass")

kwargs: AssociateRoleToGroupRequestTypeDef = {...}
result: AssociateRoleToGroupResponseTypeDef = client.associate_role_to_group(**kwargs)

Paginator usage example#

# ListBulkDeploymentDetailedReportsPaginator usage example with type annotations

from boto3.session import Session

from mypy_boto3_greengrass.client import GreengrassClient
from mypy_boto3_greengrass.paginator import ListBulkDeploymentDetailedReportsPaginator
from mypy_boto3_greengrass.type_defs import ListBulkDeploymentDetailedReportsResponseTypeDef


session = Session()
client: GreengrassClient = session.client("greengrass")

paginator: ListBulkDeploymentDetailedReportsPaginator = client.get_paginator("list_bulk_deployment_detailed_reports")
for item in paginator.paginate(...):
    item: ListBulkDeploymentDetailedReportsResponseTypeDef
    print(item)