mypy-boto3-amplifybackend
![PyPI - Downloads](https://static.pepy.tech/badge/mypy-boto3-amplifybackend)
![boto3.typed](https://github.com/youtype/mypy_boto3_builder/raw/main/logo.png)
Type annotations for
boto3.AmplifyBackend 1.35.0
service compatible with VSCode,
PyCharm,
Emacs,
Sublime Text,
mypy,
pyright and other tools.
Generated by
mypy-boto3-builder 7.26.0.
More information can be found on
boto3-stubs page and in
mypy-boto3-amplifybackend docs.
See how it helps to find and fix potential bugs:
![boto3-stubs demo](https://github.com/youtype/mypy_boto3_builder/raw/main/demo.gif)
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.
python -m pip install 'boto3-stubs[amplifybackend]'
python -m pip install 'boto3-stubs-lite[amplifybackend]'
python -m pip install mypy-boto3-amplifybackend
How to uninstall
python -m pip uninstall -y mypy-boto3-amplifybackend
Usage
VSCode
python -m pip install 'boto3-stubs[amplifybackend]'
Both type checking and code completion should now work. No explicit type
annotations required, write your boto3
code as usual.
PyCharm
Install boto3-stubs-lite[amplifybackend]
in your environment:
python -m pip install 'boto3-stubs-lite[amplifybackend]'`
Both type checking and code completion should now work. Explicit type
annotations are required.
Use boto3-stubs
package instead for implicit type discovery.
Emacs
- Install
boto3-stubs
with services you use in your environment:
python -m pip install 'boto3-stubs[amplifybackend]'
(use-package lsp-pyright
:ensure t
:hook (python-mode . (lambda ()
(require 'lsp-pyright)
(lsp))) ; or lsp-deferred
:init (when (executable-find "python3")
(setq lsp-pyright-python-executable-cmd "python3"))
)
- Make sure emacs uses the environment where you have installed
boto3-stubs
Type checking should now work. No explicit type annotations required, write
your boto3
code as usual.
Sublime Text
- Install
boto3-stubs[amplifybackend]
with services you use in your
environment:
python -m pip install 'boto3-stubs[amplifybackend]'
Type checking should now work. No explicit type annotations required, write
your boto3
code as usual.
Other IDEs
Not tested, but as long as your IDE supports mypy
or pyright
, everything
should work.
mypy
- Install
mypy
: python -m pip install mypy
- Install
boto3-stubs[amplifybackend]
in your environment:
python -m pip install 'boto3-stubs[amplifybackend]'`
Type checking should now work. No explicit type annotations required, write
your boto3
code as usual.
pyright
- Install
pyright
: npm i -g pyright
- Install
boto3-stubs[amplifybackend]
in your environment:
python -m pip install 'boto3-stubs[amplifybackend]'
Optionally, you can install boto3-stubs
to typings
folder.
Type checking should now work. No explicit type annotations required, write
your boto3
code as usual.
Explicit type annotations
Client annotations
AmplifyBackendClient
provides annotations for
boto3.client("amplifybackend")
.
from boto3.session import Session
from mypy_boto3_amplifybackend import AmplifyBackendClient
client: AmplifyBackendClient = Session().client("amplifybackend")
Paginators annotations
mypy_boto3_amplifybackend.paginator
module contains type annotations for all
paginators.
from boto3.session import Session
from mypy_boto3_amplifybackend import AmplifyBackendClient
from mypy_boto3_amplifybackend.paginator import ListBackendJobsPaginator
client: AmplifyBackendClient = Session().client("amplifybackend")
list_backend_jobs_paginator: ListBackendJobsPaginator = client.get_paginator("list_backend_jobs")
Literals
mypy_boto3_amplifybackend.literals
module contains literals extracted from
shapes that can be used in user code for type checking.
Full list of AmplifyBackend
Literals can be found in
docs.
from mypy_boto3_amplifybackend.literals import AdditionalConstraintsElementType
def check_value(value: AdditionalConstraintsElementType) -> bool: ...
Type definitions
mypy_boto3_amplifybackend.type_defs
module contains structures and shapes
assembled to typed dictionaries and unions for additional type checking.
Full list of AmplifyBackend
TypeDefs can be found in
docs.
from mypy_boto3_amplifybackend.type_defs import BackendAPIAppSyncAuthSettingsTypeDef
def get_value() -> BackendAPIAppSyncAuthSettingsTypeDef:
return {...}
How it works
Fully automated
mypy-boto3-builder carefully
generates type annotations for each service, patiently waiting for boto3
updates. It delivers drop-in type annotations for you and makes sure that:
- All available
boto3
services are covered. - Each public class and method of every
boto3
service gets valid type
annotations extracted from botocore
schemas. - Type annotations include up-to-date documentation.
- Link to documentation is provided for every method.
- Code is processed by black and
isort for readability.
What's new
Implemented features
- Fully type annotated
boto3
, botocore
, aiobotocore
and aioboto3
libraries mypy
, pyright
, VSCode
, PyCharm
, Sublime Text
and Emacs
compatibilityClient
, ServiceResource
, Resource
, Waiter
Paginator
type
annotations for each service- Generated
TypeDefs
for each service - Generated
Literals
for each service - Auto discovery of types for
boto3.client
and boto3.resource
calls - Auto discovery of types for
session.client
and session.resource
calls - Auto discovery of types for
client.get_waiter
and client.get_paginator
calls - Auto discovery of types for
ServiceResource
and Resource
collections - Auto discovery of types for
aiobotocore.Session.create_client
calls
Latest changes
Builder changelog can be found in
Releases.
Versioning
mypy-boto3-amplifybackend
version is the same as related boto3
version and
follows PEP 440 format.
Thank you
Documentation
All services type annotations can be found in
boto3 docs
Support and contributing
This package is auto-generated. Please reports any bugs or request new features
in mypy-boto3-builder
repository.