API Reference

Amazon Simple Email Service

API Version 2010-12-01

Copyright © 2024 Amazon Web Services, Inc. and/or its affiliates. All rights reserved.
Amazon Simple Email Service API Reference

Amazon Simple Email Service: API Reference

Copyright © 2024 Amazon Web Services, Inc. and/or its affiliates. All rights reserved.

Amazon's trademarks and trade dress may not be used in connection with any product or service
that is not Amazon's, in any manner that is likely to cause confusion among customers, or in any
manner that disparages or discredits Amazon. All other trademarks not owned by Amazon are
the property of their respective owners, who may or may not be affiliated with, connected to, or
sponsored by Amazon.
Amazon Simple Email Service API Reference

Table of Contents
Welcome ........................................................................................................................................... 1
Actions .............................................................................................................................................. 2
CloneReceiptRuleSet .................................................................................................................................... 5
Request Parameters ................................................................................................................................ 5
Errors .......................................................................................................................................................... 5
See Also ..................................................................................................................................................... 6
CreateConfigurationSet ............................................................................................................................... 7
Request Parameters ................................................................................................................................ 7
Errors .......................................................................................................................................................... 7
See Also ..................................................................................................................................................... 8
CreateConfigurationSetEventDestination ................................................................................................ 9
Request Parameters ................................................................................................................................ 9
Errors .......................................................................................................................................................... 9
See Also .................................................................................................................................................. 10
CreateConfigurationSetTrackingOptions ............................................................................................... 12
Request Parameters .............................................................................................................................. 12
Errors ....................................................................................................................................................... 12
See Also .................................................................................................................................................. 13
CreateCustomVerificationEmailTemplate .............................................................................................. 14
Request Parameters .............................................................................................................................. 14
Errors ....................................................................................................................................................... 15
See Also .................................................................................................................................................. 16
CreateReceiptFilter ..................................................................................................................................... 17
Request Parameters .............................................................................................................................. 17
Errors ....................................................................................................................................................... 17
See Also .................................................................................................................................................. 17
CreateReceiptRule ...................................................................................................................................... 19
Request Parameters .............................................................................................................................. 19
Errors ....................................................................................................................................................... 19
See Also .................................................................................................................................................. 21
CreateReceiptRuleSet ................................................................................................................................ 22
Request Parameters .............................................................................................................................. 22
Errors ....................................................................................................................................................... 22
See Also .................................................................................................................................................. 23

API Version 2010-12-01 iii

Amazon Simple Email Service API Reference

CreateTemplate ........................................................................................................................................... 24
Request Parameters .............................................................................................................................. 24
Errors ....................................................................................................................................................... 24
See Also .................................................................................................................................................. 25
DeleteConfigurationSet ............................................................................................................................. 26
Request Parameters .............................................................................................................................. 26
Errors ....................................................................................................................................................... 26
See Also .................................................................................................................................................. 26
DeleteConfigurationSetEventDestination .............................................................................................. 28
Request Parameters .............................................................................................................................. 28
Errors ....................................................................................................................................................... 28
See Also .................................................................................................................................................. 29
DeleteConfigurationSetTrackingOptions ............................................................................................... 30
Request Parameters .............................................................................................................................. 30
Errors ....................................................................................................................................................... 30
See Also .................................................................................................................................................. 31
DeleteCustomVerificationEmailTemplate .............................................................................................. 32
Request Parameters .............................................................................................................................. 32
Errors ....................................................................................................................................................... 32
See Also .................................................................................................................................................. 32
DeleteIdentity .............................................................................................................................................. 34
Request Parameters .............................................................................................................................. 34
Errors ....................................................................................................................................................... 34
See Also .................................................................................................................................................. 34
DeleteIdentityPolicy ................................................................................................................................... 35
Request Parameters .............................................................................................................................. 35
Errors ....................................................................................................................................................... 36
See Also .................................................................................................................................................. 36
DeleteReceiptFilter ..................................................................................................................................... 37
Request Parameters .............................................................................................................................. 37
Errors ....................................................................................................................................................... 37
See Also .................................................................................................................................................. 37
DeleteReceiptRule ...................................................................................................................................... 39
Request Parameters .............................................................................................................................. 39
Errors ....................................................................................................................................................... 39
See Also .................................................................................................................................................. 39

API Version 2010-12-01 iv

Amazon Simple Email Service API Reference

DeleteReceiptRuleSet ................................................................................................................................ 41
Request Parameters .............................................................................................................................. 41
Errors ....................................................................................................................................................... 41
See Also .................................................................................................................................................. 41
DeleteTemplate ........................................................................................................................................... 43
Request Parameters .............................................................................................................................. 43
Errors ....................................................................................................................................................... 43
See Also .................................................................................................................................................. 43
DeleteVerifiedEmailAddress ..................................................................................................................... 44
Request Parameters .............................................................................................................................. 44
Errors ....................................................................................................................................................... 44
See Also .................................................................................................................................................. 44
DescribeActiveReceiptRuleSet .................................................................................................................. 45
Response Elements ............................................................................................................................... 45
Errors ....................................................................................................................................................... 45
See Also .................................................................................................................................................. 45
DescribeConfigurationSet ......................................................................................................................... 47
Request Parameters .............................................................................................................................. 47
Response Elements ............................................................................................................................... 47
Errors ....................................................................................................................................................... 48
See Also .................................................................................................................................................. 48
DescribeReceiptRule ................................................................................................................................... 50
Request Parameters .............................................................................................................................. 50
Response Elements ............................................................................................................................... 50
Errors ....................................................................................................................................................... 50
See Also .................................................................................................................................................. 51
DescribeReceiptRuleSet ............................................................................................................................. 52
Request Parameters .............................................................................................................................. 52
Response Elements ............................................................................................................................... 52
Errors ....................................................................................................................................................... 52
See Also .................................................................................................................................................. 53
GetAccountSendingEnabled ..................................................................................................................... 54
Response Elements ............................................................................................................................... 54
Errors ....................................................................................................................................................... 54
See Also .................................................................................................................................................. 54
GetCustomVerificationEmailTemplate ................................................................................................... 55

API Version 2010-12-01 v

Amazon Simple Email Service API Reference

Request Parameters .............................................................................................................................. 55

Response Elements ............................................................................................................................... 55
Errors ....................................................................................................................................................... 56
See Also .................................................................................................................................................. 56
GetIdentityDkimAttributes ....................................................................................................................... 58
Request Parameters .............................................................................................................................. 58
Response Elements ............................................................................................................................... 58
Errors ....................................................................................................................................................... 59
See Also .................................................................................................................................................. 59
GetIdentityMailFromDomainAttributes .................................................................................................. 60
Request Parameters .............................................................................................................................. 60
Response Elements ............................................................................................................................... 60
Errors ....................................................................................................................................................... 60
See Also .................................................................................................................................................. 60
GetIdentityNotificationAttributes ........................................................................................................... 62
Request Parameters .............................................................................................................................. 62
Response Elements ............................................................................................................................... 62
Errors ....................................................................................................................................................... 62
See Also .................................................................................................................................................. 63
GetIdentityPolicies ..................................................................................................................................... 64
Request Parameters .............................................................................................................................. 64
Response Elements ............................................................................................................................... 65
Errors ....................................................................................................................................................... 65
See Also .................................................................................................................................................. 65
GetIdentityVerificationAttributes ............................................................................................................ 66
Request Parameters .............................................................................................................................. 66
Response Elements ............................................................................................................................... 66
Errors ....................................................................................................................................................... 67
See Also .................................................................................................................................................. 67
GetSendQuota ............................................................................................................................................. 68
Response Elements ............................................................................................................................... 68
Errors ....................................................................................................................................................... 68
See Also .................................................................................................................................................. 69
GetSendStatistics ........................................................................................................................................ 70
Response Elements ............................................................................................................................... 70
Errors ....................................................................................................................................................... 70

API Version 2010-12-01 vi

Amazon Simple Email Service API Reference

See Also .................................................................................................................................................. 70

GetTemplate ................................................................................................................................................ 71
Request Parameters .............................................................................................................................. 71
Response Elements ............................................................................................................................... 71
Errors ....................................................................................................................................................... 71
See Also .................................................................................................................................................. 72
ListConfigurationSets ................................................................................................................................ 73
Request Parameters .............................................................................................................................. 73
Response Elements ............................................................................................................................... 73
Errors ....................................................................................................................................................... 74
See Also .................................................................................................................................................. 74
ListCustomVerificationEmailTemplates .................................................................................................. 75
Request Parameters .............................................................................................................................. 75
Response Elements ............................................................................................................................... 75
Errors ....................................................................................................................................................... 76
See Also .................................................................................................................................................. 76
ListIdentities ................................................................................................................................................ 77
Request Parameters .............................................................................................................................. 77
Response Elements ............................................................................................................................... 78
Errors ....................................................................................................................................................... 78
See Also .................................................................................................................................................. 78
ListIdentityPolicies ..................................................................................................................................... 80
Request Parameters .............................................................................................................................. 80
Response Elements ............................................................................................................................... 80
Errors ....................................................................................................................................................... 81
See Also .................................................................................................................................................. 81
ListReceiptFilters ......................................................................................................................................... 82
Response Elements ............................................................................................................................... 82
Errors ....................................................................................................................................................... 82
See Also .................................................................................................................................................. 82
ListReceiptRuleSets .................................................................................................................................... 84
Request Parameters .............................................................................................................................. 84
Response Elements ............................................................................................................................... 84
Errors ....................................................................................................................................................... 85
See Also .................................................................................................................................................. 85
ListTemplates .............................................................................................................................................. 86

API Version 2010-12-01 vii

Amazon Simple Email Service API Reference

Request Parameters .............................................................................................................................. 86

Response Elements ............................................................................................................................... 86
Errors ....................................................................................................................................................... 87
See Also .................................................................................................................................................. 87
ListVerifiedEmailAddresses ....................................................................................................................... 88
Response Elements ............................................................................................................................... 88
Errors ....................................................................................................................................................... 88
See Also .................................................................................................................................................. 88
PutConfigurationSetDeliveryOptions ..................................................................................................... 89
Request Parameters .............................................................................................................................. 89
Errors ....................................................................................................................................................... 89
See Also .................................................................................................................................................. 90
PutIdentityPolicy ........................................................................................................................................ 91
Request Parameters .............................................................................................................................. 91
Errors ....................................................................................................................................................... 92
See Also .................................................................................................................................................. 92
ReorderReceiptRuleSet .............................................................................................................................. 94
Request Parameters .............................................................................................................................. 94
Errors ....................................................................................................................................................... 94
See Also .................................................................................................................................................. 95
SendBounce ................................................................................................................................................. 96
Request Parameters .............................................................................................................................. 96
Response Elements ............................................................................................................................... 97
Errors ....................................................................................................................................................... 97
See Also .................................................................................................................................................. 98
SendBulkTemplatedEmail ......................................................................................................................... 99
Request Parameters .............................................................................................................................. 99
Response Elements ............................................................................................................................ 103
Errors ..................................................................................................................................................... 103
See Also ................................................................................................................................................ 104
SendCustomVerificationEmail ............................................................................................................... 105
Request Parameters ........................................................................................................................... 105
Response Elements ............................................................................................................................ 105
Errors ..................................................................................................................................................... 106
See Also ................................................................................................................................................ 107
SendEmail .................................................................................................................................................. 108

API Version 2010-12-01 viii

Amazon Simple Email Service API Reference

Request Parameters ........................................................................................................................... 108

Response Elements ............................................................................................................................ 111
Errors ..................................................................................................................................................... 111
See Also ................................................................................................................................................ 112
SendRawEmail .......................................................................................................................................... 114
Request Parameters ........................................................................................................................... 115
Response Elements ............................................................................................................................ 119
Errors ..................................................................................................................................................... 119
See Also ................................................................................................................................................ 120
SendTemplatedEmail ............................................................................................................................... 122
Request Parameters ........................................................................................................................... 123
Response Elements ............................................................................................................................ 126
Errors ..................................................................................................................................................... 126
See Also ................................................................................................................................................ 127
SetActiveReceiptRuleSet ......................................................................................................................... 129
Request Parameters ........................................................................................................................... 129
Errors ..................................................................................................................................................... 129
See Also ................................................................................................................................................ 129
SetIdentityDkimEnabled ......................................................................................................................... 131
Request Parameters ........................................................................................................................... 131
Errors ..................................................................................................................................................... 132
See Also ................................................................................................................................................ 132
SetIdentityFeedbackForwardingEnabled ............................................................................................. 133
Request Parameters ........................................................................................................................... 133
Errors ..................................................................................................................................................... 134
See Also ................................................................................................................................................ 134
SetIdentityHeadersInNotificationsEnabled ......................................................................................... 135
Request Parameters ........................................................................................................................... 135
Errors ..................................................................................................................................................... 136
See Also ................................................................................................................................................ 136
SetIdentityMailFromDomain .................................................................................................................. 137
Request Parameters ........................................................................................................................... 137
Errors ..................................................................................................................................................... 138
See Also ................................................................................................................................................ 138
SetIdentityNotificationTopic .................................................................................................................. 139
Request Parameters ........................................................................................................................... 139

API Version 2010-12-01 ix

Amazon Simple Email Service API Reference

Errors ..................................................................................................................................................... 140

See Also ................................................................................................................................................ 140
SetReceiptRulePosition ........................................................................................................................... 141
Request Parameters ........................................................................................................................... 141
Errors ..................................................................................................................................................... 141
See Also ................................................................................................................................................ 142
TestRenderTemplate ................................................................................................................................ 143
Request Parameters ........................................................................................................................... 143
Response Elements ............................................................................................................................ 143
Errors ..................................................................................................................................................... 144
See Also ................................................................................................................................................ 144
UpdateAccountSendingEnabled ............................................................................................................ 146
Request Parameters ........................................................................................................................... 146
Errors ..................................................................................................................................................... 146
See Also ................................................................................................................................................ 146
UpdateConfigurationSetEventDestination .......................................................................................... 148
Request Parameters ........................................................................................................................... 148
Errors ..................................................................................................................................................... 148
See Also ................................................................................................................................................ 149
UpdateConfigurationSetReputationMetricsEnabled ......................................................................... 151
Request Parameters ........................................................................................................................... 151
Errors ..................................................................................................................................................... 151
See Also ................................................................................................................................................ 152
UpdateConfigurationSetSendingEnabled ........................................................................................... 153
Request Parameters ........................................................................................................................... 153
Errors ..................................................................................................................................................... 153
See Also ................................................................................................................................................ 154
UpdateConfigurationSetTrackingOptions ........................................................................................... 155
Request Parameters ........................................................................................................................... 155
Errors ..................................................................................................................................................... 155
See Also ................................................................................................................................................ 156
UpdateCustomVerificationEmailTemplate .......................................................................................... 157
Request Parameters ........................................................................................................................... 157
Errors ..................................................................................................................................................... 158
See Also ................................................................................................................................................ 158
UpdateReceiptRule .................................................................................................................................. 160

API Version 2010-12-01 x

Amazon Simple Email Service API Reference

Request Parameters ........................................................................................................................... 160

Errors ..................................................................................................................................................... 160
See Also ................................................................................................................................................ 161
UpdateTemplate ....................................................................................................................................... 163
Request Parameters ........................................................................................................................... 163
Errors ..................................................................................................................................................... 163
See Also ................................................................................................................................................ 163
VerifyDomainDkim ................................................................................................................................... 165
Request Parameters ........................................................................................................................... 165
Response Elements ............................................................................................................................ 166
Errors ..................................................................................................................................................... 166
See Also ................................................................................................................................................ 166
VerifyDomainIdentity .............................................................................................................................. 168
Request Parameters ........................................................................................................................... 168
Response Elements ............................................................................................................................ 168
Errors ..................................................................................................................................................... 168
See Also ................................................................................................................................................ 169
VerifyEmailAddress .................................................................................................................................. 170
Request Parameters ........................................................................................................................... 170
Errors ..................................................................................................................................................... 170
See Also ................................................................................................................................................ 170
VerifyEmailIdentity .................................................................................................................................. 171
Request Parameters ........................................................................................................................... 171
Errors ..................................................................................................................................................... 171
See Also ................................................................................................................................................ 171
Data Types ................................................................................................................................... 173
AddHeaderAction ..................................................................................................................................... 175
Contents ............................................................................................................................................... 175
See Also ................................................................................................................................................ 175
Body ............................................................................................................................................................ 176
Contents ............................................................................................................................................... 176
See Also ................................................................................................................................................ 176
BounceAction ............................................................................................................................................ 177
Contents ............................................................................................................................................... 177
See Also ................................................................................................................................................ 178
BouncedRecipientInfo ............................................................................................................................. 179

API Version 2010-12-01 xi

Amazon Simple Email Service API Reference

Contents ............................................................................................................................................... 179

See Also ................................................................................................................................................ 180
BulkEmailDestination .............................................................................................................................. 181
Contents ............................................................................................................................................... 181
See Also ................................................................................................................................................ 182
BulkEmailDestinationStatus ................................................................................................................... 183
Contents ............................................................................................................................................... 183
See Also ................................................................................................................................................ 184
CloudWatchDestination .......................................................................................................................... 185
Contents ............................................................................................................................................... 185
See Also ................................................................................................................................................ 185
CloudWatchDimensionConfiguration ................................................................................................... 186
Contents ............................................................................................................................................... 186
See Also ................................................................................................................................................ 187
ConfigurationSet ...................................................................................................................................... 188
Contents ............................................................................................................................................... 188
See Also ................................................................................................................................................ 188
Content ....................................................................................................................................................... 189
Contents ............................................................................................................................................... 189
See Also ................................................................................................................................................ 189
CustomVerificationEmailTemplate ....................................................................................................... 190
Contents ............................................................................................................................................... 190
See Also ................................................................................................................................................ 191
DeliveryOptions ........................................................................................................................................ 192
Contents ............................................................................................................................................... 192
See Also ................................................................................................................................................ 192
Destination ................................................................................................................................................ 193
Contents ............................................................................................................................................... 193
See Also ................................................................................................................................................ 194
EventDestination ...................................................................................................................................... 195
Contents ............................................................................................................................................... 195
See Also ................................................................................................................................................ 197
ExtensionField ........................................................................................................................................... 198
Contents ............................................................................................................................................... 198
See Also ................................................................................................................................................ 198
IdentityDkimAttributes ........................................................................................................................... 199

API Version 2010-12-01 xii

Amazon Simple Email Service API Reference

Contents ............................................................................................................................................... 199

See Also ................................................................................................................................................ 200
IdentityMailFromDomainAttributes ...................................................................................................... 201
Contents ............................................................................................................................................... 201
See Also ................................................................................................................................................ 202
IdentityNotificationAttributes ............................................................................................................... 203
Contents ............................................................................................................................................... 203
See Also ................................................................................................................................................ 204
IdentityVerificationAttributes ................................................................................................................ 206
Contents ............................................................................................................................................... 206
See Also ................................................................................................................................................ 206
KinesisFirehoseDestination ..................................................................................................................... 207
Contents ............................................................................................................................................... 207
See Also ................................................................................................................................................ 207
LambdaAction ........................................................................................................................................... 208
Contents ............................................................................................................................................... 208
See Also ................................................................................................................................................ 209
Message ...................................................................................................................................................... 210
Contents ............................................................................................................................................... 210
See Also ................................................................................................................................................ 210
MessageDsn ............................................................................................................................................... 211
Contents ............................................................................................................................................... 211
See Also ................................................................................................................................................ 211
MessageTag ............................................................................................................................................... 213
Contents ............................................................................................................................................... 213
See Also ................................................................................................................................................ 213
RawMessage .............................................................................................................................................. 214
Contents ............................................................................................................................................... 214
See Also ................................................................................................................................................ 214
ReceiptAction ............................................................................................................................................ 216
Contents ............................................................................................................................................... 216
See Also ................................................................................................................................................ 217
ReceiptFilter .............................................................................................................................................. 218
Contents ............................................................................................................................................... 218
See Also ................................................................................................................................................ 218
ReceiptIpFilter ........................................................................................................................................... 219

API Version 2010-12-01 xiii

Amazon Simple Email Service API Reference

Contents ............................................................................................................................................... 219

See Also ................................................................................................................................................ 219
ReceiptRule ................................................................................................................................................ 220
Contents ............................................................................................................................................... 220
See Also ................................................................................................................................................ 221
ReceiptRuleSetMetadata ......................................................................................................................... 222
Contents ............................................................................................................................................... 222
See Also ................................................................................................................................................ 222
RecipientDsnFields ................................................................................................................................... 223
Contents ............................................................................................................................................... 223
See Also ................................................................................................................................................ 224
ReputationOptions ................................................................................................................................... 226
Contents ............................................................................................................................................... 226
See Also ................................................................................................................................................ 227
S3Action ..................................................................................................................................................... 228
Contents ............................................................................................................................................... 228
See Also ................................................................................................................................................ 230
SendDataPoint .......................................................................................................................................... 231
Contents ............................................................................................................................................... 231
See Also ................................................................................................................................................ 232
SNSAction .................................................................................................................................................. 233
Contents ............................................................................................................................................... 233
See Also ................................................................................................................................................ 234
SNSDestination ......................................................................................................................................... 235
Contents ............................................................................................................................................... 235
See Also ................................................................................................................................................ 235
StopAction ................................................................................................................................................. 236
Contents ............................................................................................................................................... 236
See Also ................................................................................................................................................ 236
Template .................................................................................................................................................... 237
Contents ............................................................................................................................................... 237
See Also ................................................................................................................................................ 237
TemplateMetadata ................................................................................................................................... 239
Contents ............................................................................................................................................... 239
See Also ................................................................................................................................................ 239
TrackingOptions ....................................................................................................................................... 240

API Version 2010-12-01 xiv

Amazon Simple Email Service API Reference

Contents ............................................................................................................................................... 240

See Also ................................................................................................................................................ 240
WorkmailAction ........................................................................................................................................ 241
Contents ............................................................................................................................................... 241
See Also ................................................................................................................................................ 242
Common Parameters ................................................................................................................... 243
Common Errors ............................................................................................................................ 246

API Version 2010-12-01 xv

Amazon Simple Email Service API Reference

Welcome
This document contains reference information for the Amazon Simple Email Service (Amazon
SES) API, version 2010-12-01. This document is best used in conjunction with the Amazon SES
Developer Guide.

Note
For a list of Amazon SES endpoints to use in service requests, see Regions and Amazon SES
in the Amazon SES Developer Guide.

This documentation contains reference information related to the following:

• Amazon SES API Actions

• Amazon SES API Data Types
• Common Parameters
• Common Errors

This document was last published on June 3, 2024.

API Version 2010-12-01 1

Amazon Simple Email Service API Reference

Actions
The following actions are supported:

• CloneReceiptRuleSet
• CreateConfigurationSet
• CreateConfigurationSetEventDestination
• CreateConfigurationSetTrackingOptions
• CreateCustomVerificationEmailTemplate
• CreateReceiptFilter
• CreateReceiptRule
• CreateReceiptRuleSet
• CreateTemplate
• DeleteConfigurationSet
• DeleteConfigurationSetEventDestination
• DeleteConfigurationSetTrackingOptions
• DeleteCustomVerificationEmailTemplate
• DeleteIdentity
• DeleteIdentityPolicy
• DeleteReceiptFilter
• DeleteReceiptRule
• DeleteReceiptRuleSet
• DeleteTemplate
• DeleteVerifiedEmailAddress
• DescribeActiveReceiptRuleSet
• DescribeConfigurationSet
• DescribeReceiptRule
• DescribeReceiptRuleSet
• GetAccountSendingEnabled
• GetCustomVerificationEmailTemplate
• GetIdentityDkimAttributes

API Version 2010-12-01 2

Amazon Simple Email Service API Reference

• GetIdentityMailFromDomainAttributes
• GetIdentityNotificationAttributes
• GetIdentityPolicies
• GetIdentityVerificationAttributes
• GetSendQuota
• GetSendStatistics
• GetTemplate
• ListConfigurationSets
• ListCustomVerificationEmailTemplates
• ListIdentities
• ListIdentityPolicies
• ListReceiptFilters
• ListReceiptRuleSets
• ListTemplates
• ListVerifiedEmailAddresses
• PutConfigurationSetDeliveryOptions
• PutIdentityPolicy
• ReorderReceiptRuleSet
• SendBounce
• SendBulkTemplatedEmail
• SendCustomVerificationEmail
• SendEmail
• SendRawEmail
• SendTemplatedEmail
• SetActiveReceiptRuleSet
• SetIdentityDkimEnabled
• SetIdentityFeedbackForwardingEnabled
• SetIdentityHeadersInNotificationsEnabled
• SetIdentityMailFromDomain
• SetIdentityNotificationTopic

API Version 2010-12-01 3

Amazon Simple Email Service API Reference

• SetReceiptRulePosition
• TestRenderTemplate
• UpdateAccountSendingEnabled
• UpdateConfigurationSetEventDestination
• UpdateConfigurationSetReputationMetricsEnabled
• UpdateConfigurationSetSendingEnabled
• UpdateConfigurationSetTrackingOptions
• UpdateCustomVerificationEmailTemplate
• UpdateReceiptRule
• UpdateTemplate
• VerifyDomainDkim
• VerifyDomainIdentity
• VerifyEmailAddress
• VerifyEmailIdentity

API Version 2010-12-01 4

Amazon Simple Email Service API Reference

CloneReceiptRuleSet
Creates a receipt rule set by cloning an existing one. All receipt rules and configurations are copied
to the new receipt rule set and are completely independent of the source rule set.

For information about setting up rule sets, see the Amazon SES Developer Guide.

You can execute this operation no more than once per second.

Request Parameters
For information about the parameters that are common to all actions, see Common Parameters.

OriginalRuleSetName

The name of the rule set to clone.

Type: String

Required: Yes
RuleSetName

The name of the rule set to create. The name must meet the following requirements:
• Contain only ASCII letters (a-z, A-Z), numbers (0-9), underscores (_), or dashes (-).
• Start and end with a letter or number.
• Contain 64 characters or fewer.

Type: String

Required: Yes

Errors
For information about the errors that are common to all actions, see Common Errors.

AlreadyExists

Indicates that a resource could not be created because of a naming conflict.

HTTP Status Code: 400

CloneReceiptRuleSet API Version 2010-12-01 5

Amazon Simple Email Service API Reference

LimitExceeded

Indicates that a resource could not be created because of service limits. For a list of Amazon SES
limits, see the Amazon SES Developer Guide.

HTTP Status Code: 400

RuleSetDoesNotExist

Indicates that the provided receipt rule set does not exist.

HTTP Status Code: 400

See Also
For more information about using this API in one of the language-specific AWS SDKs, see the
following:

• AWS Command Line Interface

