Type annotations for boto3.AlexaForBusiness 1.14.0 service, generated by mypy-boto3-buider 2.2.0
Project description
mypy-boto3-alexaforbusiness
Type annotations for boto3.AlexaForBusiness 1.14.0 service compatible with mypy, VSCode, PyCharm and other tools.
Generated by mypy-boto3-buider 2.2.0.
More information can be found on boto3-stubs page.
How to install
Make sure you have mypy installed and activated in your IDE.
Install boto3-stubs
for AlexaForBusiness
service.
python -m pip install boto3-stubs[alexaforbusiness]
How to use
Client annotations
AlexaForBusinessClient
provides annotations for boto3.client("alexaforbusiness")
.
import boto3
from mypy_boto3_alexaforbusiness import AlexaForBusinessClient
from mypy_boto3_alexaforbusiness.paginator import (
ListBusinessReportSchedulesPaginator,
ListConferenceProvidersPaginator,
ListDeviceEventsPaginator,
ListSkillsPaginator,
ListSkillsStoreCategoriesPaginator,
ListSkillsStoreSkillsByCategoryPaginator,
ListSmartHomeAppliancesPaginator,
ListTagsPaginator,
SearchDevicesPaginator,
SearchProfilesPaginator,
SearchRoomsPaginator,
SearchSkillGroupsPaginator,
SearchUsersPaginator,
)
from mypy_boto3_alexaforbusiness.type_defs import AddressBookDataTypeDef, ...
client: AlexaForBusinessClient = boto3.client("alexaforbusiness")
# 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: AlexaForBusinessClient = session.client("alexaforbusiness")
Paginators annotations
mypy_boto3_alexaforbusiness.paginator
module contains type annotations for all paginators.
client: AlexaForBusinessClient = boto3.client("alexaforbusiness")
# Explicit type annotations are optional here
# Type should be correctly discovered by mypy and IDEs
# VSCode requires explicit type annotations
list_business_report_schedules_paginator: ListBusinessReportSchedulesPaginator = client.get_paginator("list_business_report_schedules")
list_conference_providers_paginator: ListConferenceProvidersPaginator = client.get_paginator("list_conference_providers")
list_device_events_paginator: ListDeviceEventsPaginator = client.get_paginator("list_device_events")
list_skills_paginator: ListSkillsPaginator = client.get_paginator("list_skills")
list_skills_store_categories_paginator: ListSkillsStoreCategoriesPaginator = client.get_paginator("list_skills_store_categories")
list_skills_store_skills_by_category_paginator: ListSkillsStoreSkillsByCategoryPaginator = client.get_paginator("list_skills_store_skills_by_category")
list_smart_home_appliances_paginator: ListSmartHomeAppliancesPaginator = client.get_paginator("list_smart_home_appliances")
list_tags_paginator: ListTagsPaginator = client.get_paginator("list_tags")
search_devices_paginator: SearchDevicesPaginator = client.get_paginator("search_devices")
search_profiles_paginator: SearchProfilesPaginator = client.get_paginator("search_profiles")
search_rooms_paginator: SearchRoomsPaginator = client.get_paginator("search_rooms")
search_skill_groups_paginator: SearchSkillGroupsPaginator = client.get_paginator("search_skill_groups")
search_users_paginator: SearchUsersPaginator = client.get_paginator("search_users")
Typed dictionations
mypy_boto3_alexaforbusiness.type_defs
module contains structures and shapes assembled
to typed dictionaries for additional type checking.
def get_structure() -> AddressBookDataTypeDef:
return {
...
}
Dynamic type annotations
mypy_boto3
command generates boto3.client/resource
type annotations for
mypy_boto3_alexaforbusiness
and other installed services.
# Run this command after you add or remove service packages
python -m mypy_boto3
Generated type annotations provide overloads for boto3.client
and boto3.resource
,
boto3.Session.client
and boto3.Session.resource
functions,
so explicit type annotations are not needed.
mypy
supports function overloads as expectedPyCharm
also supports function overloads, but consumes a lot of RAM, use carefully if you have many services installedVSCode
does not currently support function overloads, use explicit type annotations
# Type is discovered correctly by mypy and PyCharm
# VSCode still needs explicit type annotations
client = boto3.client("alexaforbusiness")
session_client = boto3.Session().client("alexaforbusiness")
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
Built Distribution
Hashes for mypy-boto3-alexaforbusiness-1.14.0.2.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 35e9ae3fa91961f54452b3f72e724bc1f68a461540265e444091b234668e7096 |
|
MD5 | 97ef886de0bbadb8c0e76c7e7223c163 |
|
BLAKE2b-256 | b436722a8abf87388e191a82bda17e935f3afe5d8e1c57c5cb2bd87e273bdda9 |
Hashes for mypy_boto3_alexaforbusiness-1.14.0.2-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 3fc72cb3bd0057df422f4a1e618f23f7b846f83a88c3dc91e772d36ce8839a89 |
|
MD5 | 80ea632f7c7518457bba4717330f3a7a |
|
BLAKE2b-256 | c767f7250e34b6fc3bc07663066f7a1d69b9f919f4acc25f0e61e20f8d359b90 |