Metadata-Version: 2.1
Name: mypy-boto3-alexaforbusiness
Version: 1.19.2
Summary: Type annotations for boto3.AlexaForBusiness 1.19.2 service, generated by mypy-boto3-builder 6.0.2
Home-page: https://github.com/vemel/mypy_boto3_builder
Author: Vlad Emelianov
Author-email: vlad.emelianov.nz@gmail.com
License: MIT License
Project-URL: Documentation, https://mypy-boto3-builder.readthedocs.io/en/latest/
Project-URL: Source, https://github.com/vemel/mypy_boto3_builder
Project-URL: Tracker, https://github.com/vemel/mypy_boto3_builder/issues
Keywords: boto3 alexaforbusiness type-annotations boto3-stubs mypy typeshed autocomplete
Platform: UNKNOWN
Classifier: Development Status :: 5 - Production/Stable
Classifier: Intended Audience :: Developers
Classifier: Environment :: Console
Classifier: License :: OSI Approved :: MIT License
Classifier: Natural Language :: English
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.6
Classifier: Programming Language :: Python :: 3.7
Classifier: Programming Language :: Python :: 3.8
Classifier: Programming Language :: Python :: 3.9
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3 :: Only
Classifier: Programming Language :: Python :: Implementation :: CPython
Classifier: Typing :: Typed
Requires-Python: >=3.6
Description-Content-Type: text/markdown

<a id="mypy-boto3-alexaforbusiness"></a>

# mypy-boto3-alexaforbusiness

