Skip to content

Type definitions#

Index > PinpointEmail > Type definitions

Auto-generated documentation for PinpointEmail type annotations stubs module mypy-boto3-pinpoint-email.

BlobTypeDef#

# BlobTypeDef Union usage example

from mypy_boto3_pinpoint_email.type_defs import BlobTypeDef


def get_value() -> BlobTypeDef:
    return ...


# BlobTypeDef definition

BlobTypeDef = Union[
    str,
    bytes,
    IO[Any],
    botocore.response.StreamingBody,
]

TimestampTypeDef#

# TimestampTypeDef Union usage example

from mypy_boto3_pinpoint_email.type_defs import TimestampTypeDef


def get_value() -> TimestampTypeDef:
    return ...


# TimestampTypeDef definition

TimestampTypeDef = Union[
    datetime.datetime,
    str,
]

InboxPlacementTrackingOptionUnionTypeDef#

# InboxPlacementTrackingOptionUnionTypeDef Union usage example

from mypy_boto3_pinpoint_email.type_defs import InboxPlacementTrackingOptionUnionTypeDef


def get_value() -> InboxPlacementTrackingOptionUnionTypeDef:
    return ...


# InboxPlacementTrackingOptionUnionTypeDef definition

InboxPlacementTrackingOptionUnionTypeDef = Union[
    InboxPlacementTrackingOptionTypeDef,  # (1)
    InboxPlacementTrackingOptionOutputTypeDef,  # (2)
]
  1. See InboxPlacementTrackingOptionTypeDef
  2. See InboxPlacementTrackingOptionOutputTypeDef

CloudWatchDestinationUnionTypeDef#

# CloudWatchDestinationUnionTypeDef Union usage example

from mypy_boto3_pinpoint_email.type_defs import CloudWatchDestinationUnionTypeDef


def get_value() -> CloudWatchDestinationUnionTypeDef:
    return ...


# CloudWatchDestinationUnionTypeDef definition

CloudWatchDestinationUnionTypeDef = Union[
    CloudWatchDestinationTypeDef,  # (1)
    CloudWatchDestinationOutputTypeDef,  # (2)
]
  1. See CloudWatchDestinationTypeDef
  2. See CloudWatchDestinationOutputTypeDef

ReputationOptionsUnionTypeDef#

# ReputationOptionsUnionTypeDef Union usage example

from mypy_boto3_pinpoint_email.type_defs import ReputationOptionsUnionTypeDef


def get_value() -> ReputationOptionsUnionTypeDef:
    return ...


# ReputationOptionsUnionTypeDef definition

ReputationOptionsUnionTypeDef = Union[
    ReputationOptionsTypeDef,  # (1)
    ReputationOptionsOutputTypeDef,  # (2)
]
  1. See ReputationOptionsTypeDef
  2. See ReputationOptionsOutputTypeDef

DomainDeliverabilityTrackingOptionUnionTypeDef#

# DomainDeliverabilityTrackingOptionUnionTypeDef Union usage example

from mypy_boto3_pinpoint_email.type_defs import DomainDeliverabilityTrackingOptionUnionTypeDef


def get_value() -> DomainDeliverabilityTrackingOptionUnionTypeDef:
    return ...


# DomainDeliverabilityTrackingOptionUnionTypeDef definition

DomainDeliverabilityTrackingOptionUnionTypeDef = Union[
    DomainDeliverabilityTrackingOptionTypeDef,  # (1)
    DomainDeliverabilityTrackingOptionOutputTypeDef,  # (2)
]
  1. See DomainDeliverabilityTrackingOptionTypeDef
  2. See DomainDeliverabilityTrackingOptionOutputTypeDef

BlacklistEntryTypeDef#

# BlacklistEntryTypeDef TypedDict usage example

from mypy_boto3_pinpoint_email.type_defs import BlacklistEntryTypeDef


def get_value() -> BlacklistEntryTypeDef:
    return {
        "RblName": ...,
    }


# BlacklistEntryTypeDef definition

class BlacklistEntryTypeDef(TypedDict):
    RblName: NotRequired[str],
    ListingTime: NotRequired[datetime.datetime],
    Description: NotRequired[str],

ContentTypeDef#

# ContentTypeDef TypedDict usage example

from mypy_boto3_pinpoint_email.type_defs import ContentTypeDef


def get_value() -> ContentTypeDef:
    return {
        "Data": ...,
    }


# ContentTypeDef definition

class ContentTypeDef(TypedDict):
    Data: str,
    Charset: NotRequired[str],

CloudWatchDimensionConfigurationTypeDef#

# CloudWatchDimensionConfigurationTypeDef TypedDict usage example

from mypy_boto3_pinpoint_email.type_defs import CloudWatchDimensionConfigurationTypeDef


def get_value() -> CloudWatchDimensionConfigurationTypeDef:
    return {
        "DimensionName": ...,
    }


# CloudWatchDimensionConfigurationTypeDef definition

class CloudWatchDimensionConfigurationTypeDef(TypedDict):
    DimensionName: str,
    DimensionValueSource: DimensionValueSourceType,  # (1)
    DefaultDimensionValue: str,
  1. See DimensionValueSourceType

DeliveryOptionsTypeDef#

# DeliveryOptionsTypeDef TypedDict usage example

from mypy_boto3_pinpoint_email.type_defs import DeliveryOptionsTypeDef


def get_value() -> DeliveryOptionsTypeDef:
    return {
        "TlsPolicy": ...,
    }


# DeliveryOptionsTypeDef definition

class DeliveryOptionsTypeDef(TypedDict):
    TlsPolicy: NotRequired[TlsPolicyType],  # (1)
    SendingPoolName: NotRequired[str],
  1. See TlsPolicyType

SendingOptionsTypeDef#

# SendingOptionsTypeDef TypedDict usage example

from mypy_boto3_pinpoint_email.type_defs import SendingOptionsTypeDef


def get_value() -> SendingOptionsTypeDef:
    return {
        "SendingEnabled": ...,
    }


# SendingOptionsTypeDef definition

class SendingOptionsTypeDef(TypedDict):
    SendingEnabled: NotRequired[bool],

TagTypeDef#

# TagTypeDef TypedDict usage example

from mypy_boto3_pinpoint_email.type_defs import TagTypeDef


def get_value() -> TagTypeDef:
    return {
        "Key": ...,
    }


# TagTypeDef definition

class TagTypeDef(TypedDict):
    Key: str,
    Value: str,

TrackingOptionsTypeDef#

# TrackingOptionsTypeDef TypedDict usage example

from mypy_boto3_pinpoint_email.type_defs import TrackingOptionsTypeDef


def get_value() -> TrackingOptionsTypeDef:
    return {
        "CustomRedirectDomain": ...,
    }


# TrackingOptionsTypeDef definition

class TrackingOptionsTypeDef(TypedDict):
    CustomRedirectDomain: str,

ResponseMetadataTypeDef#

# ResponseMetadataTypeDef TypedDict usage example

from mypy_boto3_pinpoint_email.type_defs import ResponseMetadataTypeDef


def get_value() -> ResponseMetadataTypeDef:
    return {
        "RequestId": ...,
    }


# ResponseMetadataTypeDef definition

class ResponseMetadataTypeDef(TypedDict):
    RequestId: str,
    HTTPStatusCode: int,
    HTTPHeaders: Dict[str, str],
    RetryAttempts: int,
    HostId: NotRequired[str],

DkimAttributesTypeDef#

# DkimAttributesTypeDef TypedDict usage example

from mypy_boto3_pinpoint_email.type_defs import DkimAttributesTypeDef


def get_value() -> DkimAttributesTypeDef:
    return {
        "SigningEnabled": ...,
    }


# DkimAttributesTypeDef definition

class DkimAttributesTypeDef(TypedDict):
    SigningEnabled: NotRequired[bool],
    Status: NotRequired[DkimStatusType],  # (1)
    Tokens: NotRequired[List[str]],
  1. See DkimStatusType

DomainIspPlacementTypeDef#

# DomainIspPlacementTypeDef TypedDict usage example

from mypy_boto3_pinpoint_email.type_defs import DomainIspPlacementTypeDef


def get_value() -> DomainIspPlacementTypeDef:
    return {
        "IspName": ...,
    }


# DomainIspPlacementTypeDef definition

class DomainIspPlacementTypeDef(TypedDict):
    IspName: NotRequired[str],
    InboxRawCount: NotRequired[int],
    SpamRawCount: NotRequired[int],
    InboxPercentage: NotRequired[float],
    SpamPercentage: NotRequired[float],

VolumeStatisticsTypeDef#

# VolumeStatisticsTypeDef TypedDict usage example

from mypy_boto3_pinpoint_email.type_defs import VolumeStatisticsTypeDef


def get_value() -> VolumeStatisticsTypeDef:
    return {
        "InboxRawCount": ...,
    }


# VolumeStatisticsTypeDef definition

class VolumeStatisticsTypeDef(TypedDict):
    InboxRawCount: NotRequired[int],
    SpamRawCount: NotRequired[int],
    ProjectedInbox: NotRequired[int],
    ProjectedSpam: NotRequired[int],

