Skip to main content

Type annotations for boto3.Synthetics 1.17.93 service, generated by mypy-boto3-buider 4.18.2

Project description

mypy-boto3-synthetics

PyPI - mypy-boto3-synthetics PyPI - Python Version Docs PyPI - Downloads

boto3.typed

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

Generated by mypy-boto3-buider 4.18.2.

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

How to install

Install boto3-stubs for Synthetics service.

python -m pip install boto3-stubs[synthetics]

Usage

VSCode

  • Install Python extension
  • Install Pylance extension
  • Set Pylance as your Python Language Server
  • Install boto-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 boto-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 support mypy or pyright, everything should work.

mypy

  • Install mypy: python -m pip install mypy
  • Install boto-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 boto-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").

import boto3

from mypy_boto3_synthetics import SyntheticsClient

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

# now client usage is checked by mypy and IDE should provide code auto-complete

# works for session as well
session = boto3.session.Session(region="us-west-1")
session_client: SyntheticsClient = session.client("synthetics")

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

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 (
    CanaryCodeInputTypeDef,
    CanaryCodeOutputTypeDef,
    CanaryLastRunTypeDef,
    CanaryRunConfigInputTypeDef,
    CanaryRunConfigOutputTypeDef,
    CanaryRunStatusTypeDef,
    CanaryRunTimelineTypeDef,
    CanaryRunTypeDef,
    CanaryScheduleInputTypeDef,
    CanaryScheduleOutputTypeDef,
    CanaryStatusTypeDef,
    CanaryTimelineTypeDef,
    CanaryTypeDef,
    CreateCanaryResponseTypeDef,
    DescribeCanariesLastRunResponseTypeDef,
    DescribeCanariesResponseTypeDef,
    DescribeRuntimeVersionsResponseTypeDef,
    GetCanaryResponseTypeDef,
    GetCanaryRunsResponseTypeDef,
    ListTagsForResourceResponseTypeDef,
    ResponseMetadataTypeDef,
    RuntimeVersionTypeDef,
    VpcConfigInputTypeDef,
    VpcConfigOutputTypeDef,
)

def get_structure() -> CanaryCodeInputTypeDef:
    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.

Project details


Release history Release notifications | RSS feed

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

mypy-boto3-synthetics-1.17.93.tar.gz (9.7 kB view details)

Uploaded Source

Built Distribution

mypy_boto3_synthetics-1.17.93-py3-none-any.whl (12.4 kB view details)

Uploaded Python 3

File details

Details for the file mypy-boto3-synthetics-1.17.93.tar.gz.

File metadata

  • Download URL: mypy-boto3-synthetics-1.17.93.tar.gz
  • Upload date:
  • Size: 9.7 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.4.1 importlib_metadata/4.5.0 pkginfo/1.7.0 requests/2.25.1 requests-toolbelt/0.9.1 tqdm/4.61.0 CPython/3.9.5

File hashes

Hashes for mypy-boto3-synthetics-1.17.93.tar.gz
Algorithm Hash digest
SHA256 d13568e5265c6e8322449a1ae65c3f948333b89d56bfdefbf11ae7b39f73b813
MD5 fb8f1bb74e939bf310cdeb5d963bded8
BLAKE2b-256 18102a79fd704edd9e22a4eca3bd462e5ecdebf2ee6cfbe05538bfca270cbc98

See more details on using hashes here.

File details

Details for the file mypy_boto3_synthetics-1.17.93-py3-none-any.whl.

File metadata

  • Download URL: mypy_boto3_synthetics-1.17.93-py3-none-any.whl
  • Upload date:
  • Size: 12.4 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.4.1 importlib_metadata/4.5.0 pkginfo/1.7.0 requests/2.25.1 requests-toolbelt/0.9.1 tqdm/4.61.0 CPython/3.9.5

File hashes

Hashes for mypy_boto3_synthetics-1.17.93-py3-none-any.whl
Algorithm Hash digest
SHA256 3520a378ba92c88dd36852603a492d063c1555994575c22c11ad00512ab59cff
MD5 7653e409c390a3b73acd123e4c5779a7
BLAKE2b-256 1bf4de5e71d2681a7cb3716a34a33b7bb1bcf46d634770e88ded5968b0464c71

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page