• AWS SDK for .NET
• AWS SDK for C++
• AWS SDK for Go v2
• AWS SDK for Java V2
• AWS SDK for JavaScript V3
• AWS SDK for PHP V3
• AWS SDK for Python
• AWS SDK for Ruby V3

See Also API Version 2010-12-01 6

Amazon Simple Email Service API Reference

CreateConfigurationSet
Creates a configuration set.

Configuration sets enable you to publish email sending events. For information about using
configuration sets, see the Amazon SES Developer Guide.

You can execute this operation no more than once per second.

Request Parameters
For information about the parameters that are common to all actions, see Common Parameters.

ConfigurationSet

A data structure that contains the name of the configuration set.

Type: ConfigurationSet object

Required: Yes

Errors
For information about the errors that are common to all actions, see Common Errors.

ConfigurationSetAlreadyExists

Indicates that the configuration set could not be created because of a naming conflict.

HTTP Status Code: 400

InvalidConfigurationSet

Indicates that the configuration set is invalid. See the error message for details.

HTTP Status Code: 400

LimitExceeded

Indicates that a resource could not be created because of service limits. For a list of Amazon SES
limits, see the Amazon SES Developer Guide.

HTTP Status Code: 400

CreateConfigurationSet API Version 2010-12-01 7

Amazon Simple Email Service API Reference

See Also
For more information about using this API in one of the language-specific AWS SDKs, see the
following:

• AWS Command Line Interface

• AWS SDK for .NET
• AWS SDK for C++
• AWS SDK for Go v2
• AWS SDK for Java V2
• AWS SDK for JavaScript V3
• AWS SDK for PHP V3
• AWS SDK for Python
• AWS SDK for Ruby V3

See Also API Version 2010-12-01 8

Amazon Simple Email Service API Reference

CreateConfigurationSetEventDestination
Creates a configuration set event destination.

Note
When you create or update an event destination, you must provide one, and only one,
destination. The destination can be CloudWatch, Amazon Kinesis Firehose, or Amazon
Simple Notification Service (Amazon SNS).

An event destination is the AWS service to which Amazon SES publishes the email sending events
associated with a configuration set. For information about using configuration sets, see the
Amazon SES Developer Guide.

You can execute this operation no more than once per second.

Request Parameters
For information about the parameters that are common to all actions, see Common Parameters.

ConfigurationSetName

The name of the configuration set that the event destination should be associated with.

Type: String

Required: Yes
EventDestination

An object that describes the AWS service that email sending event where information is
published.

Type: EventDestination object

Required: Yes

Errors
For information about the errors that are common to all actions, see Common Errors.

CreateConfigurationSetEventDestination API Version 2010-12-01 9

Amazon Simple Email Service API Reference

ConfigurationSetDoesNotExist

Indicates that the configuration set does not exist.

HTTP Status Code: 400

EventDestinationAlreadyExists

Indicates that the event destination could not be created because of a naming conflict.

HTTP Status Code: 400

InvalidCloudWatchDestination

Indicates that the Amazon CloudWatch destination is invalid. See the error message for details.

HTTP Status Code: 400

InvalidFirehoseDestination

Indicates that the Amazon Kinesis Firehose destination is invalid. See the error message for
details.

HTTP Status Code: 400

InvalidSNSDestination

Indicates that the Amazon Simple Notification Service (Amazon SNS) destination is invalid. See
the error message for details.

HTTP Status Code: 400

LimitExceeded

Indicates that a resource could not be created because of service limits. For a list of Amazon SES
limits, see the Amazon SES Developer Guide.

HTTP Status Code: 400

See Also
For more information about using this API in one of the language-specific AWS SDKs, see the
following:

• AWS Command Line Interface

See Also API Version 2010-12-01 10

Amazon Simple Email Service API Reference

• AWS SDK for .NET

• AWS SDK for C++
• AWS SDK for Go v2
• AWS SDK for Java V2
• AWS SDK for JavaScript V3
• AWS SDK for PHP V3
• AWS SDK for Python
• AWS SDK for Ruby V3

See Also API Version 2010-12-01 11

Amazon Simple Email Service API Reference

CreateConfigurationSetTrackingOptions
Creates an association between a configuration set and a custom domain for open and click event
tracking.

By default, images and links used for tracking open and click events are hosted on domains
operated by Amazon SES. You can configure a subdomain of your own to handle these events. For
information about using custom domains, see the Amazon SES Developer Guide.

Request Parameters
For information about the parameters that are common to all actions, see Common Parameters.

ConfigurationSetName

The name of the configuration set that the tracking options should be associated with.

Type: String

Required: Yes
TrackingOptions

A domain that is used to redirect email recipients to an Amazon SES-operated domain. This
domain captures open and click events generated by Amazon SES emails.

For more information, see Configuring Custom Domains to Handle Open and Click Tracking in
the Amazon SES Developer Guide.

Type: TrackingOptions object

Required: Yes

Errors
For information about the errors that are common to all actions, see Common Errors.

ConfigurationSetDoesNotExist

Indicates that the configuration set does not exist.

HTTP Status Code: 400

CreateConfigurationSetTrackingOptions API Version 2010-12-01 12

Amazon Simple Email Service API Reference

InvalidTrackingOptions

Indicates that the custom domain to be used for open and click tracking redirects is invalid. This
error appears most often in the following situations:
• When the tracking domain you specified is not verified in Amazon SES.
• When the tracking domain you specified is not a valid domain or subdomain.

HTTP Status Code: 400

TrackingOptionsAlreadyExists

Indicates that the configuration set you specified already contains a TrackingOptions object.

HTTP Status Code: 400

See Also
For more information about using this API in one of the language-specific AWS SDKs, see the
following:

• AWS Command Line Interface

• AWS SDK for .NET
• AWS SDK for C++
• AWS SDK for Go v2
• AWS SDK for Java V2
• AWS SDK for JavaScript V3
• AWS SDK for PHP V3
• AWS SDK for Python
• AWS SDK for Ruby V3

See Also API Version 2010-12-01 13

Amazon Simple Email Service API Reference

CreateCustomVerificationEmailTemplate
Creates a new custom verification email template.

For more information about custom verification email templates, see Using Custom Verification
Email Templates in the Amazon SES Developer Guide.

You can execute this operation no more than once per second.

Request Parameters
For information about the parameters that are common to all actions, see Common Parameters.

FailureRedirectionURL

The URL that the recipient of the verification email is sent to if his or her address is not
successfully verified.

Type: String

Required: Yes
FromEmailAddress

The email address that the custom verification email is sent from.

Type: String

Required: Yes
SuccessRedirectionURL

The URL that the recipient of the verification email is sent to if his or her address is successfully
verified.

Type: String

Required: Yes
TemplateContent

The content of the custom verification email. The total size of the email must be less than 10
MB. The message body may contain HTML, with some limitations. For more information, see
Custom Verification Email Frequently Asked Questions in the Amazon SES Developer Guide.

CreateCustomVerificationEmailTemplate API Version 2010-12-01 14

Amazon Simple Email Service API Reference

Type: String

Required: Yes
TemplateName

The name of the custom verification email template.

Type: String

Required: Yes
TemplateSubject

The subject line of the custom verification email.

Type: String

Required: Yes

Errors
For information about the errors that are common to all actions, see Common Errors.

CustomVerificationEmailInvalidContent

Indicates that custom verification email template provided content is invalid.

HTTP Status Code: 400

CustomVerificationEmailTemplateAlreadyExists

Indicates that a custom verification email template with the name you specified already exists.

HTTP Status Code: 400

FromEmailAddressNotVerified

Indicates that the sender address specified for a custom verification email is not verified, and is
therefore not eligible to send the custom verification email.

HTTP Status Code: 400

LimitExceeded

Indicates that a resource could not be created because of service limits. For a list of Amazon SES
limits, see the Amazon SES Developer Guide.

Errors API Version 2010-12-01 15

Amazon Simple Email Service API Reference

HTTP Status Code: 400

See Also
For more information about using this API in one of the language-specific AWS SDKs, see the
following:

• AWS Command Line Interface

• AWS SDK for .NET
• AWS SDK for C++
• AWS SDK for Go v2
• AWS SDK for Java V2
• AWS SDK for JavaScript V3
• AWS SDK for PHP V3
• AWS SDK for Python
• AWS SDK for Ruby V3

See Also API Version 2010-12-01 16

Amazon Simple Email Service API Reference

CreateReceiptFilter
Creates a new IP address filter.

For information about setting up IP address filters, see the Amazon SES Developer Guide.

You can execute this operation no more than once per second.

Request Parameters
For information about the parameters that are common to all actions, see Common Parameters.

Filter

A data structure that describes the IP address filter to create, which consists of a name, an IP
address range, and whether to allow or block mail from it.

Type: ReceiptFilter object

Required: Yes

Errors
For information about the errors that are common to all actions, see Common Errors.

AlreadyExists

Indicates that a resource could not be created because of a naming conflict.

HTTP Status Code: 400

LimitExceeded

Indicates that a resource could not be created because of service limits. For a list of Amazon SES
limits, see the Amazon SES Developer Guide.

HTTP Status Code: 400

See Also
For more information about using this API in one of the language-specific AWS SDKs, see the
following:

CreateReceiptFilter API Version 2010-12-01 17

Amazon Simple Email Service API Reference

• AWS Command Line Interface

• AWS SDK for .NET
• AWS SDK for C++
• AWS SDK for Go v2
• AWS SDK for Java V2
• AWS SDK for JavaScript V3
• AWS SDK for PHP V3
• AWS SDK for Python
• AWS SDK for Ruby V3

See Also API Version 2010-12-01 18

Amazon Simple Email Service API Reference

CreateReceiptRule
Creates a receipt rule.

For information about setting up receipt rules, see the Amazon SES Developer Guide.

You can execute this operation no more than once per second.

Request Parameters

For information about the parameters that are common to all actions, see Common Parameters.

After

The name of an existing rule after which the new rule is placed. If this parameter is null, the
new rule is inserted at the beginning of the rule list.

Type: String

Required: No
Rule

A data structure that contains the specified rule's name, actions, recipients, domains, enabled
status, scan status, and TLS policy.

Type: ReceiptRule object

Required: Yes
RuleSetName

The name of the rule set where the receipt rule is added.

Type: String

Required: Yes

Errors

For information about the errors that are common to all actions, see Common Errors.

CreateReceiptRule API Version 2010-12-01 19

Amazon Simple Email Service API Reference

AlreadyExists

Indicates that a resource could not be created because of a naming conflict.

HTTP Status Code: 400

InvalidLambdaFunction

Indicates that the provided AWS Lambda function is invalid, or that Amazon SES could not
execute the provided function, possibly due to permissions issues. For information about giving
permissions, see the Amazon SES Developer Guide.

HTTP Status Code: 400

InvalidS3Configuration

Indicates that the provided Amazon S3 bucket or AWS KMS encryption key is invalid, or
that Amazon SES could not publish to the bucket, possibly due to permissions issues. For
information about giving permissions, see the Amazon SES Developer Guide.

HTTP Status Code: 400

InvalidSnsTopic

Indicates that the provided Amazon SNS topic is invalid, or that Amazon SES could not publish
to the topic, possibly due to permissions issues. For information about giving permissions, see
the Amazon SES Developer Guide.

HTTP Status Code: 400

LimitExceeded

Indicates that a resource could not be created because of service limits. For a list of Amazon SES
limits, see the Amazon SES Developer Guide.

HTTP Status Code: 400

RuleDoesNotExist

Indicates that the provided receipt rule does not exist.

HTTP Status Code: 400

RuleSetDoesNotExist

Indicates that the provided receipt rule set does not exist.

Errors API Version 2010-12-01 20

Amazon Simple Email Service API Reference

HTTP Status Code: 400

See Also
For more information about using this API in one of the language-specific AWS SDKs, see the
following:

• AWS Command Line Interface

• AWS SDK for .NET
• AWS SDK for C++
• AWS SDK for Go v2
• AWS SDK for Java V2
• AWS SDK for JavaScript V3
• AWS SDK for PHP V3
• AWS SDK for Python
• AWS SDK for Ruby V3

See Also API Version 2010-12-01 21

Amazon Simple Email Service API Reference

CreateReceiptRuleSet
Creates an empty receipt rule set.

For information about setting up receipt rule sets, see the Amazon SES Developer Guide.

You can execute this operation no more than once per second.

Request Parameters

For information about the parameters that are common to all actions, see Common Parameters.

RuleSetName

The name of the rule set to create. The name must meet the following requirements:
• Contain only ASCII letters (a-z, A-Z), numbers (0-9), underscores (_), or dashes (-).
• Start and end with a letter or number.
• Contain 64 characters or fewer.

Type: String

Required: Yes

Errors

For information about the errors that are common to all actions, see Common Errors.

AlreadyExists

Indicates that a resource could not be created because of a naming conflict.

HTTP Status Code: 400

LimitExceeded

Indicates that a resource could not be created because of service limits. For a list of Amazon SES
limits, see the Amazon SES Developer Guide.

HTTP Status Code: 400

CreateReceiptRuleSet API Version 2010-12-01 22

Amazon Simple Email Service API Reference

See Also
For more information about using this API in one of the language-specific AWS SDKs, see the
following:

• AWS Command Line Interface

• AWS SDK for .NET
• AWS SDK for C++
• AWS SDK for Go v2
• AWS SDK for Java V2
• AWS SDK for JavaScript V3
• AWS SDK for PHP V3
• AWS SDK for Python
• AWS SDK for Ruby V3

See Also API Version 2010-12-01 23

Amazon Simple Email Service API Reference

CreateTemplate
Creates an email template. Email templates enable you to send personalized email to one or more
destinations in a single operation. For more information, see the Amazon SES Developer Guide.

You can execute this operation no more than once per second.

Request Parameters
For information about the parameters that are common to all actions, see Common Parameters.

Template

The content of the email, composed of a subject line and either an HTML part or a text-only
part.

Type: Template object

Required: Yes

Errors
For information about the errors that are common to all actions, see Common Errors.

AlreadyExists

Indicates that a resource could not be created because of a naming conflict.

HTTP Status Code: 400

InvalidTemplate

Indicates that the template that you specified could not be rendered. This issue may occur when
a template refers to a partial that does not exist.

HTTP Status Code: 400

LimitExceeded

Indicates that a resource could not be created because of service limits. For a list of Amazon SES
limits, see the Amazon SES Developer Guide.

HTTP Status Code: 400

CreateTemplate API Version 2010-12-01 24

Amazon Simple Email Service API Reference

See Also
For more information about using this API in one of the language-specific AWS SDKs, see the
following:

• AWS Command Line Interface

• AWS SDK for .NET
• AWS SDK for C++
• AWS SDK for Go v2
• AWS SDK for Java V2
• AWS SDK for JavaScript V3
• AWS SDK for PHP V3
• AWS SDK for Python
• AWS SDK for Ruby V3

See Also API Version 2010-12-01 25

Amazon Simple Email Service API Reference

DeleteConfigurationSet
Deletes a configuration set. Configuration sets enable you to publish email sending events. For
information about using configuration sets, see the Amazon SES Developer Guide.

You can execute this operation no more than once per second.

Request Parameters
For information about the parameters that are common to all actions, see Common Parameters.

ConfigurationSetName

The name of the configuration set to delete.

Type: String

Required: Yes

Errors
For information about the errors that are common to all actions, see Common Errors.

ConfigurationSetDoesNotExist

Indicates that the configuration set does not exist.

HTTP Status Code: 400

See Also
For more information about using this API in one of the language-specific AWS SDKs, see the
following:

• AWS Command Line Interface

• AWS SDK for .NET
• AWS SDK for C++
• AWS SDK for Go v2
• AWS SDK for Java V2

DeleteConfigurationSet API Version 2010-12-01 26

Amazon Simple Email Service API Reference

• AWS SDK for JavaScript V3

• AWS SDK for PHP V3
• AWS SDK for Python
• AWS SDK for Ruby V3

See Also API Version 2010-12-01 27

Amazon Simple Email Service API Reference

DeleteConfigurationSetEventDestination
Deletes a configuration set event destination. Configuration set event destinations are associated
with configuration sets, which enable you to publish email sending events. For information about
using configuration sets, see the Amazon SES Developer Guide.

You can execute this operation no more than once per second.

Request Parameters
For information about the parameters that are common to all actions, see Common Parameters.

ConfigurationSetName

The name of the configuration set from which to delete the event destination.

Type: String

Required: Yes
EventDestinationName

The name of the event destination to delete.

Type: String

Required: Yes

Errors
For information about the errors that are common to all actions, see Common Errors.

ConfigurationSetDoesNotExist

Indicates that the configuration set does not exist.

HTTP Status Code: 400

EventDestinationDoesNotExist

Indicates that the event destination does not exist.

HTTP Status Code: 400

DeleteConfigurationSetEventDestination API Version 2010-12-01 28

Amazon Simple Email Service API Reference

See Also
For more information about using this API in one of the language-specific AWS SDKs, see the
following:

• AWS Command Line Interface

• AWS SDK for .NET
• AWS SDK for C++
• AWS SDK for Go v2
• AWS SDK for Java V2
• AWS SDK for JavaScript V3
• AWS SDK for PHP V3
• AWS SDK for Python
• AWS SDK for Ruby V3

See Also API Version 2010-12-01 29

Amazon Simple Email Service API Reference

DeleteConfigurationSetTrackingOptions
Deletes an association between a configuration set and a custom domain for open and click event
tracking.

By default, images and links used for tracking open and click events are hosted on domains
operated by Amazon SES. You can configure a subdomain of your own to handle these events. For
information about using custom domains, see the Amazon SES Developer Guide.

Note
Deleting this kind of association results in emails sent using the specified configuration set
to capture open and click events using the standard, Amazon SES-operated domains.

Request Parameters

For information about the parameters that are common to all actions, see Common Parameters.

ConfigurationSetName

The name of the configuration set.

Type: String

Required: Yes

Errors

For information about the errors that are common to all actions, see Common Errors.

ConfigurationSetDoesNotExist

Indicates that the configuration set does not exist.

HTTP Status Code: 400

TrackingOptionsDoesNotExist

Indicates that the TrackingOptions object you specified does not exist.

DeleteConfigurationSetTrackingOptions API Version 2010-12-01 30

Amazon Simple Email Service API Reference

HTTP Status Code: 400

See Also
For more information about using this API in one of the language-specific AWS SDKs, see the
following:

• AWS Command Line Interface

• AWS SDK for .NET
• AWS SDK for C++
• AWS SDK for Go v2
• AWS SDK for Java V2
• AWS SDK for JavaScript V3
• AWS SDK for PHP V3
• AWS SDK for Python
• AWS SDK for Ruby V3

See Also API Version 2010-12-01 31

Amazon Simple Email Service API Reference

DeleteCustomVerificationEmailTemplate
Deletes an existing custom verification email template.

For more information about custom verification email templates, see Using Custom Verification
Email Templates in the Amazon SES Developer Guide.

You can execute this operation no more than once per second.

Request Parameters

For information about the parameters that are common to all actions, see Common Parameters.

TemplateName

The name of the custom verification email template to delete.

Type: String

Required: Yes

Errors

For information about the errors that are common to all actions, see Common Errors.

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the
following:

• AWS Command Line Interface

• AWS SDK for .NET
• AWS SDK for C++
• AWS SDK for Go v2
• AWS SDK for Java V2
• AWS SDK for JavaScript V3
• AWS SDK for PHP V3
• AWS SDK for Python

DeleteCustomVerificationEmailTemplate API Version 2010-12-01 32

Amazon Simple Email Service API Reference

• AWS SDK for Ruby V3

See Also API Version 2010-12-01 33

Amazon Simple Email Service API Reference

DeleteIdentity
Deletes the specified identity (an email address or a domain) from the list of verified identities.

You can execute this operation no more than once per second.

Request Parameters
For information about the parameters that are common to all actions, see Common Parameters.

Identity

The identity to be removed from the list of identities for the AWS account.

Type: String

Required: Yes

Errors
For information about the errors that are common to all actions, see Common Errors.

See Also
For more information about using this API in one of the language-specific AWS SDKs, see the
following:

• AWS Command Line Interface

• AWS SDK for .NET
• AWS SDK for C++
• AWS SDK for Go v2
• AWS SDK for Java V2
• AWS SDK for JavaScript V3
• AWS SDK for PHP V3
• AWS SDK for Python
• AWS SDK for Ruby V3

DeleteIdentity API Version 2010-12-01 34

Amazon Simple Email Service API Reference

DeleteIdentityPolicy
Deletes the specified sending authorization policy for the given identity (an email address or a
domain). This operation returns successfully even if a policy with the specified name does not exist.

Note
This operation is for the identity owner only. If you have not verified the identity, it returns
an error.

Sending authorization is a feature that enables an identity owner to authorize other senders to use
its identities. For information about using sending authorization, see the Amazon SES Developer
Guide.

You can execute this operation no more than once per second.

Request Parameters
For information about the parameters that are common to all actions, see Common Parameters.

Identity

The identity that is associated with the policy to delete. You can specify the identity by using
its name or by using its Amazon Resource Name (ARN). Examples: user@example.com,
example.com, arn:aws:ses:us-east-1:123456789012:identity/example.com.

To successfully call this operation, you must own the identity.

Type: String

Required: Yes
PolicyName

The name of the policy to be deleted.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 64.

Required: Yes

DeleteIdentityPolicy API Version 2010-12-01 35

Amazon Simple Email Service API Reference

Errors
For information about the errors that are common to all actions, see Common Errors.

See Also
For more information about using this API in one of the language-specific AWS SDKs, see the
following:

• AWS Command Line Interface

• AWS SDK for .NET
• AWS SDK for C++
• AWS SDK for Go v2
• AWS SDK for Java V2
• AWS SDK for JavaScript V3
• AWS SDK for PHP V3
• AWS SDK for Python
• AWS SDK for Ruby V3

Errors API Version 2010-12-01 36

Amazon Simple Email Service API Reference

DeleteReceiptFilter
Deletes the specified IP address filter.

For information about managing IP address filters, see the Amazon SES Developer Guide.

You can execute this operation no more than once per second.

Request Parameters
For information about the parameters that are common to all actions, see Common Parameters.

FilterName

The name of the IP address filter to delete.

Type: String

Required: Yes

Errors
For information about the errors that are common to all actions, see Common Errors.

See Also
For more information about using this API in one of the language-specific AWS SDKs, see the
following:

• AWS Command Line Interface

• AWS SDK for .NET
• AWS SDK for C++
• AWS SDK for Go v2
• AWS SDK for Java V2
• AWS SDK for JavaScript V3
• AWS SDK for PHP V3
• AWS SDK for Python
• AWS SDK for Ruby V3

DeleteReceiptFilter API Version 2010-12-01 37

Amazon Simple Email Service API Reference

See Also API Version 2010-12-01 38

Amazon Simple Email Service API Reference

DeleteReceiptRule
Deletes the specified receipt rule.

For information about managing receipt rules, see the Amazon SES Developer Guide.

You can execute this operation no more than once per second.

Request Parameters
For information about the parameters that are common to all actions, see Common Parameters.

RuleName

The name of the receipt rule to delete.

Type: String

Required: Yes
RuleSetName

The name of the receipt rule set that contains the receipt rule to delete.

Type: String

Required: Yes

Errors
For information about the errors that are common to all actions, see Common Errors.

RuleSetDoesNotExist

Indicates that the provided receipt rule set does not exist.

HTTP Status Code: 400

See Also
For more information about using this API in one of the language-specific AWS SDKs, see the
following:

DeleteReceiptRule API Version 2010-12-01 39

Amazon Simple Email Service API Reference

• AWS Command Line Interface

• AWS SDK for .NET
• AWS SDK for C++
• AWS SDK for Go v2
• AWS SDK for Java V2
• AWS SDK for JavaScript V3
• AWS SDK for PHP V3
• AWS SDK for Python
• AWS SDK for Ruby V3

See Also API Version 2010-12-01 40

Amazon Simple Email Service API Reference

DeleteReceiptRuleSet
Deletes the specified receipt rule set and all of the receipt rules it contains.

Note
The currently active rule set cannot be deleted.

For information about managing receipt rule sets, see the Amazon SES Developer Guide.

You can execute this operation no more than once per second.

Request Parameters

For information about the parameters that are common to all actions, see Common Parameters.

RuleSetName

The name of the receipt rule set to delete.

Type: String

Required: Yes

Errors

For information about the errors that are common to all actions, see Common Errors.

CannotDelete

Indicates that the delete operation could not be completed.

HTTP Status Code: 400

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the
following:

DeleteReceiptRuleSet API Version 2010-12-01 41

Amazon Simple Email Service API Reference

• AWS Command Line Interface

• AWS SDK for .NET
• AWS SDK for C++
• AWS SDK for Go v2
• AWS SDK for Java V2
• AWS SDK for JavaScript V3
• AWS SDK for PHP V3
• AWS SDK for Python
• AWS SDK for Ruby V3

See Also API Version 2010-12-01 42

Amazon Simple Email Service API Reference

DeleteTemplate
Deletes an email template.

You can execute this operation no more than once per second.

Request Parameters
For information about the parameters that are common to all actions, see Common Parameters.

TemplateName

The name of the template to be deleted.

Type: String

Required: Yes

Errors
For information about the errors that are common to all actions, see Common Errors.

See Also
For more information about using this API in one of the language-specific AWS SDKs, see the
following:

• AWS Command Line Interface

• AWS SDK for .NET
• AWS SDK for C++
• AWS SDK for Go v2
• AWS SDK for Java V2
• AWS SDK for JavaScript V3
• AWS SDK for PHP V3
• AWS SDK for Python
• AWS SDK for Ruby V3

DeleteTemplate API Version 2010-12-01 43

Amazon Simple Email Service API Reference

DeleteVerifiedEmailAddress
Deprecated. Use the DeleteIdentity operation to delete email addresses and domains.

Request Parameters
For information about the parameters that are common to all actions, see Common Parameters.

EmailAddress

An email address to be removed from the list of verified addresses.

Type: String

Required: Yes

Errors
For information about the errors that are common to all actions, see Common Errors.

See Also
For more information about using this API in one of the language-specific AWS SDKs, see the
following:

• AWS Command Line Interface

• AWS SDK for .NET
• AWS SDK for C++
• AWS SDK for Go v2
• AWS SDK for Java V2
• AWS SDK for JavaScript V3
• AWS SDK for PHP V3
• AWS SDK for Python
• AWS SDK for Ruby V3

DeleteVerifiedEmailAddress API Version 2010-12-01 44

Amazon Simple Email Service API Reference

DescribeActiveReceiptRuleSet
Returns the metadata and receipt rules for the receipt rule set that is currently active.

For information about setting up receipt rule sets, see the Amazon SES Developer Guide.