DedicatedIpTypeDef#

# DedicatedIpTypeDef TypedDict usage example

from mypy_boto3_pinpoint_email.type_defs import DedicatedIpTypeDef


def get_value() -> DedicatedIpTypeDef:
    return {
        "Ip": ...,
    }


# DedicatedIpTypeDef definition

class DedicatedIpTypeDef(TypedDict):
    Ip: str,
    WarmupStatus: WarmupStatusType,  # (1)
    WarmupPercentage: int,
    PoolName: NotRequired[str],
  1. See WarmupStatusType

DeleteConfigurationSetEventDestinationRequestTypeDef#

# DeleteConfigurationSetEventDestinationRequestTypeDef TypedDict usage example

from mypy_boto3_pinpoint_email.type_defs import DeleteConfigurationSetEventDestinationRequestTypeDef


def get_value() -> DeleteConfigurationSetEventDestinationRequestTypeDef:
    return {
        "ConfigurationSetName": ...,
    }


# DeleteConfigurationSetEventDestinationRequestTypeDef definition

class DeleteConfigurationSetEventDestinationRequestTypeDef(TypedDict):
    ConfigurationSetName: str,
    EventDestinationName: str,

DeleteConfigurationSetRequestTypeDef#

# DeleteConfigurationSetRequestTypeDef TypedDict usage example

from mypy_boto3_pinpoint_email.type_defs import DeleteConfigurationSetRequestTypeDef


def get_value() -> DeleteConfigurationSetRequestTypeDef:
    return {
        "ConfigurationSetName": ...,
    }


# DeleteConfigurationSetRequestTypeDef definition

class DeleteConfigurationSetRequestTypeDef(TypedDict):
    ConfigurationSetName: str,

DeleteDedicatedIpPoolRequestTypeDef#

# DeleteDedicatedIpPoolRequestTypeDef TypedDict usage example

from mypy_boto3_pinpoint_email.type_defs import DeleteDedicatedIpPoolRequestTypeDef


def get_value() -> DeleteDedicatedIpPoolRequestTypeDef:
    return {
        "PoolName": ...,
    }


# DeleteDedicatedIpPoolRequestTypeDef definition

class DeleteDedicatedIpPoolRequestTypeDef(TypedDict):
    PoolName: str,

DeleteEmailIdentityRequestTypeDef#

# DeleteEmailIdentityRequestTypeDef TypedDict usage example

from mypy_boto3_pinpoint_email.type_defs import DeleteEmailIdentityRequestTypeDef


def get_value() -> DeleteEmailIdentityRequestTypeDef:
    return {
        "EmailIdentity": ...,
    }


# DeleteEmailIdentityRequestTypeDef definition

class DeleteEmailIdentityRequestTypeDef(TypedDict):
    EmailIdentity: str,

DeliverabilityTestReportTypeDef#

# DeliverabilityTestReportTypeDef TypedDict usage example

from mypy_boto3_pinpoint_email.type_defs import DeliverabilityTestReportTypeDef


def get_value() -> DeliverabilityTestReportTypeDef:
    return {
        "ReportId": ...,
    }


# DeliverabilityTestReportTypeDef definition

class DeliverabilityTestReportTypeDef(TypedDict):
    ReportId: NotRequired[str],
    ReportName: NotRequired[str],
    Subject: NotRequired[str],
    FromEmailAddress: NotRequired[str],
    CreateDate: NotRequired[datetime.datetime],
    DeliverabilityTestStatus: NotRequired[DeliverabilityTestStatusType],  # (1)
  1. See DeliverabilityTestStatusType

DestinationTypeDef#

# DestinationTypeDef TypedDict usage example

from mypy_boto3_pinpoint_email.type_defs import DestinationTypeDef


def get_value() -> DestinationTypeDef:
    return {
        "ToAddresses": ...,
    }


# DestinationTypeDef definition

class DestinationTypeDef(TypedDict):
    ToAddresses: NotRequired[Sequence[str]],
    CcAddresses: NotRequired[Sequence[str]],
    BccAddresses: NotRequired[Sequence[str]],

DomainDeliverabilityCampaignTypeDef#

# DomainDeliverabilityCampaignTypeDef TypedDict usage example

from mypy_boto3_pinpoint_email.type_defs import DomainDeliverabilityCampaignTypeDef


def get_value() -> DomainDeliverabilityCampaignTypeDef:
    return {
        "CampaignId": ...,
    }


# DomainDeliverabilityCampaignTypeDef definition

class DomainDeliverabilityCampaignTypeDef(TypedDict):
    CampaignId: NotRequired[str],
    ImageUrl: NotRequired[str],
    Subject: NotRequired[str],
    FromAddress: NotRequired[str],
    SendingIps: NotRequired[List[str]],
    FirstSeenDateTime: NotRequired[datetime.datetime],
    LastSeenDateTime: NotRequired[datetime.datetime],
    InboxCount: NotRequired[int],
    SpamCount: NotRequired[int],
    ReadRate: NotRequired[float],
    DeleteRate: NotRequired[float],
    ReadDeleteRate: NotRequired[float],
    ProjectedVolume: NotRequired[int],
    Esps: NotRequired[List[str]],

InboxPlacementTrackingOptionOutputTypeDef#

# InboxPlacementTrackingOptionOutputTypeDef TypedDict usage example

from mypy_boto3_pinpoint_email.type_defs import InboxPlacementTrackingOptionOutputTypeDef


def get_value() -> InboxPlacementTrackingOptionOutputTypeDef:
    return {
        "Global": ...,
    }


# InboxPlacementTrackingOptionOutputTypeDef definition

class InboxPlacementTrackingOptionOutputTypeDef(TypedDict):
    Global: NotRequired[bool],
    TrackedIsps: NotRequired[List[str]],

TemplateTypeDef#

# TemplateTypeDef TypedDict usage example

from mypy_boto3_pinpoint_email.type_defs import TemplateTypeDef


def get_value() -> TemplateTypeDef:
    return {
        "TemplateArn": ...,
    }


# TemplateTypeDef definition

class TemplateTypeDef(TypedDict):
    TemplateArn: NotRequired[str],
    TemplateData: NotRequired[str],

KinesisFirehoseDestinationTypeDef#

# KinesisFirehoseDestinationTypeDef TypedDict usage example

from mypy_boto3_pinpoint_email.type_defs import KinesisFirehoseDestinationTypeDef


def get_value() -> KinesisFirehoseDestinationTypeDef:
    return {
        "IamRoleArn": ...,
    }


# KinesisFirehoseDestinationTypeDef definition

class KinesisFirehoseDestinationTypeDef(TypedDict):
    IamRoleArn: str,
    DeliveryStreamArn: str,

PinpointDestinationTypeDef#

# PinpointDestinationTypeDef TypedDict usage example

from mypy_boto3_pinpoint_email.type_defs import PinpointDestinationTypeDef


def get_value() -> PinpointDestinationTypeDef:
    return {
        "ApplicationArn": ...,
    }


# PinpointDestinationTypeDef definition

class PinpointDestinationTypeDef(TypedDict):
    ApplicationArn: NotRequired[str],

SnsDestinationTypeDef#

# SnsDestinationTypeDef TypedDict usage example

from mypy_boto3_pinpoint_email.type_defs import SnsDestinationTypeDef


def get_value() -> SnsDestinationTypeDef:
    return {
        "TopicArn": ...,
    }


# SnsDestinationTypeDef definition

class SnsDestinationTypeDef(TypedDict):
    TopicArn: str,

SendQuotaTypeDef#

# SendQuotaTypeDef TypedDict usage example

from mypy_boto3_pinpoint_email.type_defs import SendQuotaTypeDef


def get_value() -> SendQuotaTypeDef:
    return {
        "Max24HourSend": ...,
    }


# SendQuotaTypeDef definition

class SendQuotaTypeDef(TypedDict):
    Max24HourSend: NotRequired[float],
    MaxSendRate: NotRequired[float],
    SentLast24Hours: NotRequired[float],

GetBlacklistReportsRequestTypeDef#

# GetBlacklistReportsRequestTypeDef TypedDict usage example

from mypy_boto3_pinpoint_email.type_defs import GetBlacklistReportsRequestTypeDef


def get_value() -> GetBlacklistReportsRequestTypeDef:
    return {
        "BlacklistItemNames": ...,
    }


# GetBlacklistReportsRequestTypeDef definition

class GetBlacklistReportsRequestTypeDef(TypedDict):
    BlacklistItemNames: Sequence[str],

GetConfigurationSetEventDestinationsRequestTypeDef#

# GetConfigurationSetEventDestinationsRequestTypeDef TypedDict usage example

from mypy_boto3_pinpoint_email.type_defs import GetConfigurationSetEventDestinationsRequestTypeDef


def get_value() -> GetConfigurationSetEventDestinationsRequestTypeDef:
    return {
        "ConfigurationSetName": ...,
    }


# GetConfigurationSetEventDestinationsRequestTypeDef definition

