diff options
| author | CoprDistGit <infra@openeuler.org> | 2023-04-11 05:25:21 +0000 |
|---|---|---|
| committer | CoprDistGit <infra@openeuler.org> | 2023-04-11 05:25:21 +0000 |
| commit | 3c7786929467b89016179e8c5e267472000702ce (patch) | |
| tree | 8a931492700cba18e13ac8ba41ae2c9928eb9d5a | |
| parent | 82bd133077a33f0f89abcc3d6ec30840d2c6adb4 (diff) | |
automatic import of python-mypy-boto3-pinpointopeneuler20.03
| -rw-r--r-- | .gitignore | 1 | ||||
| -rw-r--r-- | python-mypy-boto3-pinpoint.spec | 2551 | ||||
| -rw-r--r-- | sources | 1 |
3 files changed, 2553 insertions, 0 deletions
@@ -0,0 +1 @@ +/mypy-boto3-pinpoint-1.26.0.post1.tar.gz diff --git a/python-mypy-boto3-pinpoint.spec b/python-mypy-boto3-pinpoint.spec new file mode 100644 index 0000000..6450ca0 --- /dev/null +++ b/python-mypy-boto3-pinpoint.spec @@ -0,0 +1,2551 @@ +%global _empty_manifest_terminate_build 0 +Name: python-mypy-boto3-pinpoint +Version: 1.26.0.post1 +Release: 1 +Summary: Type annotations for boto3.Pinpoint 1.26.0 service generated with mypy-boto3-builder 7.11.10 +License: MIT License +URL: https://github.com/youtype/mypy_boto3_builder +Source0: https://mirrors.nju.edu.cn/pypi/web/packages/9c/7f/39caf07a503b93e95db4000c50de98360d9e7c0d91e1a967954db1433672/mypy-boto3-pinpoint-1.26.0.post1.tar.gz +BuildArch: noarch + +Requires: python3-typing-extensions + +%description +<a id="mypy-boto3-pinpoint"></a> + +# mypy-boto3-pinpoint + +[](https://pypi.org/project/mypy-boto3-pinpoint) +[](https://pypi.org/project/mypy-boto3-pinpoint) +[](https://mypy-boto3-builder.readthedocs.io/) +[](https://pypistats.org/packages/mypy-boto3-pinpoint) + + + +Type annotations for +[boto3.Pinpoint 1.26.0](https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/pinpoint.html#Pinpoint) +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.11.10](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 docs](https://youtype.github.io/boto3_stubs_docs/mypy_boto3_pinpoint/). + +See how it helps to find and fix potential bugs: + + + +- [mypy-boto3-pinpoint](#mypy-boto3-pinpoint) + - [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) + - [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 `Pinpoint`. + +<a id="from-pypi-with-pip"></a> + +### From PyPI with pip + +Install `boto3-stubs` for `Pinpoint` service. + +```bash +# install with boto3 type annotations +python -m pip install 'boto3-stubs[pinpoint]' + + +# 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]' + + +# standalone installation +python -m pip install mypy-boto3-pinpoint +``` + +<a id="how-to-uninstall"></a> + +## How to uninstall + +```bash +python -m pip uninstall -y mypy-boto3-pinpoint +``` + +<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]` in your environment: + +```bash +python -m pip install 'boto3-stubs[pinpoint]' +``` + +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]` in your environment: + +```bash +python -m pip install 'boto3-stubs-lite[pinpoint]'` +``` + +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]' +``` + +- 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]` with services you use in your environment: + +```bash +python -m pip install 'boto3-stubs[pinpoint]' +``` + +- 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]` in your environment: + +```bash +python -m pip install 'boto3-stubs[pinpoint]'` +``` + +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]` in your environment: + +```bash +python -m pip install 'boto3-stubs[pinpoint]' +``` + +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 + +`PinpointClient` provides annotations for `boto3.client("pinpoint")`. + +```python +from boto3.session import Session + +from mypy_boto3_pinpoint import PinpointClient + +client: PinpointClient = Session().client("pinpoint") + +# now client usage is checked by mypy and IDE should provide code completion +``` + +<a id="literals"></a> + +### Literals + +`mypy_boto3_pinpoint.literals` module contains literals extracted from shapes +that can be used in user code for type checking. + +```python +from mypy_boto3_pinpoint.literals import ( + ActionType, + AlignmentType, + AttributeTypeType, + ButtonActionType, + CampaignStatusType, + ChannelTypeType, + DayOfWeekType, + DeliveryStatusType, + DimensionTypeType, + DurationType, + EndpointTypesElementType, + FilterTypeType, + FormatType, + FrequencyType, + IncludeType, + JobStatusType, + LayoutType, + MessageTypeType, + ModeType, + OperatorType, + RecencyTypeType, + SegmentTypeType, + SourceTypeType, + StateType, + TemplateTypeType, + TypeType, + PinpointServiceName, + ServiceName, + ResourceServiceName, + RegionName, +) + + +def check_value(value: ActionType) -> bool: + ... +``` + +<a id="typed-dictionaries"></a> + +### Typed dictionaries + +`mypy_boto3_pinpoint.type_defs` module contains structures and shapes assembled +to typed dictionaries for additional type checking. + +```python +from mypy_boto3_pinpoint.type_defs import ( + ADMChannelRequestTypeDef, + ADMChannelResponseTypeDef, + ADMMessageTypeDef, + APNSChannelRequestTypeDef, + APNSChannelResponseTypeDef, + APNSMessageTypeDef, + APNSPushNotificationTemplateTypeDef, + APNSSandboxChannelRequestTypeDef, + APNSSandboxChannelResponseTypeDef, + APNSVoipChannelRequestTypeDef, + APNSVoipChannelResponseTypeDef, + APNSVoipSandboxChannelRequestTypeDef, + APNSVoipSandboxChannelResponseTypeDef, + ActivityResponseTypeDef, + ContactCenterActivityTypeDef, + HoldoutActivityTypeDef, + AddressConfigurationTypeDef, + AndroidPushNotificationTemplateTypeDef, + ApplicationResponseTypeDef, + CampaignHookTypeDef, + CampaignLimitsTypeDef, + QuietTimeTypeDef, + AttributeDimensionTypeDef, + AttributesResourceTypeDef, + BaiduChannelRequestTypeDef, + BaiduChannelResponseTypeDef, + BaiduMessageTypeDef, + CampaignCustomMessageTypeDef, + CampaignEmailMessageTypeDef, + CampaignStateTypeDef, + CustomDeliveryConfigurationTypeDef, + CampaignSmsMessageTypeDef, + ChannelResponseTypeDef, + ClosedDaysRuleTypeDef, + WaitTimeTypeDef, + CreateApplicationRequestTypeDef, + ResponseMetadataTypeDef, + EmailTemplateRequestTypeDef, + CreateTemplateMessageBodyTypeDef, + ExportJobRequestTypeDef, + ImportJobRequestTypeDef, + TemplateCreateMessageBodyTypeDef, + CreateRecommenderConfigurationTypeDef, + RecommenderConfigurationResponseTypeDef, + SMSTemplateRequestTypeDef, + VoiceTemplateRequestTypeDef, + JourneyCustomMessageTypeDef, + DefaultButtonConfigurationTypeDef, + DefaultMessageTypeDef, + DefaultPushNotificationMessageTypeDef, + DefaultPushNotificationTemplateTypeDef, + DeleteAdmChannelRequestRequestTypeDef, + DeleteApnsChannelRequestRequestTypeDef, + DeleteApnsSandboxChannelRequestRequestTypeDef, + DeleteApnsVoipChannelRequestRequestTypeDef, + DeleteApnsVoipSandboxChannelRequestRequestTypeDef, + DeleteAppRequestRequestTypeDef, + DeleteBaiduChannelRequestRequestTypeDef, + DeleteCampaignRequestRequestTypeDef, + DeleteEmailChannelRequestRequestTypeDef, + EmailChannelResponseTypeDef, + DeleteEmailTemplateRequestRequestTypeDef, + MessageBodyTypeDef, + DeleteEndpointRequestRequestTypeDef, + DeleteEventStreamRequestRequestTypeDef, + EventStreamTypeDef, + DeleteGcmChannelRequestRequestTypeDef, + GCMChannelResponseTypeDef, + DeleteInAppTemplateRequestRequestTypeDef, + DeleteJourneyRequestRequestTypeDef, + DeletePushTemplateRequestRequestTypeDef, + DeleteRecommenderConfigurationRequestRequestTypeDef, + DeleteSegmentRequestRequestTypeDef, + DeleteSmsChannelRequestRequestTypeDef, + SMSChannelResponseTypeDef, + DeleteSmsTemplateRequestRequestTypeDef, + DeleteUserEndpointsRequestRequestTypeDef, + DeleteVoiceChannelRequestRequestTypeDef, + VoiceChannelResponseTypeDef, + DeleteVoiceTemplateRequestRequestTypeDef, + GCMMessageTypeDef, + SMSMessageTypeDef, + VoiceMessageTypeDef, + EmailChannelRequestTypeDef, + JourneyEmailMessageTypeDef, + RawEmailTypeDef, + EmailTemplateResponseTypeDef, + EndpointDemographicTypeDef, + EndpointLocationTypeDef, + EndpointUserTypeDef, + EndpointItemResponseTypeDef, + EndpointMessageResultTypeDef, + EndpointSendConfigurationTypeDef, + MetricDimensionTypeDef, + SetDimensionTypeDef, + EventItemResponseTypeDef, + SessionTypeDef, + ExportJobResourceTypeDef, + GCMChannelRequestTypeDef, + GPSCoordinatesTypeDef, + GetAdmChannelRequestRequestTypeDef, + GetApnsChannelRequestRequestTypeDef, + GetApnsSandboxChannelRequestRequestTypeDef, + GetApnsVoipChannelRequestRequestTypeDef, + GetApnsVoipSandboxChannelRequestRequestTypeDef, + GetAppRequestRequestTypeDef, + GetApplicationDateRangeKpiRequestRequestTypeDef, + GetApplicationSettingsRequestRequestTypeDef, + GetAppsRequestRequestTypeDef, + GetBaiduChannelRequestRequestTypeDef, + GetCampaignActivitiesRequestRequestTypeDef, + GetCampaignDateRangeKpiRequestRequestTypeDef, + GetCampaignRequestRequestTypeDef, + GetCampaignVersionRequestRequestTypeDef, + GetCampaignVersionsRequestRequestTypeDef, + GetCampaignsRequestRequestTypeDef, + GetChannelsRequestRequestTypeDef, + GetEmailChannelRequestRequestTypeDef, + GetEmailTemplateRequestRequestTypeDef, + GetEndpointRequestRequestTypeDef, + GetEventStreamRequestRequestTypeDef, + GetExportJobRequestRequestTypeDef, + GetExportJobsRequestRequestTypeDef, + GetGcmChannelRequestRequestTypeDef, + GetImportJobRequestRequestTypeDef, + GetImportJobsRequestRequestTypeDef, + GetInAppMessagesRequestRequestTypeDef, + GetInAppTemplateRequestRequestTypeDef, + GetJourneyDateRangeKpiRequestRequestTypeDef, + GetJourneyExecutionActivityMetricsRequestRequestTypeDef, + JourneyExecutionActivityMetricsResponseTypeDef, + GetJourneyExecutionMetricsRequestRequestTypeDef, + JourneyExecutionMetricsResponseTypeDef, + GetJourneyRequestRequestTypeDef, + GetPushTemplateRequestRequestTypeDef, + GetRecommenderConfigurationRequestRequestTypeDef, + GetRecommenderConfigurationsRequestRequestTypeDef, + GetSegmentExportJobsRequestRequestTypeDef, + GetSegmentImportJobsRequestRequestTypeDef, + GetSegmentRequestRequestTypeDef, + GetSegmentVersionRequestRequestTypeDef, + GetSegmentVersionsRequestRequestTypeDef, + GetSegmentsRequestRequestTypeDef, + GetSmsChannelRequestRequestTypeDef, + GetSmsTemplateRequestRequestTypeDef, + SMSTemplateResponseTypeDef, + GetUserEndpointsRequestRequestTypeDef, + GetVoiceChannelRequestRequestTypeDef, + GetVoiceTemplateRequestRequestTypeDef, + VoiceTemplateResponseTypeDef, + ImportJobResourceTypeDef, + InAppMessageBodyConfigTypeDef, + OverrideButtonConfigurationTypeDef, + InAppMessageHeaderConfigTypeDef, + JourneyChannelSettingsTypeDef, + JourneyLimitsTypeDef, + JourneyPushMessageTypeDef, + JourneyScheduleTypeDef, + JourneySMSMessageTypeDef, + JourneyStateRequestTypeDef, + ListJourneysRequestRequestTypeDef, + ListTagsForResourceRequestRequestTypeDef, + TagsModelTypeDef, + ListTemplateVersionsRequestRequestTypeDef, + ListTemplatesRequestRequestTypeDef, + MessageTypeDef, + MessageResultTypeDef, + NumberValidateRequestTypeDef, + NumberValidateResponseTypeDef, + OpenHoursRuleTypeDef, + WriteEventStreamTypeDef, + RandomSplitEntryTypeDef, + RecencyDimensionTypeDef, + UpdateAttributesRequestTypeDef, + ResultRowValueTypeDef, + SMSChannelRequestTypeDef, + SegmentConditionTypeDef, + SegmentReferenceTypeDef, + SegmentImportResourceTypeDef, + SendOTPMessageRequestParametersTypeDef, + SimpleEmailPartTypeDef, + TemplateActiveVersionRequestTypeDef, + TemplateTypeDef, + TemplateResponseTypeDef, + TemplateVersionResponseTypeDef, + UntagResourceRequestRequestTypeDef, + UpdateRecommenderConfigurationTypeDef, + VoiceChannelRequestTypeDef, + VerificationResponseTypeDef, + VerifyOTPMessageRequestParametersTypeDef, + UpdateAdmChannelRequestRequestTypeDef, + UpdateApnsChannelRequestRequestTypeDef, + UpdateApnsSandboxChannelRequestRequestTypeDef, + UpdateApnsVoipChannelRequestRequestTypeDef, + UpdateApnsVoipSandboxChannelRequestRequestTypeDef, + ActivitiesResponseTypeDef, + ApplicationsResponseTypeDef, + ApplicationSettingsResourceTypeDef, + WriteApplicationSettingsRequestTypeDef, + UpdateBaiduChannelRequestRequestTypeDef, + ChannelsResponseTypeDef, + ClosedDaysTypeDef, + WaitActivityTypeDef, + CreateAppRequestRequestTypeDef, + CreateAppResponseTypeDef, + DeleteAdmChannelResponseTypeDef, + DeleteApnsChannelResponseTypeDef, + DeleteApnsSandboxChannelResponseTypeDef, + DeleteApnsVoipChannelResponseTypeDef, + DeleteApnsVoipSandboxChannelResponseTypeDef, + DeleteAppResponseTypeDef, + DeleteBaiduChannelResponseTypeDef, + EmptyResponseMetadataTypeDef, + GetAdmChannelResponseTypeDef, + GetApnsChannelResponseTypeDef, + GetApnsSandboxChannelResponseTypeDef, + GetApnsVoipChannelResponseTypeDef, + GetApnsVoipSandboxChannelResponseTypeDef, + GetAppResponseTypeDef, + GetBaiduChannelResponseTypeDef, + RemoveAttributesResponseTypeDef, + UpdateAdmChannelResponseTypeDef, + UpdateApnsChannelResponseTypeDef, + UpdateApnsSandboxChannelResponseTypeDef, + UpdateApnsVoipChannelResponseTypeDef, + UpdateApnsVoipSandboxChannelResponseTypeDef, + UpdateBaiduChannelResponseTypeDef, + CreateEmailTemplateRequestRequestTypeDef, + UpdateEmailTemplateRequestRequestTypeDef, + CreateEmailTemplateResponseTypeDef, + CreatePushTemplateResponseTypeDef, + CreateSmsTemplateResponseTypeDef, + CreateVoiceTemplateResponseTypeDef, + CreateExportJobRequestRequestTypeDef, + CreateImportJobRequestRequestTypeDef, + CreateInAppTemplateResponseTypeDef, + CreateRecommenderConfigurationRequestRequestTypeDef, + CreateRecommenderConfigurationResponseTypeDef, + DeleteRecommenderConfigurationResponseTypeDef, + GetRecommenderConfigurationResponseTypeDef, + ListRecommenderConfigurationsResponseTypeDef, + UpdateRecommenderConfigurationResponseTypeDef, + CreateSmsTemplateRequestRequestTypeDef, + UpdateSmsTemplateRequestRequestTypeDef, + CreateVoiceTemplateRequestRequestTypeDef, + UpdateVoiceTemplateRequestRequestTypeDef, + CustomMessageActivityTypeDef, + PushNotificationTemplateRequestTypeDef, + PushNotificationTemplateResponseTypeDef, + DeleteEmailChannelResponseTypeDef, + GetEmailChannelResponseTypeDef, + UpdateEmailChannelResponseTypeDef, + DeleteEmailTemplateResponseTypeDef, + DeleteInAppTemplateResponseTypeDef, + DeletePushTemplateResponseTypeDef, + DeleteSmsTemplateResponseTypeDef, + DeleteVoiceTemplateResponseTypeDef, + UpdateEmailTemplateResponseTypeDef, + UpdateEndpointResponseTypeDef, + UpdateEndpointsBatchResponseTypeDef, + UpdateInAppTemplateResponseTypeDef, + UpdatePushTemplateResponseTypeDef, + UpdateSmsTemplateResponseTypeDef, + UpdateTemplateActiveVersionResponseTypeDef, + UpdateVoiceTemplateResponseTypeDef, + DeleteEventStreamResponseTypeDef, + GetEventStreamResponseTypeDef, + PutEventStreamResponseTypeDef, + DeleteGcmChannelResponseTypeDef, + GetGcmChannelResponseTypeDef, + UpdateGcmChannelResponseTypeDef, + DeleteSmsChannelResponseTypeDef, + GetSmsChannelResponseTypeDef, + UpdateSmsChannelResponseTypeDef, + DeleteVoiceChannelResponseTypeDef, + GetVoiceChannelResponseTypeDef, + UpdateVoiceChannelResponseTypeDef, + UpdateEmailChannelRequestRequestTypeDef, + EmailMessageActivityTypeDef, + GetEmailTemplateResponseTypeDef, + EndpointBatchItemTypeDef, + EndpointRequestTypeDef, + EndpointResponseTypeDef, + PublicEndpointTypeDef, + SendUsersMessageResponseTypeDef, + EventDimensionsTypeDef, + SegmentDemographicsTypeDef, + ItemResponseTypeDef, + EventTypeDef, + ExportJobResponseTypeDef, + UpdateGcmChannelRequestRequestTypeDef, + GPSPointDimensionTypeDef, + GetJourneyExecutionActivityMetricsResponseTypeDef, + GetJourneyExecutionMetricsResponseTypeDef, + GetSmsTemplateResponseTypeDef, + GetVoiceTemplateResponseTypeDef, + ImportJobResponseTypeDef, + InAppMessageButtonTypeDef, + PushMessageActivityTypeDef, + SMSMessageActivityTypeDef, + UpdateJourneyStateRequestRequestTypeDef, + ListTagsForResourceResponseTypeDef, + TagResourceRequestRequestTypeDef, + MessageResponseTypeDef, + PhoneNumberValidateRequestRequestTypeDef, + PhoneNumberValidateResponseTypeDef, + OpenHoursTypeDef, + PutEventStreamRequestRequestTypeDef, + RandomSplitActivityTypeDef, + SegmentBehaviorsTypeDef, + RemoveAttributesRequestRequestTypeDef, + ResultRowTypeDef, + UpdateSmsChannelRequestRequestTypeDef, + SendOTPMessageRequestRequestTypeDef, + SimpleEmailTypeDef, + UpdateTemplateActiveVersionRequestRequestTypeDef, + TemplateConfigurationTypeDef, + TemplatesResponseTypeDef, + TemplateVersionsResponseTypeDef, + UpdateRecommenderConfigurationRequestRequestTypeDef, + UpdateVoiceChannelRequestRequestTypeDef, + VerifyOTPMessageResponseTypeDef, + VerifyOTPMessageRequestRequestTypeDef, + GetCampaignActivitiesResponseTypeDef, + GetAppsResponseTypeDef, + GetApplicationSettingsResponseTypeDef, + UpdateApplicationSettingsResponseTypeDef, + UpdateApplicationSettingsRequestRequestTypeDef, + GetChannelsResponseTypeDef, + GetRecommenderConfigurationsResponseTypeDef, + CreatePushTemplateRequestRequestTypeDef, + UpdatePushTemplateRequestRequestTypeDef, + GetPushTemplateResponseTypeDef, + EndpointBatchRequestTypeDef, + UpdateEndpointRequestRequestTypeDef, + DeleteEndpointResponseTypeDef, + EndpointsResponseTypeDef, + GetEndpointResponseTypeDef, + SendUsersMessagesResponseTypeDef, + CampaignEventFilterTypeDef, + EventConditionTypeDef, + EventFilterTypeDef, + EventsResponseTypeDef, + EventsBatchTypeDef, + CreateExportJobResponseTypeDef, + ExportJobsResponseTypeDef, + GetExportJobResponseTypeDef, + SegmentLocationTypeDef, + CreateImportJobResponseTypeDef, + GetImportJobResponseTypeDef, + ImportJobsResponseTypeDef, + InAppMessageContentTypeDef, + SendMessagesResponseTypeDef, + SendOTPMessageResponseTypeDef, + BaseKpiResultTypeDef, + EmailMessageTypeDef, + ListTemplatesResponseTypeDef, + ListTemplateVersionsResponseTypeDef, + UpdateEndpointsBatchRequestRequestTypeDef, + DeleteUserEndpointsResponseTypeDef, + GetUserEndpointsResponseTypeDef, + InAppCampaignScheduleTypeDef, + ScheduleTypeDef, + EventStartConditionTypeDef, + PutEventsResponseTypeDef, + EventsRequestTypeDef, + GetExportJobsResponseTypeDef, + GetSegmentExportJobsResponseTypeDef, + SegmentDimensionsTypeDef, + GetImportJobsResponseTypeDef, + GetSegmentImportJobsResponseTypeDef, + CampaignInAppMessageTypeDef, + InAppMessageTypeDef, + InAppTemplateRequestTypeDef, + InAppTemplateResponseTypeDef, + ApplicationDateRangeKpiResponseTypeDef, + CampaignDateRangeKpiResponseTypeDef, + JourneyDateRangeKpiResponseTypeDef, + DirectMessageConfigurationTypeDef, + StartConditionTypeDef, + PutEventsRequestRequestTypeDef, + SegmentGroupTypeDef, + SimpleConditionTypeDef, + MessageConfigurationTypeDef, + InAppMessageCampaignTypeDef, + CreateInAppTemplateRequestRequestTypeDef, + UpdateInAppTemplateRequestRequestTypeDef, + GetInAppTemplateResponseTypeDef, + GetApplicationDateRangeKpiResponseTypeDef, + GetCampaignDateRangeKpiResponseTypeDef, + GetJourneyDateRangeKpiResponseTypeDef, + MessageRequestTypeDef, + SendUsersMessageRequestTypeDef, + SegmentGroupListTypeDef, + ConditionTypeDef, + MultiConditionalBranchTypeDef, + TreatmentResourceTypeDef, + WriteTreatmentResourceTypeDef, + InAppMessagesResponseTypeDef, + SendMessagesRequestRequestTypeDef, + SendUsersMessagesRequestRequestTypeDef, + SegmentResponseTypeDef, + WriteSegmentRequestTypeDef, + ConditionalSplitActivityTypeDef, + MultiConditionalSplitActivityTypeDef, + CampaignResponseTypeDef, + WriteCampaignRequestTypeDef, + GetInAppMessagesResponseTypeDef, + CreateSegmentResponseTypeDef, + DeleteSegmentResponseTypeDef, + GetSegmentResponseTypeDef, + GetSegmentVersionResponseTypeDef, + SegmentsResponseTypeDef, + UpdateSegmentResponseTypeDef, + CreateSegmentRequestRequestTypeDef, + UpdateSegmentRequestRequestTypeDef, + ActivityTypeDef, + CampaignsResponseTypeDef, + CreateCampaignResponseTypeDef, + DeleteCampaignResponseTypeDef, + GetCampaignResponseTypeDef, + GetCampaignVersionResponseTypeDef, + UpdateCampaignResponseTypeDef, + CreateCampaignRequestRequestTypeDef, + UpdateCampaignRequestRequestTypeDef, + GetSegmentVersionsResponseTypeDef, + GetSegmentsResponseTypeDef, + JourneyResponseTypeDef, + WriteJourneyRequestTypeDef, + GetCampaignVersionsResponseTypeDef, + GetCampaignsResponseTypeDef, + CreateJourneyResponseTypeDef, + DeleteJourneyResponseTypeDef, + GetJourneyResponseTypeDef, + JourneysResponseTypeDef, + UpdateJourneyResponseTypeDef, + UpdateJourneyStateResponseTypeDef, + CreateJourneyRequestRequestTypeDef, + UpdateJourneyRequestRequestTypeDef, + ListJourneysResponseTypeDef, +) + + +def get_structure() -> ADMChannelRequestTypeDef: + 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 a 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 the documentation (blame `botocore` docs if types + are incorrect). +- 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` and `aiobotocore` 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.session` calls +- Auto discovery of types for `session.client` and `session.session` 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` 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/) + +<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. + + +%package -n python3-mypy-boto3-pinpoint +Summary: Type annotations for boto3.Pinpoint 1.26.0 service generated with mypy-boto3-builder 7.11.10 +Provides: python-mypy-boto3-pinpoint +BuildRequires: python3-devel +BuildRequires: python3-setuptools +BuildRequires: python3-pip +%description -n python3-mypy-boto3-pinpoint +<a id="mypy-boto3-pinpoint"></a> + +# mypy-boto3-pinpoint + +[](https://pypi.org/project/mypy-boto3-pinpoint) +[](https://pypi.org/project/mypy-boto3-pinpoint) +[](https://mypy-boto3-builder.readthedocs.io/) +[](https://pypistats.org/packages/mypy-boto3-pinpoint) + + + +Type annotations for +[boto3.Pinpoint 1.26.0](https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/pinpoint.html#Pinpoint) +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.11.10](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 docs](https://youtype.github.io/boto3_stubs_docs/mypy_boto3_pinpoint/). + +See how it helps to find and fix potential bugs: + + + +- [mypy-boto3-pinpoint](#mypy-boto3-pinpoint) + - [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) + - [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 `Pinpoint`. + +<a id="from-pypi-with-pip"></a> + +### From PyPI with pip + +Install `boto3-stubs` for `Pinpoint` service. + +```bash +# install with boto3 type annotations +python -m pip install 'boto3-stubs[pinpoint]' + + +# 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]' + + +# standalone installation +python -m pip install mypy-boto3-pinpoint +``` + +<a id="how-to-uninstall"></a> + +## How to uninstall + +```bash +python -m pip uninstall -y mypy-boto3-pinpoint +``` + +<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]` in your environment: + +```bash +python -m pip install 'boto3-stubs[pinpoint]' +``` + +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]` in your environment: + +```bash +python -m pip install 'boto3-stubs-lite[pinpoint]'` +``` + +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]' +``` + +- 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]` with services you use in your environment: + +```bash +python -m pip install 'boto3-stubs[pinpoint]' +``` + +- 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]` in your environment: + +```bash +python -m pip install 'boto3-stubs[pinpoint]'` +``` + +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]` in your environment: + +```bash +python -m pip install 'boto3-stubs[pinpoint]' +``` + +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 + +`PinpointClient` provides annotations for `boto3.client("pinpoint")`. + +```python +from boto3.session import Session + +from mypy_boto3_pinpoint import PinpointClient + +client: PinpointClient = Session().client("pinpoint") + +# now client usage is checked by mypy and IDE should provide code completion +``` + +<a id="literals"></a> + +### Literals + +`mypy_boto3_pinpoint.literals` module contains literals extracted from shapes +that can be used in user code for type checking. + +```python +from mypy_boto3_pinpoint.literals import ( + ActionType, + AlignmentType, + AttributeTypeType, + ButtonActionType, + CampaignStatusType, + ChannelTypeType, + DayOfWeekType, + DeliveryStatusType, + DimensionTypeType, + DurationType, + EndpointTypesElementType, + FilterTypeType, + FormatType, + FrequencyType, + IncludeType, + JobStatusType, + LayoutType, + MessageTypeType, + ModeType, + OperatorType, + RecencyTypeType, + SegmentTypeType, + SourceTypeType, + StateType, + TemplateTypeType, + TypeType, + PinpointServiceName, + ServiceName, + ResourceServiceName, + RegionName, +) + + +def check_value(value: ActionType) -> bool: + ... +``` + +<a id="typed-dictionaries"></a> + +### Typed dictionaries + +`mypy_boto3_pinpoint.type_defs` module contains structures and shapes assembled +to typed dictionaries for additional type checking. + +```python +from mypy_boto3_pinpoint.type_defs import ( + ADMChannelRequestTypeDef, + ADMChannelResponseTypeDef, + ADMMessageTypeDef, + APNSChannelRequestTypeDef, + APNSChannelResponseTypeDef, + APNSMessageTypeDef, + APNSPushNotificationTemplateTypeDef, + APNSSandboxChannelRequestTypeDef, + APNSSandboxChannelResponseTypeDef, + APNSVoipChannelRequestTypeDef, + APNSVoipChannelResponseTypeDef, + APNSVoipSandboxChannelRequestTypeDef, + APNSVoipSandboxChannelResponseTypeDef, + ActivityResponseTypeDef, + ContactCenterActivityTypeDef, + HoldoutActivityTypeDef, + AddressConfigurationTypeDef, + AndroidPushNotificationTemplateTypeDef, + ApplicationResponseTypeDef, + CampaignHookTypeDef, + CampaignLimitsTypeDef, + QuietTimeTypeDef, + AttributeDimensionTypeDef, + AttributesResourceTypeDef, + BaiduChannelRequestTypeDef, + BaiduChannelResponseTypeDef, + BaiduMessageTypeDef, + CampaignCustomMessageTypeDef, + CampaignEmailMessageTypeDef, + CampaignStateTypeDef, + CustomDeliveryConfigurationTypeDef, + CampaignSmsMessageTypeDef, + ChannelResponseTypeDef, + ClosedDaysRuleTypeDef, + WaitTimeTypeDef, + CreateApplicationRequestTypeDef, + ResponseMetadataTypeDef, + EmailTemplateRequestTypeDef, + CreateTemplateMessageBodyTypeDef, + ExportJobRequestTypeDef, + ImportJobRequestTypeDef, + TemplateCreateMessageBodyTypeDef, + CreateRecommenderConfigurationTypeDef, + RecommenderConfigurationResponseTypeDef, + SMSTemplateRequestTypeDef, + VoiceTemplateRequestTypeDef, + JourneyCustomMessageTypeDef, + DefaultButtonConfigurationTypeDef, + DefaultMessageTypeDef, + DefaultPushNotificationMessageTypeDef, + DefaultPushNotificationTemplateTypeDef, + DeleteAdmChannelRequestRequestTypeDef, + DeleteApnsChannelRequestRequestTypeDef, + DeleteApnsSandboxChannelRequestRequestTypeDef, + DeleteApnsVoipChannelRequestRequestTypeDef, + DeleteApnsVoipSandboxChannelRequestRequestTypeDef, + DeleteAppRequestRequestTypeDef, + DeleteBaiduChannelRequestRequestTypeDef, + DeleteCampaignRequestRequestTypeDef, + DeleteEmailChannelRequestRequestTypeDef, + EmailChannelResponseTypeDef, + DeleteEmailTemplateRequestRequestTypeDef, + MessageBodyTypeDef, + DeleteEndpointRequestRequestTypeDef, + DeleteEventStreamRequestRequestTypeDef, + EventStreamTypeDef, + DeleteGcmChannelRequestRequestTypeDef, + GCMChannelResponseTypeDef, + DeleteInAppTemplateRequestRequestTypeDef, + DeleteJourneyRequestRequestTypeDef, + DeletePushTemplateRequestRequestTypeDef, + DeleteRecommenderConfigurationRequestRequestTypeDef, + DeleteSegmentRequestRequestTypeDef, + DeleteSmsChannelRequestRequestTypeDef, + SMSChannelResponseTypeDef, + DeleteSmsTemplateRequestRequestTypeDef, + DeleteUserEndpointsRequestRequestTypeDef, + DeleteVoiceChannelRequestRequestTypeDef, + VoiceChannelResponseTypeDef, + DeleteVoiceTemplateRequestRequestTypeDef, + GCMMessageTypeDef, + SMSMessageTypeDef, + VoiceMessageTypeDef, + EmailChannelRequestTypeDef, + JourneyEmailMessageTypeDef, + RawEmailTypeDef, + EmailTemplateResponseTypeDef, + EndpointDemographicTypeDef, + EndpointLocationTypeDef, + EndpointUserTypeDef, + EndpointItemResponseTypeDef, + EndpointMessageResultTypeDef, + EndpointSendConfigurationTypeDef, + MetricDimensionTypeDef, + SetDimensionTypeDef, + EventItemResponseTypeDef, + SessionTypeDef, + ExportJobResourceTypeDef, + GCMChannelRequestTypeDef, + GPSCoordinatesTypeDef, + GetAdmChannelRequestRequestTypeDef, + GetApnsChannelRequestRequestTypeDef, + GetApnsSandboxChannelRequestRequestTypeDef, + GetApnsVoipChannelRequestRequestTypeDef, + GetApnsVoipSandboxChannelRequestRequestTypeDef, + GetAppRequestRequestTypeDef, + GetApplicationDateRangeKpiRequestRequestTypeDef, + GetApplicationSettingsRequestRequestTypeDef, + GetAppsRequestRequestTypeDef, + GetBaiduChannelRequestRequestTypeDef, + GetCampaignActivitiesRequestRequestTypeDef, + GetCampaignDateRangeKpiRequestRequestTypeDef, + GetCampaignRequestRequestTypeDef, + GetCampaignVersionRequestRequestTypeDef, + GetCampaignVersionsRequestRequestTypeDef, + GetCampaignsRequestRequestTypeDef, + GetChannelsRequestRequestTypeDef, + GetEmailChannelRequestRequestTypeDef, + GetEmailTemplateRequestRequestTypeDef, + GetEndpointRequestRequestTypeDef, + GetEventStreamRequestRequestTypeDef, + GetExportJobRequestRequestTypeDef, + GetExportJobsRequestRequestTypeDef, + GetGcmChannelRequestRequestTypeDef, + GetImportJobRequestRequestTypeDef, + GetImportJobsRequestRequestTypeDef, + GetInAppMessagesRequestRequestTypeDef, + GetInAppTemplateRequestRequestTypeDef, + GetJourneyDateRangeKpiRequestRequestTypeDef, + GetJourneyExecutionActivityMetricsRequestRequestTypeDef, + JourneyExecutionActivityMetricsResponseTypeDef, + GetJourneyExecutionMetricsRequestRequestTypeDef, + JourneyExecutionMetricsResponseTypeDef, + GetJourneyRequestRequestTypeDef, + GetPushTemplateRequestRequestTypeDef, + GetRecommenderConfigurationRequestRequestTypeDef, + GetRecommenderConfigurationsRequestRequestTypeDef, + GetSegmentExportJobsRequestRequestTypeDef, + GetSegmentImportJobsRequestRequestTypeDef, + GetSegmentRequestRequestTypeDef, + GetSegmentVersionRequestRequestTypeDef, + GetSegmentVersionsRequestRequestTypeDef, + GetSegmentsRequestRequestTypeDef, + GetSmsChannelRequestRequestTypeDef, + GetSmsTemplateRequestRequestTypeDef, + SMSTemplateResponseTypeDef, + GetUserEndpointsRequestRequestTypeDef, + GetVoiceChannelRequestRequestTypeDef, + GetVoiceTemplateRequestRequestTypeDef, + VoiceTemplateResponseTypeDef, + ImportJobResourceTypeDef, + InAppMessageBodyConfigTypeDef, + OverrideButtonConfigurationTypeDef, + InAppMessageHeaderConfigTypeDef, + JourneyChannelSettingsTypeDef, + JourneyLimitsTypeDef, + JourneyPushMessageTypeDef, + JourneyScheduleTypeDef, + JourneySMSMessageTypeDef, + JourneyStateRequestTypeDef, + ListJourneysRequestRequestTypeDef, + ListTagsForResourceRequestRequestTypeDef, + TagsModelTypeDef, + ListTemplateVersionsRequestRequestTypeDef, + ListTemplatesRequestRequestTypeDef, + MessageTypeDef, + MessageResultTypeDef, + NumberValidateRequestTypeDef, + NumberValidateResponseTypeDef, + OpenHoursRuleTypeDef, + WriteEventStreamTypeDef, + RandomSplitEntryTypeDef, + RecencyDimensionTypeDef, + UpdateAttributesRequestTypeDef, + ResultRowValueTypeDef, + SMSChannelRequestTypeDef, + SegmentConditionTypeDef, + SegmentReferenceTypeDef, + SegmentImportResourceTypeDef, + SendOTPMessageRequestParametersTypeDef, + SimpleEmailPartTypeDef, + TemplateActiveVersionRequestTypeDef, + TemplateTypeDef, + TemplateResponseTypeDef, + TemplateVersionResponseTypeDef, + UntagResourceRequestRequestTypeDef, + UpdateRecommenderConfigurationTypeDef, + VoiceChannelRequestTypeDef, + VerificationResponseTypeDef, + VerifyOTPMessageRequestParametersTypeDef, + UpdateAdmChannelRequestRequestTypeDef, + UpdateApnsChannelRequestRequestTypeDef, + UpdateApnsSandboxChannelRequestRequestTypeDef, + UpdateApnsVoipChannelRequestRequestTypeDef, + UpdateApnsVoipSandboxChannelRequestRequestTypeDef, + ActivitiesResponseTypeDef, + ApplicationsResponseTypeDef, + ApplicationSettingsResourceTypeDef, + WriteApplicationSettingsRequestTypeDef, + UpdateBaiduChannelRequestRequestTypeDef, + ChannelsResponseTypeDef, + ClosedDaysTypeDef, + WaitActivityTypeDef, + CreateAppRequestRequestTypeDef, + CreateAppResponseTypeDef, + DeleteAdmChannelResponseTypeDef, + DeleteApnsChannelResponseTypeDef, + DeleteApnsSandboxChannelResponseTypeDef, + DeleteApnsVoipChannelResponseTypeDef, + DeleteApnsVoipSandboxChannelResponseTypeDef, + DeleteAppResponseTypeDef, + DeleteBaiduChannelResponseTypeDef, + EmptyResponseMetadataTypeDef, + GetAdmChannelResponseTypeDef, + GetApnsChannelResponseTypeDef, + GetApnsSandboxChannelResponseTypeDef, + GetApnsVoipChannelResponseTypeDef, + GetApnsVoipSandboxChannelResponseTypeDef, + GetAppResponseTypeDef, + GetBaiduChannelResponseTypeDef, + RemoveAttributesResponseTypeDef, + UpdateAdmChannelResponseTypeDef, + UpdateApnsChannelResponseTypeDef, + UpdateApnsSandboxChannelResponseTypeDef, + UpdateApnsVoipChannelResponseTypeDef, + UpdateApnsVoipSandboxChannelResponseTypeDef, + UpdateBaiduChannelResponseTypeDef, + CreateEmailTemplateRequestRequestTypeDef, + UpdateEmailTemplateRequestRequestTypeDef, + CreateEmailTemplateResponseTypeDef, + CreatePushTemplateResponseTypeDef, + CreateSmsTemplateResponseTypeDef, + CreateVoiceTemplateResponseTypeDef, + CreateExportJobRequestRequestTypeDef, + CreateImportJobRequestRequestTypeDef, + CreateInAppTemplateResponseTypeDef, + CreateRecommenderConfigurationRequestRequestTypeDef, + CreateRecommenderConfigurationResponseTypeDef, + DeleteRecommenderConfigurationResponseTypeDef, + GetRecommenderConfigurationResponseTypeDef, + ListRecommenderConfigurationsResponseTypeDef, + UpdateRecommenderConfigurationResponseTypeDef, + CreateSmsTemplateRequestRequestTypeDef, + UpdateSmsTemplateRequestRequestTypeDef, + CreateVoiceTemplateRequestRequestTypeDef, + UpdateVoiceTemplateRequestRequestTypeDef, + CustomMessageActivityTypeDef, + PushNotificationTemplateRequestTypeDef, + PushNotificationTemplateResponseTypeDef, + DeleteEmailChannelResponseTypeDef, + GetEmailChannelResponseTypeDef, + UpdateEmailChannelResponseTypeDef, + DeleteEmailTemplateResponseTypeDef, + DeleteInAppTemplateResponseTypeDef, + DeletePushTemplateResponseTypeDef, + DeleteSmsTemplateResponseTypeDef, + DeleteVoiceTemplateResponseTypeDef, + UpdateEmailTemplateResponseTypeDef, + UpdateEndpointResponseTypeDef, + UpdateEndpointsBatchResponseTypeDef, + UpdateInAppTemplateResponseTypeDef, + UpdatePushTemplateResponseTypeDef, + UpdateSmsTemplateResponseTypeDef, + UpdateTemplateActiveVersionResponseTypeDef, + UpdateVoiceTemplateResponseTypeDef, + DeleteEventStreamResponseTypeDef, + GetEventStreamResponseTypeDef, + PutEventStreamResponseTypeDef, + DeleteGcmChannelResponseTypeDef, + GetGcmChannelResponseTypeDef, + UpdateGcmChannelResponseTypeDef, + DeleteSmsChannelResponseTypeDef, + GetSmsChannelResponseTypeDef, + UpdateSmsChannelResponseTypeDef, + DeleteVoiceChannelResponseTypeDef, + GetVoiceChannelResponseTypeDef, + UpdateVoiceChannelResponseTypeDef, + UpdateEmailChannelRequestRequestTypeDef, + EmailMessageActivityTypeDef, + GetEmailTemplateResponseTypeDef, + EndpointBatchItemTypeDef, + EndpointRequestTypeDef, + EndpointResponseTypeDef, + PublicEndpointTypeDef, + SendUsersMessageResponseTypeDef, + EventDimensionsTypeDef, + SegmentDemographicsTypeDef, + ItemResponseTypeDef, + EventTypeDef, + ExportJobResponseTypeDef, + UpdateGcmChannelRequestRequestTypeDef, + GPSPointDimensionTypeDef, + GetJourneyExecutionActivityMetricsResponseTypeDef, + GetJourneyExecutionMetricsResponseTypeDef, + GetSmsTemplateResponseTypeDef, + GetVoiceTemplateResponseTypeDef, + ImportJobResponseTypeDef, + InAppMessageButtonTypeDef, + PushMessageActivityTypeDef, + SMSMessageActivityTypeDef, + UpdateJourneyStateRequestRequestTypeDef, + ListTagsForResourceResponseTypeDef, + TagResourceRequestRequestTypeDef, + MessageResponseTypeDef, + PhoneNumberValidateRequestRequestTypeDef, + PhoneNumberValidateResponseTypeDef, + OpenHoursTypeDef, + PutEventStreamRequestRequestTypeDef, + RandomSplitActivityTypeDef, + SegmentBehaviorsTypeDef, + RemoveAttributesRequestRequestTypeDef, + ResultRowTypeDef, + UpdateSmsChannelRequestRequestTypeDef, + SendOTPMessageRequestRequestTypeDef, + SimpleEmailTypeDef, + UpdateTemplateActiveVersionRequestRequestTypeDef, + TemplateConfigurationTypeDef, + TemplatesResponseTypeDef, + TemplateVersionsResponseTypeDef, + UpdateRecommenderConfigurationRequestRequestTypeDef, + UpdateVoiceChannelRequestRequestTypeDef, + VerifyOTPMessageResponseTypeDef, + VerifyOTPMessageRequestRequestTypeDef, + GetCampaignActivitiesResponseTypeDef, + GetAppsResponseTypeDef, + GetApplicationSettingsResponseTypeDef, + UpdateApplicationSettingsResponseTypeDef, + UpdateApplicationSettingsRequestRequestTypeDef, + GetChannelsResponseTypeDef, + GetRecommenderConfigurationsResponseTypeDef, + CreatePushTemplateRequestRequestTypeDef, + UpdatePushTemplateRequestRequestTypeDef, + GetPushTemplateResponseTypeDef, + EndpointBatchRequestTypeDef, + UpdateEndpointRequestRequestTypeDef, + DeleteEndpointResponseTypeDef, + EndpointsResponseTypeDef, + GetEndpointResponseTypeDef, + SendUsersMessagesResponseTypeDef, + CampaignEventFilterTypeDef, + EventConditionTypeDef, + EventFilterTypeDef, + EventsResponseTypeDef, + EventsBatchTypeDef, + CreateExportJobResponseTypeDef, + ExportJobsResponseTypeDef, + GetExportJobResponseTypeDef, + SegmentLocationTypeDef, + CreateImportJobResponseTypeDef, + GetImportJobResponseTypeDef, + ImportJobsResponseTypeDef, + InAppMessageContentTypeDef, + SendMessagesResponseTypeDef, + SendOTPMessageResponseTypeDef, + BaseKpiResultTypeDef, + EmailMessageTypeDef, + ListTemplatesResponseTypeDef, + ListTemplateVersionsResponseTypeDef, + UpdateEndpointsBatchRequestRequestTypeDef, + DeleteUserEndpointsResponseTypeDef, + GetUserEndpointsResponseTypeDef, + InAppCampaignScheduleTypeDef, + ScheduleTypeDef, + EventStartConditionTypeDef, + PutEventsResponseTypeDef, + EventsRequestTypeDef, + GetExportJobsResponseTypeDef, + GetSegmentExportJobsResponseTypeDef, + SegmentDimensionsTypeDef, + GetImportJobsResponseTypeDef, + GetSegmentImportJobsResponseTypeDef, + CampaignInAppMessageTypeDef, + InAppMessageTypeDef, + InAppTemplateRequestTypeDef, + InAppTemplateResponseTypeDef, + ApplicationDateRangeKpiResponseTypeDef, + CampaignDateRangeKpiResponseTypeDef, + JourneyDateRangeKpiResponseTypeDef, + DirectMessageConfigurationTypeDef, + StartConditionTypeDef, + PutEventsRequestRequestTypeDef, + SegmentGroupTypeDef, + SimpleConditionTypeDef, + MessageConfigurationTypeDef, + InAppMessageCampaignTypeDef, + CreateInAppTemplateRequestRequestTypeDef, + UpdateInAppTemplateRequestRequestTypeDef, + GetInAppTemplateResponseTypeDef, + GetApplicationDateRangeKpiResponseTypeDef, + GetCampaignDateRangeKpiResponseTypeDef, + GetJourneyDateRangeKpiResponseTypeDef, + MessageRequestTypeDef, + SendUsersMessageRequestTypeDef, + SegmentGroupListTypeDef, + ConditionTypeDef, + MultiConditionalBranchTypeDef, + TreatmentResourceTypeDef, + WriteTreatmentResourceTypeDef, + InAppMessagesResponseTypeDef, + SendMessagesRequestRequestTypeDef, + SendUsersMessagesRequestRequestTypeDef, + SegmentResponseTypeDef, + WriteSegmentRequestTypeDef, + ConditionalSplitActivityTypeDef, + MultiConditionalSplitActivityTypeDef, + CampaignResponseTypeDef, + WriteCampaignRequestTypeDef, + GetInAppMessagesResponseTypeDef, + CreateSegmentResponseTypeDef, + DeleteSegmentResponseTypeDef, + GetSegmentResponseTypeDef, + GetSegmentVersionResponseTypeDef, + SegmentsResponseTypeDef, + UpdateSegmentResponseTypeDef, + CreateSegmentRequestRequestTypeDef, + UpdateSegmentRequestRequestTypeDef, + ActivityTypeDef, + CampaignsResponseTypeDef, + CreateCampaignResponseTypeDef, + DeleteCampaignResponseTypeDef, + GetCampaignResponseTypeDef, + GetCampaignVersionResponseTypeDef, + UpdateCampaignResponseTypeDef, + CreateCampaignRequestRequestTypeDef, + UpdateCampaignRequestRequestTypeDef, + GetSegmentVersionsResponseTypeDef, + GetSegmentsResponseTypeDef, + JourneyResponseTypeDef, + WriteJourneyRequestTypeDef, + GetCampaignVersionsResponseTypeDef, + GetCampaignsResponseTypeDef, + CreateJourneyResponseTypeDef, + DeleteJourneyResponseTypeDef, + GetJourneyResponseTypeDef, + JourneysResponseTypeDef, + UpdateJourneyResponseTypeDef, + UpdateJourneyStateResponseTypeDef, + CreateJourneyRequestRequestTypeDef, + UpdateJourneyRequestRequestTypeDef, + ListJourneysResponseTypeDef, +) + + +def get_structure() -> ADMChannelRequestTypeDef: + 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 a 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 the documentation (blame `botocore` docs if types + are incorrect). +- 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` and `aiobotocore` 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.session` calls +- Auto discovery of types for `session.client` and `session.session` 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` 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/) + +<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. + + +%package help +Summary: Development documents and examples for mypy-boto3-pinpoint +Provides: python3-mypy-boto3-pinpoint-doc +%description help +<a id="mypy-boto3-pinpoint"></a> + +# mypy-boto3-pinpoint + +[](https://pypi.org/project/mypy-boto3-pinpoint) +[](https://pypi.org/project/mypy-boto3-pinpoint) +[](https://mypy-boto3-builder.readthedocs.io/) +[](https://pypistats.org/packages/mypy-boto3-pinpoint) + + + +Type annotations for +[boto3.Pinpoint 1.26.0](https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/pinpoint.html#Pinpoint) +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.11.10](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 docs](https://youtype.github.io/boto3_stubs_docs/mypy_boto3_pinpoint/). + +See how it helps to find and fix potential bugs: + + + +- [mypy-boto3-pinpoint](#mypy-boto3-pinpoint) + - [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) + - [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 `Pinpoint`. + +<a id="from-pypi-with-pip"></a> + +### From PyPI with pip + +Install `boto3-stubs` for `Pinpoint` service. + +```bash +# install with boto3 type annotations +python -m pip install 'boto3-stubs[pinpoint]' + + +# 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]' + + +# standalone installation +python -m pip install mypy-boto3-pinpoint +``` + +<a id="how-to-uninstall"></a> + +## How to uninstall + +```bash +python -m pip uninstall -y mypy-boto3-pinpoint +``` + +<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]` in your environment: + +```bash +python -m pip install 'boto3-stubs[pinpoint]' +``` + +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]` in your environment: + +```bash +python -m pip install 'boto3-stubs-lite[pinpoint]'` +``` + +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]' +``` + +- 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]` with services you use in your environment: + +```bash +python -m pip install 'boto3-stubs[pinpoint]' +``` + +- 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]` in your environment: + +```bash +python -m pip install 'boto3-stubs[pinpoint]'` +``` + +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]` in your environment: + +```bash +python -m pip install 'boto3-stubs[pinpoint]' +``` + +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 + +`PinpointClient` provides annotations for `boto3.client("pinpoint")`. + +```python +from boto3.session import Session + +from mypy_boto3_pinpoint import PinpointClient + +client: PinpointClient = Session().client("pinpoint") + +# now client usage is checked by mypy and IDE should provide code completion +``` + +<a id="literals"></a> + +### Literals + +`mypy_boto3_pinpoint.literals` module contains literals extracted from shapes +that can be used in user code for type checking. + +```python +from mypy_boto3_pinpoint.literals import ( + ActionType, + AlignmentType, + AttributeTypeType, + ButtonActionType, + CampaignStatusType, + ChannelTypeType, + DayOfWeekType, + DeliveryStatusType, + DimensionTypeType, + DurationType, + EndpointTypesElementType, + FilterTypeType, + FormatType, + FrequencyType, + IncludeType, + JobStatusType, + LayoutType, + MessageTypeType, + ModeType, + OperatorType, + RecencyTypeType, + SegmentTypeType, + SourceTypeType, + StateType, + TemplateTypeType, + TypeType, + PinpointServiceName, + ServiceName, + ResourceServiceName, + RegionName, +) + + +def check_value(value: ActionType) -> bool: + ... +``` + +<a id="typed-dictionaries"></a> + +### Typed dictionaries + +`mypy_boto3_pinpoint.type_defs` module contains structures and shapes assembled +to typed dictionaries for additional type checking. + +```python +from mypy_boto3_pinpoint.type_defs import ( + ADMChannelRequestTypeDef, + ADMChannelResponseTypeDef, + ADMMessageTypeDef, + APNSChannelRequestTypeDef, + APNSChannelResponseTypeDef, + APNSMessageTypeDef, + APNSPushNotificationTemplateTypeDef, + APNSSandboxChannelRequestTypeDef, + APNSSandboxChannelResponseTypeDef, + APNSVoipChannelRequestTypeDef, + APNSVoipChannelResponseTypeDef, + APNSVoipSandboxChannelRequestTypeDef, + APNSVoipSandboxChannelResponseTypeDef, + ActivityResponseTypeDef, + ContactCenterActivityTypeDef, + HoldoutActivityTypeDef, + AddressConfigurationTypeDef, + AndroidPushNotificationTemplateTypeDef, + ApplicationResponseTypeDef, + CampaignHookTypeDef, + CampaignLimitsTypeDef, + QuietTimeTypeDef, + AttributeDimensionTypeDef, + AttributesResourceTypeDef, + BaiduChannelRequestTypeDef, + BaiduChannelResponseTypeDef, + BaiduMessageTypeDef, + CampaignCustomMessageTypeDef, + CampaignEmailMessageTypeDef, + CampaignStateTypeDef, + CustomDeliveryConfigurationTypeDef, + CampaignSmsMessageTypeDef, + ChannelResponseTypeDef, + ClosedDaysRuleTypeDef, + WaitTimeTypeDef, + CreateApplicationRequestTypeDef, + ResponseMetadataTypeDef, + EmailTemplateRequestTypeDef, + CreateTemplateMessageBodyTypeDef, + ExportJobRequestTypeDef, + ImportJobRequestTypeDef, + TemplateCreateMessageBodyTypeDef, + CreateRecommenderConfigurationTypeDef, + RecommenderConfigurationResponseTypeDef, + SMSTemplateRequestTypeDef, + VoiceTemplateRequestTypeDef, + JourneyCustomMessageTypeDef, + DefaultButtonConfigurationTypeDef, + DefaultMessageTypeDef, + DefaultPushNotificationMessageTypeDef, + DefaultPushNotificationTemplateTypeDef, + DeleteAdmChannelRequestRequestTypeDef, + DeleteApnsChannelRequestRequestTypeDef, + DeleteApnsSandboxChannelRequestRequestTypeDef, + DeleteApnsVoipChannelRequestRequestTypeDef, + DeleteApnsVoipSandboxChannelRequestRequestTypeDef, + DeleteAppRequestRequestTypeDef, + DeleteBaiduChannelRequestRequestTypeDef, + DeleteCampaignRequestRequestTypeDef, + DeleteEmailChannelRequestRequestTypeDef, + EmailChannelResponseTypeDef, + DeleteEmailTemplateRequestRequestTypeDef, + MessageBodyTypeDef, + DeleteEndpointRequestRequestTypeDef, + DeleteEventStreamRequestRequestTypeDef, + EventStreamTypeDef, + DeleteGcmChannelRequestRequestTypeDef, + GCMChannelResponseTypeDef, + DeleteInAppTemplateRequestRequestTypeDef, + DeleteJourneyRequestRequestTypeDef, + DeletePushTemplateRequestRequestTypeDef, + DeleteRecommenderConfigurationRequestRequestTypeDef, + DeleteSegmentRequestRequestTypeDef, + DeleteSmsChannelRequestRequestTypeDef, + SMSChannelResponseTypeDef, + DeleteSmsTemplateRequestRequestTypeDef, + DeleteUserEndpointsRequestRequestTypeDef, + DeleteVoiceChannelRequestRequestTypeDef, + VoiceChannelResponseTypeDef, + DeleteVoiceTemplateRequestRequestTypeDef, + GCMMessageTypeDef, + SMSMessageTypeDef, + VoiceMessageTypeDef, + EmailChannelRequestTypeDef, + JourneyEmailMessageTypeDef, + RawEmailTypeDef, + EmailTemplateResponseTypeDef, + EndpointDemographicTypeDef, + EndpointLocationTypeDef, + EndpointUserTypeDef, + EndpointItemResponseTypeDef, + EndpointMessageResultTypeDef, + EndpointSendConfigurationTypeDef, + MetricDimensionTypeDef, + SetDimensionTypeDef, + EventItemResponseTypeDef, + SessionTypeDef, + ExportJobResourceTypeDef, + GCMChannelRequestTypeDef, + GPSCoordinatesTypeDef, + GetAdmChannelRequestRequestTypeDef, + GetApnsChannelRequestRequestTypeDef, + GetApnsSandboxChannelRequestRequestTypeDef, + GetApnsVoipChannelRequestRequestTypeDef, + GetApnsVoipSandboxChannelRequestRequestTypeDef, + GetAppRequestRequestTypeDef, + GetApplicationDateRangeKpiRequestRequestTypeDef, + GetApplicationSettingsRequestRequestTypeDef, + GetAppsRequestRequestTypeDef, + GetBaiduChannelRequestRequestTypeDef, + GetCampaignActivitiesRequestRequestTypeDef, + GetCampaignDateRangeKpiRequestRequestTypeDef, + GetCampaignRequestRequestTypeDef, + GetCampaignVersionRequestRequestTypeDef, + GetCampaignVersionsRequestRequestTypeDef, + GetCampaignsRequestRequestTypeDef, + GetChannelsRequestRequestTypeDef, + GetEmailChannelRequestRequestTypeDef, + GetEmailTemplateRequestRequestTypeDef, + GetEndpointRequestRequestTypeDef, + GetEventStreamRequestRequestTypeDef, + GetExportJobRequestRequestTypeDef, + GetExportJobsRequestRequestTypeDef, + GetGcmChannelRequestRequestTypeDef, + GetImportJobRequestRequestTypeDef, + GetImportJobsRequestRequestTypeDef, + GetInAppMessagesRequestRequestTypeDef, + GetInAppTemplateRequestRequestTypeDef, + GetJourneyDateRangeKpiRequestRequestTypeDef, + GetJourneyExecutionActivityMetricsRequestRequestTypeDef, + JourneyExecutionActivityMetricsResponseTypeDef, + GetJourneyExecutionMetricsRequestRequestTypeDef, + JourneyExecutionMetricsResponseTypeDef, + GetJourneyRequestRequestTypeDef, + GetPushTemplateRequestRequestTypeDef, + GetRecommenderConfigurationRequestRequestTypeDef, + GetRecommenderConfigurationsRequestRequestTypeDef, + GetSegmentExportJobsRequestRequestTypeDef, + GetSegmentImportJobsRequestRequestTypeDef, + GetSegmentRequestRequestTypeDef, + GetSegmentVersionRequestRequestTypeDef, + GetSegmentVersionsRequestRequestTypeDef, + GetSegmentsRequestRequestTypeDef, + GetSmsChannelRequestRequestTypeDef, + GetSmsTemplateRequestRequestTypeDef, + SMSTemplateResponseTypeDef, + GetUserEndpointsRequestRequestTypeDef, + GetVoiceChannelRequestRequestTypeDef, + GetVoiceTemplateRequestRequestTypeDef, + VoiceTemplateResponseTypeDef, + ImportJobResourceTypeDef, + InAppMessageBodyConfigTypeDef, + OverrideButtonConfigurationTypeDef, + InAppMessageHeaderConfigTypeDef, + JourneyChannelSettingsTypeDef, + JourneyLimitsTypeDef, + JourneyPushMessageTypeDef, + JourneyScheduleTypeDef, + JourneySMSMessageTypeDef, + JourneyStateRequestTypeDef, + ListJourneysRequestRequestTypeDef, + ListTagsForResourceRequestRequestTypeDef, + TagsModelTypeDef, + ListTemplateVersionsRequestRequestTypeDef, + ListTemplatesRequestRequestTypeDef, + MessageTypeDef, + MessageResultTypeDef, + NumberValidateRequestTypeDef, + NumberValidateResponseTypeDef, + OpenHoursRuleTypeDef, + WriteEventStreamTypeDef, + RandomSplitEntryTypeDef, + RecencyDimensionTypeDef, + UpdateAttributesRequestTypeDef, + ResultRowValueTypeDef, + SMSChannelRequestTypeDef, + SegmentConditionTypeDef, + SegmentReferenceTypeDef, + SegmentImportResourceTypeDef, + SendOTPMessageRequestParametersTypeDef, + SimpleEmailPartTypeDef, + TemplateActiveVersionRequestTypeDef, + TemplateTypeDef, + TemplateResponseTypeDef, + TemplateVersionResponseTypeDef, + UntagResourceRequestRequestTypeDef, + UpdateRecommenderConfigurationTypeDef, + VoiceChannelRequestTypeDef, + VerificationResponseTypeDef, + VerifyOTPMessageRequestParametersTypeDef, + UpdateAdmChannelRequestRequestTypeDef, + UpdateApnsChannelRequestRequestTypeDef, + UpdateApnsSandboxChannelRequestRequestTypeDef, + UpdateApnsVoipChannelRequestRequestTypeDef, + UpdateApnsVoipSandboxChannelRequestRequestTypeDef, + ActivitiesResponseTypeDef, + ApplicationsResponseTypeDef, + ApplicationSettingsResourceTypeDef, + WriteApplicationSettingsRequestTypeDef, + UpdateBaiduChannelRequestRequestTypeDef, + ChannelsResponseTypeDef, + ClosedDaysTypeDef, + WaitActivityTypeDef, + CreateAppRequestRequestTypeDef, + CreateAppResponseTypeDef, + DeleteAdmChannelResponseTypeDef, + DeleteApnsChannelResponseTypeDef, + DeleteApnsSandboxChannelResponseTypeDef, + DeleteApnsVoipChannelResponseTypeDef, + DeleteApnsVoipSandboxChannelResponseTypeDef, + DeleteAppResponseTypeDef, + DeleteBaiduChannelResponseTypeDef, + EmptyResponseMetadataTypeDef, + GetAdmChannelResponseTypeDef, + GetApnsChannelResponseTypeDef, + GetApnsSandboxChannelResponseTypeDef, + GetApnsVoipChannelResponseTypeDef, + GetApnsVoipSandboxChannelResponseTypeDef, + GetAppResponseTypeDef, + GetBaiduChannelResponseTypeDef, + RemoveAttributesResponseTypeDef, + UpdateAdmChannelResponseTypeDef, + UpdateApnsChannelResponseTypeDef, + UpdateApnsSandboxChannelResponseTypeDef, + UpdateApnsVoipChannelResponseTypeDef, + UpdateApnsVoipSandboxChannelResponseTypeDef, + UpdateBaiduChannelResponseTypeDef, + CreateEmailTemplateRequestRequestTypeDef, + UpdateEmailTemplateRequestRequestTypeDef, + CreateEmailTemplateResponseTypeDef, + CreatePushTemplateResponseTypeDef, + CreateSmsTemplateResponseTypeDef, + CreateVoiceTemplateResponseTypeDef, + CreateExportJobRequestRequestTypeDef, + CreateImportJobRequestRequestTypeDef, + CreateInAppTemplateResponseTypeDef, + CreateRecommenderConfigurationRequestRequestTypeDef, + CreateRecommenderConfigurationResponseTypeDef, + DeleteRecommenderConfigurationResponseTypeDef, + GetRecommenderConfigurationResponseTypeDef, + ListRecommenderConfigurationsResponseTypeDef, + UpdateRecommenderConfigurationResponseTypeDef, + CreateSmsTemplateRequestRequestTypeDef, + UpdateSmsTemplateRequestRequestTypeDef, + CreateVoiceTemplateRequestRequestTypeDef, + UpdateVoiceTemplateRequestRequestTypeDef, + CustomMessageActivityTypeDef, + PushNotificationTemplateRequestTypeDef, + PushNotificationTemplateResponseTypeDef, + DeleteEmailChannelResponseTypeDef, + GetEmailChannelResponseTypeDef, + UpdateEmailChannelResponseTypeDef, + DeleteEmailTemplateResponseTypeDef, + DeleteInAppTemplateResponseTypeDef, + DeletePushTemplateResponseTypeDef, + DeleteSmsTemplateResponseTypeDef, + DeleteVoiceTemplateResponseTypeDef, + UpdateEmailTemplateResponseTypeDef, + UpdateEndpointResponseTypeDef, + UpdateEndpointsBatchResponseTypeDef, + UpdateInAppTemplateResponseTypeDef, + UpdatePushTemplateResponseTypeDef, + UpdateSmsTemplateResponseTypeDef, + UpdateTemplateActiveVersionResponseTypeDef, + UpdateVoiceTemplateResponseTypeDef, + DeleteEventStreamResponseTypeDef, + GetEventStreamResponseTypeDef, + PutEventStreamResponseTypeDef, + DeleteGcmChannelResponseTypeDef, + GetGcmChannelResponseTypeDef, + UpdateGcmChannelResponseTypeDef, + DeleteSmsChannelResponseTypeDef, + GetSmsChannelResponseTypeDef, + UpdateSmsChannelResponseTypeDef, + DeleteVoiceChannelResponseTypeDef, + GetVoiceChannelResponseTypeDef, + UpdateVoiceChannelResponseTypeDef, + UpdateEmailChannelRequestRequestTypeDef, + EmailMessageActivityTypeDef, + GetEmailTemplateResponseTypeDef, + EndpointBatchItemTypeDef, + EndpointRequestTypeDef, + EndpointResponseTypeDef, + PublicEndpointTypeDef, + SendUsersMessageResponseTypeDef, + EventDimensionsTypeDef, + SegmentDemographicsTypeDef, + ItemResponseTypeDef, + EventTypeDef, + ExportJobResponseTypeDef, + UpdateGcmChannelRequestRequestTypeDef, + GPSPointDimensionTypeDef, + GetJourneyExecutionActivityMetricsResponseTypeDef, + GetJourneyExecutionMetricsResponseTypeDef, + GetSmsTemplateResponseTypeDef, + GetVoiceTemplateResponseTypeDef, + ImportJobResponseTypeDef, + InAppMessageButtonTypeDef, + PushMessageActivityTypeDef, + SMSMessageActivityTypeDef, + UpdateJourneyStateRequestRequestTypeDef, + ListTagsForResourceResponseTypeDef, + TagResourceRequestRequestTypeDef, + MessageResponseTypeDef, + PhoneNumberValidateRequestRequestTypeDef, + PhoneNumberValidateResponseTypeDef, + OpenHoursTypeDef, + PutEventStreamRequestRequestTypeDef, + RandomSplitActivityTypeDef, + SegmentBehaviorsTypeDef, + RemoveAttributesRequestRequestTypeDef, + ResultRowTypeDef, + UpdateSmsChannelRequestRequestTypeDef, + SendOTPMessageRequestRequestTypeDef, + SimpleEmailTypeDef, + UpdateTemplateActiveVersionRequestRequestTypeDef, + TemplateConfigurationTypeDef, + TemplatesResponseTypeDef, + TemplateVersionsResponseTypeDef, + UpdateRecommenderConfigurationRequestRequestTypeDef, + UpdateVoiceChannelRequestRequestTypeDef, + VerifyOTPMessageResponseTypeDef, + VerifyOTPMessageRequestRequestTypeDef, + GetCampaignActivitiesResponseTypeDef, + GetAppsResponseTypeDef, + GetApplicationSettingsResponseTypeDef, + UpdateApplicationSettingsResponseTypeDef, + UpdateApplicationSettingsRequestRequestTypeDef, + GetChannelsResponseTypeDef, + GetRecommenderConfigurationsResponseTypeDef, + CreatePushTemplateRequestRequestTypeDef, + UpdatePushTemplateRequestRequestTypeDef, + GetPushTemplateResponseTypeDef, + EndpointBatchRequestTypeDef, + UpdateEndpointRequestRequestTypeDef, + DeleteEndpointResponseTypeDef, + EndpointsResponseTypeDef, + GetEndpointResponseTypeDef, + SendUsersMessagesResponseTypeDef, + CampaignEventFilterTypeDef, + EventConditionTypeDef, + EventFilterTypeDef, + EventsResponseTypeDef, + EventsBatchTypeDef, + CreateExportJobResponseTypeDef, + ExportJobsResponseTypeDef, + GetExportJobResponseTypeDef, + SegmentLocationTypeDef, + CreateImportJobResponseTypeDef, + GetImportJobResponseTypeDef, + ImportJobsResponseTypeDef, + InAppMessageContentTypeDef, + SendMessagesResponseTypeDef, + SendOTPMessageResponseTypeDef, + BaseKpiResultTypeDef, + EmailMessageTypeDef, + ListTemplatesResponseTypeDef, + ListTemplateVersionsResponseTypeDef, + UpdateEndpointsBatchRequestRequestTypeDef, + DeleteUserEndpointsResponseTypeDef, + GetUserEndpointsResponseTypeDef, + InAppCampaignScheduleTypeDef, + ScheduleTypeDef, + EventStartConditionTypeDef, + PutEventsResponseTypeDef, + EventsRequestTypeDef, + GetExportJobsResponseTypeDef, + GetSegmentExportJobsResponseTypeDef, + SegmentDimensionsTypeDef, + GetImportJobsResponseTypeDef, + GetSegmentImportJobsResponseTypeDef, + CampaignInAppMessageTypeDef, + InAppMessageTypeDef, + InAppTemplateRequestTypeDef, + InAppTemplateResponseTypeDef, + ApplicationDateRangeKpiResponseTypeDef, + CampaignDateRangeKpiResponseTypeDef, + JourneyDateRangeKpiResponseTypeDef, + DirectMessageConfigurationTypeDef, + StartConditionTypeDef, + PutEventsRequestRequestTypeDef, + SegmentGroupTypeDef, + SimpleConditionTypeDef, + MessageConfigurationTypeDef, + InAppMessageCampaignTypeDef, + CreateInAppTemplateRequestRequestTypeDef, + UpdateInAppTemplateRequestRequestTypeDef, + GetInAppTemplateResponseTypeDef, + GetApplicationDateRangeKpiResponseTypeDef, + GetCampaignDateRangeKpiResponseTypeDef, + GetJourneyDateRangeKpiResponseTypeDef, + MessageRequestTypeDef, + SendUsersMessageRequestTypeDef, + SegmentGroupListTypeDef, + ConditionTypeDef, + MultiConditionalBranchTypeDef, + TreatmentResourceTypeDef, + WriteTreatmentResourceTypeDef, + InAppMessagesResponseTypeDef, + SendMessagesRequestRequestTypeDef, + SendUsersMessagesRequestRequestTypeDef, + SegmentResponseTypeDef, + WriteSegmentRequestTypeDef, + ConditionalSplitActivityTypeDef, + MultiConditionalSplitActivityTypeDef, + CampaignResponseTypeDef, + WriteCampaignRequestTypeDef, + GetInAppMessagesResponseTypeDef, + CreateSegmentResponseTypeDef, + DeleteSegmentResponseTypeDef, + GetSegmentResponseTypeDef, + GetSegmentVersionResponseTypeDef, + SegmentsResponseTypeDef, + UpdateSegmentResponseTypeDef, + CreateSegmentRequestRequestTypeDef, + UpdateSegmentRequestRequestTypeDef, + ActivityTypeDef, + CampaignsResponseTypeDef, + CreateCampaignResponseTypeDef, + DeleteCampaignResponseTypeDef, + GetCampaignResponseTypeDef, + GetCampaignVersionResponseTypeDef, + UpdateCampaignResponseTypeDef, + CreateCampaignRequestRequestTypeDef, + UpdateCampaignRequestRequestTypeDef, + GetSegmentVersionsResponseTypeDef, + GetSegmentsResponseTypeDef, + JourneyResponseTypeDef, + WriteJourneyRequestTypeDef, + GetCampaignVersionsResponseTypeDef, + GetCampaignsResponseTypeDef, + CreateJourneyResponseTypeDef, + DeleteJourneyResponseTypeDef, + GetJourneyResponseTypeDef, + JourneysResponseTypeDef, + UpdateJourneyResponseTypeDef, + UpdateJourneyStateResponseTypeDef, + CreateJourneyRequestRequestTypeDef, + UpdateJourneyRequestRequestTypeDef, + ListJourneysResponseTypeDef, +) + + +def get_structure() -> ADMChannelRequestTypeDef: + 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 a 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 the documentation (blame `botocore` docs if types + are incorrect). +- 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` and `aiobotocore` 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.session` calls +- Auto discovery of types for `session.client` and `session.session` 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` 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/) + +<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. + + +%prep +%autosetup -n mypy-boto3-pinpoint-1.26.0.post1 + +%build +%py3_build + +%install +%py3_install +install -d -m755 %{buildroot}/%{_pkgdocdir} +if [ -d doc ]; then cp -arf doc %{buildroot}/%{_pkgdocdir}; fi +if [ -d docs ]; then cp -arf docs %{buildroot}/%{_pkgdocdir}; fi +if [ -d example ]; then cp -arf example %{buildroot}/%{_pkgdocdir}; fi +if [ -d examples ]; then cp -arf examples %{buildroot}/%{_pkgdocdir}; fi +pushd %{buildroot} +if [ -d usr/lib ]; then + find usr/lib -type f -printf "/%h/%f\n" >> filelist.lst +fi +if [ -d usr/lib64 ]; then + find usr/lib64 -type f -printf "/%h/%f\n" >> filelist.lst +fi +if [ -d usr/bin ]; then + find usr/bin -type f -printf "/%h/%f\n" >> filelist.lst +fi +if [ -d usr/sbin ]; then + find usr/sbin -type f -printf "/%h/%f\n" >> filelist.lst +fi +touch doclist.lst +if [ -d usr/share/man ]; then + find usr/share/man -type f -printf "/%h/%f.gz\n" >> doclist.lst +fi +popd +mv %{buildroot}/filelist.lst . +mv %{buildroot}/doclist.lst . + +%files -n python3-mypy-boto3-pinpoint -f filelist.lst +%dir %{python3_sitelib}/* + +%files help -f doclist.lst +%{_docdir}/* + +%changelog +* Tue Apr 11 2023 Python_Bot <Python_Bot@openeuler.org> - 1.26.0.post1-1 +- Package Spec generated @@ -0,0 +1 @@ +0cd96ebee86579c9156fd575aefb775b mypy-boto3-pinpoint-1.26.0.post1.tar.gz |