You can execute this operation no more than once per second.

Response Elements
The following elements are returned by the service.

Metadata

The metadata for the currently active receipt rule set. The metadata consists of the rule set
name and a timestamp of when the rule set was created.

Type: ReceiptRuleSetMetadata object

Rules.member.N

The receipt rules that belong to the active rule set.

Type: Array of ReceiptRule objects

Errors
For information about the errors that are common to all actions, see Common Errors.

See Also
For more information about using this API in one of the language-specific AWS SDKs, see the
following:

• AWS Command Line Interface

• AWS SDK for .NET
• AWS SDK for C++
• AWS SDK for Go v2
• AWS SDK for Java V2
• AWS SDK for JavaScript V3

DescribeActiveReceiptRuleSet API Version 2010-12-01 45

Amazon Simple Email Service API Reference

• AWS SDK for PHP V3

• AWS SDK for Python
• AWS SDK for Ruby V3

See Also API Version 2010-12-01 46

Amazon Simple Email Service API Reference

DescribeConfigurationSet
Returns the details of the specified configuration set. For information about using configuration
sets, see the Amazon SES Developer Guide.

You can execute this operation no more than once per second.

Request Parameters
For information about the parameters that are common to all actions, see Common Parameters.

ConfigurationSetAttributeNames.member.N

A list of configuration set attributes to return.

Type: Array of strings

Valid Values: eventDestinations | trackingOptions | deliveryOptions |

reputationOptions

Required: No
ConfigurationSetName

The name of the configuration set to describe.

Type: String

Required: Yes

Response Elements
The following elements are returned by the service.

ConfigurationSet

The configuration set object associated with the specified configuration set.

Type: ConfigurationSet object

DeliveryOptions

Specifies whether messages that use the configuration set are required to use Transport Layer
Security (TLS).

DescribeConfigurationSet API Version 2010-12-01 47

Amazon Simple Email Service API Reference

Type: DeliveryOptions object

EventDestinations.member.N

A list of event destinations associated with the configuration set.

Type: Array of EventDestination objects

ReputationOptions

An object that represents the reputation settings for the configuration set.

Type: ReputationOptions object

TrackingOptions

The name of the custom open and click tracking domain associated with the configuration set.

Type: TrackingOptions object

Errors

For information about the errors that are common to all actions, see Common Errors.

ConfigurationSetDoesNotExist

Indicates that the configuration set does not exist.

HTTP Status Code: 400

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the
following:

• AWS Command Line Interface

• AWS SDK for .NET
• AWS SDK for C++
• AWS SDK for Go v2
• AWS SDK for Java V2
• AWS SDK for JavaScript V3

Errors API Version 2010-12-01 48

Amazon Simple Email Service API Reference

• AWS SDK for PHP V3

• AWS SDK for Python
• AWS SDK for Ruby V3

See Also API Version 2010-12-01 49

Amazon Simple Email Service API Reference

DescribeReceiptRule
Returns the details of the specified receipt rule.

For information about setting up receipt rules, see the Amazon SES Developer Guide.

You can execute this operation no more than once per second.

Request Parameters
For information about the parameters that are common to all actions, see Common Parameters.

RuleName

The name of the receipt rule.

Type: String

Required: Yes
RuleSetName

The name of the receipt rule set that the receipt rule belongs to.

Type: String

Required: Yes

Response Elements
The following element is returned by the service.

Rule

A data structure that contains the specified receipt rule's name, actions, recipients, domains,
enabled status, scan status, and Transport Layer Security (TLS) policy.

Type: ReceiptRule object

Errors
For information about the errors that are common to all actions, see Common Errors.

DescribeReceiptRule API Version 2010-12-01 50

Amazon Simple Email Service API Reference

RuleDoesNotExist

Indicates that the provided receipt rule does not exist.

HTTP Status Code: 400

RuleSetDoesNotExist

Indicates that the provided receipt rule set does not exist.

HTTP Status Code: 400

See Also
For more information about using this API in one of the language-specific AWS SDKs, see the
following:

• AWS Command Line Interface

• AWS SDK for .NET
• AWS SDK for C++
• AWS SDK for Go v2
• AWS SDK for Java V2
• AWS SDK for JavaScript V3
• AWS SDK for PHP V3
• AWS SDK for Python
• AWS SDK for Ruby V3

See Also API Version 2010-12-01 51

Amazon Simple Email Service API Reference

DescribeReceiptRuleSet
Returns the details of the specified receipt rule set.

For information about managing receipt rule sets, see the Amazon SES Developer Guide.

You can execute this operation no more than once per second.

Request Parameters

For information about the parameters that are common to all actions, see Common Parameters.

RuleSetName

The name of the receipt rule set to describe.

Type: String

Required: Yes

Response Elements

The following elements are returned by the service.

Metadata

The metadata for the receipt rule set, which consists of the rule set name and the timestamp of
when the rule set was created.

Type: ReceiptRuleSetMetadata object

Rules.member.N

A list of the receipt rules that belong to the specified receipt rule set.

Type: Array of ReceiptRule objects

Errors

For information about the errors that are common to all actions, see Common Errors.

DescribeReceiptRuleSet API Version 2010-12-01 52

Amazon Simple Email Service API Reference

RuleSetDoesNotExist

Indicates that the provided receipt rule set does not exist.

HTTP Status Code: 400

See Also
For more information about using this API in one of the language-specific AWS SDKs, see the
following:

• AWS Command Line Interface

• AWS SDK for .NET
• AWS SDK for C++
• AWS SDK for Go v2
• AWS SDK for Java V2
• AWS SDK for JavaScript V3
• AWS SDK for PHP V3
• AWS SDK for Python
• AWS SDK for Ruby V3

See Also API Version 2010-12-01 53

Amazon Simple Email Service API Reference

GetAccountSendingEnabled
Returns the email sending status of the Amazon SES account for the current Region.

You can execute this operation no more than once per second.

Response Elements
The following element is returned by the service.

Enabled

Describes whether email sending is enabled or disabled for your Amazon SES account in the
current AWS Region.

Type: Boolean

Errors
For information about the errors that are common to all actions, see Common Errors.

See Also
For more information about using this API in one of the language-specific AWS SDKs, see the
following:

• AWS Command Line Interface

• AWS SDK for .NET
• AWS SDK for C++
• AWS SDK for Go v2
• AWS SDK for Java V2
• AWS SDK for JavaScript V3
• AWS SDK for PHP V3
• AWS SDK for Python
• AWS SDK for Ruby V3

GetAccountSendingEnabled API Version 2010-12-01 54

Amazon Simple Email Service API Reference

GetCustomVerificationEmailTemplate
Returns the custom email verification template for the template name you specify.

For more information about custom verification email templates, see Using Custom Verification
Email Templates in the Amazon SES Developer Guide.

You can execute this operation no more than once per second.

Request Parameters

For information about the parameters that are common to all actions, see Common Parameters.

TemplateName

The name of the custom verification email template to retrieve.

Type: String

Required: Yes

Response Elements

The following elements are returned by the service.

FailureRedirectionURL

The URL that the recipient of the verification email is sent to if his or her address is not
successfully verified.

Type: String
FromEmailAddress

The email address that the custom verification email is sent from.

Type: String
SuccessRedirectionURL

The URL that the recipient of the verification email is sent to if his or her address is successfully
verified.

GetCustomVerificationEmailTemplate API Version 2010-12-01 55

Amazon Simple Email Service API Reference

Type: String
TemplateContent

The content of the custom verification email.

Type: String
TemplateName

The name of the custom verification email template.

Type: String
TemplateSubject

The subject line of the custom verification email.

Type: String

Errors

For information about the errors that are common to all actions, see Common Errors.

CustomVerificationEmailTemplateDoesNotExist

Indicates that a custom verification email template with the name you specified does not exist.

HTTP Status Code: 400

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the
following:

• AWS Command Line Interface

• AWS SDK for .NET
• AWS SDK for C++
• AWS SDK for Go v2
• AWS SDK for Java V2
• AWS SDK for JavaScript V3

Errors API Version 2010-12-01 56

Amazon Simple Email Service API Reference

• AWS SDK for PHP V3

• AWS SDK for Python
• AWS SDK for Ruby V3

See Also API Version 2010-12-01 57

Amazon Simple Email Service API Reference

GetIdentityDkimAttributes
Returns the current status of Easy DKIM signing for an entity. For domain name identities, this
operation also returns the DKIM tokens that are required for Easy DKIM signing, and whether
Amazon SES has successfully verified that these tokens have been published.

This operation takes a list of identities as input and returns the following information for each:

• Whether Easy DKIM signing is enabled or disabled.

• A set of DKIM tokens that represent the identity. If the identity is an email address, the tokens
represent the domain of that address.
• Whether Amazon SES has successfully verified the DKIM tokens published in the domain's DNS.
This information is only returned for domain name identities, not for email addresses.

This operation is throttled at one request per second and can only get DKIM attributes for up to
100 identities at a time.

For more information about creating DNS records using DKIM tokens, go to the Amazon SES
Developer Guide.

Request Parameters

For information about the parameters that are common to all actions, see Common Parameters.

Identities.member.N

A list of one or more verified identities - email addresses, domains, or both.

Type: Array of strings

Required: Yes

Response Elements

The following element is returned by the service.

DkimAttributes , DkimAttributes.entry.N.key (key), DkimAttributes.entry.N.value (value)

The DKIM attributes for an email address or a domain.

GetIdentityDkimAttributes API Version 2010-12-01 58

Amazon Simple Email Service API Reference

Type: String to IdentityDkimAttributes object map

Errors
For information about the errors that are common to all actions, see Common Errors.

See Also
For more information about using this API in one of the language-specific AWS SDKs, see the
following:

• AWS Command Line Interface

• AWS SDK for .NET
• AWS SDK for C++
• AWS SDK for Go v2
• AWS SDK for Java V2
• AWS SDK for JavaScript V3
• AWS SDK for PHP V3
• AWS SDK for Python
• AWS SDK for Ruby V3

Errors API Version 2010-12-01 59

Amazon Simple Email Service API Reference

GetIdentityMailFromDomainAttributes
Returns the custom MAIL FROM attributes for a list of identities (email addresses : domains).

This operation is throttled at one request per second and can only get custom MAIL FROM
attributes for up to 100 identities at a time.

Request Parameters
For information about the parameters that are common to all actions, see Common Parameters.

Identities.member.N

A list of one or more identities.

Type: Array of strings

Required: Yes

Response Elements
The following element is returned by the service.

MailFromDomainAttributes , MailFromDomainAttributes.entry.N.key (key),

MailFromDomainAttributes.entry.N.value (value)

A map of identities to custom MAIL FROM attributes.

Type: String to IdentityMailFromDomainAttributes object map

Errors
For information about the errors that are common to all actions, see Common Errors.

See Also
For more information about using this API in one of the language-specific AWS SDKs, see the
following:

• AWS Command Line Interface

GetIdentityMailFromDomainAttributes API Version 2010-12-01 60

Amazon Simple Email Service API Reference

• AWS SDK for .NET

• AWS SDK for C++
• AWS SDK for Go v2
• AWS SDK for Java V2
• AWS SDK for JavaScript V3
• AWS SDK for PHP V3
• AWS SDK for Python
• AWS SDK for Ruby V3

See Also API Version 2010-12-01 61

Amazon Simple Email Service API Reference

GetIdentityNotificationAttributes
Given a list of verified identities (email addresses and/or domains), returns a structure describing
identity notification attributes.

This operation is throttled at one request per second and can only get notification attributes for up
to 100 identities at a time.

For more information about using notifications with Amazon SES, see the Amazon SES Developer
Guide.

Request Parameters

For information about the parameters that are common to all actions, see Common Parameters.

Identities.member.N

A list of one or more identities. You can specify an identity by using its name or by using
its Amazon Resource Name (ARN). Examples: user@example.com, example.com,
arn:aws:ses:us-east-1:123456789012:identity/example.com.

Type: Array of strings

Required: Yes

Response Elements

The following element is returned by the service.

NotificationAttributes , NotificationAttributes.entry.N.key (key),

NotificationAttributes.entry.N.value (value)

A map of Identity to IdentityNotificationAttributes.

Type: String to IdentityNotificationAttributes object map

Errors

For information about the errors that are common to all actions, see Common Errors.

GetIdentityNotificationAttributes API Version 2010-12-01 62

Amazon Simple Email Service API Reference

See Also
For more information about using this API in one of the language-specific AWS SDKs, see the
following:

• AWS Command Line Interface

• AWS SDK for .NET
• AWS SDK for C++
• AWS SDK for Go v2
• AWS SDK for Java V2
• AWS SDK for JavaScript V3
• AWS SDK for PHP V3
• AWS SDK for Python
• AWS SDK for Ruby V3

See Also API Version 2010-12-01 63

Amazon Simple Email Service API Reference

GetIdentityPolicies
Returns the requested sending authorization policies for the given identity (an email address or a
domain). The policies are returned as a map of policy names to policy contents. You can retrieve a
maximum of 20 policies at a time.

Note
This operation is for the identity owner only. If you have not verified the identity, it returns
an error.

Sending authorization is a feature that enables an identity owner to authorize other senders to use
its identities. For information about using sending authorization, see the Amazon SES Developer
Guide.

You can execute this operation no more than once per second.

Request Parameters
For information about the parameters that are common to all actions, see Common Parameters.

Identity

The identity for which the policies are retrieved. You can specify an identity by using its name
or by using its Amazon Resource Name (ARN). Examples: user@example.com, example.com,
arn:aws:ses:us-east-1:123456789012:identity/example.com.

To successfully call this operation, you must own the identity.

Type: String

Required: Yes
PolicyNames.member.N

A list of the names of policies to be retrieved. You can retrieve a maximum of 20 policies at a
time. If you do not know the names of the policies that are attached to the identity, you can use
ListIdentityPolicies.

Type: Array of strings

GetIdentityPolicies API Version 2010-12-01 64

Amazon Simple Email Service API Reference

Length Constraints: Minimum length of 1. Maximum length of 64.

Required: Yes

Response Elements
The following element is returned by the service.

Policies , Policies.entry.N.key (key), Policies.entry.N.value (value)

A map of policy names to policies.

Type: String to string map

Key Length Constraints: Minimum length of 1. Maximum length of 64.

Value Length Constraints: Minimum length of 1.

Errors
For information about the errors that are common to all actions, see Common Errors.

See Also
For more information about using this API in one of the language-specific AWS SDKs, see the
following:

• AWS Command Line Interface

• AWS SDK for .NET
• AWS SDK for C++
• AWS SDK for Go v2
• AWS SDK for Java V2
• AWS SDK for JavaScript V3
• AWS SDK for PHP V3
• AWS SDK for Python
• AWS SDK for Ruby V3

Response Elements API Version 2010-12-01 65

Amazon Simple Email Service API Reference

GetIdentityVerificationAttributes
Given a list of identities (email addresses and/or domains), returns the verification status and (for
domain identities) the verification token for each identity.

The verification status of an email address is "Pending" until the email address owner clicks the
link within the verification email that Amazon SES sent to that address. If the email address owner
clicks the link within 24 hours, the verification status of the email address changes to "Success". If
the link is not clicked within 24 hours, the verification status changes to "Failed." In that case, to
verify the email address, you must restart the verification process from the beginning.

For domain identities, the domain's verification status is "Pending" as Amazon SES searches for
the required TXT record in the DNS settings of the domain. When Amazon SES detects the record,
the domain's verification status changes to "Success". If Amazon SES is unable to detect the record
within 72 hours, the domain's verification status changes to "Failed." In that case, to verify the
domain, you must restart the verification process from the beginning.

This operation is throttled at one request per second and can only get verification attributes for up
to 100 identities at a time.

Request Parameters
For information about the parameters that are common to all actions, see Common Parameters.

Identities.member.N

A list of identities.

Type: Array of strings

Required: Yes

Response Elements
The following element is returned by the service.

VerificationAttributes , VerificationAttributes.entry.N.key (key), VerificationAttributes.entry.N.value

(value)

A map of Identities to IdentityVerificationAttributes objects.

GetIdentityVerificationAttributes API Version 2010-12-01 66

Amazon Simple Email Service API Reference

Type: String to IdentityVerificationAttributes object map

Errors
For information about the errors that are common to all actions, see Common Errors.

See Also
For more information about using this API in one of the language-specific AWS SDKs, see the
following:

• AWS Command Line Interface

• AWS SDK for .NET
• AWS SDK for C++
• AWS SDK for Go v2
• AWS SDK for Java V2
• AWS SDK for JavaScript V3
• AWS SDK for PHP V3
• AWS SDK for Python
• AWS SDK for Ruby V3

Errors API Version 2010-12-01 67

Amazon Simple Email Service API Reference

GetSendQuota
Provides the sending limits for the Amazon SES account.

You can execute this operation no more than once per second.

Response Elements

The following elements are returned by the service.

Max24HourSend

The maximum number of emails the user is allowed to send in a 24-hour interval. A value of -1
signifies an unlimited quota.

Type: Double

MaxSendRate

The maximum number of emails that Amazon SES can accept from the user's account per
second.

Note
The rate at which Amazon SES accepts the user's messages might be less than the
maximum send rate.

Type: Double

SentLast24Hours

The number of emails sent during the previous 24 hours.

Type: Double

Errors

For information about the errors that are common to all actions, see Common Errors.

GetSendQuota API Version 2010-12-01 68

Amazon Simple Email Service API Reference

See Also
For more information about using this API in one of the language-specific AWS SDKs, see the
following:

• AWS Command Line Interface

• AWS SDK for .NET
• AWS SDK for C++
• AWS SDK for Go v2
• AWS SDK for Java V2
• AWS SDK for JavaScript V3
• AWS SDK for PHP V3
• AWS SDK for Python
• AWS SDK for Ruby V3

See Also API Version 2010-12-01 69

Amazon Simple Email Service API Reference

GetSendStatistics
Provides sending statistics for the current AWS Region. The result is a list of data points,
representing the last two weeks of sending activity. Each data point in the list contains statistics for
a 15-minute period of time.

You can execute this operation no more than once per second.

Response Elements
The following element is returned by the service.

SendDataPoints.member.N

A list of data points, each of which represents 15 minutes of activity.

Type: Array of SendDataPoint objects

Errors
For information about the errors that are common to all actions, see Common Errors.

See Also
For more information about using this API in one of the language-specific AWS SDKs, see the
following:

• AWS Command Line Interface

• AWS SDK for .NET
• AWS SDK for C++
• AWS SDK for Go v2
• AWS SDK for Java V2
• AWS SDK for JavaScript V3
• AWS SDK for PHP V3
• AWS SDK for Python
• AWS SDK for Ruby V3

GetSendStatistics API Version 2010-12-01 70

Amazon Simple Email Service API Reference

GetTemplate
Displays the template object (which includes the Subject line, HTML part and text part) for the
template you specify.

You can execute this operation no more than once per second.

Request Parameters

For information about the parameters that are common to all actions, see Common Parameters.

TemplateName

The name of the template to retrieve.

Type: String

Required: Yes

Response Elements

The following element is returned by the service.

Template

The content of the email, composed of a subject line and either an HTML part or a text-only
part.

Type: Template object

Errors

For information about the errors that are common to all actions, see Common Errors.

TemplateDoesNotExist

Indicates that the Template object you specified does not exist in your Amazon SES account.

HTTP Status Code: 400

GetTemplate API Version 2010-12-01 71

Amazon Simple Email Service API Reference

See Also
For more information about using this API in one of the language-specific AWS SDKs, see the
following:

• AWS Command Line Interface

• AWS SDK for .NET
• AWS SDK for C++
• AWS SDK for Go v2
• AWS SDK for Java V2
• AWS SDK for JavaScript V3
• AWS SDK for PHP V3
• AWS SDK for Python
• AWS SDK for Ruby V3

See Also API Version 2010-12-01 72

Amazon Simple Email Service API Reference

ListConfigurationSets
Provides a list of the configuration sets associated with your Amazon SES account in the current
AWS Region. For information about using configuration sets, see Monitoring Your Amazon SES
Sending Activity in the Amazon SES Developer Guide.

You can execute this operation no more than once per second. This operation returns up
to 1,000 configuration sets each time it is run. If your Amazon SES account has more than
1,000 configuration sets, this operation also returns NextToken. You can then execute the
ListConfigurationSets operation again, passing the NextToken parameter and the value of
the NextToken element to retrieve additional results.

Request Parameters
For information about the parameters that are common to all actions, see Common Parameters.

MaxItems

The number of configuration sets to return.

Type: Integer

Required: No
NextToken

A token returned from a previous call to ListConfigurationSets to indicate the position of

the configuration set in the configuration set list.

Type: String

Required: No

Response Elements
The following elements are returned by the service.

ConfigurationSets.member.N

A list of configuration sets.

Type: Array of ConfigurationSet objects

ListConfigurationSets API Version 2010-12-01 73

Amazon Simple Email Service API Reference

NextToken

A token indicating that there are additional configuration sets available to be listed. Pass this
token to successive calls of ListConfigurationSets.

Type: String

Errors
For information about the errors that are common to all actions, see Common Errors.

See Also
For more information about using this API in one of the language-specific AWS SDKs, see the
following:

• AWS Command Line Interface

• AWS SDK for .NET
• AWS SDK for C++
• AWS SDK for Go v2
• AWS SDK for Java V2
• AWS SDK for JavaScript V3
• AWS SDK for PHP V3
• AWS SDK for Python
• AWS SDK for Ruby V3

Errors API Version 2010-12-01 74

Amazon Simple Email Service API Reference

ListCustomVerificationEmailTemplates
Lists the existing custom verification email templates for your account in the current AWS Region.

For more information about custom verification email templates, see Using Custom Verification
Email Templates in the Amazon SES Developer Guide.

You can execute this operation no more than once per second.

Request Parameters

For information about the parameters that are common to all actions, see Common Parameters.

MaxResults

The maximum number of custom verification email templates to return. This value must be at
least 1 and less than or equal to 50. If you do not specify a value, or if you specify a value less
than 1 or greater than 50, the operation returns up to 50 results.

Type: Integer

Valid Range: Minimum value of 1. Maximum value of 50.

Required: No
NextToken

An array the contains the name and creation time stamp for each template in your Amazon SES
account.

Type: String

Required: No

Response Elements

The following elements are returned by the service.

CustomVerificationEmailTemplates.member.N

A list of the custom verification email templates that exist in your account.

ListCustomVerificationEmailTemplates API Version 2010-12-01 75

Amazon Simple Email Service API Reference

Type: Array of CustomVerificationEmailTemplate objects

NextToken

A token indicating that there are additional custom verification email templates available to be
listed. Pass this token to a subsequent call to ListTemplates to retrieve the next 50 custom
verification email templates.

Type: String

Errors
For information about the errors that are common to all actions, see Common Errors.

See Also
For more information about using this API in one of the language-specific AWS SDKs, see the
following:

• AWS Command Line Interface

• AWS SDK for .NET
• AWS SDK for C++
• AWS SDK for Go v2
• AWS SDK for Java V2
• AWS SDK for JavaScript V3
• AWS SDK for PHP V3
• AWS SDK for Python
• AWS SDK for Ruby V3

Errors API Version 2010-12-01 76

Amazon Simple Email Service API Reference

ListIdentities
Returns a list containing all of the identities (email addresses and domains) for your AWS account
in the current AWS Region, regardless of verification status.

You can execute this operation no more than once per second.

Note
It's recommended that for successive pagination calls of this API, you continue to
the use the same parameter/value pairs as used in the original call, e.g., if you used
IdentityType=Domain in the the original call and received a NextToken in the response,
you should continue providing the IdentityType=Domain parameter for further
NextToken calls; however, if you didn't provide the IdentityType parameter in the
original call, then continue to not provide it for successive pagination calls. Using this
protocol will ensure consistent results.

Request Parameters

For information about the parameters that are common to all actions, see Common Parameters.

IdentityType

The type of the identities to list. Possible values are "EmailAddress" and "Domain". If this
parameter is omitted, then all identities are listed.

Type: String

Valid Values: EmailAddress | Domain

Required: No
MaxItems

The maximum number of identities per page. Possible values are 1-1000 inclusive.

Type: Integer

Required: No

ListIdentities API Version 2010-12-01 77

Amazon Simple Email Service API Reference

NextToken

The token to use for pagination.

Type: String

Required: No

Response Elements

The following elements are returned by the service.

Identities.member.N

A list of identities.

Type: Array of strings

NextToken

The token used for pagination.

Type: String

Errors

For information about the errors that are common to all actions, see Common Errors.

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the
following:

• AWS Command Line Interface

• AWS SDK for .NET
• AWS SDK for C++
• AWS SDK for Go v2
• AWS SDK for Java V2
• AWS SDK for JavaScript V3

Response Elements API Version 2010-12-01 78

Amazon Simple Email Service API Reference

• AWS SDK for PHP V3

• AWS SDK for Python
• AWS SDK for Ruby V3

See Also API Version 2010-12-01 79

Amazon Simple Email Service API Reference

ListIdentityPolicies
Returns a list of sending authorization policies that are attached to the given identity (an email
address or a domain). This operation returns only a list. To get the actual policy content, use
GetIdentityPolicies.

Note
This operation is for the identity owner only. If you have not verified the identity, it returns
an error.

Sending authorization is a feature that enables an identity owner to authorize other senders to use
its identities. For information about using sending authorization, see the Amazon SES Developer
Guide.

You can execute this operation no more than once per second.

Request Parameters

For information about the parameters that are common to all actions, see Common Parameters.

Identity

The identity that is associated with the policy for which the policies are listed.
You can specify an identity by using its name or by using its Amazon Resource
Name (ARN). Examples: user@example.com, example.com, arn:aws:ses:us-
east-1:123456789012:identity/example.com.

To successfully call this operation, you must own the identity.

Type: String

Required: Yes

Response Elements

The following element is returned by the service.

ListIdentityPolicies API Version 2010-12-01 80

Amazon Simple Email Service API Reference

PolicyNames.member.N

A list of names of policies that apply to the specified identity.

Type: Array of strings

Length Constraints: Minimum length of 1. Maximum length of 64.

Errors
For information about the errors that are common to all actions, see Common Errors.

See Also
For more information about using this API in one of the language-specific AWS SDKs, see the
following:

• AWS Command Line Interface

• AWS SDK for .NET
• AWS SDK for C++
• AWS SDK for Go v2
• AWS SDK for Java V2
• AWS SDK for JavaScript V3
• AWS SDK for PHP V3
• AWS SDK for Python
• AWS SDK for Ruby V3

Errors API Version 2010-12-01 81

Amazon Simple Email Service API Reference

ListReceiptFilters
Lists the IP address filters associated with your AWS account in the current AWS Region.

For information about managing IP address filters, see the Amazon SES Developer Guide.

