# mypy-boto3-pinpoint-sms-voice<a id="mypy-boto3-pinpoint-sms-voice"></a>
[![PyPI - mypy-boto3-pinpoint-sms-voice](https://img.shields.io/pypi/v/mypy-boto3-pinpoint-sms-voice.svg?color=blue)](https://pypi.org/project/mypy-boto3-pinpoint-sms-voice)
[![PyPI - Python Version](https://img.shields.io/pypi/pyversions/mypy-boto3-pinpoint-sms-voice.svg?color=blue)](https://pypi.org/project/mypy-boto3-pinpoint-sms-voice)
[![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-pinpoint-sms-voice?color=blue)](https://pypistats.org/packages/mypy-boto3-pinpoint-sms-voice)
![boto3.typed](https://github.com/vemel/mypy_boto3_builder/raw/master/logo.png)
Type annotations for
[boto3.PinpointSMSVoice 1.17.74](https://boto3.amazonaws.com/v1/documentation/api/1.17.74/reference/services/pinpoint-sms-voice.html#PinpointSMSVoice)
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-buider 4.13.1](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-pinpoint-sms-voice docs](https://vemel.github.io/boto3_stubs_docs/mypy_boto3_pinpoint_sms_voice/)
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-pinpoint-sms-voice](#mypy-boto3-pinpoint-sms-voice)
- [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)
- [Literals](#literals)
- [Typed dictionaries](#typed-dictionaries)
- [Versioning](#versioning)
- [Documentation](#documentation)
- [Support and contributing](#support-and-contributing)
## How to install<a id="how-to-install"></a>
Install `boto3-stubs` for `PinpointSMSVoice` service.
```bash
python -m pip install boto3-stubs[pinpoint-sms-voice]
```
## Usage<a id="usage"></a>
### VSCode<a id="vscode"></a>
- 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[pinpoint-sms-voice]` in your environment:
`python -m pip install 'boto3-stubs[pinpoint-sms-voice]'`
Both type checking and auto-complete should work for `PinpointSMSVoice`
service. No explicit type annotations required, write your `boto3` code as
usual.
### PyCharm<a id="pycharm"></a>
- Install `boto-stubs[pinpoint-sms-voice]` in your environment:
`python -m pip install 'boto3-stubs[pinpoint-sms-voice]'`
Both type checking and auto-complete should work for `PinpointSMSVoice`
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<a id="other-ides"></a>
Not tested, but as long as your IDE support `mypy` or `pyright`, everything
should work.
### mypy<a id="mypy"></a>
- Install `mypy`: `python -m pip install mypy`
- Install `boto-stubs[pinpoint-sms-voice]` in your environment:
`python -m pip install 'boto3-stubs[pinpoint-sms-voice]'`
- Run `mypy` as usual
Type checking should work for `PinpointSMSVoice` service. No explicit type
annotations required, write your `boto3` code as usual.
### pyright<a id="pyright"></a>
- Install `pyright`: `yarn global add pyright`
- Install `boto-stubs[pinpoint-sms-voice]` in your environment:
`python -m pip install 'boto3-stubs[pinpoint-sms-voice]'`
- Optionally, you can install `boto3-stubs` to `typings` folder.
Type checking should work for `PinpointSMSVoice` service. No explicit type
annotations required, write your `boto3` code as usual.
## Explicit type annotations<a id="explicit-type-annotations"></a>
### Client annotations<a id="client-annotations"></a>
`PinpointSMSVoiceClient` provides annotations for
`boto3.client("pinpoint-sms-voice")`.
```python
import boto3
from mypy_boto3_pinpoint_sms_voice import PinpointSMSVoiceClient
client: PinpointSMSVoiceClient = boto3.client("pinpoint-sms-voice")
# 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: PinpointSMSVoiceClient = session.client("pinpoint-sms-voice")
```
### Literals<a id="literals"></a>
`mypy_boto3_pinpoint_sms_voice.literals` module contains literals extracted
from shapes that can be used in user code for type checking.
```python
from mypy_boto3_pinpoint_sms_voice.literals import (
EventTypeType,
)
def check_value(value: EventTypeType) -> bool:
...
```
### Typed dictionaries<a id="typed-dictionaries"></a>
`mypy_boto3_pinpoint_sms_voice.type_defs` module contains structures and shapes
assembled to typed dictionaries for additional type checking.
```python
from mypy_boto3_pinpoint_sms_voice.type_defs import (
CallInstructionsMessageTypeTypeDef,
CloudWatchLogsDestinationTypeDef,
EventDestinationDefinitionTypeDef,
EventDestinationTypeDef,
GetConfigurationSetEventDestinationsResponseTypeDef,
KinesisFirehoseDestinationTypeDef,
PlainTextMessageTypeTypeDef,
SSMLMessageTypeTypeDef,
SendVoiceMessageResponseTypeDef,
SnsDestinationTypeDef,
VoiceMessageContentTypeDef,
)
def get_structure() -> CallInstructionsMessageTypeTypeDef:
return {
...
}
```
## Versioning<a id="versioning"></a>
`mypy-boto3-pinpoint-sms-voice` version is the same as related `boto3` version
and follows [PEP 440](https://www.python.org/dev/peps/pep-0440/) format.
## Documentation<a id="documentation"></a>
All type annotations can be found in
[mypy-boto3-pinpoint-sms-voice docs](https://vemel.github.io/boto3_stubs_docs/mypy_boto3_pinpoint_sms_voice/)
## Support and contributing<a id="support-and-contributing"></a>
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.