class GetConfigurationSetEventDestinationsRequestTypeDef(TypedDict):
    ConfigurationSetName: str,

GetConfigurationSetRequestTypeDef#

# GetConfigurationSetRequestTypeDef TypedDict usage example

from mypy_boto3_pinpoint_email.type_defs import GetConfigurationSetRequestTypeDef


def get_value() -> GetConfigurationSetRequestTypeDef:
    return {
        "ConfigurationSetName": ...,
    }


# GetConfigurationSetRequestTypeDef definition

class GetConfigurationSetRequestTypeDef(TypedDict):
    ConfigurationSetName: str,

ReputationOptionsOutputTypeDef#

# ReputationOptionsOutputTypeDef TypedDict usage example

from mypy_boto3_pinpoint_email.type_defs import ReputationOptionsOutputTypeDef


def get_value() -> ReputationOptionsOutputTypeDef:
    return {
        "ReputationMetricsEnabled": ...,
    }


# ReputationOptionsOutputTypeDef definition

class ReputationOptionsOutputTypeDef(TypedDict):
    ReputationMetricsEnabled: NotRequired[bool],
    LastFreshStart: NotRequired[datetime.datetime],

GetDedicatedIpRequestTypeDef#

# GetDedicatedIpRequestTypeDef TypedDict usage example

from mypy_boto3_pinpoint_email.type_defs import GetDedicatedIpRequestTypeDef


def get_value() -> GetDedicatedIpRequestTypeDef:
    return {
        "Ip": ...,
    }


# GetDedicatedIpRequestTypeDef definition

class GetDedicatedIpRequestTypeDef(TypedDict):
    Ip: str,

PaginatorConfigTypeDef#

# PaginatorConfigTypeDef TypedDict usage example

from mypy_boto3_pinpoint_email.type_defs import PaginatorConfigTypeDef


def get_value() -> PaginatorConfigTypeDef:
    return {
        "MaxItems": ...,
    }


# PaginatorConfigTypeDef definition

class PaginatorConfigTypeDef(TypedDict):
    MaxItems: NotRequired[int],
    PageSize: NotRequired[int],
    StartingToken: NotRequired[str],

GetDedicatedIpsRequestTypeDef#

# GetDedicatedIpsRequestTypeDef TypedDict usage example

from mypy_boto3_pinpoint_email.type_defs import GetDedicatedIpsRequestTypeDef


def get_value() -> GetDedicatedIpsRequestTypeDef:
    return {
        "PoolName": ...,
    }


# GetDedicatedIpsRequestTypeDef definition

class GetDedicatedIpsRequestTypeDef(TypedDict):
    PoolName: NotRequired[str],
    NextToken: NotRequired[str],
    PageSize: NotRequired[int],

GetDeliverabilityTestReportRequestTypeDef#

# GetDeliverabilityTestReportRequestTypeDef TypedDict usage example

from mypy_boto3_pinpoint_email.type_defs import GetDeliverabilityTestReportRequestTypeDef


def get_value() -> GetDeliverabilityTestReportRequestTypeDef:
    return {
        "ReportId": ...,
    }


# GetDeliverabilityTestReportRequestTypeDef definition

class GetDeliverabilityTestReportRequestTypeDef(TypedDict):
    ReportId: str,

PlacementStatisticsTypeDef#

# PlacementStatisticsTypeDef TypedDict usage example

from mypy_boto3_pinpoint_email.type_defs import PlacementStatisticsTypeDef


def get_value() -> PlacementStatisticsTypeDef:
    return {
        "InboxPercentage": ...,
    }


# PlacementStatisticsTypeDef definition

class PlacementStatisticsTypeDef(TypedDict):
    InboxPercentage: NotRequired[float],
    SpamPercentage: NotRequired[float],
    MissingPercentage: NotRequired[float],
    SpfPercentage: NotRequired[float],
    DkimPercentage: NotRequired[float],

GetDomainDeliverabilityCampaignRequestTypeDef#

# GetDomainDeliverabilityCampaignRequestTypeDef TypedDict usage example

from mypy_boto3_pinpoint_email.type_defs import GetDomainDeliverabilityCampaignRequestTypeDef


def get_value() -> GetDomainDeliverabilityCampaignRequestTypeDef:
    return {
        "CampaignId": ...,
    }


# GetDomainDeliverabilityCampaignRequestTypeDef definition

class GetDomainDeliverabilityCampaignRequestTypeDef(TypedDict):
    CampaignId: str,

GetEmailIdentityRequestTypeDef#

# GetEmailIdentityRequestTypeDef TypedDict usage example

from mypy_boto3_pinpoint_email.type_defs import GetEmailIdentityRequestTypeDef


def get_value() -> GetEmailIdentityRequestTypeDef:
    return {
        "EmailIdentity": ...,
    }


# GetEmailIdentityRequestTypeDef definition

class GetEmailIdentityRequestTypeDef(TypedDict):
    EmailIdentity: str,

MailFromAttributesTypeDef#

# MailFromAttributesTypeDef TypedDict usage example

from mypy_boto3_pinpoint_email.type_defs import MailFromAttributesTypeDef


def get_value() -> MailFromAttributesTypeDef:
    return {
        "MailFromDomain": ...,
    }


# MailFromAttributesTypeDef definition

class MailFromAttributesTypeDef(TypedDict):
    MailFromDomain: str,
    MailFromDomainStatus: MailFromDomainStatusType,  # (1)
    BehaviorOnMxFailure: BehaviorOnMxFailureType,  # (2)
  1. See MailFromDomainStatusType
  2. See BehaviorOnMxFailureType

IdentityInfoTypeDef#

# IdentityInfoTypeDef TypedDict usage example

from mypy_boto3_pinpoint_email.type_defs import IdentityInfoTypeDef


def get_value() -> IdentityInfoTypeDef:
    return {
        "IdentityType": ...,
    }


# IdentityInfoTypeDef definition

class IdentityInfoTypeDef(TypedDict):
    IdentityType: NotRequired[IdentityTypeType],  # (1)
    IdentityName: NotRequired[str],
    SendingEnabled: NotRequired[bool],
  1. See IdentityTypeType

InboxPlacementTrackingOptionTypeDef#

# InboxPlacementTrackingOptionTypeDef TypedDict usage example

from mypy_boto3_pinpoint_email.type_defs import InboxPlacementTrackingOptionTypeDef


def get_value() -> InboxPlacementTrackingOptionTypeDef:
    return {
        "Global": ...,
    }


# InboxPlacementTrackingOptionTypeDef definition

class InboxPlacementTrackingOptionTypeDef(TypedDict):
    Global: NotRequired[bool],
    TrackedIsps: NotRequired[Sequence[str]],

ListConfigurationSetsRequestTypeDef#

# ListConfigurationSetsRequestTypeDef TypedDict usage example

from mypy_boto3_pinpoint_email.type_defs import ListConfigurationSetsRequestTypeDef


def get_value() -> ListConfigurationSetsRequestTypeDef:
    return {
        "NextToken": ...,
    }


# ListConfigurationSetsRequestTypeDef definition

class ListConfigurationSetsRequestTypeDef(TypedDict):
    NextToken: NotRequired[str],
    PageSize: NotRequired[int],

ListDedicatedIpPoolsRequestTypeDef#

# ListDedicatedIpPoolsRequestTypeDef TypedDict usage example

from mypy_boto3_pinpoint_email.type_defs import ListDedicatedIpPoolsRequestTypeDef


def get_value() -> ListDedicatedIpPoolsRequestTypeDef:
    return {
        "NextToken": ...,
    }


# ListDedicatedIpPoolsRequestTypeDef definition

class ListDedicatedIpPoolsRequestTypeDef(TypedDict):
    NextToken: NotRequired[str],
    PageSize: NotRequired[int],

ListDeliverabilityTestReportsRequestTypeDef#

# ListDeliverabilityTestReportsRequestTypeDef TypedDict usage example

from mypy_boto3_pinpoint_email.type_defs import ListDeliverabilityTestReportsRequestTypeDef


def get_value() -> ListDeliverabilityTestReportsRequestTypeDef:
    return {
        "NextToken": ...,
    }


# ListDeliverabilityTestReportsRequestTypeDef definition

class ListDeliverabilityTestReportsRequestTypeDef(TypedDict):
    NextToken: NotRequired[str],
    PageSize: NotRequired[int],

ListEmailIdentitiesRequestTypeDef#

# ListEmailIdentitiesRequestTypeDef TypedDict usage example

from mypy_boto3_pinpoint_email.type_defs import ListEmailIdentitiesRequestTypeDef


def get_value() -> ListEmailIdentitiesRequestTypeDef:
    return {
        "NextToken": ...,
    }


# ListEmailIdentitiesRequestTypeDef definition

class ListEmailIdentitiesRequestTypeDef(TypedDict):
    NextToken: NotRequired[str],
    PageSize: NotRequired[int],

ListTagsForResourceRequestTypeDef#

# ListTagsForResourceRequestTypeDef TypedDict usage example

