• 沒有找到結果。

Amazon Simple Email Service

N/A
N/A
Protected

Academic year: 2022

Share "Amazon Simple Email Service"

Copied!
299
0
0

加載中.... (立即查看全文)

全文

(1)

Amazon Simple Email Service

API v2 Reference

API Version 2019-09-27

(2)

Amazon Simple Email Service: API v2 Reference

Copyright © 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.

(3)

Table of Contents

Welcome ... 1

Actions ... 2

CreateConfigurationSet ... 4

Request Syntax ... 4

URI Request Parameters ... 4

Request Body ... 4

Response Syntax ... 5

Response Elements ... 5

Errors ... 5

See Also ... 6

CreateConfigurationSetEventDestination ... 7

Request Syntax ... 7

URI Request Parameters ... 7

Request Body ... 7

Response Syntax ... 8

Response Elements ... 8

Errors ... 8

See Also ... 8

CreateContact ... 10

Request Syntax ... 10

URI Request Parameters ... 10

Request Body ... 10

Response Syntax ... 11

Response Elements ... 11

Errors ... 11

See Also ... 11

CreateContactList ... 13

Request Syntax ... 13

URI Request Parameters ... 13

Request Body ... 13

Response Syntax ... 14

Response Elements ... 14

Errors ... 14

See Also ... 14

CreateCustomVerificationEmailTemplate ... 16

Request Syntax ... 16

URI Request Parameters ... 16

Request Body ... 16

Response Syntax ... 17

Response Elements ... 17

Errors ... 17

See Also ... 18

CreateDedicatedIpPool ... 19

Request Syntax ... 19

URI Request Parameters ... 19

Request Body ... 19

Response Syntax ... 19

Response Elements ... 19

Errors ... 20

See Also ... 20

CreateDeliverabilityTestReport ... 21

Request Syntax ... 21

URI Request Parameters ... 21

Request Body ... 21

(4)

Response Syntax ... 22

Response Elements ... 22

Errors ... 23

See Also ... 24

CreateEmailIdentity ... 25

Request Syntax ... 25

URI Request Parameters ... 25

Request Body ... 25

Response Syntax ... 26

Response Elements ... 26

Errors ... 27

See Also ... 28

CreateEmailIdentityPolicy ... 29

Request Syntax ... 29

URI Request Parameters ... 29

Request Body ... 29

Response Syntax ... 30

Response Elements ... 30

Errors ... 30

See Also ... 30

CreateEmailTemplate ... 32

Request Syntax ... 32

URI Request Parameters ... 32

Request Body ... 32

Response Syntax ... 32

Response Elements ... 32

Errors ... 33

See Also ... 33

CreateImportJob ... 34

Request Syntax ... 34

URI Request Parameters ... 34

Request Body ... 34

Response Syntax ... 34

Response Elements ... 35

Errors ... 35

See Also ... 35

DeleteConfigurationSet ... 36

Request Syntax ... 36

URI Request Parameters ... 36

Request Body ... 36

Response Syntax ... 36

Response Elements ... 36

Errors ... 36

See Also ... 37

DeleteConfigurationSetEventDestination ... 38

Request Syntax ... 38

URI Request Parameters ... 38

Request Body ... 38

Response Syntax ... 38

Response Elements ... 38

Errors ... 38

See Also ... 39

DeleteContact ... 40

Request Syntax ... 40

(5)

Response Elements ... 40

Errors ... 40

See Also ... 41

DeleteContactList ... 42

Request Syntax ... 42

URI Request Parameters ... 42

Request Body ... 42

Response Syntax ... 42

Response Elements ... 42

Errors ... 42

See Also ... 43

DeleteCustomVerificationEmailTemplate ... 44

Request Syntax ... 44

URI Request Parameters ... 44

Request Body ... 44

Response Syntax ... 44

Response Elements ... 44

Errors ... 44

See Also ... 45

DeleteDedicatedIpPool ... 46

Request Syntax ... 46

URI Request Parameters ... 46

Request Body ... 46

Response Syntax ... 46

Response Elements ... 46

Errors ... 46

See Also ... 47

DeleteEmailIdentity ... 48

Request Syntax ... 48

URI Request Parameters ... 48

Request Body ... 48

Response Syntax ... 48

Response Elements ... 48

Errors ... 48

See Also ... 49

DeleteEmailIdentityPolicy ... 50

Request Syntax ... 50

URI Request Parameters ... 50

Request Body ... 50

Response Syntax ... 50

Response Elements ... 50

Errors ... 51

See Also ... 51

DeleteEmailTemplate ... 52

Request Syntax ... 52

URI Request Parameters ... 52

Request Body ... 52

Response Syntax ... 52

Response Elements ... 52

Errors ... 52

See Also ... 53

DeleteSuppressedDestination ... 54

Request Syntax ... 54

URI Request Parameters ... 54

Request Body ... 54

Response Syntax ... 54

Response Elements ... 54

(6)

Errors ... 54

See Also ... 55

GetAccount ... 56

Request Syntax ... 56

URI Request Parameters ... 56

Request Body ... 56

Response Syntax ... 56

Response Elements ... 56

Errors ... 57

See Also ... 58

GetBlacklistReports ... 59

Request Syntax ... 59

URI Request Parameters ... 59

Request Body ... 59

Response Syntax ... 59

Response Elements ... 59

Errors ... 60

See Also ... 60

GetConfigurationSet ... 61

Request Syntax ... 61

URI Request Parameters ... 61

Request Body ... 61

Response Syntax ... 61

Response Elements ... 62

Errors ... 62

See Also ... 63

GetConfigurationSetEventDestinations ... 64

Request Syntax ... 64

URI Request Parameters ... 64

Request Body ... 64

Response Syntax ... 64

Response Elements ... 65

Errors ... 65

See Also ... 65

GetContact ... 66

Request Syntax ... 66

URI Request Parameters ... 66

Request Body ... 66

Response Syntax ... 66

Response Elements ... 66

Errors ... 67

See Also ... 68

GetContactList ... 69

Request Syntax ... 69

URI Request Parameters ... 69

Request Body ... 69

Response Syntax ... 69

Response Elements ... 69

Errors ... 70

See Also ... 70

GetCustomVerificationEmailTemplate ... 72

Request Syntax ... 72

URI Request Parameters ... 72

Request Body ... 72

(7)

See Also ... 73

GetDedicatedIp ... 75

Request Syntax ... 75

URI Request Parameters ... 75

Request Body ... 75

Response Syntax ... 75

Response Elements ... 75

Errors ... 75

See Also ... 76

GetDedicatedIps ... 77

Request Syntax ... 77

URI Request Parameters ... 77

Request Body ... 77

Response Syntax ... 77

Response Elements ... 77

Errors ... 78

See Also ... 78