You can execute this operation no more than once per second.

Response Elements

The following element is returned by the service.

Filters.member.N

A list of IP address filter data structures, which each consist of a name, an IP address range, and
whether to allow or block mail from it.

Type: Array of ReceiptFilter objects

Errors

For information about the errors that are common to all actions, see Common Errors.

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the
following:

• AWS Command Line Interface

• AWS SDK for .NET
• AWS SDK for C++
• AWS SDK for Go v2
• AWS SDK for Java V2
• AWS SDK for JavaScript V3
• AWS SDK for PHP V3
• AWS SDK for Python
• AWS SDK for Ruby V3

ListReceiptFilters API Version 2010-12-01 82

Amazon Simple Email Service API Reference

See Also API Version 2010-12-01 83

Amazon Simple Email Service API Reference

ListReceiptRuleSets
Lists the receipt rule sets that exist under your AWS account in the current AWS Region. If there are
additional receipt rule sets to be retrieved, you receive a NextToken that you can provide to the
next call to ListReceiptRuleSets to retrieve the additional entries.

For information about managing receipt rule sets, see the Amazon SES Developer Guide.

You can execute this operation no more than once per second.

Request Parameters

For information about the parameters that are common to all actions, see Common Parameters.

NextToken

A token returned from a previous call to ListReceiptRuleSets to indicate the position in the
receipt rule set list.

Type: String

Required: No

Response Elements

The following elements are returned by the service.

NextToken

A token indicating that there are additional receipt rule sets available to be listed. Pass this
token to successive calls of ListReceiptRuleSets to retrieve up to 100 receipt rule sets at a
time.

Type: String
RuleSets.member.N

The metadata for the currently active receipt rule set. The metadata consists of the rule set
name and the timestamp of when the rule set was created.

Type: Array of ReceiptRuleSetMetadata objects

ListReceiptRuleSets API Version 2010-12-01 84

Amazon Simple Email Service API Reference

Errors
For information about the errors that are common to all actions, see Common Errors.

See Also
For more information about using this API in one of the language-specific AWS SDKs, see the
following:

• AWS Command Line Interface

• AWS SDK for .NET
• AWS SDK for C++
• AWS SDK for Go v2
• AWS SDK for Java V2
• AWS SDK for JavaScript V3
• AWS SDK for PHP V3
• AWS SDK for Python
• AWS SDK for Ruby V3

Errors API Version 2010-12-01 85

Amazon Simple Email Service API Reference

ListTemplates
Lists the email templates present in your Amazon SES account in the current AWS Region.

You can execute this operation no more than once per second.

Request Parameters

For information about the parameters that are common to all actions, see Common Parameters.

MaxItems

The maximum number of templates to return. This value must be at least 1 and less than or
equal to 100. If more than 100 items are requested, the page size will automatically set to 100.
If you do not specify a value, 10 is the default page size.

Type: Integer

Required: No
NextToken

A token returned from a previous call to ListTemplates to indicate the position in the list of
email templates.

Type: String

Required: No

Response Elements

The following elements are returned by the service.

NextToken

A token indicating that there are additional email templates available to be listed. Pass this
token to a subsequent call to ListTemplates to retrieve the next set of email templates
within your page size.

Type: String

ListTemplates API Version 2010-12-01 86

Amazon Simple Email Service API Reference

TemplatesMetadata.member.N

An array the contains the name and creation time stamp for each template in your Amazon SES
account.

Type: Array of TemplateMetadata objects

Errors
For information about the errors that are common to all actions, see Common Errors.

See Also
For more information about using this API in one of the language-specific AWS SDKs, see the
following:

• AWS Command Line Interface

• AWS SDK for .NET
• AWS SDK for C++
• AWS SDK for Go v2
• AWS SDK for Java V2
• AWS SDK for JavaScript V3
• AWS SDK for PHP V3
• AWS SDK for Python
• AWS SDK for Ruby V3

Errors API Version 2010-12-01 87

Amazon Simple Email Service API Reference

ListVerifiedEmailAddresses
Deprecated. Use the ListIdentities operation to list the email addresses and domains
associated with your account.

Response Elements
The following element is returned by the service.

VerifiedEmailAddresses.member.N

A list of email addresses that have been verified.

Type: Array of strings

Errors
For information about the errors that are common to all actions, see Common Errors.

See Also
For more information about using this API in one of the language-specific AWS SDKs, see the
following:

• AWS Command Line Interface

• AWS SDK for .NET
• AWS SDK for C++
• AWS SDK for Go v2
• AWS SDK for Java V2
• AWS SDK for JavaScript V3
• AWS SDK for PHP V3
• AWS SDK for Python
• AWS SDK for Ruby V3

ListVerifiedEmailAddresses API Version 2010-12-01 88

Amazon Simple Email Service API Reference

PutConfigurationSetDeliveryOptions
Adds or updates the delivery options for a configuration set.

Request Parameters

For information about the parameters that are common to all actions, see Common Parameters.

ConfigurationSetName

The name of the configuration set.

Type: String

Required: Yes
DeliveryOptions

Specifies whether messages that use the configuration set are required to use Transport Layer
Security (TLS).

Type: DeliveryOptions object

Required: No

Errors

For information about the errors that are common to all actions, see Common Errors.

ConfigurationSetDoesNotExist

Indicates that the configuration set does not exist.

HTTP Status Code: 400

InvalidDeliveryOptions

Indicates that provided delivery option is invalid.

HTTP Status Code: 400

PutConfigurationSetDeliveryOptions API Version 2010-12-01 89

Amazon Simple Email Service API Reference

See Also
For more information about using this API in one of the language-specific AWS SDKs, see the
following:

• AWS Command Line Interface

• AWS SDK for .NET
• AWS SDK for C++
• AWS SDK for Go v2
• AWS SDK for Java V2
• AWS SDK for JavaScript V3
• AWS SDK for PHP V3
• AWS SDK for Python
• AWS SDK for Ruby V3

See Also API Version 2010-12-01 90

Amazon Simple Email Service API Reference

PutIdentityPolicy
Adds or updates a sending authorization policy for the specified identity (an email address or a
domain).

Note
This operation is for the identity owner only. If you have not verified the identity, it returns
an error.

Sending authorization is a feature that enables an identity owner to authorize other senders to use
its identities. For information about using sending authorization, see the Amazon SES Developer
Guide.

You can execute this operation no more than once per second.

Request Parameters

For information about the parameters that are common to all actions, see Common Parameters.

Identity

The identity to which that the policy applies. You can specify an identity by using its name or
by using its Amazon Resource Name (ARN). Examples: user@example.com, example.com,
arn:aws:ses:us-east-1:123456789012:identity/example.com.

To successfully call this operation, you must own the identity.

Type: String

Required: Yes
Policy

The text of the policy in JSON format. The policy cannot exceed 4 KB.

For information about the syntax of sending authorization policies, see the Amazon SES
Developer Guide.

Type: String

PutIdentityPolicy API Version 2010-12-01 91

Amazon Simple Email Service API Reference

Length Constraints: Minimum length of 1.

Required: Yes
PolicyName

The name of the policy.

The policy name cannot exceed 64 characters and can only include alphanumeric characters,
dashes, and underscores.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 64.

Required: Yes

Errors

For information about the errors that are common to all actions, see Common Errors.

InvalidPolicy

Indicates that the provided policy is invalid. Check the error stack for more information about
what caused the error.

HTTP Status Code: 400

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the
following:

• AWS Command Line Interface

• AWS SDK for .NET
• AWS SDK for C++
• AWS SDK for Go v2
• AWS SDK for Java V2
• AWS SDK for JavaScript V3

Errors API Version 2010-12-01 92

Amazon Simple Email Service API Reference

• AWS SDK for PHP V3

• AWS SDK for Python
• AWS SDK for Ruby V3

See Also API Version 2010-12-01 93

Amazon Simple Email Service API Reference

ReorderReceiptRuleSet
Reorders the receipt rules within a receipt rule set.

Note
All of the rules in the rule set must be represented in this request. That is, it is error if the
reorder request doesn't explicitly position all of the rules.

For information about managing receipt rule sets, see the Amazon SES Developer Guide.

You can execute this operation no more than once per second.

Request Parameters

For information about the parameters that are common to all actions, see Common Parameters.

RuleNames.member.N

The specified receipt rule set's receipt rules, in order.

Type: Array of strings

Required: Yes
RuleSetName

The name of the receipt rule set to reorder.

Type: String

Required: Yes

Errors

For information about the errors that are common to all actions, see Common Errors.

RuleDoesNotExist

Indicates that the provided receipt rule does not exist.

ReorderReceiptRuleSet API Version 2010-12-01 94

Amazon Simple Email Service API Reference

HTTP Status Code: 400

RuleSetDoesNotExist

Indicates that the provided receipt rule set does not exist.

HTTP Status Code: 400

See Also
For more information about using this API in one of the language-specific AWS SDKs, see the
following:

• AWS Command Line Interface

• AWS SDK for .NET
• AWS SDK for C++
• AWS SDK for Go v2
• AWS SDK for Java V2
• AWS SDK for JavaScript V3
• AWS SDK for PHP V3
• AWS SDK for Python
• AWS SDK for Ruby V3

See Also API Version 2010-12-01 95

Amazon Simple Email Service API Reference

SendBounce
Generates and sends a bounce message to the sender of an email you received through Amazon
SES. You can only use this operation on an email up to 24 hours after you receive it.

Note
You cannot use this operation to send generic bounces for mail that was not received by
Amazon SES.

For information about receiving email through Amazon SES, see the Amazon SES Developer Guide.

You can execute this operation no more than once per second.

Request Parameters

For information about the parameters that are common to all actions, see Common Parameters.

BouncedRecipientInfoList.member.N

A list of recipients of the bounced message, including the information required to create
the Delivery Status Notifications (DSNs) for the recipients. You must specify at least one
BouncedRecipientInfo in the list.

Type: Array of BouncedRecipientInfo objects

Required: Yes
BounceSender

The address to use in the "From" header of the bounce message. This must be an identity that
you have verified with Amazon SES.

Type: String

Required: Yes
BounceSenderArn

This parameter is used only for sending authorization. It is the ARN of the identity that is
associated with the sending authorization policy that permits you to use the address in the

SendBounce API Version 2010-12-01 96

Amazon Simple Email Service API Reference

"From" header of the bounce. For more information about sending authorization, see the
Amazon SES Developer Guide.

Type: String

Required: No
Explanation

Human-readable text for the bounce message to explain the failure. If not specified, the text is
auto-generated based on the bounced recipient information.

Type: String

Required: No
MessageDsn

Message-related DSN fields. If not specified, Amazon SES chooses the values.

Type: MessageDsn object

Required: No
OriginalMessageId

The message ID of the message to be bounced.

Type: String

Required: Yes

Response Elements
The following element is returned by the service.

MessageId

The message ID of the bounce message.

Type: String

Errors
For information about the errors that are common to all actions, see Common Errors.

Response Elements API Version 2010-12-01 97

Amazon Simple Email Service API Reference

MessageRejected

Indicates that the action failed, and the message could not be sent. Check the error stack for
more information about what caused the error.

HTTP Status Code: 400

See Also
For more information about using this API in one of the language-specific AWS SDKs, see the
following:

• AWS Command Line Interface

• AWS SDK for .NET
• AWS SDK for C++
• AWS SDK for Go v2
• AWS SDK for Java V2
• AWS SDK for JavaScript V3
• AWS SDK for PHP V3
• AWS SDK for Python
• AWS SDK for Ruby V3

See Also API Version 2010-12-01 98

Amazon Simple Email Service API Reference

SendBulkTemplatedEmail
Composes an email message to multiple destinations. The message body is created using an email
template.

To send email using this operation, your call must meet the following requirements:

• The call must refer to an existing email template. You can create email templates using
CreateTemplate.
• The message must be sent from a verified email address or domain.
• If your account is still in the Amazon SES sandbox, you may send only to verified addresses or
domains, or to email addresses associated with the Amazon SES Mailbox Simulator. For more
information, see Verifying Email Addresses and Domains in the Amazon SES Developer Guide.
• The maximum message size is 10 MB.
• Each Destination parameter must include at least one recipient email address. The recipient
address can be a To: address, a CC: address, or a BCC: address. If a recipient email address is
invalid (that is, it is not in the format UserName@[SubDomain.]Domain.TopLevelDomain), the
entire message is rejected, even if the message contains other recipients that are valid.
• The message may not include more than 50 recipients, across the To:, CC: and BCC: fields. If you
need to send an email message to a larger audience, you can divide your recipient list into groups
of 50 or fewer, and then call the SendBulkTemplatedEmail operation several times to send
the message to each group.
• The number of destinations you can contact in a single call can be limited by your account's
maximum sending rate.

Request Parameters

For information about the parameters that are common to all actions, see Common Parameters.

ConfigurationSetName

The name of the configuration set to use when you send an email using
SendBulkTemplatedEmail.

Type: String

Required: No

SendBulkTemplatedEmail API Version 2010-12-01 99

Amazon Simple Email Service API Reference

DefaultTags.member.N

A list of tags, in the form of name/value pairs, to apply to an email that you send to a
destination using SendBulkTemplatedEmail.

Type: Array of MessageTag objects

Required: No
DefaultTemplateData

A list of replacement values to apply to the template when replacement data is not specified
in a Destination object. These values act as a default or fallback option when no other data is
available.

The template data is a JSON object, typically consisting of key-value pairs in which the keys
correspond to replacement tags in the email template.

Type: String

Length Constraints: Maximum length of 262144.

Required: Yes
Destinations.member.N

One or more Destination objects. All of the recipients in a Destination receive the same
version of the email. You can specify up to 50 Destination objects within a Destinations
array.

Type: Array of BulkEmailDestination objects

Required: Yes
ReplyToAddresses.member.N

The reply-to email address(es) for the message. If the recipient replies to the message, each
reply-to address receives the reply.

Type: Array of strings

Required: No
ReturnPath

The email address that bounces and complaints are forwarded to when feedback forwarding is
enabled. If the message cannot be delivered to the recipient, then an error message is returned

Request Parameters API Version 2010-12-01 100

Amazon Simple Email Service API Reference

from the recipient's ISP; this message is forwarded to the email address specified by the
ReturnPath parameter. The ReturnPath parameter is never overwritten. This email address
must be either individually verified with Amazon SES, or from a domain that has been verified
with Amazon SES.

Type: String

Required: No
ReturnPathArn

This parameter is used only for sending authorization. It is the ARN of the identity that is
associated with the sending authorization policy that permits you to use the email address
specified in the ReturnPath parameter.

For example, if the owner of example.com (which has ARN arn:aws:ses:us-

east-1:123456789012:identity/example.com) attaches a policy to it that authorizes
you to use feedback@example.com, then you would specify the ReturnPathArn to be
arn:aws:ses:us-east-1:123456789012:identity/example.com, and the ReturnPath
to be feedback@example.com.

For more information about sending authorization, see the Amazon SES Developer Guide.

Type: String

Required: No
Source

The email address that is sending the email. This email address must be either individually
verified with Amazon SES, or from a domain that has been verified with Amazon SES. For
information about verifying identities, see the Amazon SES Developer Guide.

If you are sending on behalf of another user and have been permitted to do so by a sending
authorization policy, then you must also specify the SourceArn parameter. For more
information about sending authorization, see the Amazon SES Developer Guide.

Note
Amazon SES does not support the SMTPUTF8 extension, as described in RFC6531. For
this reason, the email address string must be 7-bit ASCII. If you want to send to or from
email addresses that contain Unicode characters in the domain part of an address, you

Request Parameters API Version 2010-12-01 101

Amazon Simple Email Service API Reference

must encode the domain using Punycode. Punycode is not permitted in the local part
of the email address (the part before the @ sign) nor in the "friendly from" name. If
you want to use Unicode characters in the "friendly from" name, you must encode the
"friendly from" name using MIME encoded-word syntax, as described in Sending raw
email using the Amazon SES API. For more information about Punycode, see RFC 3492.

Type: String

Required: Yes
SourceArn

This parameter is used only for sending authorization. It is the ARN of the identity that is
associated with the sending authorization policy that permits you to send for the email address
specified in the Source parameter.

For example, if the owner of example.com (which has ARN arn:aws:ses:us-

east-1:123456789012:identity/example.com) attaches a policy to it that authorizes
you to send from user@example.com, then you would specify the SourceArn to be
arn:aws:ses:us-east-1:123456789012:identity/example.com, and the Source to be
user@example.com.

For more information about sending authorization, see the Amazon SES Developer Guide.

Type: String

Required: No
Template

The template to use when sending this email.

Type: String

Required: Yes
TemplateArn

The ARN of the template to use when sending this email.

Type: String

Request Parameters API Version 2010-12-01 102

Amazon Simple Email Service API Reference

Required: No

Response Elements

The following element is returned by the service.

Status.member.N

One object per intended recipient. Check each response object and retry any messages with a
failure status. (Note that order of responses will be respective to order of destinations in the
request.)Receipt rules enable you to specify which actions

Type: Array of BulkEmailDestinationStatus objects

Errors

For information about the errors that are common to all actions, see Common Errors.

AccountSendingPaused

Indicates that email sending is disabled for your entire Amazon SES account.

You can enable or disable email sending for your Amazon SES account using
UpdateAccountSendingEnabled.

HTTP Status Code: 400

ConfigurationSetDoesNotExist

Indicates that the configuration set does not exist.

HTTP Status Code: 400

ConfigurationSetSendingPaused

Indicates that email sending is disabled for the configuration set.

You can enable or disable email sending for a configuration set using
UpdateConfigurationSetSendingEnabled.

HTTP Status Code: 400

Response Elements API Version 2010-12-01 103

Amazon Simple Email Service API Reference

MailFromDomainNotVerified

Indicates that the message could not be sent because Amazon SES could not read the MX
record required to use the specified MAIL FROM domain. For information about editing the
custom MAIL FROM domain settings for an identity, see the Amazon SES Developer Guide.

HTTP Status Code: 400

MessageRejected

Indicates that the action failed, and the message could not be sent. Check the error stack for
more information about what caused the error.

HTTP Status Code: 400

TemplateDoesNotExist

Indicates that the Template object you specified does not exist in your Amazon SES account.

HTTP Status Code: 400

See Also
For more information about using this API in one of the language-specific AWS SDKs, see the
following:

• AWS Command Line Interface

• AWS SDK for .NET
• AWS SDK for C++
• AWS SDK for Go v2
• AWS SDK for Java V2
• AWS SDK for JavaScript V3
• AWS SDK for PHP V3
• AWS SDK for Python
• AWS SDK for Ruby V3

See Also API Version 2010-12-01 104

Amazon Simple Email Service API Reference

SendCustomVerificationEmail
Adds an email address to the list of identities for your Amazon SES account in the current AWS
Region and attempts to verify it. As a result of executing this operation, a customized verification
email is sent to the specified address.

To use this operation, you must first create a custom verification email template. For more
information about creating and using custom verification email templates, see Using Custom
Verification Email Templates in the Amazon SES Developer Guide.

You can execute this operation no more than once per second.

Request Parameters
For information about the parameters that are common to all actions, see Common Parameters.

ConfigurationSetName

Name of a configuration set to use when sending the verification email.

Type: String

Required: No
EmailAddress

The email address to verify.

Type: String

Required: Yes
TemplateName

The name of the custom verification email template to use when sending the verification email.

Type: String

Required: Yes

Response Elements
The following element is returned by the service.

SendCustomVerificationEmail API Version 2010-12-01 105

Amazon Simple Email Service API Reference

MessageId

The unique message identifier returned from the SendCustomVerificationEmail operation.

Type: String

Errors

For information about the errors that are common to all actions, see Common Errors.

ConfigurationSetDoesNotExist

Indicates that the configuration set does not exist.

HTTP Status Code: 400

CustomVerificationEmailTemplateDoesNotExist

Indicates that a custom verification email template with the name you specified does not exist.

HTTP Status Code: 400

FromEmailAddressNotVerified

Indicates that the sender address specified for a custom verification email is not verified, and is
therefore not eligible to send the custom verification email.

HTTP Status Code: 400

MessageRejected

Indicates that the action failed, and the message could not be sent. Check the error stack for
more information about what caused the error.

HTTP Status Code: 400

ProductionAccessNotGranted

Indicates that the account has not been granted production access.

HTTP Status Code: 400

Errors API Version 2010-12-01 106

Amazon Simple Email Service API Reference

See Also
For more information about using this API in one of the language-specific AWS SDKs, see the
following:

• AWS Command Line Interface

• AWS SDK for .NET
• AWS SDK for C++
• AWS SDK for Go v2
• AWS SDK for Java V2
• AWS SDK for JavaScript V3
• AWS SDK for PHP V3
• AWS SDK for Python
• AWS SDK for Ruby V3

See Also API Version 2010-12-01 107

Amazon Simple Email Service API Reference

SendEmail
Composes an email message and immediately queues it for sending. To send email using this
operation, your message must meet the following requirements:

• The message must be sent from a verified email address or domain. If you attempt to send email
using a non-verified address or domain, the operation results in an "Email address not verified"
error.
• If your account is still in the Amazon SES sandbox, you may only send to verified addresses or
domains, or to email addresses associated with the Amazon SES Mailbox Simulator. For more
information, see Verifying Email Addresses and Domains in the Amazon SES Developer Guide.
• The maximum message size is 10 MB.
• The message must include at least one recipient email address. The recipient address can be a To:
address, a CC: address, or a BCC: address. If a recipient email address is invalid (that is, it is not
in the format UserName@[SubDomain.]Domain.TopLevelDomain), the entire message is rejected,
even if the message contains other recipients that are valid.
• The message may not include more than 50 recipients, across the To:, CC: and BCC: fields. If you
need to send an email message to a larger audience, you can divide your recipient list into groups
of 50 or fewer, and then call the SendEmail operation several times to send the message to
each group.

Important
For every message that you send, the total number of recipients (including each recipient
in the To:, CC: and BCC: fields) is counted against the maximum number of emails you
can send in a 24-hour period (your sending quota). For more information about sending
quotas in Amazon SES, see Managing Your Amazon SES Sending Limits in the Amazon SES
Developer Guide.

Request Parameters
For information about the parameters that are common to all actions, see Common Parameters.

ConfigurationSetName

The name of the configuration set to use when you send an email using SendEmail.

SendEmail API Version 2010-12-01 108

Amazon Simple Email Service API Reference

Type: String

Required: No
Destination

The destination for this email, composed of To:, CC:, and BCC: fields.

Type: Destination object

Required: Yes
Message

The message to be sent.

Type: Message object

Required: Yes
ReplyToAddresses.member.N

The reply-to email address(es) for the message. If the recipient replies to the message, each
reply-to address receives the reply.

Type: Array of strings

Required: No
ReturnPath

The email address that bounces and complaints are forwarded to when feedback forwarding is
enabled. If the message cannot be delivered to the recipient, then an error message is returned
from the recipient's ISP; this message is forwarded to the email address specified by the
ReturnPath parameter. The ReturnPath parameter is never overwritten. This email address
must be either individually verified with Amazon SES, or from a domain that has been verified
with Amazon SES.

Type: String

Required: No
ReturnPathArn

This parameter is used only for sending authorization. It is the ARN of the identity that is
associated with the sending authorization policy that permits you to use the email address
specified in the ReturnPath parameter.

Request Parameters API Version 2010-12-01 109

Amazon Simple Email Service API Reference

For example, if the owner of example.com (which has ARN arn:aws:ses:us-

east-1:123456789012:identity/example.com) attaches a policy to it that authorizes
you to use feedback@example.com, then you would specify the ReturnPathArn to be
arn:aws:ses:us-east-1:123456789012:identity/example.com, and the ReturnPath
to be feedback@example.com.

For more information about sending authorization, see the Amazon SES Developer Guide.

Type: String

Required: No

Source

The email address that is sending the email. This email address must be either individually
verified with Amazon SES, or from a domain that has been verified with Amazon SES. For
information about verifying identities, see the Amazon SES Developer Guide.

If you are sending on behalf of another user and have been permitted to do so by a sending
authorization policy, then you must also specify the SourceArn parameter. For more
information about sending authorization, see the Amazon SES Developer Guide.

Note
Amazon SES does not support the SMTPUTF8 extension, as described in RFC6531. For
this reason, the email address string must be 7-bit ASCII. If you want to send to or from
email addresses that contain Unicode characters in the domain part of an address, you
must encode the domain using Punycode. Punycode is not permitted in the local part
of the email address (the part before the @ sign) nor in the "friendly from" name. If
you want to use Unicode characters in the "friendly from" name, you must encode the
"friendly from" name using MIME encoded-word syntax, as described in Sending raw
email using the Amazon SES API. For more information about Punycode, see RFC 3492.

Type: String

Required: Yes

Request Parameters API Version 2010-12-01 110

Amazon Simple Email Service API Reference

SourceArn

This parameter is used only for sending authorization. It is the ARN of the identity that is
associated with the sending authorization policy that permits you to send for the email address
specified in the Source parameter.

For example, if the owner of example.com (which has ARN arn:aws:ses:us-

east-1:123456789012:identity/example.com) attaches a policy to it that authorizes
you to send from user@example.com, then you would specify the SourceArn to be
arn:aws:ses:us-east-1:123456789012:identity/example.com, and the Source to be
user@example.com.

For more information about sending authorization, see the Amazon SES Developer Guide.

Type: String

Required: No
Tags.member.N

A list of tags, in the form of name/value pairs, to apply to an email that you send using
SendEmail. Tags correspond to characteristics of the email that you define, so that you can
publish email sending events.

Type: Array of MessageTag objects

Required: No

Response Elements
The following element is returned by the service.

MessageId

The unique message identifier returned from the SendEmail action.

Type: String

Errors
For information about the errors that are common to all actions, see Common Errors.

Response Elements API Version 2010-12-01 111

Amazon Simple Email Service API Reference

AccountSendingPaused

Indicates that email sending is disabled for your entire Amazon SES account.

You can enable or disable email sending for your Amazon SES account using
UpdateAccountSendingEnabled.

HTTP Status Code: 400

ConfigurationSetDoesNotExist

Indicates that the configuration set does not exist.

HTTP Status Code: 400

ConfigurationSetSendingPaused

Indicates that email sending is disabled for the configuration set.

You can enable or disable email sending for a configuration set using
UpdateConfigurationSetSendingEnabled.

HTTP Status Code: 400

MailFromDomainNotVerified

Indicates that the message could not be sent because Amazon SES could not read the MX
record required to use the specified MAIL FROM domain. For information about editing the
custom MAIL FROM domain settings for an identity, see the Amazon SES Developer Guide.

HTTP Status Code: 400

MessageRejected

Indicates that the action failed, and the message could not be sent. Check the error stack for
more information about what caused the error.