from mypy_boto3_pinpoint_email.type_defs import ListTagsForResourceRequestTypeDef


def get_value() -> ListTagsForResourceRequestTypeDef:
    return {
        "ResourceArn": ...,
    }


# ListTagsForResourceRequestTypeDef definition

class ListTagsForResourceRequestTypeDef(TypedDict):
    ResourceArn: str,

MessageTagTypeDef#

# MessageTagTypeDef TypedDict usage example

from mypy_boto3_pinpoint_email.type_defs import MessageTagTypeDef


def get_value() -> MessageTagTypeDef:
    return {
        "Name": ...,
    }


# MessageTagTypeDef definition

class MessageTagTypeDef(TypedDict):
    Name: str,
    Value: str,

PutAccountDedicatedIpWarmupAttributesRequestTypeDef#

# PutAccountDedicatedIpWarmupAttributesRequestTypeDef TypedDict usage example

from mypy_boto3_pinpoint_email.type_defs import PutAccountDedicatedIpWarmupAttributesRequestTypeDef


def get_value() -> PutAccountDedicatedIpWarmupAttributesRequestTypeDef:
    return {
        "AutoWarmupEnabled": ...,
    }


# PutAccountDedicatedIpWarmupAttributesRequestTypeDef definition

class PutAccountDedicatedIpWarmupAttributesRequestTypeDef(TypedDict):
    AutoWarmupEnabled: NotRequired[bool],

PutAccountSendingAttributesRequestTypeDef#

# PutAccountSendingAttributesRequestTypeDef TypedDict usage example

from mypy_boto3_pinpoint_email.type_defs import PutAccountSendingAttributesRequestTypeDef


def get_value() -> PutAccountSendingAttributesRequestTypeDef:
    return {
        "SendingEnabled": ...,
    }


# PutAccountSendingAttributesRequestTypeDef definition

class PutAccountSendingAttributesRequestTypeDef(TypedDict):
    SendingEnabled: NotRequired[bool],

PutConfigurationSetDeliveryOptionsRequestTypeDef#

# PutConfigurationSetDeliveryOptionsRequestTypeDef TypedDict usage example

from mypy_boto3_pinpoint_email.type_defs import PutConfigurationSetDeliveryOptionsRequestTypeDef


def get_value() -> PutConfigurationSetDeliveryOptionsRequestTypeDef:
    return {
        "ConfigurationSetName": ...,
    }


# PutConfigurationSetDeliveryOptionsRequestTypeDef definition

class PutConfigurationSetDeliveryOptionsRequestTypeDef(TypedDict):
    ConfigurationSetName: str,
    TlsPolicy: NotRequired[TlsPolicyType],  # (1)
    SendingPoolName: NotRequired[str],
  1. See TlsPolicyType

PutConfigurationSetReputationOptionsRequestTypeDef#

# PutConfigurationSetReputationOptionsRequestTypeDef TypedDict usage example

from mypy_boto3_pinpoint_email.type_defs import PutConfigurationSetReputationOptionsRequestTypeDef


def get_value() -> PutConfigurationSetReputationOptionsRequestTypeDef:
    return {
        "ConfigurationSetName": ...,
    }


# PutConfigurationSetReputationOptionsRequestTypeDef definition

class PutConfigurationSetReputationOptionsRequestTypeDef(TypedDict):
    ConfigurationSetName: str,
    ReputationMetricsEnabled: NotRequired[bool],

PutConfigurationSetSendingOptionsRequestTypeDef#

# PutConfigurationSetSendingOptionsRequestTypeDef TypedDict usage example

from mypy_boto3_pinpoint_email.type_defs import PutConfigurationSetSendingOptionsRequestTypeDef


def get_value() -> PutConfigurationSetSendingOptionsRequestTypeDef:
    return {
        "ConfigurationSetName": ...,
    }


# PutConfigurationSetSendingOptionsRequestTypeDef definition

class PutConfigurationSetSendingOptionsRequestTypeDef(TypedDict):
    ConfigurationSetName: str,
    SendingEnabled: NotRequired[bool],

PutConfigurationSetTrackingOptionsRequestTypeDef#

# PutConfigurationSetTrackingOptionsRequestTypeDef TypedDict usage example

from mypy_boto3_pinpoint_email.type_defs import PutConfigurationSetTrackingOptionsRequestTypeDef


def get_value() -> PutConfigurationSetTrackingOptionsRequestTypeDef:
    return {
        "ConfigurationSetName": ...,
    }


# PutConfigurationSetTrackingOptionsRequestTypeDef definition

class PutConfigurationSetTrackingOptionsRequestTypeDef(TypedDict):
    ConfigurationSetName: str,
    CustomRedirectDomain: NotRequired[str],

PutDedicatedIpInPoolRequestTypeDef#

# PutDedicatedIpInPoolRequestTypeDef TypedDict usage example

from mypy_boto3_pinpoint_email.type_defs import PutDedicatedIpInPoolRequestTypeDef


def get_value() -> PutDedicatedIpInPoolRequestTypeDef:
    return {
        "Ip": ...,
    }


# PutDedicatedIpInPoolRequestTypeDef definition

class PutDedicatedIpInPoolRequestTypeDef(TypedDict):
    Ip: str,
    DestinationPoolName: str,

PutDedicatedIpWarmupAttributesRequestTypeDef#

# PutDedicatedIpWarmupAttributesRequestTypeDef TypedDict usage example

from mypy_boto3_pinpoint_email.type_defs import PutDedicatedIpWarmupAttributesRequestTypeDef


def get_value() -> PutDedicatedIpWarmupAttributesRequestTypeDef:
    return {
        "Ip": ...,
    }


# PutDedicatedIpWarmupAttributesRequestTypeDef definition

class PutDedicatedIpWarmupAttributesRequestTypeDef(TypedDict):
    Ip: str,
    WarmupPercentage: int,

PutEmailIdentityDkimAttributesRequestTypeDef#

# PutEmailIdentityDkimAttributesRequestTypeDef TypedDict usage example

from mypy_boto3_pinpoint_email.type_defs import PutEmailIdentityDkimAttributesRequestTypeDef


def get_value() -> PutEmailIdentityDkimAttributesRequestTypeDef:
    return {
        "EmailIdentity": ...,
    }


# PutEmailIdentityDkimAttributesRequestTypeDef definition

class PutEmailIdentityDkimAttributesRequestTypeDef(TypedDict):
    EmailIdentity: str,
    SigningEnabled: NotRequired[bool],

PutEmailIdentityFeedbackAttributesRequestTypeDef#

# PutEmailIdentityFeedbackAttributesRequestTypeDef TypedDict usage example

from mypy_boto3_pinpoint_email.type_defs import PutEmailIdentityFeedbackAttributesRequestTypeDef


def get_value() -> PutEmailIdentityFeedbackAttributesRequestTypeDef:
    return {
        "EmailIdentity": ...,
    }


# PutEmailIdentityFeedbackAttributesRequestTypeDef definition

class PutEmailIdentityFeedbackAttributesRequestTypeDef(TypedDict):
    EmailIdentity: str,
    EmailForwardingEnabled: NotRequired[bool],

PutEmailIdentityMailFromAttributesRequestTypeDef#

# PutEmailIdentityMailFromAttributesRequestTypeDef TypedDict usage example

from mypy_boto3_pinpoint_email.type_defs import PutEmailIdentityMailFromAttributesRequestTypeDef


def get_value() -> PutEmailIdentityMailFromAttributesRequestTypeDef:
    return {
        "EmailIdentity": ...,
    }


# PutEmailIdentityMailFromAttributesRequestTypeDef definition

class PutEmailIdentityMailFromAttributesRequestTypeDef(TypedDict):
    EmailIdentity: str,
    MailFromDomain: NotRequired[str],
    BehaviorOnMxFailure: NotRequired[BehaviorOnMxFailureType],  # (1)
  1. See BehaviorOnMxFailureType

UntagResourceRequestTypeDef#

# UntagResourceRequestTypeDef TypedDict usage example

from mypy_boto3_pinpoint_email.type_defs import UntagResourceRequestTypeDef


def get_value() -> UntagResourceRequestTypeDef:
    return {
        "ResourceArn": ...,
    }


# UntagResourceRequestTypeDef definition

class UntagResourceRequestTypeDef(TypedDict):
    ResourceArn: str,
    TagKeys: Sequence[str],

RawMessageTypeDef#

# RawMessageTypeDef TypedDict usage example

from mypy_boto3_pinpoint_email.type_defs import RawMessageTypeDef


def get_value() -> RawMessageTypeDef:
    return {
        "Data": ...,
    }


# RawMessageTypeDef definition

class RawMessageTypeDef(TypedDict):
    Data: BlobTypeDef,

BodyTypeDef#

# BodyTypeDef TypedDict usage example

from mypy_boto3_pinpoint_email.type_defs import BodyTypeDef


def get_value() -> BodyTypeDef:
    return {
        "Text": ...,
    }


# BodyTypeDef definition