GetDeliverabilityDashboardOptions ... 79

Request Syntax ... 79

URI Request Parameters ... 79

Request Body ... 79

Response Syntax ... 79

Response Elements ... 80

Errors ... 80

See Also ... 81

GetDeliverabilityTestReport ... 82

Request Syntax ... 82

URI Request Parameters ... 82

Request Body ... 82

Response Syntax ... 82

Response Elements ... 83

Errors ... 83

See Also ... 84

GetDomainDeliverabilityCampaign ... 85

Request Syntax ... 85

URI Request Parameters ... 85

Request Body ... 85

Response Syntax ... 85

Response Elements ... 85

Errors ... 86

See Also ... 86

GetDomainStatisticsReport ... 87

Request Syntax ... 87

URI Request Parameters ... 87

Request Body ... 87

Response Syntax ... 87

Response Elements ... 88

Errors ... 88

See Also ... 89

GetEmailIdentity ... 90

Request Syntax ... 90

URI Request Parameters ... 90

Request Body ... 90

Response Syntax ... 90

Response Elements ... 91

Errors ... 92

See Also ... 92

(8)

GetEmailIdentityPolicies ... 93

Request Syntax ... 93

URI Request Parameters ... 93

Request Body ... 93

Response Syntax ... 93

Response Elements ... 93

Errors ... 94

See Also ... 94

GetEmailTemplate ... 95

Request Syntax ... 95

URI Request Parameters ... 95

Request Body ... 95

Response Syntax ... 95

Response Elements ... 95

Errors ... 96

See Also ... 96

GetImportJob ... 97

Request Syntax ... 97

URI Request Parameters ... 97

Request Body ... 97

Response Syntax ... 97

Response Elements ... 98

Errors ... 98

See Also ... 99

GetSuppressedDestination ... 100

Request Syntax ... 100

URI Request Parameters ... 100

Request Body ... 100

Response Syntax ... 100

Response Elements ... 100

Errors ... 100

See Also ... 101

ListConfigurationSets ... 102

Request Syntax ... 102

URI Request Parameters ... 102

Request Body ... 102

Response Syntax ... 102

Response Elements ... 102

Errors ... 103

See Also ... 103

ListContactLists ... 104

Request Syntax ... 104

URI Request Parameters ... 104

Request Body ... 104

Response Syntax ... 104

Response Elements ... 104

Errors ... 105

See Also ... 105

ListContacts ... 106

Request Syntax ... 106

URI Request Parameters ... 106

Request Body ... 106

Response Syntax ... 107

Response Elements ... 107

(9)

Request Syntax ... 109

URI Request Parameters ... 109

Request Body ... 109

Response Syntax ... 109

Response Elements ... 109

Errors ... 110

See Also ... 110

ListDedicatedIpPools ... 111

Request Syntax ... 111

URI Request Parameters ... 111

Request Body ... 111

Response Syntax ... 111

Response Elements ... 111

Errors ... 112

See Also ... 112

ListDeliverabilityTestReports ... 113

Request Syntax ... 113

URI Request Parameters ... 113

Request Body ... 113

Response Syntax ... 113

Response Elements ... 113

Errors ... 114

See Also ... 114

ListDomainDeliverabilityCampaigns ... 115

Request Syntax ... 115

URI Request Parameters ... 115

Request Body ... 115

Response Syntax ... 115

Response Elements ... 116

Errors ... 116

See Also ... 117

ListEmailIdentities ... 118

Request Syntax ... 118

URI Request Parameters ... 118

Request Body ... 118

Response Syntax ... 118

Response Elements ... 118

Errors ... 119

See Also ... 119

ListEmailTemplates ... 120

Request Syntax ... 120

URI Request Parameters ... 120

Request Body ... 120

Response Syntax ... 120

Response Elements ... 120

Errors ... 121

See Also ... 121

ListImportJobs ... 122

Request Syntax ... 122

URI Request Parameters ... 122

Request Body ... 122

Response Syntax ... 122

Response Elements ... 123

Errors ... 123

See Also ... 123

ListSuppressedDestinations ... 125

Request Syntax ... 125

(10)

URI Request Parameters ... 125

Request Body ... 125

Response Syntax ... 125

Response Elements ... 126

Errors ... 126

See Also ... 126

ListTagsForResource ... 128

Request Syntax ... 128

URI Request Parameters ... 128

Request Body ... 128

Response Syntax ... 128

Response Elements ... 128

Errors ... 129

See Also ... 129

PutAccountDedicatedIpWarmupAttributes ... 130

Request Syntax ... 130

URI Request Parameters ... 130

Request Body ... 130

Response Syntax ... 130

Response Elements ... 130

Errors ... 130

See Also ... 131

PutAccountDetails ... 132

Request Syntax ... 132

URI Request Parameters ... 132

Request Body ... 132

Response Syntax ... 133

Response Elements ... 133

Errors ... 133

See Also ... 134

PutAccountSendingAttributes ... 135

Request Syntax ... 135

URI Request Parameters ... 135

Request Body ... 135

Response Syntax ... 135

Response Elements ... 135

Errors ... 135

See Also ... 136

PutAccountSuppressionAttributes ... 137

Request Syntax ... 137

URI Request Parameters ... 137

Request Body ... 137

Response Syntax ... 137

Response Elements ... 137

Errors ... 137

See Also ... 138

PutConfigurationSetDeliveryOptions ... 139

Request Syntax ... 139

URI Request Parameters ... 139

Request Body ... 139

Response Syntax ... 139

Response Elements ... 140

Errors ... 140

See Also ... 140

(11)

Request Body ... 141

Response Syntax ... 141

Response Elements ... 141

Errors ... 141

See Also ... 142

PutConfigurationSetSendingOptions ... 143

Request Syntax ... 143

URI Request Parameters ... 143

Request Body ... 143

Response Syntax ... 143

Response Elements ... 143

Errors ... 143

See Also ... 144

PutConfigurationSetSuppressionOptions ... 145

Request Syntax ... 145

URI Request Parameters ... 145

Request Body ... 145

Response Syntax ... 145

Response Elements ... 145

Errors ... 146

See Also ... 146

PutConfigurationSetTrackingOptions ... 147

Request Syntax ... 147

URI Request Parameters ... 147

Request Body ... 147

Response Syntax ... 147

Response Elements ... 147

Errors ... 147

See Also ... 148

PutDedicatedIpInPool ... 149

Request Syntax ... 149

URI Request Parameters ... 149

Request Body ... 149

Response Syntax ... 149

Response Elements ... 149

Errors ... 150

See Also ... 150

PutDedicatedIpWarmupAttributes ... 151

Request Syntax ... 151

URI Request Parameters ... 151

Request Body ... 151

Response Syntax ... 151

Response Elements ... 151