HTTP Status Code: 400

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the
following:

See Also API Version 2010-12-01 112

Amazon Simple Email Service API Reference

• AWS Command Line Interface

• AWS SDK for .NET
• AWS SDK for C++
• AWS SDK for Go v2
• AWS SDK for Java V2
• AWS SDK for JavaScript V3
• AWS SDK for PHP V3
• AWS SDK for Python
• AWS SDK for Ruby V3

See Also API Version 2010-12-01 113

Amazon Simple Email Service API Reference

SendRawEmail
Composes an email message and immediately queues it for sending.

This operation is more flexible than the SendEmail operation. When you use the SendRawEmail
operation, you can specify the headers of the message as well as its content. This flexibility is
useful, for example, when you need to send a multipart MIME email (such a message that contains
both a text and an HTML version). You can also use this operation to send messages that include
attachments.

The SendRawEmail operation has the following requirements:

• You can only send email from verified email addresses or domains. If you try to send email from
an address that isn't verified, the operation results in an "Email address not verified" error.

• If your account is still in the Amazon SES sandbox, you can only send email to other verified
addresses in your account, or to addresses that are associated with the Amazon SES mailbox
simulator.

• The maximum message size, including attachments, is 10 MB.

• Each message has to include at least one recipient address. A recipient address includes any
address on the To:, CC:, or BCC: lines.

• If you send a single message to more than one recipient address, and one of
the recipient addresses isn't in a valid format (that is, it's not in the format
UserName@[SubDomain.]Domain.TopLevelDomain), Amazon SES rejects the entire message, even
if the other addresses are valid.
• Each message can include up to 50 recipient addresses across the To:, CC:, or BCC: lines. If you
need to send a single message to more than 50 recipients, you have to split the list of recipient
addresses into groups of less than 50 recipients, and send separate messages to each group.
• Amazon SES allows you to specify 8-bit Content-Transfer-Encoding for MIME message parts.
However, if Amazon SES has to modify the contents of your message (for example, if you use
open and click tracking), 8-bit content isn't preserved. For this reason, we highly recommend that
you encode all content that isn't 7-bit ASCII. For more information, see MIME Encoding in the
Amazon SES Developer Guide.

Additionally, keep the following considerations in mind when using the SendRawEmail operation:

SendRawEmail API Version 2010-12-01 114

Amazon Simple Email Service API Reference

• Although you can customize the message headers when using the SendRawEmail operation,
Amazon SES automatically applies its own Message-ID and Date headers; if you passed these
headers when creating the message, they are overwritten by the values that Amazon SES
provides.
• If you are using sending authorization to send on behalf of another user, SendRawEmail
enables you to specify the cross-account identity for the email's Source, From, and Return-Path
parameters in one of two ways: you can pass optional parameters SourceArn, FromArn, and/or
ReturnPathArn, or you can include the following X-headers in the header of your raw email:
• X-SES-SOURCE-ARN
• X-SES-FROM-ARN
• X-SES-RETURN-PATH-ARN

Important
Don't include these X-headers in the DKIM signature. Amazon SES removes these before
it sends the email.

If you only specify the SourceIdentityArn parameter, Amazon SES sets the From and Return-
Path addresses to the same identity that you specified.

For more information about sending authorization, see the Using Sending Authorization with
Amazon SES in the Amazon SES Developer Guide.
• For every message that you send, the total number of recipients (including each recipient in the
To:, CC: and BCC: fields) is counted against the maximum number of emails you can send in a 24-
hour period (your sending quota). For more information about sending quotas in Amazon SES,
see Managing Your Amazon SES Sending Limits in the Amazon SES Developer Guide.

Request Parameters

For information about the parameters that are common to all actions, see Common Parameters.

ConfigurationSetName

The name of the configuration set to use when you send an email using SendRawEmail.

Type: String

Request Parameters API Version 2010-12-01 115

Amazon Simple Email Service API Reference

Required: No
Destinations.member.N

A list of destinations for the message, consisting of To:, CC:, and BCC: addresses.

Type: Array of strings

Required: No
FromArn

This parameter is used only for sending authorization. It is the ARN of the identity that is
associated with the sending authorization policy that permits you to specify a particular "From"
address in the header of the raw email.

Instead of using this parameter, you can use the X-header X-SES-FROM-ARN in the raw
message of the email. If you use both the FromArn parameter and the corresponding X-header,
Amazon SES uses the value of the FromArn parameter.

Note
For information about when to use this parameter, see the description of
SendRawEmail in this guide, or see the Amazon SES Developer Guide.

Type: String

Required: No
RawMessage

The raw email message itself. The message has to meet the following criteria:
• The message has to contain a header and a body, separated by a blank line.
• All of the required header fields must be present in the message.
• Each part of a multipart MIME message must be formatted properly.
• Attachments must be of a content type that Amazon SES supports. For a list on unsupported
content types, see Unsupported Attachment Types in the Amazon SES Developer Guide.
• The entire message must be base64-encoded.

Request Parameters API Version 2010-12-01 116

Amazon Simple Email Service API Reference

• If any of the MIME parts in your message contain content that is outside of the 7-bit ASCII
character range, we highly recommend that you encode that content. For more information,
see Sending Raw Email in the Amazon SES Developer Guide.
• Per RFC 5321, the maximum length of each line of text, including the <CRLF>, must not
exceed 1,000 characters.

Type: RawMessage object

Required: Yes
ReturnPathArn

This parameter is used only for sending authorization. It is the ARN of the identity that is
associated with the sending authorization policy that permits you to use the email address
specified in the ReturnPath parameter.

For example, if the owner of example.com (which has ARN arn:aws:ses:us-

east-1:123456789012:identity/example.com) attaches a policy to it that authorizes
you to use feedback@example.com, then you would specify the ReturnPathArn to be
arn:aws:ses:us-east-1:123456789012:identity/example.com, and the ReturnPath
to be feedback@example.com.

Instead of using this parameter, you can use the X-header X-SES-RETURN-PATH-ARN in
the raw message of the email. If you use both the ReturnPathArn parameter and the
corresponding X-header, Amazon SES uses the value of the ReturnPathArn parameter.

Note
For information about when to use this parameter, see the description of
SendRawEmail in this guide, or see the Amazon SES Developer Guide.

Type: String

Required: No
Source

The identity's email address. If you do not provide a value for this parameter, you must specify a
"From" address in the raw text of the message. (You can also specify both.)

Request Parameters API Version 2010-12-01 117

Amazon Simple Email Service API Reference

Note
Amazon SES does not support the SMTPUTF8 extension, as described inRFC6531. For
this reason, the email address string must be 7-bit ASCII. If you want to send to or from
email addresses that contain Unicode characters in the domain part of an address, you
must encode the domain using Punycode. Punycode is not permitted in the local part
of the email address (the part before the @ sign) nor in the "friendly from" name. If
you want to use Unicode characters in the "friendly from" name, you must encode the
"friendly from" name using MIME encoded-word syntax, as described in Sending raw
email using the Amazon SES API. For more information about Punycode, see RFC 3492.

If you specify the Source parameter and have feedback forwarding enabled, then bounces and
complaints are sent to this email address. This takes precedence over any Return-Path header
that you might include in the raw text of the message.

Type: String

Required: No

SourceArn

This parameter is used only for sending authorization. It is the ARN of the identity that is
associated with the sending authorization policy that permits you to send for the email address
specified in the Source parameter.

For example, if the owner of example.com (which has ARN arn:aws:ses:us-

east-1:123456789012:identity/example.com) attaches a policy to it that authorizes
you to send from user@example.com, then you would specify the SourceArn to be
arn:aws:ses:us-east-1:123456789012:identity/example.com, and the Source to be
user@example.com.

Instead of using this parameter, you can use the X-header X-SES-SOURCE-ARN in the raw
message of the email. If you use both the SourceArn parameter and the corresponding X-
header, Amazon SES uses the value of the SourceArn parameter.

Request Parameters API Version 2010-12-01 118

Amazon Simple Email Service API Reference

Note
For information about when to use this parameter, see the description of
SendRawEmail in this guide, or see the Amazon SES Developer Guide.

Type: String

Required: No
Tags.member.N

A list of tags, in the form of name/value pairs, to apply to an email that you send using
SendRawEmail. Tags correspond to characteristics of the email that you define, so that you can
publish email sending events.

Type: Array of MessageTag objects

Required: No

Response Elements

The following element is returned by the service.

MessageId

The unique message identifier returned from the SendRawEmail action.

Type: String

Errors

For information about the errors that are common to all actions, see Common Errors.

AccountSendingPaused

Indicates that email sending is disabled for your entire Amazon SES account.

You can enable or disable email sending for your Amazon SES account using
UpdateAccountSendingEnabled.

Response Elements API Version 2010-12-01 119

Amazon Simple Email Service API Reference

HTTP Status Code: 400

ConfigurationSetDoesNotExist

Indicates that the configuration set does not exist.

HTTP Status Code: 400

ConfigurationSetSendingPaused

Indicates that email sending is disabled for the configuration set.

You can enable or disable email sending for a configuration set using
UpdateConfigurationSetSendingEnabled.

HTTP Status Code: 400

MailFromDomainNotVerified

Indicates that the message could not be sent because Amazon SES could not read the MX
record required to use the specified MAIL FROM domain. For information about editing the
custom MAIL FROM domain settings for an identity, see the Amazon SES Developer Guide.

HTTP Status Code: 400

MessageRejected

Indicates that the action failed, and the message could not be sent. Check the error stack for
more information about what caused the error.

HTTP Status Code: 400

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the
following:

• AWS Command Line Interface

• AWS SDK for .NET
• AWS SDK for C++
• AWS SDK for Go v2
• AWS SDK for Java V2

See Also API Version 2010-12-01 120

Amazon Simple Email Service API Reference

• AWS SDK for JavaScript V3

• AWS SDK for PHP V3
• AWS SDK for Python
• AWS SDK for Ruby V3

See Also API Version 2010-12-01 121

Amazon Simple Email Service API Reference

SendTemplatedEmail
Composes an email message using an email template and immediately queues it for sending.

To send email using this operation, your call must meet the following requirements:

• The call must refer to an existing email template. You can create email templates using the
CreateTemplate operation.

• The message must be sent from a verified email address or domain.

• If your account is still in the Amazon SES sandbox, you may only send to verified addresses or
domains, or to email addresses associated with the Amazon SES Mailbox Simulator. For more
information, see Verifying Email Addresses and Domains in the Amazon SES Developer Guide.

• The maximum message size is 10 MB.

• Calls to the SendTemplatedEmail operation may only include one Destination parameter. A
destination is a set of recipients that receives the same version of the email. The Destination
parameter can include up to 50 recipients, across the To:, CC: and BCC: fields.

• The Destination parameter must include at least one recipient email address. The recipient
address can be a To: address, a CC: address, or a BCC: address. If a recipient email address is
invalid (that is, it is not in the format UserName@[SubDomain.]Domain.TopLevelDomain), the
entire message is rejected, even if the message contains other recipients that are valid.

Important
If your call to the SendTemplatedEmail operation includes all of the required
parameters, Amazon SES accepts it and returns a Message ID. However, if Amazon SES
can't render the email because the template contains errors, it doesn't send the email.
Additionally, because it already accepted the message, Amazon SES doesn't return a
message stating that it was unable to send the email.
For these reasons, we highly recommend that you set up Amazon SES to send you
notifications when Rendering Failure events occur. For more information, see Sending
Personalized Email Using the Amazon SES API in the Amazon Simple Email Service
Developer Guide.

SendTemplatedEmail API Version 2010-12-01 122

Amazon Simple Email Service API Reference

Request Parameters

For information about the parameters that are common to all actions, see Common Parameters.

ConfigurationSetName

The name of the configuration set to use when you send an email using
SendTemplatedEmail.

Type: String

Required: No
Destination

The destination for this email, composed of To:, CC:, and BCC: fields. A Destination can include
up to 50 recipients across these three fields.

Type: Destination object

Required: Yes
ReplyToAddresses.member.N

The reply-to email address(es) for the message. If the recipient replies to the message, each
reply-to address receives the reply.

Type: Array of strings

Required: No
ReturnPath

The email address that bounces and complaints are forwarded to when feedback forwarding is
enabled. If the message cannot be delivered to the recipient, then an error message is returned
from the recipient's ISP; this message is forwarded to the email address specified by the
ReturnPath parameter. The ReturnPath parameter is never overwritten. This email address
must be either individually verified with Amazon SES, or from a domain that has been verified
with Amazon SES.

Type: String

Required: No

Request Parameters API Version 2010-12-01 123

Amazon Simple Email Service API Reference

ReturnPathArn

This parameter is used only for sending authorization. It is the ARN of the identity that is
associated with the sending authorization policy that permits you to use the email address
specified in the ReturnPath parameter.

For example, if the owner of example.com (which has ARN arn:aws:ses:us-

east-1:123456789012:identity/example.com) attaches a policy to it that authorizes
you to use feedback@example.com, then you would specify the ReturnPathArn to be
arn:aws:ses:us-east-1:123456789012:identity/example.com, and the ReturnPath
to be feedback@example.com.

For more information about sending authorization, see the Amazon SES Developer Guide.

Type: String

Required: No
Source

The email address that is sending the email. This email address must be either individually
verified with Amazon SES, or from a domain that has been verified with Amazon SES. For
information about verifying identities, see the Amazon SES Developer Guide.

If you are sending on behalf of another user and have been permitted to do so by a sending
authorization policy, then you must also specify the SourceArn parameter. For more
information about sending authorization, see the Amazon SES Developer Guide.

Note
Amazon SES does not support the SMTPUTF8 extension, as described in RFC6531. for
this reason, The email address string must be 7-bit ASCII. If you want to send to or from
email addresses that contain Unicode characters in the domain part of an address, you
must encode the domain using Punycode. Punycode is not permitted in the local part
of the email address (the part before the @ sign) nor in the "friendly from" name. If
you want to use Unicode characters in the "friendly from" name, you must encode the
"friendly from" name using MIME encoded-word syntax, as described in Sending raw
email using the Amazon SES API. For more information about Punycode, see RFC 3492.

Type: String

Request Parameters API Version 2010-12-01 124

Amazon Simple Email Service API Reference

Required: Yes
SourceArn

This parameter is used only for sending authorization. It is the ARN of the identity that is
associated with the sending authorization policy that permits you to send for the email address
specified in the Source parameter.

For example, if the owner of example.com (which has ARN arn:aws:ses:us-

east-1:123456789012:identity/example.com) attaches a policy to it that authorizes
you to send from user@example.com, then you would specify the SourceArn to be
arn:aws:ses:us-east-1:123456789012:identity/example.com, and the Source to be
user@example.com.

For more information about sending authorization, see the Amazon SES Developer Guide.

Type: String

Required: No
Tags.member.N

A list of tags, in the form of name/value pairs, to apply to an email that you send using
SendTemplatedEmail. Tags correspond to characteristics of the email that you define, so that
you can publish email sending events.

Type: Array of MessageTag objects

Required: No
Template

The template to use when sending this email.

Type: String

Required: Yes
TemplateArn

The ARN of the template to use when sending this email.

Type: String

Request Parameters API Version 2010-12-01 125

Amazon Simple Email Service API Reference

Required: No
TemplateData

A list of replacement values to apply to the template. This parameter is a JSON object, typically
consisting of key-value pairs in which the keys correspond to replacement tags in the email
template.

Type: String

Length Constraints: Maximum length of 262144.

Required: Yes

Response Elements

The following element is returned by the service.

MessageId

The unique message identifier returned from the SendTemplatedEmail action.

Type: String

Errors

For information about the errors that are common to all actions, see Common Errors.

AccountSendingPaused

Indicates that email sending is disabled for your entire Amazon SES account.

You can enable or disable email sending for your Amazon SES account using
UpdateAccountSendingEnabled.

HTTP Status Code: 400

ConfigurationSetDoesNotExist

Indicates that the configuration set does not exist.

HTTP Status Code: 400

Response Elements API Version 2010-12-01 126

Amazon Simple Email Service API Reference

ConfigurationSetSendingPaused

Indicates that email sending is disabled for the configuration set.

You can enable or disable email sending for a configuration set using
UpdateConfigurationSetSendingEnabled.

HTTP Status Code: 400

MailFromDomainNotVerified

Indicates that the message could not be sent because Amazon SES could not read the MX
record required to use the specified MAIL FROM domain. For information about editing the
custom MAIL FROM domain settings for an identity, see the Amazon SES Developer Guide.

HTTP Status Code: 400

MessageRejected

Indicates that the action failed, and the message could not be sent. Check the error stack for
more information about what caused the error.

HTTP Status Code: 400

TemplateDoesNotExist

Indicates that the Template object you specified does not exist in your Amazon SES account.

HTTP Status Code: 400

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the
following:

• AWS Command Line Interface

• AWS SDK for .NET
• AWS SDK for C++
• AWS SDK for Go v2
• AWS SDK for Java V2
• AWS SDK for JavaScript V3

See Also API Version 2010-12-01 127

Amazon Simple Email Service API Reference

• AWS SDK for PHP V3

• AWS SDK for Python
• AWS SDK for Ruby V3

See Also API Version 2010-12-01 128

Amazon Simple Email Service API Reference

SetActiveReceiptRuleSet
Sets the specified receipt rule set as the active receipt rule set.

Note
To disable your email-receiving through Amazon SES completely, you can call this
operation with RuleSetName set to null.

For information about managing receipt rule sets, see the Amazon SES Developer Guide.

You can execute this operation no more than once per second.

Request Parameters
For information about the parameters that are common to all actions, see Common Parameters.

RuleSetName

The name of the receipt rule set to make active. Setting this value to null disables all email
receiving.

Type: String

Required: No

Errors
For information about the errors that are common to all actions, see Common Errors.

RuleSetDoesNotExist

Indicates that the provided receipt rule set does not exist.

HTTP Status Code: 400

See Also
For more information about using this API in one of the language-specific AWS SDKs, see the
following:

SetActiveReceiptRuleSet API Version 2010-12-01 129

Amazon Simple Email Service API Reference

• AWS Command Line Interface

• AWS SDK for .NET
• AWS SDK for C++
• AWS SDK for Go v2
• AWS SDK for Java V2
• AWS SDK for JavaScript V3
• AWS SDK for PHP V3
• AWS SDK for Python
• AWS SDK for Ruby V3

See Also API Version 2010-12-01 130

Amazon Simple Email Service API Reference

SetIdentityDkimEnabled
Enables or disables Easy DKIM signing of email sent from an identity. If Easy DKIM signing is
enabled for a domain, then Amazon SES uses DKIM to sign all email that it sends from addresses
on that domain. If Easy DKIM signing is enabled for an email address, then Amazon SES uses DKIM
to sign all email it sends from that address.

Note
For email addresses (for example, user@example.com), you can only enable DKIM signing
if the corresponding domain (in this case, example.com) has been set up to use Easy DKIM.

You can enable DKIM signing for an identity at any time after you start the verification process for
the identity, even if the verification process isn't complete.

You can execute this operation no more than once per second.

For more information about Easy DKIM signing, go to the Amazon SES Developer Guide.

Request Parameters

For information about the parameters that are common to all actions, see Common Parameters.

DkimEnabled

Sets whether DKIM signing is enabled for an identity. Set to true to enable DKIM signing for
this identity; false to disable it.

Type: Boolean

Required: Yes
Identity

The identity for which DKIM signing should be enabled or disabled.

Type: String

Required: Yes

SetIdentityDkimEnabled API Version 2010-12-01 131

Amazon Simple Email Service API Reference

Errors
For information about the errors that are common to all actions, see Common Errors.

See Also
For more information about using this API in one of the language-specific AWS SDKs, see the
following:

• AWS Command Line Interface

• AWS SDK for .NET
• AWS SDK for C++
• AWS SDK for Go v2
• AWS SDK for Java V2
• AWS SDK for JavaScript V3
• AWS SDK for PHP V3
• AWS SDK for Python
• AWS SDK for Ruby V3

Errors API Version 2010-12-01 132

Amazon Simple Email Service API Reference

SetIdentityFeedbackForwardingEnabled
Given an identity (an email address or a domain), enables or disables whether Amazon SES
forwards bounce and complaint notifications as email. Feedback forwarding can only be disabled
when Amazon Simple Notification Service (Amazon SNS) topics are specified for both bounces and
complaints.

Note
Feedback forwarding does not apply to delivery notifications. Delivery notifications are
only available through Amazon SNS.

You can execute this operation no more than once per second.

For more information about using notifications with Amazon SES, see the Amazon SES Developer
Guide.

Request Parameters

For information about the parameters that are common to all actions, see Common Parameters.

ForwardingEnabled

Sets whether Amazon SES forwards bounce and complaint notifications as email. true specifies
that Amazon SES forwards bounce and complaint notifications as email, in addition to any
Amazon SNS topic publishing otherwise specified. false specifies that Amazon SES publishes
bounce and complaint notifications only through Amazon SNS. This value can only be set to
false when Amazon SNS topics are set for both Bounce and Complaint notification types.

Type: Boolean

Required: Yes
Identity

The identity for which to set bounce and complaint notification forwarding. Examples:
user@example.com, example.com.

Type: String

SetIdentityFeedbackForwardingEnabled API Version 2010-12-01 133

Amazon Simple Email Service API Reference

Required: Yes

Errors
For information about the errors that are common to all actions, see Common Errors.

See Also
For more information about using this API in one of the language-specific AWS SDKs, see the
following:

• AWS Command Line Interface

• AWS SDK for .NET
• AWS SDK for C++
• AWS SDK for Go v2
• AWS SDK for Java V2
• AWS SDK for JavaScript V3
• AWS SDK for PHP V3
• AWS SDK for Python
• AWS SDK for Ruby V3

Errors API Version 2010-12-01 134

Amazon Simple Email Service API Reference

SetIdentityHeadersInNotificationsEnabled
Given an identity (an email address or a domain), sets whether Amazon SES includes the original
email headers in the Amazon Simple Notification Service (Amazon SNS) notifications of a specified
type.

You can execute this operation no more than once per second.

For more information about using notifications with Amazon SES, see the Amazon SES Developer
Guide.

Request Parameters
For information about the parameters that are common to all actions, see Common Parameters.

Enabled

Sets whether Amazon SES includes the original email headers in Amazon SNS notifications of
the specified notification type. A value of true specifies that Amazon SES includes headers
in notifications, and a value of false specifies that Amazon SES does not include headers in
notifications.

This value can only be set when NotificationType is already set to use a particular Amazon
SNS topic.

Type: Boolean

Required: Yes
Identity

The identity for which to enable or disable headers in notifications. Examples:

user@example.com, example.com.

Type: String

Required: Yes
NotificationType

The notification type for which to enable or disable headers in notifications.

Type: String

SetIdentityHeadersInNotificationsEnabled API Version 2010-12-01 135

Amazon Simple Email Service API Reference

Valid Values: Bounce | Complaint | Delivery

Required: Yes

Errors
For information about the errors that are common to all actions, see Common Errors.

See Also
For more information about using this API in one of the language-specific AWS SDKs, see the
following:

• AWS Command Line Interface

• AWS SDK for .NET
• AWS SDK for C++
• AWS SDK for Go v2
• AWS SDK for Java V2
• AWS SDK for JavaScript V3
• AWS SDK for PHP V3
• AWS SDK for Python
• AWS SDK for Ruby V3

Errors API Version 2010-12-01 136

Amazon Simple Email Service API Reference

SetIdentityMailFromDomain
Enables or disables the custom MAIL FROM domain setup for a verified identity (an email address
or a domain).

Important
To send emails using the specified MAIL FROM domain, you must add an MX record to
your MAIL FROM domain's DNS settings. To ensure that your emails pass Sender Policy
Framework (SPF) checks, you must also add or update an SPF record. For more information,
see the Amazon SES Developer Guide.

You can execute this operation no more than once per second.

Request Parameters
For information about the parameters that are common to all actions, see Common Parameters.

BehaviorOnMXFailure

The action for Amazon SES to take if it cannot successfully read the required MX record when
you send an email. If you choose UseDefaultValue, Amazon SES uses amazonses.com (or a
subdomain of that) as the MAIL FROM domain. If you choose RejectMessage, Amazon SES
returns a MailFromDomainNotVerified error and not send the email.

The action specified in BehaviorOnMXFailure is taken when the custom MAIL FROM domain
setup is in the Pending, Failed, and TemporaryFailure states.

Type: String

Valid Values: UseDefaultValue | RejectMessage

Required: No
Identity

The verified identity.

Type: String

Required: Yes

SetIdentityMailFromDomain API Version 2010-12-01 137

Amazon Simple Email Service API Reference

MailFromDomain

The custom MAIL FROM domain for the verified identity to use. The MAIL FROM domain must
1) be a subdomain of the verified identity, 2) not be used in a "From" address if the MAIL FROM
domain is the destination of email feedback forwarding (for more information, see the Amazon
SES Developer Guide), and 3) not be used to receive emails. A value of null disables the
custom MAIL FROM setting for the identity.

Type: String

Required: No

Errors
For information about the errors that are common to all actions, see Common Errors.

See Also
For more information about using this API in one of the language-specific AWS SDKs, see the
following:

• AWS Command Line Interface

• AWS SDK for .NET
• AWS SDK for C++
• AWS SDK for Go v2
• AWS SDK for Java V2
• AWS SDK for JavaScript V3
• AWS SDK for PHP V3
• AWS SDK for Python
• AWS SDK for Ruby V3

Errors API Version 2010-12-01 138

Amazon Simple Email Service API Reference

SetIdentityNotificationTopic
Sets an Amazon Simple Notification Service (Amazon SNS) topic to use when delivering
notifications. When you use this operation, you specify a verified identity, such as an email address
or domain. When you send an email that uses the chosen identity in the Source field, Amazon
SES sends notifications to the topic you specified. You can send bounce, complaint, or delivery
notifications (or any combination of the three) to the Amazon SNS topic that you specify.

You can execute this operation no more than once per second.

For more information about feedback notification, see the Amazon SES Developer Guide.

Request Parameters
For information about the parameters that are common to all actions, see Common Parameters.

Identity

The identity (email address or domain) for the Amazon SNS topic.

Important
You can only specify a verified identity for this parameter.

You can specify an identity by using its name or by using its Amazon Resource Name (ARN).
The following examples are all valid identities: sender@example.com, example.com,
arn:aws:ses:us-east-1:123456789012:identity/example.com.

Type: String

Required: Yes
NotificationType

The type of notifications that are published to the specified Amazon SNS topic.

Type: String

Valid Values: Bounce | Complaint | Delivery

Required: Yes

SetIdentityNotificationTopic API Version 2010-12-01 139

Amazon Simple Email Service API Reference

SnsTopic