class BodyTypeDef(TypedDict):
    Text: NotRequired[ContentTypeDef],  # (1)
    Html: NotRequired[ContentTypeDef],  # (1)
  1. See ContentTypeDef
  2. See ContentTypeDef

CloudWatchDestinationOutputTypeDef#

# CloudWatchDestinationOutputTypeDef TypedDict usage example

from mypy_boto3_pinpoint_email.type_defs import CloudWatchDestinationOutputTypeDef


def get_value() -> CloudWatchDestinationOutputTypeDef:
    return {
        "DimensionConfigurations": ...,
    }


# CloudWatchDestinationOutputTypeDef definition

class CloudWatchDestinationOutputTypeDef(TypedDict):
    DimensionConfigurations: List[CloudWatchDimensionConfigurationTypeDef],  # (1)
  1. See List[CloudWatchDimensionConfigurationTypeDef]

CloudWatchDestinationTypeDef#

# CloudWatchDestinationTypeDef TypedDict usage example

from mypy_boto3_pinpoint_email.type_defs import CloudWatchDestinationTypeDef


def get_value() -> CloudWatchDestinationTypeDef:
    return {
        "DimensionConfigurations": ...,
    }


# CloudWatchDestinationTypeDef definition

class CloudWatchDestinationTypeDef(TypedDict):
    DimensionConfigurations: Sequence[CloudWatchDimensionConfigurationTypeDef],  # (1)
  1. See Sequence[CloudWatchDimensionConfigurationTypeDef]

CreateDedicatedIpPoolRequestTypeDef#

# CreateDedicatedIpPoolRequestTypeDef TypedDict usage example

from mypy_boto3_pinpoint_email.type_defs import CreateDedicatedIpPoolRequestTypeDef


def get_value() -> CreateDedicatedIpPoolRequestTypeDef:
    return {
        "PoolName": ...,
    }


# CreateDedicatedIpPoolRequestTypeDef definition

class CreateDedicatedIpPoolRequestTypeDef(TypedDict):
    PoolName: str,
    Tags: NotRequired[Sequence[TagTypeDef]],  # (1)
  1. See Sequence[TagTypeDef]

CreateEmailIdentityRequestTypeDef#

# CreateEmailIdentityRequestTypeDef TypedDict usage example

from mypy_boto3_pinpoint_email.type_defs import CreateEmailIdentityRequestTypeDef


def get_value() -> CreateEmailIdentityRequestTypeDef:
    return {
        "EmailIdentity": ...,
    }


# CreateEmailIdentityRequestTypeDef definition

class CreateEmailIdentityRequestTypeDef(TypedDict):
    EmailIdentity: str,
    Tags: NotRequired[Sequence[TagTypeDef]],  # (1)
  1. See Sequence[TagTypeDef]

TagResourceRequestTypeDef#

# TagResourceRequestTypeDef TypedDict usage example

from mypy_boto3_pinpoint_email.type_defs import TagResourceRequestTypeDef


def get_value() -> TagResourceRequestTypeDef:
    return {
        "ResourceArn": ...,
    }


# TagResourceRequestTypeDef definition

class TagResourceRequestTypeDef(TypedDict):
    ResourceArn: str,
    Tags: Sequence[TagTypeDef],  # (1)
  1. See Sequence[TagTypeDef]

CreateDeliverabilityTestReportResponseTypeDef#

# CreateDeliverabilityTestReportResponseTypeDef TypedDict usage example

from mypy_boto3_pinpoint_email.type_defs import CreateDeliverabilityTestReportResponseTypeDef


def get_value() -> CreateDeliverabilityTestReportResponseTypeDef:
    return {
        "ReportId": ...,
    }


# CreateDeliverabilityTestReportResponseTypeDef definition

class CreateDeliverabilityTestReportResponseTypeDef(TypedDict):
    ReportId: str,
    DeliverabilityTestStatus: DeliverabilityTestStatusType,  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See DeliverabilityTestStatusType
  2. See ResponseMetadataTypeDef

GetBlacklistReportsResponseTypeDef#

# GetBlacklistReportsResponseTypeDef TypedDict usage example

from mypy_boto3_pinpoint_email.type_defs import GetBlacklistReportsResponseTypeDef


def get_value() -> GetBlacklistReportsResponseTypeDef:
    return {
        "BlacklistReport": ...,
    }


# GetBlacklistReportsResponseTypeDef definition

class GetBlacklistReportsResponseTypeDef(TypedDict):
    BlacklistReport: Dict[str, List[BlacklistEntryTypeDef]],  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See Dict[str, List[BlacklistEntryTypeDef]]
  2. See ResponseMetadataTypeDef

ListConfigurationSetsResponseTypeDef#

# ListConfigurationSetsResponseTypeDef TypedDict usage example

from mypy_boto3_pinpoint_email.type_defs import ListConfigurationSetsResponseTypeDef


def get_value() -> ListConfigurationSetsResponseTypeDef:
    return {
        "ConfigurationSets": ...,
    }


# ListConfigurationSetsResponseTypeDef definition

class ListConfigurationSetsResponseTypeDef(TypedDict):
    ConfigurationSets: List[str],
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
    NextToken: NotRequired[str],
  1. See ResponseMetadataTypeDef

ListDedicatedIpPoolsResponseTypeDef#

# ListDedicatedIpPoolsResponseTypeDef TypedDict usage example

from mypy_boto3_pinpoint_email.type_defs import ListDedicatedIpPoolsResponseTypeDef


def get_value() -> ListDedicatedIpPoolsResponseTypeDef:
    return {
        "DedicatedIpPools": ...,
    }


# ListDedicatedIpPoolsResponseTypeDef definition

class ListDedicatedIpPoolsResponseTypeDef(TypedDict):
    DedicatedIpPools: List[str],
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
    NextToken: NotRequired[str],
  1. See ResponseMetadataTypeDef

ListTagsForResourceResponseTypeDef#

# ListTagsForResourceResponseTypeDef TypedDict usage example

from mypy_boto3_pinpoint_email.type_defs import ListTagsForResourceResponseTypeDef


def get_value() -> ListTagsForResourceResponseTypeDef:
    return {
        "Tags": ...,
    }


# ListTagsForResourceResponseTypeDef definition

class ListTagsForResourceResponseTypeDef(TypedDict):
    Tags: List[TagTypeDef],  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See List[TagTypeDef]
  2. See ResponseMetadataTypeDef

SendEmailResponseTypeDef#

# SendEmailResponseTypeDef TypedDict usage example

from mypy_boto3_pinpoint_email.type_defs import SendEmailResponseTypeDef


def get_value() -> SendEmailResponseTypeDef:
    return {
        "MessageId": ...,
    }


# SendEmailResponseTypeDef definition

class SendEmailResponseTypeDef(TypedDict):
    MessageId: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
  1. See ResponseMetadataTypeDef

CreateEmailIdentityResponseTypeDef#

# CreateEmailIdentityResponseTypeDef TypedDict usage example

from mypy_boto3_pinpoint_email.type_defs import CreateEmailIdentityResponseTypeDef


def get_value() -> CreateEmailIdentityResponseTypeDef:
    return {
        "IdentityType": ...,
    }


# CreateEmailIdentityResponseTypeDef definition

class CreateEmailIdentityResponseTypeDef(TypedDict):
    IdentityType: IdentityTypeType,  # (1)
    VerifiedForSendingStatus: bool,
    DkimAttributes: DkimAttributesTypeDef,  # (2)
    ResponseMetadata: ResponseMetadataTypeDef,  # (3)
  1. See IdentityTypeType
  2. See DkimAttributesTypeDef
  3. See ResponseMetadataTypeDef

DailyVolumeTypeDef#

# DailyVolumeTypeDef TypedDict usage example

from mypy_boto3_pinpoint_email.type_defs import DailyVolumeTypeDef


def get_value() -> DailyVolumeTypeDef:
    return {
        "StartDate": ...,
    }


# DailyVolumeTypeDef definition

class DailyVolumeTypeDef(TypedDict):
    StartDate: NotRequired[datetime.datetime],
    VolumeStatistics: NotRequired[VolumeStatisticsTypeDef],  # (1)
    DomainIspPlacements: NotRequired[List[DomainIspPlacementTypeDef]],  # (2)
  1. See VolumeStatisticsTypeDef
  2. See List[DomainIspPlacementTypeDef]

OverallVolumeTypeDef#

# OverallVolumeTypeDef TypedDict usage example

from mypy_boto3_pinpoint_email.type_defs import OverallVolumeTypeDef


def get_value() -> OverallVolumeTypeDef:
    return {
        "VolumeStatistics": ...,
    }


# OverallVolumeTypeDef definition

class OverallVolumeTypeDef(TypedDict):
    VolumeStatistics: NotRequired[VolumeStatisticsTypeDef],  # (1)
    ReadRatePercent: NotRequired[float],
    DomainIspPlacements: NotRequired[List[DomainIspPlacementTypeDef]],  # (2)
  1. See VolumeStatisticsTypeDef
  2. See List[DomainIspPlacementTypeDef]

GetDedicatedIpResponseTypeDef#

# GetDedicatedIpResponseTypeDef TypedDict usage example