[![PyPI - mypy-boto3-alexaforbusiness](https://img.shields.io/pypi/v/mypy-boto3-alexaforbusiness.svg?color=blue)](https://pypi.org/project/mypy-boto3-alexaforbusiness)
[![PyPI - Python Version](https://img.shields.io/pypi/pyversions/mypy-boto3-alexaforbusiness.svg?color=blue)](https://pypi.org/project/mypy-boto3-alexaforbusiness)
[![Docs](https://img.shields.io/readthedocs/mypy-boto3-builder.svg?color=blue)](https://mypy-boto3-builder.readthedocs.io/)
[![PyPI - Downloads](https://img.shields.io/pypi/dw/mypy-boto3-alexaforbusiness?color=blue)](https://pypistats.org/packages/mypy-boto3-alexaforbusiness)

![boto3.typed](https://github.com/vemel/mypy_boto3_builder/raw/master/logo.png)

Type annotations for
[boto3.AlexaForBusiness 1.19.2](https://boto3.amazonaws.com/v1/documentation/api/1.19.2/reference/services/alexaforbusiness.html#AlexaForBusiness)
service compatible with [VSCode](https://code.visualstudio.com/),
[PyCharm](https://www.jetbrains.com/pycharm/),
[Emacs](https://www.gnu.org/software/emacs/),
[Sublime Text](https://www.sublimetext.com/),
[mypy](https://github.com/python/mypy),
[pyright](https://github.com/microsoft/pyright) and other tools.

Generated by
[mypy-boto3-builder 6.0.2](https://github.com/vemel/mypy_boto3_builder).

More information can be found on
[boto3-stubs](https://pypi.org/project/boto3-stubs/) page and in
[mypy-boto3-alexaforbusiness docs](https://vemel.github.io/boto3_stubs_docs/mypy_boto3_alexaforbusiness/)

See how it helps to find and fix potential bugs:

![boto3-stubs demo](https://github.com/vemel/mypy_boto3_builder/raw/master/demo.gif)

- [mypy-boto3-alexaforbusiness](#mypy-boto3-alexaforbusiness)
  - [How to install](#how-to-install)
  - [Usage](#usage)
    - [VSCode](#vscode)
    - [PyCharm](#pycharm)
    - [Other IDEs](#other-ides)
    - [mypy](#mypy)
    - [pyright](#pyright)
  - [Explicit type annotations](#explicit-type-annotations)
    - [Client annotations](#client-annotations)
    - [Paginators annotations](#paginators-annotations)
    - [Literals](#literals)
    - [Typed dictionaries](#typed-dictionaries)
  - [Versioning](#versioning)
  - [Documentation](#documentation)
  - [Support and contributing](#support-and-contributing)

<a id="how-to-install"></a>

## How to install

Install `boto3-stubs` for `AlexaForBusiness` service.

```bash
python -m pip install boto3-stubs[alexaforbusiness]
```

<a id="usage"></a>

## Usage

<a id="vscode"></a>

### VSCode

- Install
  [Python extension](https://marketplace.visualstudio.com/items?itemName=ms-python.python)
- Install
  [Pylance extension](https://marketplace.visualstudio.com/items?itemName=ms-python.vscode-pylance)
- Set `Pylance` as your Python Language Server
- Install `boto-stubs[alexaforbusiness]` in your environment:
  `python -m pip install 'boto3-stubs[alexaforbusiness]'`

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

<a id="pycharm"></a>

### PyCharm

- Install `boto-stubs[alexaforbusiness]` in your environment:
  `python -m pip install 'boto3-stubs[alexaforbusiness]'`

Both type checking and auto-complete should work for `AlexaForBusiness`
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.

<a id="other-ides"></a>

### Other IDEs

Not tested, but as long as your IDE supports `mypy` or `pyright`, everything
should work.

<a id="mypy"></a>

### mypy

- Install `mypy`: `python -m pip install mypy`
- Install `boto-stubs[alexaforbusiness]` in your environment:
  `python -m pip install 'boto3-stubs[alexaforbusiness]'`
- Run `mypy` as usual

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

<a id="pyright"></a>

### pyright

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

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

<a id="explicit-type-annotations"></a>

## Explicit type annotations

<a id="client-annotations"></a>

### Client annotations

`AlexaForBusinessClient` provides annotations for
`boto3.client("alexaforbusiness")`.

```python
import boto3

from mypy_boto3_alexaforbusiness import AlexaForBusinessClient

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")
```

<a id="paginators-annotations"></a>

### Paginators annotations

`mypy_boto3_alexaforbusiness.paginator` module contains type annotations for
all paginators.

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

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")
```

<a id="literals"></a>

### Literals

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

```python
from mypy_boto3_alexaforbusiness.literals import (
    BusinessReportFailureCodeType,
    BusinessReportFormatType,
    BusinessReportIntervalType,
    BusinessReportStatusType,
    CommsProtocolType,
    ConferenceProviderTypeType,
    ConnectionStatusType,
    DeviceEventTypeType,
    DeviceStatusDetailCodeType,
    DeviceStatusType,
    DeviceUsageTypeType,
    DistanceUnitType,
    EnablementTypeFilterType,
    EnablementTypeType,
    EndOfMeetingReminderTypeType,
    EnrollmentStatusType,
    FeatureType,
    ListBusinessReportSchedulesPaginatorName,
    ListConferenceProvidersPaginatorName,
    ListDeviceEventsPaginatorName,
    ListSkillsPaginatorName,
    ListSkillsStoreCategoriesPaginatorName,
    ListSkillsStoreSkillsByCategoryPaginatorName,
    ListSmartHomeAppliancesPaginatorName,
    ListTagsPaginatorName,
    LocaleType,
    NetworkEapMethodType,
    NetworkSecurityTypeType,
    PhoneNumberTypeType,
    RequirePinType,
    SearchDevicesPaginatorName,
    SearchProfilesPaginatorName,
    SearchRoomsPaginatorName,
    SearchSkillGroupsPaginatorName,
    SearchUsersPaginatorName,
    SipTypeType,
    SkillTypeFilterType,
    SkillTypeType,
    SortValueType,
    TemperatureUnitType,
    WakeWordType,
    ServiceName,
    PaginatorName,
)

def check_value(value: BusinessReportFailureCodeType) -> bool:
    ...
```

<a id="typed-dictionaries"></a>

### Typed dictionaries

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

```python
from mypy_boto3_alexaforbusiness.type_defs import (
    AddressBookDataTypeDef,
    AddressBookTypeDef,
    ApproveSkillRequestRequestTypeDef,
    AssociateContactWithAddressBookRequestRequestTypeDef,
    AssociateDeviceWithNetworkProfileRequestRequestTypeDef,
    AssociateDeviceWithRoomRequestRequestTypeDef,
    AssociateSkillGroupWithRoomRequestRequestTypeDef,
    AssociateSkillWithSkillGroupRequestRequestTypeDef,
    AssociateSkillWithUsersRequestRequestTypeDef,
    AudioTypeDef,
    BusinessReportContentRangeTypeDef,
    BusinessReportRecurrenceTypeDef,
    BusinessReportS3LocationTypeDef,
    BusinessReportScheduleTypeDef,
    BusinessReportTypeDef,
    CategoryTypeDef,
    ConferencePreferenceTypeDef,
    ConferenceProviderTypeDef,
    ContactDataTypeDef,
    ContactTypeDef,
    ContentTypeDef,
    CreateAddressBookRequestRequestTypeDef,
    CreateAddressBookResponseTypeDef,
    CreateBusinessReportScheduleRequestRequestTypeDef,
    CreateBusinessReportScheduleResponseTypeDef,
    CreateConferenceProviderRequestRequestTypeDef,
    CreateConferenceProviderResponseTypeDef,
    CreateContactRequestRequestTypeDef,
    CreateContactResponseTypeDef,
    CreateEndOfMeetingReminderTypeDef,
    CreateGatewayGroupRequestRequestTypeDef,
    CreateGatewayGroupResponseTypeDef,
    CreateInstantBookingTypeDef,
    CreateMeetingRoomConfigurationTypeDef,
    CreateNetworkProfileRequestRequestTypeDef,
    CreateNetworkProfileResponseTypeDef,
    CreateProfileRequestRequestTypeDef,
    CreateProfileResponseTypeDef,
    CreateRequireCheckInTypeDef,
    CreateRoomRequestRequestTypeDef,
    CreateRoomResponseTypeDef,
    CreateSkillGroupRequestRequestTypeDef,
    CreateSkillGroupResponseTypeDef,
    CreateUserRequestRequestTypeDef,
    CreateUserResponseTypeDef,
    DeleteAddressBookRequestRequestTypeDef,
    DeleteBusinessReportScheduleRequestRequestTypeDef,
    DeleteConferenceProviderRequestRequestTypeDef,
    DeleteContactRequestRequestTypeDef,
    DeleteDeviceRequestRequestTypeDef,
    DeleteDeviceUsageDataRequestRequestTypeDef,
    DeleteGatewayGroupRequestRequestTypeDef,
    DeleteNetworkProfileRequestRequestTypeDef,
    DeleteProfileRequestRequestTypeDef,
    DeleteRoomRequestRequestTypeDef,
    DeleteRoomSkillParameterRequestRequestTypeDef,
    DeleteSkillAuthorizationRequestRequestTypeDef,
    DeleteSkillGroupRequestRequestTypeDef,
    DeleteUserRequestRequestTypeDef,
    DeveloperInfoTypeDef,
    DeviceDataTypeDef,
    DeviceEventTypeDef,
    DeviceNetworkProfileInfoTypeDef,
    DeviceStatusDetailTypeDef,
    DeviceStatusInfoTypeDef,
    DeviceTypeDef,
    DisassociateContactFromAddressBookRequestRequestTypeDef,
    DisassociateDeviceFromRoomRequestRequestTypeDef,
    DisassociateSkillFromSkillGroupRequestRequestTypeDef,
    DisassociateSkillFromUsersRequestRequestTypeDef,
    DisassociateSkillGroupFromRoomRequestRequestTypeDef,
    EndOfMeetingReminderTypeDef,
    FilterTypeDef,
    ForgetSmartHomeAppliancesRequestRequestTypeDef,
    GatewayGroupSummaryTypeDef,
    GatewayGroupTypeDef,
    GatewaySummaryTypeDef,
    GatewayTypeDef,
    GetAddressBookRequestRequestTypeDef,
    GetAddressBookResponseTypeDef,
    GetConferencePreferenceResponseTypeDef,
    GetConferenceProviderRequestRequestTypeDef,
    GetConferenceProviderResponseTypeDef,
    GetContactRequestRequestTypeDef,
    GetContactResponseTypeDef,
    GetDeviceRequestRequestTypeDef,
    GetDeviceResponseTypeDef,
    GetGatewayGroupRequestRequestTypeDef,
    GetGatewayGroupResponseTypeDef,
    GetGatewayRequestRequestTypeDef,
    GetGatewayResponseTypeDef,
    GetInvitationConfigurationResponseTypeDef,
    GetNetworkProfileRequestRequestTypeDef,
    GetNetworkProfileResponseTypeDef,
    GetProfileRequestRequestTypeDef,
    GetProfileResponseTypeDef,
    GetRoomRequestRequestTypeDef,
    GetRoomResponseTypeDef,
    GetRoomSkillParameterRequestRequestTypeDef,
    GetRoomSkillParameterResponseTypeDef,
    GetSkillGroupRequestRequestTypeDef,
    GetSkillGroupResponseTypeDef,
    IPDialInTypeDef,
    InstantBookingTypeDef,
    ListBusinessReportSchedulesRequestRequestTypeDef,
    ListBusinessReportSchedulesResponseTypeDef,
    ListConferenceProvidersRequestRequestTypeDef,
    ListConferenceProvidersResponseTypeDef,
    ListDeviceEventsRequestRequestTypeDef,
    ListDeviceEventsResponseTypeDef,
    ListGatewayGroupsRequestRequestTypeDef,
    ListGatewayGroupsResponseTypeDef,
    ListGatewaysRequestRequestTypeDef,
    ListGatewaysResponseTypeDef,
    ListSkillsRequestRequestTypeDef,
    ListSkillsResponseTypeDef,
    ListSkillsStoreCategoriesRequestRequestTypeDef,
    ListSkillsStoreCategoriesResponseTypeDef,
    ListSkillsStoreSkillsByCategoryRequestRequestTypeDef,
    ListSkillsStoreSkillsByCategoryResponseTypeDef,
    ListSmartHomeAppliancesRequestRequestTypeDef,
    ListSmartHomeAppliancesResponseTypeDef,
    ListTagsRequestRequestTypeDef,
    ListTagsResponseTypeDef,
    MeetingRoomConfigurationTypeDef,
    MeetingSettingTypeDef,
    NetworkProfileDataTypeDef,
    NetworkProfileTypeDef,
    PSTNDialInTypeDef,
    PaginatorConfigTypeDef,
    PhoneNumberTypeDef,
    ProfileDataTypeDef,
    ProfileTypeDef,
    PutConferencePreferenceRequestRequestTypeDef,
    PutInvitationConfigurationRequestRequestTypeDef,
    PutRoomSkillParameterRequestRequestTypeDef,
    PutSkillAuthorizationRequestRequestTypeDef,
    RegisterAVSDeviceRequestRequestTypeDef,
    RegisterAVSDeviceResponseTypeDef,
    RejectSkillRequestRequestTypeDef,
    RequireCheckInTypeDef,
    ResolveRoomRequestRequestTypeDef,
    ResolveRoomResponseTypeDef,
    ResponseMetadataTypeDef,
    RevokeInvitationRequestRequestTypeDef,
    RoomDataTypeDef,
    RoomSkillParameterTypeDef,
    RoomTypeDef,
    SearchAddressBooksRequestRequestTypeDef,
    SearchAddressBooksResponseTypeDef,
    SearchContactsRequestRequestTypeDef,
    SearchContactsResponseTypeDef,
    SearchDevicesRequestRequestTypeDef,
    SearchDevicesResponseTypeDef,
    SearchNetworkProfilesRequestRequestTypeDef,
    SearchNetworkProfilesResponseTypeDef,
    SearchProfilesRequestRequestTypeDef,
    SearchProfilesResponseTypeDef,
    SearchRoomsRequestRequestTypeDef,
    SearchRoomsResponseTypeDef,
    SearchSkillGroupsRequestRequestTypeDef,
    SearchSkillGroupsResponseTypeDef,
    SearchUsersRequestRequestTypeDef,
    SearchUsersResponseTypeDef,
    SendAnnouncementRequestRequestTypeDef,
    SendAnnouncementResponseTypeDef,
    SendInvitationRequestRequestTypeDef,
    SipAddressTypeDef,
    SkillDetailsTypeDef,
    SkillGroupDataTypeDef,
    SkillGroupTypeDef,
    SkillSummaryTypeDef,
    SkillsStoreSkillTypeDef,
    SmartHomeApplianceTypeDef,
    SortTypeDef,
    SsmlTypeDef,
    StartDeviceSyncRequestRequestTypeDef,
    StartSmartHomeApplianceDiscoveryRequestRequestTypeDef,
    TagResourceRequestRequestTypeDef,
    TagTypeDef,
    TextTypeDef,
    UntagResourceRequestRequestTypeDef,
    UpdateAddressBookRequestRequestTypeDef,
    UpdateBusinessReportScheduleRequestRequestTypeDef,
    UpdateConferenceProviderRequestRequestTypeDef,
    UpdateContactRequestRequestTypeDef,
    UpdateDeviceRequestRequestTypeDef,
    UpdateEndOfMeetingReminderTypeDef,
    UpdateGatewayGroupRequestRequestTypeDef,
    UpdateGatewayRequestRequestTypeDef,
    UpdateInstantBookingTypeDef,
    UpdateMeetingRoomConfigurationTypeDef,
    UpdateNetworkProfileRequestRequestTypeDef,
    UpdateProfileRequestRequestTypeDef,
    UpdateRequireCheckInTypeDef,
    UpdateRoomRequestRequestTypeDef,
    UpdateSkillGroupRequestRequestTypeDef,
    UserDataTypeDef,
)

def get_structure() -> AddressBookDataTypeDef:
    return {
      ...
    }
```

<a id="versioning"></a>

## Versioning

`mypy-boto3-alexaforbusiness` version is the same as related `boto3` version
and follows [PEP 440](https://www.python.org/dev/peps/pep-0440/) format.

<a id="documentation"></a>

## Documentation

All type annotations can be found in
[mypy-boto3-alexaforbusiness docs](https://vemel.github.io/boto3_stubs_docs/mypy_boto3_alexaforbusiness/)

<a id="support-and-contributing"></a>

## Support and contributing

This package is auto-generated. Please reports any bugs or request new features
in [mypy-boto3-builder](https://github.com/vemel/mypy_boto3_builder/issues/)
repository.