The Amazon Resource Name (ARN) of the Amazon SNS topic. If the parameter is omitted from
the request or a null value is passed, SnsTopic is cleared and publishing is disabled.

Type: String

Required: No

Errors
For information about the errors that are common to all actions, see Common Errors.

See Also
For more information about using this API in one of the language-specific AWS SDKs, see the
following:

• AWS Command Line Interface

• AWS SDK for .NET
• AWS SDK for C++
• AWS SDK for Go v2
• AWS SDK for Java V2
• AWS SDK for JavaScript V3
• AWS SDK for PHP V3
• AWS SDK for Python
• AWS SDK for Ruby V3

Errors API Version 2010-12-01 140

Amazon Simple Email Service API Reference

SetReceiptRulePosition
Sets the position of the specified receipt rule in the receipt rule set.

For information about managing receipt rules, see the Amazon SES Developer Guide.

You can execute this operation no more than once per second.

Request Parameters

For information about the parameters that are common to all actions, see Common Parameters.

After

The name of the receipt rule after which to place the specified receipt rule.

Type: String

Required: No
RuleName

The name of the receipt rule to reposition.

Type: String

Required: Yes
RuleSetName

The name of the receipt rule set that contains the receipt rule to reposition.

Type: String

Required: Yes

Errors

For information about the errors that are common to all actions, see Common Errors.

RuleDoesNotExist

Indicates that the provided receipt rule does not exist.

SetReceiptRulePosition API Version 2010-12-01 141

Amazon Simple Email Service API Reference

HTTP Status Code: 400

RuleSetDoesNotExist

Indicates that the provided receipt rule set does not exist.

HTTP Status Code: 400

See Also
For more information about using this API in one of the language-specific AWS SDKs, see the
following:

• AWS Command Line Interface

• AWS SDK for .NET
• AWS SDK for C++
• AWS SDK for Go v2
• AWS SDK for Java V2
• AWS SDK for JavaScript V3
• AWS SDK for PHP V3
• AWS SDK for Python
• AWS SDK for Ruby V3

See Also API Version 2010-12-01 142

Amazon Simple Email Service API Reference

TestRenderTemplate
Creates a preview of the MIME content of an email when provided with a template and a set of
replacement data.

You can execute this operation no more than once per second.

Request Parameters

For information about the parameters that are common to all actions, see Common Parameters.

TemplateData

A list of replacement values to apply to the template. This parameter is a JSON object, typically
consisting of key-value pairs in which the keys correspond to replacement tags in the email
template.

Type: String

Length Constraints: Maximum length of 262144.

Required: Yes
TemplateName

The name of the template to render.

Type: String

Required: Yes

Response Elements

The following element is returned by the service.

RenderedTemplate

The complete MIME message rendered by applying the data in the TemplateData parameter to
the template specified in the TemplateName parameter.

Type: String

TestRenderTemplate API Version 2010-12-01 143

Amazon Simple Email Service API Reference

Errors

For information about the errors that are common to all actions, see Common Errors.

InvalidRenderingParameter

Indicates that one or more of the replacement values you provided is invalid. This error may
occur when the TemplateData object contains invalid JSON.

HTTP Status Code: 400

MissingRenderingAttribute

Indicates that one or more of the replacement values for the specified template was not
specified. Ensure that the TemplateData object contains references to all of the replacement
tags in the specified template.

HTTP Status Code: 400

TemplateDoesNotExist

Indicates that the Template object you specified does not exist in your Amazon SES account.

HTTP Status Code: 400

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the
following:

• AWS Command Line Interface

• AWS SDK for .NET
• AWS SDK for C++
• AWS SDK for Go v2
• AWS SDK for Java V2
• AWS SDK for JavaScript V3
• AWS SDK for PHP V3
• AWS SDK for Python
• AWS SDK for Ruby V3

Errors API Version 2010-12-01 144

Amazon Simple Email Service API Reference

See Also API Version 2010-12-01 145

Amazon Simple Email Service API Reference

UpdateAccountSendingEnabled
Enables or disables email sending across your entire Amazon SES account in the current AWS
Region. You can use this operation in conjunction with Amazon CloudWatch alarms to temporarily
pause email sending across your Amazon SES account in a given AWS Region when reputation
metrics (such as your bounce or complaint rates) reach certain thresholds.

You can execute this operation no more than once per second.

Request Parameters
For information about the parameters that are common to all actions, see Common Parameters.

Enabled

Describes whether email sending is enabled or disabled for your Amazon SES account in the
current AWS Region.

Type: Boolean

Required: No

Errors
For information about the errors that are common to all actions, see Common Errors.

See Also
For more information about using this API in one of the language-specific AWS SDKs, see the
following:

• AWS Command Line Interface

• AWS SDK for .NET
• AWS SDK for C++
• AWS SDK for Go v2
• AWS SDK for Java V2
• AWS SDK for JavaScript V3
• AWS SDK for PHP V3

UpdateAccountSendingEnabled API Version 2010-12-01 146

Amazon Simple Email Service API Reference

• AWS SDK for Python

• AWS SDK for Ruby V3

See Also API Version 2010-12-01 147

Amazon Simple Email Service API Reference

UpdateConfigurationSetEventDestination
Updates the event destination of a configuration set. Event destinations are associated with
configuration sets, which enable you to publish email sending events to Amazon CloudWatch,
Amazon Kinesis Firehose, or Amazon Simple Notification Service (Amazon SNS). For information
about using configuration sets, see Monitoring Your Amazon SES Sending Activity in the Amazon
SES Developer Guide.

Note
When you create or update an event destination, you must provide one, and only one,
destination. The destination can be Amazon CloudWatch, Amazon Kinesis Firehose, or
Amazon Simple Notification Service (Amazon SNS).

You can execute this operation no more than once per second.

Request Parameters

For information about the parameters that are common to all actions, see Common Parameters.

ConfigurationSetName

The name of the configuration set that contains the event destination.

Type: String

Required: Yes
EventDestination

The event destination object.

Type: EventDestination object

Required: Yes

Errors

For information about the errors that are common to all actions, see Common Errors.

UpdateConfigurationSetEventDestination API Version 2010-12-01 148

Amazon Simple Email Service API Reference

ConfigurationSetDoesNotExist

Indicates that the configuration set does not exist.

HTTP Status Code: 400

EventDestinationDoesNotExist

Indicates that the event destination does not exist.

HTTP Status Code: 400

InvalidCloudWatchDestination

Indicates that the Amazon CloudWatch destination is invalid. See the error message for details.

HTTP Status Code: 400

InvalidFirehoseDestination

Indicates that the Amazon Kinesis Firehose destination is invalid. See the error message for
details.

HTTP Status Code: 400

InvalidSNSDestination

Indicates that the Amazon Simple Notification Service (Amazon SNS) destination is invalid. See
the error message for details.

HTTP Status Code: 400

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the
following:

• AWS Command Line Interface

• AWS SDK for .NET
• AWS SDK for C++
• AWS SDK for Go v2
• AWS SDK for Java V2

See Also API Version 2010-12-01 149

Amazon Simple Email Service API Reference

• AWS SDK for JavaScript V3

• AWS SDK for PHP V3
• AWS SDK for Python
• AWS SDK for Ruby V3

See Also API Version 2010-12-01 150

Amazon Simple Email Service API Reference

UpdateConfigurationSetReputationMetricsEnabled
Enables or disables the publishing of reputation metrics for emails sent using a specific
configuration set in a given AWS Region. Reputation metrics include bounce and complaint rates.
These metrics are published to Amazon CloudWatch. By using CloudWatch, you can create alarms
when bounce or complaint rates exceed certain thresholds.

You can execute this operation no more than once per second.

Request Parameters

For information about the parameters that are common to all actions, see Common Parameters.

ConfigurationSetName

The name of the configuration set to update.

Type: String

Required: Yes

Enabled

Describes whether or not Amazon SES publishes reputation metrics for the configuration set,
such as bounce and complaint rates, to Amazon CloudWatch.

Type: Boolean

Required: Yes

Errors

For information about the errors that are common to all actions, see Common Errors.

ConfigurationSetDoesNotExist

Indicates that the configuration set does not exist.

HTTP Status Code: 400

UpdateConfigurationSetReputationMetricsEnabled API Version 2010-12-01 151

Amazon Simple Email Service API Reference

See Also
For more information about using this API in one of the language-specific AWS SDKs, see the
following:

• AWS Command Line Interface

• AWS SDK for .NET
• AWS SDK for C++
• AWS SDK for Go v2
• AWS SDK for Java V2
• AWS SDK for JavaScript V3
• AWS SDK for PHP V3
• AWS SDK for Python
• AWS SDK for Ruby V3

See Also API Version 2010-12-01 152

Amazon Simple Email Service API Reference

UpdateConfigurationSetSendingEnabled
Enables or disables email sending for messages sent using a specific configuration set in a given
AWS Region. You can use this operation in conjunction with Amazon CloudWatch alarms to
temporarily pause email sending for a configuration set when the reputation metrics for that
configuration set (such as your bounce on complaint rate) exceed certain thresholds.

You can execute this operation no more than once per second.

Request Parameters

For information about the parameters that are common to all actions, see Common Parameters.

ConfigurationSetName

The name of the configuration set to update.

Type: String

Required: Yes

Enabled

Describes whether email sending is enabled or disabled for the configuration set.

Type: Boolean

Required: Yes

Errors

For information about the errors that are common to all actions, see Common Errors.

ConfigurationSetDoesNotExist

Indicates that the configuration set does not exist.

HTTP Status Code: 400

UpdateConfigurationSetSendingEnabled API Version 2010-12-01 153

Amazon Simple Email Service API Reference

See Also
For more information about using this API in one of the language-specific AWS SDKs, see the
following:

• AWS Command Line Interface

• AWS SDK for .NET
• AWS SDK for C++
• AWS SDK for Go v2
• AWS SDK for Java V2
• AWS SDK for JavaScript V3
• AWS SDK for PHP V3
• AWS SDK for Python
• AWS SDK for Ruby V3

See Also API Version 2010-12-01 154

Amazon Simple Email Service API Reference

UpdateConfigurationSetTrackingOptions
Modifies an association between a configuration set and a custom domain for open and click event
tracking.

By default, images and links used for tracking open and click events are hosted on domains
operated by Amazon SES. You can configure a subdomain of your own to handle these events. For
information about using custom domains, see the Amazon SES Developer Guide.

Request Parameters
For information about the parameters that are common to all actions, see Common Parameters.

ConfigurationSetName

The name of the configuration set.

Type: String

Required: Yes
TrackingOptions

A domain that is used to redirect email recipients to an Amazon SES-operated domain. This
domain captures open and click events generated by Amazon SES emails.

For more information, see Configuring Custom Domains to Handle Open and Click Tracking in
the Amazon SES Developer Guide.

Type: TrackingOptions object

Required: Yes

Errors
For information about the errors that are common to all actions, see Common Errors.

ConfigurationSetDoesNotExist

Indicates that the configuration set does not exist.

HTTP Status Code: 400

UpdateConfigurationSetTrackingOptions API Version 2010-12-01 155

Amazon Simple Email Service API Reference

InvalidTrackingOptions

Indicates that the custom domain to be used for open and click tracking redirects is invalid. This
error appears most often in the following situations:
• When the tracking domain you specified is not verified in Amazon SES.
• When the tracking domain you specified is not a valid domain or subdomain.

HTTP Status Code: 400

TrackingOptionsDoesNotExist

Indicates that the TrackingOptions object you specified does not exist.

HTTP Status Code: 400

See Also
For more information about using this API in one of the language-specific AWS SDKs, see the
following:

• AWS Command Line Interface

• AWS SDK for .NET
• AWS SDK for C++
• AWS SDK for Go v2
• AWS SDK for Java V2
• AWS SDK for JavaScript V3
• AWS SDK for PHP V3
• AWS SDK for Python
• AWS SDK for Ruby V3

See Also API Version 2010-12-01 156

Amazon Simple Email Service API Reference

UpdateCustomVerificationEmailTemplate
Updates an existing custom verification email template.

For more information about custom verification email templates, see Using Custom Verification
Email Templates in the Amazon SES Developer Guide.

You can execute this operation no more than once per second.

Request Parameters
For information about the parameters that are common to all actions, see Common Parameters.

FailureRedirectionURL

The URL that the recipient of the verification email is sent to if his or her address is not
successfully verified.

Type: String

Required: No
FromEmailAddress

The email address that the custom verification email is sent from.

Type: String

Required: No
SuccessRedirectionURL

The URL that the recipient of the verification email is sent to if his or her address is successfully
verified.

Type: String

Required: No
TemplateContent

The content of the custom verification email. The total size of the email must be less than 10
MB. The message body may contain HTML, with some limitations. For more information, see
Custom Verification Email Frequently Asked Questions in the Amazon SES Developer Guide.

Type: String

UpdateCustomVerificationEmailTemplate API Version 2010-12-01 157

Amazon Simple Email Service API Reference

Required: No
TemplateName

The name of the custom verification email template to update.

Type: String

Required: Yes
TemplateSubject

The subject line of the custom verification email.

Type: String

Required: No

Errors
For information about the errors that are common to all actions, see Common Errors.

CustomVerificationEmailInvalidContent

Indicates that custom verification email template provided content is invalid.

HTTP Status Code: 400

CustomVerificationEmailTemplateDoesNotExist

Indicates that a custom verification email template with the name you specified does not exist.

HTTP Status Code: 400

FromEmailAddressNotVerified

Indicates that the sender address specified for a custom verification email is not verified, and is
therefore not eligible to send the custom verification email.

HTTP Status Code: 400

See Also
For more information about using this API in one of the language-specific AWS SDKs, see the
following:

Errors API Version 2010-12-01 158

Amazon Simple Email Service API Reference

• AWS Command Line Interface

• AWS SDK for .NET
• AWS SDK for C++
• AWS SDK for Go v2
• AWS SDK for Java V2
• AWS SDK for JavaScript V3
• AWS SDK for PHP V3
• AWS SDK for Python
• AWS SDK for Ruby V3

See Also API Version 2010-12-01 159

Amazon Simple Email Service API Reference

UpdateReceiptRule
Updates a receipt rule.

For information about managing receipt rules, see the Amazon SES Developer Guide.

You can execute this operation no more than once per second.

Request Parameters

For information about the parameters that are common to all actions, see Common Parameters.

Rule

A data structure that contains the updated receipt rule information.

Type: ReceiptRule object

Required: Yes

RuleSetName

The name of the receipt rule set that the receipt rule belongs to.

Type: String

Required: Yes

Errors

For information about the errors that are common to all actions, see Common Errors.

InvalidLambdaFunction

Indicates that the provided AWS Lambda function is invalid, or that Amazon SES could not
execute the provided function, possibly due to permissions issues. For information about giving
permissions, see the Amazon SES Developer Guide.

HTTP Status Code: 400

UpdateReceiptRule API Version 2010-12-01 160

Amazon Simple Email Service API Reference

InvalidS3Configuration

Indicates that the provided Amazon S3 bucket or AWS KMS encryption key is invalid, or
that Amazon SES could not publish to the bucket, possibly due to permissions issues. For
information about giving permissions, see the Amazon SES Developer Guide.

HTTP Status Code: 400

InvalidSnsTopic

Indicates that the provided Amazon SNS topic is invalid, or that Amazon SES could not publish
to the topic, possibly due to permissions issues. For information about giving permissions, see
the Amazon SES Developer Guide.

HTTP Status Code: 400

LimitExceeded

Indicates that a resource could not be created because of service limits. For a list of Amazon SES
limits, see the Amazon SES Developer Guide.

HTTP Status Code: 400

RuleDoesNotExist

Indicates that the provided receipt rule does not exist.

HTTP Status Code: 400

RuleSetDoesNotExist

Indicates that the provided receipt rule set does not exist.

HTTP Status Code: 400

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the
following:

• AWS Command Line Interface

• AWS SDK for .NET
• AWS SDK for C++

See Also API Version 2010-12-01 161

Amazon Simple Email Service API Reference

• AWS SDK for Go v2

• AWS SDK for Java V2
• AWS SDK for JavaScript V3
• AWS SDK for PHP V3
• AWS SDK for Python
• AWS SDK for Ruby V3

See Also API Version 2010-12-01 162

Amazon Simple Email Service API Reference

UpdateTemplate
Updates an email template. Email templates enable you to send personalized email to one or more
destinations in a single operation. For more information, see the Amazon SES Developer Guide.

You can execute this operation no more than once per second.

Request Parameters
For information about the parameters that are common to all actions, see Common Parameters.

Template

The content of the email, composed of a subject line and either an HTML part or a text-only
part.

Type: Template object

Required: Yes

Errors
For information about the errors that are common to all actions, see Common Errors.

InvalidTemplate

Indicates that the template that you specified could not be rendered. This issue may occur when
a template refers to a partial that does not exist.

HTTP Status Code: 400

TemplateDoesNotExist

Indicates that the Template object you specified does not exist in your Amazon SES account.

HTTP Status Code: 400

See Also
For more information about using this API in one of the language-specific AWS SDKs, see the
following:

UpdateTemplate API Version 2010-12-01 163

Amazon Simple Email Service API Reference

• AWS Command Line Interface

• AWS SDK for .NET
• AWS SDK for C++
• AWS SDK for Go v2
• AWS SDK for Java V2
• AWS SDK for JavaScript V3
• AWS SDK for PHP V3
• AWS SDK for Python
• AWS SDK for Ruby V3

See Also API Version 2010-12-01 164

Amazon Simple Email Service API Reference

VerifyDomainDkim
Returns a set of DKIM tokens for a domain identity.

Important
When you execute the VerifyDomainDkim operation, the domain that you specify
is added to the list of identities that are associated with your account. This is true
even if you haven't already associated the domain with your account by using the
VerifyDomainIdentity operation. However, you can't send email from the domain until
you either successfully verify it or you successfully set up DKIM for it.

You use the tokens that are generated by this operation to create CNAME records. When Amazon
SES detects that you've added these records to the DNS configuration for a domain, you can start
sending email from that domain. You can start sending email even if you haven't added the TXT
record provided by the VerifyDomainIdentity operation to the DNS configuration for your domain.
All email that you send from the domain is authenticated using DKIM.

To create the CNAME records for DKIM authentication, use the following values:

• Name: token._domainkey.example.com
• Type: CNAME
• Value: token.dkim.amazonses.com

In the preceding example, replace token with one of the tokens that are generated when you
execute this operation. Replace example.com with your domain. Repeat this process for each token
that's generated by this operation.

You can execute this operation no more than once per second.

Request Parameters

For information about the parameters that are common to all actions, see Common Parameters.

Domain

The name of the domain to be verified for Easy DKIM signing.

VerifyDomainDkim API Version 2010-12-01 165

Amazon Simple Email Service API Reference

Type: String

Required: Yes

Response Elements

The following element is returned by the service.

DkimTokens.member.N

A set of character strings that represent the domain's identity. If the identity is an email
address, the tokens represent the domain of that address.

Using these tokens, you need to create DNS CNAME records that point to DKIM public keys
that are hosted by Amazon SES. Amazon Web Services eventually detects that you've updated
your DNS records. This detection process might take up to 72 hours. After successful detection,
Amazon SES is able to DKIM-sign email originating from that domain. (This only applies to
domain identities, not email address identities.)

For more information about creating DNS records using DKIM tokens, see the Amazon SES
Developer Guide.

Type: Array of strings

Errors

For information about the errors that are common to all actions, see Common Errors.

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the
following:

• AWS Command Line Interface

• AWS SDK for .NET
• AWS SDK for C++
• AWS SDK for Go v2
• AWS SDK for Java V2

Response Elements API Version 2010-12-01 166

Amazon Simple Email Service API Reference

• AWS SDK for JavaScript V3

• AWS SDK for PHP V3
• AWS SDK for Python
• AWS SDK for Ruby V3

See Also API Version 2010-12-01 167

Amazon Simple Email Service API Reference

VerifyDomainIdentity
Adds a domain to the list of identities for your Amazon SES account in the current AWS Region and
attempts to verify it. For more information about verifying domains, see Verifying Email Addresses
and Domains in the Amazon SES Developer Guide.

You can execute this operation no more than once per second.

Request Parameters
For information about the parameters that are common to all actions, see Common Parameters.

Domain

The domain to be verified.

Type: String

Required: Yes

Response Elements
The following element is returned by the service.

VerificationToken

A TXT record that you must place in the DNS settings of the domain to complete domain
verification with Amazon SES.

As Amazon SES searches for the TXT record, the domain's verification status is "Pending". When
Amazon SES detects the record, the domain's verification status changes to "Success". If Amazon
SES is unable to detect the record within 72 hours, the domain's verification status changes to
"Failed." In that case, to verify the domain, you must restart the verification process from the
beginning. The domain's verification status also changes to "Success" when it is DKIM verified.

Type: String

Errors
For information about the errors that are common to all actions, see Common Errors.

VerifyDomainIdentity API Version 2010-12-01 168

Amazon Simple Email Service API Reference

See Also
For more information about using this API in one of the language-specific AWS SDKs, see the
following:

• AWS Command Line Interface

• AWS SDK for .NET
• AWS SDK for C++
• AWS SDK for Go v2
• AWS SDK for Java V2
• AWS SDK for JavaScript V3
• AWS SDK for PHP V3
• AWS SDK for Python
• AWS SDK for Ruby V3

See Also API Version 2010-12-01 169

Amazon Simple Email Service API Reference

VerifyEmailAddress
Deprecated. Use the VerifyEmailIdentity operation to verify a new email address.

Request Parameters
For information about the parameters that are common to all actions, see Common Parameters.

EmailAddress

The email address to be verified.

Type: String

Required: Yes

Errors
For information about the errors that are common to all actions, see Common Errors.

See Also
For more information about using this API in one of the language-specific AWS SDKs, see the
following:

• AWS Command Line Interface

• AWS SDK for .NET
• AWS SDK for C++
• AWS SDK for Go v2
• AWS SDK for Java V2
• AWS SDK for JavaScript V3
• AWS SDK for PHP V3
• AWS SDK for Python
• AWS SDK for Ruby V3

VerifyEmailAddress API Version 2010-12-01 170

Amazon Simple Email Service API Reference

VerifyEmailIdentity
Adds an email address to the list of identities for your Amazon SES account in the current AWS
Region and attempts to verify it. As a result of executing this operation, a verification email is sent
to the specified address.

You can execute this operation no more than once per second.

Request Parameters

For information about the parameters that are common to all actions, see Common Parameters.

EmailAddress

The email address to be verified.

Type: String

Required: Yes

Errors

For information about the errors that are common to all actions, see Common Errors.

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the
following:

• AWS Command Line Interface

• AWS SDK for .NET
• AWS SDK for C++
• AWS SDK for Go v2
• AWS SDK for Java V2
• AWS SDK for JavaScript V3
• AWS SDK for PHP V3
• AWS SDK for Python

VerifyEmailIdentity API Version 2010-12-01 171

Amazon Simple Email Service API Reference

• AWS SDK for Ruby V3

See Also API Version 2010-12-01 172

Amazon Simple Email Service API Reference

Data Types
The Amazon Simple Email Service API contains several data types that various actions use. This
section describes each data type in detail.

Note
The order of each element in a data type structure is not guaranteed. Applications should
not assume a particular order.

The following data types are supported:

• AddHeaderAction
• Body
• BounceAction
• BouncedRecipientInfo
• BulkEmailDestination
• BulkEmailDestinationStatus
• CloudWatchDestination
• CloudWatchDimensionConfiguration
• ConfigurationSet
• Content
• CustomVerificationEmailTemplate
• DeliveryOptions
• Destination
• EventDestination
• ExtensionField
• IdentityDkimAttributes
• IdentityMailFromDomainAttributes
• IdentityNotificationAttributes
• IdentityVerificationAttributes
• KinesisFirehoseDestination

API Version 2010-12-01 173

Amazon Simple Email Service API Reference

• LambdaAction
• Message
• MessageDsn
• MessageTag
• RawMessage
• ReceiptAction
• ReceiptFilter
• ReceiptIpFilter
• ReceiptRule
• ReceiptRuleSetMetadata
• RecipientDsnFields
• ReputationOptions
• S3Action
• SendDataPoint
• SNSAction
• SNSDestination
• StopAction
• Template
• TemplateMetadata
• TrackingOptions
• WorkmailAction

API Version 2010-12-01 174

Amazon Simple Email Service API Reference

AddHeaderAction
When included in a receipt rule, this action adds a header to the received email.

For information about adding a header using a receipt rule, see the Amazon SES Developer Guide.

Contents
HeaderName

The name of the header to add to the incoming message. The name must contain at least
one character, and can contain up to 50 characters. It consists of alphanumeric (a–z, A–Z, 0–9)
characters and dashes.

Type: String

Required: Yes
HeaderValue

The content to include in the header. This value can contain up to 2048 characters. It can't
contain newline (\n) or carriage return (\r) characters.

Type: String

Required: Yes

See Also
For more information about using this API in one of the language-specific AWS SDKs, see the
following:

• AWS SDK for C++

• AWS SDK for Java V2
• AWS SDK for Ruby V3

AddHeaderAction API Version 2010-12-01 175

Amazon Simple Email Service API Reference

Body
Represents the body of the message. You can specify text, HTML, or both. If you use both, then the
message should display correctly in the widest variety of email clients.

Contents
Html

The content of the message, in HTML format. Use this for email clients that can process HTML.
You can include clickable links, formatted text, and much more in an HTML message.

Type: Content object

Required: No
Text

The content of the message, in text format. Use this for text-based email clients, or clients on
high-latency networks (such as mobile devices).

Type: Content object

Required: No

See Also
For more information about using this API in one of the language-specific AWS SDKs, see the
following:

• AWS SDK for C++

• AWS SDK for Java V2
• AWS SDK for Ruby V3

Body API Version 2010-12-01 176

Amazon Simple Email Service API Reference

BounceAction
When included in a receipt rule, this action rejects the received email by returning a bounce
response to the sender and, optionally, publishes a notification to Amazon Simple Notification
Service (Amazon SNS).

For information about sending a bounce message in response to a received email, see the Amazon
SES Developer Guide.

Contents
Message

Human-readable text to include in the bounce message.

Type: String

Required: Yes
Sender

The email address of the sender of the bounced email. This is the address from which the
bounce message is sent.

Type: String

Required: Yes
SmtpReplyCode

The SMTP reply code, as defined by RFC 5321.

Type: String

Required: Yes
StatusCode

The SMTP enhanced status code, as defined by RFC 3463.

Type: String

Required: No

BounceAction API Version 2010-12-01 177

Amazon Simple Email Service API Reference

TopicArn

The Amazon Resource Name (ARN) of the Amazon SNS topic to notify when the bounce action
is taken. You can find the ARN of a topic by using the ListTopics operation in Amazon SNS.