from mypy_boto3_pinpoint_email.type_defs import GetDedicatedIpResponseTypeDef


def get_value() -> GetDedicatedIpResponseTypeDef:
    return {
        "DedicatedIp": ...,
    }


# GetDedicatedIpResponseTypeDef definition

class GetDedicatedIpResponseTypeDef(TypedDict):
    DedicatedIp: DedicatedIpTypeDef,  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See DedicatedIpTypeDef
  2. See ResponseMetadataTypeDef

GetDedicatedIpsResponseTypeDef#

# GetDedicatedIpsResponseTypeDef TypedDict usage example

from mypy_boto3_pinpoint_email.type_defs import GetDedicatedIpsResponseTypeDef


def get_value() -> GetDedicatedIpsResponseTypeDef:
    return {
        "DedicatedIps": ...,
    }


# GetDedicatedIpsResponseTypeDef definition

class GetDedicatedIpsResponseTypeDef(TypedDict):
    DedicatedIps: List[DedicatedIpTypeDef],  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
    NextToken: NotRequired[str],
  1. See List[DedicatedIpTypeDef]
  2. See ResponseMetadataTypeDef

ListDeliverabilityTestReportsResponseTypeDef#

# ListDeliverabilityTestReportsResponseTypeDef TypedDict usage example

from mypy_boto3_pinpoint_email.type_defs import ListDeliverabilityTestReportsResponseTypeDef


def get_value() -> ListDeliverabilityTestReportsResponseTypeDef:
    return {
        "DeliverabilityTestReports": ...,
    }


# ListDeliverabilityTestReportsResponseTypeDef definition

class ListDeliverabilityTestReportsResponseTypeDef(TypedDict):
    DeliverabilityTestReports: List[DeliverabilityTestReportTypeDef],  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
    NextToken: NotRequired[str],
  1. See List[DeliverabilityTestReportTypeDef]
  2. See ResponseMetadataTypeDef

GetDomainDeliverabilityCampaignResponseTypeDef#

# GetDomainDeliverabilityCampaignResponseTypeDef TypedDict usage example

from mypy_boto3_pinpoint_email.type_defs import GetDomainDeliverabilityCampaignResponseTypeDef


def get_value() -> GetDomainDeliverabilityCampaignResponseTypeDef:
    return {
        "DomainDeliverabilityCampaign": ...,
    }


# GetDomainDeliverabilityCampaignResponseTypeDef definition

class GetDomainDeliverabilityCampaignResponseTypeDef(TypedDict):
    DomainDeliverabilityCampaign: DomainDeliverabilityCampaignTypeDef,  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See DomainDeliverabilityCampaignTypeDef
  2. See ResponseMetadataTypeDef

ListDomainDeliverabilityCampaignsResponseTypeDef#

# ListDomainDeliverabilityCampaignsResponseTypeDef TypedDict usage example

from mypy_boto3_pinpoint_email.type_defs import ListDomainDeliverabilityCampaignsResponseTypeDef


def get_value() -> ListDomainDeliverabilityCampaignsResponseTypeDef:
    return {
        "DomainDeliverabilityCampaigns": ...,
    }


# ListDomainDeliverabilityCampaignsResponseTypeDef definition

class ListDomainDeliverabilityCampaignsResponseTypeDef(TypedDict):
    DomainDeliverabilityCampaigns: List[DomainDeliverabilityCampaignTypeDef],  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
    NextToken: NotRequired[str],
  1. See List[DomainDeliverabilityCampaignTypeDef]
  2. See ResponseMetadataTypeDef

DomainDeliverabilityTrackingOptionOutputTypeDef#

# DomainDeliverabilityTrackingOptionOutputTypeDef TypedDict usage example

from mypy_boto3_pinpoint_email.type_defs import DomainDeliverabilityTrackingOptionOutputTypeDef


def get_value() -> DomainDeliverabilityTrackingOptionOutputTypeDef:
    return {
        "Domain": ...,
    }


# DomainDeliverabilityTrackingOptionOutputTypeDef definition

class DomainDeliverabilityTrackingOptionOutputTypeDef(TypedDict):
    Domain: NotRequired[str],
    SubscriptionStartDate: NotRequired[datetime.datetime],
    InboxPlacementTrackingOption: NotRequired[InboxPlacementTrackingOptionOutputTypeDef],  # (1)
  1. See InboxPlacementTrackingOptionOutputTypeDef

GetDomainStatisticsReportRequestTypeDef#

# GetDomainStatisticsReportRequestTypeDef TypedDict usage example

from mypy_boto3_pinpoint_email.type_defs import GetDomainStatisticsReportRequestTypeDef


def get_value() -> GetDomainStatisticsReportRequestTypeDef:
    return {
        "Domain": ...,
    }


# GetDomainStatisticsReportRequestTypeDef definition

class GetDomainStatisticsReportRequestTypeDef(TypedDict):
    Domain: str,
    StartDate: TimestampTypeDef,
    EndDate: TimestampTypeDef,

ListDomainDeliverabilityCampaignsRequestTypeDef#

# ListDomainDeliverabilityCampaignsRequestTypeDef TypedDict usage example

from mypy_boto3_pinpoint_email.type_defs import ListDomainDeliverabilityCampaignsRequestTypeDef


def get_value() -> ListDomainDeliverabilityCampaignsRequestTypeDef:
    return {
        "StartDate": ...,
    }


# ListDomainDeliverabilityCampaignsRequestTypeDef definition

class ListDomainDeliverabilityCampaignsRequestTypeDef(TypedDict):
    StartDate: TimestampTypeDef,
    EndDate: TimestampTypeDef,
    SubscribedDomain: str,
    NextToken: NotRequired[str],
    PageSize: NotRequired[int],

ReputationOptionsTypeDef#

# ReputationOptionsTypeDef TypedDict usage example

from mypy_boto3_pinpoint_email.type_defs import ReputationOptionsTypeDef


def get_value() -> ReputationOptionsTypeDef:
    return {
        "ReputationMetricsEnabled": ...,
    }


# ReputationOptionsTypeDef definition

class ReputationOptionsTypeDef(TypedDict):
    ReputationMetricsEnabled: NotRequired[bool],
    LastFreshStart: NotRequired[TimestampTypeDef],

GetAccountResponseTypeDef#

# GetAccountResponseTypeDef TypedDict usage example

from mypy_boto3_pinpoint_email.type_defs import GetAccountResponseTypeDef


def get_value() -> GetAccountResponseTypeDef:
    return {
        "SendQuota": ...,
    }


# GetAccountResponseTypeDef definition

class GetAccountResponseTypeDef(TypedDict):
    SendQuota: SendQuotaTypeDef,  # (1)
    SendingEnabled: bool,
    DedicatedIpAutoWarmupEnabled: bool,
    EnforcementStatus: str,
    ProductionAccessEnabled: bool,
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See SendQuotaTypeDef
  2. See ResponseMetadataTypeDef

GetConfigurationSetResponseTypeDef#

# GetConfigurationSetResponseTypeDef TypedDict usage example

from mypy_boto3_pinpoint_email.type_defs import GetConfigurationSetResponseTypeDef


def get_value() -> GetConfigurationSetResponseTypeDef:
    return {
        "ConfigurationSetName": ...,
    }


# GetConfigurationSetResponseTypeDef definition

class GetConfigurationSetResponseTypeDef(TypedDict):
    ConfigurationSetName: str,
    TrackingOptions: TrackingOptionsTypeDef,  # (1)
    DeliveryOptions: DeliveryOptionsTypeDef,  # (2)
    ReputationOptions: ReputationOptionsOutputTypeDef,  # (3)
    SendingOptions: SendingOptionsTypeDef,  # (4)
    Tags: List[TagTypeDef],  # (5)
    ResponseMetadata: ResponseMetadataTypeDef,  # (6)
  1. See TrackingOptionsTypeDef
  2. See DeliveryOptionsTypeDef
  3. See ReputationOptionsOutputTypeDef
  4. See SendingOptionsTypeDef
  5. See List[TagTypeDef]
  6. See ResponseMetadataTypeDef

GetDedicatedIpsRequestPaginateTypeDef#

# GetDedicatedIpsRequestPaginateTypeDef TypedDict usage example

from mypy_boto3_pinpoint_email.type_defs import GetDedicatedIpsRequestPaginateTypeDef


def get_value() -> GetDedicatedIpsRequestPaginateTypeDef:
    return {
        "PoolName": ...,
    }


# GetDedicatedIpsRequestPaginateTypeDef definition

class GetDedicatedIpsRequestPaginateTypeDef(TypedDict):
    PoolName: NotRequired[str],
    PaginationConfig: NotRequired[PaginatorConfigTypeDef],  # (1)
  1. See PaginatorConfigTypeDef

ListConfigurationSetsRequestPaginateTypeDef#

# ListConfigurationSetsRequestPaginateTypeDef TypedDict usage example

from mypy_boto3_pinpoint_email.type_defs import ListConfigurationSetsRequestPaginateTypeDef


