mypy-boto3-synthetics 1.20.50

Type annotations for boto3.Synthetics 1.20.50 service generated by mypy-boto3-builder 7.0.1

mypy-boto3-synthetics

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

Generated by mypy-boto3-builder 7.0.1.

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:

• mypy-boto3-synthetics
  • How to install
    • VSCode extension
    • From PyPI with pip
  • Usage
    • VSCode
    • PyCharm
    • Other IDEs
    • mypy
    • pyright
  • Explicit type annotations
    • Client annotations
    • Literals
    • Typed dictionaries
  • Versioning
  • Documentation
  • Support and contributing

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

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 auto-complete should work for Synthetics service. No explicit type annotations required, write your boto3 code as usual.

PyCharm

• Install boto3-stubs[synthetics] in your environment: python -m pip install 'boto3-stubs[synthetics]'

Both type checking and auto-complete should work for Synthetics service. No explicit type annotations required, write your boto3 code as usual. Auto-complete can be slow on big projects or if you have a lot of installed boto3-stubs submodules.

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]'
• Run mypy as usual

Type checking should work for Synthetics service. No explicit type annotations required, write your boto3 code as usual.

pyright

• Install pyright: yarn global add 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 work for Synthetics service. 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 auto-complete

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,
    ServiceName,
)

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 {
      ...
    }

Versioning

mypy-boto3-synthetics version is the same as related boto3 version and follows PEP 440 format.

Documentation

All type annotations can be found in mypy-boto3-synthetics docs

Support and contributing

This package is auto-generated. Please reports any bugs or request new features in mypy-boto3-builder repository.