| 1 | {
|
| 2 | "version": "1.0",
|
| 3 | "examples": {
|
| 4 | "CloneReceiptRuleSet": [
|
| 5 | {
|
| 6 | "input": {
|
| 7 | "OriginalRuleSetName": "RuleSetToClone",
|
| 8 | "RuleSetName": "RuleSetToCreate"
|
| 9 | },
|
| 10 | "comments": {
|
| 11 | "input": {
|
| 12 | },
|
| 13 | "output": {
|
| 14 | }
|
| 15 | },
|
| 16 | "description": "The following example creates a receipt rule set by cloning an existing one:",
|
| 17 | "id": "clonereceiptruleset-1469055039770",
|
| 18 | "title": "CloneReceiptRuleSet"
|
| 19 | }
|
| 20 | ],
|
| 21 | "CreateReceiptFilter": [
|
| 22 | {
|
| 23 | "input": {
|
| 24 | "Filter": {
|
| 25 | "IpFilter": {
|
| 26 | "Cidr": "1.2.3.4/24",
|
| 27 | "Policy": "Allow"
|
| 28 | },
|
| 29 | "Name": "MyFilter"
|
| 30 | }
|
| 31 | },
|
| 32 | "comments": {
|
| 33 | "input": {
|
| 34 | },
|
| 35 | "output": {
|
| 36 | }
|
| 37 | },
|
| 38 | "description": "The following example creates a new IP address filter:",
|
| 39 | "id": "createreceiptfilter-1469122681253",
|
| 40 | "title": "CreateReceiptFilter"
|
| 41 | }
|
| 42 | ],
|
| 43 | "CreateReceiptRule": [
|
| 44 | {
|
| 45 | "input": {
|
| 46 | "After": "",
|
| 47 | "Rule": {
|
| 48 | "Actions": [
|
| 49 | {
|
| 50 | "S3Action": {
|
| 51 | "BucketName": "MyBucket",
|
| 52 | "ObjectKeyPrefix": "email"
|
| 53 | }
|
| 54 | }
|
| 55 | ],
|
| 56 | "Enabled": true,
|
| 57 | "Name": "MyRule",
|
| 58 | "ScanEnabled": true,
|
| 59 | "TlsPolicy": "Optional"
|
| 60 | },
|
| 61 | "RuleSetName": "MyRuleSet"
|
| 62 | },
|
| 63 | "comments": {
|
| 64 | "input": {
|
| 65 | },
|
| 66 | "output": {
|
| 67 | }
|
| 68 | },
|
| 69 | "description": "The following example creates a new receipt rule:",
|
| 70 | "id": "createreceiptrule-1469122946515",
|
| 71 | "title": "CreateReceiptRule"
|
| 72 | }
|
| 73 | ],
|
| 74 | "CreateReceiptRuleSet": [
|
| 75 | {
|
| 76 | "input": {
|
| 77 | "RuleSetName": "MyRuleSet"
|
| 78 | },
|
| 79 | "comments": {
|
| 80 | "input": {
|
| 81 | },
|
| 82 | "output": {
|
| 83 | }
|
| 84 | },
|
| 85 | "description": "The following example creates an empty receipt rule set:",
|
| 86 | "id": "createreceiptruleset-1469058761646",
|
| 87 | "title": "CreateReceiptRuleSet"
|
| 88 | }
|
| 89 | ],
|
| 90 | "DeleteIdentity": [
|
| 91 | {
|
| 92 | "input": {
|
| 93 | "Identity": "user@example.com"
|
| 94 | },
|
| 95 | "comments": {
|
| 96 | "input": {
|
| 97 | },
|
| 98 | "output": {
|
| 99 | }
|
| 100 | },
|
| 101 | "description": "The following example deletes an identity from the list of identities that have been submitted for verification with Amazon SES:",
|
| 102 | "id": "deleteidentity-1469047858906",
|
| 103 | "title": "DeleteIdentity"
|
| 104 | }
|
| 105 | ],
|
| 106 | "DeleteIdentityPolicy": [
|
| 107 | {
|
| 108 | "input": {
|
| 109 | "Identity": "user@example.com",
|
| 110 | "PolicyName": "MyPolicy"
|
| 111 | },
|
| 112 | "comments": {
|
| 113 | "input": {
|
| 114 | },
|
| 115 | "output": {
|
| 116 | }
|
| 117 | },
|
| 118 | "description": "The following example deletes a sending authorization policy for an identity:",
|
| 119 | "id": "deleteidentitypolicy-1469055282499",
|
| 120 | "title": "DeleteIdentityPolicy"
|
| 121 | }
|
| 122 | ],
|
| 123 | "DeleteReceiptFilter": [
|
| 124 | {
|
| 125 | "input": {
|
| 126 | "FilterName": "MyFilter"
|
| 127 | },
|
| 128 | "comments": {
|
| 129 | "input": {
|
| 130 | },
|
| 131 | "output": {
|
| 132 | }
|
| 133 | },
|
| 134 | "description": "The following example deletes an IP address filter:",
|
| 135 | "id": "deletereceiptfilter-1469055456835",
|
| 136 | "title": "DeleteReceiptFilter"
|
| 137 | }
|
| 138 | ],
|
| 139 | "DeleteReceiptRule": [
|
| 140 | {
|
| 141 | "input": {
|
| 142 | "RuleName": "MyRule",
|
| 143 | "RuleSetName": "MyRuleSet"
|
| 144 | },
|
| 145 | "comments": {
|
| 146 | "input": {
|
| 147 | },
|
| 148 | "output": {
|
| 149 | }
|
| 150 | },
|
| 151 | "description": "The following example deletes a receipt rule:",
|
| 152 | "id": "deletereceiptrule-1469055563599",
|
| 153 | "title": "DeleteReceiptRule"
|
| 154 | }
|
| 155 | ],
|
| 156 | "DeleteReceiptRuleSet": [
|
| 157 | {
|
| 158 | "input": {
|
| 159 | "RuleSetName": "MyRuleSet"
|
| 160 | },
|
| 161 | "comments": {
|
| 162 | "input": {
|
| 163 | },
|
| 164 | "output": {
|
| 165 | }
|
| 166 | },
|
| 167 | "description": "The following example deletes a receipt rule set:",
|
| 168 | "id": "deletereceiptruleset-1469055713690",
|
| 169 | "title": "DeleteReceiptRuleSet"
|
| 170 | }
|
| 171 | ],
|
| 172 | "DeleteVerifiedEmailAddress": [
|
| 173 | {
|
| 174 | "input": {
|
| 175 | "EmailAddress": "user@example.com"
|
| 176 | },
|
| 177 | "comments": {
|
| 178 | "input": {
|
| 179 | },
|
| 180 | "output": {
|
| 181 | }
|
| 182 | },
|
| 183 | "description": "The following example deletes an email address from the list of identities that have been submitted for verification with Amazon SES:",
|
| 184 | "id": "deleteverifiedemailaddress-1469051086444",
|
| 185 | "title": "DeleteVerifiedEmailAddress"
|
| 186 | }
|
| 187 | ],
|
| 188 | "DescribeActiveReceiptRuleSet": [
|
| 189 | {
|
| 190 | "input": {
|
| 191 | },
|
| 192 | "output": {
|
| 193 | "Metadata": {
|
| 194 | "CreatedTimestamp": "2016-07-15T16:25:59.607Z",
|
| 195 | "Name": "default-rule-set"
|
| 196 | },
|
| 197 | "Rules": [
|
| 198 | {
|
| 199 | "Actions": [
|
| 200 | {
|
| 201 | "S3Action": {
|
| 202 | "BucketName": "MyBucket",
|
| 203 | "ObjectKeyPrefix": "email"
|
| 204 | }
|
| 205 | }
|
| 206 | ],
|
| 207 | "Enabled": true,
|
| 208 | "Name": "MyRule",
|
| 209 | "ScanEnabled": true,
|
| 210 | "TlsPolicy": "Optional"
|
| 211 | }
|
| 212 | ]
|
| 213 | },
|
| 214 | "comments": {
|
| 215 | "input": {
|
| 216 | },
|
| 217 | "output": {
|
| 218 | }
|
| 219 | },
|
| 220 | "description": "The following example returns the metadata and receipt rules for the receipt rule set that is currently active:",
|
| 221 | "id": "describeactivereceiptruleset-1469121611502",
|
| 222 | "title": "DescribeActiveReceiptRuleSet"
|
| 223 | }
|
| 224 | ],
|
| 225 | "DescribeReceiptRule": [
|
| 226 | {
|
| 227 | "input": {
|
| 228 | "RuleName": "MyRule",
|
| 229 | "RuleSetName": "MyRuleSet"
|
| 230 | },
|
| 231 | "output": {
|
| 232 | "Rule": {
|
| 233 | "Actions": [
|
| 234 | {
|
| 235 | "S3Action": {
|
| 236 | "BucketName": "MyBucket",
|
| 237 | "ObjectKeyPrefix": "email"
|
| 238 | }
|
| 239 | }
|
| 240 | ],
|
| 241 | "Enabled": true,
|
| 242 | "Name": "MyRule",
|
| 243 | "ScanEnabled": true,
|
| 244 | "TlsPolicy": "Optional"
|
| 245 | }
|
| 246 | },
|
| 247 | "comments": {
|
| 248 | "input": {
|
| 249 | },
|
| 250 | "output": {
|
| 251 | }
|
| 252 | },
|
| 253 | "description": "The following example returns the details of a receipt rule:",
|
| 254 | "id": "describereceiptrule-1469055813118",
|
| 255 | "title": "DescribeReceiptRule"
|
| 256 | }
|
| 257 | ],
|
| 258 | "DescribeReceiptRuleSet": [
|
| 259 | {
|
| 260 | "input": {
|
| 261 | "RuleSetName": "MyRuleSet"
|
| 262 | },
|
| 263 | "output": {
|
| 264 | "Metadata": {
|
| 265 | "CreatedTimestamp": "2016-07-15T16:25:59.607Z",
|
| 266 | "Name": "MyRuleSet"
|
| 267 | },
|
| 268 | "Rules": [
|
| 269 | {
|
| 270 | "Actions": [
|
| 271 | {
|
| 272 | "S3Action": {
|
| 273 | "BucketName": "MyBucket",
|
| 274 | "ObjectKeyPrefix": "email"
|
| 275 | }
|
| 276 | }
|
| 277 | ],
|
| 278 | "Enabled": true,
|
| 279 | "Name": "MyRule",
|
| 280 | "ScanEnabled": true,
|
| 281 | "TlsPolicy": "Optional"
|
| 282 | }
|
| 283 | ]
|
| 284 | },
|
| 285 | "comments": {
|
| 286 | "input": {
|
| 287 | },
|
| 288 | "output": {
|
| 289 | }
|
| 290 | },
|
| 291 | "description": "The following example returns the metadata and receipt rules of a receipt rule set:",
|
| 292 | "id": "describereceiptruleset-1469121240385",
|
| 293 | "title": "DescribeReceiptRuleSet"
|
| 294 | }
|
| 295 | ],
|
| 296 | "GetAccountSendingEnabled": [
|
| 297 | {
|
| 298 | "output": {
|
| 299 | "Enabled": true
|
| 300 | },
|
| 301 | "comments": {
|
| 302 | "input": {
|
| 303 | },
|
| 304 | "output": {
|
| 305 | }
|
| 306 | },
|
| 307 | "description": "The following example returns if sending status for an account is enabled. (true / false):",
|
| 308 | "id": "getaccountsendingenabled-1469047741333",
|
| 309 | "title": "GetAccountSendingEnabled"
|
| 310 | }
|
| 311 | ],
|
| 312 | "GetIdentityDkimAttributes": [
|
| 313 | {
|
| 314 | "input": {
|
| 315 | "Identities": [
|
| 316 | "example.com",
|
| 317 | "user@example.com"
|
| 318 | ]
|
| 319 | },
|
| 320 | "output": {
|
| 321 | "DkimAttributes": {
|
| 322 | "example.com": {
|
| 323 | "DkimEnabled": true,
|
| 324 | "DkimTokens": [
|
| 325 | "EXAMPLEjcs5xoyqytjsotsijas7236gr",
|
| 326 | "EXAMPLEjr76cvoc6mysspnioorxsn6ep",
|
| 327 | "EXAMPLEkbmkqkhlm2lyz77ppkulerm4k"
|
| 328 | ],
|
| 329 | "DkimVerificationStatus": "Success"
|
| 330 | },
|
| 331 | "user@example.com": {
|
| 332 | "DkimEnabled": false,
|
| 333 | "DkimVerificationStatus": "NotStarted"
|
| 334 | }
|
| 335 | }
|
| 336 | },
|
| 337 | "comments": {
|
| 338 | "input": {
|
| 339 | },
|
| 340 | "output": {
|
| 341 | }
|
| 342 | },
|
| 343 | "description": "The following example retrieves the Amazon SES Easy DKIM attributes for a list of identities:",
|
| 344 | "id": "getidentitydkimattributes-1469050695628",
|
| 345 | "title": "GetIdentityDkimAttributes"
|
| 346 | }
|
| 347 | ],
|
| 348 | "GetIdentityMailFromDomainAttributes": [
|
| 349 | {
|
| 350 | "input": {
|
| 351 | "Identities": [
|
| 352 | "example.com"
|
| 353 | ]
|
| 354 | },
|
| 355 | "output": {
|
| 356 | "MailFromDomainAttributes": {
|
| 357 | "example.com": {
|
| 358 | "BehaviorOnMXFailure": "UseDefaultValue",
|
| 359 | "MailFromDomain": "bounces.example.com",
|
| 360 | "MailFromDomainStatus": "Success"
|
| 361 | }
|
| 362 | }
|
| 363 | },
|
| 364 | "comments": {
|
| 365 | "input": {
|
| 366 | },
|
| 367 | "output": {
|
| 368 | }
|
| 369 | },
|
| 370 | "description": "The following example returns the custom MAIL FROM attributes for an identity:",
|
| 371 | "id": "getidentitymailfromdomainattributes-1469123114860",
|
| 372 | "title": "GetIdentityMailFromDomainAttributes"
|
| 373 | }
|
| 374 | ],
|
| 375 | "GetIdentityNotificationAttributes": [
|
| 376 | {
|
| 377 | "input": {
|
| 378 | "Identities": [
|
| 379 | "example.com"
|
| 380 | ]
|
| 381 | },
|
| 382 | "output": {
|
| 383 | "NotificationAttributes": {
|
| 384 | "example.com": {
|
| 385 | "BounceTopic": "arn:aws:sns:us-east-1:EXAMPLE65304:ExampleTopic",
|
| 386 | "ComplaintTopic": "arn:aws:sns:us-east-1:EXAMPLE65304:ExampleTopic",
|
| 387 | "DeliveryTopic": "arn:aws:sns:us-east-1:EXAMPLE65304:ExampleTopic",
|
| 388 | "ForwardingEnabled": true,
|
| 389 | "HeadersInBounceNotificationsEnabled": false,
|
| 390 | "HeadersInComplaintNotificationsEnabled": false,
|
| 391 | "HeadersInDeliveryNotificationsEnabled": false
|
| 392 | }
|
| 393 | }
|
| 394 | },
|
| 395 | "comments": {
|
| 396 | "input": {
|
| 397 | },
|
| 398 | "output": {
|
| 399 | }
|
| 400 | },
|
| 401 | "description": "The following example returns the notification attributes for an identity:",
|
| 402 | "id": "getidentitynotificationattributes-1469123466947",
|
| 403 | "title": "GetIdentityNotificationAttributes"
|
| 404 | }
|
| 405 | ],
|
| 406 | "GetIdentityPolicies": [
|
| 407 | {
|
| 408 | "input": {
|
| 409 | "Identity": "example.com",
|
| 410 | "PolicyNames": [
|
| 411 | "MyPolicy"
|
| 412 | ]
|
| 413 | },
|
| 414 | "output": {
|
| 415 | "Policies": {
|
| 416 | "MyPolicy": "{\"Version\":\"2008-10-17\",\"Statement\":[{\"Sid\":\"stmt1469123904194\",\"Effect\":\"Allow\",\"Principal\":{\"AWS\":\"arn:aws:iam::123456789012:root\"},\"Action\":[\"ses:SendEmail\",\"ses:SendRawEmail\"],\"Resource\":\"arn:aws:ses:us-east-1:EXAMPLE65304:identity/example.com\"}]}"
|
| 417 | }
|
| 418 | },
|
| 419 | "comments": {
|
| 420 | "input": {
|
| 421 | },
|
| 422 | "output": {
|
| 423 | }
|
| 424 | },
|
| 425 | "description": "The following example returns a sending authorization policy for an identity:",
|
| 426 | "id": "getidentitypolicies-1469123949351",
|
| 427 | "title": "GetIdentityPolicies"
|
| 428 | }
|
| 429 | ],
|
| 430 | "GetIdentityVerificationAttributes": [
|
| 431 | {
|
| 432 | "input": {
|
| 433 | "Identities": [
|
| 434 | "example.com"
|
| 435 | ]
|
| 436 | },
|
| 437 | "output": {
|
| 438 | "VerificationAttributes": {
|
| 439 | "example.com": {
|
| 440 | "VerificationStatus": "Success",
|
| 441 | "VerificationToken": "EXAMPLE3VYb9EDI2nTOQRi/Tf6MI/6bD6THIGiP1MVY="
|
| 442 | }
|
| 443 | }
|
| 444 | },
|
| 445 | "comments": {
|
| 446 | "input": {
|
| 447 | },
|
| 448 | "output": {
|
| 449 | }
|
| 450 | },
|
| 451 | "description": "The following example returns the verification status and the verification token for a domain identity:",
|
| 452 | "id": "getidentityverificationattributes-1469124205897",
|
| 453 | "title": "GetIdentityVerificationAttributes"
|
| 454 | }
|
| 455 | ],
|
| 456 | "GetSendQuota": [
|
| 457 | {
|
| 458 | "output": {
|
| 459 | "Max24HourSend": 200,
|
| 460 | "MaxSendRate": 1,
|
| 461 | "SentLast24Hours": 1
|
| 462 | },
|
| 463 | "comments": {
|
| 464 | "input": {
|
| 465 | },
|
| 466 | "output": {
|
| 467 | }
|
| 468 | },
|
| 469 | "description": "The following example returns the Amazon SES sending limits for an AWS account:",
|
| 470 | "id": "getsendquota-1469047324508",
|
| 471 | "title": "GetSendQuota"
|
| 472 | }
|
| 473 | ],
|
| 474 | "GetSendStatistics": [
|
| 475 | {
|
| 476 | "output": {
|
| 477 | "SendDataPoints": [
|
| 478 | {
|
| 479 | "Bounces": 0,
|
| 480 | "Complaints": 0,
|
| 481 | "DeliveryAttempts": 5,
|
| 482 | "Rejects": 0,
|
| 483 | "Timestamp": "2016-07-13T22:43:00Z"
|
| 484 | },
|
| 485 | {
|
| 486 | "Bounces": 0,
|
| 487 | "Complaints": 0,
|
| 488 | "DeliveryAttempts": 3,
|
| 489 | "Rejects": 0,
|
| 490 | "Timestamp": "2016-07-13T23:13:00Z"
|
| 491 | },
|
| 492 | {
|
| 493 | "Bounces": 0,
|
| 494 | "Complaints": 0,
|
| 495 | "DeliveryAttempts": 1,
|
| 496 | "Rejects": 0,
|
| 497 | "Timestamp": "2016-07-13T21:13:00Z"
|
| 498 | }
|
| 499 | ]
|
| 500 | },
|
| 501 | "comments": {
|
| 502 | "input": {
|
| 503 | },
|
| 504 | "output": {
|
| 505 | }
|
| 506 | },
|
| 507 | "description": "The following example returns Amazon SES sending statistics:",
|
| 508 | "id": "getsendstatistics-1469047741329",
|
| 509 | "title": "GetSendStatistics"
|
| 510 | }
|
| 511 | ],
|
| 512 | "ListIdentities": [
|
| 513 | {
|
| 514 | "input": {
|
| 515 | "IdentityType": "EmailAddress",
|
| 516 | "MaxItems": 123,
|
| 517 | "NextToken": ""
|
| 518 | },
|
| 519 | "output": {
|
| 520 | "Identities": [
|
| 521 | "user@example.com"
|
| 522 | ],
|
| 523 | "NextToken": ""
|
| 524 | },
|
| 525 | "comments": {
|
| 526 | "input": {
|
| 527 | },
|
| 528 | "output": {
|
| 529 | }
|
| 530 | },
|
| 531 | "description": "The following example lists the email address identities that have been submitted for verification with Amazon SES:",
|
| 532 | "id": "listidentities-1469048638493",
|
| 533 | "title": "ListIdentities"
|
| 534 | }
|
| 535 | ],
|
| 536 | "ListIdentityPolicies": [
|
| 537 | {
|
| 538 | "input": {
|
| 539 | "Identity": "example.com"
|
| 540 | },
|
| 541 | "output": {
|
| 542 | "PolicyNames": [
|
| 543 | "MyPolicy"
|
| 544 | ]
|
| 545 | },
|
| 546 | "comments": {
|
| 547 | "input": {
|
| 548 | },
|
| 549 | "output": {
|
| 550 | }
|
| 551 | },
|
| 552 | "description": "The following example returns a list of sending authorization policies that are attached to an identity:",
|
| 553 | "id": "listidentitypolicies-1469124417674",
|
| 554 | "title": "ListIdentityPolicies"
|
| 555 | }
|
| 556 | ],
|
| 557 | "ListReceiptFilters": [
|
| 558 | {
|
| 559 | "output": {
|
| 560 | "Filters": [
|
| 561 | {
|
| 562 | "IpFilter": {
|
| 563 | "Cidr": "1.2.3.4/24",
|
| 564 | "Policy": "Block"
|
| 565 | },
|
| 566 | "Name": "MyFilter"
|
| 567 | }
|
| 568 | ]
|
| 569 | },
|
| 570 | "comments": {
|
| 571 | "input": {
|
| 572 | },
|
| 573 | "output": {
|
| 574 | }
|
| 575 | },
|
| 576 | "description": "The following example lists the IP address filters that are associated with an AWS account:",
|
| 577 | "id": "listreceiptfilters-1469120786789",
|
| 578 | "title": "ListReceiptFilters"
|
| 579 | }
|
| 580 | ],
|
| 581 | "ListReceiptRuleSets": [
|
| 582 | {
|
| 583 | "input": {
|
| 584 | "NextToken": ""
|
| 585 | },
|
| 586 | "output": {
|
| 587 | "NextToken": "",
|
| 588 | "RuleSets": [
|
| 589 | {
|
| 590 | "CreatedTimestamp": "2016-07-15T16:25:59.607Z",
|
| 591 | "Name": "MyRuleSet"
|
| 592 | }
|
| 593 | ]
|
| 594 | },
|
| 595 | "comments": {
|
| 596 | "input": {
|
| 597 | },
|
| 598 | "output": {
|
| 599 | }
|
| 600 | },
|
| 601 | "description": "The following example lists the receipt rule sets that exist under an AWS account:",
|
| 602 | "id": "listreceiptrulesets-1469121037235",
|
| 603 | "title": "ListReceiptRuleSets"
|
| 604 | }
|
| 605 | ],
|
| 606 | "ListVerifiedEmailAddresses": [
|
| 607 | {
|
| 608 | "output": {
|
| 609 | "VerifiedEmailAddresses": [
|
| 610 | "user1@example.com",
|
| 611 | "user2@example.com"
|
| 612 | ]
|
| 613 | },
|
| 614 | "comments": {
|
| 615 | "input": {
|
| 616 | },
|
| 617 | "output": {
|
| 618 | }
|
| 619 | },
|
| 620 | "description": "The following example lists all email addresses that have been submitted for verification with Amazon SES:",
|
| 621 | "id": "listverifiedemailaddresses-1469051402570",
|
| 622 | "title": "ListVerifiedEmailAddresses"
|
| 623 | }
|
| 624 | ],
|
| 625 | "PutIdentityPolicy": [
|
| 626 | {
|
| 627 | "input": {
|
| 628 | "Identity": "example.com",
|
| 629 | "Policy": "{\"Version\":\"2008-10-17\",\"Statement\":[{\"Sid\":\"stmt1469123904194\",\"Effect\":\"Allow\",\"Principal\":{\"AWS\":\"arn:aws:iam::123456789012:root\"},\"Action\":[\"ses:SendEmail\",\"ses:SendRawEmail\"],\"Resource\":\"arn:aws:ses:us-east-1:EXAMPLE65304:identity/example.com\"}]}",
|
| 630 | "PolicyName": "MyPolicy"
|
| 631 | },
|
| 632 | "comments": {
|
| 633 | "input": {
|
| 634 | },
|
| 635 | "output": {
|
| 636 | }
|
| 637 | },
|
| 638 | "description": "The following example adds a sending authorization policy to an identity:",
|
| 639 | "id": "putidentitypolicy-1469124560016",
|
| 640 | "title": "PutIdentityPolicy"
|
| 641 | }
|
| 642 | ],
|
| 643 | "ReorderReceiptRuleSet": [
|
| 644 | {
|
| 645 | "input": {
|
| 646 | "RuleNames": [
|
| 647 | "MyRule",
|
| 648 | "MyOtherRule"
|
| 649 | ],
|
| 650 | "RuleSetName": "MyRuleSet"
|
| 651 | },
|
| 652 | "comments": {
|
| 653 | "input": {
|
| 654 | },
|
| 655 | "output": {
|
| 656 | }
|
| 657 | },
|
| 658 | "description": "The following example reorders the receipt rules within a receipt rule set:",
|
| 659 | "id": "reorderreceiptruleset-1469058156806",
|
| 660 | "title": "ReorderReceiptRuleSet"
|
| 661 | }
|
| 662 | ],
|
| 663 | "SendEmail": [
|
| 664 | {
|
| 665 | "input": {
|
| 666 | "Destination": {
|
| 667 | "BccAddresses": [
|
| 668 |
|
| 669 | ],
|
| 670 | "CcAddresses": [
|
| 671 | "recipient3@example.com"
|
| 672 | ],
|
| 673 | "ToAddresses": [
|
| 674 | "recipient1@example.com",
|
| 675 | "recipient2@example.com"
|
| 676 | ]
|
| 677 | },
|
| 678 | "Message": {
|
| 679 | "Body": {
|
| 680 | "Html": {
|
| 681 | "Charset": "UTF-8",
|
| 682 | "Data": "This message body contains HTML formatting. It can, for example, contain links like this one: <a class=\"ulink\" href=\"http://docs.aws.amazon.com/ses/latest/DeveloperGuide\" target=\"_blank\">Amazon SES Developer Guide</a>."
|
| 683 | },
|
| 684 | "Text": {
|
| 685 | "Charset": "UTF-8",
|
| 686 | "Data": "This is the message body in text format."
|
| 687 | }
|
| 688 | },
|
| 689 | "Subject": {
|
| 690 | "Charset": "UTF-8",
|
| 691 | "Data": "Test email"
|
| 692 | }
|
| 693 | },
|
| 694 | "ReplyToAddresses": [
|
| 695 |
|
| 696 | ],
|
| 697 | "ReturnPath": "",
|
| 698 | "ReturnPathArn": "",
|
| 699 | "Source": "sender@example.com",
|
| 700 | "SourceArn": ""
|
| 701 | },
|
| 702 | "output": {
|
| 703 | "MessageId": "EXAMPLE78603177f-7a5433e7-8edb-42ae-af10-f0181f34d6ee-000000"
|
| 704 | },
|
| 705 | "comments": {
|
| 706 | "input": {
|
| 707 | },
|
| 708 | "output": {
|
| 709 | }
|
| 710 | },
|
| 711 | "description": "The following example sends a formatted email:",
|
| 712 | "id": "sendemail-1469049656296",
|
| 713 | "title": "SendEmail"
|
| 714 | }
|
| 715 | ],
|
| 716 | "SendRawEmail": [
|
| 717 | {
|
| 718 | "input": {
|
| 719 | "Destinations": [
|
| 720 |
|
| 721 | ],
|
| 722 | "FromArn": "",
|
| 723 | "RawMessage": {
|
| 724 | "Data": "From: sender@example.com\\nTo: recipient@example.com\\nSubject: Test email (contains an attachment)\\nMIME-Version: 1.0\\nContent-type: Multipart/Mixed; boundary=\"NextPart\"\\n\\n--NextPart\\nContent-Type: text/plain\\n\\nThis is the message body.\\n\\n--NextPart\\nContent-Type: text/plain;\\nContent-Disposition: attachment; filename=\"attachment.txt\"\\n\\nThis is the text in the attachment.\\n\\n--NextPart--"
|
| 725 | },
|
| 726 | "ReturnPathArn": "",
|
| 727 | "Source": "",
|
| 728 | "SourceArn": ""
|
| 729 | },
|
| 730 | "output": {
|
| 731 | "MessageId": "EXAMPLEf3f73d99b-c63fb06f-d263-41f8-a0fb-d0dc67d56c07-000000"
|
| 732 | },
|
| 733 | "comments": {
|
| 734 | "input": {
|
| 735 | },
|
| 736 | "output": {
|
| 737 | }
|
| 738 | },
|
| 739 | "description": "The following example sends an email with an attachment:",
|
| 740 | "id": "sendrawemail-1469118548649",
|
| 741 | "title": "SendRawEmail"
|
| 742 | }
|
| 743 | ],
|
| 744 | "SetActiveReceiptRuleSet": [
|
| 745 | {
|
| 746 | "input": {
|
| 747 | "RuleSetName": "RuleSetToActivate"
|
| 748 | },
|
| 749 | "comments": {
|
| 750 | "input": {
|
| 751 | },
|
| 752 | "output": {
|
| 753 | }
|
| 754 | },
|
| 755 | "description": "The following example sets the active receipt rule set:",
|
| 756 | "id": "setactivereceiptruleset-1469058391329",
|
| 757 | "title": "SetActiveReceiptRuleSet"
|
| 758 | }
|
| 759 | ],
|
| 760 | "SetIdentityDkimEnabled": [
|
| 761 | {
|
| 762 | "input": {
|
| 763 | "DkimEnabled": true,
|
| 764 | "Identity": "user@example.com"
|
| 765 | },
|
| 766 | "comments": {
|
| 767 | "input": {
|
| 768 | },
|
| 769 | "output": {
|
| 770 | }
|
| 771 | },
|
| 772 | "description": "The following example configures Amazon SES to Easy DKIM-sign the email sent from an identity:",
|
| 773 | "id": "setidentitydkimenabled-1469057485202",
|
| 774 | "title": "SetIdentityDkimEnabled"
|
| 775 | }
|
| 776 | ],
|
| 777 | "SetIdentityFeedbackForwardingEnabled": [
|
| 778 | {
|
| 779 | "input": {
|
| 780 | "ForwardingEnabled": true,
|
| 781 | "Identity": "user@example.com"
|
| 782 | },
|
| 783 | "comments": {
|
| 784 | "input": {
|
| 785 | },
|
| 786 | "output": {
|
| 787 | }
|
| 788 | },
|
| 789 | "description": "The following example configures Amazon SES to forward an identity's bounces and complaints via email:",
|
| 790 | "id": "setidentityfeedbackforwardingenabled-1469056811329",
|
| 791 | "title": "SetIdentityFeedbackForwardingEnabled"
|
| 792 | }
|
| 793 | ],
|
| 794 | "SetIdentityHeadersInNotificationsEnabled": [
|
| 795 | {
|
| 796 | "input": {
|
| 797 | "Enabled": true,
|
| 798 | "Identity": "user@example.com",
|
| 799 | "NotificationType": "Bounce"
|
| 800 | },
|
| 801 | "comments": {
|
| 802 | "input": {
|
| 803 | },
|
| 804 | "output": {
|
| 805 | }
|
| 806 | },
|
| 807 | "description": "The following example configures Amazon SES to include the original email headers in the Amazon SNS bounce notifications for an identity:",
|
| 808 | "id": "setidentityheadersinnotificationsenabled-1469057295001",
|
| 809 | "title": "SetIdentityHeadersInNotificationsEnabled"
|
| 810 | }
|
| 811 | ],
|
| 812 | "SetIdentityMailFromDomain": [
|
| 813 | {
|
| 814 | "input": {
|
| 815 | "BehaviorOnMXFailure": "UseDefaultValue",
|
| 816 | "Identity": "user@example.com",
|
| 817 | "MailFromDomain": "bounces.example.com"
|
| 818 | },
|
| 819 | "comments": {
|
| 820 | "input": {
|
| 821 | },
|
| 822 | "output": {
|
| 823 | }
|
| 824 | },
|
| 825 | "description": "The following example configures Amazon SES to use a custom MAIL FROM domain for an identity:",
|
| 826 | "id": "setidentitymailfromdomain-1469057693908",
|
| 827 | "title": "SetIdentityMailFromDomain"
|
| 828 | }
|
| 829 | ],
|
| 830 | "SetIdentityNotificationTopic": [
|
| 831 | {
|
| 832 | "input": {
|
| 833 | "Identity": "user@example.com",
|
| 834 | "NotificationType": "Bounce",
|
| 835 | "SnsTopic": "arn:aws:sns:us-west-2:111122223333:MyTopic"
|
| 836 | },
|
| 837 | "comments": {
|
| 838 | "input": {
|
| 839 | },
|
| 840 | "output": {
|
| 841 | }
|
| 842 | },
|
| 843 | "description": "The following example sets the Amazon SNS topic to which Amazon SES will publish bounce, complaint, and/or delivery notifications for emails sent with the specified identity as the Source:",
|
| 844 | "id": "setidentitynotificationtopic-1469057854966",
|
| 845 | "title": "SetIdentityNotificationTopic"
|
| 846 | }
|
| 847 | ],
|
| 848 | "SetReceiptRulePosition": [
|
| 849 | {
|
| 850 | "input": {
|
| 851 | "After": "PutRuleAfterThisRule",
|
| 852 | "RuleName": "RuleToReposition",
|
| 853 | "RuleSetName": "MyRuleSet"
|
| 854 | },
|
| 855 | "comments": {
|
| 856 | "input": {
|
| 857 | },
|
| 858 | "output": {
|
| 859 | }
|
| 860 | },
|
| 861 | "description": "The following example sets the position of a receipt rule in a receipt rule set:",
|
| 862 | "id": "setreceiptruleposition-1469058530550",
|
| 863 | "title": "SetReceiptRulePosition"
|
| 864 | }
|
| 865 | ],
|
| 866 | "UpdateAccountSendingEnabled": [
|
| 867 | {
|
| 868 | "input": {
|
| 869 | "Enabled": true
|
| 870 | },
|
| 871 | "comments": {
|
| 872 | "input": {
|
| 873 | },
|
| 874 | "output": {
|
| 875 | }
|
| 876 | },
|
| 877 | "description": "The following example updated the sending status for this account.",
|
| 878 | "id": "updateaccountsendingenabled-1469047741333",
|
| 879 | "title": "UpdateAccountSendingEnabled"
|
| 880 | }
|
| 881 | ],
|
| 882 | "UpdateConfigurationSetReputationMetricsEnabled": [
|
| 883 | {
|
| 884 | "input": {
|
| 885 | "ConfigurationSetName": "foo",
|
| 886 | "Enabled": true
|
| 887 | },
|
| 888 | "comments": {
|
| 889 | "input": {
|
| 890 | },
|
| 891 | "output": {
|
| 892 | }
|
| 893 | },
|
| 894 | "description": "Set the reputationMetricsEnabled flag for a specific configuration set.",
|
| 895 | "id": "updateconfigurationsetreputationmetricsenabled-2362747741333",
|
| 896 | "title": "UpdateConfigurationSetReputationMetricsEnabled"
|
| 897 | }
|
| 898 | ],
|
| 899 | "UpdateConfigurationSetSendingEnabled": [
|
| 900 | {
|
| 901 | "input": {
|
| 902 | "ConfigurationSetName": "foo",
|
| 903 | "Enabled": true
|
| 904 | },
|
| 905 | "comments": {
|
| 906 | "input": {
|
| 907 | },
|
| 908 | "output": {
|
| 909 | }
|
| 910 | },
|
| 911 | "description": "Set the sending enabled flag for a specific configuration set.",
|
| 912 | "id": "updateconfigurationsetsendingenabled-2362747741333",
|
| 913 | "title": "UpdateConfigurationSetReputationMetricsEnabled"
|
| 914 | }
|
| 915 | ],
|
| 916 | "UpdateReceiptRule": [
|
| 917 | {
|
| 918 | "input": {
|
| 919 | "Rule": {
|
| 920 | "Actions": [
|
| 921 | {
|
| 922 | "S3Action": {
|
| 923 | "BucketName": "MyBucket",
|
| 924 | "ObjectKeyPrefix": "email"
|
| 925 | }
|
| 926 | }
|
| 927 | ],
|
| 928 | "Enabled": true,
|
| 929 | "Name": "MyRule",
|
| 930 | "ScanEnabled": true,
|
| 931 | "TlsPolicy": "Optional"
|
| 932 | },
|
| 933 | "RuleSetName": "MyRuleSet"
|
| 934 | },
|
| 935 | "comments": {
|
| 936 | "input": {
|
| 937 | },
|
| 938 | "output": {
|
| 939 | }
|
| 940 | },
|
| 941 | "description": "The following example updates a receipt rule to use an Amazon S3 action:",
|
| 942 | "id": "updatereceiptrule-1469051756940",
|
| 943 | "title": "UpdateReceiptRule"
|
| 944 | }
|
| 945 | ],
|
| 946 | "VerifyDomainDkim": [
|
| 947 | {
|
| 948 | "input": {
|
| 949 | "Domain": "example.com"
|
| 950 | },
|
| 951 | "output": {
|
| 952 | "DkimTokens": [
|
| 953 | "EXAMPLEq76owjnks3lnluwg65scbemvw",
|
| 954 | "EXAMPLEi3dnsj67hstzaj673klariwx2",
|
| 955 | "EXAMPLEwfbtcukvimehexktmdtaz6naj"
|
| 956 | ]
|
| 957 | },
|
| 958 | "comments": {
|
| 959 | "input": {
|
| 960 | },
|
| 961 | "output": {
|
| 962 | }
|
| 963 | },
|
| 964 | "description": "The following example generates DKIM tokens for a domain that has been verified with Amazon SES:",
|
| 965 | "id": "verifydomaindkim-1469049503083",
|
| 966 | "title": "VerifyDomainDkim"
|
| 967 | }
|
| 968 | ],
|
| 969 | "VerifyDomainIdentity": [
|
| 970 | {
|
| 971 | "input": {
|
| 972 | "Domain": "example.com"
|
| 973 | },
|
| 974 | "output": {
|
| 975 | "VerificationToken": "eoEmxw+YaYhb3h3iVJHuXMJXqeu1q1/wwmvjuEXAMPLE"
|
| 976 | },
|
| 977 | "comments": {
|
| 978 | "input": {
|
| 979 | },
|
| 980 | "output": {
|
| 981 | }
|
| 982 | },
|
| 983 | "description": "The following example starts the domain verification process with Amazon SES:",
|
| 984 | "id": "verifydomainidentity-1469049165936",
|
| 985 | "title": "VerifyDomainIdentity"
|
| 986 | }
|
| 987 | ],
|
| 988 | "VerifyEmailAddress": [
|
| 989 | {
|
| 990 | "input": {
|
| 991 | "EmailAddress": "user@example.com"
|
| 992 | },
|
| 993 | "comments": {
|
| 994 | "input": {
|
| 995 | },
|
| 996 | "output": {
|
| 997 | }
|
| 998 | },
|
| 999 | "description": "The following example starts the email address verification process with Amazon SES:",
|
| 1000 | "id": "verifyemailaddress-1469048849187",
|
| 1001 | "title": "VerifyEmailAddress"
|
| 1002 | }
|
| 1003 | ],
|
| 1004 | "VerifyEmailIdentity": [
|
| 1005 | {
|
| 1006 | "input": {
|
| 1007 | "EmailAddress": "user@example.com"
|
| 1008 | },
|
| 1009 | "comments": {
|
| 1010 | "input": {
|
| 1011 | },
|
| 1012 | "output": {
|
| 1013 | }
|
| 1014 | },
|
| 1015 | "description": "The following example starts the email address verification process with Amazon SES:",
|
| 1016 | "id": "verifyemailidentity-1469049068623",
|
| 1017 | "title": "VerifyEmailIdentity"
|
| 1018 | }
|
| 1019 | ]
|
| 1020 | }
|
| 1021 | }
|