Skip to main content

Type annotations for boto3.SSMContacts 1.19.2 service, generated by mypy-boto3-builder 6.0.2

Project description

mypy-boto3-ssm-contacts

PyPI - mypy-boto3-ssm-contacts PyPI - Python Version Docs PyPI - Downloads

boto3.typed

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

Generated by mypy-boto3-builder 6.0.2.

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

See how it helps to find and fix potential bugs:

boto3-stubs demo

How to install

Install boto3-stubs for SSMContacts service.

python -m pip install boto3-stubs[ssm-contacts]

Usage

VSCode

  • Install Python extension
  • Install Pylance extension
  • Set Pylance as your Python Language Server
  • Install boto-stubs[ssm-contacts] in your environment: python -m pip install 'boto3-stubs[ssm-contacts]'

Both type checking and auto-complete should work for SSMContacts service. No explicit type annotations required, write your boto3 code as usual.

PyCharm

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

Both type checking and auto-complete should work for SSMContacts 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 boto-stubs[ssm-contacts] in your environment: python -m pip install 'boto3-stubs[ssm-contacts]'
  • Run mypy as usual

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

pyright

  • Install pyright: yarn global add pyright
  • Install boto-stubs[ssm-contacts] in your environment: python -m pip install 'boto3-stubs[ssm-contacts]'
  • Optionally, you can install boto3-stubs to typings folder.

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

Explicit type annotations

Client annotations

SSMContactsClient provides annotations for boto3.client("ssm-contacts").

import boto3

from mypy_boto3_ssm_contacts import SSMContactsClient

client: SSMContactsClient = boto3.client("ssm-contacts")

# 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: SSMContactsClient = session.client("ssm-contacts")

Paginators annotations

mypy_boto3_ssm_contacts.paginator module contains type annotations for all paginators.

from mypy_boto3_ssm_contacts import SSMContactsClient
from mypy_boto3_ssm_contacts.paginator import (
    ListContactChannelsPaginator,
    ListContactsPaginator,
    ListEngagementsPaginator,
    ListPageReceiptsPaginator,
    ListPagesByContactPaginator,
    ListPagesByEngagementPaginator,
)

client: SSMContactsClient = boto3.client("ssm-contacts")

# Explicit type annotations are optional here
# Type should be correctly discovered by mypy and IDEs
# VSCode requires explicit type annotations
list_contact_channels_paginator: ListContactChannelsPaginator = client.get_paginator("list_contact_channels")
list_contacts_paginator: ListContactsPaginator = client.get_paginator("list_contacts")
list_engagements_paginator: ListEngagementsPaginator = client.get_paginator("list_engagements")
list_page_receipts_paginator: ListPageReceiptsPaginator = client.get_paginator("list_page_receipts")
list_pages_by_contact_paginator: ListPagesByContactPaginator = client.get_paginator("list_pages_by_contact")
list_pages_by_engagement_paginator: ListPagesByEngagementPaginator = client.get_paginator("list_pages_by_engagement")

Literals

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

from mypy_boto3_ssm_contacts.literals import (
    AcceptCodeValidationType,
    AcceptTypeType,
    ActivationStatusType,
    ChannelTypeType,
    ContactTypeType,
    ListContactChannelsPaginatorName,
    ListContactsPaginatorName,
    ListEngagementsPaginatorName,
    ListPageReceiptsPaginatorName,
    ListPagesByContactPaginatorName,
    ListPagesByEngagementPaginatorName,
    ReceiptTypeType,
    ServiceName,
    PaginatorName,
)

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

Typed dictionaries

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