def get_value() -> ListConfigurationSetsRequestPaginateTypeDef:
    return {
        "PaginationConfig": ...,
    }


# ListConfigurationSetsRequestPaginateTypeDef definition

class ListConfigurationSetsRequestPaginateTypeDef(TypedDict):
    PaginationConfig: NotRequired[PaginatorConfigTypeDef],  # (1)
  1. See PaginatorConfigTypeDef

ListDedicatedIpPoolsRequestPaginateTypeDef#

# ListDedicatedIpPoolsRequestPaginateTypeDef TypedDict usage example

from mypy_boto3_pinpoint_email.type_defs import ListDedicatedIpPoolsRequestPaginateTypeDef


def get_value() -> ListDedicatedIpPoolsRequestPaginateTypeDef:
    return {
        "PaginationConfig": ...,
    }


# ListDedicatedIpPoolsRequestPaginateTypeDef definition

class ListDedicatedIpPoolsRequestPaginateTypeDef(TypedDict):
    PaginationConfig: NotRequired[PaginatorConfigTypeDef],  # (1)
  1. See PaginatorConfigTypeDef

ListDeliverabilityTestReportsRequestPaginateTypeDef#

# ListDeliverabilityTestReportsRequestPaginateTypeDef TypedDict usage example

from mypy_boto3_pinpoint_email.type_defs import ListDeliverabilityTestReportsRequestPaginateTypeDef


def get_value() -> ListDeliverabilityTestReportsRequestPaginateTypeDef:
    return {
        "PaginationConfig": ...,
    }


# ListDeliverabilityTestReportsRequestPaginateTypeDef definition

class ListDeliverabilityTestReportsRequestPaginateTypeDef(TypedDict):
    PaginationConfig: NotRequired[PaginatorConfigTypeDef],  # (1)
  1. See PaginatorConfigTypeDef

ListEmailIdentitiesRequestPaginateTypeDef#

# ListEmailIdentitiesRequestPaginateTypeDef TypedDict usage example

from mypy_boto3_pinpoint_email.type_defs import ListEmailIdentitiesRequestPaginateTypeDef


def get_value() -> ListEmailIdentitiesRequestPaginateTypeDef:
    return {
        "PaginationConfig": ...,
    }


# ListEmailIdentitiesRequestPaginateTypeDef definition

class ListEmailIdentitiesRequestPaginateTypeDef(TypedDict):
    PaginationConfig: NotRequired[PaginatorConfigTypeDef],  # (1)
  1. See PaginatorConfigTypeDef

IspPlacementTypeDef#

# IspPlacementTypeDef TypedDict usage example

from mypy_boto3_pinpoint_email.type_defs import IspPlacementTypeDef


def get_value() -> IspPlacementTypeDef:
    return {
        "IspName": ...,
    }


# IspPlacementTypeDef definition

class IspPlacementTypeDef(TypedDict):
    IspName: NotRequired[str],
    PlacementStatistics: NotRequired[PlacementStatisticsTypeDef],  # (1)
  1. See PlacementStatisticsTypeDef

GetEmailIdentityResponseTypeDef#

# GetEmailIdentityResponseTypeDef TypedDict usage example

from mypy_boto3_pinpoint_email.type_defs import GetEmailIdentityResponseTypeDef


def get_value() -> GetEmailIdentityResponseTypeDef:
    return {
        "IdentityType": ...,
    }


# GetEmailIdentityResponseTypeDef definition

class GetEmailIdentityResponseTypeDef(TypedDict):
    IdentityType: IdentityTypeType,  # (1)
    FeedbackForwardingStatus: bool,
    VerifiedForSendingStatus: bool,
    DkimAttributes: DkimAttributesTypeDef,  # (2)
    MailFromAttributes: MailFromAttributesTypeDef,  # (3)
    Tags: List[TagTypeDef],  # (4)
    ResponseMetadata: ResponseMetadataTypeDef,  # (5)
  1. See IdentityTypeType
  2. See DkimAttributesTypeDef
  3. See MailFromAttributesTypeDef
  4. See List[TagTypeDef]
  5. See ResponseMetadataTypeDef

ListEmailIdentitiesResponseTypeDef#

# ListEmailIdentitiesResponseTypeDef TypedDict usage example

from mypy_boto3_pinpoint_email.type_defs import ListEmailIdentitiesResponseTypeDef


def get_value() -> ListEmailIdentitiesResponseTypeDef:
    return {
        "EmailIdentities": ...,
    }


# ListEmailIdentitiesResponseTypeDef definition

class ListEmailIdentitiesResponseTypeDef(TypedDict):
    EmailIdentities: List[IdentityInfoTypeDef],  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
    NextToken: NotRequired[str],
  1. See List[IdentityInfoTypeDef]
  2. See ResponseMetadataTypeDef

MessageTypeDef#

# MessageTypeDef TypedDict usage example

from mypy_boto3_pinpoint_email.type_defs import MessageTypeDef


def get_value() -> MessageTypeDef:
    return {
        "Subject": ...,
    }


# MessageTypeDef definition

class MessageTypeDef(TypedDict):
    Subject: ContentTypeDef,  # (1)
    Body: BodyTypeDef,  # (2)
  1. See ContentTypeDef
  2. See BodyTypeDef

EventDestinationTypeDef#

# EventDestinationTypeDef TypedDict usage example

from mypy_boto3_pinpoint_email.type_defs import EventDestinationTypeDef


def get_value() -> EventDestinationTypeDef:
    return {
        "Name": ...,
    }


# EventDestinationTypeDef definition

class EventDestinationTypeDef(TypedDict):
    Name: str,
    MatchingEventTypes: List[EventTypeType],  # (1)
    Enabled: NotRequired[bool],
    KinesisFirehoseDestination: NotRequired[KinesisFirehoseDestinationTypeDef],  # (2)
    CloudWatchDestination: NotRequired[CloudWatchDestinationOutputTypeDef],  # (3)
    SnsDestination: NotRequired[SnsDestinationTypeDef],  # (4)
    PinpointDestination: NotRequired[PinpointDestinationTypeDef],  # (5)
  1. See List[EventTypeType]
  2. See KinesisFirehoseDestinationTypeDef
  3. See CloudWatchDestinationOutputTypeDef
  4. See SnsDestinationTypeDef
  5. See PinpointDestinationTypeDef

GetDomainStatisticsReportResponseTypeDef#

# GetDomainStatisticsReportResponseTypeDef TypedDict usage example

from mypy_boto3_pinpoint_email.type_defs import GetDomainStatisticsReportResponseTypeDef


def get_value() -> GetDomainStatisticsReportResponseTypeDef:
    return {
        "OverallVolume": ...,
    }


# GetDomainStatisticsReportResponseTypeDef definition

class GetDomainStatisticsReportResponseTypeDef(TypedDict):
    OverallVolume: OverallVolumeTypeDef,  # (1)
    DailyVolumes: List[DailyVolumeTypeDef],  # (2)
    ResponseMetadata: ResponseMetadataTypeDef,  # (3)
  1. See OverallVolumeTypeDef
  2. See List[DailyVolumeTypeDef]
  3. See ResponseMetadataTypeDef

GetDeliverabilityDashboardOptionsResponseTypeDef#

# GetDeliverabilityDashboardOptionsResponseTypeDef TypedDict usage example

from mypy_boto3_pinpoint_email.type_defs import GetDeliverabilityDashboardOptionsResponseTypeDef


def get_value() -> GetDeliverabilityDashboardOptionsResponseTypeDef:
    return {
        "DashboardEnabled": ...,
    }


# GetDeliverabilityDashboardOptionsResponseTypeDef definition

class GetDeliverabilityDashboardOptionsResponseTypeDef(TypedDict):
    DashboardEnabled: bool,
    SubscriptionExpiryDate: datetime.datetime,
    AccountStatus: DeliverabilityDashboardAccountStatusType,  # (1)
    ActiveSubscribedDomains: List[DomainDeliverabilityTrackingOptionOutputTypeDef],  # (2)
    PendingExpirationSubscribedDomains: List[DomainDeliverabilityTrackingOptionOutputTypeDef],  # (2)
    ResponseMetadata: ResponseMetadataTypeDef,  # (4)
  1. See DeliverabilityDashboardAccountStatusType
  2. See List[DomainDeliverabilityTrackingOptionOutputTypeDef]
  3. See List[DomainDeliverabilityTrackingOptionOutputTypeDef]
  4. See ResponseMetadataTypeDef

GetDeliverabilityTestReportResponseTypeDef#

# GetDeliverabilityTestReportResponseTypeDef TypedDict usage example

from mypy_boto3_pinpoint_email.type_defs import GetDeliverabilityTestReportResponseTypeDef


def get_value() -> GetDeliverabilityTestReportResponseTypeDef:
    return {
        "DeliverabilityTestReport": ...,
    }


# GetDeliverabilityTestReportResponseTypeDef definition

