PinpointEmail module#
Index > PinpointEmail
Auto-generated documentation for PinpointEmail type annotations stubs module types-boto3-pinpoint-email.
How to install#
Generate locally (recommended)#
You can generate type annotations for boto3
package locally with mypy-boto3-builder
.
Use uv for build isolation.
- Run mypy-boto3-builder in your package root directory:
uvx --with 'boto3==1.36.26' mypy-boto3-builder
- Select
boto3
AWS SDK. - Add
PinpointEmail
service. - Use provided commands to install generated packages.
VSCode extension#
Add AWS Boto3
extension to your VSCode and run AWS boto3: Quick Start
command.
Click Modify
and select boto3 common
and PinpointEmail
.
From PyPI with pip#
Install types-boto3
for PinpointEmail
service.
# install with boto3 type annotations
python -m pip install 'types-boto3[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 'types-boto3-lite[pinpoint-email]'
# standalone installation
python -m pip install types-boto3-pinpoint-email
How to uninstall#
python -m pip uninstall -y types-boto3-pinpoint-email
Usage#
Code samples can be found in Examples.
PinpointEmailClient#
Type annotations and code completion for boto3.client("pinpoint-email")
as PinpointEmailClient
boto3 documentation
# PinpointEmailClient usage example
from boto3.session import Session
from types_boto3_pinpoint_email.client import PinpointEmailClient
def get_client() -> PinpointEmailClient:
return Session().client("pinpoint-email")
Paginators#
Type annotations and code completion for paginators
from boto3.client("pinpoint-email").get_paginator("...")
.
# GetDedicatedIpsPaginator usage example
from boto3.session import Session
from types_boto3_pinpoint_email.paginator import GetDedicatedIpsPaginator
def get_get_dedicated_ips_paginator() -> GetDedicatedIpsPaginator:
return Session().client("pinpoint-email").get_paginator("get_dedicated_ips"))
- GetDedicatedIpsPaginator
- ListConfigurationSetsPaginator
- ListDedicatedIpPoolsPaginator
- ListDeliverabilityTestReportsPaginator
- ListEmailIdentitiesPaginator
Literals#
Type annotations for literals used in methods and schema.
# BehaviorOnMxFailureType usage example
from types_boto3_pinpoint_email.literals import BehaviorOnMxFailureType
def get_value() -> BehaviorOnMxFailureType:
return "REJECT_MESSAGE"
- BehaviorOnMxFailureType
- DeliverabilityDashboardAccountStatusType
- DeliverabilityTestStatusType
- DimensionValueSourceType
- DkimStatusType
- EventTypeType
- GetDedicatedIpsPaginatorName
- IdentityTypeType
- ListConfigurationSetsPaginatorName
- ListDedicatedIpPoolsPaginatorName
- ListDeliverabilityTestReportsPaginatorName
- ListEmailIdentitiesPaginatorName
- MailFromDomainStatusType
- TlsPolicyType
- WarmupStatusType
- PinpointEmailServiceName
- ServiceName
- ResourceServiceName
- PaginatorName
- RegionName
Type definitions#
Type annotations for type definitions used in methods and schema.
- BlacklistEntryTypeDef
- BlobTypeDef
- ContentTypeDef
- CloudWatchDimensionConfigurationTypeDef
- DeliveryOptionsTypeDef
- SendingOptionsTypeDef
- TagTypeDef
- TrackingOptionsTypeDef
- ResponseMetadataTypeDef
- DkimAttributesTypeDef
- DomainIspPlacementTypeDef
- VolumeStatisticsTypeDef
- DedicatedIpTypeDef
- DeleteConfigurationSetEventDestinationRequestTypeDef
- DeleteConfigurationSetRequestTypeDef
- DeleteDedicatedIpPoolRequestTypeDef
- DeleteEmailIdentityRequestTypeDef
- DeliverabilityTestReportTypeDef
- DestinationTypeDef
- DomainDeliverabilityCampaignTypeDef
- InboxPlacementTrackingOptionOutputTypeDef
- TimestampTypeDef
- TemplateTypeDef
- KinesisFirehoseDestinationTypeDef
- PinpointDestinationTypeDef
- SnsDestinationTypeDef
- SendQuotaTypeDef
- GetBlacklistReportsRequestTypeDef
- GetConfigurationSetEventDestinationsRequestTypeDef
- GetConfigurationSetRequestTypeDef
- ReputationOptionsOutputTypeDef
- GetDedicatedIpRequestTypeDef
- PaginatorConfigTypeDef
- GetDedicatedIpsRequestTypeDef
- GetDeliverabilityTestReportRequestTypeDef
- PlacementStatisticsTypeDef
- GetDomainDeliverabilityCampaignRequestTypeDef
- GetEmailIdentityRequestTypeDef
- MailFromAttributesTypeDef
- IdentityInfoTypeDef
- InboxPlacementTrackingOptionTypeDef
- ListConfigurationSetsRequestTypeDef
- ListDedicatedIpPoolsRequestTypeDef
- ListDeliverabilityTestReportsRequestTypeDef
- ListEmailIdentitiesRequestTypeDef
- ListTagsForResourceRequestTypeDef
- MessageTagTypeDef
- PutAccountDedicatedIpWarmupAttributesRequestTypeDef
- PutAccountSendingAttributesRequestTypeDef
- PutConfigurationSetDeliveryOptionsRequestTypeDef
- PutConfigurationSetReputationOptionsRequestTypeDef
- PutConfigurationSetSendingOptionsRequestTypeDef
- PutConfigurationSetTrackingOptionsRequestTypeDef
- PutDedicatedIpInPoolRequestTypeDef
- PutDedicatedIpWarmupAttributesRequestTypeDef
- PutEmailIdentityDkimAttributesRequestTypeDef
- PutEmailIdentityFeedbackAttributesRequestTypeDef
- PutEmailIdentityMailFromAttributesRequestTypeDef
- UntagResourceRequestTypeDef
- RawMessageTypeDef
- BodyTypeDef
- CloudWatchDestinationOutputTypeDef
- CloudWatchDestinationTypeDef
- CreateDedicatedIpPoolRequestTypeDef
- CreateEmailIdentityRequestTypeDef
- TagResourceRequestTypeDef
- CreateDeliverabilityTestReportResponseTypeDef
- GetBlacklistReportsResponseTypeDef
- ListConfigurationSetsResponseTypeDef
- ListDedicatedIpPoolsResponseTypeDef
- ListTagsForResourceResponseTypeDef
- SendEmailResponseTypeDef
- CreateEmailIdentityResponseTypeDef
- DailyVolumeTypeDef
- OverallVolumeTypeDef
- GetDedicatedIpResponseTypeDef
- GetDedicatedIpsResponseTypeDef
- ListDeliverabilityTestReportsResponseTypeDef
- GetDomainDeliverabilityCampaignResponseTypeDef
- ListDomainDeliverabilityCampaignsResponseTypeDef
- DomainDeliverabilityTrackingOptionOutputTypeDef
- GetDomainStatisticsReportRequestTypeDef
- ListDomainDeliverabilityCampaignsRequestTypeDef
- ReputationOptionsTypeDef
- GetAccountResponseTypeDef
- GetConfigurationSetResponseTypeDef
- GetDedicatedIpsRequestPaginateTypeDef
- ListConfigurationSetsRequestPaginateTypeDef
- ListDedicatedIpPoolsRequestPaginateTypeDef
- ListDeliverabilityTestReportsRequestPaginateTypeDef
- ListEmailIdentitiesRequestPaginateTypeDef
- IspPlacementTypeDef
- GetEmailIdentityResponseTypeDef
- ListEmailIdentitiesResponseTypeDef
- InboxPlacementTrackingOptionUnionTypeDef
- MessageTypeDef
- EventDestinationTypeDef
- CloudWatchDestinationUnionTypeDef
- GetDomainStatisticsReportResponseTypeDef
- GetDeliverabilityDashboardOptionsResponseTypeDef
- ReputationOptionsUnionTypeDef
- GetDeliverabilityTestReportResponseTypeDef
- DomainDeliverabilityTrackingOptionTypeDef
- EmailContentTypeDef
- GetConfigurationSetEventDestinationsResponseTypeDef
- EventDestinationDefinitionTypeDef
- CreateConfigurationSetRequestTypeDef
- DomainDeliverabilityTrackingOptionUnionTypeDef
- CreateDeliverabilityTestReportRequestTypeDef
- SendEmailRequestTypeDef
- CreateConfigurationSetEventDestinationRequestTypeDef
- UpdateConfigurationSetEventDestinationRequestTypeDef
- PutDeliverabilityDashboardOptionRequestTypeDef