from mypy_boto3_ssm_contacts.type_defs import (
    AcceptPageRequestRequestTypeDef,
    ActivateContactChannelRequestRequestTypeDef,
    ChannelTargetInfoTypeDef,
    ContactChannelAddressTypeDef,
    ContactChannelTypeDef,
    ContactTargetInfoTypeDef,
    ContactTypeDef,
    CreateContactChannelRequestRequestTypeDef,
    CreateContactChannelResultTypeDef,
    CreateContactRequestRequestTypeDef,
    CreateContactResultTypeDef,
    DeactivateContactChannelRequestRequestTypeDef,
    DeleteContactChannelRequestRequestTypeDef,
    DeleteContactRequestRequestTypeDef,
    DescribeEngagementRequestRequestTypeDef,
    DescribeEngagementResultTypeDef,
    DescribePageRequestRequestTypeDef,
    DescribePageResultTypeDef,
    EngagementTypeDef,
    GetContactChannelRequestRequestTypeDef,
    GetContactChannelResultTypeDef,
    GetContactPolicyRequestRequestTypeDef,
    GetContactPolicyResultTypeDef,
    GetContactRequestRequestTypeDef,
    GetContactResultTypeDef,
    ListContactChannelsRequestRequestTypeDef,
    ListContactChannelsResultTypeDef,
    ListContactsRequestRequestTypeDef,
    ListContactsResultTypeDef,
    ListEngagementsRequestRequestTypeDef,
    ListEngagementsResultTypeDef,
    ListPageReceiptsRequestRequestTypeDef,
    ListPageReceiptsResultTypeDef,
    ListPagesByContactRequestRequestTypeDef,
    ListPagesByContactResultTypeDef,
    ListPagesByEngagementRequestRequestTypeDef,
    ListPagesByEngagementResultTypeDef,
    ListTagsForResourceRequestRequestTypeDef,
    ListTagsForResourceResultTypeDef,
    PageTypeDef,
    PaginatorConfigTypeDef,
    PlanTypeDef,
    PutContactPolicyRequestRequestTypeDef,
    ReceiptTypeDef,
    ResponseMetadataTypeDef,
    SendActivationCodeRequestRequestTypeDef,
    StageTypeDef,
    StartEngagementRequestRequestTypeDef,
    StartEngagementResultTypeDef,
    StopEngagementRequestRequestTypeDef,
    TagResourceRequestRequestTypeDef,
    TagTypeDef,
    TargetTypeDef,
    TimeRangeTypeDef,
    UntagResourceRequestRequestTypeDef,
    UpdateContactChannelRequestRequestTypeDef,
    UpdateContactRequestRequestTypeDef,
)

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

Versioning

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

Documentation

All type annotations can be found in mypy-boto3-ssm-contacts 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-ssm-contacts-1.19.2.tar.gz (15.8 kB view details)

Uploaded Source

Built Distribution

mypy_boto3_ssm_contacts-1.19.2-py3-none-any.whl (24.2 kB view details)

Uploaded Python 3

File details

Details for the file mypy-boto3-ssm-contacts-1.19.2.tar.gz.

File metadata

  • Download URL: mypy-boto3-ssm-contacts-1.19.2.tar.gz
  • Upload date:
  • Size: 15.8 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.4.2 importlib_metadata/4.8.1 pkginfo/1.7.1 requests/2.26.0 requests-toolbelt/0.9.1 tqdm/4.62.3 CPython/3.10.0

File hashes

Hashes for mypy-boto3-ssm-contacts-1.19.2.tar.gz
Algorithm Hash digest
SHA256 9a94598322616a465c4fbd12f114cf8a69344ed8f80ebad017b763acde21299e
MD5 d51786e36e98954060e4537e57cff320
BLAKE2b-256 84ebd8777100072233bbff13873b639a9a6943540e24d44b4fd6878bf58afe11

See more details on using hashes here.

File details

Details for the file mypy_boto3_ssm_contacts-1.19.2-py3-none-any.whl.

File metadata

  • Download URL: mypy_boto3_ssm_contacts-1.19.2-py3-none-any.whl
  • Upload date:
  • Size: 24.2 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.4.2 importlib_metadata/4.8.1 pkginfo/1.7.1 requests/2.26.0 requests-toolbelt/0.9.1 tqdm/4.62.3 CPython/3.10.0

File hashes

Hashes for mypy_boto3_ssm_contacts-1.19.2-py3-none-any.whl
Algorithm Hash digest
SHA256 230211c5d6f27e63456d605e558d186e1737014b2e57831b43fc003986e060ef
MD5 12d6a8620221bb7f3873f9f81ed3ed95
BLAKE2b-256 e347a1fca4737a052f27e7440ebe42902a16981b330bf495975d681b7f643397

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