|
707 | 707 | ], |
708 | 708 | "documentation":"<p>Retrieve inbox placement and engagement rates for the domains that you use to send email.</p>" |
709 | 709 | }, |
| 710 | + "GetEmailAddressInsights":{ |
| 711 | + "name":"GetEmailAddressInsights", |
| 712 | + "http":{ |
| 713 | + "method":"POST", |
| 714 | + "requestUri":"/v2/email/email-address-insights/" |
| 715 | + }, |
| 716 | + "input":{"shape":"GetEmailAddressInsightsRequest"}, |
| 717 | + "output":{"shape":"GetEmailAddressInsightsResponse"}, |
| 718 | + "errors":[ |
| 719 | + {"shape":"TooManyRequestsException"}, |
| 720 | + {"shape":"BadRequestException"} |
| 721 | + ], |
| 722 | + "documentation":"<p>Provides validation insights about a specific email address, including syntax validation, DNS record checks, mailbox existence, and other deliverability factors.</p>" |
| 723 | + }, |
710 | 724 | "GetEmailIdentity":{ |
711 | 725 | "name":"GetEmailIdentity", |
712 | 726 | "http":{ |
|
2438 | 2452 | "shape":"TemplateContent", |
2439 | 2453 | "documentation":"<p>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 <a href=\"https://docs.aws.amazon.com/ses/latest/dg/creating-identities.html#send-email-verify-address-custom-faq\">Custom verification email frequently asked questions</a> in the <i>Amazon SES Developer Guide</i>.</p>" |
2440 | 2454 | }, |
| 2455 | + "Tags":{ |
| 2456 | + "shape":"TagList", |
| 2457 | + "documentation":"<p>An array of objects that define the tags (keys and values) to associate with the custom verification email template.</p>" |
| 2458 | + }, |
2441 | 2459 | "SuccessRedirectionURL":{ |
2442 | 2460 | "shape":"SuccessRedirectionURL", |
2443 | 2461 | "documentation":"<p>The URL that the recipient of the verification email is sent to if his or her address is successfully verified.</p>" |
|
2609 | 2627 | "TemplateContent":{ |
2610 | 2628 | "shape":"EmailTemplateContent", |
2611 | 2629 | "documentation":"<p>The content of the email template, composed of a subject line, an HTML part, and a text-only part.</p>" |
| 2630 | + }, |
| 2631 | + "Tags":{ |
| 2632 | + "shape":"TagList", |
| 2633 | + "documentation":"<p>An array of objects that define the tags (keys and values) to associate with the email template.</p>" |
2612 | 2634 | } |
2613 | 2635 | }, |
2614 | 2636 | "documentation":"<p>Represents a request to create an email template. For more information, see the <a href=\"https://docs.aws.amazon.com/ses/latest/DeveloperGuide/send-personalized-email-api.html\">Amazon SES Developer Guide</a>.</p>" |
|
3563 | 3585 | "member":{"shape":"InsightsEmailAddress"}, |
3564 | 3586 | "max":5 |
3565 | 3587 | }, |
| 3588 | + "EmailAddressInsightsConfidenceVerdict":{ |
| 3589 | + "type":"string", |
| 3590 | + "documentation":"<p>The confidence level of SES that the email address meets the validation criteria:</p> <ul> <li> <p> <code>LOW</code> - Weak or no indication of the specific check (e.g., LOW for IsRoleAddress means the email is less likely to be a role-based address).</p> </li> <li> <p> <code>MEDIUM</code> - Moderate indication of the specific check (e.g., MEDIUM for IsDisposable means the email might be a disposable address).</p> </li> <li> <p> <code>HIGH</code> - Strong indication of the specific check (e.g., HIGH for IsRandomInput means the email is very likely randomly generated).</p> </li> </ul>", |
| 3591 | + "enum":[ |
| 3592 | + "LOW", |
| 3593 | + "MEDIUM", |
| 3594 | + "HIGH" |
| 3595 | + ] |
| 3596 | + }, |
| 3597 | + "EmailAddressInsightsMailboxEvaluations":{ |
| 3598 | + "type":"structure", |
| 3599 | + "members":{ |
| 3600 | + "HasValidSyntax":{ |
| 3601 | + "shape":"EmailAddressInsightsVerdict", |
| 3602 | + "documentation":"<p>Checks that the email address follows proper RFC standards and contains valid characters in the correct format.</p>" |
| 3603 | + }, |
| 3604 | + "HasValidDnsRecords":{ |
| 3605 | + "shape":"EmailAddressInsightsVerdict", |
| 3606 | + "documentation":"<p>Checks that the domain exists, has valid DNS records, and is configured to receive email.</p>" |
| 3607 | + }, |
| 3608 | + "MailboxExists":{ |
| 3609 | + "shape":"EmailAddressInsightsVerdict", |
| 3610 | + "documentation":"<p>Checks that the mailbox exists and can receive messages without actually sending an email.</p>" |
| 3611 | + }, |
| 3612 | + "IsRoleAddress":{ |
| 3613 | + "shape":"EmailAddressInsightsVerdict", |
| 3614 | + "documentation":"<p>Identifies role-based addresses (such as admin@, support@, or info@) that may have lower engagement rates.</p>" |
| 3615 | + }, |
| 3616 | + "IsDisposable":{ |
| 3617 | + "shape":"EmailAddressInsightsVerdict", |
| 3618 | + "documentation":"<p>Checks disposable or temporary email addresses that could negatively impact your sender reputation.</p>" |
| 3619 | + }, |
| 3620 | + "IsRandomInput":{ |
| 3621 | + "shape":"EmailAddressInsightsVerdict", |
| 3622 | + "documentation":"<p>Checks if the input appears to be random text.</p>" |
| 3623 | + } |
| 3624 | + }, |
| 3625 | + "documentation":"<p>Contains individual validation checks performed on an email address.</p>" |
| 3626 | + }, |
| 3627 | + "EmailAddressInsightsVerdict":{ |
| 3628 | + "type":"structure", |
| 3629 | + "members":{ |
| 3630 | + "ConfidenceVerdict":{ |
| 3631 | + "shape":"EmailAddressInsightsConfidenceVerdict", |
| 3632 | + "documentation":"<p>The confidence level of the validation verdict.</p>" |
| 3633 | + } |
| 3634 | + }, |
| 3635 | + "documentation":"<p>Contains the overall validation verdict for an email address.</p>" |
| 3636 | + }, |
3566 | 3637 | "EmailAddressList":{ |
3567 | 3638 | "type":"list", |
3568 | 3639 | "member":{"shape":"EmailAddress"} |
|
4242 | 4313 | "shape":"TemplateContent", |
4243 | 4314 | "documentation":"<p>The content of the custom verification email.</p>" |
4244 | 4315 | }, |
| 4316 | + "Tags":{ |
| 4317 | + "shape":"TagList", |
| 4318 | + "documentation":"<p>An array of objects that define the tags (keys and values) that are associated with the custom verification email template.</p>" |
| 4319 | + }, |
4245 | 4320 | "SuccessRedirectionURL":{ |
4246 | 4321 | "shape":"SuccessRedirectionURL", |
4247 | 4322 | "documentation":"<p>The URL that the recipient of the verification email is sent to if his or her address is successfully verified.</p>" |
|
4484 | 4559 | }, |
4485 | 4560 | "documentation":"<p>An object that includes statistics that are related to the domain that you specified.</p>" |
4486 | 4561 | }, |
| 4562 | + "GetEmailAddressInsightsRequest":{ |
| 4563 | + "type":"structure", |
| 4564 | + "required":["EmailAddress"], |
| 4565 | + "members":{ |
| 4566 | + "EmailAddress":{ |
| 4567 | + "shape":"EmailAddress", |
| 4568 | + "documentation":"<p>The email address to analyze for validation insights.</p>" |
| 4569 | + } |
| 4570 | + }, |
| 4571 | + "documentation":"<p>A request to return validation insights about an email address.</p>" |
| 4572 | + }, |
| 4573 | + "GetEmailAddressInsightsResponse":{ |
| 4574 | + "type":"structure", |
| 4575 | + "members":{ |
| 4576 | + "MailboxValidation":{ |
| 4577 | + "shape":"MailboxValidation", |
| 4578 | + "documentation":"<p>Detailed validation results for the email address.</p>" |
| 4579 | + } |
| 4580 | + }, |
| 4581 | + "documentation":"<p>Validation insights about an email address.</p>" |
| 4582 | + }, |
4487 | 4583 | "GetEmailIdentityPoliciesRequest":{ |
4488 | 4584 | "type":"structure", |
4489 | 4585 | "required":["EmailIdentity"], |
|
4593 | 4689 | "TemplateContent":{ |
4594 | 4690 | "shape":"EmailTemplateContent", |
4595 | 4691 | "documentation":"<p>The content of the email template, composed of a subject line, an HTML part, and a text-only part.</p>" |
| 4692 | + }, |
| 4693 | + "Tags":{ |
| 4694 | + "shape":"TagList", |
| 4695 | + "documentation":"<p>An array of objects that define the tags (keys and values) that are associated with the email template.</p>" |
4596 | 4696 | } |
4597 | 4697 | }, |
4598 | 4698 | "documentation":"<p>The following element is returned by the service.</p>" |
|
5936 | 6036 | "TRANSACTIONAL" |
5937 | 6037 | ] |
5938 | 6038 | }, |
| 6039 | + "MailboxValidation":{ |
| 6040 | + "type":"structure", |
| 6041 | + "members":{ |
| 6042 | + "IsValid":{ |
| 6043 | + "shape":"EmailAddressInsightsVerdict", |
| 6044 | + "documentation":"<p>Overall validity assessment with a confidence verdict.</p>" |
| 6045 | + }, |
| 6046 | + "Evaluations":{ |
| 6047 | + "shape":"EmailAddressInsightsMailboxEvaluations", |
| 6048 | + "documentation":"<p>Specific validation checks performed on the email address.</p>" |
| 6049 | + } |
| 6050 | + }, |
| 6051 | + "documentation":"<p>Contains detailed validation information about an email address.</p>" |
| 6052 | + }, |
5939 | 6053 | "Max24HourSend":{"type":"double"}, |
5940 | 6054 | "MaxDeliverySeconds":{ |
5941 | 6055 | "type":"long", |
|
6457 | 6571 | "SuppressedReasons":{ |
6458 | 6572 | "shape":"SuppressionListReasons", |
6459 | 6573 | "documentation":"<p>A list that contains the reasons that email addresses will be automatically added to the suppression list for your account. This list can contain any or all of the following:</p> <ul> <li> <p> <code>COMPLAINT</code> – Amazon SES adds an email address to the suppression list for your account when a message sent to that address results in a complaint.</p> </li> <li> <p> <code>BOUNCE</code> – Amazon SES adds an email address to the suppression list for your account when a message sent to that address results in a hard bounce.</p> </li> </ul>" |
| 6574 | + }, |
| 6575 | + "ValidationAttributes":{ |
| 6576 | + "shape":"SuppressionValidationAttributes", |
| 6577 | + "documentation":"<p>An object that contains additional suppression attributes for your account.</p>" |
6460 | 6578 | } |
6461 | 6579 | }, |
6462 | 6580 | "documentation":"<p>A request to change your account's suppression preferences.</p>" |
|
6590 | 6708 | "SuppressedReasons":{ |
6591 | 6709 | "shape":"SuppressionListReasons", |
6592 | 6710 | "documentation":"<p>A list that contains the reasons that email addresses are automatically added to the suppression list for your account. This list can contain any or all of the following:</p> <ul> <li> <p> <code>COMPLAINT</code> – Amazon SES adds an email address to the suppression list for your account when a message sent to that address results in a complaint.</p> </li> <li> <p> <code>BOUNCE</code> – Amazon SES adds an email address to the suppression list for your account when a message sent to that address results in a hard bounce.</p> </li> </ul>" |
| 6711 | + }, |
| 6712 | + "ValidationOptions":{ |
| 6713 | + "shape":"SuppressionValidationOptions", |
| 6714 | + "documentation":"<p>An object that contains information about the email address suppression preferences for the configuration set in the current Amazon Web Services Region.</p>" |
6593 | 6715 | } |
6594 | 6716 | }, |
6595 | 6717 | "documentation":"<p>A request to change the account suppression list preferences for a specific configuration set.</p>" |
|
7592 | 7714 | "SuppressedReasons":{ |
7593 | 7715 | "shape":"SuppressionListReasons", |
7594 | 7716 | "documentation":"<p>A list that contains the reasons that email addresses will be automatically added to the suppression list for your account. This list can contain any or all of the following:</p> <ul> <li> <p> <code>COMPLAINT</code> – Amazon SES adds an email address to the suppression list for your account when a message sent to that address results in a complaint.</p> </li> <li> <p> <code>BOUNCE</code> – Amazon SES adds an email address to the suppression list for your account when a message sent to that address results in a hard bounce.</p> </li> </ul>" |
7595 | | - } |
| 7717 | + }, |
| 7718 | + "ValidationAttributes":{"shape":"SuppressionValidationAttributes"} |
7596 | 7719 | }, |
7597 | 7720 | "documentation":"<p>An object that contains information about the email address suppression preferences for your account in the current Amazon Web Services Region.</p>" |
7598 | 7721 | }, |
| 7722 | + "SuppressionConditionThreshold":{ |
| 7723 | + "type":"structure", |
| 7724 | + "required":["ConditionThresholdEnabled"], |
| 7725 | + "members":{ |
| 7726 | + "ConditionThresholdEnabled":{ |
| 7727 | + "shape":"FeatureStatus", |
| 7728 | + "documentation":"<p>Indicates whether Auto Validation is enabled for suppression. Set to <code>ENABLED</code> to enable the Auto Validation feature, or set to <code>DISABLED</code> to disable it.</p>" |
| 7729 | + }, |
| 7730 | + "OverallConfidenceThreshold":{ |
| 7731 | + "shape":"SuppressionConfidenceThreshold", |
| 7732 | + "documentation":"<p>The overall confidence threshold used to determine suppression decisions.</p>" |
| 7733 | + } |
| 7734 | + }, |
| 7735 | + "documentation":"<p>Contains Auto Validation settings, allowing you to suppress sending to specific destination(s) if they do not meet required threshold. For details on Auto Validation, see <a href=\"https://docs.aws.amazon.com/ses/latest/DeveloperGuide/email-validation.html\">Auto Validation</a>.</p>" |
| 7736 | + }, |
| 7737 | + "SuppressionConfidenceThreshold":{ |
| 7738 | + "type":"structure", |
| 7739 | + "required":["ConfidenceVerdictThreshold"], |
| 7740 | + "members":{ |
| 7741 | + "ConfidenceVerdictThreshold":{ |
| 7742 | + "shape":"SuppressionConfidenceVerdictThreshold", |
| 7743 | + "documentation":"<p>The confidence level threshold for suppression decisions.</p>" |
| 7744 | + } |
| 7745 | + }, |
| 7746 | + "documentation":"<p>Contains the confidence threshold settings for Auto Validation.</p>" |
| 7747 | + }, |
| 7748 | + "SuppressionConfidenceVerdictThreshold":{ |
| 7749 | + "type":"string", |
| 7750 | + "documentation":"<p>The confidence level threshold for suppression validation:</p> <ul> <li> <p> <code>MEDIUM</code> – Allows emails to be sent to addresses with medium or high delivery likelihood.</p> </li> <li> <p> <code>HIGH</code> – Allows emails to be sent only to addresses with high delivery likelihood.</p> </li> <li> <p> <code>MANAGED</code> – Managed confidence threshold where Amazon SES automatically determines the appropriate level.</p> </li> </ul>", |
| 7751 | + "enum":[ |
| 7752 | + "MEDIUM", |
| 7753 | + "HIGH", |
| 7754 | + "MANAGED" |
| 7755 | + ] |
| 7756 | + }, |
7599 | 7757 | "SuppressionListDestination":{ |
7600 | 7758 | "type":"structure", |
7601 | 7759 | "required":["SuppressionListImportAction"], |
|
7633 | 7791 | "SuppressedReasons":{ |
7634 | 7792 | "shape":"SuppressionListReasons", |
7635 | 7793 | "documentation":"<p>A list that contains the reasons that email addresses are automatically added to the suppression list for your account. This list can contain any or all of the following:</p> <ul> <li> <p> <code>COMPLAINT</code> – Amazon SES adds an email address to the suppression list for your account when a message sent to that address results in a complaint.</p> </li> <li> <p> <code>BOUNCE</code> – Amazon SES adds an email address to the suppression list for your account when a message sent to that address results in a hard bounce.</p> </li> </ul>" |
7636 | | - } |
| 7794 | + }, |
| 7795 | + "ValidationOptions":{"shape":"SuppressionValidationOptions"} |
7637 | 7796 | }, |
7638 | 7797 | "documentation":"<p>An object that contains information about the suppression list preferences for your account.</p>" |
7639 | 7798 | }, |
| 7799 | + "SuppressionValidationAttributes":{ |
| 7800 | + "type":"structure", |
| 7801 | + "required":["ConditionThreshold"], |
| 7802 | + "members":{ |
| 7803 | + "ConditionThreshold":{ |
| 7804 | + "shape":"SuppressionConditionThreshold", |
| 7805 | + "documentation":"<p>Specifies the condition threshold settings for account-level suppression.</p>" |
| 7806 | + } |
| 7807 | + }, |
| 7808 | + "documentation":"<p>Structure containing validation attributes used for suppressing sending to specific destination on account level.</p>" |
| 7809 | + }, |
| 7810 | + "SuppressionValidationOptions":{ |
| 7811 | + "type":"structure", |
| 7812 | + "required":["ConditionThreshold"], |
| 7813 | + "members":{ |
| 7814 | + "ConditionThreshold":{ |
| 7815 | + "shape":"SuppressionConditionThreshold", |
| 7816 | + "documentation":"<p>Specifies the condition threshold settings for suppression validation.</p>" |
| 7817 | + } |
| 7818 | + }, |
| 7819 | + "documentation":"<p>Contains validation options for email address suppression.</p>" |
| 7820 | + }, |
7640 | 7821 | "Tag":{ |
7641 | 7822 | "type":"structure", |
7642 | 7823 | "required":[ |
|
0 commit comments