Skip to content

Type definitions#

Index > SES > Type definitions

Auto-generated documentation for SES type annotations stubs module mypy-boto3-ses.

BlobTypeDef#

# BlobTypeDef definition

BlobTypeDef = Union[
    str,
    bytes,
    IO[Any],
    StreamingBody,
]

TimestampTypeDef#

# TimestampTypeDef definition

TimestampTypeDef = Union[
    datetime,
    str,
]

AddHeaderActionTypeDef#

# AddHeaderActionTypeDef definition

class AddHeaderActionTypeDef(TypedDict):
    HeaderName: str,
    HeaderValue: str,

ContentTypeDef#

# ContentTypeDef definition

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

BounceActionTypeDef#

# BounceActionTypeDef definition

class BounceActionTypeDef(TypedDict):
    SmtpReplyCode: str,
    Message: str,
    Sender: str,
    TopicArn: NotRequired[str],
    StatusCode: NotRequired[str],

BulkEmailDestinationStatusTypeDef#

# BulkEmailDestinationStatusTypeDef definition

class BulkEmailDestinationStatusTypeDef(TypedDict):
    Status: NotRequired[BulkEmailStatusType],  # (1)
    Error: NotRequired[str],
    MessageId: NotRequired[str],
  1. See BulkEmailStatusType

DestinationTypeDef#

# DestinationTypeDef definition

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

MessageTagTypeDef#

# MessageTagTypeDef definition

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

CloneReceiptRuleSetRequestRequestTypeDef#

# CloneReceiptRuleSetRequestRequestTypeDef definition

class CloneReceiptRuleSetRequestRequestTypeDef(TypedDict):
    RuleSetName: str,
    OriginalRuleSetName: str,

CloudWatchDimensionConfigurationTypeDef#

# CloudWatchDimensionConfigurationTypeDef definition

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

ConfigurationSetTypeDef#

# ConfigurationSetTypeDef definition

class ConfigurationSetTypeDef(TypedDict):
    Name: str,

TrackingOptionsTypeDef#

# TrackingOptionsTypeDef definition

class TrackingOptionsTypeDef(TypedDict):
    CustomRedirectDomain: NotRequired[str],

CreateCustomVerificationEmailTemplateRequestRequestTypeDef#

# CreateCustomVerificationEmailTemplateRequestRequestTypeDef definition

class CreateCustomVerificationEmailTemplateRequestRequestTypeDef(TypedDict):
    TemplateName: str,
    FromEmailAddress: str,
    TemplateSubject: str,
    TemplateContent: str,
    SuccessRedirectionURL: str,
    FailureRedirectionURL: str,

CreateReceiptRuleSetRequestRequestTypeDef#

# CreateReceiptRuleSetRequestRequestTypeDef definition

class CreateReceiptRuleSetRequestRequestTypeDef(TypedDict):
    RuleSetName: str,

TemplateTypeDef#

# TemplateTypeDef definition

class TemplateTypeDef(TypedDict):
    TemplateName: str,
    SubjectPart: NotRequired[str],
    TextPart: NotRequired[str],
    HtmlPart: NotRequired[str],

CustomVerificationEmailTemplateTypeDef#

# CustomVerificationEmailTemplateTypeDef definition

class CustomVerificationEmailTemplateTypeDef(TypedDict):
    TemplateName: NotRequired[str],
    FromEmailAddress: NotRequired[str],
    TemplateSubject: NotRequired[str],
    SuccessRedirectionURL: NotRequired[str],
    FailureRedirectionURL: NotRequired[str],

DeleteConfigurationSetEventDestinationRequestRequestTypeDef#

# DeleteConfigurationSetEventDestinationRequestRequestTypeDef definition

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

DeleteConfigurationSetRequestRequestTypeDef#

# DeleteConfigurationSetRequestRequestTypeDef definition

class DeleteConfigurationSetRequestRequestTypeDef(TypedDict):
    ConfigurationSetName: str,

DeleteConfigurationSetTrackingOptionsRequestRequestTypeDef#

# DeleteConfigurationSetTrackingOptionsRequestRequestTypeDef definition

class DeleteConfigurationSetTrackingOptionsRequestRequestTypeDef(TypedDict):
    ConfigurationSetName: str,

DeleteCustomVerificationEmailTemplateRequestRequestTypeDef#

# DeleteCustomVerificationEmailTemplateRequestRequestTypeDef definition

class DeleteCustomVerificationEmailTemplateRequestRequestTypeDef(TypedDict):
    TemplateName: str,

DeleteIdentityPolicyRequestRequestTypeDef#

# DeleteIdentityPolicyRequestRequestTypeDef definition

class DeleteIdentityPolicyRequestRequestTypeDef(TypedDict):
    Identity: str,
    PolicyName: str,

DeleteIdentityRequestRequestTypeDef#

# DeleteIdentityRequestRequestTypeDef definition

class DeleteIdentityRequestRequestTypeDef(TypedDict):
    Identity: str,

DeleteReceiptFilterRequestRequestTypeDef#

# DeleteReceiptFilterRequestRequestTypeDef definition

class DeleteReceiptFilterRequestRequestTypeDef(TypedDict):
    FilterName: str,

DeleteReceiptRuleRequestRequestTypeDef#

# DeleteReceiptRuleRequestRequestTypeDef definition

class DeleteReceiptRuleRequestRequestTypeDef(TypedDict):
    RuleSetName: str,
    RuleName: str,

