Skip to content

AmplifyBackend module#

Index > AmplifyBackend

Auto-generated documentation for AmplifyBackend type annotations stubs module mypy-boto3-amplifybackend.

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 AmplifyBackend.

From PyPI with pip#

Install boto3-stubs for AmplifyBackend service.

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

# 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[amplifybackend]'

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

How to uninstall#

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


Code samples can be found in Examples.


Type annotations and code completion for boto3.client("amplifybackend") as AmplifyBackendClient boto3 documentation

# AmplifyBackendClient usage example

from boto3.session import Session

from mypy_boto3_amplifybackend.client import AmplifyBackendClient

def get_client() -> AmplifyBackendClient:
    return Session().client("amplifybackend")


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

# ListBackendJobsPaginator usage example

from boto3.session import Session

from mypy_boto3_amplifybackend.paginator import ListBackendJobsPaginator

def get_list_backend_jobs_paginator() -> ListBackendJobsPaginator:
    return Session().client("amplifybackend").get_paginator("list_backend_jobs"))


Type annotations for literals used in methods and schemas.

# AdditionalConstraintsElementType usage example

from mypy_boto3_amplifybackend.literals import AdditionalConstraintsElementType

def get_value() -> AdditionalConstraintsElementType:
    return "REQUIRE_DIGIT"

Typed dictionaries#

Type annotations for typed dictionaries used in methods and schema.

# BackendAPIAppSyncAuthSettingsTypeDef usage example

from mypy_boto3_amplifybackend.type_defs import BackendAPIAppSyncAuthSettingsTypeDef

def get_value() -> BackendAPIAppSyncAuthSettingsTypeDef:
    return {
        "CognitoUserPoolId": ...,