Examples

Index > Braket > Examples

Auto-generated documentation for Braket type annotations stubs module mypy-boto3-braket.

Client

Implicit type annotations

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

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

Client method usage example

# BraketClient usage example

from boto3.session import Session


session = Session()

client = session.client("braket")  # (1)
result = client.cancel_job()  # (2)

1. client: BraketClient
2. result: CancelJobResponseTypeDef

Paginator usage example

# SearchDevicesPaginator usage example

from boto3.session import Session


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

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

1. client: BraketClient
2. paginator: SearchDevicesPaginator
3. item: SearchDevicesResponseTypeDef

Explicit type annotations

With boto3-stubs-lite[braket] or a standalone mypy_boto3_braket package, you have to explicitly specify client: BraketClient 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

# BraketClient usage example with type annotations

from boto3.session import Session

from mypy_boto3_braket.client import BraketClient
from mypy_boto3_braket.type_defs import CancelJobResponseTypeDef
from mypy_boto3_braket.type_defs import CancelJobRequestTypeDef


session = Session()

client: BraketClient = session.client("braket")

kwargs: CancelJobRequestTypeDef = {...}
result: CancelJobResponseTypeDef = client.cancel_job(**kwargs)

Paginator usage example

# SearchDevicesPaginator usage example with type annotations

from boto3.session import Session

from mypy_boto3_braket.client import BraketClient
from mypy_boto3_braket.paginator import SearchDevicesPaginator
from mypy_boto3_braket.type_defs import SearchDevicesResponseTypeDef


session = Session()
client: BraketClient = session.client("braket")

paginator: SearchDevicesPaginator = client.get_paginator("search_devices")
for item in paginator.paginate(...):
    item: SearchDevicesResponseTypeDef
    print(item)