Errors ... 151

See Also ... 152

PutDeliverabilityDashboardOption ... 153

Request Syntax ... 153

URI Request Parameters ... 153

Request Body ... 153

Response Syntax ... 154

Response Elements ... 154

Errors ... 154

See Also ... 154

PutEmailIdentityConfigurationSetAttributes ... 156

Request Syntax ... 156

URI Request Parameters ... 156

Request Body ... 156

(12)

Response Syntax ... 156

Response Elements ... 156

Errors ... 156

See Also ... 157

PutEmailIdentityDkimAttributes ... 158

Request Syntax ... 158

URI Request Parameters ... 158

Request Body ... 158

Response Syntax ... 158

Response Elements ... 158

Errors ... 158

See Also ... 159

PutEmailIdentityDkimSigningAttributes ... 160

Request Syntax ... 160

URI Request Parameters ... 160

Request Body ... 160

Response Syntax ... 161

Response Elements ... 161

Errors ... 162

See Also ... 162

PutEmailIdentityFeedbackAttributes ... 163

Request Syntax ... 163

URI Request Parameters ... 163

Request Body ... 163

Response Syntax ... 164

Response Elements ... 164

Errors ... 164

See Also ... 164

PutEmailIdentityMailFromAttributes ... 165

Request Syntax ... 165

URI Request Parameters ... 165

Request Body ... 165

Response Syntax ... 166

Response Elements ... 166

Errors ... 166

See Also ... 166

PutSuppressedDestination ... 167

Request Syntax ... 167

URI Request Parameters ... 167

Request Body ... 167

Response Syntax ... 167

Response Elements ... 167

Errors ... 167

See Also ... 168

SendBulkEmail ... 169

Request Syntax ... 169

URI Request Parameters ... 169

Request Body ... 169

Response Syntax ... 171

Response Elements ... 171

Errors ... 172

See Also ... 172

SendCustomVerificationEmail ... 174

Request Syntax ... 174

(13)

Response Elements ... 175

Errors ... 175

See Also ... 176

SendEmail ... 177

Request Syntax ... 177

URI Request Parameters ... 178

Request Body ... 178

Response Syntax ... 179

Response Elements ... 180

Errors ... 180

See Also ... 181

TagResource ... 182

Request Syntax ... 182

URI Request Parameters ... 182

Request Body ... 182

Response Syntax ... 182

Response Elements ... 183

Errors ... 183

See Also ... 183

TestRenderEmailTemplate ... 184

Request Syntax ... 184

URI Request Parameters ... 184

Request Body ... 184

Response Syntax ... 184

Response Elements ... 185

Errors ... 185

See Also ... 185

UntagResource ... 186

Request Syntax ... 186

URI Request Parameters ... 186

Request Body ... 186

Response Syntax ... 186

Response Elements ... 186

Errors ... 186

See Also ... 187

UpdateConfigurationSetEventDestination ... 188

Request Syntax ... 188

URI Request Parameters ... 188

Request Body ... 189

Response Syntax ... 189

Response Elements ... 189

Errors ... 189

See Also ... 189

UpdateContact ... 191

Request Syntax ... 191

URI Request Parameters ... 191

Request Body ... 191

Response Syntax ... 192

Response Elements ... 192

Errors ... 192

See Also ... 192

UpdateContactList ... 193

Request Syntax ... 193

URI Request Parameters ... 193

Request Body ... 193

Response Syntax ... 193

Response Elements ... 194

(14)

Errors ... 194

See Also ... 194

UpdateCustomVerificationEmailTemplate ... 195

Request Syntax ... 195

URI Request Parameters ... 195

Request Body ... 195

Response Syntax ... 196

Response Elements ... 196

Errors ... 196

See Also ... 196

UpdateEmailIdentityPolicy ... 198

Request Syntax ... 198

URI Request Parameters ... 198

Request Body ... 198

Response Syntax ... 199

Response Elements ... 199

Errors ... 199

See Also ... 199

UpdateEmailTemplate ... 200

Request Syntax ... 200

URI Request Parameters ... 200

Request Body ... 200

Response Syntax ... 200

Response Elements ... 200

Errors ... 201

See Also ... 201

Data Types ... 202

AccountDetails ... 204

Contents ... 204

See Also ... 205

BlacklistEntry ... 206

Contents ... 206

See Also ... 206

Body ... 207

Contents ... 207

See Also ... 207

BulkEmailContent ... 208

Contents ... 208

See Also ... 208

BulkEmailEntry ... 209

Contents ... 209

See Also ... 209

BulkEmailEntryResult ... 210

Contents ... 210

See Also ... 211

CloudWatchDestination ... 212

Contents ... 212

See Also ... 212

CloudWatchDimensionConfiguration ... 213

Contents ... 213

See Also ... 213

Contact ... 214

Contents ... 214

See Also ... 214

(15)

ContactListDestination ... 216

Contents ... 216

See Also ... 216

Content ... 217

Contents ... 217

See Also ... 217

CustomVerificationEmailTemplateMetadata ... 218

Contents ... 218

See Also ... 218

DailyVolume ... 219

Contents ... 219

See Also ... 219

DedicatedIp ... 220

Contents ... 220

See Also ... 220

DeliverabilityTestReport ... 221

Contents ... 221

See Also ... 221

DeliveryOptions ... 223

Contents ... 223

See Also ... 223

Destination ... 224

Contents ... 224

See Also ... 224

DkimAttributes ... 225

Contents ... 225

See Also ... 226

DkimSigningAttributes ... 227

Contents ... 227

See Also ... 227

DomainDeliverabilityCampaign ... 228

Contents ... 228

See Also ... 230

DomainDeliverabilityTrackingOption ... 231

Contents ... 231

See Also ... 231

DomainIspPlacement ... 232

Contents ... 232

See Also ... 232

EmailContent ... 234

Contents ... 234

See Also ... 234

EmailTemplateContent ... 235

Contents ... 235

See Also ... 235

EmailTemplateMetadata ... 236

Contents ... 236

See Also ... 236

EventDestination ... 237

Contents ... 237

See Also ... 238

EventDestinationDefinition ... 239

Contents ... 239

See Also ... 240

FailureInfo ... 241

Contents ... 241

See Also ... 241

(16)

IdentityInfo ... 242

Contents ... 242

See Also ... 242

ImportDataSource ... 243

Contents ... 243

See Also ... 243

ImportDestination ... 244

Contents ... 244

See Also ... 244

ImportJobSummary ... 245

Contents ... 245

See Also ... 245

InboxPlacementTrackingOption ... 246

Contents ... 246

See Also ... 246

IspPlacement ... 247

Contents ... 247

See Also ... 247

KinesisFirehoseDestination ... 248

Contents ... 248

See Also ... 248