DeleteReceiptRuleSetRequestRequestTypeDef#

# DeleteReceiptRuleSetRequestRequestTypeDef definition

class DeleteReceiptRuleSetRequestRequestTypeDef(TypedDict):
    RuleSetName: str,

DeleteTemplateRequestRequestTypeDef#

# DeleteTemplateRequestRequestTypeDef definition

class DeleteTemplateRequestRequestTypeDef(TypedDict):
    TemplateName: str,

DeleteVerifiedEmailAddressRequestRequestTypeDef#

# DeleteVerifiedEmailAddressRequestRequestTypeDef definition

class DeleteVerifiedEmailAddressRequestRequestTypeDef(TypedDict):
    EmailAddress: str,

DeliveryOptionsTypeDef#

# DeliveryOptionsTypeDef definition

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

ReceiptRuleSetMetadataTypeDef#

# ReceiptRuleSetMetadataTypeDef definition

class ReceiptRuleSetMetadataTypeDef(TypedDict):
    Name: NotRequired[str],
    CreatedTimestamp: NotRequired[datetime],

ResponseMetadataTypeDef#

# ResponseMetadataTypeDef definition

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

DescribeConfigurationSetRequestRequestTypeDef#

# DescribeConfigurationSetRequestRequestTypeDef definition

class DescribeConfigurationSetRequestRequestTypeDef(TypedDict):
    ConfigurationSetName: str,
    ConfigurationSetAttributeNames: NotRequired[Sequence[ConfigurationSetAttributeType]],  # (1)
  1. See ConfigurationSetAttributeType

ReputationOptionsTypeDef#

# ReputationOptionsTypeDef definition

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

DescribeReceiptRuleRequestRequestTypeDef#

# DescribeReceiptRuleRequestRequestTypeDef definition

class DescribeReceiptRuleRequestRequestTypeDef(TypedDict):
    RuleSetName: str,
    RuleName: str,

DescribeReceiptRuleSetRequestRequestTypeDef#

# DescribeReceiptRuleSetRequestRequestTypeDef definition

class DescribeReceiptRuleSetRequestRequestTypeDef(TypedDict):
    RuleSetName: str,

KinesisFirehoseDestinationTypeDef#

# KinesisFirehoseDestinationTypeDef definition

class KinesisFirehoseDestinationTypeDef(TypedDict):
    IAMRoleARN: str,
    DeliveryStreamARN: str,

SNSDestinationTypeDef#

# SNSDestinationTypeDef definition

class SNSDestinationTypeDef(TypedDict):
    TopicARN: str,

ExtensionFieldTypeDef#

# ExtensionFieldTypeDef definition

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

GetCustomVerificationEmailTemplateRequestRequestTypeDef#

# GetCustomVerificationEmailTemplateRequestRequestTypeDef definition

class GetCustomVerificationEmailTemplateRequestRequestTypeDef(TypedDict):
    TemplateName: str,

GetIdentityDkimAttributesRequestRequestTypeDef#

# GetIdentityDkimAttributesRequestRequestTypeDef definition

class GetIdentityDkimAttributesRequestRequestTypeDef(TypedDict):
    Identities: Sequence[str],

IdentityDkimAttributesTypeDef#

# IdentityDkimAttributesTypeDef definition

class IdentityDkimAttributesTypeDef(TypedDict):
    DkimEnabled: bool,
    DkimVerificationStatus: VerificationStatusType,  # (1)
    DkimTokens: NotRequired[List[str]],
  1. See VerificationStatusType

GetIdentityMailFromDomainAttributesRequestRequestTypeDef#

# GetIdentityMailFromDomainAttributesRequestRequestTypeDef definition

class GetIdentityMailFromDomainAttributesRequestRequestTypeDef(TypedDict):
    Identities: Sequence[str],

IdentityMailFromDomainAttributesTypeDef#

# IdentityMailFromDomainAttributesTypeDef definition

class IdentityMailFromDomainAttributesTypeDef(TypedDict):
    MailFromDomain: str,
    MailFromDomainStatus: CustomMailFromStatusType,  # (1)
    BehaviorOnMXFailure: BehaviorOnMXFailureType,  # (2)
  1. See CustomMailFromStatusType
  2. See BehaviorOnMXFailureType

GetIdentityNotificationAttributesRequestRequestTypeDef#

# GetIdentityNotificationAttributesRequestRequestTypeDef definition

class GetIdentityNotificationAttributesRequestRequestTypeDef(TypedDict):
    Identities: Sequence[str],

IdentityNotificationAttributesTypeDef#

# IdentityNotificationAttributesTypeDef definition

class IdentityNotificationAttributesTypeDef(TypedDict):
    BounceTopic: str,
    ComplaintTopic: str,
    DeliveryTopic: str,
    ForwardingEnabled: bool,
    HeadersInBounceNotificationsEnabled: NotRequired[bool],
    HeadersInComplaintNotificationsEnabled: NotRequired[bool],
    HeadersInDeliveryNotificationsEnabled: NotRequired[bool],

GetIdentityPoliciesRequestRequestTypeDef#

# GetIdentityPoliciesRequestRequestTypeDef definition

class GetIdentityPoliciesRequestRequestTypeDef(TypedDict):
    Identity: str,
    PolicyNames: Sequence[str],

WaiterConfigTypeDef#

# WaiterConfigTypeDef definition

class WaiterConfigTypeDef(TypedDict):
    Delay: NotRequired[int],
    M