class GetDeliverabilityTestReportResponseTypeDef(TypedDict):
    DeliverabilityTestReport: DeliverabilityTestReportTypeDef,  # (1)
    OverallPlacement: PlacementStatisticsTypeDef,  # (2)
    IspPlacements: List[IspPlacementTypeDef],  # (3)
    Message: str,
    Tags: List[TagTypeDef],  # (4)
    ResponseMetadata: ResponseMetadataTypeDef,  # (5)
  1. See DeliverabilityTestReportTypeDef
  2. See PlacementStatisticsTypeDef
  3. See List[IspPlacementTypeDef]
  4. See List[TagTypeDef]
  5. See ResponseMetadataTypeDef

DomainDeliverabilityTrackingOptionTypeDef#

# DomainDeliverabilityTrackingOptionTypeDef TypedDict usage example

from mypy_boto3_pinpoint_email.type_defs import DomainDeliverabilityTrackingOptionTypeDef


def get_value() -> DomainDeliverabilityTrackingOptionTypeDef:
    return {
        "Domain": ...,
    }


# DomainDeliverabilityTrackingOptionTypeDef definition

class DomainDeliverabilityTrackingOptionTypeDef(TypedDict):
    Domain: NotRequired[str],
    SubscriptionStartDate: NotRequired[TimestampTypeDef],
    InboxPlacementTrackingOption: NotRequired[InboxPlacementTrackingOptionUnionTypeDef],  # (1)
  1. See InboxPlacementTrackingOptionUnionTypeDef

EmailContentTypeDef#

# EmailContentTypeDef TypedDict usage example

from mypy_boto3_pinpoint_email.type_defs import EmailContentTypeDef


def get_value() -> EmailContentTypeDef:
    return {
        "Simple": ...,
    }


# EmailContentTypeDef definition

class EmailContentTypeDef(TypedDict):
    Simple: NotRequired[MessageTypeDef],  # (1)
    Raw: NotRequired[RawMessageTypeDef],  # (2)
    Template: NotRequired[TemplateTypeDef],  # (3)
  1. See MessageTypeDef
  2. See RawMessageTypeDef
  3. See TemplateTypeDef

GetConfigurationSetEventDestinationsResponseTypeDef#

# GetConfigurationSetEventDestinationsResponseTypeDef TypedDict usage example

from mypy_boto3_pinpoint_email.type_defs import GetConfigurationSetEventDestinationsResponseTypeDef


def get_value() -> GetConfigurationSetEventDestinationsResponseTypeDef:
    return {
        "EventDestinations": ...,
    }


# GetConfigurationSetEventDestinationsResponseTypeDef definition

class GetConfigurationSetEventDestinationsResponseTypeDef(TypedDict):
    EventDestinations: List[EventDestinationTypeDef],  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See List[EventDestinationTypeDef]
  2. See ResponseMetadataTypeDef

EventDestinationDefinitionTypeDef#

# EventDestinationDefinitionTypeDef TypedDict usage example

from mypy_boto3_pinpoint_email.type_defs import EventDestinationDefinitionTypeDef


def get_value() -> EventDestinationDefinitionTypeDef:
    return {
        "Enabled": ...,
    }


# EventDestinationDefinitionTypeDef definition

class EventDestinationDefinitionTypeDef(TypedDict):
    Enabled: NotRequired[bool],
    MatchingEventTypes: NotRequired[Sequence[EventTypeType]],  # (1)
    KinesisFirehoseDestination: NotRequired[KinesisFirehoseDestinationTypeDef],  # (2)
    CloudWatchDestination: NotRequired[CloudWatchDestinationUnionTypeDef],  # (3)
    SnsDestination: NotRequired[SnsDestinationTypeDef],  # (4)
    PinpointDestination: NotRequired[PinpointDestinationTypeDef],  # (5)
  1. See Sequence[EventTypeType]
  2. See KinesisFirehoseDestinationTypeDef
  3. See CloudWatchDestinationUnionTypeDef
  4. See SnsDestinationTypeDef
  5. See PinpointDestinationTypeDef

CreateConfigurationSetRequestTypeDef#

# CreateConfigurationSetRequestTypeDef TypedDict usage example

from mypy_boto3_pinpoint_email.type_defs import CreateConfigurationSetRequestTypeDef


def get_value() -> CreateConfigurationSetRequestTypeDef:
    return {
        "ConfigurationSetName": ...,
    }


# CreateConfigurationSetRequestTypeDef definition

class CreateConfigurationSetRequestTypeDef(TypedDict):
    ConfigurationSetName: str,
    TrackingOptions: NotRequired[TrackingOptionsTypeDef],  # (1)
    DeliveryOptions: NotRequired[DeliveryOptionsTypeDef],  # (2)
    ReputationOptions: NotRequired[ReputationOptionsUnionTypeDef],  # (3)
    SendingOptions: NotRequired[SendingOptionsTypeDef],  # (4)
    Tags: NotRequired[Sequence[TagTypeDef]],  # (5)
  1. See TrackingOptionsTypeDef
  2. See DeliveryOptionsTypeDef
  3. See ReputationOptionsUnionTypeDef
  4. See SendingOptionsTypeDef
  5. See Sequence[TagTypeDef]

CreateDeliverabilityTestReportRequestTypeDef#

# CreateDeliverabilityTestReportRequestTypeDef TypedDict usage example

from mypy_boto3_pinpoint_email.type_defs import CreateDeliverabilityTestReportRequestTypeDef


def get_value() -> CreateDeliverabilityTestReportRequestTypeDef:
    return {
        "FromEmailAddress": ...,
    }


# CreateDeliverabilityTestReportRequestTypeDef definition

class CreateDeliverabilityTestReportRequestTypeDef(TypedDict):
    FromEmailAddress: str,
    Content: EmailContentTypeDef,  # (1)
    ReportName: NotRequired[str],
    Tags: NotRequired[Sequence[TagTypeDef]],  # (2)
  1. See EmailContentTypeDef
  2. See Sequence[TagTypeDef]

SendEmailRequestTypeDef#

# SendEmailRequestTypeDef TypedDict usage example

from mypy_boto3_pinpoint_email.type_defs import SendEmailRequestTypeDef


def get_value() -> SendEmailRequestTypeDef:
    return {
        "Destination": ...,
    }


# SendEmailRequestTypeDef definition

class SendEmailRequestTypeDef(TypedDict):
    Destination: DestinationTypeDef,  # (1)
    Content: EmailContentTypeDef,  # (2)
    FromEmailAddress: NotRequired[str],
    ReplyToAddresses: NotRequired[Sequence[str]],
    FeedbackForwardingEmailAddress: NotRequired[str],
    EmailTags: NotRequired[Sequence[MessageTagTypeDef]],  # (3)
    ConfigurationSetName: NotRequired[str],
  1. See DestinationTypeDef
  2. See EmailContentTypeDef
  3. See Sequence[MessageTagTypeDef]

CreateConfigurationSetEventDestinationRequestTypeDef#

# CreateConfigurationSetEventDestinationRequestTypeDef TypedDict usage example

from mypy_boto3_pinpoint_email.type_defs import CreateConfigurationSetEventDestinationRequestTypeDef


def get_value() -> CreateConfigurationSetEventDestinationRequestTypeDef:
    return {
        "ConfigurationSetName": ...,
    }


# CreateConfigurationSetEventDestinationRequestTypeDef definition

class CreateConfigurationSetEventDestinationRequestTypeDef(TypedDict):
    ConfigurationSetName: str,
    EventDestinationName: str,
    EventDestination: EventDestinationDefinitionTypeDef,  # (1)
  1. See EventDestinationDefinitionTypeDef

UpdateConfigurationSetEventDestinationRequestTypeDef#

# UpdateConfigurationSetEventDestinationRequestTypeDef TypedDict usage example

from mypy_boto3_pinpoint_email.type_defs import UpdateConfigurationSetEventDestinationRequestTypeDef


def get_value() -> UpdateConfigurationSetEventDestinationRequestTypeDef:
    return {
        "ConfigurationSetName": ...,
    }


# UpdateConfigurationSetEventDestinationRequestTypeDef definition

class UpdateConfigurationSetEventDestinationRequestTypeDef(TypedDict):
    ConfigurationSetName: str,
    EventDestinationName: str,
    EventDestination: EventDestinationDefinitionTypeDef,  # (1)
  1. See EventDestinationDefinitionTypeDef

PutDeliverabilityDashboardOptionRequestTypeDef#

# PutDeliverabilityDashboardOptionRequestTypeDef TypedDict usage example

from mypy_boto3_pinpoint_email.type_defs import PutDeliverabilityDashboardOptionRequestTypeDef


def get_value() -> PutDeliverabilityDashboardOptionRequestTypeDef:
    return {
        "DashboardEnabled": ...,
    }


# PutDeliverabilityDashboardOptionRequestTypeDef definition

class PutDeliverabilityDashboardOptionRequestTypeDef(TypedDict):
    DashboardEnabled: bool,
    SubscribedDomains: NotRequired[Sequence[DomainDeliverabilityTrackingOptionUnionTypeDef]],  # (1)
  1. See Sequence[DomainDeliverabilityTrackingOptionUnionTypeDef]