ListContactsFilter ... 249

Contents ... 249

See Also ... 249

ListManagementOptions ... 250

Contents ... 250

See Also ... 250

MailFromAttributes ... 251

Contents ... 251

See Also ... 251

Message ... 252

Contents ... 252

See Also ... 252

MessageTag ... 253

Contents ... 253

See Also ... 253

OverallVolume ... 254

Contents ... 254

See Also ... 254

PinpointDestination ... 255

Contents ... 255

See Also ... 255

PlacementStatistics ... 256

Contents ... 256

See Also ... 256

RawMessage ... 258

Contents ... 258

See Also ... 258

ReplacementEmailContent ... 259

Contents ... 259

See Also ... 259

ReplacementTemplate ... 260

Contents ... 260

See Also ... 260

(17)

ReviewDetails ... 262

Contents ... 262

See Also ... 262

SendingOptions ... 263

Contents ... 263

See Also ... 263

SendQuota ... 264

Contents ... 264

See Also ... 264

SnsDestination ... 265

Contents ... 265

See Also ... 265

SuppressedDestination ... 266

Contents ... 266

See Also ... 266

SuppressedDestinationAttributes ... 267

Contents ... 267

See Also ... 267

SuppressedDestinationSummary ... 268

Contents ... 268

See Also ... 268

SuppressionAttributes ... 269

Contents ... 269

See Also ... 269

SuppressionListDestination ... 270

Contents ... 270

See Also ... 270

SuppressionOptions ... 271

Contents ... 271

See Also ... 271

Tag ... 272

Contents ... 272

See Also ... 272

Template ... 273

Contents ... 273

See Also ... 273

Topic ... 274

Contents ... 274

See Also ... 274

TopicFilter ... 275

Contents ... 275

See Also ... 275

TopicPreference ... 276

Contents ... 276

See Also ... 276

TrackingOptions ... 277

Contents ... 277

See Also ... 277

VolumeStatistics ... 278

Contents ... 278

See Also ... 278

Common Parameters ... 279

Common Errors ... 281

(18)

Welcome

Welcome to the Amazon SES API v2 Reference. This guide provides information about the Amazon SES API v2, including supported operations, data types, parameters, and schemas.

Amazon SES is an AWS service that you can use to send email messages to your customers.

If you're new to Amazon SES API v2, you might find it helpful to review the Amazon Simple Email Service Developer Guide. The Amazon SES Developer Guide provides information and code samples that demonstrate how to use Amazon SES API v2 features programmatically.

The Amazon SES API v2 is available in several AWS Regions and it provides an endpoint for each of these Regions. For more information, see Amazon SES endpoints and quotas in the Amazon Web Services General Reference. To learn more about AWS Regions, see Managing AWS Regions in the Amazon Web Services General Reference.

This document was last published on March 6, 2022.

(19)

Actions

The following actions are supported:

• CreateConfigurationSet (p. 4)

• CreateConfigurationSetEventDestination (p. 7)

• CreateContact (p. 10)

• CreateContactList (p. 13)

• CreateCustomVerificationEmailTemplate (p. 16)

• CreateDedicatedIpPool (p. 19)

• CreateDeliverabilityTestReport (p. 21)

• CreateEmailIdentity (p. 25)

• CreateEmailIdentityPolicy (p. 29)

• CreateEmailTemplate (p. 32)

• CreateImportJob (p. 34)

• DeleteConfigurationSet (p. 36)

• DeleteConfigurationSetEventDestination (p. 38)

• DeleteContact (p. 40)

• DeleteContactList (p. 42)

• DeleteCustomVerificationEmailTemplate (p. 44)

• DeleteDedicatedIpPool (p. 46)

• DeleteEmailIdentity (p. 48)

• DeleteEmailIdentityPolicy (p. 50)

• DeleteEmailTemplate (p. 52)

• DeleteSuppressedDestination (p. 54)

• GetAccount (p. 56)

• GetBlacklistReports (p. 59)

• GetConfigurationSet (p. 61)

• GetConfigurationSetEventDestinations (p. 64)

• GetContact (p. 66)

• GetContactList (p. 69)

• GetCustomVerificationEmailTemplate (p. 72)

• GetDedicatedIp (p. 75)

• GetDedicatedIps (p. 77)

• GetDeliverabilityDashboardOptions (p. 79)

• GetDeliverabilityTestReport (p. 82)

• GetDomainDeliverabilityCampaign (p. 85)

• GetDomainStatisticsReport (p. 87)

• GetEmailIdentity (p. 90)

• GetEmailIdentityPolicies (p. 93)

• GetEmailTemplate (p. 95)

• GetImportJob (p. 97)

• GetSuppressedDestination (p. 100)

• ListConfigurationSets (p. 102)

(20)

• ListContactLists (p. 104)

• ListContacts (p. 106)

• ListCustomVerificationEmailTemplates (p. 109)

• ListDedicatedIpPools (p. 111)

• ListDeliverabilityTestReports (p. 113)

• ListDomainDeliverabilityCampaigns (p. 115)

• ListEmailIdentities (p. 118)

• ListEmailTemplates (p. 120)

• ListImportJobs (p. 122)

• ListSuppressedDestinations (p. 125)

• ListTagsForResource (p. 128)

• PutAccountDedicatedIpWarmupAttributes (p. 130)

• PutAccountDetails (p. 132)

• PutAccountSendingAttributes (p. 135)

• PutAccountSuppressionAttributes (p. 137)

• PutConfigurationSetDeliveryOptions (p. 139)

• PutConfigurationSetReputationOptions (p. 141)

• PutConfigurationSetSendingOptions (p. 143)

• PutConfigurationSetSuppressionOptions (p. 145)

• PutConfigurationSetTrackingOptions (p. 147)

• PutDedicatedIpInPool (p. 149)

• PutDedicatedIpWarmupAttributes (p. 151)

• PutDeliverabilityDashboardOption (p. 153)

• PutEmailIdentityConfigurationSetAttributes (p. 156)

• PutEmailIdentityDkimAttributes (p. 158)

• PutEmailIdentityDkimSigningAttributes (p. 160)

• PutEmailIdentityFeedbackAttributes (p. 163)

• PutEmailIdentityMailFromAttributes (p. 165)

• PutSuppressedDestination (p. 167)

• SendBulkEmail (p. 169)

• SendCustomVerificationEmail (p. 174)

• SendEmail (p. 177)

• TagResource (p. 182)

• TestRenderEmailTemplate (p. 184)

• UntagResource (p. 186)

• UpdateConfigurationSetEventDestination (p. 188)

• UpdateContact (p. 191)

• UpdateContactList (p. 193)

• UpdateCustomVerificationEmailTemplate (p. 195)

• UpdateEmailIdentityPolicy (p. 198)

