Type definitions#
Index > PinpointEmail > Type definitions
Auto-generated documentation for PinpointEmail type annotations stubs module mypy-boto3-pinpoint-email.
BlobTypeDef#
# BlobTypeDef definition
BlobTypeDef = Union[
str,
bytes,
IO[Any],
StreamingBody,
]
TimestampTypeDef#
# TimestampTypeDef definition
TimestampTypeDef = Union[
datetime,
str,
]
BlacklistEntryTypeDef#
# BlacklistEntryTypeDef definition
class BlacklistEntryTypeDef(TypedDict):
RblName: NotRequired[str],
ListingTime: NotRequired[datetime],
Description: NotRequired[str],
ContentTypeDef#
# ContentTypeDef definition
class ContentTypeDef(TypedDict):
Data: str,
Charset: NotRequired[str],
CloudWatchDimensionConfigurationTypeDef#
# CloudWatchDimensionConfigurationTypeDef definition
class CloudWatchDimensionConfigurationTypeDef(TypedDict):
DimensionName: str,
DimensionValueSource: DimensionValueSourceType, # (1)
DefaultDimensionValue: str,
DeliveryOptionsTypeDef#
# DeliveryOptionsTypeDef definition
class DeliveryOptionsTypeDef(TypedDict):
TlsPolicy: NotRequired[TlsPolicyType], # (1)
SendingPoolName: NotRequired[str],
- See TlsPolicyType
SendingOptionsTypeDef#
# SendingOptionsTypeDef definition
class SendingOptionsTypeDef(TypedDict):
SendingEnabled: NotRequired[bool],
TagTypeDef#
# TagTypeDef definition
class TagTypeDef(TypedDict):
Key: str,
Value: str,
TrackingOptionsTypeDef#
# TrackingOptionsTypeDef definition
class TrackingOptionsTypeDef(TypedDict):
CustomRedirectDomain: str,
ResponseMetadataTypeDef#
# ResponseMetadataTypeDef definition
class ResponseMetadataTypeDef(TypedDict):
RequestId: str,
HostId: str,
HTTPStatusCode: int,
HTTPHeaders: Dict[str, str],
RetryAttempts: int,
DkimAttributesTypeDef#
# DkimAttributesTypeDef definition
class DkimAttributesTypeDef(TypedDict):
SigningEnabled: NotRequired[bool],
Status: NotRequired[DkimStatusType], # (1)
Tokens: NotRequired[List[str]],
- See DkimStatusType
DomainIspPlacementTypeDef#
# DomainIspPlacementTypeDef definition
class DomainIspPlacementTypeDef(TypedDict):
IspName: NotRequired[str],
InboxRawCount: NotRequired[int],
SpamRawCount: NotRequired[int],
InboxPercentage: NotRequired[float],
SpamPercentage: NotRequired[float],
VolumeStatisticsTypeDef#
# VolumeStatisticsTypeDef definition
class VolumeStatisticsTypeDef(TypedDict):
InboxRawCount: NotRequired[int],
SpamRawCount: NotRequired[int],
ProjectedInbox: NotRequired[int],
ProjectedSpam: NotRequired[int],
DedicatedIpTypeDef#
# DedicatedIpTypeDef definition
class DedicatedIpTypeDef(TypedDict):
Ip: str,
WarmupStatus: WarmupStatusType, # (1)
WarmupPercentage: int,
PoolName: NotRequired[str],
- See WarmupStatusType
DeleteConfigurationSetEventDestinationRequestRequestTypeDef#
# DeleteConfigurationSetEventDestinationRequestRequestTypeDef definition
class DeleteConfigurationSetEventDestinationRequestRequestTypeDef(TypedDict):
ConfigurationSetName: str,
EventDestinationName: str,
DeleteConfigurationSetRequestRequestTypeDef#
# DeleteConfigurationSetRequestRequestTypeDef definition
class DeleteConfigurationSetRequestRequestTypeDef(TypedDict):
ConfigurationSetName: str,
DeleteDedicatedIpPoolRequestRequestTypeDef#
# DeleteDedicatedIpPoolRequestRequestTypeDef definition
class DeleteDedicatedIpPoolRequestRequestTypeDef(TypedDict):
PoolName: str,
DeleteEmailIdentityRequestRequestTypeDef#
# DeleteEmailIdentityRequestRequestTypeDef definition
class DeleteEmailIdentityRequestRequestTypeDef(TypedDict):
EmailIdentity: str,
DeliverabilityTestReportTypeDef#
# DeliverabilityTestReportTypeDef definition
class DeliverabilityTestReportTypeDef(TypedDict):
ReportId: NotRequired[str],
ReportName: NotRequired[str],
Subject: NotRequired[str],
FromEmailAddress: NotRequired[str],
CreateDate: NotRequired[datetime],
DeliverabilityTestStatus: NotRequired[DeliverabilityTestStatusType], # (1)
DestinationTypeDef#
# DestinationTypeDef definition
class DestinationTypeDef(TypedDict):
ToAddresses: NotRequired[Sequence[str]],
CcAddresses: NotRequired[Sequence[str]],
BccAddresses: NotRequired[Sequence[str]],
DomainDeliverabilityCampaignTypeDef#
# DomainDeliverabilityCampaignTypeDef definition
class DomainDeliverabilityCampaignTypeDef(TypedDict):
CampaignId: NotRequired[str],
ImageUrl: NotRequired[str],
Subject: NotRequired[str],
FromAddress: NotRequired[str],
SendingIps: NotRequired[List[str]],
FirstSeenDateTime: NotRequired[datetime],
LastSeenDateTime: NotRequired[datetime],
InboxCount: NotRequired[int],
SpamCount: NotRequired[int],
ReadRate: NotRequired[float],
DeleteRate: NotRequired[float],
ReadDeleteRate: NotRequired[float],
ProjectedVolume: NotRequired[int],
Esps: NotRequired[List[str]],
InboxPlacementTrackingOptionTypeDef#
# InboxPlacementTrackingOptionTypeDef definition
class InboxPlacementTrackingOptionTypeDef(TypedDict):
Global: NotRequired[bool],
TrackedIsps: NotRequired[List[str]],
TemplateTypeDef#
# TemplateTypeDef definition
class TemplateTypeDef(TypedDict):
TemplateArn: NotRequired[str],
TemplateData: NotRequired[str],
KinesisFirehoseDestinationTypeDef#
# KinesisFirehoseDestinationTypeDef definition
class KinesisFirehoseDestinationTypeDef(TypedDict):
IamRoleArn: str,
DeliveryStreamArn: str,
PinpointDestinationTypeDef#
# PinpointDestinationTypeDef definition
class PinpointDestinationTypeDef(TypedDict):
ApplicationArn: NotRequired[str],
SnsDestinationTypeDef#
# SnsDestinationTypeDef definition
class SnsDestinationTypeDef(TypedDict):
TopicArn: str,
SendQuotaTypeDef#
# SendQuotaTypeDef definition
class SendQuotaTypeDef(TypedDict):
Max24HourSend: NotRequired[float],
MaxSendRate: NotRequired[float],
SentLast24Hours: NotRequired[float],
GetBlacklistReportsRequestRequestTypeDef#
# GetBlacklistReportsRequestRequestTypeDef definition
class GetBlacklistReportsRequestRequestTypeDef(TypedDict):
BlacklistItemNames: Sequence[str],
GetConfigurationSetEventDestinationsRequestRequestTypeDef#
# GetConfigurationSetEventDestinationsRequestRequestTypeDef definition
class GetConfigurationSetEventDestinationsRequestRequestTypeDef(TypedDict):
ConfigurationSetName: str,
GetConfigurationSetRequestRequestTypeDef#
# GetConfigurationSetRequestRequestTypeDef definition
class GetConfigurationSetRequestRequestTypeDef(TypedDict):
ConfigurationSetName: str,
GetDedicatedIpRequestRequestTypeDef#
# GetDedicatedIpRequestRequestTypeDef definition
class GetDedicatedIpRequestRequestTypeDef(TypedDict):
Ip: str,
PaginatorConfigTypeDef#
# PaginatorConfigTypeDef definition
class PaginatorConfigTypeDef(TypedDict):
MaxItems: NotRequired[int],
PageSize: NotRequired[int],
StartingToken: NotRequired[str],
GetDedicatedIpsRequestRequestTypeDef#
# GetDedicatedIpsRequestRequestTypeDef definition
class GetDedicatedIpsRequestRequestTypeDef(TypedDict):
PoolName: NotRequired[str],
NextToken: NotRequired[str],
PageSize: NotRequired[int],
GetDeliverabilityTestReportRequestRequestTypeDef#
# GetDeliverabilityTestReportRequestRequestTypeDef definition
class GetDeliverabilityTestReportRequestRequestTypeDef(TypedDict):
ReportId: str,
PlacementStatisticsTypeDef#
# PlacementStatisticsTypeDef definition
class PlacementStatisticsTypeDef(TypedDict):
InboxPercentage: NotRequired[float],
SpamPercentage: NotRequired[float],
MissingPercentage: NotRequired[float],
SpfPercentage: NotRequired[float],
DkimPercentage: NotRequired[float],
GetDomainDeliverabilityCampaignRequestRequestTypeDef#
# GetDomainDeliverabilityCampaignRequestRequestTypeDef definition
class GetDomainDeliverabilityCampaignRequestRequestTypeDef(TypedDict):
CampaignId: str,
GetEmailIdentityRequestRequestTypeDef#
# GetEmailIdentityRequestRequestTypeDef definition
class GetEmailIdentityRequestRequestTypeDef(TypedDict):
EmailIdentity: str,
MailFromAttributesTypeDef#
# MailFromAttributesTypeDef definition
class MailFromAttributesTypeDef(TypedDict):
MailFromDomain: str,
MailFromDomainStatus: MailFromDomainStatusType, # (1)
BehaviorOnMxFailure: BehaviorOnMxFailureType, # (2)
IdentityInfoTypeDef#
# IdentityInfoTypeDef definition
class IdentityInfoTypeDef(TypedDict):
IdentityType: NotRequired[IdentityTypeType], # (1)
IdentityName: NotRequired[str],
SendingEnabled: NotRequired[bool],
- See IdentityTypeType
ListConfigurationSetsRequestRequestTypeDef#
# ListConfigurationSetsRequestRequestTypeDef definition
class ListConfigurationSetsRequestRequestTypeDef(TypedDict):
NextToken: NotRequired[str],
PageSize: NotRequired[int],
ListDedicatedIpPoolsRequestRequestTypeDef#
# ListDedicatedIpPoolsRequestRequestTypeDef definition
class ListDedicatedIpPoolsRequestRequestTypeDef(TypedDict):
NextToken: NotRequired[str],
PageSize: NotRequired[int],
ListDeliverabilityTestReportsRequestRequestTypeDef#
# ListDeliverabilityTestReportsRequestRequestTypeDef definition
class ListDeliverabilityTestReportsRequestRequestTypeDef(TypedDict):
NextToken: NotRequired[str],
PageSize: NotRequired[int],
ListEmailIdentitiesRequestRequestTypeDef#
# ListEmailIdentitiesRequestRequestTypeDef definition
class ListEmailIdentitiesRequestRequestTypeDef(TypedDict):
NextToken: NotRequired[str],
PageSize: NotRequired[int],
ListTagsForResourceRequestRequestTypeDef#
# ListTagsForResourceRequestRequestTypeDef definition
class ListTagsForResourceRequestRequestTypeDef(TypedDict):
ResourceArn: str,
MessageTagTypeDef#
# MessageTagTypeDef definition
class MessageTagTypeDef(TypedDict):
Name: str,
Value: str,
PutAccountDedicatedIpWarmupAttributesRequestRequestTypeDef#
# PutAccountDedicatedIpWarmupAttributesRequestRequestTypeDef definition
class PutAccountDedicatedIpWarmupAttributesRequestRequestTypeDef(TypedDict):
AutoWarmupEnabled: NotRequired[bool],
PutAccountSendingAttributesRequestRequestTypeDef#
# PutAccountSendingAttributesRequestRequestTypeDef definition
class PutAccountSendingAttributesRequestRequestTypeDef(TypedDict):
SendingEnabled: NotRequired[bool],
PutConfigurationSetDeliveryOptionsRequestRequestTypeDef#
# PutConfigurationSetDeliveryOptionsRequestRequestTypeDef definition
class PutConfigurationSetDeliveryOptionsRequestRequestTypeDef(TypedDict):
ConfigurationSetName: str,
TlsPolicy: NotRequired[TlsPolicyType], # (1)
SendingPoolName: NotRequired[str],
- See TlsPolicyType
PutConfigurationSetReputationOptionsRequestRequestTypeDef#
# PutConfigurationSetReputationOptionsRequestRequestTypeDef definition
class PutConfigurationSetReputationOptionsRequestRequestTypeDef(TypedDict):
ConfigurationSetName: str,
ReputationMetricsEnabled: NotRequired[bool],
PutConfigurationSetSendingOptionsRequestRequestTypeDef#
# PutConfigurationSetSendingOptionsRequestRequestTypeDef definition
class PutConfigurationSetSendingOptionsRequestRequestTypeDef(TypedDict):
ConfigurationSetName: str,
SendingEnabled: NotRequired[bool],
PutConfigurationSetTrackingOptionsRequestRequestTypeDef#
# PutConfigurationSetTrackingOptionsRequestRequestTypeDef definition
class PutConfigurationSetTrackingOptionsRequestRequestTypeDef(TypedDict):
ConfigurationSetName: str,
CustomRedirectDomain: NotRequired[str],
PutDedicatedIpInPoolRequestRequestTypeDef#
# PutDedicatedIpInPoolRequestRequestTypeDef definition
class PutDedicatedIpInPoolRequestRequestTypeDef(TypedDict):
Ip: str,
DestinationPoolName: str,
PutDedicatedIpWarmupAttributesRequestRequestTypeDef#
# PutDedicatedIpWarmupAttributesRequestRequestTypeDef definition
class PutDedicatedIpWarmupAttributesRequestRequestTypeDef(TypedDict):
Ip: str,
WarmupPercentage: int,
PutEmailIdentityDkimAttributesRequestRequestTypeDef#
# PutEmailIdentityDkimAttributesRequestRequestTypeDef definition
class PutEmailIdentityDkimAttributesRequestRequestTypeDef(TypedDict):
EmailIdentity: str,
SigningEnabled: NotRequired[bool],
PutEmailIdentityFeedbackAttributesRequestRequestTypeDef#
# PutEmailIdentityFeedbackAttributesRequestRequestTypeDef definition
class PutEmailIdentityFeedbackAttributesRequestRequestTypeDef(TypedDict):
EmailIdentity: str,
EmailForwardingEnabled: NotRequired[bool],
PutEmailIdentityMailFromAttributesRequestRequestTypeDef#
# PutEmailIdentityMailFromAttributesRequestRequestTypeDef definition
class PutEmailIdentityMailFromAttributesRequestRequestTypeDef(TypedDict):
EmailIdentity: str,
MailFromDomain: NotRequired[str],
BehaviorOnMxFailure: NotRequired[BehaviorOnMxFailureType], # (1)
UntagResourceRequestRequestTypeDef#
# UntagResourceRequestRequestTypeDef definition
class UntagResourceRequestRequestTypeDef(TypedDict):
ResourceArn: str,
TagKeys: Sequence[str],
RawMessageTypeDef#
# RawMessageTypeDef definition
class RawMessageTypeDef(TypedDict):
Data: Union[str, bytes, IO[Any], StreamingBody],
BodyTypeDef#
# BodyTypeDef definition
class BodyTypeDef(TypedDict):
Text: NotRequired[ContentTypeDef], # (1)
Html: NotRequired[ContentTypeDef], # (1)
- See ContentTypeDef
- See ContentTypeDef
CloudWatchDestinationTypeDef#
# CloudWatchDestinationTypeDef definition
class CloudWatchDestinationTypeDef(TypedDict):
DimensionConfigurations: Sequence[CloudWatchDimensionConfigurationTypeDef], # (1)
CreateDedicatedIpPoolRequestRequestTypeDef#
# CreateDedicatedIpPoolRequestRequestTypeDef definition
class CreateDedicatedIpPoolRequestRequestTypeDef(TypedDict):
PoolName: str,
Tags: NotRequired[Sequence[TagTypeDef]], # (1)
- See TagTypeDef
CreateEmailIdentityRequestRequestTypeDef#
# CreateEmailIdentityRequestRequestTypeDef definition
class CreateEmailIdentityRequestRequestTypeDef(TypedDict):
EmailIdentity: str,
Tags: NotRequired[Sequence[TagTypeDef]], # (1)
- See TagTypeDef
TagResourceRequestRequestTypeDef#
# TagResourceRequestRequestTypeDef definition
class TagResourceRequestRequestTypeDef(TypedDict):
ResourceArn: str,
Tags: Sequence[TagTypeDef], # (1)
- See TagTypeDef
CreateDeliverabilityTestReportResponseTypeDef#
# CreateDeliverabilityTestReportResponseTypeDef definition
class CreateDeliverabilityTestReportResponseTypeDef(TypedDict):
ReportId: str,
DeliverabilityTestStatus: DeliverabilityTestStatusType, # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
GetBlacklistReportsResponseTypeDef#
# GetBlacklistReportsResponseTypeDef definition
class GetBlacklistReportsResponseTypeDef(TypedDict):
BlacklistReport: Dict[str, List[BlacklistEntryTypeDef]], # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
ListConfigurationSetsResponseTypeDef#
# ListConfigurationSetsResponseTypeDef definition
class ListConfigurationSetsResponseTypeDef(TypedDict):
ConfigurationSets: List[str],
NextToken: str,
ResponseMetadata: ResponseMetadataTypeDef, # (1)
ListDedicatedIpPoolsResponseTypeDef#
# ListDedicatedIpPoolsResponseTypeDef definition
class ListDedicatedIpPoolsResponseTypeDef(TypedDict):
DedicatedIpPools: List[str],
NextToken: str,
ResponseMetadata: ResponseMetadataTypeDef, # (1)
ListTagsForResourceResponseTypeDef#
# ListTagsForResourceResponseTypeDef definition
class ListTagsForResourceResponseTypeDef(TypedDict):
Tags: List[TagTypeDef], # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
- See TagTypeDef
- See ResponseMetadataTypeDef
SendEmailResponseTypeDef#
# SendEmailResponseTypeDef definition
class SendEmailResponseTypeDef(TypedDict):
MessageId: str,
ResponseMetadata: ResponseMetadataTypeDef, # (1)
CreateEmailIdentityResponseTypeDef#
# CreateEmailIdentityResponseTypeDef definition
class CreateEmailIdentityResponseTypeDef(TypedDict):
IdentityType: IdentityTypeType, # (1)
VerifiedForSendingStatus: bool,
DkimAttributes: DkimAttributesTypeDef, # (2)
ResponseMetadata: ResponseMetadataTypeDef, # (3)
DailyVolumeTypeDef#
# DailyVolumeTypeDef definition
class DailyVolumeTypeDef(TypedDict):
StartDate: NotRequired[datetime],
VolumeStatistics: NotRequired[VolumeStatisticsTypeDef], # (1)
DomainIspPlacements: NotRequired[List[DomainIspPlacementTypeDef]], # (2)
OverallVolumeTypeDef#
# OverallVolumeTypeDef definition
class OverallVolumeTypeDef(TypedDict):
VolumeStatistics: NotRequired[VolumeStatisticsTypeDef], # (1)
ReadRatePercent: NotRequired[float],
DomainIspPlacements: NotRequired[List[DomainIspPlacementTypeDef]], # (2)
GetDedicatedIpResponseTypeDef#
# GetDedicatedIpResponseTypeDef definition
class GetDedicatedIpResponseTypeDef(TypedDict):
DedicatedIp: DedicatedIpTypeDef, # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
GetDedicatedIpsResponseTypeDef#
# GetDedicatedIpsResponseTypeDef definition
class GetDedicatedIpsResponseTypeDef(TypedDict):
DedicatedIps: List[DedicatedIpTypeDef], # (1)
NextToken: str,
ResponseMetadata: ResponseMetadataTypeDef, # (2)
ListDeliverabilityTestReportsResponseTypeDef#
# ListDeliverabilityTestReportsResponseTypeDef definition
class ListDeliverabilityTestReportsResponseTypeDef(TypedDict):
DeliverabilityTestReports: List[DeliverabilityTestReportTypeDef], # (1)
NextToken: str,
ResponseMetadata: ResponseMetadataTypeDef, # (2)
GetDomainDeliverabilityCampaignResponseTypeDef#
# GetDomainDeliverabilityCampaignResponseTypeDef definition
class GetDomainDeliverabilityCampaignResponseTypeDef(TypedDict):
DomainDeliverabilityCampaign: DomainDeliverabilityCampaignTypeDef, # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)