Skip to content

Braket module#

Index > Braket

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

How to install#

VSCode extension#

Add AWS Boto3 extension to your VSCode and run AWS boto3: Quick Start command.

Click Modify and select boto3 common and Braket.

From PyPI with pip#

Install boto3-stubs for Braket service.

# install with boto3 type annotations
python -m pip install 'boto3-stubs[braket]'

# Lite version does not provide session.client/resource overloads
# it is more RAM-friendly, but requires explicit type annotations
python -m pip install 'boto3-stubs-lite[braket]'

# standalone installation
python -m pip install mypy-boto3-braket

How to uninstall#

python -m pip uninstall -y mypy-boto3-braket


Code samples can be found in Examples.


Type annotations and code completion for boto3.client("braket") as BraketClient boto3 documentation

# BraketClient usage example

from boto3.session import Session

from mypy_boto3_braket.client import BraketClient

def get_client() -> BraketClient:
    return Session().client("braket")


Type annotations and code completion for paginators from boto3.client("braket").get_paginator("...").

# SearchDevicesPaginator usage example

from boto3.session import Session

from mypy_boto3_braket.paginator import SearchDevicesPaginator

def get_search_devices_paginator() -> SearchDevicesPaginator:
    return Session().client("braket").get_paginator("search_devices"))


Type annotations for literals used in methods and schemas.

# CancellationStatusType usage example

from mypy_boto3_braket.literals import CancellationStatusType

def get_value() -> CancellationStatusType:
    return "CANCELLED"

Typed dictionaries#

Type annotations for typed dictionaries used in methods and schema.

# ContainerImageTypeDef usage example

from mypy_boto3_braket.type_defs import ContainerImageTypeDef

def get_value() -> ContainerImageTypeDef:
    return {
        "uri": ...,