• UpdateEmailTemplate (p. 200)

(21)

CreateConfigurationSet

CreateConfigurationSet

Create a configuration set. Configuration sets are groups of rules that you can apply to the emails that you send. You apply a configuration set to an email by specifying the name of the configuration set when you call the Amazon SES API v2. When you apply a configuration set to an email, all of the rules in that configuration set are applied to the email.

Request Syntax

POST /v2/email/configuration-sets HTTP/1.1 Content-type: application/json

{

"ConfigurationSetName": "string", "DeliveryOptions": {

"SendingPoolName": "string", "TlsPolicy": "string"

},

"ReputationOptions": { "LastFreshStart": number,

"ReputationMetricsEnabled": boolean },

"SendingOptions": {

"SendingEnabled": boolean },

"SuppressionOptions": {

"SuppressedReasons": [ "string" ] },

"Tags": [ {

"Key": "string", "Value": "string"

} ],

"TrackingOptions": {

"CustomRedirectDomain": "string"

}}

URI Request Parameters

The request does not use any URI parameters.

Request Body

The request accepts the following data in JSON format.

ConfigurationSetName (p. 4)

The name of the configuration set. The name can contain up to 64 alphanumeric characters, including letters, numbers, hyphens (-) and underscores (_) only.

Type: String Required: Yes DeliveryOptions (p. 4)

An object that defines the dedicated IP pool that is used to send emails that you send using the configuration set.

(22)

Response Syntax

Type: DeliveryOptions (p. 223) object Required: No

ReputationOptions (p. 4)

An object that defines whether or not Amazon SES collects reputation metrics for the emails that you send that use the configuration set.

Type: ReputationOptions (p. 261) object Required: No

SendingOptions (p. 4)

An object that defines whether or not Amazon SES can send email that you send using the configuration set.

Type: SendingOptions (p. 263) object Required: No

SuppressionOptions (p. 4)

An object that contains information about the suppression list preferences for your account.

Type: SuppressionOptions (p. 271) object Required: No

Tags (p. 4)

An array of objects that define the tags (keys and values) to associate with the configuration set.

Type: Array of Tag (p. 272) objects Required: No

TrackingOptions (p. 4)

An object that defines the open and click tracking options for emails that you send using the configuration set.

Type: TrackingOptions (p. 277) object Required: No

Response Syntax

HTTP/1.1 200

Response Elements

If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body.

Errors

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

(23)

See Also

HTTP Status Code: 400 BadRequestException

The input you provided is invalid.

HTTP Status Code: 400 ConcurrentModificationException

The resource is being modified by another operation or thread.

HTTP Status Code: 500 LimitExceededException

There are too many instances of the specified resource type.

HTTP Status Code: 400 NotFoundException

The resource you attempted to access doesn't exist.

HTTP Status Code: 404 TooManyRequestsException

Too many requests have been made to the operation.

HTTP Status Code: 429

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

• AWS SDK for Java V2

• AWS SDK for JavaScript

• AWS SDK for PHP V3

• AWS SDK for Python

• AWS SDK for Ruby V3

(24)

CreateConfigurationSetEventDestination

CreateConfigurationSetEventDestination

Create an event destination. Events include message sends, deliveries, opens, clicks, bounces, and complaints. Event destinations are places that you can send information about these events to. For example, you can send event data to Amazon SNS to receive notifications when you receive bounces or complaints, or you can use Amazon Kinesis Data Firehose to stream data to Amazon S3 for long-term storage.

A single configuration set can include more than one event destination.

Request Syntax

POST /v2/email/configuration-sets/ConfigurationSetName/event-destinations HTTP/1.1 Content-type: application/json

{ "EventDestination": {

"CloudWatchDestination": { "DimensionConfigurations": [ {

"DefaultDimensionValue": "string", "DimensionName": "string",

"DimensionValueSource": "string"

} ] },

"Enabled": boolean,

"KinesisFirehoseDestination": { "DeliveryStreamArn": "string", "IamRoleArn": "string"

},

"MatchingEventTypes": [ "string" ], "PinpointDestination": {

"ApplicationArn": "string"

},

"SnsDestination": { "TopicArn": "string"

} },

"EventDestinationName": "string"

}

URI Request Parameters

The request uses the following URI parameters.

ConfigurationSetName (p. 7)

The name of the configuration set . Required: Yes

Request Body

(25)

Response Syntax

EventDestination (p. 7)

An object that defines the event destination.

Type: EventDestinationDefinition (p. 239) object Required: Yes

EventDestinationName (p. 7)

A name that identifies the event destination within the configuration set.

Type: String Required: Yes

Response Syntax

HTTP/1.1 200

Response Elements

If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body.

Errors

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

AlreadyExistsException

The resource specified in your request already exists.

HTTP Status Code: 400 BadRequestException

The input you provided is invalid.

HTTP Status Code: 400 LimitExceededException

There are too many instances of the specified resource type.

HTTP Status Code: 400 NotFoundException

The resource you attempted to access doesn't exist.

HTTP Status Code: 404 TooManyRequestsException

Too many requests have been made to the operation.

HTTP Status Code: 429

See Also

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

(26)

See Also

• AWS Command Line Interface

• AWS SDK for .NET

• AWS SDK for C++

• AWS SDK for Go

• AWS SDK for Java V2

• AWS SDK for JavaScript

• AWS SDK for PHP V3

• AWS SDK for Python

• AWS SDK for Ruby V3

(27)

CreateContact

CreateContact

Creates a contact, which is an end-user who is receiving the email, and adds them to a contact list.

Request Syntax

POST /v2/email/contact-lists/ContactListName/contacts HTTP/1.1 Content-type: application/json

{

"AttributesData": "string", "EmailAddress": "string", "TopicPreferences": [ {

"SubscriptionStatus": "string", "TopicName": "string"

} ],

"UnsubscribeAll": boolean }

URI Request Parameters

The request uses the following URI parameters.

ContactListName (p. 10)

The name of the contact list to which the contact should be added.

Required: Yes

Request Body

The request accepts the following data in JSON format.

AttributesData (p. 10)

The attribute data attached to a contact.

Type: String Required: No EmailAddress (p. 10)

The contact's email address.

Type: String Required: Yes TopicPreferences (p. 10)

The contact's preferences for being opted-in to or opted-out of topics.

Type: Array of TopicPreference (p. 276) objects Required: No

(28)

Response Syntax

UnsubscribeAll (p. 10)

A boolean value status noting if the contact is unsubscribed from all contact list topics.

Type: Boolean Required: No

Response Syntax

HTTP/1.1 200

Response Elements

If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body.

Errors

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

AlreadyExistsException

The resource specified in your request already exists.

HTTP Status Code: 400 BadRequestException

The input you provided is invalid.

