Skip to content

Examples#

Index > LookoutMetrics > Examples

Auto-generated documentation for LookoutMetrics type annotations stubs module mypy-boto3-lookoutmetrics.

Client#

Implicit type annotations#

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

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

Client method usage example#

# LookoutMetricsClient usage example

from boto3.session import Session


session = Session()

client = session.client("lookoutmetrics")  # (1)
result = client.create_alert()  # (2)
  1. client: LookoutMetricsClient
  2. result: CreateAlertResponseTypeDef

Explicit type annotations#

With boto3-stubs-lite[lookoutmetrics] or a standalone mypy_boto3_lookoutmetrics package, you have to explicitly specify client: LookoutMetricsClient 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#

# LookoutMetricsClient usage example with type annotations

from boto3.session import Session

from mypy_boto3_lookoutmetrics.client import LookoutMetricsClient
from mypy_boto3_lookoutmetrics.type_defs import CreateAlertResponseTypeDef
from mypy_boto3_lookoutmetrics.type_defs import CreateAlertRequestTypeDef


session = Session()

client: LookoutMetricsClient = session.client("lookoutmetrics")

kwargs: CreateAlertRequestTypeDef = {...}
result: CreateAlertResponseTypeDef = client.create_alert(**kwargs)