<a id="mypy-boto3-pinpoint-email"></a>
# mypy-boto3-pinpoint-email
[![PyPI - mypy-boto3-pinpoint-email](https://img.shields.io/pypi/v/mypy-boto3-pinpoint-email.svg?color=blue)](https://pypi.org/project/mypy-boto3-pinpoint-email)
[![PyPI - Python Version](https://img.shields.io/pypi/pyversions/mypy-boto3-pinpoint-email.svg?color=blue)](https://pypi.org/project/mypy-boto3-pinpoint-email)
[![Docs](https://img.shields.io/readthedocs/boto3-stubs.svg?color=blue)](https://youtype.github.io/boto3_stubs_docs/mypy_boto3_pinpoint_email/)
[![PyPI - Downloads](https://img.shields.io/pypi/dm/mypy-boto3-pinpoint-email?color=blue)](https://pypistats.org/packages/mypy-boto3-pinpoint-email)
![boto3.typed](https://github.com/youtype/mypy_boto3_builder/raw/main/logo.png)
Type annotations for
[boto3.PinpointEmail 1.27.0](https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/pinpoint-email.html#PinpointEmail)
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 7.14.5](https://github.com/youtype/mypy_boto3_builder).
More information can be found on
[boto3-stubs](https://pypi.org/project/boto3-stubs/) page and in
[mypy-boto3-pinpoint-email docs](https://youtype.github.io/boto3_stubs_docs/mypy_boto3_pinpoint_email/).
See how it helps to find and fix potential bugs:
![boto3-stubs demo](https://github.com/youtype/mypy_boto3_builder/raw/main/demo.gif)
- [mypy-boto3-pinpoint-email](#mypy-boto3-pinpoint-email)
- [How to install](#how-to-install)
- [VSCode extension](#vscode-extension)
- [From PyPI with pip](#from-pypi-with-pip)
- [How to uninstall](#how-to-uninstall)
- [Usage](#usage)
- [VSCode](#vscode)
- [PyCharm](#pycharm)
- [Emacs](#emacs)
- [Sublime Text](#sublime-text)
- [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)
- [How it works](#how-it-works)
- [What's new](#what's-new)
- [Implemented features](#implemented-features)
- [Latest changes](#latest-changes)
- [Versioning](#versioning)
- [Thank you](#thank-you)
- [Documentation](#documentation)
- [Support and contributing](#support-and-contributing)
<a id="how-to-install"></a>
## How to install
<a id="vscode-extension"></a>
### VSCode extension
Add
[AWS Boto3](https://marketplace.visualstudio.com/items?itemName=Boto3typed.boto3-ide)
extension to your VSCode and run `AWS boto3: Quick Start` command.
Click `Modify` and select `boto3 common` and `PinpointEmail`.
<a id="from-pypi-with-pip"></a>
### From PyPI with pip
Install `boto3-stubs` for `PinpointEmail` service.
```bash
# install with boto3 type annotations
python -m pip install 'boto3-stubs[pinpoint-email]'
# Lite version does not provide session.client/resource overloads
# it is more RAM-friendly, but requires explicit type annotations
python -m pip install 'boto3-stubs-lite[pinpoint-email]'
# standalone installation
python -m pip install mypy-boto3-pinpoint-email
```
<a id="how-to-uninstall"></a>
## How to uninstall
```bash
python -m pip uninstall -y mypy-boto3-pinpoint-email
```
<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 `boto3-stubs[pinpoint-email]` in your environment:
```bash
python -m pip install 'boto3-stubs[pinpoint-email]'
```
Both type checking and code completion should now work. No explicit type
annotations required, write your `boto3` code as usual.
<a id="pycharm"></a>
### PyCharm
Install `boto3-stubs-lite[pinpoint-email]` in your environment:
```bash
python -m pip install 'boto3-stubs-lite[pinpoint-email]'`
```
Both type checking and code completion should now work. Explicit type
annotations **are required**.
Use `boto3-stubs` package instead for implicit type discovery.
<a id="emacs"></a>
### Emacs
- Install `boto3-stubs` with services you use in your environment:
```bash
python -m pip install 'boto3-stubs[pinpoint-email]'
```
- Install [use-package](https://github.com/jwiegley/use-package),
[lsp](https://github.com/emacs-lsp/lsp-mode/),
[company](https://github.com/company-mode/company-mode) and
[flycheck](https://github.com/flycheck/flycheck) packages
- Install [lsp-pyright](https://github.com/emacs-lsp/lsp-pyright) package
```elisp
(use-package lsp-pyright
:ensure t
:hook (python-mode . (lambda ()
(require 'lsp-pyright)
(lsp))) ; or lsp-deferred
:init (when (executable-find "python3")
(setq lsp-pyright-python-executable-cmd "python3"))
)
```
- Make sure emacs uses the environment where you have installed `boto3-stubs`
Type checking should now work. No explicit type annotations required, write
your `boto3` code as usual.
<a id="sublime-text"></a>
### Sublime Text
- Install `boto3-stubs[pinpoint-email]` with services you use in your
environment:
```bash
python -m pip install 'boto3-stubs[pinpoint-email]'
```
- Install [LSP-pyright](https://github.com/sublimelsp/LSP-pyright) package
Type checking should now work. No explicit type annotations required, write
your `boto3` code as usual.
<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 `boto3-stubs[pinpoint-email]` in your environment:
```bash
python -m pip install 'boto3-stubs[pinpoint-email]'`
```
Type checking should now work. No explicit type annotations required, write
your `boto3` code as usual.
<a id="pyright"></a>
### pyright
- Install `pyright`: `npm i -g pyright`
- Install `boto3-stubs[pinpoint-email]` in your environment:
```bash
python -m pip install 'boto3-stubs[pinpoint-email]'
```
Optionally, you can install `boto3-stubs` to `typings` folder.
Type checking should now work. 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
`PinpointEmailClient` provides annotations for
`boto3.client("pinpoint-email")`.
```python
from boto3.session import Session
from mypy_boto3_pinpoint_email import PinpointEmailClient
client: PinpointEmailClient = Session().client("pinpoint-email")
# now client usage is checked by mypy and IDE should provide code completion
```
<a id="paginators-annotations"></a>
### Paginators annotations
`mypy_boto3_pinpoint_email.paginator` module contains type annotations for all
paginators.
```python
from boto3.session import Session
from mypy_boto3_pinpoint_email import PinpointEmailClient
from mypy_boto3_pinpoint_email.paginator import (
GetDedicatedIpsPaginator,
ListConfigurationSetsPaginator,
ListDedicatedIpPoolsPaginator,
ListDeliverabilityTestReportsPaginator,
ListEmailIdentitiesPaginator,
)
client: PinpointEmailClient = Session().client("pinpoint-email")
# Explicit type annotations are optional here
# Types should be correctly discovered by mypy and IDEs
get_dedicated_ips_paginator: GetDedicatedIpsPaginator = client.get_paginator("get_dedicated_ips")
list_configuration_sets_paginator: ListConfigurationSetsPaginator = client.get_paginator(
"list_configuration_sets"
)
list_dedicated_ip_pools_paginator: ListDedicatedIpPoolsPaginator = client.get_paginator(
"list_dedicated_ip_pools"
)
list_deliverability_test_reports_paginator: ListDeliverabilityTestReportsPaginator = (
client.get_paginator("list_deliverability_test_reports")
)
list_email_identities_paginator: ListEmailIdentitiesPaginator = client.get_paginator(
"list_email_identities"
)
```
<a id="literals"></a>
### Literals
`mypy_boto3_pinpoint_email.literals` module contains literals extracted from
shapes that can be used in user code for type checking.
```python
from mypy_boto3_pinpoint_email.literals import (
BehaviorOnMxFailureType,
DeliverabilityDashboardAccountStatusType,
DeliverabilityTestStatusType,
DimensionValueSourceType,
DkimStatusType,
EventTypeType,
GetDedicatedIpsPaginatorName,
IdentityTypeType,
ListConfigurationSetsPaginatorName,
ListDedicatedIpPoolsPaginatorName,
ListDeliverabilityTestReportsPaginatorName,
ListEmailIdentitiesPaginatorName,
MailFromDomainStatusType,
TlsPolicyType,
WarmupStatusType,
PinpointEmailServiceName,
ServiceName,
ResourceServiceName,
PaginatorName,
RegionName,
)
def check_value(value: BehaviorOnMxFailureType) -> bool:
...
```
<a id="typed-dictionaries"></a>
### Typed dictionaries
`mypy_boto3_pinpoint_email.type_defs` module contains structures and shapes
assembled to typed dictionaries for additional type checking.
```python
from mypy_boto3_pinpoint_email.type_defs import (
BlacklistEntryTypeDef,
ContentTypeDef,
CloudWatchDimensionConfigurationTypeDef,
DeliveryOptionsTypeDef,
ReputationOptionsTypeDef,
SendingOptionsTypeDef,
TagTypeDef,
TrackingOptionsTypeDef,
CreateDeliverabilityTestReportResponseTypeDef,
DkimAttributesTypeDef,
DomainIspPlacementTypeDef,
VolumeStatisticsTypeDef,
DedicatedIpTypeDef,
DeleteConfigurationSetEventDestinationRequestRequestTypeDef,
DeleteConfigurationSetRequestRequestTypeDef,
DeleteDedicatedIpPoolRequestRequestTypeDef,
DeleteEmailIdentityRequestRequestTypeDef,
DeliverabilityTestReportTypeDef,
DestinationTypeDef,
DomainDeliverabilityCampaignTypeDef,
InboxPlacementTrackingOptionTypeDef,
RawMessageTypeDef,
TemplateTypeDef,
KinesisFirehoseDestinationTypeDef,
PinpointDestinationTypeDef,
SnsDestinationTypeDef,
SendQuotaTypeDef,
GetBlacklistReportsRequestRequestTypeDef,
GetConfigurationSetEventDestinationsRequestRequestTypeDef,
GetConfigurationSetRequestRequestTypeDef,
GetDedicatedIpRequestRequestTypeDef,
GetDedicatedIpsRequestGetDedicatedIpsPaginateTypeDef,
GetDedicatedIpsRequestRequestTypeDef,
GetDeliverabilityTestReportRequestRequestTypeDef,
PlacementStatisticsTypeDef,
GetDomainDeliverabilityCampaignRequestRequestTypeDef,
GetDomainStatisticsReportRequestRequestTypeDef,
GetEmailIdentityRequestRequestTypeDef,
MailFromAttributesTypeDef,
IdentityInfoTypeDef,
ListConfigurationSetsRequestListConfigurationSetsPaginateTypeDef,
ListConfigurationSetsRequestRequestTypeDef,
ListConfigurationSetsResponseTypeDef,
ListDedicatedIpPoolsRequestListDedicatedIpPoolsPaginateTypeDef,
ListDedicatedIpPoolsRequestRequestTypeDef,
ListDedicatedIpPoolsResponseTypeDef,
ListDeliverabilityTestReportsRequestListDeliverabilityTestReportsPaginateTypeDef,
ListDeliverabilityTestReportsRequestRequestTypeDef,
ListDomainDeliverabilityCampaignsRequestRequestTypeDef,
ListEmailIdentitiesRequestListEmailIdentitiesPaginateTypeDef,
ListEmailIdentitiesRequestRequestTypeDef,
ListTagsForResourceRequestRequestTypeDef,
MessageTagTypeDef,
PaginatorConfigTypeDef,
PutAccountDedicatedIpWarmupAttributesRequestRequestTypeDef,
PutAccountSendingAttributesRequestRequestTypeDef,
PutConfigurationSetDeliveryOptionsRequestRequestTypeDef,
PutConfigurationSetReputationOptionsRequestRequestTypeDef,
PutConfigurationSetSendingOptionsRequestRequestTypeDef,
PutConfigurationSetTrackingOptionsRequestRequestTypeDef,
PutDedicatedIpInPoolRequestRequestTypeDef,
PutDedicatedIpWarmupAttributesRequestRequestTypeDef,
PutEmailIdentityDkimAttributesRequestRequestTypeDef,
PutEmailIdentityFeedbackAttributesRequestRequestTypeDef,
PutEmailIdentityMailFromAttributesRequestRequestTypeDef,
ResponseMetadataTypeDef,
SendEmailResponseTypeDef,
UntagResourceRequestRequestTypeDef,
GetBlacklistReportsResponseTypeDef,
BodyTypeDef,
CloudWatchDestinationTypeDef,
CreateDedicatedIpPoolRequestRequestTypeDef,
CreateEmailIdentityRequestRequestTypeDef,
ListTagsForResourceResponseTypeDef,
TagResourceRequestRequestTypeDef,
CreateConfigurationSetRequestRequestTypeDef,
GetConfigurationSetResponseTypeDef,
CreateEmailIdentityResponseTypeDef,
DailyVolumeTypeDef,
OverallVolumeTypeDef,
GetDedicatedIpResponseTypeDef,
GetDedicatedIpsResponseTypeDef,
ListDeliverabilityTestReportsResponseTypeDef,
GetDomainDeliverabilityCampaignResponseTypeDef,
ListDomainDeliverabilityCampaignsResponseTypeDef,
DomainDeliverabilityTrackingOptionTypeDef,
GetAccountResponseTypeDef,
IspPlacementTypeDef,
GetEmailIdentityResponseTypeDef,
ListEmailIdentitiesResponseTypeDef,
MessageTypeDef,
EventDestinationDefinitionTypeDef,
EventDestinationTypeDef,
GetDomainStatisticsReportResponseTypeDef,
GetDeliverabilityDashboardOptionsResponseTypeDef,
PutDeliverabilityDashboardOptionRequestRequestTypeDef,
GetDeliverabilityTestReportResponseTypeDef,
EmailContentTypeDef,
CreateConfigurationSetEventDestinationRequestRequestTypeDef,
UpdateConfigurationSetEventDestinationRequestRequestTypeDef,
GetConfigurationSetEventDestinationsResponseTypeDef,
CreateDeliverabilityTestReportRequestRequestTypeDef,
SendEmailRequestRequestTypeDef,
)
def get_structure() -> BlacklistEntryTypeDef:
return {...}
```
<a id="how-it-works"></a>
## How it works
Fully automated
[mypy-boto3-builder](https://github.com/youtype/mypy_boto3_builder) carefully
generates type annotations for each service, patiently waiting for `boto3`
updates. It delivers drop-in type annotations for you and makes sure that:
- All available `boto3` services are covered.
- Each public class and method of every `boto3` service gets valid type
annotations extracted from `botocore` schemas.
- Type annotations include up-to-date documentation.
- Link to documentation is provided for every method.
- Code is processed by [black](https://github.com/psf/black) and
[isort](https://github.com/PyCQA/isort) for readability.
<a id="what's-new"></a>
## What's new
<a id="implemented-features"></a>
### Implemented features
- Fully type annotated `boto3`, `botocore`, `aiobotocore` and `aioboto3`
libraries
- `mypy`, `pyright`, `VSCode`, `PyCharm`, `Sublime Text` and `Emacs`
compatibility
- `Client`, `ServiceResource`, `Resource`, `Waiter` `Paginator` type
annotations for each service
- Generated `TypeDefs` for each service
- Generated `Literals` for each service
- Auto discovery of types for `boto3.client` and `boto3.resource` calls
- Auto discovery of types for `session.client` and `session.resource` calls
- Auto discovery of types for `client.get_waiter` and `client.get_paginator`
calls
- Auto discovery of types for `ServiceResource` and `Resource` collections
- Auto discovery of types for `aiobotocore.Session.create_client` calls
<a id="latest-changes"></a>
### Latest changes
Builder changelog can be found in
[Releases](https://github.com/youtype/mypy_boto3_builder/releases).
<a id="versioning"></a>
## Versioning
`mypy-boto3-pinpoint-email` version is the same as related `boto3` version and
follows [PEP 440](https://www.python.org/dev/peps/pep-0440/) format.
<a id="thank-you"></a>
## Thank you
- [Allie Fitter](https://github.com/alliefitter) for
[boto3-type-annotations](https://pypi.org/project/boto3-type-annotations/),
this package is based on top of his work
- [black](https://github.com/psf/black) developers for an awesome formatting
tool
- [Timothy Edmund Crosley](https://github.com/timothycrosley) for
[isort](https://github.com/PyCQA/isort) and how flexible it is
- [mypy](https://github.com/python/mypy) developers for doing all dirty work
for us
- [pyright](https://github.com/microsoft/pyright) team for the new era of typed
Python
<a id="documentation"></a>
## Documentation
All services type annotations can be found in
[boto3 docs](https://youtype.github.io/boto3_stubs_docs/mypy_boto3_pinpoint_email/)
<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/youtype/mypy_boto3_builder/issues/)
repository.
Raw data
{
"_id": null,
"home_page": "https://github.com/youtype/mypy_boto3_builder",
"name": "mypy-boto3-pinpoint-email",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3.7",
"maintainer_email": "",
"keywords": "boto3 pinpoint-email type-annotations boto3-stubs mypy typeshed autocomplete",
"author": "Vlad Emelianov",
"author_email": "vlad.emelianov.nz@gmail.com",
"download_url": "https://files.pythonhosted.org/packages/bf/8f/2b25969b06fb5efad50d650a9ae9c2db9a61d3cf99a735e8444998485250/mypy-boto3-pinpoint-email-1.27.0.tar.gz",
"platform": null,
"description": "<a id=\"mypy-boto3-pinpoint-email\"></a>\n\n# mypy-boto3-pinpoint-email\n\n[![PyPI - mypy-boto3-pinpoint-email](https://img.shields.io/pypi/v/mypy-boto3-pinpoint-email.svg?color=blue)](https://pypi.org/project/mypy-boto3-pinpoint-email)\n[![PyPI - Python Version](https://img.shields.io/pypi/pyversions/mypy-boto3-pinpoint-email.svg?color=blue)](https://pypi.org/project/mypy-boto3-pinpoint-email)\n[![Docs](https://img.shields.io/readthedocs/boto3-stubs.svg?color=blue)](https://youtype.github.io/boto3_stubs_docs/mypy_boto3_pinpoint_email/)\n[![PyPI - Downloads](https://img.shields.io/pypi/dm/mypy-boto3-pinpoint-email?color=blue)](https://pypistats.org/packages/mypy-boto3-pinpoint-email)\n\n![boto3.typed](https://github.com/youtype/mypy_boto3_builder/raw/main/logo.png)\n\nType annotations for\n[boto3.PinpointEmail 1.27.0](https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/pinpoint-email.html#PinpointEmail)\nservice compatible with [VSCode](https://code.visualstudio.com/),\n[PyCharm](https://www.jetbrains.com/pycharm/),\n[Emacs](https://www.gnu.org/software/emacs/),\n[Sublime Text](https://www.sublimetext.com/),\n[mypy](https://github.com/python/mypy),\n[pyright](https://github.com/microsoft/pyright) and other tools.\n\nGenerated by\n[mypy-boto3-builder 7.14.5](https://github.com/youtype/mypy_boto3_builder).\n\nMore information can be found on\n[boto3-stubs](https://pypi.org/project/boto3-stubs/) page and in\n[mypy-boto3-pinpoint-email docs](https://youtype.github.io/boto3_stubs_docs/mypy_boto3_pinpoint_email/).\n\nSee how it helps to find and fix potential bugs:\n\n![boto3-stubs demo](https://github.com/youtype/mypy_boto3_builder/raw/main/demo.gif)\n\n- [mypy-boto3-pinpoint-email](#mypy-boto3-pinpoint-email)\n - [How to install](#how-to-install)\n - [VSCode extension](#vscode-extension)\n - [From PyPI with pip](#from-pypi-with-pip)\n - [How to uninstall](#how-to-uninstall)\n - [Usage](#usage)\n - [VSCode](#vscode)\n - [PyCharm](#pycharm)\n - [Emacs](#emacs)\n - [Sublime Text](#sublime-text)\n - [Other IDEs](#other-ides)\n - [mypy](#mypy)\n - [pyright](#pyright)\n - [Explicit type annotations](#explicit-type-annotations)\n - [Client annotations](#client-annotations)\n - [Paginators annotations](#paginators-annotations)\n - [Literals](#literals)\n - [Typed dictionaries](#typed-dictionaries)\n - [How it works](#how-it-works)\n - [What's new](#what's-new)\n - [Implemented features](#implemented-features)\n - [Latest changes](#latest-changes)\n - [Versioning](#versioning)\n - [Thank you](#thank-you)\n - [Documentation](#documentation)\n - [Support and contributing](#support-and-contributing)\n\n<a id=\"how-to-install\"></a>\n\n## How to install\n\n<a id=\"vscode-extension\"></a>\n\n### VSCode extension\n\nAdd\n[AWS Boto3](https://marketplace.visualstudio.com/items?itemName=Boto3typed.boto3-ide)\nextension to your VSCode and run `AWS boto3: Quick Start` command.\n\nClick `Modify` and select `boto3 common` and `PinpointEmail`.\n\n<a id=\"from-pypi-with-pip\"></a>\n\n### From PyPI with pip\n\nInstall `boto3-stubs` for `PinpointEmail` service.\n\n```bash\n# install with boto3 type annotations\npython -m pip install 'boto3-stubs[pinpoint-email]'\n\n\n# Lite version does not provide session.client/resource overloads\n# it is more RAM-friendly, but requires explicit type annotations\npython -m pip install 'boto3-stubs-lite[pinpoint-email]'\n\n\n# standalone installation\npython -m pip install mypy-boto3-pinpoint-email\n```\n\n<a id=\"how-to-uninstall\"></a>\n\n## How to uninstall\n\n```bash\npython -m pip uninstall -y mypy-boto3-pinpoint-email\n```\n\n<a id=\"usage\"></a>\n\n## Usage\n\n<a id=\"vscode\"></a>\n\n### VSCode\n\n- Install\n [Python extension](https://marketplace.visualstudio.com/items?itemName=ms-python.python)\n- Install\n [Pylance extension](https://marketplace.visualstudio.com/items?itemName=ms-python.vscode-pylance)\n- Set `Pylance` as your Python Language Server\n- Install `boto3-stubs[pinpoint-email]` in your environment:\n\n```bash\npython -m pip install 'boto3-stubs[pinpoint-email]'\n```\n\nBoth type checking and code completion should now work. No explicit type\nannotations required, write your `boto3` code as usual.\n\n<a id=\"pycharm\"></a>\n\n### PyCharm\n\nInstall `boto3-stubs-lite[pinpoint-email]` in your environment:\n\n```bash\npython -m pip install 'boto3-stubs-lite[pinpoint-email]'`\n```\n\nBoth type checking and code completion should now work. Explicit type\nannotations **are required**.\n\nUse `boto3-stubs` package instead for implicit type discovery.\n\n<a id=\"emacs\"></a>\n\n### Emacs\n\n- Install `boto3-stubs` with services you use in your environment:\n\n```bash\npython -m pip install 'boto3-stubs[pinpoint-email]'\n```\n\n- Install [use-package](https://github.com/jwiegley/use-package),\n [lsp](https://github.com/emacs-lsp/lsp-mode/),\n [company](https://github.com/company-mode/company-mode) and\n [flycheck](https://github.com/flycheck/flycheck) packages\n- Install [lsp-pyright](https://github.com/emacs-lsp/lsp-pyright) package\n\n```elisp\n(use-package lsp-pyright\n :ensure t\n :hook (python-mode . (lambda ()\n (require 'lsp-pyright)\n (lsp))) ; or lsp-deferred\n :init (when (executable-find \"python3\")\n (setq lsp-pyright-python-executable-cmd \"python3\"))\n )\n```\n\n- Make sure emacs uses the environment where you have installed `boto3-stubs`\n\nType checking should now work. No explicit type annotations required, write\nyour `boto3` code as usual.\n\n<a id=\"sublime-text\"></a>\n\n### Sublime Text\n\n- Install `boto3-stubs[pinpoint-email]` with services you use in your\n environment:\n\n```bash\npython -m pip install 'boto3-stubs[pinpoint-email]'\n```\n\n- Install [LSP-pyright](https://github.com/sublimelsp/LSP-pyright) package\n\nType checking should now work. No explicit type annotations required, write\nyour `boto3` code as usual.\n\n<a id=\"other-ides\"></a>\n\n### Other IDEs\n\nNot tested, but as long as your IDE supports `mypy` or `pyright`, everything\nshould work.\n\n<a id=\"mypy\"></a>\n\n### mypy\n\n- Install `mypy`: `python -m pip install mypy`\n- Install `boto3-stubs[pinpoint-email]` in your environment:\n\n```bash\npython -m pip install 'boto3-stubs[pinpoint-email]'`\n```\n\nType checking should now work. No explicit type annotations required, write\nyour `boto3` code as usual.\n\n<a id=\"pyright\"></a>\n\n### pyright\n\n- Install `pyright`: `npm i -g pyright`\n- Install `boto3-stubs[pinpoint-email]` in your environment:\n\n```bash\npython -m pip install 'boto3-stubs[pinpoint-email]'\n```\n\nOptionally, you can install `boto3-stubs` to `typings` folder.\n\nType checking should now work. No explicit type annotations required, write\nyour `boto3` code as usual.\n\n<a id=\"explicit-type-annotations\"></a>\n\n## Explicit type annotations\n\n<a id=\"client-annotations\"></a>\n\n### Client annotations\n\n`PinpointEmailClient` provides annotations for\n`boto3.client(\"pinpoint-email\")`.\n\n```python\nfrom boto3.session import Session\n\nfrom mypy_boto3_pinpoint_email import PinpointEmailClient\n\nclient: PinpointEmailClient = Session().client(\"pinpoint-email\")\n\n# now client usage is checked by mypy and IDE should provide code completion\n```\n\n<a id=\"paginators-annotations\"></a>\n\n### Paginators annotations\n\n`mypy_boto3_pinpoint_email.paginator` module contains type annotations for all\npaginators.\n\n```python\nfrom boto3.session import Session\n\nfrom mypy_boto3_pinpoint_email import PinpointEmailClient\nfrom mypy_boto3_pinpoint_email.paginator import (\n GetDedicatedIpsPaginator,\n ListConfigurationSetsPaginator,\n ListDedicatedIpPoolsPaginator,\n ListDeliverabilityTestReportsPaginator,\n ListEmailIdentitiesPaginator,\n)\n\nclient: PinpointEmailClient = Session().client(\"pinpoint-email\")\n\n# Explicit type annotations are optional here\n# Types should be correctly discovered by mypy and IDEs\nget_dedicated_ips_paginator: GetDedicatedIpsPaginator = client.get_paginator(\"get_dedicated_ips\")\nlist_configuration_sets_paginator: ListConfigurationSetsPaginator = client.get_paginator(\n \"list_configuration_sets\"\n)\nlist_dedicated_ip_pools_paginator: ListDedicatedIpPoolsPaginator = client.get_paginator(\n \"list_dedicated_ip_pools\"\n)\nlist_deliverability_test_reports_paginator: ListDeliverabilityTestReportsPaginator = (\n client.get_paginator(\"list_deliverability_test_reports\")\n)\nlist_email_identities_paginator: ListEmailIdentitiesPaginator = client.get_paginator(\n \"list_email_identities\"\n)\n```\n\n<a id=\"literals\"></a>\n\n### Literals\n\n`mypy_boto3_pinpoint_email.literals` module contains literals extracted from\nshapes that can be used in user code for type checking.\n\n```python\nfrom mypy_boto3_pinpoint_email.literals import (\n BehaviorOnMxFailureType,\n DeliverabilityDashboardAccountStatusType,\n DeliverabilityTestStatusType,\n DimensionValueSourceType,\n DkimStatusType,\n EventTypeType,\n GetDedicatedIpsPaginatorName,\n IdentityTypeType,\n ListConfigurationSetsPaginatorName,\n ListDedicatedIpPoolsPaginatorName,\n ListDeliverabilityTestReportsPaginatorName,\n ListEmailIdentitiesPaginatorName,\n MailFromDomainStatusType,\n TlsPolicyType,\n WarmupStatusType,\n PinpointEmailServiceName,\n ServiceName,\n ResourceServiceName,\n PaginatorName,\n RegionName,\n)\n\n\ndef check_value(value: BehaviorOnMxFailureType) -> bool:\n ...\n```\n\n<a id=\"typed-dictionaries\"></a>\n\n### Typed dictionaries\n\n`mypy_boto3_pinpoint_email.type_defs` module contains structures and shapes\nassembled to typed dictionaries for additional type checking.\n\n```python\nfrom mypy_boto3_pinpoint_email.type_defs import (\n BlacklistEntryTypeDef,\n ContentTypeDef,\n CloudWatchDimensionConfigurationTypeDef,\n DeliveryOptionsTypeDef,\n ReputationOptionsTypeDef,\n SendingOptionsTypeDef,\n TagTypeDef,\n TrackingOptionsTypeDef,\n CreateDeliverabilityTestReportResponseTypeDef,\n DkimAttributesTypeDef,\n DomainIspPlacementTypeDef,\n VolumeStatisticsTypeDef,\n DedicatedIpTypeDef,\n DeleteConfigurationSetEventDestinationRequestRequestTypeDef,\n DeleteConfigurationSetRequestRequestTypeDef,\n DeleteDedicatedIpPoolRequestRequestTypeDef,\n DeleteEmailIdentityRequestRequestTypeDef,\n DeliverabilityTestReportTypeDef,\n DestinationTypeDef,\n DomainDeliverabilityCampaignTypeDef,\n InboxPlacementTrackingOptionTypeDef,\n RawMessageTypeDef,\n TemplateTypeDef,\n KinesisFirehoseDestinationTypeDef,\n PinpointDestinationTypeDef,\n SnsDestinationTypeDef,\n SendQuotaTypeDef,\n GetBlacklistReportsRequestRequestTypeDef,\n GetConfigurationSetEventDestinationsRequestRequestTypeDef,\n GetConfigurationSetRequestRequestTypeDef,\n GetDedicatedIpRequestRequestTypeDef,\n GetDedicatedIpsRequestGetDedicatedIpsPaginateTypeDef,\n GetDedicatedIpsRequestRequestTypeDef,\n GetDeliverabilityTestReportRequestRequestTypeDef,\n PlacementStatisticsTypeDef,\n GetDomainDeliverabilityCampaignRequestRequestTypeDef,\n GetDomainStatisticsReportRequestRequestTypeDef,\n GetEmailIdentityRequestRequestTypeDef,\n MailFromAttributesTypeDef,\n IdentityInfoTypeDef,\n ListConfigurationSetsRequestListConfigurationSetsPaginateTypeDef,\n ListConfigurationSetsRequestRequestTypeDef,\n ListConfigurationSetsResponseTypeDef,\n ListDedicatedIpPoolsRequestListDedicatedIpPoolsPaginateTypeDef,\n ListDedicatedIpPoolsRequestRequestTypeDef,\n ListDedicatedIpPoolsResponseTypeDef,\n ListDeliverabilityTestReportsRequestListDeliverabilityTestReportsPaginateTypeDef,\n ListDeliverabilityTestReportsRequestRequestTypeDef,\n ListDomainDeliverabilityCampaignsRequestRequestTypeDef,\n ListEmailIdentitiesRequestListEmailIdentitiesPaginateTypeDef,\n ListEmailIdentitiesRequestRequestTypeDef,\n ListTagsForResourceRequestRequestTypeDef,\n MessageTagTypeDef,\n PaginatorConfigTypeDef,\n PutAccountDedicatedIpWarmupAttributesRequestRequestTypeDef,\n PutAccountSendingAttributesRequestRequestTypeDef,\n PutConfigurationSetDeliveryOptionsRequestRequestTypeDef,\n PutConfigurationSetReputationOptionsRequestRequestTypeDef,\n PutConfigurationSetSendingOptionsRequestRequestTypeDef,\n PutConfigurationSetTrackingOptionsRequestRequestTypeDef,\n PutDedicatedIpInPoolRequestRequestTypeDef,\n PutDedicatedIpWarmupAttributesRequestRequestTypeDef,\n PutEmailIdentityDkimAttributesRequestRequestTypeDef,\n PutEmailIdentityFeedbackAttributesRequestRequestTypeDef,\n PutEmailIdentityMailFromAttributesRequestRequestTypeDef,\n ResponseMetadataTypeDef,\n SendEmailResponseTypeDef,\n UntagResourceRequestRequestTypeDef,\n GetBlacklistReportsResponseTypeDef,\n BodyTypeDef,\n CloudWatchDestinationTypeDef,\n CreateDedicatedIpPoolRequestRequestTypeDef,\n CreateEmailIdentityRequestRequestTypeDef,\n ListTagsForResourceResponseTypeDef,\n TagResourceRequestRequestTypeDef,\n CreateConfigurationSetRequestRequestTypeDef,\n GetConfigurationSetResponseTypeDef,\n CreateEmailIdentityResponseTypeDef,\n DailyVolumeTypeDef,\n OverallVolumeTypeDef,\n GetDedicatedIpResponseTypeDef,\n GetDedicatedIpsResponseTypeDef,\n ListDeliverabilityTestReportsResponseTypeDef,\n GetDomainDeliverabilityCampaignResponseTypeDef,\n ListDomainDeliverabilityCampaignsResponseTypeDef,\n DomainDeliverabilityTrackingOptionTypeDef,\n GetAccountResponseTypeDef,\n IspPlacementTypeDef,\n GetEmailIdentityResponseTypeDef,\n ListEmailIdentitiesResponseTypeDef,\n MessageTypeDef,\n EventDestinationDefinitionTypeDef,\n EventDestinationTypeDef,\n GetDomainStatisticsReportResponseTypeDef,\n GetDeliverabilityDashboardOptionsResponseTypeDef,\n PutDeliverabilityDashboardOptionRequestRequestTypeDef,\n GetDeliverabilityTestReportResponseTypeDef,\n EmailContentTypeDef,\n CreateConfigurationSetEventDestinationRequestRequestTypeDef,\n UpdateConfigurationSetEventDestinationRequestRequestTypeDef,\n GetConfigurationSetEventDestinationsResponseTypeDef,\n CreateDeliverabilityTestReportRequestRequestTypeDef,\n SendEmailRequestRequestTypeDef,\n)\n\n\ndef get_structure() -> BlacklistEntryTypeDef:\n return {...}\n```\n\n<a id=\"how-it-works\"></a>\n\n## How it works\n\nFully automated\n[mypy-boto3-builder](https://github.com/youtype/mypy_boto3_builder) carefully\ngenerates type annotations for each service, patiently waiting for `boto3`\nupdates. It delivers drop-in type annotations for you and makes sure that:\n\n- All available `boto3` services are covered.\n- Each public class and method of every `boto3` service gets valid type\n annotations extracted from `botocore` schemas.\n- Type annotations include up-to-date documentation.\n- Link to documentation is provided for every method.\n- Code is processed by [black](https://github.com/psf/black) and\n [isort](https://github.com/PyCQA/isort) for readability.\n\n<a id=\"what's-new\"></a>\n\n## What's new\n\n<a id=\"implemented-features\"></a>\n\n### Implemented features\n\n- Fully type annotated `boto3`, `botocore`, `aiobotocore` and `aioboto3`\n libraries\n- `mypy`, `pyright`, `VSCode`, `PyCharm`, `Sublime Text` and `Emacs`\n compatibility\n- `Client`, `ServiceResource`, `Resource`, `Waiter` `Paginator` type\n annotations for each service\n- Generated `TypeDefs` for each service\n- Generated `Literals` for each service\n- Auto discovery of types for `boto3.client` and `boto3.resource` calls\n- Auto discovery of types for `session.client` and `session.resource` calls\n- Auto discovery of types for `client.get_waiter` and `client.get_paginator`\n calls\n- Auto discovery of types for `ServiceResource` and `Resource` collections\n- Auto discovery of types for `aiobotocore.Session.create_client` calls\n\n<a id=\"latest-changes\"></a>\n\n### Latest changes\n\nBuilder changelog can be found in\n[Releases](https://github.com/youtype/mypy_boto3_builder/releases).\n\n<a id=\"versioning\"></a>\n\n## Versioning\n\n`mypy-boto3-pinpoint-email` version is the same as related `boto3` version and\nfollows [PEP 440](https://www.python.org/dev/peps/pep-0440/) format.\n\n<a id=\"thank-you\"></a>\n\n## Thank you\n\n- [Allie Fitter](https://github.com/alliefitter) for\n [boto3-type-annotations](https://pypi.org/project/boto3-type-annotations/),\n this package is based on top of his work\n- [black](https://github.com/psf/black) developers for an awesome formatting\n tool\n- [Timothy Edmund Crosley](https://github.com/timothycrosley) for\n [isort](https://github.com/PyCQA/isort) and how flexible it is\n- [mypy](https://github.com/python/mypy) developers for doing all dirty work\n for us\n- [pyright](https://github.com/microsoft/pyright) team for the new era of typed\n Python\n\n<a id=\"documentation\"></a>\n\n## Documentation\n\nAll services type annotations can be found in\n[boto3 docs](https://youtype.github.io/boto3_stubs_docs/mypy_boto3_pinpoint_email/)\n\n<a id=\"support-and-contributing\"></a>\n\n## Support and contributing\n\nThis package is auto-generated. Please reports any bugs or request new features\nin [mypy-boto3-builder](https://github.com/youtype/mypy_boto3_builder/issues/)\nrepository.\n",
"bugtrack_url": null,
"license": "MIT License",
"summary": "Type annotations for boto3.PinpointEmail 1.27.0 service generated with mypy-boto3-builder 7.14.5",
"version": "1.27.0",
"project_urls": {
"Documentation": "https://youtype.github.io/boto3_stubs_docs/mypy_boto3_pinpoint_email/",
"Homepage": "https://github.com/youtype/mypy_boto3_builder",
"Source": "https://github.com/youtype/mypy_boto3_builder",
"Tracker": "https://github.com/youtype/mypy_boto3_builder/issues"
},
"split_keywords": [
"boto3",
"pinpoint-email",
"type-annotations",
"boto3-stubs",
"mypy",
"typeshed",
"autocomplete"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "a547b323b1bca7fff3c02821e8d1394e8013d85e1aafe8e9aa1409704040ea17",
"md5": "d8b9c3e2f361ecd9a1d495b8574b51b5",
"sha256": "aeee9a6abc1afb1747f5391ef4091ab4524fc558be119995c98a8b1e85ddc29e"
},
"downloads": -1,
"filename": "mypy_boto3_pinpoint_email-1.27.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "d8b9c3e2f361ecd9a1d495b8574b51b5",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.7",
"size": 34432,
"upload_time": "2023-07-03T20:01:25",
"upload_time_iso_8601": "2023-07-03T20:01:25.094891Z",
"url": "https://files.pythonhosted.org/packages/a5/47/b323b1bca7fff3c02821e8d1394e8013d85e1aafe8e9aa1409704040ea17/mypy_boto3_pinpoint_email-1.27.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "bf8f2b25969b06fb5efad50d650a9ae9c2db9a61d3cf99a735e8444998485250",
"md5": "b8ec5fc120b7577fe0d91fb9715deec9",
"sha256": "f554428fff26ca5238b608e70aab1684f49324250bafff2436d5543a97c9c5b7"
},
"downloads": -1,
"filename": "mypy-boto3-pinpoint-email-1.27.0.tar.gz",
"has_sig": false,
"md5_digest": "b8ec5fc120b7577fe0d91fb9715deec9",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.7",
"size": 30207,
"upload_time": "2023-07-03T20:01:32",
"upload_time_iso_8601": "2023-07-03T20:01:32.531091Z",
"url": "https://files.pythonhosted.org/packages/bf/8f/2b25969b06fb5efad50d650a9ae9c2db9a61d3cf99a735e8444998485250/mypy-boto3-pinpoint-email-1.27.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-07-03 20:01:32",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "youtype",
"github_project": "mypy_boto3_builder",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "mypy-boto3-pinpoint-email"
}