HTTP Status Code: 400 NotFoundException

The resource you attempted to access doesn't exist.

HTTP Status Code: 404 TooManyRequestsException

Too many requests have been made to the operation.

HTTP Status Code: 429

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

(29)

See Also

• AWS SDK for Python

• AWS SDK for Ruby V3

(30)

CreateContactList

CreateContactList

Creates a contact list.

Request Syntax

POST /v2/email/contact-lists HTTP/1.1 Content-type: application/json {

"ContactListName": "string", "Description": "string", "Tags": [

{

"Key": "string", "Value": "string"

} ],

"Topics": [ {

"DefaultSubscriptionStatus": "string", "Description": "string",

"DisplayName": "string", "TopicName": "string"

} ]}

URI Request Parameters

The request does not use any URI parameters.

Request Body

The request accepts the following data in JSON format.

ContactListName (p. 13) The name of the contact list.

Type: String Required: Yes Description (p. 13)

A description of what the contact list is about.

Type: String Required: No Tags (p. 13)

The tags associated with a contact list.

(31)

Response Syntax

Topics (p. 13)

An interest group, theme, or label within a list. A contact list can have multiple topics.

Type: Array of Topic (p. 274) objects Required: No

Response Syntax

HTTP/1.1 200

Response Elements

If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body.

Errors

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

AlreadyExistsException

The resource specified in your request already exists.

HTTP Status Code: 400 BadRequestException

The input you provided is invalid.

HTTP Status Code: 400 LimitExceededException

There are too many instances of the specified resource type.

HTTP Status Code: 400 TooManyRequestsException

Too many requests have been made to the operation.

HTTP Status Code: 429

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

• AWS SDK for Java V2

• AWS SDK for JavaScript

• AWS SDK for PHP V3

(32)

See Also

• AWS SDK for Python

• AWS SDK for Ruby V3

(33)

CreateCustomVerificationEmailTemplate

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 Syntax

POST /v2/email/custom-verification-email-templates HTTP/1.1 Content-type: application/json

{ "FailureRedirectionURL": "string", "FromEmailAddress": "string", "SuccessRedirectionURL": "string", "TemplateContent": "string", "TemplateName": "string", "TemplateSubject": "string"

}

URI Request Parameters

The request does not use any URI parameters.

Request Body

The request accepts the following data in JSON format.

FailureRedirectionURL (p. 16)

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 (p. 16)

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

Type: String Required: Yes

SuccessRedirectionURL (p. 16)

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

Type: String Required: Yes

(34)

Response Syntax

TemplateContent (p. 16)

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 Required: Yes TemplateName (p. 16)

The name of the custom verification email template.

Type: String

Length Constraints: Minimum length of 1.

Required: Yes TemplateSubject (p. 16)

The subject line of the custom verification email.

Type: String Required: Yes

Response Syntax

HTTP/1.1 200

Response Elements

If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body.

Errors

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

AlreadyExistsException

The resource specified in your request already exists.

HTTP Status Code: 400 BadRequestException

The input you provided is invalid.

HTTP Status Code: 400 LimitExceededException

There are too many instances of the specified resource type.

HTTP Status Code: 400

(35)

See Also

HTTP Status Code: 404 TooManyRequestsException

Too many requests have been made to the operation.

HTTP Status Code: 429

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

• AWS SDK for Java V2

• AWS SDK for JavaScript

• AWS SDK for PHP V3

• AWS SDK for Python

• AWS SDK for Ruby V3

(36)

CreateDedicatedIpPool

CreateDedicatedIpPool

Create a new pool of dedicated IP addresses. A pool can include one or more dedicated IP addresses that are associated with your AWS account. You can associate a pool with a configuration set. When you send an email that uses that configuration set, the message is sent from one of the addresses in the associated pool.

Request Syntax

POST /v2/email/dedicated-ip-pools HTTP/1.1 Content-type: application/json

{

"PoolName": "string", "Tags": [

{

"Key": "string", "Value": "string"

} ] }

URI Request Parameters

The request does not use any URI parameters.

Request Body

The request accepts the following data in JSON format.

PoolName (p. 19)

The name of the dedicated IP pool.

Type: String Required: Yes Tags (p. 19)

An object that defines the tags (keys and values) that you want to associate with the pool.

Type: Array of Tag (p. 272) objects Required: No

Response Syntax

HTTP/1.1 200

Response Elements

(37)

Errors

Errors

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

AlreadyExistsException

The resource specified in your request already exists.

HTTP Status Code: 400 BadRequestException

The input you provided is invalid.

HTTP Status Code: 400 ConcurrentModificationException

The resource is being modified by another operation or thread.

HTTP Status Code: 500 LimitExceededException

There are too many instances of the specified resource type.

HTTP Status Code: 400 TooManyRequestsException

Too many requests have been made to the operation.

HTTP Status Code: 429

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

• AWS SDK for Java V2

• AWS SDK for JavaScript

• AWS SDK for PHP V3

• AWS SDK for Python

• AWS SDK for Ruby V3

(38)

CreateDeliverabilityTestReport

CreateDeliverabilityTestReport

Create a new predictive inbox placement test. Predictive inbox placement tests can help you predict how your messages will be handled by various email providers around the world. When you perform a predictive inbox placement test, you provide a sample message that contains the content that you plan to send to your customers. Amazon SES then sends that message to special email addresses spread across several major email providers. After about 24 hours, the test is complete, and you can use the GetDeliverabilityTestReport operation to view the results of the test.

Request Syntax

POST /v2/email/deliverability-dashboard/test HTTP/1.1 Content-type: application/json

{

"Content": { "Raw": { "Data": blob },

"Simple": { "Body": { "Html": {

"Charset": "string", "Data": "string"

},

"Text": {

"Charset": "string", "Data": "string"

} },

"Subject": {

"Charset": "string", "Data": "string"

} },

"Template": {

"TemplateArn": "string", "TemplateData": "string", "TemplateName": "string"

} },

"FromEmailAddress": "string", "ReportName": "string", "Tags": [

{

"Key": "string", "Value": "string"

} ]}

URI Request Parameters

The request does not use any URI parameters.

Request Body

(39)

Response Syntax

Content (p. 21)

The HTML body of the message that you sent when you performed the predictive inbox placement test.

Type: EmailContent (p. 234) object Required: Yes

FromEmailAddress (p. 21)

The email address that the predictive inbox placement test email was sent from.

Type: String Required: Yes ReportName (p. 21)

A unique name that helps you to identify the predictive inbox placement test when you retrieve the results.

Type: String Required: No Tags (p. 21)

An array of objects that define the tags (keys and values) that you want to associate with the predictive inbox placement test.

Type: Array of Tag (p. 272) objects Required: No

Response Syntax

HTTP/1.1 200