For more information about Amazon SNS topics, see the Amazon SNS Developer Guide.

Type: String

Required: No

See Also
For more information about using this API in one of the language-specific AWS SDKs, see the
following:

• AWS SDK for C++

• AWS SDK for Java V2
• AWS SDK for Ruby V3

See Also API Version 2010-12-01 178

Amazon Simple Email Service API Reference

BouncedRecipientInfo
Recipient-related information to include in the Delivery Status Notification (DSN) when an email
that Amazon SES receives on your behalf bounces.

For information about receiving email through Amazon SES, see the Amazon SES Developer Guide.

Contents
Recipient

The email address of the recipient of the bounced email.

Type: String

Required: Yes
BounceType

The reason for the bounce. You must provide either this parameter or RecipientDsnFields.

Type: String

Valid Values: DoesNotExist | MessageTooLarge | ExceededQuota |

ContentRejected | Undefined | TemporaryFailure

Required: No
RecipientArn

This parameter is used only for sending authorization. It is the ARN of the identity that is
associated with the sending authorization policy that permits you to receive email for the
recipient of the bounced email. For more information about sending authorization, see the
Amazon SES Developer Guide.

Type: String

Required: No
RecipientDsnFields

Recipient-related DSN fields, most of which would normally be filled in automatically when
provided with a BounceType. You must provide either this parameter or BounceType.

BouncedRecipientInfo API Version 2010-12-01 179

Amazon Simple Email Service API Reference

Type: RecipientDsnFields object

Required: No

See Also
For more information about using this API in one of the language-specific AWS SDKs, see the
following:

• AWS SDK for C++

• AWS SDK for Java V2
• AWS SDK for Ruby V3

See Also API Version 2010-12-01 180

Amazon Simple Email Service API Reference

BulkEmailDestination
An array that contains one or more Destinations, as well as the tags and replacement data
associated with each of those Destinations.

Contents
Destination

Represents the destination of the message, consisting of To:, CC:, and BCC: fields.

Note
Amazon SES does not support the SMTPUTF8 extension, as described in RFC6531. For
this reason, the email address string must be 7-bit ASCII. If you want to send to or from
email addresses that contain Unicode characters in the domain part of an address, you
must encode the domain using Punycode. Punycode is not permitted in the local part
of the email address (the part before the @ sign) nor in the "friendly from" name. If
you want to use Unicode characters in the "friendly from" name, you must encode the
"friendly from" name using MIME encoded-word syntax, as described in Sending raw
email using the Amazon SES API. For more information about Punycode, see RFC 3492.

Type: Destination object

Required: Yes
ReplacementTags.member.N

A list of tags, in the form of name/value pairs, to apply to an email that you send using
SendBulkTemplatedEmail. Tags correspond to characteristics of the email that you define, so
that you can publish email sending events.

Type: Array of MessageTag objects

Required: No
ReplacementTemplateData

A list of replacement values to apply to the template. This parameter is a JSON object, typically
consisting of key-value pairs in which the keys correspond to replacement tags in the email
template.

BulkEmailDestination API Version 2010-12-01 181

Amazon Simple Email Service API Reference

Type: String

Length Constraints: Maximum length of 262144.

Required: No

See Also
For more information about using this API in one of the language-specific AWS SDKs, see the
following:

• AWS SDK for C++

• AWS SDK for Java V2
• AWS SDK for Ruby V3

See Also API Version 2010-12-01 182

Amazon Simple Email Service API Reference

BulkEmailDestinationStatus
An object that contains the response from the SendBulkTemplatedEmail operation.

Contents
Error

A description of an error that prevented a message being sent using the

SendBulkTemplatedEmail operation.

Type: String

Required: No
MessageId

The unique message identifier returned from the SendBulkTemplatedEmail operation.

Type: String

Required: No
Status

The status of a message sent using the SendBulkTemplatedEmail operation.

Possible values for this parameter include:

• Success: Amazon SES accepted the message, and attempts to deliver it to the recipients.
• MessageRejected: The message was rejected because it contained a virus.
• MailFromDomainNotVerified: The sender's email address or domain was not verified.
• ConfigurationSetDoesNotExist: The configuration set you specified does not exist.
• TemplateDoesNotExist: The template you specified does not exist.
• AccountSuspended: Your account has been shut down because of issues related to your
email sending practices.
• AccountThrottled: The number of emails you can send has been reduced because your
account has exceeded its allocated sending limit.
• AccountDailyQuotaExceeded: You have reached or exceeded the maximum number of
emails you can send from your account in a 24-hour period.

BulkEmailDestinationStatus API Version 2010-12-01 183

Amazon Simple Email Service API Reference

• InvalidSendingPoolName: The configuration set you specified refers to an IP pool that

does not exist.
• AccountSendingPaused: Email sending for the Amazon SES account was disabled using the
UpdateAccountSendingEnabled operation.
• ConfigurationSetSendingPaused: Email sending for this configuration set was disabled
using the UpdateConfigurationSetSendingEnabled operation.
• InvalidParameterValue: One or more of the parameters you specified when calling this
operation was invalid. See the error message for additional information.
• TransientFailure: Amazon SES was unable to process your request because of a
temporary issue.
• Failed: Amazon SES was unable to process your request. See the error message for
additional information.

Type: String

Valid Values: Success | MessageRejected | MailFromDomainNotVerified |

ConfigurationSetDoesNotExist | TemplateDoesNotExist | AccountSuspended
| AccountThrottled | AccountDailyQuotaExceeded | InvalidSendingPoolName
| AccountSendingPaused | ConfigurationSetSendingPaused |
InvalidParameterValue | TransientFailure | Failed

Required: No

See Also
For more information about using this API in one of the language-specific AWS SDKs, see the
following:

• AWS SDK for C++

• AWS SDK for Java V2
• AWS SDK for Ruby V3

See Also API Version 2010-12-01 184

Amazon Simple Email Service API Reference

CloudWatchDestination
Contains information associated with an Amazon CloudWatch event destination to which email
sending events are published.

Event destinations, such as Amazon CloudWatch, are associated with configuration sets, which
enable you to publish email sending events. For information about using configuration sets, see the
Amazon SES Developer Guide.

Contents
DimensionConfigurations.member.N

A list of dimensions upon which to categorize your emails when you publish email sending
events to Amazon CloudWatch.

Type: Array of CloudWatchDimensionConfiguration objects

Required: Yes

See Also
For more information about using this API in one of the language-specific AWS SDKs, see the
following:

• AWS SDK for C++

• AWS SDK for Java V2
• AWS SDK for Ruby V3

CloudWatchDestination API Version 2010-12-01 185

Amazon Simple Email Service API Reference

CloudWatchDimensionConfiguration
Contains the dimension configuration to use when you publish email sending events to Amazon
CloudWatch.

For information about publishing email sending events to Amazon CloudWatch, see the Amazon
SES Developer Guide.

Contents
DefaultDimensionValue

The default value of the dimension that is published to Amazon CloudWatch if you do not
provide the value of the dimension when you send an email. The default value must meet the
following requirements:
• Contain only ASCII letters (a-z, A-Z), numbers (0-9), underscores (_), dashes (-), at signs (@), or
periods (.).
• Contain 256 characters or fewer.

Type: String

Required: Yes
DimensionName

The name of an Amazon CloudWatch dimension associated with an email sending metric. The
name must meet the following requirements:
• Contain only ASCII letters (a-z, A-Z), numbers (0-9), underscores (_), dashes (-), or colons (:).
• Contain 256 characters or fewer.

Type: String

Required: Yes
DimensionValueSource

The place where Amazon SES finds the value of a dimension to publish to Amazon CloudWatch.
To use the message tags that you specify using an X-SES-MESSAGE-TAGS header or a
parameter to the SendEmail/SendRawEmail API, specify messageTag. To use your own email
headers, specify emailHeader. To put a custom tag on any link included in your email, specify
linkTag.

CloudWatchDimensionConfiguration API Version 2010-12-01 186

Amazon Simple Email Service API Reference

Type: String

Valid Values: messageTag | emailHeader | linkTag

Required: Yes

See Also
For more information about using this API in one of the language-specific AWS SDKs, see the
following:

• AWS SDK for C++

• AWS SDK for Java V2
• AWS SDK for Ruby V3

See Also API Version 2010-12-01 187

Amazon Simple Email Service API Reference

ConfigurationSet
The name of the configuration set.

Configuration sets let you create groups of rules that you can apply to the emails you send
using Amazon SES. For more information about using configuration sets, see Using Amazon SES
Configuration Sets in the Amazon SES Developer Guide.

Contents
Name

The name of the configuration set. The name must meet the following requirements:
• Contain only letters (a-z, A-Z), numbers (0-9), underscores (_), or dashes (-).
• Contain 64 characters or fewer.

Type: String

Required: Yes

See Also
For more information about using this API in one of the language-specific AWS SDKs, see the
following:

• AWS SDK for C++

• AWS SDK for Java V2
• AWS SDK for Ruby V3

ConfigurationSet API Version 2010-12-01 188

Amazon Simple Email Service API Reference

Content
Represents textual data, plus an optional character set specification.

By default, the text must be 7-bit ASCII, due to the constraints of the SMTP protocol. If the text
must contain any other characters, then you must also specify a character set. Examples include
UTF-8, ISO-8859-1, and Shift_JIS.

Contents
Data

The textual data of the content.

Type: String

Required: Yes
Charset

The character set of the content.

Type: String

Required: No

See Also
For more information about using this API in one of the language-specific AWS SDKs, see the
following:

• AWS SDK for C++

• AWS SDK for Java V2
• AWS SDK for Ruby V3

Content API Version 2010-12-01 189

Amazon Simple Email Service API Reference

CustomVerificationEmailTemplate
Contains information about a custom verification email template.

Contents
FailureRedirectionURL

The URL that the recipient of the verification email is sent to if his or her address is not
successfully verified.

Type: String

Required: No
FromEmailAddress

The email address that the custom verification email is sent from.

Type: String

Required: No
SuccessRedirectionURL

The URL that the recipient of the verification email is sent to if his or her address is successfully
verified.

Type: String

Required: No
TemplateName

The name of the custom verification email template.

Type: String

Required: No
TemplateSubject

The subject line of the custom verification email.

Type: String

CustomVerificationEmailTemplate API Version 2010-12-01 190

Amazon Simple Email Service API Reference

Required: No

See Also
For more information about using this API in one of the language-specific AWS SDKs, see the
following:

• AWS SDK for C++

• AWS SDK for Java V2
• AWS SDK for Ruby V3

See Also API Version 2010-12-01 191

Amazon Simple Email Service API Reference

DeliveryOptions
Specifies whether messages that use the configuration set are required to use Transport Layer
Security (TLS).

Contents
TlsPolicy

Specifies whether messages that use the configuration set are required to use Transport Layer
Security (TLS). If the value is Require, messages are only delivered if a TLS connection can
be established. If the value is Optional, messages can be delivered in plain text if a TLS
connection can't be established.

Type: String

Valid Values: Require | Optional

Required: No

See Also
For more information about using this API in one of the language-specific AWS SDKs, see the
following:

• AWS SDK for C++

• AWS SDK for Java V2
• AWS SDK for Ruby V3

DeliveryOptions API Version 2010-12-01 192

Amazon Simple Email Service API Reference

Destination
Represents the destination of the message, consisting of To:, CC:, and BCC: fields.

Note
Amazon SES does not support the SMTPUTF8 extension, as described in RFC6531. For
this reason, the email address string must be 7-bit ASCII. If you want to send to or from
email addresses that contain Unicode characters in the domain part of an address, you
must encode the domain using Punycode. Punycode is not permitted in the local part
of the email address (the part before the @ sign) nor in the "friendly from" name. If you
want to use Unicode characters in the "friendly from" name, you must encode the "friendly
from" name using MIME encoded-word syntax, as described in Sending raw email using the
Amazon SES API. For more information about Punycode, see RFC 3492.

Contents
BccAddresses.member.N

The recipients to place on the BCC: line of the message.

Type: Array of strings

Required: No
CcAddresses.member.N

The recipients to place on the CC: line of the message.

Type: Array of strings

Required: No
ToAddresses.member.N

The recipients to place on the To: line of the message.

Type: Array of strings

Required: No

Destination API Version 2010-12-01 193

Amazon Simple Email Service API Reference

See Also
For more information about using this API in one of the language-specific AWS SDKs, see the
following:

• AWS SDK for C++

• AWS SDK for Java V2
• AWS SDK for Ruby V3

See Also API Version 2010-12-01 194

Amazon Simple Email Service API Reference

EventDestination
Contains information about an event destination.

Note
When you create or update an event destination, you must provide one, and only one,
destination. The destination can be Amazon CloudWatch, Amazon Kinesis Firehose or
Amazon Simple Notification Service (Amazon SNS).

Event destinations are associated with configuration sets, which enable you to publish email
sending events to Amazon CloudWatch, Amazon Kinesis Firehose, or Amazon Simple Notification
Service (Amazon SNS). For information about using configuration sets, see the Amazon SES
Developer Guide.

Contents
MatchingEventTypes.member.N

The type of email sending events to publish to the event destination.

• send - The call was successful and Amazon SES is attempting to deliver the email.
• reject - Amazon SES determined that the email contained a virus and rejected it.
• bounce - The recipient's mail server permanently rejected the email. This corresponds to a
hard bounce.
• complaint - The recipient marked the email as spam.
• delivery - Amazon SES successfully delivered the email to the recipient's mail server.
• open - The recipient received the email and opened it in their email client.
• click - The recipient clicked one or more links in the email.
• renderingFailure - Amazon SES did not send the email because of a template rendering
issue.

Type: Array of strings

Valid Values: send | reject | bounce | complaint | delivery | open | click |

renderingFailure

EventDestination API Version 2010-12-01 195

Amazon Simple Email Service API Reference

Required: Yes
Name

The name of the event destination. The name must meet the following requirements:
• Contain only ASCII letters (a-z, A-Z), numbers (0-9), underscores (_), or dashes (-).
• Contain 64 characters or fewer.

Type: String

Required: Yes
CloudWatchDestination

An object that contains the names, default values, and sources of the dimensions associated
with an Amazon CloudWatch event destination.

Type: CloudWatchDestination object

Required: No
Enabled

Sets whether Amazon SES publishes events to this destination when you send an email with the
associated configuration set. Set to true to enable publishing to this destination; set to false
to prevent publishing to this destination. The default value is false.

Type: Boolean

Required: No
KinesisFirehoseDestination

An object that contains the delivery stream ARN and the IAM role ARN associated with an
Amazon Kinesis Firehose event destination.

Type: KinesisFirehoseDestination object

Required: No
SNSDestination

An object that contains the topic ARN associated with an Amazon Simple Notification Service
(Amazon SNS) event destination.

Contents API Version 2010-12-01 196

Amazon Simple Email Service API Reference

Type: SNSDestination object

Required: No

See Also
For more information about using this API in one of the language-specific AWS SDKs, see the
following:

• AWS SDK for C++

• AWS SDK for Java V2
• AWS SDK for Ruby V3

See Also API Version 2010-12-01 197

Amazon Simple Email Service API Reference

ExtensionField
Additional X-headers to include in the Delivery Status Notification (DSN) when an email that
Amazon SES receives on your behalf bounces.

For information about receiving email through Amazon SES, see the Amazon SES Developer Guide.

Contents
Name

The name of the header to add. Must be between 1 and 50 characters, inclusive, and consist of
alphanumeric (a-z, A-Z, 0-9) characters and dashes only.

Type: String

Required: Yes
Value

The value of the header to add. Must contain 2048 characters or fewer, and must not contain
newline characters ("\r" or "\n").

Type: String

Required: Yes

See Also
For more information about using this API in one of the language-specific AWS SDKs, see the
following:

• AWS SDK for C++

• AWS SDK for Java V2
• AWS SDK for Ruby V3

ExtensionField API Version 2010-12-01 198

Amazon Simple Email Service API Reference

IdentityDkimAttributes
Represents the DKIM attributes of a verified email address or a domain.

Contents
DkimEnabled

Is true if DKIM signing is enabled for email sent from the identity. It's false otherwise. The
default value is true.

Type: Boolean

Required: Yes
DkimVerificationStatus

Describes whether Amazon SES has successfully verified the DKIM DNS records (tokens)
published in the domain name's DNS. (This only applies to domain identities, not email address
identities.)

Type: String

Valid Values: Pending | Success | Failed | TemporaryFailure | NotStarted

Required: Yes
DkimTokens.member.N

A set of character strings that represent the domain's identity. Using these tokens, you need
to create DNS CNAME records that point to DKIM public keys that are hosted by Amazon SES.
Amazon Web Services eventually detects that you've updated your DNS records. This detection
process might take up to 72 hours. After successful detection, Amazon SES is able to DKIM-sign
email originating from that domain. (This only applies to domain identities, not email address
identities.)

For more information about creating DNS records using DKIM tokens, see the Amazon SES
Developer Guide.

Type: Array of strings

Required: No

IdentityDkimAttributes API Version 2010-12-01 199

Amazon Simple Email Service API Reference

See Also
For more information about using this API in one of the language-specific AWS SDKs, see the
following:

• AWS SDK for C++

• AWS SDK for Java V2
• AWS SDK for Ruby V3

See Also API Version 2010-12-01 200

Amazon Simple Email Service API Reference

IdentityMailFromDomainAttributes
Represents the custom MAIL FROM domain attributes of a verified identity (email address or
domain).

Contents
BehaviorOnMXFailure

The action that Amazon SES takes if it cannot successfully read the required MX record when
you send an email. A value of UseDefaultValue indicates that if Amazon SES cannot read the
required MX record, it uses amazonses.com (or a subdomain of that) as the MAIL FROM domain.
A value of RejectMessage indicates that if Amazon SES cannot read the required MX record,
Amazon SES returns a MailFromDomainNotVerified error and does not send the email.

The custom MAIL FROM setup states that result in this behavior are Pending, Failed, and
TemporaryFailure.

Type: String

Valid Values: UseDefaultValue | RejectMessage

Required: Yes
MailFromDomain

The custom MAIL FROM domain that the identity is configured to use.

Type: String

Required: Yes
MailFromDomainStatus

The state that indicates whether Amazon SES has successfully read the MX record required
for custom MAIL FROM domain setup. If the state is Success, Amazon SES uses the specified
custom MAIL FROM domain when the verified identity sends an email. All other states indicate
that Amazon SES takes the action described by BehaviorOnMXFailure.

Type: String

Valid Values: Pending | Success | Failed | TemporaryFailure

IdentityMailFromDomainAttributes API Version 2010-12-01 201

Amazon Simple Email Service API Reference

Required: Yes

See Also
For more information about using this API in one of the language-specific AWS SDKs, see the
following:

• AWS SDK for C++

• AWS SDK for Java V2
• AWS SDK for Ruby V3

See Also API Version 2010-12-01 202

Amazon Simple Email Service API Reference

IdentityNotificationAttributes
Represents the notification attributes of an identity, including whether an identity has Amazon
Simple Notification Service (Amazon SNS) topics set for bounce, complaint, and/or delivery
notifications, and whether feedback forwarding is enabled for bounce and complaint notifications.

Contents
BounceTopic

The Amazon Resource Name (ARN) of the Amazon SNS topic where Amazon SES publishes
bounce notifications.

Type: String

Required: Yes
ComplaintTopic

The Amazon Resource Name (ARN) of the Amazon SNS topic where Amazon SES publishes
complaint notifications.

Type: String

Required: Yes
DeliveryTopic

The Amazon Resource Name (ARN) of the Amazon SNS topic where Amazon SES publishes
delivery notifications.

Type: String

Required: Yes
ForwardingEnabled

Describes whether Amazon SES forwards bounce and complaint notifications as email. true
indicates that Amazon SES forwards bounce and complaint notifications as email, while false
indicates that bounce and complaint notifications are published only to the specified bounce
and complaint Amazon SNS topics.

Type: Boolean

IdentityNotificationAttributes API Version 2010-12-01 203

Amazon Simple Email Service API Reference

Required: Yes
HeadersInBounceNotificationsEnabled

Describes whether Amazon SES includes the original email headers in Amazon SNS notifications
of type Bounce. A value of true specifies that Amazon SES includes headers in bounce
notifications, and a value of false specifies that Amazon SES does not include headers in
bounce notifications.

Type: Boolean

Required: No
HeadersInComplaintNotificationsEnabled

Describes whether Amazon SES includes the original email headers in Amazon SNS notifications
of type Complaint. A value of true specifies that Amazon SES includes headers in complaint
notifications, and a value of false specifies that Amazon SES does not include headers in
complaint notifications.

Type: Boolean

Required: No
HeadersInDeliveryNotificationsEnabled

Describes whether Amazon SES includes the original email headers in Amazon SNS notifications
of type Delivery. A value of true specifies that Amazon SES includes headers in delivery
notifications, and a value of false specifies that Amazon SES does not include headers in
delivery notifications.

Type: Boolean

Required: No

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the
following:

• AWS SDK for C++

• AWS SDK for Java V2

See Also API Version 2010-12-01 204

Amazon Simple Email Service API Reference

• AWS SDK for Ruby V3

See Also API Version 2010-12-01 205

Amazon Simple Email Service API Reference

IdentityVerificationAttributes
Represents the verification attributes of a single identity.

Contents
VerificationStatus

The verification status of the identity: "Pending", "Success", "Failed", or "TemporaryFailure".

Type: String

Valid Values: Pending | Success | Failed | TemporaryFailure | NotStarted

Required: Yes
VerificationToken

The verification token for a domain identity. Null for email address identities.

Type: String

Required: No

See Also
For more information about using this API in one of the language-specific AWS SDKs, see the
following:

• AWS SDK for C++

• AWS SDK for Java V2
• AWS SDK for Ruby V3

IdentityVerificationAttributes API Version 2010-12-01 206

Amazon Simple Email Service API Reference

KinesisFirehoseDestination
Contains the delivery stream ARN and the IAM role ARN associated with an Amazon Kinesis
Firehose event destination.

Event destinations, such as Amazon Kinesis Firehose, are associated with configuration sets, which
enable you to publish email sending events. For information about using configuration sets, see the
Amazon SES Developer Guide.

Contents
DeliveryStreamARN

The ARN of the Amazon Kinesis Firehose stream that email sending events should be published
to.

Type: String

Required: Yes
IAMRoleARN

The ARN of the IAM role under which Amazon SES publishes email sending events to the
Amazon Kinesis Firehose stream.

Type: String

Required: Yes

See Also
For more information about using this API in one of the language-specific AWS SDKs, see the
following:

• AWS SDK for C++

• AWS SDK for Java V2
• AWS SDK for Ruby V3

KinesisFirehoseDestination API Version 2010-12-01 207

Amazon Simple Email Service API Reference

LambdaAction
When included in a receipt rule, this action calls an AWS Lambda function and, optionally,
publishes a notification to Amazon Simple Notification Service (Amazon SNS).

To enable Amazon SES to call your AWS Lambda function or to publish to an Amazon SNS topic
of another account, Amazon SES must have permission to access those resources. For information
about giving permissions, see the Amazon SES Developer Guide.

For information about using AWS Lambda actions in receipt rules, see the Amazon SES Developer
Guide.

Contents
FunctionArn

The Amazon Resource Name (ARN) of the AWS Lambda function. An example
of an AWS Lambda function ARN is arn:aws:lambda:us-west-2:account-
id:function:MyFunction. For more information about AWS Lambda, see the AWS Lambda
Developer Guide.

Type: String

Required: Yes
InvocationType

The invocation type of the AWS Lambda function. An invocation type of RequestResponse
means that the execution of the function immediately results in a response, and a value of
Event means that the function is invoked asynchronously. The default value is Event. For
information about AWS Lambda invocation types, see the AWS Lambda Developer Guide.

Important
There is a 30-second timeout on RequestResponse invocations. You should use Event
invocation in most cases. Use RequestResponse only to make a mail flow decision,
such as whether to stop the receipt rule or the receipt rule set.

Type: String

LambdaAction API Version 2010-12-01 208

Amazon Simple Email Service API Reference

Valid Values: Event | RequestResponse

Required: No
TopicArn

The Amazon Resource Name (ARN) of the Amazon SNS topic to notify when the Lambda action
is executed. You can find the ARN of a topic by using the ListTopics operation in Amazon SNS.

For more information about Amazon SNS topics, see the Amazon SNS Developer Guide.

Type: String

Required: No

See Also
For more information about using this API in one of the language-specific AWS SDKs, see the
following:

• AWS SDK for C++

• AWS SDK for Java V2
• AWS SDK for Ruby V3

See Also API Version 2010-12-01 209

Amazon Simple Email Service API Reference

Message
Represents the message to be sent, composed of a subject and a body.

Contents
Body

The message body.

Type: Body object

Required: Yes
Subject

The subject of the message: A short summary of the content, which appears in the recipient's
inbox.

Type: Content object

Required: Yes

See Also
For more information about using this API in one of the language-specific AWS SDKs, see the
following:

• AWS SDK for C++

• AWS SDK for Java V2
• AWS SDK for Ruby V3

Message API Version 2010-12-01 210

Amazon Simple Email Service API Reference

MessageDsn
Message-related information to include in the Delivery Status Notification (DSN) when an email
that Amazon SES receives on your behalf bounces.

For information about receiving email through Amazon SES, see the Amazon SES Developer Guide.

Contents
ReportingMta

The reporting MTA that attempted to deliver the message, formatted as specified in
RFC 3464 (mta-name-type; mta-name). The default value is dns; inbound-smtp.
[region].amazonaws.com.

Type: String

Required: Yes
ArrivalDate

When the message was received by the reporting mail transfer agent (MTA), in RFC 822 date-
time format.

Type: Timestamp

Required: No
ExtensionFields.member.N

Additional X-headers to include in the DSN.

Type: Array of ExtensionField objects

Required: No

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the
following:

• AWS SDK for C++

MessageDsn API Version 2010-12-01 211

Amazon Simple Email Service API Reference

• AWS SDK for Java V2

• AWS SDK for Ruby V3

See Also API Version 2010-12-01 212

Amazon Simple Email Service API Reference

MessageTag
Contains the name and value of a tag that you can provide to SendEmail or SendRawEmail to
apply to an email.

Message tags, which you use with configuration sets, enable you to publish email sending events.
For information about using configuration sets, see the Amazon SES Developer Guide.

Contents
Name

The name of the tag. The name must meet the following requirements:
• Contain only ASCII letters (a-z, A-Z), numbers (0-9), underscores (_), or dashes (-).
• Contain 256 characters or fewer.

Type: String

Required: Yes
Value

The value of the tag. The value must meet the following requirements:
• Contain only ASCII letters (a-z, A-Z), numbers (0-9), underscores (_), or dashes (-).
• Contain 256 characters or fewer.

