mypy-boto3-synthetics

boto3.typed

Type annotations for boto3.Synthetics 1.23.0 service compatible with VSCode, PyCharm, Emacs, Sublime Text, mypy, pyright and other tools.

Generated by mypy-boto3-builder 7.5.14.

More information can be found on boto3-stubs page and in mypy-boto3-synthetics docs

See how it helps to find and fix potential bugs:

boto3-stubs demo

mypy-boto3-synthetics

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

From PyPI with pip

Install boto3-stubs for Synthetics service.

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


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


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

How to uninstall

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

Usage

VSCode

Install Python extension
Install Pylance extension
Set Pylance as your Python Language Server
Install boto3-stubs[synthetics] in your environment:

python -m pip install 'boto3-stubs[synthetics]'

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[synthetics] in your environment:

python -m pip install 'boto3-stubs-lite[synthetics]'`

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[synthetics]'

Install use-package, lsp, company and flycheck packages
Install lsp-pyright package

(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[synthetics] with services you use in your environment:

python -m pip install 'boto3-stubs[synthetics]'

Install LSP-pyright package

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[synthetics] in your environment:

python -m pip install 'boto3-stubs[synthetics]'`

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[synthetics] in your environment:

python -m pip install 'boto3-stubs[synthetics]'

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

SyntheticsClient provides annotations for boto3.client("synthetics").

from boto3.session import Session

from mypy_boto3_synthetics import SyntheticsClient

client: SyntheticsClient = Session().client("synthetics")

# now client usage is checked by mypy and IDE should provide code completion

Literals

mypy_boto3_synthetics.literals module contains literals extracted from shapes that can be used in user code for type checking.

from mypy_boto3_synthetics.literals import (
    CanaryRunStateReasonCodeType,
    CanaryRunStateType,
    CanaryStateReasonCodeType,
    CanaryStateType,
    EncryptionModeType,
    SyntheticsServiceName,
    ServiceName,
    ResourceServiceName,
    RegionName,
)

def check_value(value: CanaryRunStateReasonCodeType) -> bool:
    ...

Typed dictionaries

mypy_boto3_synthetics.type_defs module contains structures and shapes assembled to typed dictionaries for additional type checking.

from mypy_boto3_synthetics.type_defs import (
    ArtifactConfigInputTypeDef,
    ArtifactConfigOutputTypeDef,
    BaseScreenshotTypeDef,
    CanaryCodeInputTypeDef,
    CanaryCodeOutputTypeDef,
    CanaryLastRunTypeDef,
    CanaryRunConfigInputTypeDef,
    CanaryRunConfigOutputTypeDef,
    CanaryRunStatusTypeDef,
    CanaryRunTimelineTypeDef,
    CanaryRunTypeDef,
    CanaryScheduleInputTypeDef,
    CanaryScheduleOutputTypeDef,
    CanaryStatusTypeDef,
    CanaryTimelineTypeDef,
    CanaryTypeDef,
    CreateCanaryRequestRequestTypeDef,
    CreateCanaryResponseTypeDef,
    DeleteCanaryRequestRequestTypeDef,
    DescribeCanariesLastRunRequestRequestTypeDef,
    DescribeCanariesLastRunResponseTypeDef,
    DescribeCanariesRequestRequestTypeDef,
    DescribeCanariesResponseTypeDef,
    DescribeRuntimeVersionsRequestRequestTypeDef,
    DescribeRuntimeVersionsResponseTypeDef,
    GetCanaryRequestRequestTypeDef,
    GetCanaryResponseTypeDef,
    GetCanaryRunsRequestRequestTypeDef,
    GetCanaryRunsResponseTypeDef,
    ListTagsForResourceRequestRequestTypeDef,
    ListTagsForResourceResponseTypeDef,
    ResponseMetadataTypeDef,
    RuntimeVersionTypeDef,
    S3EncryptionConfigTypeDef,
    StartCanaryRequestRequestTypeDef,
    StopCanaryRequestRequestTypeDef,
    TagResourceRequestRequestTypeDef,
    UntagResourceRequestRequestTypeDef,
    UpdateCanaryRequestRequestTypeDef,
    VisualReferenceInputTypeDef,
    VisualReferenceOutputTypeDef,
    VpcConfigInputTypeDef,
    VpcConfigOutputTypeDef,
)

def get_structure() -> ArtifactConfigInputTypeDef:
    return {
      ...
    }

How it works

Fully automated mypy-boto3-builder carefully generates type annotations for each service, patiently waiting for boto3 updates. It delivers a 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 the documentation (blame botocore docs if types are incorrect).
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 and aiobotocore libraries
mypy, pyright, VSCode, PyCharm, Sublime Text and Emacs compatibility
Client, 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.session calls
Auto discovery of types for session.client and session.session 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-synthetics version is the same as related boto3 version and follows PEP 440 format.

Thank you

Allie Fitter for boto3-type-annotations, this package is based on top of his work
black developers for an awesome formatting tool
Timothy Edmund Crosley for isort and how flexible it is
mypy developers for doing all dirty work for us
pyright team for the new era of typed Python

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.

Metadata

Release files for mypy-boto3-synthetics 1.23.0.post1

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for mypy-boto3-synthetics 1.23.0.post1
File	Size	Uploaded
mypy-boto3-synthetics-1.23.0.post1.tar.gz	15.7 kB	May 13, 2022	Details

Built distribution (wheel)

Table of built distributions (wheels) for mypy-boto3-synthetics 1.23.0.post1
File	Interpreter	ABI	Platform	Reset
mypy_boto3_synthetics-1.23.0.post1-py3-none-any.whl 20.3 kB May 13, 2022	Python 3	none	any	Details

Total release size: 36.0 kB

Release files / mypy-boto3-synthetics-1.23.0.post1.tar.gz

Download URL	mypy-boto3-synthetics-1.23.0.post1.tar.gz
Size	15.7 kB
Tags	Source
SHA-256 checksum How to use checksums	`edc2005d5ec650e3fc351c982e98067004b03c6528668cd75358ff7c2bd116f7`
BLAKE2b-256 checksum How to use checksums	`ca55c07425a1e88b0c7f5e694ac5e02ba9a6b1ba98f69f0f524d09a466baf77c`
Upload date	May 13, 2022
Uploaded using Trusted Publishing? What is trusted publishing?	No
Uploaded via	`twine/4.0.0 CPython/3.10.4`

Release files / mypy_boto3_synthetics-1.23.0.post1-py3-none-any.whl

Download URL	mypy_boto3_synthetics-1.23.0.post1-py3-none-any.whl
Size	20.3 kB
Tags	Python 3
SHA-256 checksum How to use checksums	`6d442e9bd638add472043e1ed70b1b8f8c1fa309ddb9a090195d1c55abde4e0d`
BLAKE2b-256 checksum How to use checksums	`48af4d882a0d475080bd48d872f562032eb5dca721e78f8f03b767169a72038f`
Upload date	May 13, 2022
Uploaded using Trusted Publishing? What is trusted publishing?	No
Uploaded via	`twine/4.0.0 CPython/3.10.4`