Content-type: application/json {

"DeliverabilityTestStatus": "string", "ReportId": "string"

}

Response Elements

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

DeliverabilityTestStatus (p. 22)

The status of the predictive inbox placement test. If the status is IN_PROGRESS, then the predictive inbox placement test is currently running. Predictive inbox placement tests are usually complete within 24 hours of creating the test. If the status is COMPLETE, then the test is finished, and you can use the GetDeliverabilityTestReport to view the results of the test.

Type: String

(40)

Errors

Valid Values: IN_PROGRESS | COMPLETED ReportId (p. 22)

A unique string that identifies the predictive inbox placement test.

Type: String

Errors

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

AccountSuspendedException

The message can't be sent because the account's ability to send email has been permanently restricted.

HTTP Status Code: 400 BadRequestException

The input you provided is invalid.

HTTP Status Code: 400 ConcurrentModificationException

The resource is being modified by another operation or thread.

HTTP Status Code: 500 LimitExceededException

There are too many instances of the specified resource type.

HTTP Status Code: 400

MailFromDomainNotVerifiedException

The message can't be sent because the sending domain isn't verified.

HTTP Status Code: 400 MessageRejected

The message can't be sent because it contains invalid content.

HTTP Status Code: 400 NotFoundException

The resource you attempted to access doesn't exist.

HTTP Status Code: 404 SendingPausedException

The message can't be sent because the account's ability to send email is currently paused.

HTTP Status Code: 400 TooManyRequestsException

(41)

See Also

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

• AWS SDK for Java V2

• AWS SDK for JavaScript

• AWS SDK for PHP V3

• AWS SDK for Python

• AWS SDK for Ruby V3

(42)

CreateEmailIdentity

CreateEmailIdentity

Starts the process of verifying an email identity. An identity is an email address or domain that you use when you send email. Before you can use an identity to send email, you first have to verify it. By verifying an identity, you demonstrate that you're the owner of the identity, and that you've given Amazon SES API v2 permission to send email from the identity.

When you verify an email address, Amazon SES sends an email to the address. Your email address is verified as soon as you follow the link in the verification email.

When you verify a domain without specifying the DkimSigningAttributes object, this operation provides a set of DKIM tokens. You can convert these tokens into CNAME records, which you then add to the DNS configuration for your domain. Your domain is verified when Amazon SES detects these records in the DNS configuration for your domain. This verification method is known as Easy DKIM.

Alternatively, you can perform the verification process by providing your own public-private key pair.

This verification method is known as Bring Your Own DKIM (BYODKIM). To use BYODKIM, your call to the CreateEmailIdentity operation has to include the DkimSigningAttributes object. When you specify this object, you provide a selector (a component of the DNS record name that identifies the public key to use for DKIM authentication) and a private key.

When you verify a domain, this operation provides a set of DKIM tokens, which you can convert into CNAME tokens. You add these CNAME tokens to the DNS configuration for your domain. Your domain is verified when Amazon SES detects these records in the DNS configuration for your domain. For some DNS providers, it can take 72 hours or more to complete the domain verification process.

Additionally, you can associate an existing configuration set with the email identity that you're verifying.

Request Syntax

POST /v2/email/identities HTTP/1.1 Content-type: application/json { "ConfigurationSetName": "string", "DkimSigningAttributes": {

"DomainSigningPrivateKey": "string", "DomainSigningSelector": "string", "NextSigningKeyLength": "string"

},

"EmailIdentity": "string", "Tags": [

{

"Key": "string", "Value": "string"

} ]}

URI Request Parameters

The request does not use any URI parameters.

(43)

Response Syntax

ConfigurationSetName (p. 25)

The configuration set to use by default when sending from this identity. Note that any configuration set defined in the email sending request takes precedence.

Type: String Required: No

DkimSigningAttributes (p. 25)

If your request includes this object, Amazon SES configures the identity to use Bring Your Own DKIM (BYODKIM) for DKIM authentication purposes, or, configures the key length to be used for Easy DKIM.

You can only specify this object if the email identity is a domain, as opposed to an address.

Type: DkimSigningAttributes (p. 227) object Required: No

EmailIdentity (p. 25)

The email address or domain to verify.

Type: String

Length Constraints: Minimum length of 1.

Required: Yes Tags (p. 25)

An array of objects that define the tags (keys and values) to associate with the email identity.

Type: Array of Tag (p. 272) objects Required: No

Response Syntax

HTTP/1.1 200

Content-type: application/json {

"DkimAttributes": {

"CurrentSigningKeyLength": "string", "LastKeyGenerationTimestamp": number, "NextSigningKeyLength": "string", "SigningAttributesOrigin": "string", "SigningEnabled": boolean,

"Status": "string", "Tokens": [ "string" ] },

"IdentityType": "string",

"VerifiedForSendingStatus": boolean }

Response Elements

If the action is successful, the service sends back an HTTP 200 response.

(44)

Errors

The following data is returned in JSON format by the service.

DkimAttributes (p. 26)

An object that contains information about the DKIM attributes for the identity.

Type: DkimAttributes (p. 225) object IdentityType (p. 26)

The email identity type. Note: the MANAGED_DOMAIN identity type is not supported.

Type: String

Valid Values: EMAIL_ADDRESS | DOMAIN | MANAGED_DOMAIN VerifiedForSendingStatus (p. 26)

Specifies whether or not the identity is verified. You can only send email from verified email addresses or domains. For more information about verifying identities, see the Amazon Pinpoint User Guide.

Type: Boolean

Errors

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

AlreadyExistsException

The resource specified in your request already exists.

HTTP Status Code: 400 BadRequestException

The input you provided is invalid.

HTTP Status Code: 400 ConcurrentModificationException

The resource is being modified by another operation or thread.

HTTP Status Code: 500 LimitExceededException

There are too many instances of the specified resource type.

HTTP Status Code: 400 NotFoundException

The resource you attempted to access doesn't exist.

HTTP Status Code: 404 TooManyRequestsException

(45)

See Also

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

• AWS SDK for Java V2

• AWS SDK for JavaScript

• AWS SDK for PHP V3

• AWS SDK for Python

• AWS SDK for Ruby V3

(46)

CreateEmailIdentityPolicy

CreateEmailIdentityPolicy

Creates the specified sending authorization policy for the given identity (an email address or a domain).

NoteThis API is for the identity owner only. If you have not verified the identity, this API will return 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 Syntax

POST /v2/email/identities/EmailIdentity/policies/PolicyName HTTP/1.1 Content-type: application/json

{ "Policy": "string"

}

URI Request Parameters

The request uses the following URI parameters.

EmailIdentity (p. 29) The email identity.

Length Constraints: Minimum length of 1.

Required: Yes PolicyName (p. 29)

The name of the policy.

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

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