Type: String

Required: Yes

See Also
For more information about using this API in one of the language-specific AWS SDKs, see the
following:

• AWS SDK for C++

• AWS SDK for Java V2
• AWS SDK for Ruby V3

MessageTag API Version 2010-12-01 213

Amazon Simple Email Service API Reference

RawMessage
Represents the raw data of the message.

Contents
Data

The raw data of the message. This data needs to base64-encoded if you are accessing Amazon
SES directly through the HTTPS interface. If you are accessing Amazon SES using an AWS SDK,
the SDK takes care of the base 64-encoding for you. In all cases, the client must ensure that the
message format complies with Internet email standards regarding email header fields, MIME
types, and MIME encoding.

The To:, CC:, and BCC: headers in the raw message can contain a group list.

If you are using SendRawEmail with sending authorization, you can include X-headers in
the raw message to specify the "Source," "From," and "Return-Path" addresses. For more
information, see the documentation for SendRawEmail.

Important
Do not include these X-headers in the DKIM signature, because they are removed by
Amazon SES before sending the email.

For more information, go to the Amazon SES Developer Guide.

Type: Base64-encoded binary data object

Required: Yes

See Also
For more information about using this API in one of the language-specific AWS SDKs, see the
following:

• AWS SDK for C++

• AWS SDK for Java V2

RawMessage API Version 2010-12-01 214

Amazon Simple Email Service API Reference

• AWS SDK for Ruby V3

See Also API Version 2010-12-01 215

Amazon Simple Email Service API Reference

ReceiptAction
An action that Amazon SES can take when it receives an email on behalf of one or more email
addresses or domains that you own. An instance of this data type can represent only one action.

For information about setting up receipt rules, see the Amazon SES Developer Guide.

Contents
AddHeaderAction

Adds a header to the received email.

Type: AddHeaderAction object

Required: No
BounceAction

Rejects the received email by returning a bounce response to the sender and, optionally,
publishes a notification to Amazon Simple Notification Service (Amazon SNS).

Type: BounceAction object

Required: No
LambdaAction

Calls an AWS Lambda function, and optionally, publishes a notification to Amazon SNS.

Type: LambdaAction object

Required: No
S3Action

Saves the received message to an Amazon Simple Storage Service (Amazon S3) bucket and,
optionally, publishes a notification to Amazon SNS.

Type: S3Action object

Required: No
SNSAction

Publishes the email content within a notification to Amazon SNS.

ReceiptAction API Version 2010-12-01 216

Amazon Simple Email Service API Reference

Type: SNSAction object

Required: No
StopAction

Terminates the evaluation of the receipt rule set and optionally publishes a notification to
Amazon SNS.

Type: StopAction object

Required: No
WorkmailAction

Calls Amazon WorkMail and, optionally, publishes a notification to Amazon Amazon SNS.

Type: WorkmailAction object

Required: No

See Also
For more information about using this API in one of the language-specific AWS SDKs, see the
following:

• AWS SDK for C++

• AWS SDK for Java V2
• AWS SDK for Ruby V3

See Also API Version 2010-12-01 217

Amazon Simple Email Service API Reference

ReceiptFilter
A receipt IP address filter enables you to specify whether to accept or reject mail originating from
an IP address or range of IP addresses.

For information about setting up IP address filters, see the Amazon SES Developer Guide.

Contents
IpFilter

A structure that provides the IP addresses to block or allow, and whether to block or allow
incoming mail from them.

Type: ReceiptIpFilter object

Required: Yes
Name

The name of the IP address filter. The name must meet the following requirements:
• Contain only ASCII letters (a-z, A-Z), numbers (0-9), underscores (_), or dashes (-).
• Start and end with a letter or number.
• Contain 64 characters or fewer.

Type: String

Required: Yes

See Also
For more information about using this API in one of the language-specific AWS SDKs, see the
following:

• AWS SDK for C++

• AWS SDK for Java V2
• AWS SDK for Ruby V3

ReceiptFilter API Version 2010-12-01 218

Amazon Simple Email Service API Reference

ReceiptIpFilter
A receipt IP address filter enables you to specify whether to accept or reject mail originating from
an IP address or range of IP addresses.

For information about setting up IP address filters, see the Amazon SES Developer Guide.

Contents
Cidr

A single IP address or a range of IP addresses to block or allow, specified in Classless Inter-

Domain Routing (CIDR) notation. An example of a single email address is 10.0.0.1. An example
of a range of IP addresses is 10.0.0.1/24. For more information about CIDR notation, see RFC
2317.

Type: String

Required: Yes
Policy

Indicates whether to block or allow incoming mail from the specified IP addresses.

Type: String

Valid Values: Block | Allow

Required: Yes

See Also
For more information about using this API in one of the language-specific AWS SDKs, see the
following:

• AWS SDK for C++

• AWS SDK for Java V2
• AWS SDK for Ruby V3

ReceiptIpFilter API Version 2010-12-01 219

Amazon Simple Email Service API Reference

ReceiptRule
Receipt rules enable you to specify which actions Amazon SES should take when it receives mail on
behalf of one or more email addresses or domains that you own.

Each receipt rule defines a set of email addresses or domains that it applies to. If the email
addresses or domains match at least one recipient address of the message, Amazon SES executes
all of the receipt rule's actions on the message.

For information about setting up receipt rules, see the Amazon SES Developer Guide.

Contents
Name

The name of the receipt rule. The name must meet the following requirements:
• Contain only ASCII letters (a-z, A-Z), numbers (0-9), underscores (_), dashes (-), or periods (.).
• Start and end with a letter or number.
• Contain 64 characters or fewer.

Type: String

Required: Yes
Actions.member.N

An ordered list of actions to perform on messages that match at least one of the recipient email
addresses or domains specified in the receipt rule.

Type: Array of ReceiptAction objects

Required: No
Enabled

If true, the receipt rule is active. The default value is false.

Type: Boolean

Required: No

ReceiptRule API Version 2010-12-01 220

Amazon Simple Email Service API Reference

Recipients.member.N

The recipient domains and email addresses that the receipt rule applies to. If this field is not
specified, this rule matches all recipients on all verified domains.

Type: Array of strings

Required: No
ScanEnabled

If true, then messages that this receipt rule applies to are scanned for spam and viruses. The
default value is false.

Type: Boolean

Required: No
TlsPolicy

Specifies whether Amazon SES should require that incoming email is delivered over a
connection encrypted with Transport Layer Security (TLS). If this parameter is set to Require,
Amazon SES bounces emails that are not received over TLS. The default is Optional.

Type: String

Valid Values: Require | Optional

Required: No

See Also
For more information about using this API in one of the language-specific AWS SDKs, see the
following:

• AWS SDK for C++

• AWS SDK for Java V2
• AWS SDK for Ruby V3

See Also API Version 2010-12-01 221

Amazon Simple Email Service API Reference

ReceiptRuleSetMetadata
Information about a receipt rule set.

A receipt rule set is a collection of rules that specify what Amazon SES should do with mail it
receives on behalf of your account's verified domains.

For information about setting up receipt rule sets, see the Amazon SES Developer Guide.

Contents
CreatedTimestamp

The date and time the receipt rule set was created.

Type: Timestamp

Required: No
Name

The name of the receipt rule set. The name must meet the following requirements:
• Contain only ASCII letters (a-z, A-Z), numbers (0-9), underscores (_), or dashes (-).
• Start and end with a letter or number.
• Contain 64 characters or fewer.

Type: String

Required: No

See Also
For more information about using this API in one of the language-specific AWS SDKs, see the
following:

• AWS SDK for C++

• AWS SDK for Java V2
• AWS SDK for Ruby V3

ReceiptRuleSetMetadata API Version 2010-12-01 222

Amazon Simple Email Service API Reference

RecipientDsnFields
Recipient-related information to include in the Delivery Status Notification (DSN) when an email
that Amazon SES receives on your behalf bounces.

For information about receiving email through Amazon SES, see the Amazon SES Developer Guide.

Contents
Action

The action performed by the reporting mail transfer agent (MTA) as a result of its attempt to
deliver the message to the recipient address. This is required by RFC 3464.

Type: String

Valid Values: failed | delayed | delivered | relayed | expanded

Required: Yes
Status

The status code that indicates what went wrong. This is required by RFC 3464.

Type: String

Required: Yes
DiagnosticCode

An extended explanation of what went wrong; this is usually an SMTP response. See RFC 3463
for the correct formatting of this parameter.

Type: String

Required: No
ExtensionFields.member.N

Additional X-headers to include in the DSN.

Type: Array of ExtensionField objects

Required: No

RecipientDsnFields API Version 2010-12-01 223

Amazon Simple Email Service API Reference

FinalRecipient

The email address that the message was ultimately delivered to. This corresponds to the
Final-Recipient in the DSN. If not specified, FinalRecipient is set to the Recipient
specified in the BouncedRecipientInfo structure. Either FinalRecipient or the recipient
in BouncedRecipientInfo must be a recipient of the original bounced message.

Note
Do not prepend the FinalRecipient email address with rfc 822;, as described in
RFC 3798.

Type: String

Required: No
LastAttemptDate

The time the final delivery attempt was made, in RFC 822 date-time format.

Type: Timestamp

Required: No
RemoteMta

The MTA to which the remote MTA attempted to deliver the message, formatted as specified in
RFC 3464 (mta-name-type; mta-name). This parameter typically applies only to propagating
synchronous bounces.

Type: String

Required: No

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the
following:

• AWS SDK for C++

See Also API Version 2010-12-01 224

Amazon Simple Email Service API Reference

• AWS SDK for Java V2

• AWS SDK for Ruby V3

See Also API Version 2010-12-01 225

Amazon Simple Email Service API Reference

ReputationOptions
Contains information about the reputation settings for a configuration set.

Contents
LastFreshStart

The date and time at which the reputation metrics for the configuration set were last reset.
Resetting these metrics is known as a fresh start.

When you disable email sending for a configuration set using

UpdateConfigurationSetSendingEnabled and later re-enable it, the reputation metrics for the
configuration set (but not for the entire Amazon SES account) are reset.

If email sending for the configuration set has never been disabled and later re-enabled, the
value of this attribute is null.

Type: Timestamp

Required: No
ReputationMetricsEnabled

Describes whether or not Amazon SES publishes reputation metrics for the configuration set,
such as bounce and complaint rates, to Amazon CloudWatch.

If the value is true, reputation metrics are published. If the value is false, reputation metrics
are not published. The default value is false.

Type: Boolean

Required: No
SendingEnabled

Describes whether email sending is enabled or disabled for the configuration set. If the value
is true, then Amazon SES sends emails that use the configuration set. If the value is false,
Amazon SES does not send emails that use the configuration set. The default value is true. You
can change this setting using UpdateConfigurationSetSendingEnabled.

Type: Boolean

ReputationOptions API Version 2010-12-01 226

Amazon Simple Email Service API Reference

Required: No

See Also
For more information about using this API in one of the language-specific AWS SDKs, see the
following:

• AWS SDK for C++

• AWS SDK for Java V2
• AWS SDK for Ruby V3

See Also API Version 2010-12-01 227

Amazon Simple Email Service API Reference

S3Action
When included in a receipt rule, this action saves the received message to an Amazon Simple
Storage Service (Amazon S3) bucket and, optionally, publishes a notification to Amazon Simple
Notification Service (Amazon SNS).

To enable Amazon SES to write emails to your Amazon S3 bucket, use an AWS KMS key to encrypt
your emails, or publish to an Amazon SNS topic of another account, Amazon SES must have
permission to access those resources. For information about granting permissions, see the Amazon
SES Developer Guide.

Note
When you save your emails to an Amazon S3 bucket, the maximum email size (including
headers) is 40 MB. Emails larger than that bounces.

For information about specifying Amazon S3 actions in receipt rules, see the Amazon SES
Developer Guide.

Contents
BucketName

The name of the Amazon S3 bucket for incoming email.

Type: String

Required: Yes
KmsKeyArn

The customer master key that Amazon SES should use to encrypt your emails before saving
them to the Amazon S3 bucket. You can use the default master key or a custom master key that
you created in AWS KMS as follows:
• To use the default master key, provide an ARN in the form of
arn:aws:kms:REGION:ACCOUNT-ID-WITHOUT-HYPHENS:alias/aws/ses. For example,
if your AWS account ID is 123456789012 and you want to use the default master key in the
US West (Oregon) Region, the ARN of the default master key would be arn:aws:kms:us-

S3Action API Version 2010-12-01 228

Amazon Simple Email Service API Reference

west-2:123456789012:alias/aws/ses. If you use the default master key, you don't need
to perform any extra steps to give Amazon SES permission to use the key.
• To use a custom master key that you created in AWS KMS, provide the ARN of the master key
and ensure that you add a statement to your key's policy to give Amazon SES permission to
use it. For more information about giving permissions, see the Amazon SES Developer Guide.

For more information about key policies, see the AWS KMS Developer Guide. If you do not
specify a master key, Amazon SES does not encrypt your emails.

Important
Your mail is encrypted by Amazon SES using the Amazon S3 encryption client before
the mail is submitted to Amazon S3 for storage. It is not encrypted using Amazon S3
server-side encryption. This means that you must use the Amazon S3 encryption client
to decrypt the email after retrieving it from Amazon S3, as the service has no access to
use your AWS KMS keys for decryption. This encryption client is currently available with
the AWS SDK for Java and AWS SDK for Ruby only. For more information about client-
side encryption using AWS KMS master keys, see the Amazon S3 Developer Guide.

Type: String

Required: No
ObjectKeyPrefix

The key prefix of the Amazon S3 bucket. The key prefix is similar to a directory name that
enables you to store similar data under the same directory in a bucket.

Type: String

Required: No
TopicArn

The ARN of the Amazon SNS topic to notify when the message is saved to the Amazon S3
bucket. You can find the ARN of a topic by using the ListTopics operation in Amazon SNS.

For more information about Amazon SNS topics, see the Amazon SNS Developer Guide.

Type: String

Contents API Version 2010-12-01 229

Amazon Simple Email Service API Reference

Required: No

See Also
For more information about using this API in one of the language-specific AWS SDKs, see the
following:

• AWS SDK for C++

• AWS SDK for Java V2
• AWS SDK for Ruby V3

See Also API Version 2010-12-01 230

Amazon Simple Email Service API Reference

SendDataPoint
Represents sending statistics data. Each SendDataPoint contains statistics for a 15-minute period
of sending activity.

Contents
Bounces

Number of emails that have bounced.

Type: Long

Required: No
Complaints

Number of unwanted emails that were rejected by recipients.

Type: Long

Required: No
DeliveryAttempts

Number of emails that have been sent.

Type: Long

Required: No
Rejects

Number of emails rejected by Amazon SES.

Type: Long

Required: No
Timestamp

Time of the data point.

Type: Timestamp

Required: No

SendDataPoint API Version 2010-12-01 231

Amazon Simple Email Service API Reference

See Also
For more information about using this API in one of the language-specific AWS SDKs, see the
following:

• AWS SDK for C++

• AWS SDK for Java V2
• AWS SDK for Ruby V3

See Also API Version 2010-12-01 232

Amazon Simple Email Service API Reference

SNSAction
When included in a receipt rule, this action publishes a notification to Amazon Simple Notification
Service (Amazon SNS). This action includes a complete copy of the email content in the Amazon
SNS notifications. Amazon SNS notifications for all other actions simply provide information about
the email. They do not include the email content itself.

If you own the Amazon SNS topic, you don't need to do anything to give Amazon SES permission
to publish emails to it. However, if you don't own the Amazon SNS topic, you need to attach a
policy to the topic to give Amazon SES permissions to access it. For information about giving
permissions, see the Amazon SES Developer Guide.

Important
You can only publish emails that are 150 KB or less (including the header) to Amazon
SNS. Larger emails bounce. If you anticipate emails larger than 150 KB, use the S3 action
instead.

For information about using a receipt rule to publish an Amazon SNS notification, see the Amazon
SES Developer Guide.

Contents
TopicArn

The Amazon Resource Name (ARN) of the Amazon SNS topic to notify. You can find the ARN of
a topic by using the ListTopics operation in Amazon SNS.

For more information about Amazon SNS topics, see the Amazon SNS Developer Guide.

Type: String

Required: Yes
Encoding

The encoding to use for the email within the Amazon SNS notification. UTF-8 is easier to use,
but may not preserve all special characters when a message was encoded with a different
encoding format. Base64 preserves all special characters. The default value is UTF-8.

SNSAction API Version 2010-12-01 233

Amazon Simple Email Service API Reference

Type: String

Valid Values: UTF-8 | Base64

Required: No

See Also
For more information about using this API in one of the language-specific AWS SDKs, see the
following:

• AWS SDK for C++

• AWS SDK for Java V2
• AWS SDK for Ruby V3

See Also API Version 2010-12-01 234

Amazon Simple Email Service API Reference

SNSDestination
Contains the topic ARN associated with an Amazon Simple Notification Service (Amazon SNS)
event destination.

Event destinations, such as Amazon SNS, are associated with configuration sets, which enable you
to publish email sending events. For information about using configuration sets, see the Amazon
SES Developer Guide.

Contents
TopicARN

The ARN of the Amazon SNS topic for email sending events. You can find the ARN of a topic by
using the ListTopics Amazon SNS operation.

For more information about Amazon SNS topics, see the Amazon SNS Developer Guide.

Type: String

Required: Yes

See Also
For more information about using this API in one of the language-specific AWS SDKs, see the
following:

• AWS SDK for C++

• AWS SDK for Java V2
• AWS SDK for Ruby V3

SNSDestination API Version 2010-12-01 235

Amazon Simple Email Service API Reference

StopAction
When included in a receipt rule, this action terminates the evaluation of the receipt rule set and,
optionally, publishes a notification to Amazon Simple Notification Service (Amazon SNS).

For information about setting a stop action in a receipt rule, see the Amazon SES Developer Guide.

Contents
Scope

The scope of the StopAction. The only acceptable value is RuleSet.

Type: String

Valid Values: RuleSet

Required: Yes
TopicArn

The Amazon Resource Name (ARN) of the Amazon SNS topic to notify when the stop action is
taken. You can find the ARN of a topic by using the ListTopics Amazon SNS operation.

For more information about Amazon SNS topics, see the Amazon SNS Developer Guide.

Type: String

Required: No

See Also
For more information about using this API in one of the language-specific AWS SDKs, see the
following:

• AWS SDK for C++

• AWS SDK for Java V2
• AWS SDK for Ruby V3

StopAction API Version 2010-12-01 236

Amazon Simple Email Service API Reference

Template
The content of the email, composed of a subject line and either an HTML part or a text-only part.

Contents
TemplateName

The name of the template. You use this name when you send email using the
SendTemplatedEmail or SendBulkTemplatedEmail operations.

Type: String

Required: Yes
HtmlPart

The HTML body of the email.

Type: String

Required: No
SubjectPart

The subject line of the email.

Type: String

Required: No
TextPart

The email body that is visible to recipients whose email clients do not display HTML content.

Type: String

Required: No

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the
following:

Template API Version 2010-12-01 237

Amazon Simple Email Service API Reference

• AWS SDK for C++

• AWS SDK for Java V2
• AWS SDK for Ruby V3

See Also API Version 2010-12-01 238

Amazon Simple Email Service API Reference

TemplateMetadata
Contains information about an email template.

Contents
CreatedTimestamp

The time and date the template was created.

Type: Timestamp

Required: No
Name

The name of the template.

Type: String

Required: No

See Also
For more information about using this API in one of the language-specific AWS SDKs, see the
following:

• AWS SDK for C++

• AWS SDK for Java V2
• AWS SDK for Ruby V3

TemplateMetadata API Version 2010-12-01 239

Amazon Simple Email Service API Reference

TrackingOptions
A domain that is used to redirect email recipients to an Amazon SES-operated domain. This domain
captures open and click events generated by Amazon SES emails.

For more information, see Configuring Custom Domains to Handle Open and Click Tracking in the
Amazon SES Developer Guide.

Contents
CustomRedirectDomain

The custom subdomain that is used to redirect email recipients to the Amazon SES event
tracking domain.

Type: String

Required: No

See Also
For more information about using this API in one of the language-specific AWS SDKs, see the
following:

• AWS SDK for C++

• AWS SDK for Java V2
• AWS SDK for Ruby V3

TrackingOptions API Version 2010-12-01 240

Amazon Simple Email Service API Reference

WorkmailAction
When included in a receipt rule, this action calls Amazon WorkMail and, optionally, publishes a
notification to Amazon Simple Notification Service (Amazon SNS). It usually isn't necessary to
set this up manually, because Amazon WorkMail adds the rule automatically during its setup
procedure.

For information using a receipt rule to call Amazon WorkMail, see the Amazon SES Developer
Guide.

Contents
OrganizationArn

The Amazon Resource Name (ARN) of the Amazon WorkMail organization. Amazon WorkMail
ARNs use the following format:

arn:aws:workmail:<region>:<awsAccountId>:organization/
<workmailOrganizationId>

You can find the ID of your organization by using the ListOrganizations operation in Amazon
WorkMail. Amazon WorkMail organization IDs begin with "m-", followed by a string of
alphanumeric characters.

For information about Amazon WorkMail organizations, see the Amazon WorkMail
Administrator Guide.

Type: String

Required: Yes
TopicArn

The Amazon Resource Name (ARN) of the Amazon SNS topic to notify when the WorkMail
action is called. You can find the ARN of a topic by using the ListTopics operation in Amazon
SNS.

For more information about Amazon SNS topics, see the Amazon SNS Developer Guide.

Type: String

Required: No

WorkmailAction API Version 2010-12-01 241

Amazon Simple Email Service API Reference

See Also
For more information about using this API in one of the language-specific AWS SDKs, see the
following:

• AWS SDK for C++

• AWS SDK for Java V2
• AWS SDK for Ruby V3

See Also API Version 2010-12-01 242

Amazon Simple Email Service API Reference

Common Parameters
The following list contains the parameters that all actions use for signing Signature Version 4
requests with a query string. Any action-specific parameters are listed in the topic for that action.
For more information about Signature Version 4, see Signing AWS API requests in the IAM User
Guide.

Action

The action to be performed.

Type: string

Required: Yes
Version

The API version that the request is written for, expressed in the format YYYY-MM-DD.

Type: string

Required: Yes
X-Amz-Algorithm

The hash algorithm that you used to create the request signature.

Condition: Specify this parameter when you include authentication information in a query
string instead of in the HTTP authorization header.

Type: string

Valid Values: AWS4-HMAC-SHA256

Required: Conditional
X-Amz-Credential

The credential scope value, which is a string that includes your access key, the date, the region
you are targeting, the service you are requesting, and a termination string ("aws4_request").
The value is expressed in the following format: access_key/YYYYMMDD/region/service/
aws4_request.

API Version 2010-12-01 243

Amazon Simple Email Service API Reference

For more information, see Create a signed AWS API request in the IAM User Guide.

Condition: Specify this parameter when you include authentication information in a query
string instead of in the HTTP authorization header.

Type: string

Required: Conditional
X-Amz-Date

The date that is used to create the signature. The format must be ISO 8601 basic format
(YYYYMMDD'T'HHMMSS'Z'). For example, the following date time is a valid X-Amz-Date value:
20120325T120000Z.

Condition: X-Amz-Date is optional for all requests; it can be used to override the date used for
signing requests. If the Date header is specified in the ISO 8601 basic format, X-Amz-Date is not
required. When X-Amz-Date is used, it always overrides the value of the Date header. For more
information, see Elements of an AWS API request signature in the IAM User Guide.

Type: string

Required: Conditional
X-Amz-Security-Token

The temporary security token that was obtained through a call to AWS Security Token Service
(AWS STS). For a list of services that support temporary security credentials from AWS STS, see
AWS services that work with IAM in the IAM User Guide.

Condition: If you're using temporary security credentials from AWS STS, you must include the
security token.

Type: string

Required: Conditional
X-Amz-Signature

Specifies the hex-encoded signature that was calculated from the string to sign and the derived
signing key.

Condition: Specify this parameter when you include authentication information in a query
string instead of in the HTTP authorization header.

API Version 2010-12-01 244

Amazon Simple Email Service API Reference

Type: string

Required: Conditional
X-Amz-SignedHeaders

Specifies all the HTTP headers that were included as part of the canonical request. For more
information about specifying signed headers, see Create a signed AWS API request in the IAM
User Guide.

Condition: Specify this parameter when you include authentication information in a query
string instead of in the HTTP authorization header.

Type: string

Required: Conditional

API Version 2010-12-01 245

Amazon Simple Email Service API Reference

Common Errors
This section lists the errors common to the API actions of all AWS services. For errors specific to an
API action for this service, see the topic for that API action.

AccessDeniedException

You do not have sufficient access to perform this action.

HTTP Status Code: 400

IncompleteSignature

The request signature does not conform to AWS standards.

HTTP Status Code: 400

InternalFailure

The request processing has failed because of an unknown error, exception or failure.

HTTP Status Code: 500

InvalidAction

The action or operation requested is invalid. Verify that the action is typed correctly.

HTTP Status Code: 400

InvalidClientTokenId

The X.509 certificate or AWS access key ID provided does not exist in our records.

HTTP Status Code: 403

InvalidParameterCombination

Parameters that must not be used together were used together.

HTTP Status Code: 400

InvalidParameterValue

An invalid or out-of-range value was supplied for the input parameter.

HTTP Status Code: 400

API Version 2010-12-01 246

Amazon Simple Email Service API Reference

InvalidQueryParameter

The AWS query string is malformed or does not adhere to AWS standards.

HTTP Status Code: 400

MalformedQueryString

The query string contains a syntax error.

HTTP Status Code: 404

MissingAction

The request is missing an action or a required parameter.

HTTP Status Code: 400

MissingAuthenticationToken

The request must contain either a valid (registered) AWS access key ID or X.509 certificate.

HTTP Status Code: 403

MissingParameter

A required parameter for the specified action is not supplied.

HTTP Status Code: 400

NotAuthorized

You do not have permission to perform this action.

HTTP Status Code: 400

OptInRequired

The AWS access key ID needs a subscription for the service.

HTTP Status Code: 403

RequestExpired

The request reached the service more than 15 minutes after the date stamp on the request or
more than 15 minutes after the request expiration date (such as for pre-signed URLs), or the
date stamp on the request is more than 15 minutes in the future.

API Version 2010-12-01 247

Amazon Simple Email Service API Reference

HTTP Status Code: 400

ServiceUnavailable

The request has failed due to a temporary failure of the server.

HTTP Status Code: 503

ThrottlingException

The request was denied due to request throttling.

HTTP Status Code: 400

ValidationError

The input fails to satisfy the constraints specified by an AWS service.

HTTP Status Code: 400

API Version 2010-12-01 248