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,
]
CloudWatchDestinationUnionTypeDef#
# CloudWatchDestinationUnionTypeDef definition
CloudWatchDestinationUnionTypeDef = Union[
CloudWatchDestinationTypeDef, # (1)
CloudWatchDestinationOutputTypeDef, # (2)
]
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],
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,
ConfigurationSetTypeDef#
# ConfigurationSetTypeDef definition
class ConfigurationSetTypeDef(TypedDict):
Name: str,
ConnectActionTypeDef#
# ConnectActionTypeDef definition
class ConnectActionTypeDef(TypedDict):
InstanceARN: str,
IAMRoleARN: 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)
- See TlsPolicyType
ReceiptRuleSetMetadataTypeDef#
# ReceiptRuleSetMetadataTypeDef definition
class ReceiptRuleSetMetadataTypeDef(TypedDict):
Name: NotRequired[str],
CreatedTimestamp: NotRequired[datetime],
ResponseMetadataTypeDef#
# ResponseMetadataTypeDef definition
class ResponseMetadataTypeDef(TypedDict):
RequestId: str,
HTTPStatusCode: int,
HTTPHeaders: dict[str, str],
RetryAttempts: int,
HostId: NotRequired[str],
DescribeConfigurationSetRequestRequestTypeDef#
# DescribeConfigurationSetRequestRequestTypeDef definition
class DescribeConfigurationSetRequestRequestTypeDef(TypedDict):
ConfigurationSetName: str,
ConfigurationSetAttributeNames: NotRequired[Sequence[ConfigurationSetAttributeType]], # (1)
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]],
GetIdentityMailFromDomainAttributesRequestRequestTypeDef#
# GetIdentityMailFromDomainAttributesRequestRequestTypeDef definition
class GetIdentityMailFromDomainAttributesRequestRequestTypeDef(TypedDict):
Identities: Sequence[str],
IdentityMailFromDomainAttributesTypeDef#
# IdentityMailFromDomainAttributesTypeDef definition
class IdentityMailFromDomainAttributesTypeDef(TypedDict):
MailFromDomain: str,
MailFromDomainStatus: CustomMailFromStatusType, # (1)
BehaviorOnMXFailure: BehaviorOnMXFailureType, # (2)
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],
GetIdentityVerificationAttributesRequestRequestTypeDef#
# GetIdentityVerificationAttributesRequestRequestTypeDef definition
class GetIdentityVerificationAttributesRequestRequestTypeDef(TypedDict):
Identities: Sequence[str],
WaiterConfigTypeDef#
# WaiterConfigTypeDef definition
class WaiterConfigTypeDef(TypedDict):
Delay: NotRequired[int],
MaxAttempts: NotRequired[int],
IdentityVerificationAttributesTypeDef#
# IdentityVerificationAttributesTypeDef definition
class IdentityVerificationAttributesTypeDef(TypedDict):
VerificationStatus: VerificationStatusType, # (1)
VerificationToken: NotRequired[str],
SendDataPointTypeDef#
# SendDataPointTypeDef definition
class SendDataPointTypeDef(TypedDict):
Timestamp: NotRequired[datetime],
DeliveryAttempts: NotRequired[int],
Bounces: NotRequired[int],
Complaints: NotRequired[int],
Rejects: NotRequired[int],
GetTemplateRequestRequestTypeDef#
# GetTemplateRequestRequestTypeDef definition
class GetTemplateRequestRequestTypeDef(TypedDict):
TemplateName: str,
LambdaActionTypeDef#
# LambdaActionTypeDef definition
class LambdaActionTypeDef(TypedDict):
FunctionArn: str,
TopicArn: NotRequired[str],
InvocationType: NotRequired[InvocationTypeType], # (1)
PaginatorConfigTypeDef#
# PaginatorConfigTypeDef definition
class PaginatorConfigTypeDef(TypedDict):
MaxItems: NotRequired[int],
PageSize: NotRequired[int],
StartingToken: NotRequired[str],
ListConfigurationSetsRequestRequestTypeDef#
# ListConfigurationSetsRequestRequestTypeDef definition
class ListConfigurationSetsRequestRequestTypeDef(TypedDict):
NextToken: NotRequired[str],
MaxItems: NotRequired[int],
ListCustomVerificationEmailTemplatesRequestRequestTypeDef#
# ListCustomVerificationEmailTemplatesRequestRequestTypeDef definition
class ListCustomVerificationEmailTemplatesRequestRequestTypeDef(TypedDict):
NextToken: NotRequired[str],
MaxResults: NotRequired[int],
ListIdentitiesRequestRequestTypeDef#
# ListIdentitiesRequestRequestTypeDef definition
class ListIdentitiesRequestRequestTypeDef(TypedDict):
IdentityType: NotRequired[IdentityTypeType], # (1)
NextToken: NotRequired[str],
MaxItems: NotRequired[int],
- See IdentityTypeType
ListIdentityPoliciesRequestRequestTypeDef#
# ListIdentityPoliciesRequestRequestTypeDef definition
class ListIdentityPoliciesRequestRequestTypeDef(TypedDict):
Identity: str,
ListReceiptRuleSetsRequestRequestTypeDef#
# ListReceiptRuleSetsRequestRequestTypeDef definition
class ListReceiptRuleSetsRequestRequestTypeDef(TypedDict):
NextToken: NotRequired[str],
ListTemplatesRequestRequestTypeDef#
# ListTemplatesRequestRequestTypeDef definition
class ListTemplatesRequestRequestTypeDef(TypedDict):
NextToken: NotRequired[str],
MaxItems: NotRequired[int],
TemplateMetadataTypeDef#
# TemplateMetadataTypeDef definition
class TemplateMetadataTypeDef(TypedDict):
Name: NotRequired[str],
CreatedTimestamp: NotRequired[datetime],
PutIdentityPolicyRequestRequestTypeDef#
# PutIdentityPolicyRequestRequestTypeDef definition
class PutIdentityPolicyRequestRequestTypeDef(TypedDict):
Identity: str,
PolicyName: str,
Policy: str,
S3ActionTypeDef#
# S3ActionTypeDef definition
class S3ActionTypeDef(TypedDict):
BucketName: str,
TopicArn: NotRequired[str],
ObjectKeyPrefix: NotRequired[str],
KmsKeyArn: NotRequired[str],
IamRoleArn: NotRequired[str],
SNSActionTypeDef#
# SNSActionTypeDef definition
class SNSActionTypeDef(TypedDict):
TopicArn: str,
Encoding: NotRequired[SNSActionEncodingType], # (1)
StopActionTypeDef#
# StopActionTypeDef definition
class StopActionTypeDef(TypedDict):
Scope: StopScopeType, # (1)
TopicArn: NotRequired[str],
- See StopScopeType
WorkmailActionTypeDef#
# WorkmailActionTypeDef definition
class WorkmailActionTypeDef(TypedDict):
OrganizationArn: str,
TopicArn: NotRequired[str],
ReceiptIpFilterTypeDef#
# ReceiptIpFilterTypeDef definition
class ReceiptIpFilterTypeDef(TypedDict):
Policy: ReceiptFilterPolicyType, # (1)
Cidr: str,
ReorderReceiptRuleSetRequestRequestTypeDef#
# ReorderReceiptRuleSetRequestRequestTypeDef definition
class ReorderReceiptRuleSetRequestRequestTypeDef(TypedDict):
RuleSetName: str,
RuleNames: Sequence[str],
SendCustomVerificationEmailRequestRequestTypeDef#
# SendCustomVerificationEmailRequestRequestTypeDef definition
class SendCustomVerificationEmailRequestRequestTypeDef(TypedDict):
EmailAddress: str,
TemplateName: str,
ConfigurationSetName: NotRequired[str],
SetActiveReceiptRuleSetRequestRequestTypeDef#
# SetActiveReceiptRuleSetRequestRequestTypeDef definition
class SetActiveReceiptRuleSetRequestRequestTypeDef(TypedDict):
RuleSetName: NotRequired[str],
SetIdentityDkimEnabledRequestRequestTypeDef#
# SetIdentityDkimEnabledRequestRequestTypeDef definition
class SetIdentityDkimEnabledRequestRequestTypeDef(TypedDict):
Identity: str,
DkimEnabled: bool,
SetIdentityFeedbackForwardingEnabledRequestRequestTypeDef#
# SetIdentityFeedbackForwardingEnabledRequestRequestTypeDef definition
class SetIdentityFeedbackForwardingEnabledRequestRequestTypeDef(TypedDict):
Identity: str,
ForwardingEnabled: bool,
SetIdentityHeadersInNotificationsEnabledRequestRequestTypeDef#
# SetIdentityHeadersInNotificationsEnabledRequestRequestTypeDef definition
class SetIdentityHeadersInNotificationsEnabledRequestRequestTypeDef(TypedDict):
Identity: str,
NotificationType: NotificationTypeType, # (1)
Enabled: bool,
SetIdentityMailFromDomainRequestRequestTypeDef#
# SetIdentityMailFromDomainRequestRequestTypeDef definition
class SetIdentityMailFromDomainRequestRequestTypeDef(TypedDict):
Identity: str,
MailFromDomain: NotRequired[str],
BehaviorOnMXFailure: NotRequired[BehaviorOnMXFailureType], # (1)
SetIdentityNotificationTopicRequestRequestTypeDef#
# SetIdentityNotificationTopicRequestRequestTypeDef definition
class SetIdentityNotificationTopicRequestRequestTypeDef(TypedDict):
Identity: str,
NotificationType: NotificationTypeType, # (1)
SnsTopic: NotRequired[str],
SetReceiptRulePositionRequestRequestTypeDef#
# SetReceiptRulePositionRequestRequestTypeDef definition
class SetReceiptRulePositionRequestRequestTypeDef(TypedDict):
RuleSetName: str,
RuleName: str,
After: NotRequired[str],
TestRenderTemplateRequestRequestTypeDef#
# TestRenderTemplateRequestRequestTypeDef definition
class TestRenderTemplateRequestRequestTypeDef(TypedDict):
TemplateName: str,
TemplateData: str,
UpdateAccountSendingEnabledRequestRequestTypeDef#
# UpdateAccountSendingEnabledRequestRequestTypeDef definition
class UpdateAccountSendingEnabledRequestRequestTypeDef(TypedDict):
Enabled: NotRequired[bool],
UpdateConfigurationSetReputationMetricsEnabledRequestRequestTypeDef#
# UpdateConfigurationSetReputationMetricsEnabledRequestRequestTypeDef definition
class UpdateConfigurationSetReputationMetricsEnabledRequestRequestTypeDef(TypedDict):
ConfigurationSetName: str,
Enabled: bool,
UpdateConfigurationSetSendingEnabledRequestRequestTypeDef#
# UpdateConfigurationSetSendingEnabledRequestRequestTypeDef definition
class UpdateConfigurationSetSendingEnabledRequestRequestTypeDef(TypedDict):
ConfigurationSetName: str,
Enabled: bool,
UpdateCustomVerificationEmailTemplateRequestRequestTypeDef#
# UpdateCustomVerificationEmailTemplateRequestRequestTypeDef definition
class UpdateCustomVerificationEmailTemplateRequestRequestTypeDef(TypedDict):
TemplateName: str,
FromEmailAddress: NotRequired[str],
TemplateSubject: NotRequired[str],
TemplateContent: NotRequired[str],
SuccessRedirectionURL: NotRequired[str],
FailureRedirectionURL: NotRequired[str],
VerifyDomainDkimRequestRequestTypeDef#
# VerifyDomainDkimRequestRequestTypeDef definition
class VerifyDomainDkimRequestRequestTypeDef(TypedDict):
Domain: str,
VerifyDomainIdentityRequestRequestTypeDef#
# VerifyDomainIdentityRequestRequestTypeDef definition
class VerifyDomainIdentityRequestRequestTypeDef(TypedDict):
Domain: str,
VerifyEmailAddressRequestRequestTypeDef#
# VerifyEmailAddressRequestRequestTypeDef definition
class VerifyEmailAddressRequestRequestTypeDef(TypedDict):
EmailAddress: str,
VerifyEmailIdentityRequestRequestTypeDef#
# VerifyEmailIdentityRequestRequestTypeDef definition
class VerifyEmailIdentityRequestRequestTypeDef(TypedDict):
EmailAddress: str,
RawMessageTypeDef#
# RawMessageTypeDef definition
class RawMessageTypeDef(TypedDict):
Data: BlobTypeDef,
BodyTypeDef#
# BodyTypeDef definition
class BodyTypeDef(TypedDict):
Text: NotRequired[ContentTypeDef], # (1)
Html: NotRequired[ContentTypeDef], # (1)
- See ContentTypeDef
- See ContentTypeDef
BulkEmailDestinationTypeDef#
# BulkEmailDestinationTypeDef definition
class BulkEmailDestinationTypeDef(TypedDict):
Destination: DestinationTypeDef, # (1)
ReplacementTags: NotRequired[Sequence[MessageTagTypeDef]], # (2)
ReplacementTemplateData: NotRequired[str],
- See DestinationTypeDef
- See MessageTagTypeDef
SendTemplatedEmailRequestRequestTypeDef#
# SendTemplatedEmailRequestRequestTypeDef definition
class SendTemplatedEmailRequestRequestTypeDef(TypedDict):
Source: str,
Destination: DestinationTypeDef, # (1)
Template: str,
TemplateData: str,
ReplyToAddresses: NotRequired[Sequence[str]],
ReturnPath: NotRequired[str],
SourceArn: NotRequired[str],
ReturnPathArn: NotRequired[str],
Tags: NotRequired[Sequence[MessageTagTypeDef]], # (2)
ConfigurationSetName: NotRequired[str],
TemplateArn: NotRequired[str],
- See DestinationTypeDef
- See MessageTagTypeDef
CloudWatchDestinationOutputTypeDef#
# CloudWatchDestinationOutputTypeDef definition
class CloudWatchDestinationOutputTypeDef(TypedDict):
DimensionConfigurations: list[CloudWatchDimensionConfigurationTypeDef], # (1)
CloudWatchDestinationTypeDef#
# CloudWatchDestinationTypeDef definition
class CloudWatchDestinationTypeDef(TypedDict):
DimensionConfigurations: Sequence[CloudWatchDimensionConfigurationTypeDef], # (1)
CreateConfigurationSetRequestRequestTypeDef#
# CreateConfigurationSetRequestRequestTypeDef definition
class CreateConfigurationSetRequestRequestTypeDef(TypedDict):
ConfigurationSet: ConfigurationSetTypeDef, # (1)
CreateConfigurationSetTrackingOptionsRequestRequestTypeDef#
# CreateConfigurationSetTrackingOptionsRequestRequestTypeDef definition
class CreateConfigurationSetTrackingOptionsRequestRequestTypeDef(TypedDict):
ConfigurationSetName: str,
TrackingOptions: TrackingOptionsTypeDef, # (1)
UpdateConfigurationSetTrackingOptionsRequestRequestTypeDef#
# UpdateConfigurationSetTrackingOptionsRequestRequestTypeDef definition
class UpdateConfigurationSetTrackingOptionsRequestRequestTypeDef(TypedDict):
ConfigurationSetName: str,
TrackingOptions: TrackingOptionsTypeDef, # (1)
CreateTemplateRequestRequestTypeDef#
# CreateTemplateRequestRequestTypeDef definition
class CreateTemplateRequestRequestTypeDef(TypedDict):
Template: TemplateTypeDef, # (1)
- See TemplateTypeDef
UpdateTemplateRequestRequestTypeDef#
# UpdateTemplateRequestRequestTypeDef definition
class UpdateTemplateRequestRequestTypeDef(TypedDict):
Template: TemplateTypeDef, # (1)
- See TemplateTypeDef
PutConfigurationSetDeliveryOptionsRequestRequestTypeDef#
# PutConfigurationSetDeliveryOptionsRequestRequestTypeDef definition
class PutConfigurationSetDeliveryOptionsRequestRequestTypeDef(TypedDict):
ConfigurationSetName: str,
DeliveryOptions: NotRequired[DeliveryOptionsTypeDef], # (1)
EmptyResponseMetadataTypeDef#
# EmptyResponseMetadataTypeDef definition
class EmptyResponseMetadataTypeDef(TypedDict):
ResponseMetadata: ResponseMetadataTypeDef, # (1)
GetAccountSendingEnabledResponseTypeDef#
# GetAccountSendingEnabledResponseTypeDef definition
class GetAccountSendingEnabledResponseTypeDef(TypedDict):
Enabled: bool,
ResponseMetadata: ResponseMetadataTypeDef, # (1)
GetCustomVerificationEmailTemplateResponseTypeDef#
# GetCustomVerificationEmailTemplateResponseTypeDef definition
class GetCustomVerificationEmailTemplateResponseTypeDef(TypedDict):
TemplateName: str,
FromEmailAddress: str,
TemplateSubject: str,
TemplateContent: str,
SuccessRedirectionURL: str,
FailureRedirectionURL: str,
ResponseMetadata: ResponseMetadataTypeDef, # (1)
GetIdentityPoliciesResponseTypeDef#
# GetIdentityPoliciesResponseTypeDef definition
class GetIdentityPoliciesResponseTypeDef(TypedDict):
Policies: dict[str, str],
ResponseMetadata: ResponseMetadataTypeDef, # (1)
GetSendQuotaResponseTypeDef#
# GetSendQuotaResponseTypeDef definition
class GetSendQuotaResponseTypeDef(TypedDict):
Max24HourSend: float,
MaxSendRate: float,
SentLast24Hours: float,
ResponseMetadata: ResponseMetadataTypeDef, # (1)
GetTemplateResponseTypeDef#
# GetTemplateResponseTypeDef definition
class GetTemplateResponseTypeDef(TypedDict):
Template: TemplateTypeDef, # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
ListConfigurationSetsResponseTypeDef#
# ListConfigurationSetsResponseTypeDef definition
class ListConfigurationSetsResponseTypeDef(TypedDict):
ConfigurationSets: list[ConfigurationSetTypeDef], # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
NextToken: NotRequired[str],
ListCustomVerificationEmailTemplatesResponseTypeDef#
# ListCustomVerificationEmailTemplatesResponseTypeDef definition
class ListCustomVerificationEmailTemplatesResponseTypeDef(TypedDict):
CustomVerificationEmailTemplates: list[CustomVerificationEmailTemplateTypeDef], # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
NextToken: NotRequired[str],
ListIdentitiesResponseTypeDef#
# ListIdentitiesResponseTypeDef definition
class ListIdentitiesResponseTypeDef(TypedDict):
Identities: list[str],
ResponseMetadata: ResponseMetadataTypeDef, # (1)
NextToken: NotRequired[str],
ListIdentityPoliciesResponseTypeDef#
# ListIdentityPoliciesResponseTypeDef definition
class ListIdentityPoliciesResponseTypeDef(TypedDict):
PolicyNames: list[str],
ResponseMetadata: ResponseMetadataTypeDef, # (1)
ListReceiptRuleSetsResponseTypeDef#
# ListReceiptRuleSetsResponseTypeDef definition
class ListReceiptRuleSetsResponseTypeDef(TypedDict):
RuleSets: list[ReceiptRuleSetMetadataTypeDef], # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
NextToken: NotRequired[str],
ListVerifiedEmailAddressesResponseTypeDef#
# ListVerifiedEmailAddressesResponseTypeDef definition
class ListVerifiedEmailAddressesResponseTypeDef(TypedDict):
VerifiedEmailAddresses: list[str],
ResponseMetadata: ResponseMetadataTypeDef, # (1)
SendBounceResponseTypeDef#
# SendBounceResponseTypeDef definition
class SendBounceResponseTypeDef(TypedDict):
MessageId: str,
ResponseMetadata: ResponseMetadataTypeDef, # (1)
SendBulkTemplatedEmailResponseTypeDef#
# SendBulkTemplatedEmailResponseTypeDef definition
class SendBulkTemplatedEmailResponseTypeDef(TypedDict):
Status: list[BulkEmailDestinationStatusTypeDef], # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
SendCustomVerificationEmailResponseTypeDef#
# SendCustomVerificationEmailResponseTypeDef definition
class SendCustomVerificationEmailResponseTypeDef(TypedDict):
MessageId: str,
ResponseMetadata: ResponseMetadataTypeDef, # (1)
SendEmailResponseTypeDef#
# SendEmailResponseTypeDef definition
class SendEmailResponseTypeDef(TypedDict):
MessageId: str,
ResponseMetadata: ResponseMetadataTypeDef, # (1)
SendRawEmailResponseTypeDef#
# SendRawEmailResponseTypeDef definition
class SendRawEmailResponseTypeDef(TypedDict):
MessageId: str,
ResponseMetadata: ResponseMetadataTypeDef, # (1)
SendTemplatedEmailResponseTypeDef#
# SendTemplatedEmailResponseTypeDef definition
class SendTemplatedEmailResponseTypeDef(TypedDict):
MessageId: str,
ResponseMetadata: ResponseMetadataTypeDef, # (1)
TestRenderTemplateResponseTypeDef#
# TestRenderTemplateResponseTypeDef definition
class TestRenderTemplateResponseTypeDef(TypedDict):
RenderedTemplate: str,
ResponseMetadata: ResponseMetadataTypeDef, # (1)
VerifyDomainDkimResponseTypeDef#
# VerifyDomainDkimResponseTypeDef definition
class VerifyDomainDkimResponseTypeDef(TypedDict):
DkimTokens: list[str],
ResponseMetadata: ResponseMetadataTypeDef, # (1)
VerifyDomainIdentityResponseTypeDef#
# VerifyDomainIdentityResponseTypeDef definition
class VerifyDomainIdentityResponseTypeDef(TypedDict):
VerificationToken: str,
ResponseMetadata: ResponseMetadataTypeDef, # (1)
GetIdentityDkimAttributesResponseTypeDef#
# GetIdentityDkimAttributesResponseTypeDef definition
class GetIdentityDkimAttributesResponseTypeDef(TypedDict):
DkimAttributes: dict[str, IdentityDkimAttributesTypeDef], # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
GetIdentityMailFromDomainAttributesResponseTypeDef#
# GetIdentityMailFromDomainAttributesResponseTypeDef definition
class GetIdentityMailFromDomainAttributesResponseTypeDef(TypedDict):
MailFromDomainAttributes: dict[str, IdentityMailFromDomainAttributesTypeDef], # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
GetIdentityNotificationAttributesResponseTypeDef#
# GetIdentityNotificationAttributesResponseTypeDef definition
class GetIdentityNotificationAttributesResponseTypeDef(TypedDict):
NotificationAttributes: dict[str, IdentityNotificationAttributesTypeDef], # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
GetIdentityVerificationAttributesRequestWaitTypeDef#
# GetIdentityVerificationAttributesRequestWaitTypeDef definition
class GetIdentityVerificationAttributesRequestWaitTypeDef(TypedDict):
Identities: Sequence[str],
WaiterConfig: NotRequired[WaiterConfigTypeDef], # (1)
GetIdentityVerificationAttributesResponseTypeDef#
# GetIdentityVerificationAttributesResponseTypeDef definition
class GetIdentityVerificationAttributesResponseTypeDef(TypedDict):
VerificationAttributes: dict[str, IdentityVerificationAttributesTypeDef], # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
GetSendStatisticsResponseTypeDef#
# GetSendStatisticsResponseTypeDef definition
class GetSendStatisticsResponseTypeDef(TypedDict):
SendDataPoints: list[SendDataPointTypeDef], # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
ListConfigurationSetsRequestPaginateTypeDef#
# ListConfigurationSetsRequestPaginateTypeDef definition
class ListConfigurationSetsRequestPaginateTypeDef(TypedDict):
PaginationConfig: NotRequired[PaginatorConfigTypeDef], # (1)
ListCustomVerificationEmailTemplatesRequestPaginateTypeDef#
# ListCustomVerificationEmailTemplatesRequestPaginateTypeDef definition
class ListCustomVerificationEmailTemplatesRequestPaginateTypeDef(TypedDict):
PaginationConfig: NotRequired[PaginatorConfigTypeDef], # (1)
ListIdentitiesRequestPaginateTypeDef#
# ListIdentitiesRequestPaginateTypeDef definition
class ListIdentitiesRequestPaginateTypeDef(TypedDict):
IdentityType: NotRequired[IdentityTypeType], # (1)
PaginationConfig: NotRequired[PaginatorConfigTypeDef], # (2)
ListReceiptRuleSetsRequestPaginateTypeDef#
# ListReceiptRuleSetsRequestPaginateTypeDef definition
class ListReceiptRuleSetsRequestPaginateTypeDef(TypedDict):
PaginationConfig: NotRequired[PaginatorConfigTypeDef], # (1)
ListTemplatesRequestPaginateTypeDef#
# ListTemplatesRequestPaginateTypeDef definition
class ListTemplatesRequestPaginateTypeDef(TypedDict):
PaginationConfig: NotRequired[PaginatorConfigTypeDef], # (1)
ListTemplatesResponseTypeDef#
# ListTemplatesResponseTypeDef definition
class ListTemplatesResponseTypeDef(TypedDict):
TemplatesMetadata: list[TemplateMetadataTypeDef], # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
NextToken: NotRequired[str],
MessageDsnTypeDef#
# MessageDsnTypeDef definition
class MessageDsnTypeDef(TypedDict):
ReportingMta: str,
ArrivalDate: NotRequired[TimestampTypeDef],
ExtensionFields: NotRequired[Sequence[ExtensionFieldTypeDef]], # (1)
RecipientDsnFieldsTypeDef#
# RecipientDsnFieldsTypeDef definition
class RecipientDsnFieldsTypeDef(TypedDict):
Action: DsnActionType, # (1)
Status: str,
FinalRecipient: NotRequired[str],
RemoteMta: NotRequired[str],
DiagnosticCode: NotRequired[str],
LastAttemptDate: NotRequired[TimestampTypeDef],
ExtensionFields: NotRequired[Sequence[ExtensionFieldTypeDef]], # (2)
- See DsnActionType
- See ExtensionFieldTypeDef
ReceiptActionTypeDef#
# ReceiptActionTypeDef definition
class ReceiptActionTypeDef(TypedDict):
S3Action: NotRequired[S3ActionTypeDef], # (1)
BounceAction: NotRequired[BounceActionTypeDef], # (2)
WorkmailAction: NotRequired[WorkmailActionTypeDef], # (3)
LambdaAction: NotRequired[LambdaActionTypeDef], # (4)
StopAction: NotRequired[StopActionTypeDef], # (5)
AddHeaderAction: NotRequired[AddHeaderActionTypeDef], # (6)
SNSAction: NotRequired[SNSActionTypeDef], # (7)
ConnectAction: NotRequired[ConnectActionTypeDef], # (8)
- See S3ActionTypeDef
- See BounceActionTypeDef
- See WorkmailActionTypeDef
- See LambdaActionTypeDef
- See StopActionTypeDef
- See AddHeaderActionTypeDef
- See SNSActionTypeDef
- See ConnectActionTypeDef
ReceiptFilterTypeDef#
# ReceiptFilterTypeDef definition
class ReceiptFilterTypeDef(TypedDict):
Name: str,
IpFilter: ReceiptIpFilterTypeDef, # (1)
SendRawEmailRequestRequestTypeDef#
# SendRawEmailRequestRequestTypeDef definition
class SendRawEmailRequestRequestTypeDef(TypedDict):
RawMessage: RawMessageTypeDef, # (1)
Source: NotRequired[str],
Destinations: NotRequired[Sequence[str]],
FromArn: NotRequired[str],
SourceArn: NotRequired[str],
ReturnPathArn: NotRequired[str],
Tags: NotRequired[Sequence[MessageTagTypeDef]], # (2)
ConfigurationSetName: NotRequired[str],
- See RawMessageTypeDef
- See MessageTagTypeDef
MessageTypeDef#
# MessageTypeDef definition
class MessageTypeDef(TypedDict):
Subject: ContentTypeDef, # (1)
Body: BodyTypeDef, # (2)
- See ContentTypeDef
- See BodyTypeDef
SendBulkTemplatedEmailRequestRequestTypeDef#
# SendBulkTemplatedEmailRequestRequestTypeDef definition
class SendBulkTemplatedEmailRequestRequestTypeDef(TypedDict):
Source: str,
Template: str,
DefaultTemplateData: str,
Destinations: Sequence[BulkEmailDestinationTypeDef], # (1)
SourceArn: NotRequired[str],
ReplyToAddresses: NotRequired[Sequence[str]],
ReturnPath: NotRequired[str],
ReturnPathArn: NotRequired[str],
ConfigurationSetName: NotRequired[str],
DefaultTags: NotRequired[Sequence[MessageTagTypeDef]], # (2)
TemplateArn: NotRequired[str],
EventDestinationOutputTypeDef#
# EventDestinationOutputTypeDef definition
class EventDestinationOutputTypeDef(TypedDict):
Name: str,
MatchingEventTypes: list[EventTypeType], # (1)
Enabled: NotRequired[bool],
KinesisFirehoseDestination: NotRequired[KinesisFirehoseDestinationTypeDef], # (2)
CloudWatchDestination: NotRequired[CloudWatchDestinationOutputTypeDef], # (3)
SNSDestination: NotRequired[SNSDestinationTypeDef], # (4)
- See EventTypeType
- See KinesisFirehoseDestinationTypeDef
- See CloudWatchDestinationOutputTypeDef
- See SNSDestinationTypeDef
BouncedRecipientInfoTypeDef#
# BouncedRecipientInfoTypeDef definition
class BouncedRecipientInfoTypeDef(TypedDict):
Recipient: str,
RecipientArn: NotRequired[str],
BounceType: NotRequired[BounceTypeType], # (1)
RecipientDsnFields: NotRequired[RecipientDsnFieldsTypeDef], # (2)
ReceiptRuleOutputTypeDef#
# ReceiptRuleOutputTypeDef definition
class ReceiptRuleOutputTypeDef(TypedDict):
Name: str,
Enabled: NotRequired[bool],
TlsPolicy: NotRequired[TlsPolicyType], # (1)
Recipients: NotRequired[list[str]],
Actions: NotRequired[list[ReceiptActionTypeDef]], # (2)
ScanEnabled: NotRequired[bool],
- See TlsPolicyType
- See ReceiptActionTypeDef
ReceiptRuleTypeDef#
# ReceiptRuleTypeDef definition
class ReceiptRuleTypeDef(TypedDict):
Name: str,
Enabled: NotRequired[bool],
TlsPolicy: NotRequired[TlsPolicyType], # (1)
Recipients: NotRequired[Sequence[str]],
Actions: NotRequired[Sequence[ReceiptActionTypeDef]], # (2)
ScanEnabled: NotRequired[bool],
- See TlsPolicyType
- See ReceiptActionTypeDef
CreateReceiptFilterRequestRequestTypeDef#
# CreateReceiptFilterRequestRequestTypeDef definition
class CreateReceiptFilterRequestRequestTypeDef(TypedDict):
Filter: ReceiptFilterTypeDef, # (1)
ListReceiptFiltersResponseTypeDef#
# ListReceiptFiltersResponseTypeDef definition
class ListReceiptFiltersResponseTypeDef(TypedDict):
Filters: list[ReceiptFilterTypeDef], # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
SendEmailRequestRequestTypeDef#
# SendEmailRequestRequestTypeDef definition
class SendEmailRequestRequestTypeDef(TypedDict):
Source: str,
Destination: DestinationTypeDef, # (1)
Message: MessageTypeDef, # (2)
ReplyToAddresses: NotRequired[Sequence[str]],
ReturnPath: NotRequired[str],
SourceArn: NotRequired[str],
ReturnPathArn: NotRequired[str],
Tags: NotRequired[Sequence[MessageTagTypeDef]], # (3)
ConfigurationSetName: NotRequired[str],
- See DestinationTypeDef
- See MessageTypeDef
- See MessageTagTypeDef
DescribeConfigurationSetResponseTypeDef#
# DescribeConfigurationSetResponseTypeDef definition
class DescribeConfigurationSetResponseTypeDef(TypedDict):
ConfigurationSet: ConfigurationSetTypeDef, # (1)
EventDestinations: list[EventDestinationOutputTypeDef], # (2)
TrackingOptions: TrackingOptionsTypeDef, # (3)
DeliveryOptions: DeliveryOptionsTypeDef, # (4)
ReputationOptions: ReputationOptionsTypeDef, # (5)
ResponseMetadata: ResponseMetadataTypeDef, # (6)
- See ConfigurationSetTypeDef
- See EventDestinationOutputTypeDef
- See TrackingOptionsTypeDef
- See DeliveryOptionsTypeDef
- See ReputationOptionsTypeDef
- See ResponseMetadataTypeDef
EventDestinationTypeDef#
# EventDestinationTypeDef definition
class EventDestinationTypeDef(TypedDict):
Name: str,
MatchingEventTypes: Sequence[EventTypeType], # (1)
Enabled: NotRequired[bool],
KinesisFirehoseDestination: NotRequired[KinesisFirehoseDestinationTypeDef], # (2)
CloudWatchDestination: NotRequired[CloudWatchDestinationUnionTypeDef], # (3)
SNSDestination: NotRequired[SNSDestinationTypeDef], # (4)
- See EventTypeType
- See KinesisFirehoseDestinationTypeDef
- See CloudWatchDestinationTypeDef CloudWatchDestinationOutputTypeDef
- See SNSDestinationTypeDef
SendBounceRequestRequestTypeDef#
# SendBounceRequestRequestTypeDef definition
class SendBounceRequestRequestTypeDef(TypedDict):
OriginalMessageId: str,
BounceSender: str,
BouncedRecipientInfoList: Sequence[BouncedRecipientInfoTypeDef], # (1)
Explanation: NotRequired[str],
MessageDsn: NotRequired[MessageDsnTypeDef], # (2)
BounceSenderArn: NotRequired[str],
DescribeActiveReceiptRuleSetResponseTypeDef#
# DescribeActiveReceiptRuleSetResponseTypeDef definition
class DescribeActiveReceiptRuleSetResponseTypeDef(TypedDict):
Metadata: ReceiptRuleSetMetadataTypeDef, # (1)
Rules: list[ReceiptRuleOutputTypeDef], # (2)
ResponseMetadata: ResponseMetadataTypeDef, # (3)
DescribeReceiptRuleResponseTypeDef#
# DescribeReceiptRuleResponseTypeDef definition
class DescribeReceiptRuleResponseTypeDef(TypedDict):
Rule: ReceiptRuleOutputTypeDef, # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
DescribeReceiptRuleSetResponseTypeDef#
# DescribeReceiptRuleSetResponseTypeDef definition
class DescribeReceiptRuleSetResponseTypeDef(TypedDict):
Metadata: ReceiptRuleSetMetadataTypeDef, # (1)
Rules: list[ReceiptRuleOutputTypeDef], # (2)
ResponseMetadata: ResponseMetadataTypeDef, # (3)
CreateReceiptRuleRequestRequestTypeDef#
# CreateReceiptRuleRequestRequestTypeDef definition
class CreateReceiptRuleRequestRequestTypeDef(TypedDict):
RuleSetName: str,
Rule: ReceiptRuleTypeDef, # (1)
After: NotRequired[str],
UpdateReceiptRuleRequestRequestTypeDef#
# UpdateReceiptRuleRequestRequestTypeDef definition
class UpdateReceiptRuleRequestRequestTypeDef(TypedDict):
RuleSetName: str,
Rule: ReceiptRuleTypeDef, # (1)
CreateConfigurationSetEventDestinationRequestRequestTypeDef#
# CreateConfigurationSetEventDestinationRequestRequestTypeDef definition
class CreateConfigurationSetEventDestinationRequestRequestTypeDef(TypedDict):
ConfigurationSetName: str,
EventDestination: EventDestinationTypeDef, # (1)
UpdateConfigurationSetEventDestinationRequestRequestTypeDef#
# UpdateConfigurationSetEventDestinationRequestRequestTypeDef definition
class UpdateConfigurationSetEventDestinationRequestRequestTypeDef(TypedDict):
ConfigurationSetName: str,
EventDestination: EventDestinationTypeDef, # (1)