Required: Yes

Request Body

The request accepts the following data in JSON format.

Policy (p. 29)

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

(47)

Response Syntax

Length Constraints: Minimum length of 1.

Required: Yes

Response Syntax

HTTP/1.1 200

Response Elements

If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body.

Errors

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

AlreadyExistsException

The resource specified in your request already exists.

HTTP Status Code: 400 BadRequestException

The input you provided is invalid.

HTTP Status Code: 400 LimitExceededException

There are too many instances of the specified resource type.

HTTP Status Code: 400 NotFoundException

The resource you attempted to access doesn't exist.

HTTP Status Code: 404 TooManyRequestsException

Too many requests have been made to the operation.

HTTP Status Code: 429

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

• AWS SDK for Java V2

• AWS SDK for JavaScript

(48)

See Also

• AWS SDK for PHP V3

• AWS SDK for Python

• AWS SDK for Ruby V3

(49)

CreateEmailTemplate

CreateEmailTemplate

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

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

Request Syntax

POST /v2/email/templates HTTP/1.1 Content-type: application/json {

"TemplateContent": { "Html": "string", "Subject": "string", "Text": "string"

},

"TemplateName": "string"

}

URI Request Parameters

The request does not use any URI parameters.

Request Body

The request accepts the following data in JSON format.

TemplateContent (p. 32)

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

Type: EmailTemplateContent (p. 235) object Required: Yes

TemplateName (p. 32) The name of the template.

Type: String

Length Constraints: Minimum length of 1.

Required: Yes

Response Syntax

HTTP/1.1 200

Response Elements

If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body.

(50)

Errors

Errors

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

AlreadyExistsException

The resource specified in your request already exists.

HTTP Status Code: 400 BadRequestException

The input you provided is invalid.

HTTP Status Code: 400 LimitExceededException

There are too many instances of the specified resource type.

HTTP Status Code: 400 TooManyRequestsException

Too many requests have been made to the operation.

HTTP Status Code: 429

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

• AWS SDK for Java V2

• AWS SDK for JavaScript

• AWS SDK for PHP V3

• AWS SDK for Python

• AWS SDK for Ruby V3

(51)

CreateImportJob

CreateImportJob

Creates an import job for a data destination.

Request Syntax

POST /v2/email/import-jobs HTTP/1.1 Content-type: application/json { "ImportDataSource": { "DataFormat": "string", "S3Url": "string"

},

"ImportDestination": {

"ContactListDestination": {

"ContactListImportAction": "string", "ContactListName": "string"

},

"SuppressionListDestination": {

"SuppressionListImportAction": "string"

} }}

URI Request Parameters

The request does not use any URI parameters.

Request Body

The request accepts the following data in JSON format.

ImportDataSource (p. 34)

The data source for the import job.

Type: ImportDataSource (p. 243) object Required: Yes

ImportDestination (p. 34)

The destination for the import job.

Type: ImportDestination (p. 244) object Required: Yes

Response Syntax

HTTP/1.1 200

Content-type: application/json { "JobId": "string"

(52)

Response Elements

}

Response Elements

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

JobId (p. 34)

A string that represents the import job ID.

Type: String

Length Constraints: Minimum length of 1.

Errors

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

BadRequestException

The input you provided is invalid.

HTTP Status Code: 400 LimitExceededException

There are too many instances of the specified resource type.

HTTP Status Code: 400 TooManyRequestsException

Too many requests have been made to the operation.

HTTP Status Code: 429

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

• AWS SDK for Java V2

• AWS SDK for JavaScript

• AWS SDK for PHP V3

• AWS SDK for Python

• AWS SDK for Ruby V3

(53)

DeleteConfigurationSet

DeleteConfigurationSet

Delete an existing configuration set.

Configuration sets are groups of rules that you can apply to the emails you send. You apply a configuration set to an email by including a reference to the configuration set in the headers of the email. When you apply a configuration set to an email, all of the rules in that configuration set are applied to the email.

Request Syntax

DELETE /v2/email/configuration-sets/ConfigurationSetName HTTP/1.1

URI Request Parameters

The request uses the following URI parameters.

ConfigurationSetName (p. 36) The name of the configuration set.

Required: Yes

Request Body

The request does not have a request body.

Response Syntax

HTTP/1.1 200

Response Elements

If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body.

Errors

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

BadRequestException

The input you provided is invalid.

HTTP Status Code: 400 ConcurrentModificationException

The resource is being modified by another operation or thread.

HTTP Status Code: 500 NotFoundException

The resource you attempted to access doesn't exist.

(54)

See Also

HTTP Status Code: 404 TooManyRequestsException

Too many requests have been made to the operation.

HTTP Status Code: 429

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

• AWS SDK for Java V2

• AWS SDK for JavaScript

• AWS SDK for PHP V3

• AWS SDK for Python

• AWS SDK for Ruby V3

(55)

DeleteConfigurationSetEventDestination

DeleteConfigurationSetEventDestination

Delete an event destination.

Events include message sends, deliveries, opens, clicks, bounces, and complaints. Event destinations are places that you can send information about these events to. For example, you can send event data to Amazon SNS to receive notifications when you receive bounces or complaints, or you can use Amazon Kinesis Data Firehose to stream data to Amazon S3 for long-term storage.

Request Syntax

DELETE /v2/email/configuration-sets/ConfigurationSetName/event- destinations/EventDestinationName HTTP/1.1

URI Request Parameters

The request uses the following URI parameters.

ConfigurationSetName (p. 38)

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

Required: Yes

EventDestinationName (p. 38)

The name of the event destination to delete.

Required: Yes

Request Body

The request does not have a request body.

Response Syntax

HTTP/1.1 200

Response Elements

If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body.

Errors

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

BadRequestException

The input you provided is invalid.

HTTP Status Code: 400

參考文獻

相關文件

The hashCode method for a given class can be used to test for object equality and object inequality for that class. The hashCode method is used by the java.util.SortedSet

object of supreme nonconceptual gnosis = true suchness,’ ‘that which conforms to the ultimate truth = prajñā,’ and ‘the supreme object = true suchness,’ and we can see

„ An adaptation layer is used to support specific primitives as required by a particular signaling application. „ The standard SS7 applications (e.g., ISUP) do not realize that

¾ Relocation, which modifies the object program so that it can be loaded at an address different from the location originally specified.. ¾ Linking, which combines two or

this: a Sub-type reference variable pointing to the object itself super: a Base-type reference variable pointing to the object itself. same reference value, different type

* All rights reserved, Tei-Wei Kuo, National Taiwan University, 2005..

Note that this method uses two separate object variables: the local variable message and the instance field name.. A local variable belongs to an individual method, and you can use

n Receiver Report: used to send reception statistics from those participants that receive but do not send them... The RTP Control