aws-sdk-for-zig/codegen/models/sesv2.2019-09-27.json

8940 lines
473 KiB
JSON
Raw Permalink Normal View History

2021-05-30 01:17:45 +00:00
{
"smithy": "1.0",
"metadata": {
"suppressions": [
{
"id": "HttpMethodSemantics",
"namespace": "*"
},
{
"id": "HttpResponseCodeSemantics",
"namespace": "*"
},
{
"id": "PaginatedTrait",
"namespace": "*"
},
{
"id": "HttpHeaderTrait",
"namespace": "*"
},
{
"id": "HttpUriConflict",
"namespace": "*"
},
{
"id": "Service",
"namespace": "*"
}
]
},
"shapes": {
"com.amazonaws.sesv2#AccountDetails": {
"type": "structure",
"members": {
"MailType": {
"target": "com.amazonaws.sesv2#MailType",
"traits": {
"smithy.api#documentation": "<p>The type of email your account is sending. The mail type can be one of the\n following:</p>\n <ul>\n <li>\n <p>\n <code>MARKETING</code> Most of your sending traffic is to keep your\n customers informed of your latest offering.</p>\n </li>\n <li>\n <p>\n <code>TRANSACTIONAL</code> Most of your sending traffic is to\n communicate during a transaction with a customer.</p>\n </li>\n </ul>"
}
},
"WebsiteURL": {
"target": "com.amazonaws.sesv2#WebsiteURL",
"traits": {
"smithy.api#documentation": "<p>The URL of your website. This information helps us better understand the type of\n content that you plan to send.</p>"
}
},
"ContactLanguage": {
"target": "com.amazonaws.sesv2#ContactLanguage",
"traits": {
"smithy.api#documentation": "<p>The language you would prefer for the case. The contact language can be one of\n <code>ENGLISH</code> or <code>JAPANESE</code>.</p>"
}
},
"UseCaseDescription": {
"target": "com.amazonaws.sesv2#UseCaseDescription",
"traits": {
"smithy.api#documentation": "<p>A description of the types of email that you plan to send.</p>"
}
},
"AdditionalContactEmailAddresses": {
"target": "com.amazonaws.sesv2#AdditionalContactEmailAddresses",
"traits": {
"smithy.api#documentation": "<p>Additional email addresses where updates are sent about your account review\n process.</p>"
}
},
"ReviewDetails": {
"target": "com.amazonaws.sesv2#ReviewDetails",
"traits": {
"smithy.api#documentation": "<p>Information about the review of the latest details you submitted.</p>"
}
}
},
"traits": {
"smithy.api#documentation": "<p>An object that contains information about your account details.</p>"
}
},
"com.amazonaws.sesv2#AccountSuspendedException": {
"type": "structure",
"members": {
"message": {
"target": "com.amazonaws.sesv2#ErrorMessage"
}
},
"traits": {
"smithy.api#documentation": "<p>The message can't be sent because the account's ability to send email has been\n permanently restricted.</p>",
"smithy.api#error": "client",
"smithy.api#httpError": 400
}
},
"com.amazonaws.sesv2#AdditionalContactEmailAddress": {
"type": "string",
"traits": {
"smithy.api#length": {
"min": 6,
"max": 254
},
"smithy.api#pattern": "^(.+)@(.+)$",
"smithy.api#sensitive": {}
}
},
"com.amazonaws.sesv2#AdditionalContactEmailAddresses": {
"type": "list",
"member": {
"target": "com.amazonaws.sesv2#AdditionalContactEmailAddress"
},
"traits": {
"smithy.api#length": {
"min": 1,
"max": 4
},
"smithy.api#sensitive": {}
}
},
"com.amazonaws.sesv2#AlreadyExistsException": {
"type": "structure",
"members": {
"message": {
"target": "com.amazonaws.sesv2#ErrorMessage"
}
},
"traits": {
"smithy.api#documentation": "<p>The resource specified in your request already exists.</p>",
"smithy.api#error": "client",
"smithy.api#httpError": 400
}
},
"com.amazonaws.sesv2#AmazonResourceName": {
"type": "string"
},
"com.amazonaws.sesv2#AttributesData": {
"type": "string"
},
"com.amazonaws.sesv2#BadRequestException": {
"type": "structure",
"members": {
"message": {
"target": "com.amazonaws.sesv2#ErrorMessage"
}
},
"traits": {
"smithy.api#documentation": "<p>The input you provided is invalid.</p>",
"smithy.api#error": "client",
"smithy.api#httpError": 400
}
},
"com.amazonaws.sesv2#BehaviorOnMxFailure": {
"type": "string",
"traits": {
"smithy.api#documentation": "<p>The action that you want to take if the required MX record can't be found when you\n send an email. When you set this value to <code>UseDefaultValue</code>, the mail is sent\n using <i>amazonses.com</i> as the MAIL FROM domain. When you set this\n value to <code>RejectMessage</code>, the Amazon SES API v2 returns a\n <code>MailFromDomainNotVerified</code> error, and doesn't attempt to deliver the\n email.</p>\n <p>These behaviors are taken when the custom MAIL FROM domain configuration is in the\n <code>Pending</code>, <code>Failed</code>, and <code>TemporaryFailure</code>\n states.</p>",
"smithy.api#enum": [
{
"value": "USE_DEFAULT_VALUE",
"name": "USE_DEFAULT_VALUE"
},
{
"value": "REJECT_MESSAGE",
"name": "REJECT_MESSAGE"
}
]
}
},
"com.amazonaws.sesv2#BlacklistEntries": {
"type": "list",
"member": {
"target": "com.amazonaws.sesv2#BlacklistEntry"
}
},
"com.amazonaws.sesv2#BlacklistEntry": {
"type": "structure",
"members": {
"RblName": {
"target": "com.amazonaws.sesv2#RblName",
"traits": {
"smithy.api#documentation": "<p>The name of the blacklist that the IP address appears on.</p>"
}
},
"ListingTime": {
"target": "com.amazonaws.sesv2#Timestamp",
"traits": {
"smithy.api#documentation": "<p>The time when the blacklisting event occurred, shown in Unix time format.</p>"
}
},
"Description": {
"target": "com.amazonaws.sesv2#BlacklistingDescription",
"traits": {
"smithy.api#documentation": "<p>Additional information about the blacklisting event, as provided by the blacklist\n maintainer.</p>"
}
}
},
"traits": {
"smithy.api#documentation": "<p>An object that contains information about a blacklisting event that impacts one of the\n dedicated IP addresses that is associated with your account.</p>"
}
},
"com.amazonaws.sesv2#BlacklistItemName": {
"type": "string",
"traits": {
"smithy.api#documentation": "<p>An IP address that you want to obtain blacklist information for.</p>"
}
},
"com.amazonaws.sesv2#BlacklistItemNames": {
"type": "list",
"member": {
"target": "com.amazonaws.sesv2#BlacklistItemName"
}
},
"com.amazonaws.sesv2#BlacklistReport": {
"type": "map",
"key": {
"target": "com.amazonaws.sesv2#BlacklistItemName"
},
"value": {
"target": "com.amazonaws.sesv2#BlacklistEntries"
}
},
"com.amazonaws.sesv2#BlacklistingDescription": {
"type": "string",
"traits": {
"smithy.api#documentation": "<p>A description of the blacklisting event.</p>"
}
},
"com.amazonaws.sesv2#Body": {
"type": "structure",
"members": {
"Text": {
"target": "com.amazonaws.sesv2#Content",
"traits": {
"smithy.api#documentation": "<p>An object that represents the version of the message that is displayed in email\n clients that don't support HTML, or clients where the recipient has disabled HTML\n rendering.</p>"
}
},
"Html": {
"target": "com.amazonaws.sesv2#Content",
"traits": {
"smithy.api#documentation": "<p>An object that represents the version of the message that is displayed in email\n clients that support HTML. HTML messages can include formatted text, hyperlinks, images,\n and more. </p>"
}
}
},
"traits": {
"smithy.api#documentation": "<p>Represents the body of the email message.</p>"
}
},
"com.amazonaws.sesv2#BulkEmailContent": {
"type": "structure",
"members": {
"Template": {
"target": "com.amazonaws.sesv2#Template",
"traits": {
"smithy.api#documentation": "<p>The template to use for the bulk email message.</p>"
}
}
},
"traits": {
"smithy.api#documentation": "<p>An object that contains the body of the message. You can specify a template\n message.</p>"
}
},
"com.amazonaws.sesv2#BulkEmailEntry": {
"type": "structure",
"members": {
"Destination": {
"target": "com.amazonaws.sesv2#Destination",
"traits": {
"smithy.api#documentation": "<p>Represents the destination of the message, consisting of To:, CC:, and BCC:\n fields.</p>\n <note>\n <p>Amazon SES does not support the SMTPUTF8 extension, as described in <a href=\"https://tools.ietf.org/html/rfc6531\">RFC6531</a>. For this reason, the\n local part of a destination email address (the part of the email address that\n precedes the @ sign) may only contain <a href=\"https://en.wikipedia.org/wiki/Email_address#Local-part\">7-bit ASCII\n characters</a>. If the domain part of an address (the part after the @ sign)\n contains non-ASCII characters, they must be encoded using Punycode, as described in\n <a href=\"https://tools.ietf.org/html/rfc3492.html\">RFC3492</a>.</p>\n </note>",
"smithy.api#required": {}
}
},
"ReplacementTags": {
"target": "com.amazonaws.sesv2#MessageTagList",
"traits": {
"smithy.api#documentation": "<p>A list of tags, in the form of name/value pairs, to apply to an email that you send\n using the <code>SendBulkTemplatedEmail</code> operation. Tags correspond to\n characteristics of the email that you define, so that you can publish email sending\n events.</p>"
}
},
"ReplacementEmailContent": {
"target": "com.amazonaws.sesv2#ReplacementEmailContent",
"traits": {
"smithy.api#documentation": "<p>The <code>ReplacementEmailContent</code> associated with a\n <code>BulkEmailEntry</code>.</p>"
}
}
}
},
"com.amazonaws.sesv2#BulkEmailEntryList": {
"type": "list",
"member": {
"target": "com.amazonaws.sesv2#BulkEmailEntry"
},
"traits": {
"smithy.api#documentation": "<p>A list of <code>BulkEmailEntry</code> objects.</p>"
}
},
"com.amazonaws.sesv2#BulkEmailEntryResult": {
"type": "structure",
"members": {
"Status": {
"target": "com.amazonaws.sesv2#BulkEmailStatus",
"traits": {
"smithy.api#documentation": "<p>The status of a message sent using the <code>SendBulkTemplatedEmail</code>\n operation.</p>\n <p>Possible values for this parameter include:</p>\n <ul>\n <li>\n <p>SUCCESS: Amazon SES accepted the message, and will attempt to deliver it to\n the recipients.</p>\n </li>\n <li>\n <p>MESSAGE_REJECTED: The message was rejected because it contained a\n virus.</p>\n </li>\n <li>\n <p>MAIL_FROM_DOMAIN_NOT_VERIFIED: The sender's email address or domain was not\n verified.</p>\n </li>\n <li>\n <p>CONFIGURATION_SET_DOES_NOT_EXIST: The configuration set you specified does not\n exist.</p>\n </li>\n <li>\n <p>TEMPLATE_DOES_NOT_EXIST: The template you specified does not exist.</p>\n </li>\n <li>\n <p>ACCOUNT_SUSPENDED: Your account has been shut down because of issues related\n to your email sending practices.</p>\n </li>\n <li>\n <p>ACCOUNT_THROTTLED: The number of emails you can send has been reduced because\n your account has exceeded its allocated sending limit.</p>\n </li>\n <li>\n <p>ACCOUNT_DAILY_QUOTA_EXCEEDED: You have reached or exceeded the maximum number\n of emails you can send from your account in a 24-hour period.</p>\n </li>\n <li>\n <p>INVALID_SENDING_POOL_NAME: The configuration set you specified refers to an IP\n pool that does not exist.</p>\n </li>\n <li>\n <p>ACCOUNT_SENDING_PAUSED: Email sending for the Amazon SES account was disabled\n using the <a href=\"https://docs.aws.amazon.com/ses/latest/APIReference/API_UpdateAccountSendingEnabled.html\">UpdateAccountSendingEnabled</a> operation.</p>\n </li>\n <li>\n <p>CONFIGURATION_SET_SENDING_PAUSED: Email sending for this configuration set was\n disabled using the <a href=\"https://docs.aws.amazon.com/ses/latest/APIReference/API_UpdateConfigurationSetSendingEnabled.html\">UpdateConfigurationSetSendingEnabled</a> operation.</p>\n </li>\n <li>\n <p>INVALID_PARAMETER_VALUE: One or more of the parameters you specified when\n calling this operation was invalid. See the error message for additional\n information.</p>\n </li>\n <li>\n <p>TRANSIENT_FAILURE: Amazon SES was unable to process your request because of a\n temporary issue.</p>\n </li>\n <li>\n <p>FAILED: Amazon SES was unable to process your request. See the error message\n for additional information.</p>\n </li>\n </ul>"
}
},
"Error": {
"target": "com.amazonaws.sesv2#ErrorMessage",
"traits": {
"smithy.api#documentation": "<p>A description of an error that prevented a message being sent using the\n <code>SendBulkTemplatedEmail</code> operation.</p>"
}
},
"MessageId": {
"target": "com.amazonaws.sesv2#OutboundMessageId",
"traits": {
"smithy.api#documentation": "<p>The unique message identifier returned from the <code>SendBulkTemplatedEmail</code>\n operation.</p>"
}
}
},
"traits": {
"smithy.api#documentation": "<p>The result of the <code>SendBulkEmail</code> operation of each specified\n <code>BulkEmailEntry</code>.</p>"
}
},
"com.amazonaws.sesv2#BulkEmailEntryResultList": {
"type": "list",
"member": {
"target": "com.amazonaws.sesv2#BulkEmailEntryResult"
},
"traits": {
"smithy.api#documentation": "<p>A list of <code>BulkMailEntry</code> objects.</p>"
}
},
"com.amazonaws.sesv2#BulkEmailStatus": {
"type": "string",
"traits": {
"smithy.api#enum": [
{
"value": "SUCCESS",
"name": "SUCCESS"
},
{
"value": "MESSAGE_REJECTED",
"name": "MESSAGE_REJECTED"
},
{
"value": "MAIL_FROM_DOMAIN_NOT_VERIFIED",
"name": "MAIL_FROM_DOMAIN_NOT_VERIFIED"
},
{
"value": "CONFIGURATION_SET_NOT_FOUND",
"name": "CONFIGURATION_SET_NOT_FOUND"
},
{
"value": "TEMPLATE_NOT_FOUND",
"name": "TEMPLATE_NOT_FOUND"
},
{
"value": "ACCOUNT_SUSPENDED",
"name": "ACCOUNT_SUSPENDED"
},
{
"value": "ACCOUNT_THROTTLED",
"name": "ACCOUNT_THROTTLED"
},
{
"value": "ACCOUNT_DAILY_QUOTA_EXCEEDED",
"name": "ACCOUNT_DAILY_QUOTA_EXCEEDED"
},
{
"value": "INVALID_SENDING_POOL_NAME",
"name": "INVALID_SENDING_POOL_NAME"
},
{
"value": "ACCOUNT_SENDING_PAUSED",
"name": "ACCOUNT_SENDING_PAUSED"
},
{
"value": "CONFIGURATION_SET_SENDING_PAUSED",
"name": "CONFIGURATION_SET_SENDING_PAUSED"
},
{
"value": "INVALID_PARAMETER",
"name": "INVALID_PARAMETER"
},
{
"value": "TRANSIENT_FAILURE",
"name": "TRANSIENT_FAILURE"
},
{
"value": "FAILED",
"name": "FAILED"
}
]
}
},
"com.amazonaws.sesv2#CampaignId": {
"type": "string"
},
"com.amazonaws.sesv2#CaseId": {
"type": "string"
},
"com.amazonaws.sesv2#Charset": {
"type": "string"
},
"com.amazonaws.sesv2#CloudWatchDestination": {
"type": "structure",
"members": {
"DimensionConfigurations": {
"target": "com.amazonaws.sesv2#CloudWatchDimensionConfigurations",
"traits": {
"smithy.api#documentation": "<p>An array of objects that define the dimensions to use when you send email events to\n Amazon CloudWatch.</p>",
"smithy.api#required": {}
}
}
},
"traits": {
"smithy.api#documentation": "<p>An object that defines an Amazon CloudWatch destination for email events. You can use Amazon CloudWatch to\n monitor and gain insights on your email sending metrics.</p>"
}
},
"com.amazonaws.sesv2#CloudWatchDimensionConfiguration": {
"type": "structure",
"members": {
"DimensionName": {
"target": "com.amazonaws.sesv2#DimensionName",
"traits": {
"smithy.api#documentation": "<p>The name of an Amazon CloudWatch dimension associated with an email sending metric. The name has to\n meet the following criteria:</p>\n <ul>\n <li>\n <p>It can only contain ASCII letters (az, AZ), numbers (09),\n underscores (_), or dashes (-).</p>\n </li>\n <li>\n <p>It can contain no more than 256 characters.</p>\n </li>\n </ul>",
"smithy.api#required": {}
}
},
"DimensionValueSource": {
"target": "com.amazonaws.sesv2#DimensionValueSource",
"traits": {
"smithy.api#documentation": "<p>The location where the Amazon SES API v2 finds the value of a dimension to publish to Amazon CloudWatch. If\n you want to use the message tags that you specify using an\n <code>X-SES-MESSAGE-TAGS</code> header or a parameter to the <code>SendEmail</code>\n or <code>SendRawEmail</code> API, choose <code>messageTag</code>. If you want to use\n your own email headers, choose <code>emailHeader</code>. If you want to use link tags,\n choose <code>linkTags</code>.</p>",
"smithy.api#required": {}
}
},
"DefaultDimensionValue": {
"target": "com.amazonaws.sesv2#DefaultDimensionValue",
"traits": {
"smithy.api#documentation": "<p>The default value of the dimension that is published to Amazon CloudWatch if you don't provide the\n value of the dimension when you send an email. This value has to meet the following\n criteria:</p>\n <ul>\n <li>\n <p>It can only contain ASCII letters (az, AZ), numbers (09),\n underscores (_), or dashes (-).</p>\n </li>\n <li>\n <p>It can contain no more than 256 characters.</p>\n </li>\n </ul>",
"smithy.api#required": {}
}
}
},
"traits": {
"smithy.api#documentation": "<p>An object that defines the dimension configuration to use when you send email events\n to Amazon CloudWatch.</p>"
}
},
"com.amazonaws.sesv2#CloudWatchDimensionConfigurations": {
"type": "list",
"member": {
"target": "com.amazonaws.sesv2#CloudWatchDimensionConfiguration"
}
},
"com.amazonaws.sesv2#ConcurrentModificationException": {
"type": "structure",
"members": {
"message": {
"target": "com.amazonaws.sesv2#ErrorMessage"
}
},
"traits": {
"smithy.api#documentation": "<p>The resource is being modified by another operation or thread.</p>",
"smithy.api#error": "server",
"smithy.api#httpError": 500
}
},
"com.amazonaws.sesv2#ConfigurationSetName": {
"type": "string",
"traits": {
"smithy.api#documentation": "<p>The name of a configuration set.</p>\n <p>\n <i>Configuration sets</i> are groups of rules that you can apply to the\n emails you send. You apply a configuration set to an email by including a reference to\n the configuration set in the headers of the email. When you apply a configuration set to\n an email, all of the rules in that configuration set are applied to the email.</p>"
}
},
"com.amazonaws.sesv2#ConfigurationSetNameList": {
"type": "list",
"member": {
"target": "com.amazonaws.sesv2#ConfigurationSetName"
}
},
"com.amazonaws.sesv2#ConflictException": {
"type": "structure",
"members": {
"message": {
"target": "com.amazonaws.sesv2#ErrorMessage"
}
},
"traits": {
"smithy.api#documentation": "<p>If there is already an ongoing account details update under review.</p>",
"smithy.api#error": "client",
"smithy.api#httpError": 409
}
},
"com.amazonaws.sesv2#Contact": {
"type": "structure",
"members": {
"EmailAddress": {
"target": "com.amazonaws.sesv2#EmailAddress",
"traits": {
"smithy.api#documentation": "<p>The contact's email address.</p>"
}
},
"TopicPreferences": {
"target": "com.amazonaws.sesv2#TopicPreferenceList",
"traits": {
"smithy.api#documentation": "<p>The contact's preference for being opted-in to or opted-out of a topic.</p>"
}
},
"TopicDefaultPreferences": {
"target": "com.amazonaws.sesv2#TopicPreferenceList",
"traits": {
"smithy.api#documentation": "<p>The default topic preferences applied to the contact.</p>"
}
},
"UnsubscribeAll": {
"target": "com.amazonaws.sesv2#UnsubscribeAll",
"traits": {
"smithy.api#documentation": "<p>A boolean value status noting if the contact is unsubscribed from all contact list\n topics.</p>"
}
},
"LastUpdatedTimestamp": {
"target": "com.amazonaws.sesv2#Timestamp",
"traits": {
"smithy.api#documentation": "<p>A timestamp noting the last time the contact's information was updated.</p>"
}
}
},
"traits": {
"smithy.api#documentation": "<p>A contact is the end-user who is receiving the email.</p>"
}
},
"com.amazonaws.sesv2#ContactLanguage": {
"type": "string",
"traits": {
"smithy.api#enum": [
{
"value": "EN",
"name": "EN"
},
{
"value": "JA",
"name": "JA"
}
]
}
},
"com.amazonaws.sesv2#ContactList": {
"type": "structure",
"members": {
"ContactListName": {
"target": "com.amazonaws.sesv2#ContactListName",
"traits": {
"smithy.api#documentation": "<p>The name of the contact list.</p>"
}
},
"LastUpdatedTimestamp": {
"target": "com.amazonaws.sesv2#Timestamp",
"traits": {
"smithy.api#documentation": "<p>A timestamp noting the last time the contact list was updated.</p>"
}
}
},
"traits": {
"smithy.api#documentation": "<p>A list that contains contacts that have subscribed to a particular topic or\n topics.</p>"
}
},
"com.amazonaws.sesv2#ContactListDestination": {
"type": "structure",
"members": {
"ContactListName": {
"target": "com.amazonaws.sesv2#ContactListName",
"traits": {
"smithy.api#documentation": "<p>The name of the contact list.</p>",
"smithy.api#required": {}
}
},
"ContactListImportAction": {
"target": "com.amazonaws.sesv2#ContactListImportAction",
"traits": {
"smithy.api#documentation": "<p>>The type of action that you want to perform on the addresses. Acceptable\n values:</p>\n <ul>\n <li>\n <p>PUT: add the addresses to the contact list. If the record already exists, it\n will override it with the new value.</p>\n </li>\n <li>\n <p>DELETE: remove the addresses from the contact list.</p>\n </li>\n </ul>",
"smithy.api#required": {}
}
}
},
"traits": {
"smithy.api#documentation": "<p>An object that contains details about the action of a contact list.</p>"
}
},
"com.amazonaws.sesv2#ContactListImportAction": {
"type": "string",
"traits": {
"smithy.api#enum": [
{
"value": "DELETE",
"name": "DELETE"
},
{
"value": "PUT",
"name": "PUT"
}
]
}
},
"com.amazonaws.sesv2#ContactListName": {
"type": "string"
},
"com.amazonaws.sesv2#Content": {
"type": "structure",
"members": {
"Data": {
"target": "com.amazonaws.sesv2#MessageData",
"traits": {
"smithy.api#documentation": "<p>The content of the message itself.</p>",
"smithy.api#required": {}
}
},
"Charset": {
"target": "com.amazonaws.sesv2#Charset",
"traits": {
"smithy.api#documentation": "<p>The character set for the content. Because of the constraints of the SMTP protocol,\n Amazon SES uses 7-bit ASCII by default. If the text includes characters outside of the ASCII\n range, you have to specify a character set. For example, you could specify\n <code>UTF-8</code>, <code>ISO-8859-1</code>, or <code>Shift_JIS</code>.</p>"
}
}
},
"traits": {
"smithy.api#documentation": "<p>An object that represents the content of the email, and optionally a character set\n specification.</p>"
}
},
"com.amazonaws.sesv2#CreateConfigurationSet": {
"type": "operation",
"input": {
"target": "com.amazonaws.sesv2#CreateConfigurationSetRequest"
},
"output": {
"target": "com.amazonaws.sesv2#CreateConfigurationSetResponse"
},
"errors": [
{
"target": "com.amazonaws.sesv2#AlreadyExistsException"
},
{
"target": "com.amazonaws.sesv2#BadRequestException"
},
{
"target": "com.amazonaws.sesv2#ConcurrentModificationException"
},
{
"target": "com.amazonaws.sesv2#LimitExceededException"
},
{
"target": "com.amazonaws.sesv2#NotFoundException"
},
{
"target": "com.amazonaws.sesv2#TooManyRequestsException"
}
],
"traits": {
"smithy.api#documentation": "<p>Create a configuration set. <i>Configuration sets</i> are groups of\n rules that you can apply to the emails that you send. You apply a configuration set to\n an email by specifying the name of the configuration set when you call the Amazon SES API v2. When\n you apply a configuration set to an email, all of the rules in that configuration set\n are applied to the email. </p>",
"smithy.api#http": {
"method": "POST",
"uri": "/v2/email/configuration-sets",
"code": 200
}
}
},
"com.amazonaws.sesv2#CreateConfigurationSetEventDestination": {
"type": "operation",
"input": {
"target": "com.amazonaws.sesv2#CreateConfigurationSetEventDestinationRequest"
},
"output": {
"target": "com.amazonaws.sesv2#CreateConfigurationSetEventDestinationResponse"
},
"errors": [
{
"target": "com.amazonaws.sesv2#AlreadyExistsException"
},
{
"target": "com.amazonaws.sesv2#BadRequestException"
},
{
"target": "com.amazonaws.sesv2#LimitExceededException"
},
{
"target": "com.amazonaws.sesv2#NotFoundException"
},
{
"target": "com.amazonaws.sesv2#TooManyRequestsException"
}
],
"traits": {
"smithy.api#documentation": "<p>Create an event destination. <i>Events</i> include message sends,\n deliveries, opens, clicks, bounces, and complaints. <i>Event\n destinations</i> are places that you can send information about these events\n to. For example, you can send event data to Amazon SNS to receive notifications when you\n receive bounces or complaints, or you can use Amazon Kinesis Data Firehose to stream data to Amazon S3 for long-term\n storage.</p>\n <p>A single configuration set can include more than one event destination.</p>",
"smithy.api#http": {
"method": "POST",
"uri": "/v2/email/configuration-sets/{ConfigurationSetName}/event-destinations",
"code": 200
}
}
},
"com.amazonaws.sesv2#CreateConfigurationSetEventDestinationRequest": {
"type": "structure",
"members": {
"ConfigurationSetName": {
"target": "com.amazonaws.sesv2#ConfigurationSetName",
"traits": {
"smithy.api#documentation": "<p>The name of the configuration set that you want to add an event destination to.</p>",
"smithy.api#httpLabel": {},
"smithy.api#required": {}
}
},
"EventDestinationName": {
"target": "com.amazonaws.sesv2#EventDestinationName",
"traits": {
"smithy.api#documentation": "<p>A name that identifies the event destination within the configuration set.</p>",
"smithy.api#required": {}
}
},
"EventDestination": {
"target": "com.amazonaws.sesv2#EventDestinationDefinition",
"traits": {
"smithy.api#documentation": "<p>An object that defines the event destination.</p>",
"smithy.api#required": {}
}
}
},
"traits": {
"smithy.api#documentation": "<p>A request to add an event destination to a configuration set.</p>"
}
},
"com.amazonaws.sesv2#CreateConfigurationSetEventDestinationResponse": {
"type": "structure",
"members": {},
"traits": {
"smithy.api#documentation": "<p>An HTTP 200 response if the request succeeds, or an error message if the request\n fails.</p>"
}
},
"com.amazonaws.sesv2#CreateConfigurationSetRequest": {
"type": "structure",
"members": {
"ConfigurationSetName": {
"target": "com.amazonaws.sesv2#ConfigurationSetName",
"traits": {
"smithy.api#documentation": "<p>The name of the configuration set.</p>",
"smithy.api#required": {}
}
},
"TrackingOptions": {
"target": "com.amazonaws.sesv2#TrackingOptions",
"traits": {
"smithy.api#documentation": "<p>An object that defines the open and click tracking options for emails that you send\n using the configuration set.</p>"
}
},
"DeliveryOptions": {
"target": "com.amazonaws.sesv2#DeliveryOptions",
"traits": {
"smithy.api#documentation": "<p>An object that defines the dedicated IP pool that is used to send emails that you send\n using the configuration set.</p>"
}
},
"ReputationOptions": {
"target": "com.amazonaws.sesv2#ReputationOptions",
"traits": {
"smithy.api#documentation": "<p>An object that defines whether or not Amazon SES collects reputation metrics for the emails\n that you send that use the configuration set.</p>"
}
},
"SendingOptions": {
"target": "com.amazonaws.sesv2#SendingOptions",
"traits": {
"smithy.api#documentation": "<p>An object that defines whether or not Amazon SES can send email that you send using the\n configuration set.</p>"
}
},
"Tags": {
"target": "com.amazonaws.sesv2#TagList",
"traits": {
"smithy.api#documentation": "<p>An array of objects that define the tags (keys and values) that you want to associate\n with the configuration set.</p>"
}
},
"SuppressionOptions": {
"target": "com.amazonaws.sesv2#SuppressionOptions"
}
},
"traits": {
"smithy.api#documentation": "<p>A request to create a configuration set.</p>"
}
},
"com.amazonaws.sesv2#CreateConfigurationSetResponse": {
"type": "structure",
"members": {},
"traits": {
"smithy.api#documentation": "<p>An HTTP 200 response if the request succeeds, or an error message if the request\n fails.</p>"
}
},
"com.amazonaws.sesv2#CreateContact": {
"type": "operation",
"input": {
"target": "com.amazonaws.sesv2#CreateContactRequest"
},
"output": {
"target": "com.amazonaws.sesv2#CreateContactResponse"
},
"errors": [
{
"target": "com.amazonaws.sesv2#AlreadyExistsException"
},
{
"target": "com.amazonaws.sesv2#BadRequestException"
},
{
"target": "com.amazonaws.sesv2#NotFoundException"
},
{
"target": "com.amazonaws.sesv2#TooManyRequestsException"
}
],
"traits": {
"smithy.api#documentation": "<p>Creates a contact, which is an end-user who is receiving the email, and adds them to a\n contact list.</p>",
"smithy.api#http": {
"method": "POST",
"uri": "/v2/email/contact-lists/{ContactListName}/contacts",
"code": 200
}
}
},
"com.amazonaws.sesv2#CreateContactList": {
"type": "operation",
"input": {
"target": "com.amazonaws.sesv2#CreateContactListRequest"
},
"output": {
"target": "com.amazonaws.sesv2#CreateContactListResponse"
},
"errors": [
{
"target": "com.amazonaws.sesv2#AlreadyExistsException"
},
{
"target": "com.amazonaws.sesv2#BadRequestException"
},
{
"target": "com.amazonaws.sesv2#LimitExceededException"
},
{
"target": "com.amazonaws.sesv2#TooManyRequestsException"
}
],
"traits": {
"smithy.api#documentation": "<p>Creates a contact list.</p>",
"smithy.api#http": {
"method": "POST",
"uri": "/v2/email/contact-lists",
"code": 200
}
}
},
"com.amazonaws.sesv2#CreateContactListRequest": {
"type": "structure",
"members": {
"ContactListName": {
"target": "com.amazonaws.sesv2#ContactListName",
"traits": {
"smithy.api#documentation": "<p>The name of the contact list.</p>",
"smithy.api#required": {}
}
},
"Topics": {
"target": "com.amazonaws.sesv2#Topics",
"traits": {
"smithy.api#documentation": "<p>An interest group, theme, or label within a list. A contact list can have multiple\n topics.</p>"
}
},
"Description": {
"target": "com.amazonaws.sesv2#Description",
"traits": {
"smithy.api#documentation": "<p>A description of what the contact list is about.</p>"
}
},
"Tags": {
"target": "com.amazonaws.sesv2#TagList",
"traits": {
"smithy.api#documentation": "<p>The tags associated with a contact list.</p>"
}
}
}
},
"com.amazonaws.sesv2#CreateContactListResponse": {
"type": "structure",
"members": {}
},
"com.amazonaws.sesv2#CreateContactRequest": {
"type": "structure",
"members": {
"ContactListName": {
"target": "com.amazonaws.sesv2#ContactListName",
"traits": {
"smithy.api#documentation": "<p>The name of the contact list to which the contact should be added.</p>",
"smithy.api#httpLabel": {},
"smithy.api#required": {}
}
},
"EmailAddress": {
"target": "com.amazonaws.sesv2#EmailAddress",
"traits": {
"smithy.api#documentation": "<p>The contact's email address.</p>",
"smithy.api#required": {}
}
},
"TopicPreferences": {
"target": "com.amazonaws.sesv2#TopicPreferenceList",
"traits": {
"smithy.api#documentation": "<p>The contact's preferences for being opted-in to or opted-out of topics.</p>"
}
},
"UnsubscribeAll": {
"target": "com.amazonaws.sesv2#UnsubscribeAll",
"traits": {
"smithy.api#documentation": "<p>A boolean value status noting if the contact is unsubscribed from all contact list\n topics.</p>"
}
},
"AttributesData": {
"target": "com.amazonaws.sesv2#AttributesData",
"traits": {
"smithy.api#documentation": "<p>The attribute data attached to a contact.</p>"
}
}
}
},
"com.amazonaws.sesv2#CreateContactResponse": {
"type": "structure",
"members": {}
},
"com.amazonaws.sesv2#CreateCustomVerificationEmailTemplate": {
"type": "operation",
"input": {
"target": "com.amazonaws.sesv2#CreateCustomVerificationEmailTemplateRequest"
},
"output": {
"target": "com.amazonaws.sesv2#CreateCustomVerificationEmailTemplateResponse"
},
"errors": [
{
"target": "com.amazonaws.sesv2#AlreadyExistsException"
},
{
"target": "com.amazonaws.sesv2#BadRequestException"
},
{
"target": "com.amazonaws.sesv2#LimitExceededException"
},
{
"target": "com.amazonaws.sesv2#NotFoundException"
},
{
"target": "com.amazonaws.sesv2#TooManyRequestsException"
}
],
"traits": {
"smithy.api#documentation": "<p>Creates a new custom verification email template.</p>\n <p>For more information about custom verification email templates, see <a href=\"https://docs.aws.amazon.com/ses/latest/DeveloperGuide/send-email-verify-address-custom.html\">Using Custom Verification Email Templates</a> in the <i>Amazon SES Developer\n Guide</i>.</p>\n <p>You can execute this operation no more than once per second.</p>",
"smithy.api#http": {
"method": "POST",
"uri": "/v2/email/custom-verification-email-templates",
"code": 200
}
}
},
"com.amazonaws.sesv2#CreateCustomVerificationEmailTemplateRequest": {
"type": "structure",
"members": {
"TemplateName": {
"target": "com.amazonaws.sesv2#EmailTemplateName",
"traits": {
"smithy.api#documentation": "<p>The name of the custom verification email template.</p>",
"smithy.api#required": {}
}
},
"FromEmailAddress": {
"target": "com.amazonaws.sesv2#EmailAddress",
"traits": {
"smithy.api#documentation": "<p>The email address that the custom verification email is sent from.</p>",
"smithy.api#required": {}
}
},
"TemplateSubject": {
"target": "com.amazonaws.sesv2#EmailTemplateSubject",
"traits": {
"smithy.api#documentation": "<p>The subject line of the custom verification email.</p>",
"smithy.api#required": {}
}
},
"TemplateContent": {
"target": "com.amazonaws.sesv2#TemplateContent",
"traits": {
"smithy.api#documentation": "<p>The content of the custom verification email. The total size of the email must be less\n than 10 MB. The message body may contain HTML, with some limitations. For more\n information, see <a href=\"https://docs.aws.amazon.com/ses/latest/DeveloperGuide/send-email-verify-address-custom.html#custom-verification-emails-faq\">Custom Verification Email Frequently Asked Questions</a> in the <i>Amazon SES\n Developer Guide</i>.</p>",
"smithy.api#required": {}
}
},
"SuccessRedirectionURL": {
"target": "com.amazonaws.sesv2#SuccessRedirectionURL",
"traits": {
"smithy.api#documentation": "<p>The URL that the recipient of the verification email is sent to if his or her address\n is successfully verified.</p>",
"smithy.api#required": {}
}
},
"FailureRedirectionURL": {
"target": "com.amazonaws.sesv2#FailureRedirectionURL",
"traits": {
"smithy.api#documentation": "<p>The URL that the recipient of the verification email is sent to if his or her address\n is not successfully verified.</p>",
"smithy.api#required": {}
}
}
},
"traits": {
"smithy.api#documentation": "<p>Represents a request to create a custom verification email template.</p>"
}
},
"com.amazonaws.sesv2#CreateCustomVerificationEmailTemplateResponse": {
"type": "structure",
"members": {},
"traits": {
"smithy.api#documentation": "<p>If the action is successful, the service sends back an HTTP 200 response with an empty\n HTTP body.</p>"
}
},
"com.amazonaws.sesv2#CreateDedicatedIpPool": {
"type": "operation",
"input": {
"target": "com.amazonaws.sesv2#CreateDedicatedIpPoolRequest"
},
"output": {
"target": "com.amazonaws.sesv2#CreateDedicatedIpPoolResponse"
},
"errors": [
{
"target": "com.amazonaws.sesv2#AlreadyExistsException"
},
{
"target": "com.amazonaws.sesv2#BadRequestException"
},
{
"target": "com.amazonaws.sesv2#ConcurrentModificationException"
},
{
"target": "com.amazonaws.sesv2#LimitExceededException"
},
{
"target": "com.amazonaws.sesv2#TooManyRequestsException"
}
],
"traits": {
"smithy.api#documentation": "<p>Create a new pool of dedicated IP addresses. A pool can include one or more dedicated\n IP addresses that are associated with your AWS account. You can associate a pool with\n a configuration set. When you send an email that uses that configuration set, the\n message is sent from one of the addresses in the associated pool.</p>",
"smithy.api#http": {
"method": "POST",
"uri": "/v2/email/dedicated-ip-pools",
"code": 200
}
}
},
"com.amazonaws.sesv2#CreateDedicatedIpPoolRequest": {
"type": "structure",
"members": {
"PoolName": {
"target": "com.amazonaws.sesv2#PoolName",
"traits": {
"smithy.api#documentation": "<p>The name of the dedicated IP pool.</p>",
"smithy.api#required": {}
}
},
"Tags": {
"target": "com.amazonaws.sesv2#TagList",
"traits": {
"smithy.api#documentation": "<p>An object that defines the tags (keys and values) that you want to associate with the\n pool.</p>"
}
}
},
"traits": {
"smithy.api#documentation": "<p>A request to create a new dedicated IP pool.</p>"
}
},
"com.amazonaws.sesv2#CreateDedicatedIpPoolResponse": {
"type": "structure",
"members": {},
"traits": {
"smithy.api#documentation": "<p>An HTTP 200 response if the request succeeds, or an error message if the request\n fails.</p>"
}
},
"com.amazonaws.sesv2#CreateDeliverabilityTestReport": {
"type": "operation",
"input": {
"target": "com.amazonaws.sesv2#CreateDeliverabilityTestReportRequest"
},
"output": {
"target": "com.amazonaws.sesv2#CreateDeliverabilityTestReportResponse"
},
"errors": [
{
"target": "com.amazonaws.sesv2#AccountSuspendedException"
},
{
"target": "com.amazonaws.sesv2#BadRequestException"
},
{
"target": "com.amazonaws.sesv2#ConcurrentModificationException"
},
{
"target": "com.amazonaws.sesv2#LimitExceededException"
},
{
"target": "com.amazonaws.sesv2#MailFromDomainNotVerifiedException"
},
{
"target": "com.amazonaws.sesv2#MessageRejected"
},
{
"target": "com.amazonaws.sesv2#NotFoundException"
},
{
"target": "com.amazonaws.sesv2#SendingPausedException"
},
{
"target": "com.amazonaws.sesv2#TooManyRequestsException"
}
],
"traits": {
"smithy.api#documentation": "<p>Create a new predictive inbox placement test. Predictive inbox placement tests can help you predict how your messages will be handled\n by various email providers around the world. When you perform a predictive inbox placement test, you provide a\n sample message that contains the content that you plan to send to your customers. Amazon SES\n then sends that message to special email addresses spread across several major email\n providers. After about 24 hours, the test is complete, and you can use the\n <code>GetDeliverabilityTestReport</code> operation to view the results of the\n test.</p>",
"smithy.api#http": {
"method": "POST",
"uri": "/v2/email/deliverability-dashboard/test",
"code": 200
}
}
},
"com.amazonaws.sesv2#CreateDeliverabilityTestReportRequest": {
"type": "structure",
"members": {
"ReportName": {
"target": "com.amazonaws.sesv2#ReportName",
"traits": {
"smithy.api#documentation": "<p>A unique name that helps you to identify the predictive inbox placement test when you retrieve the\n results.</p>"
}
},
"FromEmailAddress": {
"target": "com.amazonaws.sesv2#EmailAddress",
"traits": {
"smithy.api#documentation": "<p>The email address that the predictive inbox placement test email was sent from.</p>",
"smithy.api#required": {}
}
},
"Content": {
"target": "com.amazonaws.sesv2#EmailContent",
"traits": {
"smithy.api#documentation": "<p>The HTML body of the message that you sent when you performed the predictive inbox placement test.</p>",
"smithy.api#required": {}
}
},
"Tags": {
"target": "com.amazonaws.sesv2#TagList",
"traits": {
"smithy.api#documentation": "<p>An array of objects that define the tags (keys and values) that you want to associate\n with the predictive inbox placement test.</p>"
}
}
},
"traits": {
"smithy.api#documentation": "<p>A request to perform a predictive inbox placement test. Predictive inbox placement tests can help you predict how your messages will\n be handled by various email providers around the world. When you perform a predictive inbox placement test, you\n provide a sample message that contains the content that you plan to send to your\n customers. We send that message to special email addresses spread across several major\n email providers around the world. The test takes about 24 hours to complete. When the\n test is complete, you can use the <code>GetDeliverabilityTestReport</code> operation to\n view the results of the test.</p>"
}
},
"com.amazonaws.sesv2#CreateDeliverabilityTestReportResponse": {
"type": "structure",
"members": {
"ReportId": {
"target": "com.amazonaws.sesv2#ReportId",
"traits": {
"smithy.api#documentation": "<p>A unique string that identifies the predictive inbox placement test.</p>",
"smithy.api#required": {}
}
},
"DeliverabilityTestStatus": {
"target": "com.amazonaws.sesv2#DeliverabilityTestStatus",
"traits": {
"smithy.api#documentation": "<p>The status of the predictive inbox placement test. If the status is <code>IN_PROGRESS</code>, then the predictive inbox placement test\n is currently running. Predictive inbox placement tests are usually complete within 24 hours of creating the\n test. If the status is <code>COMPLETE</code>, then the test is finished, and you can use\n the <code>GetDeliverabilityTestReport</code> to view the results of the test.</p>",
"smithy.api#required": {}
}
}
},
"traits": {
"smithy.api#documentation": "<p>Information about the predictive inbox placement test that you created.</p>"
}
},
"com.amazonaws.sesv2#CreateEmailIdentity": {
"type": "operation",
"input": {
"target": "com.amazonaws.sesv2#CreateEmailIdentityRequest"
},
"output": {
"target": "com.amazonaws.sesv2#CreateEmailIdentityResponse"
},
"errors": [
{
"target": "com.amazonaws.sesv2#AlreadyExistsException"
},
{
"target": "com.amazonaws.sesv2#BadRequestException"
},
{
"target": "com.amazonaws.sesv2#ConcurrentModificationException"
},
{
"target": "com.amazonaws.sesv2#LimitExceededException"
},
{
"target": "com.amazonaws.sesv2#NotFoundException"
},
{
"target": "com.amazonaws.sesv2#TooManyRequestsException"
}
],
"traits": {
"smithy.api#documentation": "<p>Starts the process of verifying an email identity. An <i>identity</i> is\n an email address or domain that you use when you send email. Before you can use an\n identity to send email, you first have to verify it. By verifying an identity, you\n demonstrate that you're the owner of the identity, and that you've given Amazon SES API v2\n permission to send email from the identity.</p>\n <p>When you verify an email address, Amazon SES sends an email to the address. Your email\n address is verified as soon as you follow the link in the verification email.\n \n </p>\n <p>When you verify a domain without specifying the <code>DkimSigningAttributes</code>\n object, this operation provides a set of DKIM tokens. You can convert these tokens into\n CNAME records, which you then add to the DNS configuration for your domain. Your domain\n is verified when Amazon SES detects these records in the DNS configuration for your domain.\n This verification method is known as <a href=\"https://docs.aws.amazon.com/ses/latest/DeveloperGuide/easy-dkim.html\">Easy DKIM</a>.</p>\n <p>Alternatively, you can perform the verification process by providing your own\n public-private key pair. This verification method is known as Bring Your Own DKIM\n (BYODKIM). To use BYODKIM, your call to the <code>CreateEmailIdentity</code> operation\n has to include the <code>DkimSigningAttributes</code> object. When you specify this\n object, you provide a selector (a component of the DNS record name that identifies the\n public key that you want to use for DKIM authentication) and a private key.</p>\n <p>When you verify a domain, this operation provides a set of DKIM tokens, which you can\n convert into CNAME tokens. You add these CNAME tokens to the DNS configuration for your\n domain. Your domain is verified when Amazon SES detects these records in the DNS\n configuration for your domain. For some DNS providers, it can take 72 hours or more to\n complete the domain verification process.</p>\n <p>Additionally, you can associate an existing configuration set with the email identity that you're verifying.</p>",
"smithy.api#http": {
"method": "POST",
"uri": "/v2/email/identities",
"code": 200
}
}
},
"com.amazonaws.sesv2#CreateEmailIdentityPolicy": {
"type": "operation",
"input": {
"target": "com.amazonaws.sesv2#CreateEmailIdentityPolicyRequest"
},
"output": {
"target": "com.amazonaws.sesv2#CreateEmailIdentityPolicyResponse"
},
"errors": [
{
"target": "com.amazonaws.sesv2#AlreadyExistsException"
},
{
"target": "com.amazonaws.sesv2#BadRequestException"
},
{
"target": "com.amazonaws.sesv2#LimitExceededException"
},
{
"target": "com.amazonaws.sesv2#NotFoundException"
},
{
"target": "com.amazonaws.sesv2#TooManyRequestsException"
}
],
"traits": {
"smithy.api#documentation": "<p>Creates the specified sending authorization policy for the given identity (an email\n address or a domain).</p>\n <note>\n <p>This API is for the identity owner only. If you have not verified the identity,\n this API will return an error.</p>\n </note>\n <p>Sending authorization is a feature that enables an identity owner to authorize other\n senders to use its identities. For information about using sending authorization, see\n the <a href=\"https://docs.aws.amazon.com/ses/latest/DeveloperGuide/sending-authorization.html\">Amazon SES Developer\n Guide</a>.</p>\n \n <p>You can execute this operation no more than once per second.</p>",
"smithy.api#http": {
"method": "POST",
"uri": "/v2/email/identities/{EmailIdentity}/policies/{PolicyName}",
"code": 200
}
}
},
"com.amazonaws.sesv2#CreateEmailIdentityPolicyRequest": {
"type": "structure",
"members": {
"EmailIdentity": {
"target": "com.amazonaws.sesv2#Identity",
"traits": {
"smithy.api#documentation": "<p>The email identity for which you want to create a policy.</p>",
"smithy.api#httpLabel": {},
"smithy.api#required": {}
}
},
"PolicyName": {
"target": "com.amazonaws.sesv2#PolicyName",
"traits": {
"smithy.api#documentation": "<p>The name of the policy.</p>\n\n <p>The policy name cannot exceed 64 characters and can only include alphanumeric\n characters, dashes, and underscores.</p>",
"smithy.api#httpLabel": {},
"smithy.api#required": {}
}
},
"Policy": {
"target": "com.amazonaws.sesv2#Policy",
"traits": {
"smithy.api#documentation": "<p>The text of the policy in JSON format. The policy cannot exceed 4 KB.</p>\n <p>For information about the syntax of sending authorization policies, see the <a href=\"https://docs.aws.amazon.com/ses/latest/DeveloperGuide/sending-authorization-policies.html\">Amazon SES Developer\n Guide</a>.</p>",
"smithy.api#required": {}
}
}
},
"traits": {
"smithy.api#documentation": "<p>Represents a request to create a sending authorization policy for an identity. Sending\n authorization is an Amazon SES feature that enables you to authorize other senders to use\n your identities. For information, see the <a href=\"https://docs.aws.amazon.com/ses/latest/DeveloperGuide/sending-authorization-identity-owner-tasks-management.html\">Amazon SES Developer Guide</a>.</p>"
}
},
"com.amazonaws.sesv2#CreateEmailIdentityPolicyResponse": {
"type": "structure",
"members": {},
"traits": {
"smithy.api#documentation": "<p>An HTTP 200 response if the request succeeds, or an error message if the request\n fails.</p>"
}
},
"com.amazonaws.sesv2#CreateEmailIdentityRequest": {
"type": "structure",
"members": {
"EmailIdentity": {
"target": "com.amazonaws.sesv2#Identity",
"traits": {
"smithy.api#documentation": "<p>The email address or domain that you want to verify.</p>",
"smithy.api#required": {}
}
},
"Tags": {
"target": "com.amazonaws.sesv2#TagList",
"traits": {
"smithy.api#documentation": "<p>An array of objects that define the tags (keys and values) that you want to associate\n with the email identity.</p>"
}
},
"DkimSigningAttributes": {
"target": "com.amazonaws.sesv2#DkimSigningAttributes",
"traits": {
"smithy.api#documentation": "<p>If your request includes this object, Amazon SES configures the identity to use Bring Your\n Own DKIM (BYODKIM) for DKIM authentication purposes, as opposed to the default method,\n <a href=\"https://docs.aws.amazon.com/ses/latest/DeveloperGuide/easy-dkim.html\">Easy\n DKIM</a>.</p>\n <p>You can only specify this object if the email identity is a domain, as opposed to an\n address.</p>"
}
},
"ConfigurationSetName": {
"target": "com.amazonaws.sesv2#ConfigurationSetName",
"traits": {
"smithy.api#documentation": "<p>The configuration set to use by default when sending from this identity.\n Note that any configuration set defined in the email sending request takes precedence.\n </p>"
}
}
},
"traits": {
"smithy.api#documentation": "<p>A request to begin the verification process for an email identity (an email address or\n domain).</p>"
}
},
"com.amazonaws.sesv2#CreateEmailIdentityResponse": {
"type": "structure",
"members": {
"IdentityType": {
"target": "com.amazonaws.sesv2#IdentityType",
"traits": {
"smithy.api#documentation": "<p>The email identity type.</p>"
}
},
"VerifiedForSendingStatus": {
"target": "com.amazonaws.sesv2#Enabled",
"traits": {
"smithy.api#documentation": "<p>Specifies whether or not the identity is verified. You can only send email from\n verified email addresses or domains. For more information about verifying identities,\n see the <a href=\"https://docs.aws.amazon.com/pinpoint/latest/userguide/channels-email-manage-verify.html\">Amazon Pinpoint User Guide</a>.</p>"
}
},
"DkimAttributes": {
"target": "com.amazonaws.sesv2#DkimAttributes",
"traits": {
"smithy.api#documentation": "<p>An object that contains information about the DKIM attributes for the identity.</p>"
}
}
},
"traits": {
"smithy.api#documentation": "<p>If the email identity is a domain, this object contains information about the DKIM\n verification status for the domain.</p>\n <p>If the email identity is an email address, this object is empty. </p>"
}
},
"com.amazonaws.sesv2#CreateEmailTemplate": {
"type": "operation",
"input": {
"target": "com.amazonaws.sesv2#CreateEmailTemplateRequest"
},
"output": {
"target": "com.amazonaws.sesv2#CreateEmailTemplateResponse"
},
"errors": [
{
"target": "com.amazonaws.sesv2#AlreadyExistsException"
},
{
"target": "com.amazonaws.sesv2#BadRequestException"
},
{
"target": "com.amazonaws.sesv2#LimitExceededException"
},
{
"target": "com.amazonaws.sesv2#TooManyRequestsException"
}
],
"traits": {
"smithy.api#documentation": "<p>Creates an email template. Email templates enable you to send personalized email to\n one or more destinations in a single API operation. For more information, see the <a href=\"https://docs.aws.amazon.com/ses/latest/DeveloperGuide/send-personalized-email-api.html\">Amazon SES\n Developer Guide</a>.</p>\n <p>You can execute this operation no more than once per second.</p>",
"smithy.api#http": {
"method": "POST",
"uri": "/v2/email/templates",
"code": 200
}
}
},
"com.amazonaws.sesv2#CreateEmailTemplateRequest": {
"type": "structure",
"members": {
"TemplateName": {
"target": "com.amazonaws.sesv2#EmailTemplateName",
"traits": {
"smithy.api#documentation": "<p>The name of the template you want to create.</p>",
"smithy.api#required": {}
}
},
"TemplateContent": {
"target": "com.amazonaws.sesv2#EmailTemplateContent",
"traits": {
"smithy.api#documentation": "<p>The content of the email template, composed of a subject line, an HTML part, and a\n text-only part.</p>",
"smithy.api#required": {}
}
}
},
"traits": {
"smithy.api#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\n Developer Guide</a>.</p>"
}
},
"com.amazonaws.sesv2#CreateEmailTemplateResponse": {
"type": "structure",
"members": {},
"traits": {
"smithy.api#documentation": "<p>If the action is successful, the service sends back an HTTP 200 response with an empty\n HTTP body.</p>"
}
},
"com.amazonaws.sesv2#CreateImportJob": {
"type": "operation",
"input": {
"target": "com.amazonaws.sesv2#CreateImportJobRequest"
},
"output": {
"target": "com.amazonaws.sesv2#CreateImportJobResponse"
},
"errors": [
{
"target": "com.amazonaws.sesv2#BadRequestException"
},
{
"target": "com.amazonaws.sesv2#LimitExceededException"
},
{
"target": "com.amazonaws.sesv2#TooManyRequestsException"
}
],
"traits": {
"smithy.api#documentation": "<p>Creates an import job for a data destination.</p>",
"smithy.api#http": {
"method": "POST",
"uri": "/v2/email/import-jobs",
"code": 200
}
}
},
"com.amazonaws.sesv2#CreateImportJobRequest": {
"type": "structure",
"members": {
"ImportDestination": {
"target": "com.amazonaws.sesv2#ImportDestination",
"traits": {
"smithy.api#documentation": "<p>The destination for the import job.</p>",
"smithy.api#required": {}
}
},
"ImportDataSource": {
"target": "com.amazonaws.sesv2#ImportDataSource",
"traits": {
"smithy.api#documentation": "<p>The data source for the import job.</p>",
"smithy.api#required": {}
}
}
},
"traits": {
"smithy.api#documentation": "<p>Represents a request to create an import job from a data source for a data\n destination.</p>"
}
},
"com.amazonaws.sesv2#CreateImportJobResponse": {
"type": "structure",
"members": {
"JobId": {
"target": "com.amazonaws.sesv2#JobId",
"traits": {
"smithy.api#documentation": "<p>A string that represents the import job ID.</p>"
}
}
},
"traits": {
"smithy.api#documentation": "<p>An HTTP 200 response if the request succeeds, or an error message if the request\n fails.</p>"
}
},
"com.amazonaws.sesv2#CustomRedirectDomain": {
"type": "string",
"traits": {
"smithy.api#documentation": "<p>The domain that you want to use for tracking open and click events.</p>"
}
},
"com.amazonaws.sesv2#CustomVerificationEmailTemplateMetadata": {
"type": "structure",
"members": {
"TemplateName": {
"target": "com.amazonaws.sesv2#EmailTemplateName",
"traits": {
"smithy.api#documentation": "<p>The name of the custom verification email template.</p>"
}
},
"FromEmailAddress": {
"target": "com.amazonaws.sesv2#EmailAddress",
"traits": {
"smithy.api#documentation": "<p>The email address that the custom verification email is sent from.</p>"
}
},
"TemplateSubject": {
"target": "com.amazonaws.sesv2#EmailTemplateSubject",
"traits": {
"smithy.api#documentation": "<p>The subject line of the custom verification email.</p>"
}
},
"SuccessRedirectionURL": {
"target": "com.amazonaws.sesv2#SuccessRedirectionURL",
"traits": {
"smithy.api#documentation": "<p>The URL that the recipient of the verification email is sent to if his or her address\n is successfully verified.</p>"
}
},
"FailureRedirectionURL": {
"target": "com.amazonaws.sesv2#FailureRedirectionURL",
"traits": {
"smithy.api#documentation": "<p>The URL that the recipient of the verification email is sent to if his or her address\n is not successfully verified.</p>"
}
}
},
"traits": {
"smithy.api#documentation": "<p>Contains information about a custom verification email template.</p>"
}
},
"com.amazonaws.sesv2#CustomVerificationEmailTemplatesList": {
"type": "list",
"member": {
"target": "com.amazonaws.sesv2#CustomVerificationEmailTemplateMetadata"
},
"traits": {
"smithy.api#documentation": "<p>A list of the custom verification email templates that exist in your account.</p>"
}
},
"com.amazonaws.sesv2#DailyVolume": {
"type": "structure",
"members": {
"StartDate": {
"target": "com.amazonaws.sesv2#Timestamp",
"traits": {
"smithy.api#documentation": "<p>The date that the DailyVolume metrics apply to, in Unix time.</p>"
}
},
"VolumeStatistics": {
"target": "com.amazonaws.sesv2#VolumeStatistics",
"traits": {
"smithy.api#documentation": "<p>An object that contains inbox placement metrics for a specific day in the analysis\n period.</p>"
}
},
"DomainIspPlacements": {
"target": "com.amazonaws.sesv2#DomainIspPlacements",
"traits": {
"smithy.api#documentation": "<p>An object that contains inbox placement metrics for a specified day in the analysis\n period, broken out by the recipient's email provider.</p>"
}
}
},
"traits": {
"smithy.api#documentation": "<p>An object that contains information about the volume of email sent on each day of the\n analysis period.</p>"
}
},
"com.amazonaws.sesv2#DailyVolumes": {
"type": "list",
"member": {
"target": "com.amazonaws.sesv2#DailyVolume"
}
},
"com.amazonaws.sesv2#DataFormat": {
"type": "string",
"traits": {
"smithy.api#documentation": "<p>The data format of the import job's data source.</p>",
"smithy.api#enum": [
{
"value": "CSV",
"name": "CSV"
},
{
"value": "JSON",
"name": "JSON"
}
]
}
},
"com.amazonaws.sesv2#DedicatedIp": {
"type": "structure",
"members": {
"Ip": {
"target": "com.amazonaws.sesv2#Ip",
"traits": {
"smithy.api#documentation": "<p>An IPv4 address.</p>",
"smithy.api#required": {}
}
},
"WarmupStatus": {
"target": "com.amazonaws.sesv2#WarmupStatus",
"traits": {
"smithy.api#documentation": "<p>The warm-up status of a dedicated IP address. The status can have one of the following\n values:</p>\n <ul>\n <li>\n <p>\n <code>IN_PROGRESS</code> The IP address isn't ready to use because the\n dedicated IP warm-up process is ongoing.</p>\n </li>\n <li>\n <p>\n <code>DONE</code> The dedicated IP warm-up process is complete, and\n the IP address is ready to use.</p>\n </li>\n </ul>",
"smithy.api#required": {}
}
},
"WarmupPercentage": {
"target": "com.amazonaws.sesv2#Percentage100Wrapper",
"traits": {
"smithy.api#documentation": "<p>Indicates how complete the dedicated IP warm-up process is. When this value equals 1,\n the address has completed the warm-up process and is ready for use.</p>",
"smithy.api#required": {}
}
},
"PoolName": {
"target": "com.amazonaws.sesv2#PoolName",
"traits": {
"smithy.api#documentation": "<p>The name of the dedicated IP pool that the IP address is associated with.</p>"
}
}
},
"traits": {
"smithy.api#documentation": "<p>Contains information about a dedicated IP address that is associated with your Amazon SES\n account.</p>\n <p>To learn more about requesting dedicated IP addresses, see <a href=\"https://docs.aws.amazon.com/ses/latest/DeveloperGuide/dedicated-ip-case.html\">Requesting and Relinquishing\n Dedicated IP Addresses</a> in the <i>Amazon SES Developer\n Guide</i>.</p>"
}
},
"com.amazonaws.sesv2#DedicatedIpList": {
"type": "list",
"member": {
"target": "com.amazonaws.sesv2#DedicatedIp"
},
"traits": {
"smithy.api#documentation": "<p>A list of dedicated IP addresses that are associated with your AWS account.</p>"
}
},
"com.amazonaws.sesv2#DefaultDimensionValue": {
"type": "string",
"traits": {
"smithy.api#documentation": "<p>The default value of the dimension that is published to Amazon CloudWatch if you don't provide the\n value of the dimension when you send an email. This value has to meet the following\n criteria:</p>\n <ul>\n <li>\n <p>It can only contain ASCII letters (az, AZ), numbers (09),\n underscores (_), or dashes (-).</p>\n </li>\n <li>\n <p>It can contain no more than 256 characters.</p>\n </li>\n </ul>"
}
},
"com.amazonaws.sesv2#DeleteConfigurationSet": {
"type": "operation",
"input": {
"target": "com.amazonaws.sesv2#DeleteConfigurationSetRequest"
},
"output": {
"target": "com.amazonaws.sesv2#DeleteConfigurationSetResponse"
},
"errors": [
{
"target": "com.amazonaws.sesv2#BadRequestException"
},
{
"target": "com.amazonaws.sesv2#ConcurrentModificationException"
},
{
"target": "com.amazonaws.sesv2#NotFoundException"
},
{
"target": "com.amazonaws.sesv2#TooManyRequestsException"
}
],
"traits": {
"smithy.api#documentation": "<p>Delete an existing configuration set.</p>\n <p>\n <i>Configuration sets</i> are groups of rules that you can apply to the\n emails you send. You apply a configuration set to an email by including a reference to\n the configuration set in the headers of the email. When you apply a configuration set to\n an email, all of the rules in that configuration set are applied to the email.</p>",
"smithy.api#http": {
"method": "DELETE",
"uri": "/v2/email/configuration-sets/{ConfigurationSetName}",
"code": 200
}
}
},
"com.amazonaws.sesv2#DeleteConfigurationSetEventDestination": {
"type": "operation",
"input": {
"target": "com.amazonaws.sesv2#DeleteConfigurationSetEventDestinationRequest"
},
"output": {
"target": "com.amazonaws.sesv2#DeleteConfigurationSetEventDestinationResponse"
},
"errors": [
{
"target": "com.amazonaws.sesv2#BadRequestException"
},
{
"target": "com.amazonaws.sesv2#NotFoundException"
},
{
"target": "com.amazonaws.sesv2#TooManyRequestsException"
}
],
"traits": {
"smithy.api#documentation": "<p>Delete an event destination.</p>\n <p>\n <i>Events</i> include message sends, deliveries, opens, clicks, bounces,\n and complaints. <i>Event destinations</i> are places that you can send\n information about these events to. For example, you can send event data to Amazon SNS to\n receive notifications when you receive bounces or complaints, or you can use Amazon Kinesis Data Firehose to\n stream data to Amazon S3 for long-term storage.</p>",
"smithy.api#http": {
"method": "DELETE",
"uri": "/v2/email/configuration-sets/{ConfigurationSetName}/event-destinations/{EventDestinationName}",
"code": 200
}
}
},
"com.amazonaws.sesv2#DeleteConfigurationSetEventDestinationRequest": {
"type": "structure",
"members": {
"ConfigurationSetName": {
"target": "com.amazonaws.sesv2#ConfigurationSetName",
"traits": {
"smithy.api#documentation": "<p>The name of the configuration set that contains the event destination that you want to\n delete.</p>",
"smithy.api#httpLabel": {},
"smithy.api#required": {}
}
},
"EventDestinationName": {
"target": "com.amazonaws.sesv2#EventDestinationName",
"traits": {
"smithy.api#documentation": "<p>The name of the event destination that you want to delete.</p>",
"smithy.api#httpLabel": {},
"smithy.api#required": {}
}
}
},
"traits": {
"smithy.api#documentation": "<p>A request to delete an event destination from a configuration set.</p>"
}
},
"com.amazonaws.sesv2#DeleteConfigurationSetEventDestinationResponse": {
"type": "structure",
"members": {},
"traits": {
"smithy.api#documentation": "<p>An HTTP 200 response if the request succeeds, or an error message if the request\n fails.</p>"
}
},
"com.amazonaws.sesv2#DeleteConfigurationSetRequest": {
"type": "structure",
"members": {
"ConfigurationSetName": {
"target": "com.amazonaws.sesv2#ConfigurationSetName",
"traits": {
"smithy.api#documentation": "<p>The name of the configuration set that you want to delete.</p>",
"smithy.api#httpLabel": {},
"smithy.api#required": {}
}
}
},
"traits": {
"smithy.api#documentation": "<p>A request to delete a configuration set.</p>"
}
},
"com.amazonaws.sesv2#DeleteConfigurationSetResponse": {
"type": "structure",
"members": {},
"traits": {
"smithy.api#documentation": "<p>An HTTP 200 response if the request succeeds, or an error message if the request\n fails.</p>"
}
},
"com.amazonaws.sesv2#DeleteContact": {
"type": "operation",
"input": {
"target": "com.amazonaws.sesv2#DeleteContactRequest"
},
"output": {
"target": "com.amazonaws.sesv2#DeleteContactResponse"
},
"errors": [
{
"target": "com.amazonaws.sesv2#BadRequestException"
},
{
"target": "com.amazonaws.sesv2#NotFoundException"
},
{
"target": "com.amazonaws.sesv2#TooManyRequestsException"
}
],
"traits": {
"smithy.api#documentation": "<p>Removes a contact from a contact list.</p>",
"smithy.api#http": {
"method": "DELETE",
"uri": "/v2/email/contact-lists/{ContactListName}/contacts/{EmailAddress}",
"code": 200
}
}
},
"com.amazonaws.sesv2#DeleteContactList": {
"type": "operation",
"input": {
"target": "com.amazonaws.sesv2#DeleteContactListRequest"
},
"output": {
"target": "com.amazonaws.sesv2#DeleteContactListResponse"
},
"errors": [
{
"target": "com.amazonaws.sesv2#BadRequestException"
},
{
"target": "com.amazonaws.sesv2#ConcurrentModificationException"
},
{
"target": "com.amazonaws.sesv2#NotFoundException"
},
{
"target": "com.amazonaws.sesv2#TooManyRequestsException"
}
],
"traits": {
"smithy.api#documentation": "<p>Deletes a contact list and all of the contacts on that list.</p>",
"smithy.api#http": {
"method": "DELETE",
"uri": "/v2/email/contact-lists/{ContactListName}",
"code": 200
}
}
},
"com.amazonaws.sesv2#DeleteContactListRequest": {
"type": "structure",
"members": {
"ContactListName": {
"target": "com.amazonaws.sesv2#ContactListName",
"traits": {
"smithy.api#documentation": "<p>The name of the contact list.</p>",
"smithy.api#httpLabel": {},
"smithy.api#required": {}
}
}
}
},
"com.amazonaws.sesv2#DeleteContactListResponse": {
"type": "structure",
"members": {}
},
"com.amazonaws.sesv2#DeleteContactRequest": {
"type": "structure",
"members": {
"ContactListName": {
"target": "com.amazonaws.sesv2#ContactListName",
"traits": {
"smithy.api#documentation": "<p>The name of the contact list from which the contact should be removed.</p>",
"smithy.api#httpLabel": {},
"smithy.api#required": {}
}
},
"EmailAddress": {
"target": "com.amazonaws.sesv2#EmailAddress",
"traits": {
"smithy.api#documentation": "<p>The contact's email address.</p>",
"smithy.api#httpLabel": {},
"smithy.api#required": {}
}
}
}
},
"com.amazonaws.sesv2#DeleteContactResponse": {
"type": "structure",
"members": {}
},
"com.amazonaws.sesv2#DeleteCustomVerificationEmailTemplate": {
"type": "operation",
"input": {
"target": "com.amazonaws.sesv2#DeleteCustomVerificationEmailTemplateRequest"
},
"output": {
"target": "com.amazonaws.sesv2#DeleteCustomVerificationEmailTemplateResponse"
},
"errors": [
{
"target": "com.amazonaws.sesv2#BadRequestException"
},
{
"target": "com.amazonaws.sesv2#NotFoundException"
},
{
"target": "com.amazonaws.sesv2#TooManyRequestsException"
}
],
"traits": {
"smithy.api#documentation": "<p>Deletes an existing custom verification email template.</p>\n <p>For more information about custom verification email templates, see <a href=\"https://docs.aws.amazon.com/es/latest/DeveloperGuide/send-email-verify-address-custom.html\">Using Custom Verification Email Templates</a> in the <i>Amazon SES Developer\n Guide</i>.</p>\n <p>You can execute this operation no more than once per second.</p>",
"smithy.api#http": {
"method": "DELETE",
"uri": "/v2/email/custom-verification-email-templates/{TemplateName}",
"code": 200
}
}
},
"com.amazonaws.sesv2#DeleteCustomVerificationEmailTemplateRequest": {
"type": "structure",
"members": {
"TemplateName": {
"target": "com.amazonaws.sesv2#EmailTemplateName",
"traits": {
"smithy.api#documentation": "<p>The name of the custom verification email template that you want to delete.</p>",
"smithy.api#httpLabel": {},
"smithy.api#required": {}
}
}
},
"traits": {
"smithy.api#documentation": "<p>Represents a request to delete an existing custom verification email template.</p>"
}
},
"com.amazonaws.sesv2#DeleteCustomVerificationEmailTemplateResponse": {
"type": "structure",
"members": {},
"traits": {
"smithy.api#documentation": "<p>If the action is successful, the service sends back an HTTP 200 response with an empty\n HTTP body.</p>"
}
},
"com.amazonaws.sesv2#DeleteDedicatedIpPool": {
"type": "operation",
"input": {
"target": "com.amazonaws.sesv2#DeleteDedicatedIpPoolRequest"
},
"output": {
"target": "com.amazonaws.sesv2#DeleteDedicatedIpPoolResponse"
},
"errors": [
{
"target": "com.amazonaws.sesv2#BadRequestException"
},
{
"target": "com.amazonaws.sesv2#ConcurrentModificationException"
},
{
"target": "com.amazonaws.sesv2#NotFoundException"
},
{
"target": "com.amazonaws.sesv2#TooManyRequestsException"
}
],
"traits": {
"smithy.api#documentation": "<p>Delete a dedicated IP pool.</p>",
"smithy.api#http": {
"method": "DELETE",
"uri": "/v2/email/dedicated-ip-pools/{PoolName}",
"code": 200
}
}
},
"com.amazonaws.sesv2#DeleteDedicatedIpPoolRequest": {
"type": "structure",
"members": {
"PoolName": {
"target": "com.amazonaws.sesv2#PoolName",
"traits": {
"smithy.api#documentation": "<p>The name of the dedicated IP pool that you want to delete.</p>",
"smithy.api#httpLabel": {},
"smithy.api#required": {}
}
}
},
"traits": {
"smithy.api#documentation": "<p>A request to delete a dedicated IP pool.</p>"
}
},
"com.amazonaws.sesv2#DeleteDedicatedIpPoolResponse": {
"type": "structure",
"members": {},
"traits": {
"smithy.api#documentation": "<p>An HTTP 200 response if the request succeeds, or an error message if the request\n fails.</p>"
}
},
"com.amazonaws.sesv2#DeleteEmailIdentity": {
"type": "operation",
"input": {
"target": "com.amazonaws.sesv2#DeleteEmailIdentityRequest"
},
"output": {
"target": "com.amazonaws.sesv2#DeleteEmailIdentityResponse"
},
"errors": [
{
"target": "com.amazonaws.sesv2#BadRequestException"
},
{
"target": "com.amazonaws.sesv2#ConcurrentModificationException"
},
{
"target": "com.amazonaws.sesv2#NotFoundException"
},
{
"target": "com.amazonaws.sesv2#TooManyRequestsException"
}
],
"traits": {
"smithy.api#documentation": "<p>Deletes an email identity. An identity can be either an email address or a domain\n name.</p>",
"smithy.api#http": {
"method": "DELETE",
"uri": "/v2/email/identities/{EmailIdentity}",
"code": 200
}
}
},
"com.amazonaws.sesv2#DeleteEmailIdentityPolicy": {
"type": "operation",
"input": {
"target": "com.amazonaws.sesv2#DeleteEmailIdentityPolicyRequest"
},
"output": {
"target": "com.amazonaws.sesv2#DeleteEmailIdentityPolicyResponse"
},
"errors": [
{
"target": "com.amazonaws.sesv2#BadRequestException"
},
{
"target": "com.amazonaws.sesv2#NotFoundException"
},
{
"target": "com.amazonaws.sesv2#TooManyRequestsException"
}
],
"traits": {
"smithy.api#documentation": "<p>Deletes the specified sending authorization policy for the given identity (an email\n address or a domain). This API returns successfully even if a policy with the specified\n name does not exist.</p>\n <note>\n <p>This API is for the identity owner only. If you have not verified the identity,\n this API will return an error.</p>\n </note>\n <p>Sending authorization is a feature that enables an identity owner to authorize other\n senders to use its identities. For information about using sending authorization, see\n the <a href=\"https://docs.aws.amazon.com/ses/latest/DeveloperGuide/sending-authorization.html\">Amazon SES Developer\n Guide</a>.</p>\n\n <p>You can execute this operation no more than once per second.</p>",
"smithy.api#http": {
"method": "DELETE",
"uri": "/v2/email/identities/{EmailIdentity}/policies/{PolicyName}",
"code": 200
}
}
},
"com.amazonaws.sesv2#DeleteEmailIdentityPolicyRequest": {
"type": "structure",
"members": {
"EmailIdentity": {
"target": "com.amazonaws.sesv2#Identity",
"traits": {
"smithy.api#documentation": "<p>The email identity for which you want to delete a policy.</p>",
"smithy.api#httpLabel": {},
"smithy.api#required": {}
}
},
"PolicyName": {
"target": "com.amazonaws.sesv2#PolicyName",
"traits": {
"smithy.api#documentation": "<p>The name of the policy.</p>\n\n <p>The policy name cannot exceed 64 characters and can only include alphanumeric\n characters, dashes, and underscores.</p>",
"smithy.api#httpLabel": {},
"smithy.api#required": {}
}
}
},
"traits": {
"smithy.api#documentation": "<p>Represents a request to delete a sending authorization policy for an identity. Sending\n authorization is an Amazon SES feature that enables you to authorize other senders to\n use your identities. For information, see the <a href=\"https://docs.aws.amazon.com/ses/latest/DeveloperGuide/sending-authorization-identity-owner-tasks-management.html\">Amazon SES Developer Guide</a>.</p>"
}
},
"com.amazonaws.sesv2#DeleteEmailIdentityPolicyResponse": {
"type": "structure",
"members": {},
"traits": {
"smithy.api#documentation": "<p>An HTTP 200 response if the request succeeds, or an error message if the request\n fails.</p>"
}
},
"com.amazonaws.sesv2#DeleteEmailIdentityRequest": {
"type": "structure",
"members": {
"EmailIdentity": {
"target": "com.amazonaws.sesv2#Identity",
"traits": {
"smithy.api#documentation": "<p>The identity (that is, the email address or domain) that you want to delete.</p>",
"smithy.api#httpLabel": {},
"smithy.api#required": {}
}
}
},
"traits": {
"smithy.api#documentation": "<p>A request to delete an existing email identity. When you delete an identity, you lose\n the ability to send email from that identity. You can restore your ability to send email\n by completing the verification process for the identity again.</p>"
}
},
"com.amazonaws.sesv2#DeleteEmailIdentityResponse": {
"type": "structure",
"members": {},
"traits": {
"smithy.api#documentation": "<p>An HTTP 200 response if the request succeeds, or an error message if the request\n fails.</p>"
}
},
"com.amazonaws.sesv2#DeleteEmailTemplate": {
"type": "operation",
"input": {
"target": "com.amazonaws.sesv2#DeleteEmailTemplateRequest"
},
"output": {
"target": "com.amazonaws.sesv2#DeleteEmailTemplateResponse"
},
"errors": [
{
"target": "com.amazonaws.sesv2#BadRequestException"
},
{
"target": "com.amazonaws.sesv2#NotFoundException"
},
{
"target": "com.amazonaws.sesv2#TooManyRequestsException"
}
],
"traits": {
"smithy.api#documentation": "<p>Deletes an email template.</p>\n\n <p>You can execute this operation no more than once per second.</p>",
"smithy.api#http": {
"method": "DELETE",
"uri": "/v2/email/templates/{TemplateName}",
"code": 200
}
}
},
"com.amazonaws.sesv2#DeleteEmailTemplateRequest": {
"type": "structure",
"members": {
"TemplateName": {
"target": "com.amazonaws.sesv2#EmailTemplateName",
"traits": {
"smithy.api#documentation": "<p>The name of the template to be deleted.</p>",
"smithy.api#httpLabel": {},
"smithy.api#required": {}
}
}
},
"traits": {
"smithy.api#documentation": "<p>Represents a request to delete 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\n Guide</a>.</p>"
}
},
"com.amazonaws.sesv2#DeleteEmailTemplateResponse": {
"type": "structure",
"members": {},
"traits": {
"smithy.api#documentation": "<p>If the action is successful, the service sends back an HTTP 200 response with an empty\n HTTP body.</p>"
}
},
"com.amazonaws.sesv2#DeleteSuppressedDestination": {
"type": "operation",
"input": {
"target": "com.amazonaws.sesv2#DeleteSuppressedDestinationRequest"
},
"output": {
"target": "com.amazonaws.sesv2#DeleteSuppressedDestinationResponse"
},
"errors": [
{
"target": "com.amazonaws.sesv2#BadRequestException"
},
{
"target": "com.amazonaws.sesv2#NotFoundException"
},
{
"target": "com.amazonaws.sesv2#TooManyRequestsException"
}
],
"traits": {
"smithy.api#documentation": "<p>Removes an email address from the suppression list for your account.</p>",
"smithy.api#http": {
"method": "DELETE",
"uri": "/v2/email/suppression/addresses/{EmailAddress}",
"code": 200
}
}
},
"com.amazonaws.sesv2#DeleteSuppressedDestinationRequest": {
"type": "structure",
"members": {
"EmailAddress": {
"target": "com.amazonaws.sesv2#EmailAddress",
"traits": {
"smithy.api#documentation": "<p>The suppressed email destination to remove from the account suppression list.</p>",
"smithy.api#httpLabel": {},
"smithy.api#required": {}
}
}
},
"traits": {
"smithy.api#documentation": "<p>A request to remove an email address from the suppression list for your\n account.</p>"
}
},
"com.amazonaws.sesv2#DeleteSuppressedDestinationResponse": {
"type": "structure",
"members": {},
"traits": {
"smithy.api#documentation": "<p>An HTTP 200 response if the request succeeds, or an error message if the request\n fails.</p>"
}
},
"com.amazonaws.sesv2#DeliverabilityDashboardAccountStatus": {
"type": "string",
"traits": {
"smithy.api#documentation": "<p>The current status of your Deliverability dashboard subscription. If this value is\n <code>PENDING_EXPIRATION</code>, your subscription is scheduled to expire at the end\n of the current calendar month.</p>",
"smithy.api#enum": [
{
"value": "ACTIVE",
"name": "ACTIVE"
},
{
"value": "PENDING_EXPIRATION",
"name": "PENDING_EXPIRATION"
},
{
"value": "DISABLED",
"name": "DISABLED"
}
]
}
},
"com.amazonaws.sesv2#DeliverabilityTestReport": {
"type": "structure",
"members": {
"ReportId": {
"target": "com.amazonaws.sesv2#ReportId",
"traits": {
"smithy.api#documentation": "<p>A unique string that identifies the predictive inbox placement test.</p>"
}
},
"ReportName": {
"target": "com.amazonaws.sesv2#ReportName",
"traits": {
"smithy.api#documentation": "<p>A name that helps you identify a predictive inbox placement test report.</p>"
}
},
"Subject": {
"target": "com.amazonaws.sesv2#DeliverabilityTestSubject",
"traits": {
"smithy.api#documentation": "<p>The subject line for an email that you submitted in a predictive inbox placement test.</p>"
}
},
"FromEmailAddress": {
"target": "com.amazonaws.sesv2#EmailAddress",
"traits": {
"smithy.api#documentation": "<p>The sender address that you specified for the predictive inbox placement test.</p>"
}
},
"CreateDate": {
"target": "com.amazonaws.sesv2#Timestamp",
"traits": {
"smithy.api#documentation": "<p>The date and time when the predictive inbox placement test was created, in Unix time format.</p>"
}
},
"DeliverabilityTestStatus": {
"target": "com.amazonaws.sesv2#DeliverabilityTestStatus",
"traits": {
"smithy.api#documentation": "<p>The status of the predictive inbox placement test. If the status is <code>IN_PROGRESS</code>, then the predictive inbox placement test\n is currently running. Predictive inbox placement tests are usually complete within 24 hours of creating the\n test. If the status is <code>COMPLETE</code>, then the test is finished, and you can use\n the <code>GetDeliverabilityTestReport</code> to view the results of the test.</p>"
}
}
},
"traits": {
"smithy.api#documentation": "<p>An object that contains metadata related to a predictive inbox placement test.</p>"
}
},
"com.amazonaws.sesv2#DeliverabilityTestReports": {
"type": "list",
"member": {
"target": "com.amazonaws.sesv2#DeliverabilityTestReport"
}
},
"com.amazonaws.sesv2#DeliverabilityTestStatus": {
"type": "string",
"traits": {
"smithy.api#documentation": "<p>The status of a predictive inbox placement test. If the status is <code>IN_PROGRESS</code>, then the predictive inbox placement test is\n currently running. Predictive inbox placement tests are usually complete within 24 hours of creating the test.\n If the status is <code>COMPLETE</code>, then the test is finished, and you can use the\n <code>GetDeliverabilityTestReport</code> operation to view the results of the\n test.</p>",
"smithy.api#enum": [
{
"value": "IN_PROGRESS",
"name": "IN_PROGRESS"
},
{
"value": "COMPLETED",
"name": "COMPLETED"
}
]
}
},
"com.amazonaws.sesv2#DeliverabilityTestSubject": {
"type": "string",
"traits": {
"smithy.api#documentation": "<p>The subject line for an email that you submitted in a predictive inbox placement test.</p>"
}
},
"com.amazonaws.sesv2#DeliveryOptions": {
"type": "structure",
"members": {
"TlsPolicy": {
"target": "com.amazonaws.sesv2#TlsPolicy",
"traits": {
"smithy.api#documentation": "<p>Specifies whether messages that use the configuration set are required to use\n Transport Layer Security (TLS). If the value is <code>Require</code>, messages are only\n delivered if a TLS connection can be established. If the value is <code>Optional</code>,\n messages can be delivered in plain text if a TLS connection can't be established.</p>"
}
},
"SendingPoolName": {
"target": "com.amazonaws.sesv2#PoolName",
"traits": {
"smithy.api#documentation": "<p>The name of the dedicated IP pool that you want to associate with the configuration\n set.</p>"
}
}
},
"traits": {
"smithy.api#documentation": "<p>Used to associate a configuration set with a dedicated IP pool.</p>"
}
},
"com.amazonaws.sesv2#Description": {
"type": "string"
},
"com.amazonaws.sesv2#Destination": {
"type": "structure",
"members": {
"ToAddresses": {
"target": "com.amazonaws.sesv2#EmailAddressList",
"traits": {
"smithy.api#documentation": "<p>An array that contains the email addresses of the \"To\" recipients for the\n email.</p>"
}
},
"CcAddresses": {
"target": "com.amazonaws.sesv2#EmailAddressList",
"traits": {
"smithy.api#documentation": "<p>An array that contains the email addresses of the \"CC\" (carbon copy) recipients for\n the email.</p>"
}
},
"BccAddresses": {
"target": "com.amazonaws.sesv2#EmailAddressList",
"traits": {
"smithy.api#documentation": "<p>An array that contains the email addresses of the \"BCC\" (blind carbon copy) recipients\n for the email.</p>"
}
}
},
"traits": {
"smithy.api#documentation": "<p>An object that describes the recipients for an email.</p>"
}
},
"com.amazonaws.sesv2#DimensionName": {
"type": "string",
"traits": {
"smithy.api#documentation": "<p>The name of an Amazon CloudWatch dimension associated with an email sending metric. The name has to\n meet the following criteria:</p>\n <ul>\n <li>\n <p>It can only contain ASCII letters (a-z, A-Z), numbers (0-9), underscores (_),\n or dashes (-).</p>\n </li>\n <li>\n <p>It can contain no more than 256 characters.</p>\n </li>\n </ul>"
}
},
"com.amazonaws.sesv2#DimensionValueSource": {
"type": "string",
"traits": {
"smithy.api#documentation": "<p>The location where the Amazon SES API v2 finds the value of a dimension to publish to Amazon CloudWatch. If\n you want to use the message tags that you specify using an\n <code>X-SES-MESSAGE-TAGS</code> header or a parameter to the <code>SendEmail</code>\n or <code>SendRawEmail</code> API, choose <code>messageTag</code>. If you want to use\n your own email headers, choose <code>emailHeader</code>. If you want to use link tags,\n choose <code>linkTags</code>.</p>",
"smithy.api#enum": [
{
"value": "MESSAGE_TAG",
"name": "MESSAGE_TAG"
},
{
"value": "EMAIL_HEADER",
"name": "EMAIL_HEADER"
},
{
"value": "LINK_TAG",
"name": "LINK_TAG"
}
]
}
},
"com.amazonaws.sesv2#DisplayName": {
"type": "string"
},
"com.amazonaws.sesv2#DkimAttributes": {
"type": "structure",
"members": {
"SigningEnabled": {
"target": "com.amazonaws.sesv2#Enabled",
"traits": {
"smithy.api#documentation": "<p>If the value is <code>true</code>, then the messages that you send from the identity\n are signed using DKIM. If the value is <code>false</code>, then the messages that you\n send from the identity aren't DKIM-signed.</p>"
}
},
"Status": {
"target": "com.amazonaws.sesv2#DkimStatus",
"traits": {
"smithy.api#documentation": "<p>Describes whether or not Amazon SES has successfully located the DKIM records in the DNS\n records for the domain. The status can be one of the following:</p>\n <ul>\n <li>\n <p>\n <code>PENDING</code> The verification process was initiated, but Amazon SES\n hasn't yet detected the DKIM records in the DNS configuration for the\n domain.</p>\n </li>\n <li>\n <p>\n <code>SUCCESS</code> The verification process completed\n successfully.</p>\n </li>\n <li>\n <p>\n <code>FAILED</code> The verification process failed. This typically\n occurs when Amazon SES fails to find the DKIM records in the DNS configuration of the\n domain.</p>\n </li>\n <li>\n <p>\n <code>TEMPORARY_FAILURE</code> A temporary issue is preventing Amazon SES\n from determining the DKIM authentication status of the domain.</p>\n </li>\n <li>\n <p>\n <code>NOT_STARTED</code> The DKIM verification process hasn't been\n initiated for the domain.</p>\n </li>\n </ul>"
}
},
"Tokens": {
"target": "com.amazonaws.sesv2#DnsTokenList",
"traits": {
"smithy.api#documentation": "<p>If you used <a href=\"https://docs.aws.amazon.com/ses/latest/DeveloperGuide/easy-dkim.html\">Easy DKIM</a> to configure DKIM authentication for the domain, then this object\n contains a set of unique strings that you use to create a set of CNAME records that you\n add to the DNS configuration for your domain. When Amazon SES detects these records in the\n DNS configuration for your domain, the DKIM authentication process is complete.</p>\n <p>If you configured DKIM authentication for the domain by providing your own\n public-private key pair, then this object contains the selector for the public\n key.</p>\n <p>Regardless of the DKIM authentication method you use, Amazon SES searches for the\n appropriate records in the DNS configuration of the domain for up to 72 hours.</p>"
}
},
"SigningAttributesOrigin": {
"target": "com.amazonaws.sesv2#DkimSigningAttributesOrigin",
"traits": {
"smithy.api#documentation": "<p>A string that indicates how DKIM was configured for the identity. There are two\n possible values:</p>\n <ul>\n <li>\n <p>\n <code>AWS_SES</code> Indicates that DKIM was configured for the\n identity by using <a href=\"https://docs.aws.amazon.com/ses/latest/DeveloperGuide/easy-dkim.html\">Easy DKIM</a>.</p>\n </li>\n <li>\n <p>\n <code>EXTERNAL</code> Indicates that DKIM was configured for the\n identity by using Bring Your Own DKIM (BYODKIM).</p>\n </li>\n </ul>"
}
}
},
"traits": {
"smithy.api#documentation": "<p>An object that contains information about the DKIM authentication status for an email\n identity.</p>\n <p>Amazon SES determines the authentication status by searching for specific records in the\n DNS configuration for the domain. If you used <a href=\"https://docs.aws.amazon.com/ses/latest/DeveloperGuide/easy-dkim.html\">Easy DKIM</a> to set up DKIM\n authentication, Amazon SES tries to find three unique CNAME records in the DNS configuration\n for your domain. If you provided a public key to perform DKIM authentication, Amazon SES\n tries to find a TXT record that uses the selector that you specified. The value of the\n TXT record must be a public key that's paired with the private key that you specified in\n the process of creating the identity</p>"
}
},
"com.amazonaws.sesv2#DkimSigningAttributes": {
"type": "structure",
"members": {
"DomainSigningSelector": {
"target": "com.amazonaws.sesv2#Selector",
"traits": {
"smithy.api#documentation": "<p>A string that's used to identify a public key in the DNS configuration for a\n domain.</p>",
"smithy.api#required": {}
}
},
"DomainSigningPrivateKey": {
"target": "com.amazonaws.sesv2#PrivateKey",
"traits": {
"smithy.api#documentation": "<p>A private key that's used to generate a DKIM signature.</p>\n <p>The private key must use 1024-bit RSA encryption, and must be encoded using base64\n encoding.</p>",
"smithy.api#required": {}
}
}
},
"traits": {
"smithy.api#documentation": "<p>An object that contains information about the tokens used for setting up Bring Your\n Own DKIM (BYODKIM).</p>"
}
},
"com.amazonaws.sesv2#DkimSigningAttributesOrigin": {
"type": "string",
"traits": {
"smithy.api#enum": [
{
"value": "AWS_SES",
"name": "AWS_SES"
},
{
"value": "EXTERNAL",
"name": "EXTERNAL"
}
]
}
},
"com.amazonaws.sesv2#DkimStatus": {
"type": "string",
"traits": {
"smithy.api#documentation": "<p>The DKIM authentication status of the identity. The status can be one of the\n following:</p>\n <ul>\n <li>\n <p>\n <code>PENDING</code> The verification process was initiated, but Amazon SES\n hasn't yet detected the DKIM records in the DNS configuration for the\n domain.</p>\n </li>\n <li>\n <p>\n <code>SUCCESS</code> The verification process completed\n successfully.</p>\n </li>\n <li>\n <p>\n <code>FAILED</code> The verification process failed. This typically\n occurs when Amazon SES fails to find the DKIM records in the DNS configuration of the\n domain.</p>\n </li>\n <li>\n <p>\n <code>TEMPORARY_FAILURE</code> A temporary issue is preventing Amazon SES\n from determining the DKIM authentication status of the domain.</p>\n </li>\n <li>\n <p>\n <code>NOT_STARTED</code> The DKIM verification process hasn't been\n initiated for the domain.</p>\n </li>\n </ul>",
"smithy.api#enum": [
{
"value": "PENDING",
"name": "PENDING"
},
{
"value": "SUCCESS",
"name": "SUCCESS"
},
{
"value": "FAILED",
"name": "FAILED"
},
{
"value": "TEMPORARY_FAILURE",
"name": "TEMPORARY_FAILURE"
},
{
"value": "NOT_STARTED",
"name": "NOT_STARTED"
}
]
}
},
"com.amazonaws.sesv2#DnsToken": {
"type": "string"
},
"com.amazonaws.sesv2#DnsTokenList": {
"type": "list",
"member": {
"target": "com.amazonaws.sesv2#DnsToken"
}
},
"com.amazonaws.sesv2#Domain": {
"type": "string"
},
"com.amazonaws.sesv2#DomainDeliverabilityCampaign": {
"type": "structure",
"members": {
"CampaignId": {
"target": "com.amazonaws.sesv2#CampaignId",
"traits": {
"smithy.api#documentation": "<p>The unique identifier for the campaign. The Deliverability dashboard automatically generates\n and assigns this identifier to a campaign.</p>"
}
},
"ImageUrl": {
"target": "com.amazonaws.sesv2#ImageUrl",
"traits": {
"smithy.api#documentation": "<p>The URL of an image that contains a snapshot of the email message that was\n sent.</p>"
}
},
"Subject": {
"target": "com.amazonaws.sesv2#Subject",
"traits": {
"smithy.api#documentation": "<p>The subject line, or title, of the email message.</p>"
}
},
"FromAddress": {
"target": "com.amazonaws.sesv2#Identity",
"traits": {
"smithy.api#documentation": "<p>The verified email address that the email message was sent from.</p>"
}
},
"SendingIps": {
"target": "com.amazonaws.sesv2#IpList",
"traits": {
"smithy.api#documentation": "<p>The IP addresses that were used to send the email message.</p>"
}
},
"FirstSeenDateTime": {
"target": "com.amazonaws.sesv2#Timestamp",
"traits": {
"smithy.api#documentation": "<p>The first time, in Unix time format, when the email message was delivered to any\n recipient's inbox. This value can help you determine how long it took for a campaign to\n deliver an email message.</p>"
}
},
"LastSeenDateTime": {
"target": "com.amazonaws.sesv2#Timestamp",
"traits": {
"smithy.api#documentation": "<p>The last time, in Unix time format, when the email message was delivered to any\n recipient's inbox. This value can help you determine how long it took for a campaign to\n deliver an email message.</p>"
}
},
"InboxCount": {
"target": "com.amazonaws.sesv2#Volume",
"traits": {
"smithy.api#documentation": "<p>The number of email messages that were delivered to recipients inboxes.</p>"
}
},
"SpamCount": {
"target": "com.amazonaws.sesv2#Volume",
"traits": {
"smithy.api#documentation": "<p>The number of email messages that were delivered to recipients' spam or junk mail\n folders.</p>"
}
},
"ReadRate": {
"target": "com.amazonaws.sesv2#Percentage",
"traits": {
"smithy.api#documentation": "<p>The percentage of email messages that were opened by recipients. Due to technical\n limitations, this value only includes recipients who opened the message by using an\n email client that supports images.</p>"
}
},
"DeleteRate": {
"target": "com.amazonaws.sesv2#Percentage",
"traits": {
"smithy.api#documentation": "<p>The percentage of email messages that were deleted by recipients, without being opened\n first. Due to technical limitations, this value only includes recipients who opened the\n message by using an email client that supports images.</p>"
}
},
"ReadDeleteRate": {
"target": "com.amazonaws.sesv2#Percentage",
"traits": {
"smithy.api#documentation": "<p>The percentage of email messages that were opened and then deleted by recipients. Due\n to technical limitations, this value only includes recipients who opened the message by\n using an email client that supports images.</p>"
}
},
"ProjectedVolume": {
"target": "com.amazonaws.sesv2#Volume",
"traits": {
"smithy.api#documentation": "<p>The projected number of recipients that the email message was sent to.</p>"
}
},
"Esps": {
"target": "com.amazonaws.sesv2#Esps",
"traits": {
"smithy.api#documentation": "<p>The major email providers who handled the email message.</p>"
}
}
},
"traits": {
"smithy.api#documentation": "<p>An object that contains the deliverability data for a specific campaign. This data is\n available for a campaign only if the campaign sent email by using a domain that the\n Deliverability dashboard is enabled for (<code>PutDeliverabilityDashboardOption</code>\n operation).</p>"
}
},
"com.amazonaws.sesv2#DomainDeliverabilityCampaignList": {
"type": "list",
"member": {
"target": "com.amazonaws.sesv2#DomainDeliverabilityCampaign"
},
"traits": {
"smithy.api#documentation": "<p></p>"
}
},
"com.amazonaws.sesv2#DomainDeliverabilityTrackingOption": {
"type": "structure",
"members": {
"Domain": {
"target": "com.amazonaws.sesv2#Domain",
"traits": {
"smithy.api#documentation": "<p>A verified domain thats associated with your AWS account and currently has an\n active Deliverability dashboard subscription.</p>"
}
},
"SubscriptionStartDate": {
"target": "com.amazonaws.sesv2#Timestamp",
"traits": {
"smithy.api#documentation": "<p>The date, in Unix time format, when you enabled the Deliverability dashboard for the\n domain.</p>"
}
},
"InboxPlacementTrackingOption": {
"target": "com.amazonaws.sesv2#InboxPlacementTrackingOption",
"traits": {
"smithy.api#documentation": "<p>An object that contains information about the inbox placement data settings for the\n domain.</p>"
}
}
},
"traits": {
"smithy.api#documentation": "<p>An object that contains information about the Deliverability dashboard subscription for a\n verified domain that you use to send email and currently has an active Deliverability dashboard\n subscription. If a Deliverability dashboard subscription is active for a domain, you gain access\n to reputation, inbox placement, and other metrics for the domain.</p>"
}
},
"com.amazonaws.sesv2#DomainDeliverabilityTrackingOptions": {
"type": "list",
"member": {
"target": "com.amazonaws.sesv2#DomainDeliverabilityTrackingOption"
},
"traits": {
"smithy.api#documentation": "<p>An object that contains information about the Deliverability dashboard subscription for a\n verified domain that you use to send email and currently has an active Deliverability dashboard\n subscription. If a Deliverability dashboard subscription is active for a domain, you gain access\n to reputation, inbox placement, and other metrics for the domain.</p>"
}
},
"com.amazonaws.sesv2#DomainIspPlacement": {
"type": "structure",
"members": {
"IspName": {
"target": "com.amazonaws.sesv2#IspName",
"traits": {
"smithy.api#documentation": "<p>The name of the email provider that the inbox placement data applies to.</p>"
}
},
"InboxRawCount": {
"target": "com.amazonaws.sesv2#Volume",
"traits": {
"smithy.api#documentation": "<p>The total number of messages that were sent from the selected domain to the specified\n email provider that arrived in recipients' inboxes.</p>"
}
},
"SpamRawCount": {
"target": "com.amazonaws.sesv2#Volume",
"traits": {
"smithy.api#documentation": "<p>The total number of messages that were sent from the selected domain to the specified\n email provider that arrived in recipients' spam or junk mail folders.</p>"
}
},
"InboxPercentage": {
"target": "com.amazonaws.sesv2#Percentage",
"traits": {
"smithy.api#documentation": "<p>The percentage of messages that were sent from the selected domain to the specified\n email provider that arrived in recipients' inboxes.</p>"
}
},
"SpamPercentage": {
"target": "com.amazonaws.sesv2#Percentage",
"traits": {
"smithy.api#documentation": "<p>The percentage of messages that were sent from the selected domain to the specified\n email provider that arrived in recipients' spam or junk mail folders.</p>"
}
}
},
"traits": {
"smithy.api#documentation": "<p>An object that contains inbox placement data for email sent from one of your email\n domains to a specific email provider.</p>"
}
},
"com.amazonaws.sesv2#DomainIspPlacements": {
"type": "list",
"member": {
"target": "com.amazonaws.sesv2#DomainIspPlacement"
}
},
"com.amazonaws.sesv2#EmailAddress": {
"type": "string"
},
"com.amazonaws.sesv2#EmailAddressList": {
"type": "list",
"member": {
"target": "com.amazonaws.sesv2#EmailAddress"
}
},
"com.amazonaws.sesv2#EmailContent": {
"type": "structure",
"members": {
"Simple": {
"target": "com.amazonaws.sesv2#Message",
"traits": {
"smithy.api#documentation": "<p>The simple email message. The message consists of a subject and a message body.</p>"
}
},
"Raw": {
"target": "com.amazonaws.sesv2#RawMessage",
"traits": {
"smithy.api#documentation": "<p>The raw email message. The message has to meet the following criteria:</p>\n <ul>\n <li>\n <p>The message has to contain a header and a body, separated by one blank\n line.</p>\n </li>\n <li>\n <p>All of the required header fields must be present in the message.</p>\n </li>\n <li>\n <p>Each part of a multipart MIME message must be formatted properly.</p>\n </li>\n <li>\n <p>If you include attachments, they must be in a file format that the Amazon SES API v2\n supports.\n </p>\n </li>\n <li>\n <p>The entire message must be Base64 encoded.</p>\n </li>\n <li>\n <p>If any of the MIME parts in your message contain content that is outside of\n the 7-bit ASCII character range, you should encode that content to ensure that\n recipients' email clients render the message properly.</p>\n </li>\n <li>\n <p>The length of any single line of text in the message can't exceed 1,000\n characters. This restriction is defined in <a href=\"https://tools.ietf.org/html/rfc5321\">RFC 5321</a>.</p>\n </li>\n </ul>"
}
},
"Template": {
"target": "com.amazonaws.sesv2#Template",
"traits": {
"smithy.api#documentation": "<p>The template to use for the email message.</p>"
}
}
},
"traits": {
"smithy.api#documentation": "<p>An object that defines the entire content of the email, including the message headers\n and the body content. You can create a simple email message, in which you specify the\n subject and the text and HTML versions of the message body. You can also create raw\n messages, in which you specify a complete MIME-formatted message. Raw messages can\n include attachments and custom headers.</p>"
}
},
"com.amazonaws.sesv2#EmailTemplateContent": {
"type": "structure",
"members": {
"Subject": {
"target": "com.amazonaws.sesv2#EmailTemplateSubject",
"traits": {
"smithy.api#documentation": "<p>The subject line of the email.</p>"
}
},
"Text": {
"target": "com.amazonaws.sesv2#EmailTemplateText",
"traits": {
"smithy.api#documentation": "<p>The email body that will be visible to recipients whose email clients do not display\n HTML.</p>"
}
},
"Html": {
"target": "com.amazonaws.sesv2#EmailTemplateHtml",
"traits": {
"smithy.api#documentation": "<p>The HTML body of the email.</p>"
}
}
},
"traits": {
"smithy.api#documentation": "<p>The content of the email, composed of a subject line, an HTML part, and a text-only\n part.</p>"
}
},
"com.amazonaws.sesv2#EmailTemplateData": {
"type": "string",
"traits": {
"smithy.api#documentation": "<p>An object that defines the values to use for message variables in the template. This\n object is a set of key-value pairs. Each key defines a message variable in the template.\n The corresponding value defines the value to use for that variable.</p>",
"smithy.api#length": {
"min": 0,
"max": 262144
}
}
},
"com.amazonaws.sesv2#EmailTemplateHtml": {
"type": "string",
"traits": {
"smithy.api#documentation": "<p>The HTML body of the email.</p>"
}
},
"com.amazonaws.sesv2#EmailTemplateMetadata": {
"type": "structure",
"members": {
"TemplateName": {
"target": "com.amazonaws.sesv2#EmailTemplateName",
"traits": {
"smithy.api#documentation": "<p>The name of the template.</p>"
}
},
"CreatedTimestamp": {
"target": "com.amazonaws.sesv2#Timestamp",
"traits": {
"smithy.api#documentation": "<p>The time and date the template was created.</p>"
}
}
},
"traits": {
"smithy.api#documentation": "<p>Contains information about an email template.</p>"
}
},
"com.amazonaws.sesv2#EmailTemplateMetadataList": {
"type": "list",
"member": {
"target": "com.amazonaws.sesv2#EmailTemplateMetadata"
},
"traits": {
"smithy.api#documentation": "<p>A list of the EmailTemplateMetadata object.</p>"
}
},
"com.amazonaws.sesv2#EmailTemplateName": {
"type": "string",
"traits": {
"smithy.api#documentation": "<p>The name of the template. You will refer to this name when you send email using the\n <code>SendTemplatedEmail</code> or <code>SendBulkTemplatedEmail</code>\n operations.</p>",
"smithy.api#length": {
"min": 1
}
}
},
"com.amazonaws.sesv2#EmailTemplateSubject": {
"type": "string",
"traits": {
"smithy.api#documentation": "<p>The subject line of the email.</p>"
}
},
"com.amazonaws.sesv2#EmailTemplateText": {
"type": "string",
"traits": {
"smithy.api#documentation": "<p>The email body that will be visible to recipients whose email clients do not display\n HTML.</p>"
}
},
"com.amazonaws.sesv2#Enabled": {
"type": "boolean"
},
"com.amazonaws.sesv2#EnabledWrapper": {
"type": "boolean",
"traits": {
"smithy.api#box": {}
}
},
"com.amazonaws.sesv2#ErrorMessage": {
"type": "string"
},
"com.amazonaws.sesv2#Esp": {
"type": "string"
},
"com.amazonaws.sesv2#Esps": {
"type": "list",
"member": {
"target": "com.amazonaws.sesv2#Esp"
}
},
"com.amazonaws.sesv2#EventDestination": {
"type": "structure",
"members": {
"Name": {
"target": "com.amazonaws.sesv2#EventDestinationName",
"traits": {
"smithy.api#documentation": "<p>A name that identifies the event destination.</p>",
"smithy.api#required": {}
}
},
"Enabled": {
"target": "com.amazonaws.sesv2#Enabled",
"traits": {
"smithy.api#documentation": "<p>If <code>true</code>, the event destination is enabled. When the event destination is\n enabled, the specified event types are sent to the destinations in this\n <code>EventDestinationDefinition</code>.</p>\n <p>If <code>false</code>, the event destination is disabled. When the event destination\n is disabled, events aren't sent to the specified destinations.</p>"
}
},
"MatchingEventTypes": {
"target": "com.amazonaws.sesv2#EventTypes",
"traits": {
"smithy.api#documentation": "<p>The types of events that Amazon SES sends to the specified event destinations.</p>",
"smithy.api#required": {}
}
},
"KinesisFirehoseDestination": {
"target": "com.amazonaws.sesv2#KinesisFirehoseDestination",
"traits": {
"smithy.api#documentation": "<p>An object that defines an Amazon Kinesis Data Firehose destination for email events. You can use Amazon Kinesis Data Firehose to\n stream data to other services, such as Amazon S3 and Amazon Redshift.</p>"
}
},
"CloudWatchDestination": {
"target": "com.amazonaws.sesv2#CloudWatchDestination",
"traits": {
"smithy.api#documentation": "<p>An object that defines an Amazon CloudWatch destination for email events. You can use Amazon CloudWatch to\n monitor and gain insights on your email sending metrics.</p>"
}
},
"SnsDestination": {
"target": "com.amazonaws.sesv2#SnsDestination",
"traits": {
"smithy.api#documentation": "<p>An object that defines an Amazon SNS destination for email events. You can use Amazon SNS to\n send notification when certain email events occur.</p>"
}
},
"PinpointDestination": {
"target": "com.amazonaws.sesv2#PinpointDestination",
"traits": {
"smithy.api#documentation": "<p>An object that defines an Amazon Pinpoint project destination for email events. You can send\n email event data to a Amazon Pinpoint project to view metrics using the Transactional Messaging\n dashboards that are built in to Amazon Pinpoint. For more information, see <a href=\"https://docs.aws.amazon.com/pinpoint/latest/userguide/analytics-transactional-messages.html\">Transactional\n Messaging Charts</a> in the <i>Amazon Pinpoint User Guide</i>.</p>"
}
}
},
"traits": {
"smithy.api#documentation": "<p>In the Amazon SES API v2, <i>events</i> include message sends, deliveries, opens,\n clicks, bounces, complaints and delivery delays. <i>Event destinations</i> are places that\n you can send information about these events to. For example, you can send event data to\n Amazon SNS to receive notifications when you receive bounces or complaints, or you can use\n Amazon Kinesis Data Firehose to stream data to Amazon S3 for long-term storage.</p>"
}
},
"com.amazonaws.sesv2#EventDestinationDefinition": {
"type": "structure",
"members": {
"Enabled": {
"target": "com.amazonaws.sesv2#Enabled",
"traits": {
"smithy.api#documentation": "<p>If <code>true</code>, the event destination is enabled. When the event destination is\n enabled, the specified event types are sent to the destinations in this\n <code>EventDestinationDefinition</code>.</p>\n <p>If <code>false</code>, the event destination is disabled. When the event destination\n is disabled, events aren't sent to the specified destinations.</p>"
}
},
"MatchingEventTypes": {
"target": "com.amazonaws.sesv2#EventTypes",
"traits": {
"smithy.api#documentation": "<p>An array that specifies which events the Amazon SES API v2 should send to the destinations in\n this <code>EventDestinationDefinition</code>.</p>"
}
},
"KinesisFirehoseDestination": {
"target": "com.amazonaws.sesv2#KinesisFirehoseDestination",
"traits": {
"smithy.api#documentation": "<p>An object that defines an Amazon Kinesis Data Firehose destination for email events. You can use Amazon Kinesis Data Firehose to\n stream data to other services, such as Amazon S3 and Amazon Redshift.</p>"
}
},
"CloudWatchDestination": {
"target": "com.amazonaws.sesv2#CloudWatchDestination",
"traits": {
"smithy.api#documentation": "<p>An object that defines an Amazon CloudWatch destination for email events. You can use Amazon CloudWatch to\n monitor and gain insights on your email sending metrics.</p>"
}
},
"SnsDestination": {
"target": "com.amazonaws.sesv2#SnsDestination",
"traits": {
"smithy.api#documentation": "<p>An object that defines an Amazon SNS destination for email events. You can use Amazon SNS to\n send notification when certain email events occur.</p>"
}
},
"PinpointDestination": {
"target": "com.amazonaws.sesv2#PinpointDestination",
"traits": {
"smithy.api#documentation": "<p>An object that defines an Amazon Pinpoint project destination for email events. You can send\n email event data to a Amazon Pinpoint project to view metrics using the Transactional Messaging\n dashboards that are built in to Amazon Pinpoint. For more information, see <a href=\"https://docs.aws.amazon.com/pinpoint/latest/userguide/analytics-transactional-messages.html\">Transactional\n Messaging Charts</a> in the <i>Amazon Pinpoint User Guide</i>.</p>"
}
}
},
"traits": {
"smithy.api#documentation": "<p>An object that defines the event destination. Specifically, it defines which services\n receive events from emails sent using the configuration set that the event destination\n is associated with. Also defines the types of events that are sent to the event\n destination.</p>"
}
},
"com.amazonaws.sesv2#EventDestinationName": {
"type": "string",
"traits": {
"smithy.api#documentation": "<p>The name of an event destination.</p>\n <p>\n <i>Events</i> include message sends, deliveries, opens, clicks, bounces,\n and complaints. <i>Event destinations</i> are places that you can send\n information about these events to. For example, you can send event data to Amazon SNS to\n receive notifications when you receive bounces or complaints, or you can use Amazon Kinesis Data Firehose to\n stream data to Amazon S3 for long-term storage.</p>"
}
},
"com.amazonaws.sesv2#EventDestinations": {
"type": "list",
"member": {
"target": "com.amazonaws.sesv2#EventDestination"
}
},
"com.amazonaws.sesv2#EventType": {
"type": "string",
"traits": {
"smithy.api#documentation": "<p>An email sending event type. For example, email sends, opens, and bounces are all\n email events.</p>",
"smithy.api#enum": [
{
"value": "SEND",
"name": "SEND"
},
{
"value": "REJECT",
"name": "REJECT"
},
{
"value": "BOUNCE",
"name": "BOUNCE"
},
{
"value": "COMPLAINT",
"name": "COMPLAINT"
},
{
"value": "DELIVERY",
"name": "DELIVERY"
},
{
"value": "OPEN",
"name": "OPEN"
},
{
"value": "CLICK",
"name": "CLICK"
},
{
"value": "RENDERING_FAILURE",
"name": "RENDERING_FAILURE"
},
{
"value": "DELIVERY_DELAY",
"name": "DELIVERY_DELAY"
},
{
"value": "SUBSCRIPTION",
"name": "SUBSCRIPTION"
}
]
}
},
"com.amazonaws.sesv2#EventTypes": {
"type": "list",
"member": {
"target": "com.amazonaws.sesv2#EventType"
}
},
"com.amazonaws.sesv2#FailedRecordsCount": {
"type": "integer",
"traits": {
"smithy.api#box": {}
}
},
"com.amazonaws.sesv2#FailedRecordsS3Url": {
"type": "string"
},
"com.amazonaws.sesv2#FailureInfo": {
"type": "structure",
"members": {
"FailedRecordsS3Url": {
"target": "com.amazonaws.sesv2#FailedRecordsS3Url",
"traits": {
"smithy.api#documentation": "<p>An Amazon S3 presigned URL that contains all the failed records and related\n information.</p>"
}
},
"ErrorMessage": {
"target": "com.amazonaws.sesv2#ErrorMessage",
"traits": {
"smithy.api#documentation": "<p>A message about why the import job failed.</p>"
}
}
},
"traits": {
"smithy.api#documentation": "<p>An object that contains the failure details about an import job.</p>"
}
},
"com.amazonaws.sesv2#FailureRedirectionURL": {
"type": "string",
"traits": {
"smithy.api#documentation": "<p>The URL that the recipient of the verification email is sent to if his or her address\n is not successfully verified.</p>"
}
},
"com.amazonaws.sesv2#FeedbackId": {
"type": "string"
},
"com.amazonaws.sesv2#GeneralEnforcementStatus": {
"type": "string"
},
"com.amazonaws.sesv2#GetAccount": {
"type": "operation",
"input": {
"target": "com.amazonaws.sesv2#GetAccountRequest"
},
"output": {
"target": "com.amazonaws.sesv2#GetAccountResponse"
},
"errors": [
{
"target": "com.amazonaws.sesv2#BadRequestException"
},
{
"target": "com.amazonaws.sesv2#TooManyRequestsException"
}
],
"traits": {
"smithy.api#documentation": "<p>Obtain information about the email-sending status and capabilities of your Amazon SES\n account in the current AWS Region.</p>",
"smithy.api#http": {
"method": "GET",
"uri": "/v2/email/account",
"code": 200
}
}
},
"com.amazonaws.sesv2#GetAccountRequest": {
"type": "structure",
"members": {},
"traits": {
"smithy.api#documentation": "<p>A request to obtain information about the email-sending capabilities of your Amazon SES\n account.</p>"
}
},
"com.amazonaws.sesv2#GetAccountResponse": {
"type": "structure",
"members": {
"DedicatedIpAutoWarmupEnabled": {
"target": "com.amazonaws.sesv2#Enabled",
"traits": {
"smithy.api#documentation": "<p>Indicates whether or not the automatic warm-up feature is enabled for dedicated IP\n addresses that are associated with your account.</p>"
}
},
"EnforcementStatus": {
"target": "com.amazonaws.sesv2#GeneralEnforcementStatus",
"traits": {
"smithy.api#documentation": "<p>The reputation status of your Amazon SES account. The status can be one of the\n following:</p>\n <ul>\n <li>\n <p>\n <code>HEALTHY</code> There are no reputation-related issues that\n currently impact your account.</p>\n </li>\n <li>\n <p>\n <code>PROBATION</code> We've identified potential issues with your\n Amazon SES account. We're placing your account under review while you work on\n correcting these issues.</p>\n </li>\n <li>\n <p>\n <code>SHUTDOWN</code> Your account's ability to send email is\n currently paused because of an issue with the email sent from your account. When\n you correct the issue, you can contact us and request that your account's\n ability to send email is resumed.</p>\n </li>\n </ul>"
}
},
"ProductionAccessEnabled": {
"target": "com.amazonaws.sesv2#Enabled",
"traits": {
"smithy.api#documentation": "<p>Indicates whether or not your account has production access in the current AWS\n Region.</p>\n <p>If the value is <code>false</code>, then your account is in the\n <i>sandbox</i>. When your account is in the sandbox, you can only send\n email to verified identities. Additionally, the maximum number of emails you can send in\n a 24-hour period (your sending quota) is 200, and the maximum number of emails you can\n send per second (your maximum sending rate) is 1.</p>\n <p>If the value is <code>true</code>, then your account has production access. When your\n account has production access, you can send email to any address. The sending quota and\n maximum sending rate for your account vary based on your specific use case.</p>"
}
},
"SendQuota": {
"target": "com.amazonaws.sesv2#SendQuota",
"traits": {
"smithy.api#documentation": "<p>An object that contains information about the per-day and per-second sending limits\n for your Amazon SES account in the current AWS Region.</p>"
}
},
"SendingEnabled": {
"target": "com.amazonaws.sesv2#Enabled",
"traits": {
"smithy.api#documentation": "<p>Indicates whether or not email sending is enabled for your Amazon SES account in the\n current AWS Region.</p>"
}
},
"SuppressionAttributes": {
"target": "com.amazonaws.sesv2#SuppressionAttributes",
"traits": {
"smithy.api#documentation": "<p>An object that contains information about the email address suppression preferences\n for your account in the current AWS Region.</p>"
}
},
"Details": {
"target": "com.amazonaws.sesv2#AccountDetails",
"traits": {
"smithy.api#documentation": "<p>An object that defines your account details.</p>"
}
}
},
"traits": {
"smithy.api#documentation": "<p>A list of details about the email-sending capabilities of your Amazon SES account in the\n current AWS Region.</p>"
}
},
"com.amazonaws.sesv2#GetBlacklistReports": {
"type": "operation",
"input": {
"target": "com.amazonaws.sesv2#GetBlacklistReportsRequest"
},
"output": {
"target": "com.amazonaws.sesv2#GetBlacklistReportsResponse"
},
"errors": [
{
"target": "com.amazonaws.sesv2#BadRequestException"
},
{
"target": "com.amazonaws.sesv2#NotFoundException"
},
{
"target": "com.amazonaws.sesv2#TooManyRequestsException"
}
],
"traits": {
"smithy.api#documentation": "<p>Retrieve a list of the blacklists that your dedicated IP addresses appear on.</p>",
"smithy.api#http": {
"method": "GET",
"uri": "/v2/email/deliverability-dashboard/blacklist-report",
"code": 200
}
}
},
"com.amazonaws.sesv2#GetBlacklistReportsRequest": {
"type": "structure",
"members": {
"BlacklistItemNames": {
"target": "com.amazonaws.sesv2#BlacklistItemNames",
"traits": {
"smithy.api#documentation": "<p>A list of IP addresses that you want to retrieve blacklist information about. You can\n only specify the dedicated IP addresses that you use to send email using Amazon SES or\n Amazon Pinpoint.</p>",
"smithy.api#httpQuery": "BlacklistItemNames",
"smithy.api#required": {}
}
}
},
"traits": {
"smithy.api#documentation": "<p>A request to retrieve a list of the blacklists that your dedicated IP addresses appear\n on.</p>"
}
},
"com.amazonaws.sesv2#GetBlacklistReportsResponse": {
"type": "structure",
"members": {
"BlacklistReport": {
"target": "com.amazonaws.sesv2#BlacklistReport",
"traits": {
"smithy.api#documentation": "<p>An object that contains information about a blacklist that one of your dedicated IP\n addresses appears on.</p>",
"smithy.api#required": {}
}
}
},
"traits": {
"smithy.api#documentation": "<p>An object that contains information about blacklist events.</p>"
}
},
"com.amazonaws.sesv2#GetConfigurationSet": {
"type": "operation",
"input": {
"target": "com.amazonaws.sesv2#GetConfigurationSetRequest"
},
"output": {
"target": "com.amazonaws.sesv2#GetConfigurationSetResponse"
},
"errors": [
{
"target": "com.amazonaws.sesv2#BadRequestException"
},
{
"target": "com.amazonaws.sesv2#NotFoundException"
},
{
"target": "com.amazonaws.sesv2#TooManyRequestsException"
}
],
"traits": {
"smithy.api#documentation": "<p>Get information about an existing configuration set, including the dedicated IP pool\n that it's associated with, whether or not it's enabled for sending email, and\n more.</p>\n <p>\n <i>Configuration sets</i> are groups of rules that you can apply to the\n emails you send. You apply a configuration set to an email by including a reference to\n the configuration set in the headers of the email. When you apply a configuration set to\n an email, all of the rules in that configuration set are applied to the email.</p>",
"smithy.api#http": {
"method": "GET",
"uri": "/v2/email/configuration-sets/{ConfigurationSetName}",
"code": 200
}
}
},
"com.amazonaws.sesv2#GetConfigurationSetEventDestinations": {
"type": "operation",
"input": {
"target": "com.amazonaws.sesv2#GetConfigurationSetEventDestinationsRequest"
},
"output": {
"target": "com.amazonaws.sesv2#GetConfigurationSetEventDestinationsResponse"
},
"errors": [
{
"target": "com.amazonaws.sesv2#BadRequestException"
},
{
"target": "com.amazonaws.sesv2#NotFoundException"
},
{
"target": "com.amazonaws.sesv2#TooManyRequestsException"
}
],
"traits": {
"smithy.api#documentation": "<p>Retrieve a list of event destinations that are associated with a configuration\n set.</p>\n <p>\n <i>Events</i> include message sends, deliveries, opens, clicks, bounces,\n and complaints. <i>Event destinations</i> are places that you can send\n information about these events to. For example, you can send event data to Amazon SNS to\n receive notifications when you receive bounces or complaints, or you can use Amazon Kinesis Data Firehose to\n stream data to Amazon S3 for long-term storage.</p>",
"smithy.api#http": {
"method": "GET",
"uri": "/v2/email/configuration-sets/{ConfigurationSetName}/event-destinations",
"code": 200
}
}
},
"com.amazonaws.sesv2#GetConfigurationSetEventDestinationsRequest": {
"type": "structure",
"members": {
"ConfigurationSetName": {
"target": "com.amazonaws.sesv2#ConfigurationSetName",
"traits": {
"smithy.api#documentation": "<p>The name of the configuration set that contains the event destination.</p>",
"smithy.api#httpLabel": {},
"smithy.api#required": {}
}
}
},
"traits": {
"smithy.api#documentation": "<p>A request to obtain information about the event destinations for a configuration\n set.</p>"
}
},
"com.amazonaws.sesv2#GetConfigurationSetEventDestinationsResponse": {
"type": "structure",
"members": {
"EventDestinations": {
"target": "com.amazonaws.sesv2#EventDestinations",
"traits": {
"smithy.api#documentation": "<p>An array that includes all of the events destinations that have been configured for\n the configuration set.</p>"
}
}
},
"traits": {
"smithy.api#documentation": "<p>Information about an event destination for a configuration set.</p>"
}
},
"com.amazonaws.sesv2#GetConfigurationSetRequest": {
"type": "structure",
"members": {
"ConfigurationSetName": {
"target": "com.amazonaws.sesv2#ConfigurationSetName",
"traits": {
"smithy.api#documentation": "<p>The name of the configuration set that you want to obtain more information\n about.</p>",
"smithy.api#httpLabel": {},
"smithy.api#required": {}
}
}
},
"traits": {
"smithy.api#documentation": "<p>A request to obtain information about a configuration set.</p>"
}
},
"com.amazonaws.sesv2#GetConfigurationSetResponse": {
"type": "structure",
"members": {
"ConfigurationSetName": {
"target": "com.amazonaws.sesv2#ConfigurationSetName",
"traits": {
"smithy.api#documentation": "<p>The name of the configuration set.</p>"
}
},
"TrackingOptions": {
"target": "com.amazonaws.sesv2#TrackingOptions",
"traits": {
"smithy.api#documentation": "<p>An object that defines the open and click tracking options for emails that you send\n using the configuration set.</p>"
}
},
"DeliveryOptions": {
"target": "com.amazonaws.sesv2#DeliveryOptions",
"traits": {
"smithy.api#documentation": "<p>An object that defines the dedicated IP pool that is used to send emails that you send\n using the configuration set.</p>"
}
},
"ReputationOptions": {
"target": "com.amazonaws.sesv2#ReputationOptions",
"traits": {
"smithy.api#documentation": "<p>An object that defines whether or not Amazon SES collects reputation metrics for the emails\n that you send that use the configuration set.</p>"
}
},
"SendingOptions": {
"target": "com.amazonaws.sesv2#SendingOptions",
"traits": {
"smithy.api#documentation": "<p>An object that defines whether or not Amazon SES can send email that you send using the\n configuration set.</p>"
}
},
"Tags": {
"target": "com.amazonaws.sesv2#TagList",
"traits": {
"smithy.api#documentation": "<p>An array of objects that define the tags (keys and values) that are associated with\n the configuration set.</p>"
}
},
"SuppressionOptions": {
"target": "com.amazonaws.sesv2#SuppressionOptions",
"traits": {
"smithy.api#documentation": "<p>An object that contains information about the suppression list preferences for your\n account.</p>"
}
}
},
"traits": {
"smithy.api#documentation": "<p>Information about a configuration set.</p>"
}
},
"com.amazonaws.sesv2#GetContact": {
"type": "operation",
"input": {
"target": "com.amazonaws.sesv2#GetContactRequest"
},
"output": {
"target": "com.amazonaws.sesv2#GetContactResponse"
},
"errors": [
{
"target": "com.amazonaws.sesv2#BadRequestException"
},
{
"target": "com.amazonaws.sesv2#NotFoundException"
},
{
"target": "com.amazonaws.sesv2#TooManyRequestsException"
}
],
"traits": {
"smithy.api#documentation": "<p>Returns a contact from a contact list.</p>",
"smithy.api#http": {
"method": "GET",
"uri": "/v2/email/contact-lists/{ContactListName}/contacts/{EmailAddress}",
"code": 200
}
}
},
"com.amazonaws.sesv2#GetContactList": {
"type": "operation",
"input": {
"target": "com.amazonaws.sesv2#GetContactListRequest"
},
"output": {
"target": "com.amazonaws.sesv2#GetContactListResponse"
},
"errors": [
{
"target": "com.amazonaws.sesv2#BadRequestException"
},
{
"target": "com.amazonaws.sesv2#NotFoundException"
},
{
"target": "com.amazonaws.sesv2#TooManyRequestsException"
}
],
"traits": {
"smithy.api#documentation": "<p>Returns contact list metadata. It does not return any information about the contacts\n present in the list.</p>",
"smithy.api#http": {
"method": "GET",
"uri": "/v2/email/contact-lists/{ContactListName}",
"code": 200
}
}
},
"com.amazonaws.sesv2#GetContactListRequest": {
"type": "structure",
"members": {
"ContactListName": {
"target": "com.amazonaws.sesv2#ContactListName",
"traits": {
"smithy.api#documentation": "<p>The name of the contact list.</p>",
"smithy.api#httpLabel": {},
"smithy.api#required": {}
}
}
}
},
"com.amazonaws.sesv2#GetContactListResponse": {
"type": "structure",
"members": {
"ContactListName": {
"target": "com.amazonaws.sesv2#ContactListName",
"traits": {
"smithy.api#documentation": "<p>The name of the contact list.</p>"
}
},
"Topics": {
"target": "com.amazonaws.sesv2#Topics",
"traits": {
"smithy.api#documentation": "<p>An interest group, theme, or label within a list. A contact list can have multiple\n topics.</p>"
}
},
"Description": {
"target": "com.amazonaws.sesv2#Description",
"traits": {
"smithy.api#documentation": "<p>A description of what the contact list is about.</p>"
}
},
"CreatedTimestamp": {
"target": "com.amazonaws.sesv2#Timestamp",
"traits": {
"smithy.api#documentation": "<p>A timestamp noting when the contact list was created.</p>"
}
},
"LastUpdatedTimestamp": {
"target": "com.amazonaws.sesv2#Timestamp",
"traits": {
"smithy.api#documentation": "<p>A timestamp noting the last time the contact list was updated.</p>"
}
},
"Tags": {
"target": "com.amazonaws.sesv2#TagList",
"traits": {
"smithy.api#documentation": "<p>The tags associated with a contact list.</p>"
}
}
}
},
"com.amazonaws.sesv2#GetContactRequest": {
"type": "structure",
"members": {
"ContactListName": {
"target": "com.amazonaws.sesv2#ContactListName",
"traits": {
"smithy.api#documentation": "<p>The name of the contact list to which the contact belongs.</p>",
"smithy.api#httpLabel": {},
"smithy.api#required": {}
}
},
"EmailAddress": {
"target": "com.amazonaws.sesv2#EmailAddress",
"traits": {
"smithy.api#documentation": "<p>The contact's email addres.</p>",
"smithy.api#httpLabel": {},
"smithy.api#required": {}
}
}
}
},
"com.amazonaws.sesv2#GetContactResponse": {
"type": "structure",
"members": {
"ContactListName": {
"target": "com.amazonaws.sesv2#ContactListName",
"traits": {
"smithy.api#documentation": "<p>The name of the contact list to which the contact belongs.</p>"
}
},
"EmailAddress": {
"target": "com.amazonaws.sesv2#EmailAddress",
"traits": {
"smithy.api#documentation": "<p>The contact's email addres.</p>"
}
},
"TopicPreferences": {
"target": "com.amazonaws.sesv2#TopicPreferenceList",
"traits": {
"smithy.api#documentation": "<p>The contact's preference for being opted-in to or opted-out of a topic.></p>"
}
},
"TopicDefaultPreferences": {
"target": "com.amazonaws.sesv2#TopicPreferenceList",
"traits": {
"smithy.api#documentation": "<p>The default topic preferences applied to the contact.</p>"
}
},
"UnsubscribeAll": {
"target": "com.amazonaws.sesv2#UnsubscribeAll",
"traits": {
"smithy.api#documentation": "<p>A boolean value status noting if the contact is unsubscribed from all contact list\n topics.</p>"
}
},
"AttributesData": {
"target": "com.amazonaws.sesv2#AttributesData",
"traits": {
"smithy.api#documentation": "<p>The attribute data attached to a contact.</p>"
}
},
"CreatedTimestamp": {
"target": "com.amazonaws.sesv2#Timestamp",
"traits": {
"smithy.api#documentation": "<p>A timestamp noting when the contact was created.</p>"
}
},
"LastUpdatedTimestamp": {
"target": "com.amazonaws.sesv2#Timestamp",
"traits": {
"smithy.api#documentation": "<p>A timestamp noting the last time the contact's information was updated.</p>"
}
}
}
},
"com.amazonaws.sesv2#GetCustomVerificationEmailTemplate": {
"type": "operation",
"input": {
"target": "com.amazonaws.sesv2#GetCustomVerificationEmailTemplateRequest"
},
"output": {
"target": "com.amazonaws.sesv2#GetCustomVerificationEmailTemplateResponse"
},
"errors": [
{
"target": "com.amazonaws.sesv2#BadRequestException"
},
{
"target": "com.amazonaws.sesv2#NotFoundException"
},
{
"target": "com.amazonaws.sesv2#TooManyRequestsException"
}
],
"traits": {
"smithy.api#documentation": "<p>Returns the custom email verification template for the template name you\n specify.</p>\n <p>For more information about custom verification email templates, see <a href=\"https://docs.aws.amazon.com/ses/latest/DeveloperGuide/send-email-verify-address-custom.html\">Using Custom Verification Email Templates</a> in the <i>Amazon SES Developer\n Guide</i>.</p>\n <p>You can execute this operation no more than once per second.</p>",
"smithy.api#http": {
"method": "GET",
"uri": "/v2/email/custom-verification-email-templates/{TemplateName}",
"code": 200
}
}
},
"com.amazonaws.sesv2#GetCustomVerificationEmailTemplateRequest": {
"type": "structure",
"members": {
"TemplateName": {
"target": "com.amazonaws.sesv2#EmailTemplateName",
"traits": {
"smithy.api#documentation": "<p>The name of the custom verification email template that you want to retrieve.</p>",
"smithy.api#httpLabel": {},
"smithy.api#required": {}
}
}
},
"traits": {
"smithy.api#documentation": "<p>Represents a request to retrieve an existing custom verification email\n template.</p>"
}
},
"com.amazonaws.sesv2#GetCustomVerificationEmailTemplateResponse": {
"type": "structure",
"members": {
"TemplateName": {
"target": "com.amazonaws.sesv2#EmailTemplateName",
"traits": {
"smithy.api#documentation": "<p>The name of the custom verification email template.</p>"
}
},
"FromEmailAddress": {
"target": "com.amazonaws.sesv2#EmailAddress",
"traits": {
"smithy.api#documentation": "<p>The email address that the custom verification email is sent from.</p>"
}
},
"TemplateSubject": {
"target": "com.amazonaws.sesv2#EmailTemplateSubject",
"traits": {
"smithy.api#documentation": "<p>The subject line of the custom verification email.</p>"
}
},
"TemplateContent": {
"target": "com.amazonaws.sesv2#TemplateContent",
"traits": {
"smithy.api#documentation": "<p>The content of the custom verification email.</p>"
}
},
"SuccessRedirectionURL": {
"target": "com.amazonaws.sesv2#SuccessRedirectionURL",
"traits": {
"smithy.api#documentation": "<p>The URL that the recipient of the verification email is sent to if his or her address\n is successfully verified.</p>"
}
},
"FailureRedirectionURL": {
"target": "com.amazonaws.sesv2#FailureRedirectionURL",
"traits": {
"smithy.api#documentation": "<p>The URL that the recipient of the verification email is sent to if his or her address\n is not successfully verified.</p>"
}
}
},
"traits": {
"smithy.api#documentation": "<p>The following elements are returned by the service.</p>"
}
},
"com.amazonaws.sesv2#GetDedicatedIp": {
"type": "operation",
"input": {
"target": "com.amazonaws.sesv2#GetDedicatedIpRequest"
},
"output": {
"target": "com.amazonaws.sesv2#GetDedicatedIpResponse"
},
"errors": [
{
"target": "com.amazonaws.sesv2#BadRequestException"
},
{
"target": "com.amazonaws.sesv2#NotFoundException"
},
{
"target": "com.amazonaws.sesv2#TooManyRequestsException"
}
],
"traits": {
"smithy.api#documentation": "<p>Get information about a dedicated IP address, including the name of the dedicated IP\n pool that it's associated with, as well information about the automatic warm-up process\n for the address.</p>",
"smithy.api#http": {
"method": "GET",
"uri": "/v2/email/dedicated-ips/{Ip}",
"code": 200
}
}
},
"com.amazonaws.sesv2#GetDedicatedIpRequest": {
"type": "structure",
"members": {
"Ip": {
"target": "com.amazonaws.sesv2#Ip",
"traits": {
"smithy.api#documentation": "<p>The IP address that you want to obtain more information about. The value you specify\n has to be a dedicated IP address that's assocaited with your AWS account.</p>",
"smithy.api#httpLabel": {},
"smithy.api#required": {}
}
}
},
"traits": {
"smithy.api#documentation": "<p>A request to obtain more information about a dedicated IP address.</p>"
}
},
"com.amazonaws.sesv2#GetDedicatedIpResponse": {
"type": "structure",
"members": {
"DedicatedIp": {
"target": "com.amazonaws.sesv2#DedicatedIp",
"traits": {
"smithy.api#documentation": "<p>An object that contains information about a dedicated IP address.</p>"
}
}
},
"traits": {
"smithy.api#documentation": "<p>Information about a dedicated IP address.</p>"
}
},
"com.amazonaws.sesv2#GetDedicatedIps": {
"type": "operation",
"input": {
"target": "com.amazonaws.sesv2#GetDedicatedIpsRequest"
},
"output": {
"target": "com.amazonaws.sesv2#GetDedicatedIpsResponse"
},
"errors": [
{
"target": "com.amazonaws.sesv2#BadRequestException"
},
{
"target": "com.amazonaws.sesv2#NotFoundException"
},
{
"target": "com.amazonaws.sesv2#TooManyRequestsException"
}
],
"traits": {
"smithy.api#documentation": "<p>List the dedicated IP addresses that are associated with your AWS\n account.</p>",
"smithy.api#http": {
"method": "GET",
"uri": "/v2/email/dedicated-ips",
"code": 200
},
"smithy.api#paginated": {
"inputToken": "NextToken",
"outputToken": "NextToken",
"pageSize": "PageSize"
}
}
},
"com.amazonaws.sesv2#GetDedicatedIpsRequest": {
"type": "structure",
"members": {
"PoolName": {
"target": "com.amazonaws.sesv2#PoolName",
"traits": {
"smithy.api#documentation": "<p>The name of the IP pool that the dedicated IP address is associated with.</p>",
"smithy.api#httpQuery": "PoolName"
}
},
"NextToken": {
"target": "com.amazonaws.sesv2#NextToken",
"traits": {
"smithy.api#documentation": "<p>A token returned from a previous call to <code>GetDedicatedIps</code> to indicate the\n position of the dedicated IP pool in the list of IP pools.</p>",
"smithy.api#httpQuery": "NextToken"
}
},
"PageSize": {
"target": "com.amazonaws.sesv2#MaxItems",
"traits": {
"smithy.api#documentation": "<p>The number of results to show in a single call to <code>GetDedicatedIpsRequest</code>.\n If the number of results is larger than the number you specified in this parameter, then\n the response includes a <code>NextToken</code> element, which you can use to obtain\n additional results.</p>",
"smithy.api#httpQuery": "PageSize"
}
}
},
"traits": {
"smithy.api#documentation": "<p>A request to obtain more information about dedicated IP pools.</p>"
}
},
"com.amazonaws.sesv2#GetDedicatedIpsResponse": {
"type": "structure",
"members": {
"DedicatedIps": {
"target": "com.amazonaws.sesv2#DedicatedIpList",
"traits": {
"smithy.api#documentation": "<p>A list of dedicated IP addresses that are associated with your AWS account.</p>"
}
},
"NextToken": {
"target": "com.amazonaws.sesv2#NextToken",
"traits": {
"smithy.api#documentation": "<p>A token that indicates that there are additional dedicated IP addresses to list. To\n view additional addresses, issue another request to <code>GetDedicatedIps</code>,\n passing this token in the <code>NextToken</code> parameter.</p>"
}
}
},
"traits": {
"smithy.api#documentation": "<p>Information about the dedicated IP addresses that are associated with your AWS\n account.</p>"
}
},
"com.amazonaws.sesv2#GetDeliverabilityDashboardOptions": {
"type": "operation",
"input": {
"target": "com.amazonaws.sesv2#GetDeliverabilityDashboardOptionsRequest"
},
"output": {
"target": "com.amazonaws.sesv2#GetDeliverabilityDashboardOptionsResponse"
},
"errors": [
{
"target": "com.amazonaws.sesv2#BadRequestException"
},
{
"target": "com.amazonaws.sesv2#LimitExceededException"
},
{
"target": "com.amazonaws.sesv2#TooManyRequestsException"
}
],
"traits": {
"smithy.api#documentation": "<p>Retrieve information about the status of the Deliverability dashboard for your account. When\n the Deliverability dashboard is enabled, you gain access to reputation, deliverability, and other\n metrics for the domains that you use to send email. You also gain the ability to perform\n predictive inbox placement tests.</p>\n \n <p>When you use the Deliverability dashboard, you pay a monthly subscription charge, in addition\n to any other fees that you accrue by using Amazon SES and other AWS services. For more\n information about the features and cost of a Deliverability dashboard subscription, see <a href=\"http://aws.amazon.com/ses/pricing/\">Amazon SES Pricing</a>.</p>",
"smithy.api#http": {
"method": "GET",
"uri": "/v2/email/deliverability-dashboard",
"code": 200
}
}
},
"com.amazonaws.sesv2#GetDeliverabilityDashboardOptionsRequest": {
"type": "structure",
"members": {},
"traits": {
"smithy.api#documentation": "<p>Retrieve information about the status of the Deliverability dashboard for your AWS account.\n When the Deliverability dashboard is enabled, you gain access to reputation, deliverability, and\n other metrics for your domains. You also gain the ability to perform predictive inbox placement tests.</p>\n \n <p>When you use the Deliverability dashboard, you pay a monthly subscription charge, in addition\n to any other fees that you accrue by using Amazon SES and other AWS services. For more\n information about the features and cost of a Deliverability dashboard subscription, see <a href=\"http://aws.amazon.com/pinpoint/pricing/\">Amazon Pinpoint Pricing</a>.</p>"
}
},
"com.amazonaws.sesv2#GetDeliverabilityDashboardOptionsResponse": {
"type": "structure",
"members": {
"DashboardEnabled": {
"target": "com.amazonaws.sesv2#Enabled",
"traits": {
"smithy.api#documentation": "<p>Specifies whether the Deliverability dashboard is enabled. If this value is <code>true</code>,\n the dashboard is enabled.</p>",
"smithy.api#required": {}
}
},
"SubscriptionExpiryDate": {
"target": "com.amazonaws.sesv2#Timestamp",
"traits": {
"smithy.api#documentation": "<p>The date, in Unix time format, when your current subscription to the Deliverability dashboard\n is scheduled to expire, if your subscription is scheduled to expire at the end of the\n current calendar month. This value is null if you have an active subscription that isnt\n due to expire at the end of the month.</p>"
}
},
"AccountStatus": {
"target": "com.amazonaws.sesv2#DeliverabilityDashboardAccountStatus",
"traits": {
"smithy.api#documentation": "<p>The current status of your Deliverability dashboard subscription. If this value is\n <code>PENDING_EXPIRATION</code>, your subscription is scheduled to expire at the end\n of the current calendar month.</p>"
}
},
"ActiveSubscribedDomains": {
"target": "com.amazonaws.sesv2#DomainDeliverabilityTrackingOptions",
"traits": {
"smithy.api#documentation": "<p>An array of objects, one for each verified domain that you use to send email and\n currently has an active Deliverability dashboard subscription that isnt scheduled to expire at\n the end of the current calendar month.</p>"
}
},
"PendingExpirationSubscribedDomains": {
"target": "com.amazonaws.sesv2#DomainDeliverabilityTrackingOptions",
"traits": {
"smithy.api#documentation": "<p>An array of objects, one for each verified domain that you use to send email and\n currently has an active Deliverability dashboard subscription that's scheduled to expire at the\n end of the current calendar month.</p>"
}
}
},
"traits": {
"smithy.api#documentation": "<p>An object that shows the status of the Deliverability dashboard.</p>"
}
},
"com.amazonaws.sesv2#GetDeliverabilityTestReport": {
"type": "operation",
"input": {
"target": "com.amazonaws.sesv2#GetDeliverabilityTestReportRequest"
},
"output": {
"target": "com.amazonaws.sesv2#GetDeliverabilityTestReportResponse"
},
"errors": [
{
"target": "com.amazonaws.sesv2#BadRequestException"
},
{
"target": "com.amazonaws.sesv2#NotFoundException"
},
{
"target": "com.amazonaws.sesv2#TooManyRequestsException"
}
],
"traits": {
"smithy.api#documentation": "<p>Retrieve the results of a predictive inbox placement test.</p>",
"smithy.api#http": {
"method": "GET",
"uri": "/v2/email/deliverability-dashboard/test-reports/{ReportId}",
"code": 200
}
}
},
"com.amazonaws.sesv2#GetDeliverabilityTestReportRequest": {
"type": "structure",
"members": {
"ReportId": {
"target": "com.amazonaws.sesv2#ReportId",
"traits": {
"smithy.api#documentation": "<p>A unique string that identifies the predictive inbox placement test.</p>",
"smithy.api#httpLabel": {},
"smithy.api#required": {}
}
}
},
"traits": {
"smithy.api#documentation": "<p>A request to retrieve the results of a predictive inbox placement test.</p>"
}
},
"com.amazonaws.sesv2#GetDeliverabilityTestReportResponse": {
"type": "structure",
"members": {
"DeliverabilityTestReport": {
"target": "com.amazonaws.sesv2#DeliverabilityTestReport",
"traits": {
"smithy.api#documentation": "<p>An object that contains the results of the predictive inbox placement test.</p>",
"smithy.api#required": {}
}
},
"OverallPlacement": {
"target": "com.amazonaws.sesv2#PlacementStatistics",
"traits": {
"smithy.api#documentation": "<p>An object that specifies how many test messages that were sent during the predictive inbox placement test were\n delivered to recipients' inboxes, how many were sent to recipients' spam folders, and\n how many weren't delivered.</p>",
"smithy.api#required": {}
}
},
"IspPlacements": {
"target": "com.amazonaws.sesv2#IspPlacements",
"traits": {
"smithy.api#documentation": "<p>An object that describes how the test email was handled by several email providers,\n including Gmail, Hotmail, Yahoo, AOL, and others.</p>",
"smithy.api#required": {}
}
},
"Message": {
"target": "com.amazonaws.sesv2#MessageContent",
"traits": {
"smithy.api#documentation": "<p>An object that contains the message that you sent when you performed this\n predictive inbox placement test.</p>"
}
},
"Tags": {
"target": "com.amazonaws.sesv2#TagList",
"traits": {
"smithy.api#documentation": "<p>An array of objects that define the tags (keys and values) that are associated with\n the predictive inbox placement test.</p>"
}
}
},
"traits": {
"smithy.api#documentation": "<p>The results of the predictive inbox placement test.</p>"
}
},
"com.amazonaws.sesv2#GetDomainDeliverabilityCampaign": {
"type": "operation",
"input": {
"target": "com.amazonaws.sesv2#GetDomainDeliverabilityCampaignRequest"
},
"output": {
"target": "com.amazonaws.sesv2#GetDomainDeliverabilityCampaignResponse"
},
"errors": [
{
"target": "com.amazonaws.sesv2#BadRequestException"
},
{
"target": "com.amazonaws.sesv2#NotFoundException"
},
{
"target": "com.amazonaws.sesv2#TooManyRequestsException"
}
],
"traits": {
"smithy.api#documentation": "<p>Retrieve all the deliverability data for a specific campaign. This data is available\n for a campaign only if the campaign sent email by using a domain that the\n Deliverability dashboard is enabled for.</p>",
"smithy.api#http": {
"method": "GET",
"uri": "/v2/email/deliverability-dashboard/campaigns/{CampaignId}",
"code": 200
}
}
},
"com.amazonaws.sesv2#GetDomainDeliverabilityCampaignRequest": {
"type": "structure",
"members": {
"CampaignId": {
"target": "com.amazonaws.sesv2#CampaignId",
"traits": {
"smithy.api#documentation": "<p>The unique identifier for the campaign. The Deliverability dashboard automatically generates\n and assigns this identifier to a campaign.</p>",
"smithy.api#httpLabel": {},
"smithy.api#required": {}
}
}
},
"traits": {
"smithy.api#documentation": "<p>Retrieve all the deliverability data for a specific campaign. This data is available\n for a campaign only if the campaign sent email by using a domain that the\n Deliverability dashboard is enabled for (<code>PutDeliverabilityDashboardOption</code>\n operation).</p>"
}
},
"com.amazonaws.sesv2#GetDomainDeliverabilityCampaignResponse": {
"type": "structure",
"members": {
"DomainDeliverabilityCampaign": {
"target": "com.amazonaws.sesv2#DomainDeliverabilityCampaign",
"traits": {
"smithy.api#documentation": "<p>An object that contains the deliverability data for the campaign.</p>",
"smithy.api#required": {}
}
}
},
"traits": {
"smithy.api#documentation": "<p>An object that contains all the deliverability data for a specific campaign. This data\n is available for a campaign only if the campaign sent email by using a domain that the\n Deliverability dashboard is enabled for.</p>"
}
},
"com.amazonaws.sesv2#GetDomainStatisticsReport": {
"type": "operation",
"input": {
"target": "com.amazonaws.sesv2#GetDomainStatisticsReportRequest"
},
"output": {
"target": "com.amazonaws.sesv2#GetDomainStatisticsReportResponse"
},
"errors": [
{
"target": "com.amazonaws.sesv2#BadRequestException"
},
{
"target": "com.amazonaws.sesv2#NotFoundException"
},
{
"target": "com.amazonaws.sesv2#TooManyRequestsException"
}
],
"traits": {
"smithy.api#documentation": "<p>Retrieve inbox placement and engagement rates for the domains that you use to send\n email.</p>",
"smithy.api#http": {
"method": "GET",
"uri": "/v2/email/deliverability-dashboard/statistics-report/{Domain}",
"code": 200
}
}
},
"com.amazonaws.sesv2#GetDomainStatisticsReportRequest": {
"type": "structure",
"members": {
"Domain": {
"target": "com.amazonaws.sesv2#Identity",
"traits": {
"smithy.api#documentation": "<p>The domain that you want to obtain deliverability metrics for.</p>",
"smithy.api#httpLabel": {},
"smithy.api#required": {}
}
},
"StartDate": {
"target": "com.amazonaws.sesv2#Timestamp",
"traits": {
"smithy.api#documentation": "<p>The first day (in Unix time) that you want to obtain domain deliverability metrics\n for.</p>",
"smithy.api#httpQuery": "StartDate",
"smithy.api#required": {}
}
},
"EndDate": {
"target": "com.amazonaws.sesv2#Timestamp",
"traits": {
"smithy.api#documentation": "<p>The last day (in Unix time) that you want to obtain domain deliverability metrics for.\n The <code>EndDate</code> that you specify has to be less than or equal to 30 days after\n the <code>StartDate</code>.</p>",
"smithy.api#httpQuery": "EndDate",
"smithy.api#required": {}
}
}
},
"traits": {
"smithy.api#documentation": "<p>A request to obtain deliverability metrics for a domain.</p>"
}
},
"com.amazonaws.sesv2#GetDomainStatisticsReportResponse": {
"type": "structure",
"members": {
"OverallVolume": {
"target": "com.amazonaws.sesv2#OverallVolume",
"traits": {
"smithy.api#documentation": "<p>An object that contains deliverability metrics for the domain that you specified. The\n data in this object is a summary of all of the data that was collected from the\n <code>StartDate</code> to the <code>EndDate</code>.</p>",
"smithy.api#required": {}
}
},
"DailyVolumes": {
"target": "com.amazonaws.sesv2#DailyVolumes",
"traits": {
"smithy.api#documentation": "<p>An object that contains deliverability metrics for the domain that you specified. This\n object contains data for each day, starting on the <code>StartDate</code> and ending on\n the <code>EndDate</code>.</p>",
"smithy.api#required": {}
}
}
},
"traits": {
"smithy.api#documentation": "<p>An object that includes statistics that are related to the domain that you\n specified.</p>"
}
},
"com.amazonaws.sesv2#GetEmailIdentity": {
"type": "operation",
"input": {
"target": "com.amazonaws.sesv2#GetEmailIdentityRequest"
},
"output": {
"target": "com.amazonaws.sesv2#GetEmailIdentityResponse"
},
"errors": [
{
"target": "com.amazonaws.sesv2#BadRequestException"
},
{
"target": "com.amazonaws.sesv2#NotFoundException"
},
{
"target": "com.amazonaws.sesv2#TooManyRequestsException"
}
],
"traits": {
"smithy.api#documentation": "<p>Provides information about a specific identity, including the identity's verification\n status, sending authorization policies, its DKIM authentication status, and its custom\n Mail-From settings.</p>",
"smithy.api#http": {
"method": "GET",
"uri": "/v2/email/identities/{EmailIdentity}",
"code": 200
}
}
},
"com.amazonaws.sesv2#GetEmailIdentityPolicies": {
"type": "operation",
"input": {
"target": "com.amazonaws.sesv2#GetEmailIdentityPoliciesRequest"
},
"output": {
"target": "com.amazonaws.sesv2#GetEmailIdentityPoliciesResponse"
},
"errors": [
{
"target": "com.amazonaws.sesv2#BadRequestException"
},
{
"target": "com.amazonaws.sesv2#NotFoundException"
},
{
"target": "com.amazonaws.sesv2#TooManyRequestsException"
}
],
"traits": {
"smithy.api#documentation": "<p>Returns the requested sending authorization policies for the given identity (an email\n address or a domain). The policies are returned as a map of policy names to policy\n contents. You can retrieve a maximum of 20 policies at a time.</p>\n <note>\n <p>This API is for the identity owner only. If you have not verified the identity,\n this API will return an error.</p>\n </note>\n <p>Sending authorization is a feature that enables an identity owner to authorize other\n senders to use its identities. For information about using sending authorization, see\n the <a href=\"https://docs.aws.amazon.com/ses/latest/DeveloperGuide/sending-authorization.html\">Amazon SES Developer\n Guide</a>.</p>\n <p>You can execute this operation no more than once per second.</p>",
"smithy.api#http": {
"method": "GET",
"uri": "/v2/email/identities/{EmailIdentity}/policies",
"code": 200
}
}
},
"com.amazonaws.sesv2#GetEmailIdentityPoliciesRequest": {
"type": "structure",
"members": {
"EmailIdentity": {
"target": "com.amazonaws.sesv2#Identity",
"traits": {
"smithy.api#documentation": "<p>The email identity that you want to retrieve policies for.</p>",
"smithy.api#httpLabel": {},
"smithy.api#required": {}
}
}
},
"traits": {
"smithy.api#documentation": "<p>A request to return the policies of an email identity.</p>"
}
},
"com.amazonaws.sesv2#GetEmailIdentityPoliciesResponse": {
"type": "structure",
"members": {
"Policies": {
"target": "com.amazonaws.sesv2#PolicyMap",
"traits": {
"smithy.api#documentation": "<p>A map of policy names to policies.</p>"
}
}
},
"traits": {
"smithy.api#documentation": "<p>Identity policies associated with email identity.</p>"
}
},
"com.amazonaws.sesv2#GetEmailIdentityRequest": {
"type": "structure",
"members": {
"EmailIdentity": {
"target": "com.amazonaws.sesv2#Identity",
"traits": {
"smithy.api#documentation": "<p>The email identity that you want to retrieve details for.</p>",
"smithy.api#httpLabel": {},
"smithy.api#required": {}
}
}
},
"traits": {
"smithy.api#documentation": "<p>A request to return details about an email identity.</p>"
}
},
"com.amazonaws.sesv2#GetEmailIdentityResponse": {
"type": "structure",
"members": {
"IdentityType": {
"target": "com.amazonaws.sesv2#IdentityType",
"traits": {
"smithy.api#documentation": "<p>The email identity type.</p>"
}
},
"FeedbackForwardingStatus": {
"target": "com.amazonaws.sesv2#Enabled",
"traits": {
"smithy.api#documentation": "<p>The feedback forwarding configuration for the identity.</p>\n <p>If the value is <code>true</code>, you receive email notifications when bounce or\n complaint events occur. These notifications are sent to the address that you specified\n in the <code>Return-Path</code> header of the original email.</p>\n <p>You're required to have a method of tracking bounces and complaints. If you haven't\n set up another mechanism for receiving bounce or complaint notifications (for example,\n by setting up an event destination), you receive an email notification when these events\n occur (even if this setting is disabled).</p>"
}
},
"VerifiedForSendingStatus": {
"target": "com.amazonaws.sesv2#Enabled",
"traits": {
"smithy.api#documentation": "<p>Specifies whether or not the identity is verified. You can only send email from\n verified email addresses or domains. For more information about verifying identities,\n see the <a href=\"https://docs.aws.amazon.com/pinpoint/latest/userguide/channels-email-manage-verify.html\">Amazon Pinpoint User Guide</a>.</p>"
}
},
"DkimAttributes": {
"target": "com.amazonaws.sesv2#DkimAttributes",
"traits": {
"smithy.api#documentation": "<p>An object that contains information about the DKIM attributes for the identity.</p>"
}
},
"MailFromAttributes": {
"target": "com.amazonaws.sesv2#MailFromAttributes",
"traits": {
"smithy.api#documentation": "<p>An object that contains information about the Mail-From attributes for the email\n identity.</p>"
}
},
"Policies": {
"target": "com.amazonaws.sesv2#PolicyMap",
"traits": {
"smithy.api#documentation": "<p>A map of policy names to policies.</p>"
}
},
"Tags": {
"target": "com.amazonaws.sesv2#TagList",
"traits": {
"smithy.api#documentation": "<p>An array of objects that define the tags (keys and values) that are associated with\n the email identity.</p>"
}
},
"ConfigurationSetName": {
"target": "com.amazonaws.sesv2#ConfigurationSetName",
"traits": {
"smithy.api#documentation": "<p>The configuration set used by default when sending from this identity.</p>"
}
}
},
"traits": {
"smithy.api#documentation": "<p>Details about an email identity.</p>"
}
},
"com.amazonaws.sesv2#GetEmailTemplate": {
"type": "operation",
"input": {
"target": "com.amazonaws.sesv2#GetEmailTemplateRequest"
},
"output": {
"target": "com.amazonaws.sesv2#GetEmailTemplateResponse"
},
"errors": [
{
"target": "com.amazonaws.sesv2#BadRequestException"
},
{
"target": "com.amazonaws.sesv2#NotFoundException"
},
{
"target": "com.amazonaws.sesv2#TooManyRequestsException"
}
],
"traits": {
"smithy.api#documentation": "<p>Displays the template object (which includes the subject line, HTML part and text\n part) for the template you specify.</p>\n\n <p>You can execute this operation no more than once per second.</p>",
"smithy.api#http": {
"method": "GET",
"uri": "/v2/email/templates/{TemplateName}",
"code": 200
}
}
},
"com.amazonaws.sesv2#GetEmailTemplateRequest": {
"type": "structure",
"members": {
"TemplateName": {
"target": "com.amazonaws.sesv2#EmailTemplateName",
"traits": {
"smithy.api#documentation": "<p>The name of the template you want to retrieve.</p>",
"smithy.api#httpLabel": {},
"smithy.api#required": {}
}
}
},
"traits": {
"smithy.api#documentation": "<p>Represents a request to display the template object (which includes the subject line,\n HTML part and text part) for the template you specify.</p>"
}
},
"com.amazonaws.sesv2#GetEmailTemplateResponse": {
"type": "structure",
"members": {
"TemplateName": {
"target": "com.amazonaws.sesv2#EmailTemplateName",
"traits": {
"smithy.api#documentation": "<p>The name of the template you want to retrieve.</p>",
"smithy.api#required": {}
}
},
"TemplateContent": {
"target": "com.amazonaws.sesv2#EmailTemplateContent",
"traits": {
"smithy.api#documentation": "<p>The content of the email template, composed of a subject line, an HTML part, and a\n text-only part.</p>",
"smithy.api#required": {}
}
}
},
"traits": {
"smithy.api#documentation": "<p>The following element is returned by the service.</p>"
}
},
"com.amazonaws.sesv2#GetImportJob": {
"type": "operation",
"input": {
"target": "com.amazonaws.sesv2#GetImportJobRequest"
},
"output": {
"target": "com.amazonaws.sesv2#GetImportJobResponse"
},
"errors": [
{
"target": "com.amazonaws.sesv2#BadRequestException"
},
{
"target": "com.amazonaws.sesv2#NotFoundException"
},
{
"target": "com.amazonaws.sesv2#TooManyRequestsException"
}
],
"traits": {
"smithy.api#documentation": "<p>Provides information about an import job.</p>",
"smithy.api#http": {
"method": "GET",
"uri": "/v2/email/import-jobs/{JobId}",
"code": 200
}
}
},
"com.amazonaws.sesv2#GetImportJobRequest": {
"type": "structure",
"members": {
"JobId": {
"target": "com.amazonaws.sesv2#JobId",
"traits": {
"smithy.api#documentation": "<p>The ID of the import job.</p>",
"smithy.api#httpLabel": {},
"smithy.api#required": {}
}
}
},
"traits": {
"smithy.api#documentation": "<p>Represents a request for information about an import job using the import job\n ID.</p>"
}
},
"com.amazonaws.sesv2#GetImportJobResponse": {
"type": "structure",
"members": {
"JobId": {
"target": "com.amazonaws.sesv2#JobId",
"traits": {
"smithy.api#documentation": "<p>A string that represents the import job ID.</p>"
}
},
"ImportDestination": {
"target": "com.amazonaws.sesv2#ImportDestination",
"traits": {
"smithy.api#documentation": "<p>The destination of the import job.</p>"
}
},
"ImportDataSource": {
"target": "com.amazonaws.sesv2#ImportDataSource",
"traits": {
"smithy.api#documentation": "<p>The data source of the import job.</p>"
}
},
"FailureInfo": {
"target": "com.amazonaws.sesv2#FailureInfo",
"traits": {
"smithy.api#documentation": "<p>The failure details about an import job.</p>"
}
},
"JobStatus": {
"target": "com.amazonaws.sesv2#JobStatus",
"traits": {
"smithy.api#documentation": "<p>The status of the import job.</p>"
}
},
"CreatedTimestamp": {
"target": "com.amazonaws.sesv2#Timestamp",
"traits": {
"smithy.api#documentation": "<p>The time stamp of when the import job was created.</p>"
}
},
"CompletedTimestamp": {
"target": "com.amazonaws.sesv2#Timestamp",
"traits": {
"smithy.api#documentation": "<p>The time stamp of when the import job was completed.</p>"
}
},
"ProcessedRecordsCount": {
"target": "com.amazonaws.sesv2#ProcessedRecordsCount",
"traits": {
"smithy.api#documentation": "<p>The current number of records processed.</p>"
}
},
"FailedRecordsCount": {
"target": "com.amazonaws.sesv2#FailedRecordsCount",
"traits": {
"smithy.api#documentation": "<p>The number of records that failed processing because of invalid input or other\n reasons.</p>"
}
}
},
"traits": {
"smithy.api#documentation": "<p>An HTTP 200 response if the request succeeds, or an error message if the request\n fails.</p>"
}
},
"com.amazonaws.sesv2#GetSuppressedDestination": {
"type": "operation",
"input": {
"target": "com.amazonaws.sesv2#GetSuppressedDestinationRequest"
},
"output": {
"target": "com.amazonaws.sesv2#GetSuppressedDestinationResponse"
},
"errors": [
{
"target": "com.amazonaws.sesv2#BadRequestException"
},
{
"target": "com.amazonaws.sesv2#NotFoundException"
},
{
"target": "com.amazonaws.sesv2#TooManyRequestsException"
}
],
"traits": {
"smithy.api#documentation": "<p>Retrieves information about a specific email address that's on the suppression list\n for your account.</p>",
"smithy.api#http": {
"method": "GET",
"uri": "/v2/email/suppression/addresses/{EmailAddress}",
"code": 200
}
}
},
"com.amazonaws.sesv2#GetSuppressedDestinationRequest": {
"type": "structure",
"members": {
"EmailAddress": {
"target": "com.amazonaws.sesv2#EmailAddress",
"traits": {
"smithy.api#documentation": "<p>The email address that's on the account suppression list.</p>",
"smithy.api#httpLabel": {},
"smithy.api#required": {}
}
}
},
"traits": {
"smithy.api#documentation": "<p>A request to retrieve information about an email address that's on the suppression\n list for your account.</p>"
}
},
"com.amazonaws.sesv2#GetSuppressedDestinationResponse": {
"type": "structure",
"members": {
"SuppressedDestination": {
"target": "com.amazonaws.sesv2#SuppressedDestination",
"traits": {
"smithy.api#documentation": "<p>An object containing information about the suppressed email address.</p>",
"smithy.api#required": {}
}
}
},
"traits": {
"smithy.api#documentation": "<p>Information about the suppressed email address.</p>"
}
},
"com.amazonaws.sesv2#Identity": {
"type": "string",
"traits": {
"smithy.api#length": {
"min": 1
}
}
},
"com.amazonaws.sesv2#IdentityInfo": {
"type": "structure",
"members": {
"IdentityType": {
"target": "com.amazonaws.sesv2#IdentityType",
"traits": {
"smithy.api#documentation": "<p>The email identity type. The identity type can be one of the following:</p>\n <ul>\n <li>\n <p>\n <code>EMAIL_ADDRESS</code> The identity is an email address.</p>\n </li>\n <li>\n <p>\n <code>DOMAIN</code> The identity is a domain.</p>\n </li>\n <li>\n <p>\n <code>MANAGED_DOMAIN</code> The identity is a domain that is managed\n by AWS.</p>\n </li>\n </ul>"
}
},
"IdentityName": {
"target": "com.amazonaws.sesv2#Identity",
"traits": {
"smithy.api#documentation": "<p>The address or domain of the identity.</p>"
}
},
"SendingEnabled": {
"target": "com.amazonaws.sesv2#Enabled",
"traits": {
"smithy.api#documentation": "<p>Indicates whether or not you can send email from the identity.</p>\n <p>An <i>identity</i> is an email address or domain that you send email\n from. Before you can send email from an identity, you have to demostrate that you own\n the identity, and that you authorize Amazon SES to send email from that identity.</p>"
}
}
},
"traits": {
"smithy.api#documentation": "<p>Information about an email identity.</p>"
}
},
"com.amazonaws.sesv2#IdentityInfoList": {
"type": "list",
"member": {
"target": "com.amazonaws.sesv2#IdentityInfo"
}
},
"com.amazonaws.sesv2#IdentityType": {
"type": "string",
"traits": {
"smithy.api#documentation": "<p>The email identity type. The identity type can be one of the following:</p>\n <ul>\n <li>\n <p>\n <code>EMAIL_ADDRESS</code> The identity is an email address.</p>\n </li>\n <li>\n <p>\n <code>DOMAIN</code> The identity is a domain.</p>\n </li>\n </ul>",
"smithy.api#enum": [
{
"value": "EMAIL_ADDRESS",
"name": "EMAIL_ADDRESS"
},
{
"value": "DOMAIN",
"name": "DOMAIN"
},
{
"value": "MANAGED_DOMAIN",
"name": "MANAGED_DOMAIN"
}
]
}
},
"com.amazonaws.sesv2#ImageUrl": {
"type": "string"
},
"com.amazonaws.sesv2#ImportDataSource": {
"type": "structure",
"members": {
"S3Url": {
"target": "com.amazonaws.sesv2#S3Url",
"traits": {
"smithy.api#documentation": "<p>An Amazon S3 URL in the format\n s3://<i><bucket_name></i>/<i><object></i>.</p>",
"smithy.api#required": {}
}
},
"DataFormat": {
"target": "com.amazonaws.sesv2#DataFormat",
"traits": {
"smithy.api#documentation": "<p>The data format of the import job's data source.</p>",
"smithy.api#required": {}
}
}
},
"traits": {
"smithy.api#documentation": "<p>An object that contains details about the data source of the import job.</p>"
}
},
"com.amazonaws.sesv2#ImportDestination": {
"type": "structure",
"members": {
"SuppressionListDestination": {
"target": "com.amazonaws.sesv2#SuppressionListDestination",
"traits": {
"smithy.api#documentation": "<p>An object that contains the action of the import job towards suppression list.</p>"
}
},
"ContactListDestination": {
"target": "com.amazonaws.sesv2#ContactListDestination",
"traits": {
"smithy.api#documentation": "<p>An object that contains the action of the import job towards a contact list.</p>"
}
}
},
"traits": {
"smithy.api#documentation": "<p>An object that contains details about the resource destination the import job is going\n to target.</p>"
}
},
"com.amazonaws.sesv2#ImportDestinationType": {
"type": "string",
"traits": {
"smithy.api#documentation": "<p>The destination of the import job, which can be used to list import jobs that have a\n certain <code>ImportDestinationType</code>.</p>",
"smithy.api#enum": [
{
"value": "SUPPRESSION_LIST",
"name": "SUPPRESSION_LIST"
},
{
"value": "CONTACT_LIST",
"name": "CONTACT_LIST"
}
]
}
},
"com.amazonaws.sesv2#ImportJobSummary": {
"type": "structure",
"members": {
"JobId": {
"target": "com.amazonaws.sesv2#JobId"
},
"ImportDestination": {
"target": "com.amazonaws.sesv2#ImportDestination"
},
"JobStatus": {
"target": "com.amazonaws.sesv2#JobStatus"
},
"CreatedTimestamp": {
"target": "com.amazonaws.sesv2#Timestamp",
"traits": {
"smithy.api#documentation": "<p>The date and time when the import job was created.</p>"
}
}
},
"traits": {
"smithy.api#documentation": "<p>A summary of the import job.</p>"
}
},
"com.amazonaws.sesv2#ImportJobSummaryList": {
"type": "list",
"member": {
"target": "com.amazonaws.sesv2#ImportJobSummary"
},
"traits": {
"smithy.api#documentation": "<p>A list of the import job summaries.</p>"
}
},
"com.amazonaws.sesv2#InboxPlacementTrackingOption": {
"type": "structure",
"members": {
"Global": {
"target": "com.amazonaws.sesv2#Enabled",
"traits": {
"smithy.api#documentation": "<p>Specifies whether inbox placement data is being tracked for the domain.</p>"
}
},
"TrackedIsps": {
"target": "com.amazonaws.sesv2#IspNameList",
"traits": {
"smithy.api#documentation": "<p>An array of strings, one for each major email provider that the inbox placement data\n applies to.</p>"
}
}
},
"traits": {
"smithy.api#documentation": "<p>An object that contains information about the inbox placement data settings for a\n verified domain thats associated with your AWS account. This data is available only\n if you enabled the Deliverability dashboard for the domain.</p>"
}
},
"com.amazonaws.sesv2#InvalidNextTokenException": {
"type": "structure",
"members": {
"message": {
"target": "com.amazonaws.sesv2#ErrorMessage"
}
},
"traits": {
"smithy.api#documentation": "<p>The specified request includes an invalid or expired token.</p>",
"smithy.api#error": "client",
"smithy.api#httpError": 400
}
},
"com.amazonaws.sesv2#Ip": {
"type": "string",
"traits": {
"smithy.api#documentation": "<p>An IPv4 address.</p>"
}
},
"com.amazonaws.sesv2#IpList": {
"type": "list",
"member": {
"target": "com.amazonaws.sesv2#Ip"
}
},
"com.amazonaws.sesv2#IspName": {
"type": "string",
"traits": {
"smithy.api#documentation": "<p>The name of an email provider.</p>"
}
},
"com.amazonaws.sesv2#IspNameList": {
"type": "list",
"member": {
"target": "com.amazonaws.sesv2#IspName"
}
},
"com.amazonaws.sesv2#IspPlacement": {
"type": "structure",
"members": {
"IspName": {
"target": "com.amazonaws.sesv2#IspName",
"traits": {
"smithy.api#documentation": "<p>The name of the email provider that the inbox placement data applies to.</p>"
}
},
"PlacementStatistics": {
"target": "com.amazonaws.sesv2#PlacementStatistics",
"traits": {
"smithy.api#documentation": "<p>An object that contains inbox placement metrics for a specific email provider.</p>"
}
}
},
"traits": {
"smithy.api#documentation": "<p>An object that describes how email sent during the predictive inbox placement test was handled by a certain\n email provider.</p>"
}
},
"com.amazonaws.sesv2#IspPlacements": {
"type": "list",
"member": {
"target": "com.amazonaws.sesv2#IspPlacement"
}
},
"com.amazonaws.sesv2#JobId": {
"type": "string",
"traits": {
"smithy.api#documentation": "<p>A string that represents the import job ID.</p>",
"smithy.api#length": {
"min": 1
}
}
},
"com.amazonaws.sesv2#JobStatus": {
"type": "string",
"traits": {
"smithy.api#documentation": "<p>The status of the import job.</p>",
"smithy.api#enum": [
{
"value": "CREATED",
"name": "CREATED"
},
{
"value": "PROCESSING",
"name": "PROCESSING"
},
{
"value": "COMPLETED",
"name": "COMPLETED"
},
{
"value": "FAILED",
"name": "FAILED"
}
]
}
},
"com.amazonaws.sesv2#KinesisFirehoseDestination": {
"type": "structure",
"members": {
"IamRoleArn": {
"target": "com.amazonaws.sesv2#AmazonResourceName",
"traits": {
"smithy.api#documentation": "<p>The Amazon Resource Name (ARN) of the IAM role that the Amazon SES API v2 uses to send email\n events to the Amazon Kinesis Data Firehose stream.</p>",
"smithy.api#required": {}
}
},
"DeliveryStreamArn": {
"target": "com.amazonaws.sesv2#AmazonResourceName",
"traits": {
"smithy.api#documentation": "<p>The Amazon Resource Name (ARN) of the Amazon Kinesis Data Firehose stream that the Amazon SES API v2 sends email\n events to.</p>",
"smithy.api#required": {}
}
}
},
"traits": {
"smithy.api#documentation": "<p>An object that defines an Amazon Kinesis Data Firehose destination for email events. You can use Amazon Kinesis Data Firehose to\n stream data to other services, such as Amazon S3 and Amazon Redshift.</p>"
}
},
"com.amazonaws.sesv2#LastFreshStart": {
"type": "timestamp",
"traits": {
"smithy.api#documentation": "<p>The date and time (in Unix time) when the reputation metrics were last given a fresh\n start. When your account is given a fresh start, your reputation metrics are calculated\n starting from the date of the fresh start.</p>"
}
},
"com.amazonaws.sesv2#LimitExceededException": {
"type": "structure",
"members": {
"message": {
"target": "com.amazonaws.sesv2#ErrorMessage"
}
},
"traits": {
"smithy.api#documentation": "<p>There are too many instances of the specified resource type.</p>",
"smithy.api#error": "client",
"smithy.api#httpError": 400
}
},
"com.amazonaws.sesv2#ListConfigurationSets": {
"type": "operation",
"input": {
"target": "com.amazonaws.sesv2#ListConfigurationSetsRequest"
},
"output": {
"target": "com.amazonaws.sesv2#ListConfigurationSetsResponse"
},
"errors": [
{
"target": "com.amazonaws.sesv2#BadRequestException"
},
{
"target": "com.amazonaws.sesv2#TooManyRequestsException"
}
],
"traits": {
"smithy.api#documentation": "<p>List all of the configuration sets associated with your account in the current\n region.</p>\n <p>\n <i>Configuration sets</i> are groups of rules that you can apply to the\n emails you send. You apply a configuration set to an email by including a reference to\n the configuration set in the headers of the email. When you apply a configuration set to\n an email, all of the rules in that configuration set are applied to the email.</p>",
"smithy.api#http": {
"method": "GET",
"uri": "/v2/email/configuration-sets",
"code": 200
},
"smithy.api#paginated": {
"inputToken": "NextToken",
"outputToken": "NextToken",
"pageSize": "PageSize"
}
}
},
"com.amazonaws.sesv2#ListConfigurationSetsRequest": {
"type": "structure",
"members": {
"NextToken": {
"target": "com.amazonaws.sesv2#NextToken",
"traits": {
"smithy.api#documentation": "<p>A token returned from a previous call to <code>ListConfigurationSets</code> to\n indicate the position in the list of configuration sets.</p>",
"smithy.api#httpQuery": "NextToken"
}
},
"PageSize": {
"target": "com.amazonaws.sesv2#MaxItems",
"traits": {
"smithy.api#documentation": "<p>The number of results to show in a single call to <code>ListConfigurationSets</code>.\n If the number of results is larger than the number you specified in this parameter, then\n the response includes a <code>NextToken</code> element, which you can use to obtain\n additional results.</p>",
"smithy.api#httpQuery": "PageSize"
}
}
},
"traits": {
"smithy.api#documentation": "<p>A request to obtain a list of configuration sets for your Amazon SES account in the current\n AWS Region.</p>"
}
},
"com.amazonaws.sesv2#ListConfigurationSetsResponse": {
"type": "structure",
"members": {
"ConfigurationSets": {
"target": "com.amazonaws.sesv2#ConfigurationSetNameList",
"traits": {
"smithy.api#documentation": "<p>An array that contains all of the configuration sets in your Amazon SES account in the\n current AWS Region.</p>"
}
},
"NextToken": {
"target": "com.amazonaws.sesv2#NextToken",
"traits": {
"smithy.api#documentation": "<p>A token that indicates that there are additional configuration sets to list. To view\n additional configuration sets, issue another request to\n <code>ListConfigurationSets</code>, and pass this token in the\n <code>NextToken</code> parameter.</p>"
}
}
},
"traits": {
"smithy.api#documentation": "<p>A list of configuration sets in your Amazon SES account in the current AWS Region.</p>"
}
},
"com.amazonaws.sesv2#ListContactLists": {
"type": "operation",
"input": {
"target": "com.amazonaws.sesv2#ListContactListsRequest"
},
"output": {
"target": "com.amazonaws.sesv2#ListContactListsResponse"
},
"errors": [
{
"target": "com.amazonaws.sesv2#BadRequestException"
},
{
"target": "com.amazonaws.sesv2#TooManyRequestsException"
}
],
"traits": {
"smithy.api#documentation": "<p>Lists all of the contact lists available.</p>",
"smithy.api#http": {
"method": "GET",
"uri": "/v2/email/contact-lists",
"code": 200
},
"smithy.api#paginated": {
"inputToken": "NextToken",
"outputToken": "NextToken",
"pageSize": "PageSize"
}
}
},
"com.amazonaws.sesv2#ListContactListsRequest": {
"type": "structure",
"members": {
"PageSize": {
"target": "com.amazonaws.sesv2#MaxItems",
"traits": {
"smithy.api#documentation": "<p>Maximum number of contact lists to return at once. Use this parameter to paginate\n results. If additional contact lists exist beyond the specified limit, the\n <code>NextToken</code> element is sent in the response. Use the\n <code>NextToken</code> value in subsequent requests to retrieve additional\n lists.</p>",
"smithy.api#httpQuery": "PageSize"
}
},
"NextToken": {
"target": "com.amazonaws.sesv2#NextToken",
"traits": {
"smithy.api#documentation": "<p>A string token indicating that there might be additional contact lists available to be\n listed. Use the token provided in the Response to use in the subsequent call to\n ListContactLists with the same parameters to retrieve the next page of contact\n lists.</p>",
"smithy.api#httpQuery": "NextToken"
}
}
}
},
"com.amazonaws.sesv2#ListContactListsResponse": {
"type": "structure",
"members": {
"ContactLists": {
"target": "com.amazonaws.sesv2#ListOfContactLists",
"traits": {
"smithy.api#documentation": "<p>The available contact lists.</p>"
}
},
"NextToken": {
"target": "com.amazonaws.sesv2#NextToken",
"traits": {
"smithy.api#documentation": "<p>A string token indicating that there might be additional contact lists available to be\n listed. Copy this token to a subsequent call to <code>ListContactLists</code> with the\n same parameters to retrieve the next page of contact lists.</p>"
}
}
}
},
"com.amazonaws.sesv2#ListContacts": {
"type": "operation",
"input": {
"target": "com.amazonaws.sesv2#ListContactsRequest"
},
"output": {
"target": "com.amazonaws.sesv2#ListContactsResponse"
},
"errors": [
{
"target": "com.amazonaws.sesv2#BadRequestException"
},
{
"target": "com.amazonaws.sesv2#NotFoundException"
},
{
"target": "com.amazonaws.sesv2#TooManyRequestsException"
}
],
"traits": {
"smithy.api#documentation": "<p>Lists the contacts present in a specific contact list.</p>",
"smithy.api#http": {
"method": "GET",
"uri": "/v2/email/contact-lists/{ContactListName}/contacts",
"code": 200
},
"smithy.api#paginated": {
"inputToken": "NextToken",
"outputToken": "NextToken",
"pageSize": "PageSize"
}
}
},
"com.amazonaws.sesv2#ListContactsFilter": {
"type": "structure",
"members": {
"FilteredStatus": {
"target": "com.amazonaws.sesv2#SubscriptionStatus",
"traits": {
"smithy.api#documentation": "<p>The status by which you are filtering: <code>OPT_IN</code> or\n <code>OPT_OUT</code>.</p>"
}
},
"TopicFilter": {
"target": "com.amazonaws.sesv2#TopicFilter",
"traits": {
"smithy.api#documentation": "<p>Used for filtering by a specific topic preference.</p>"
}
}
},
"traits": {
"smithy.api#documentation": "<p>A filter that can be applied to a list of contacts.</p>"
}
},
"com.amazonaws.sesv2#ListContactsRequest": {
"type": "structure",
"members": {
"ContactListName": {
"target": "com.amazonaws.sesv2#ContactListName",
"traits": {
"smithy.api#documentation": "<p>The name of the contact list.</p>",
"smithy.api#httpLabel": {},
"smithy.api#required": {}
}
},
"Filter": {
"target": "com.amazonaws.sesv2#ListContactsFilter",
"traits": {
"smithy.api#documentation": "<p>A filter that can be applied to a list of contacts.</p>"
}
},
"PageSize": {
"target": "com.amazonaws.sesv2#MaxItems",
"traits": {
"smithy.api#documentation": "<p>The number of contacts that may be returned at once, which is dependent on if there\n are more or less contacts than the value of the PageSize. Use this parameter to\n paginate results. If additional contacts exist beyond the specified limit, the\n <code>NextToken</code> element is sent in the response. Use the\n <code>NextToken</code> value in subsequent requests to retrieve additional\n contacts.</p>",
"smithy.api#httpQuery": "PageSize"
}
},
"NextToken": {
"target": "com.amazonaws.sesv2#NextToken",
"traits": {
"smithy.api#documentation": "<p>A string token indicating that there might be additional contacts available to be\n listed. Use the token provided in the Response to use in the subsequent call to\n ListContacts with the same parameters to retrieve the next page of contacts.</p>",
"smithy.api#httpQuery": "NextToken"
}
}
}
},
"com.amazonaws.sesv2#ListContactsResponse": {
"type": "structure",
"members": {
"Contacts": {
"target": "com.amazonaws.sesv2#ListOfContacts",
"traits": {
"smithy.api#documentation": "<p>The contacts present in a specific contact list.</p>"
}
},
"NextToken": {
"target": "com.amazonaws.sesv2#NextToken",
"traits": {
"smithy.api#documentation": "<p>A string token indicating that there might be additional contacts available to be\n listed. Copy this token to a subsequent call to <code>ListContacts</code> with the same\n parameters to retrieve the next page of contacts.</p>"
}
}
}
},
"com.amazonaws.sesv2#ListCustomVerificationEmailTemplates": {
"type": "operation",
"input": {
"target": "com.amazonaws.sesv2#ListCustomVerificationEmailTemplatesRequest"
},
"output": {
"target": "com.amazonaws.sesv2#ListCustomVerificationEmailTemplatesResponse"
},
"errors": [
{
"target": "com.amazonaws.sesv2#BadRequestException"
},
{
"target": "com.amazonaws.sesv2#TooManyRequestsException"
}
],
"traits": {
"smithy.api#documentation": "<p>Lists the existing custom verification email templates for your account in the current\n AWS Region.</p>\n <p>For more information about custom verification email templates, see <a href=\"https://docs.aws.amazon.com/ses/latest/DeveloperGuide/send-email-verify-address-custom.html\">Using Custom Verification Email Templates</a> in the <i>Amazon SES Developer\n Guide</i>.</p>\n <p>You can execute this operation no more than once per second.</p>",
"smithy.api#http": {
"method": "GET",
"uri": "/v2/email/custom-verification-email-templates",
"code": 200
},
"smithy.api#paginated": {
"inputToken": "NextToken",
"outputToken": "NextToken",
"pageSize": "PageSize"
}
}
},
"com.amazonaws.sesv2#ListCustomVerificationEmailTemplatesRequest": {
"type": "structure",
"members": {
"NextToken": {
"target": "com.amazonaws.sesv2#NextToken",
"traits": {
"smithy.api#documentation": "<p>A token returned from a previous call to\n <code>ListCustomVerificationEmailTemplates</code> to indicate the position in the\n list of custom verification email templates.</p>",
"smithy.api#httpQuery": "NextToken"
}
},
"PageSize": {
"target": "com.amazonaws.sesv2#MaxItems",
"traits": {
"smithy.api#documentation": "<p>The number of results to show in a single call to\n <code>ListCustomVerificationEmailTemplates</code>. If the number of results is\n larger than the number you specified in this parameter, then the response includes a\n <code>NextToken</code> element, which you can use to obtain additional\n results.</p>\n <p>The value you specify has to be at least 1, and can be no more than 50.</p>",
"smithy.api#httpQuery": "PageSize"
}
}
},
"traits": {
"smithy.api#documentation": "<p>Represents a request to list the existing custom verification email templates for your\n account.</p>"
}
},
"com.amazonaws.sesv2#ListCustomVerificationEmailTemplatesResponse": {
"type": "structure",
"members": {
"CustomVerificationEmailTemplates": {
"target": "com.amazonaws.sesv2#CustomVerificationEmailTemplatesList",
"traits": {
"smithy.api#documentation": "<p>A list of the custom verification email templates that exist in your account.</p>"
}
},
"NextToken": {
"target": "com.amazonaws.sesv2#NextToken",
"traits": {
"smithy.api#documentation": "<p>A token indicating that there are additional custom verification email templates\n available to be listed. Pass this token to a subsequent call to\n <code>ListCustomVerificationEmailTemplates</code> to retrieve the next 50 custom\n verification email templates.</p>"
}
}
},
"traits": {
"smithy.api#documentation": "<p>The following elements are returned by the service.</p>"
}
},
"com.amazonaws.sesv2#ListDedicatedIpPools": {
"type": "operation",
"input": {
"target": "com.amazonaws.sesv2#ListDedicatedIpPoolsRequest"
},
"output": {
"target": "com.amazonaws.sesv2#ListDedicatedIpPoolsResponse"
},
"errors": [
{
"target": "com.amazonaws.sesv2#BadRequestException"
},
{
"target": "com.amazonaws.sesv2#TooManyRequestsException"
}
],
"traits": {
"smithy.api#documentation": "<p>List all of the dedicated IP pools that exist in your AWS account in the current\n Region.</p>",
"smithy.api#http": {
"method": "GET",
"uri": "/v2/email/dedicated-ip-pools",
"code": 200
},
"smithy.api#paginated": {
"inputToken": "NextToken",
"outputToken": "NextToken",
"pageSize": "PageSize"
}
}
},
"com.amazonaws.sesv2#ListDedicatedIpPoolsRequest": {
"type": "structure",
"members": {
"NextToken": {
"target": "com.amazonaws.sesv2#NextToken",
"traits": {
"smithy.api#documentation": "<p>A token returned from a previous call to <code>ListDedicatedIpPools</code> to indicate\n the position in the list of dedicated IP pools.</p>",
"smithy.api#httpQuery": "NextToken"
}
},
"PageSize": {
"target": "com.amazonaws.sesv2#MaxItems",
"traits": {
"smithy.api#documentation": "<p>The number of results to show in a single call to <code>ListDedicatedIpPools</code>.\n If the number of results is larger than the number you specified in this parameter, then\n the response includes a <code>NextToken</code> element, which you can use to obtain\n additional results.</p>",
"smithy.api#httpQuery": "PageSize"
}
}
},
"traits": {
"smithy.api#documentation": "<p>A request to obtain a list of dedicated IP pools.</p>"
}
},
"com.amazonaws.sesv2#ListDedicatedIpPoolsResponse": {
"type": "structure",
"members": {
"DedicatedIpPools": {
"target": "com.amazonaws.sesv2#ListOfDedicatedIpPools",
"traits": {
"smithy.api#documentation": "<p>A list of all of the dedicated IP pools that are associated with your AWS account in\n the current Region.</p>"
}
},
"NextToken": {
"target": "com.amazonaws.sesv2#NextToken",
"traits": {
"smithy.api#documentation": "<p>A token that indicates that there are additional IP pools to list. To view additional\n IP pools, issue another request to <code>ListDedicatedIpPools</code>, passing this token\n in the <code>NextToken</code> parameter.</p>"
}
}
},
"traits": {
"smithy.api#documentation": "<p>A list of dedicated IP pools.</p>"
}
},
"com.amazonaws.sesv2#ListDeliverabilityTestReports": {
"type": "operation",
"input": {
"target": "com.amazonaws.sesv2#ListDeliverabilityTestReportsRequest"
},
"output": {
"target": "com.amazonaws.sesv2#ListDeliverabilityTestReportsResponse"
},
"errors": [
{
"target": "com.amazonaws.sesv2#BadRequestException"
},
{
"target": "com.amazonaws.sesv2#NotFoundException"
},
{
"target": "com.amazonaws.sesv2#TooManyRequestsException"
}
],
"traits": {
"smithy.api#documentation": "<p>Show a list of the predictive inbox placement tests that you've performed, regardless of their statuses. For\n predictive inbox placement tests that are complete, you can use the <code>GetDeliverabilityTestReport</code>\n operation to view the results.</p>",
"smithy.api#http": {
"method": "GET",
"uri": "/v2/email/deliverability-dashboard/test-reports",
"code": 200
},
"smithy.api#paginated": {
"inputToken": "NextToken",
"outputToken": "NextToken",
"pageSize": "PageSize"
}
}
},
"com.amazonaws.sesv2#ListDeliverabilityTestReportsRequest": {
"type": "structure",
"members": {
"NextToken": {
"target": "com.amazonaws.sesv2#NextToken",
"traits": {
"smithy.api#documentation": "<p>A token returned from a previous call to <code>ListDeliverabilityTestReports</code> to\n indicate the position in the list of predictive inbox placement tests.</p>",
"smithy.api#httpQuery": "NextToken"
}
},
"PageSize": {
"target": "com.amazonaws.sesv2#MaxItems",
"traits": {
"smithy.api#documentation": "<p>The number of results to show in a single call to\n <code>ListDeliverabilityTestReports</code>. If the number of results is larger than\n the number you specified in this parameter, then the response includes a\n <code>NextToken</code> element, which you can use to obtain additional\n results.</p>\n <p>The value you specify has to be at least 0, and can be no more than 1000.</p>",
"smithy.api#httpQuery": "PageSize"
}
}
},
"traits": {
"smithy.api#documentation": "<p>A request to list all of the predictive inbox placement tests that you've performed.</p>"
}
},
"com.amazonaws.sesv2#ListDeliverabilityTestReportsResponse": {
"type": "structure",
"members": {
"DeliverabilityTestReports": {
"target": "com.amazonaws.sesv2#DeliverabilityTestReports",
"traits": {
"smithy.api#documentation": "<p>An object that contains a lists of predictive inbox placement tests that you've performed.</p>",
"smithy.api#required": {}
}
},
"NextToken": {
"target": "com.amazonaws.sesv2#NextToken",
"traits": {
"smithy.api#documentation": "<p>A token that indicates that there are additional predictive inbox placement tests to list. To view additional\n predictive inbox placement tests, issue another request to <code>ListDeliverabilityTestReports</code>, and pass\n this token in the <code>NextToken</code> parameter.</p>"
}
}
},
"traits": {
"smithy.api#documentation": "<p>A list of the predictive inbox placement test reports that are available for your account, regardless of\n whether or not those tests are complete.</p>"
}
},
"com.amazonaws.sesv2#ListDomainDeliverabilityCampaigns": {
"type": "operation",
"input": {
"target": "com.amazonaws.sesv2#ListDomainDeliverabilityCampaignsRequest"
},
"output": {
"target": "com.amazonaws.sesv2#ListDomainDeliverabilityCampaignsResponse"
},
"errors": [
{
"target": "com.amazonaws.sesv2#BadRequestException"
},
{
"target": "com.amazonaws.sesv2#NotFoundException"
},
{
"target": "com.amazonaws.sesv2#TooManyRequestsException"
}
],
"traits": {
"smithy.api#documentation": "<p>Retrieve deliverability data for all the campaigns that used a specific domain to send\n email during a specified time range. This data is available for a domain only if you\n enabled the Deliverability dashboard for the domain.</p>",
"smithy.api#http": {
"method": "GET",
"uri": "/v2/email/deliverability-dashboard/domains/{SubscribedDomain}/campaigns",
"code": 200
},
"smithy.api#paginated": {
"inputToken": "NextToken",
"outputToken": "NextToken",
"pageSize": "PageSize"
}
}
},
"com.amazonaws.sesv2#ListDomainDeliverabilityCampaignsRequest": {
"type": "structure",
"members": {
"StartDate": {
"target": "com.amazonaws.sesv2#Timestamp",
"traits": {
"smithy.api#documentation": "<p>The first day, in Unix time format, that you want to obtain deliverability data\n for.</p>",
"smithy.api#httpQuery": "StartDate",
"smithy.api#required": {}
}
},
"EndDate": {
"target": "com.amazonaws.sesv2#Timestamp",
"traits": {
"smithy.api#documentation": "<p>The last day, in Unix time format, that you want to obtain deliverability data for.\n This value has to be less than or equal to 30 days after the value of the\n <code>StartDate</code> parameter.</p>",
"smithy.api#httpQuery": "EndDate",
"smithy.api#required": {}
}
},
"SubscribedDomain": {
"target": "com.amazonaws.sesv2#Domain",
"traits": {
"smithy.api#documentation": "<p>The domain to obtain deliverability data for.</p>",
"smithy.api#httpLabel": {},
"smithy.api#required": {}
}
},
"NextToken": {
"target": "com.amazonaws.sesv2#NextToken",
"traits": {
"smithy.api#documentation": "<p>A token thats returned from a previous call to the\n <code>ListDomainDeliverabilityCampaigns</code> operation. This token indicates the\n position of a campaign in the list of campaigns.</p>",
"smithy.api#httpQuery": "NextToken"
}
},
"PageSize": {
"target": "com.amazonaws.sesv2#MaxItems",
"traits": {
"smithy.api#documentation": "<p>The maximum number of results to include in response to a single call to the\n <code>ListDomainDeliverabilityCampaigns</code> operation. If the number of results\n is larger than the number that you specify in this parameter, the response includes a\n <code>NextToken</code> element, which you can use to obtain additional\n results.</p>",
"smithy.api#httpQuery": "PageSize"
}
}
},
"traits": {
"smithy.api#documentation": "<p>Retrieve deliverability data for all the campaigns that used a specific domain to send\n email during a specified time range. This data is available for a domain only if you\n enabled the Deliverability dashboard.</p>"
}
},
"com.amazonaws.sesv2#ListDomainDeliverabilityCampaignsResponse": {
"type": "structure",
"members": {
"DomainDeliverabilityCampaigns": {
"target": "com.amazonaws.sesv2#DomainDeliverabilityCampaignList",
"traits": {
"smithy.api#documentation": "<p>An array of responses, one for each campaign that used the domain to send email during\n the specified time range.</p>",
"smithy.api#required": {}
}
},
"NextToken": {
"target": "com.amazonaws.sesv2#NextToken",
"traits": {
"smithy.api#documentation": "<p>A token thats returned from a previous call to the\n <code>ListDomainDeliverabilityCampaigns</code> operation. This token indicates the\n position of the campaign in the list of campaigns.</p>"
}
}
},
"traits": {
"smithy.api#documentation": "<p>An array of objects that provide deliverability data for all the campaigns that used a\n specific domain to send email during a specified time range. This data is available for\n a domain only if you enabled the Deliverability dashboard for the domain.</p>"
}
},
"com.amazonaws.sesv2#ListEmailIdentities": {
"type": "operation",
"input": {
"target": "com.amazonaws.sesv2#ListEmailIdentitiesRequest"
},
"output": {
"target": "com.amazonaws.sesv2#ListEmailIdentitiesResponse"
},
"errors": [
{
"target": "com.amazonaws.sesv2#BadRequestException"
},
{
"target": "com.amazonaws.sesv2#TooManyRequestsException"
}
],
"traits": {
"smithy.api#documentation": "<p>Returns a list of all of the email identities that are associated with your AWS\n account. An identity can be either an email address or a domain. This operation returns\n identities that are verified as well as those that aren't. This operation returns\n identities that are associated with Amazon SES and Amazon Pinpoint.</p>",
"smithy.api#http": {
"method": "GET",
"uri": "/v2/email/identities",
"code": 200
},
"smithy.api#paginated": {
"inputToken": "NextToken",
"outputToken": "NextToken",
"pageSize": "PageSize"
}
}
},
"com.amazonaws.sesv2#ListEmailIdentitiesRequest": {
"type": "structure",
"members": {
"NextToken": {
"target": "com.amazonaws.sesv2#NextToken",
"traits": {
"smithy.api#documentation": "<p>A token returned from a previous call to <code>ListEmailIdentities</code> to indicate\n the position in the list of identities.</p>",
"smithy.api#httpQuery": "NextToken"
}
},
"PageSize": {
"target": "com.amazonaws.sesv2#MaxItems",
"traits": {
"smithy.api#documentation": "<p>The number of results to show in a single call to <code>ListEmailIdentities</code>. If\n the number of results is larger than the number you specified in this parameter, then\n the response includes a <code>NextToken</code> element, which you can use to obtain\n additional results.</p>\n <p>The value you specify has to be at least 0, and can be no more than 1000.</p>",
"smithy.api#httpQuery": "PageSize"
}
}
},
"traits": {
"smithy.api#documentation": "<p>A request to list all of the email identities associated with your AWS account. This\n list includes identities that you've already verified, identities that are unverified,\n and identities that were verified in the past, but are no longer verified.</p>"
}
},
"com.amazonaws.sesv2#ListEmailIdentitiesResponse": {
"type": "structure",
"members": {
"EmailIdentities": {
"target": "com.amazonaws.sesv2#IdentityInfoList",
"traits": {
"smithy.api#documentation": "<p>An array that includes all of the email identities associated with your AWS\n account.</p>"
}
},
"NextToken": {
"target": "com.amazonaws.sesv2#NextToken",
"traits": {
"smithy.api#documentation": "<p>A token that indicates that there are additional configuration sets to list. To view\n additional configuration sets, issue another request to\n <code>ListEmailIdentities</code>, and pass this token in the <code>NextToken</code>\n parameter.</p>"
}
}
},
"traits": {
"smithy.api#documentation": "<p>A list of all of the identities that you've attempted to verify, regardless of whether\n or not those identities were successfully verified.</p>"
}
},
"com.amazonaws.sesv2#ListEmailTemplates": {
"type": "operation",
"input": {
"target": "com.amazonaws.sesv2#ListEmailTemplatesRequest"
},
"output": {
"target": "com.amazonaws.sesv2#ListEmailTemplatesResponse"
},
"errors": [
{
"target": "com.amazonaws.sesv2#BadRequestException"
},
{
"target": "com.amazonaws.sesv2#TooManyRequestsException"
}
],
"traits": {
"smithy.api#documentation": "<p>Lists the email templates present in your Amazon SES account in the current AWS\n Region.</p>\n\n <p>You can execute this operation no more than once per second.</p>",
"smithy.api#http": {
"method": "GET",
"uri": "/v2/email/templates",
"code": 200
},
"smithy.api#paginated": {
"inputToken": "NextToken",
"outputToken": "NextToken",
"pageSize": "PageSize"
}
}
},
"com.amazonaws.sesv2#ListEmailTemplatesRequest": {
"type": "structure",
"members": {
"NextToken": {
"target": "com.amazonaws.sesv2#NextToken",
"traits": {
"smithy.api#documentation": "<p>A token returned from a previous call to <code>ListEmailTemplates</code> to indicate\n the position in the list of email templates.</p>",
"smithy.api#httpQuery": "NextToken"
}
},
"PageSize": {
"target": "com.amazonaws.sesv2#MaxItems",
"traits": {
"smithy.api#documentation": "<p>The number of results to show in a single call to <code>ListEmailTemplates</code>. If the number of\n results is larger than the number you specified in this parameter, then the response\n includes a <code>NextToken</code> element, which you can use to obtain additional results.</p>\n <p>The value you specify has to be at least 1, and can be no more than 10.</p>",
"smithy.api#httpQuery": "PageSize"
}
}
},
"traits": {
"smithy.api#documentation": "<p>Represents a request to list the email templates present in your Amazon SES account in the\n current AWS Region. For more information, see the <a href=\"https://docs.aws.amazon.com/ses/latest/DeveloperGuide/send-personalized-email-api.html\">Amazon SES Developer\n Guide</a>.</p>"
}
},
"com.amazonaws.sesv2#ListEmailTemplatesResponse": {
"type": "structure",
"members": {
"TemplatesMetadata": {
"target": "com.amazonaws.sesv2#EmailTemplateMetadataList",
"traits": {
"smithy.api#documentation": "<p>An array the contains the name and creation time stamp for each template in your Amazon SES\n account.</p>"
}
},
"NextToken": {
"target": "com.amazonaws.sesv2#NextToken",
"traits": {
"smithy.api#documentation": "<p>A token indicating that there are additional email templates available to be listed.\n Pass this token to a subsequent <code>ListEmailTemplates</code> call to retrieve the\n next 10 email templates.</p>"
}
}
},
"traits": {
"smithy.api#documentation": "<p>The following elements are returned by the service.</p>"
}
},
"com.amazonaws.sesv2#ListImportJobs": {
"type": "operation",
"input": {
"target": "com.amazonaws.sesv2#ListImportJobsRequest"
},
"output": {
"target": "com.amazonaws.sesv2#ListImportJobsResponse"
},
"errors": [
{
"target": "com.amazonaws.sesv2#BadRequestException"
},
{
"target": "com.amazonaws.sesv2#TooManyRequestsException"
}
],
"traits": {
"smithy.api#documentation": "<p>Lists all of the import jobs.</p>",
"smithy.api#http": {
"method": "GET",
"uri": "/v2/email/import-jobs",
"code": 200
},
"smithy.api#paginated": {
"inputToken": "NextToken",
"outputToken": "NextToken",
"pageSize": "PageSize"
}
}
},
"com.amazonaws.sesv2#ListImportJobsRequest": {
"type": "structure",
"members": {
"ImportDestinationType": {
"target": "com.amazonaws.sesv2#ImportDestinationType",
"traits": {
"smithy.api#documentation": "<p>The destination of the import job, which can be used to list import jobs that have a\n certain <code>ImportDestinationType</code>.</p>"
}
},
"NextToken": {
"target": "com.amazonaws.sesv2#NextToken",
"traits": {
"smithy.api#documentation": "<p>A string token indicating that there might be additional import jobs available to be\n listed. Copy this token to a subsequent call to <code>ListImportJobs</code> with the\n same parameters to retrieve the next page of import jobs.</p>",
"smithy.api#httpQuery": "NextToken"
}
},
"PageSize": {
"target": "com.amazonaws.sesv2#MaxItems",
"traits": {
"smithy.api#documentation": "<p>Maximum number of import jobs to return at once. Use this parameter to paginate\n results. If additional import jobs exist beyond the specified limit, the\n <code>NextToken</code> element is sent in the response. Use the\n <code>NextToken</code> value in subsequent requests to retrieve additional\n addresses.</p>",
"smithy.api#httpQuery": "PageSize"
}
}
},
"traits": {
"smithy.api#documentation": "<p>Represents a request to list all of the import jobs for a data destination within the\n specified maximum number of import jobs.</p>"
}
},
"com.amazonaws.sesv2#ListImportJobsResponse": {
"type": "structure",
"members": {
"ImportJobs": {
"target": "com.amazonaws.sesv2#ImportJobSummaryList",
"traits": {
"smithy.api#documentation": "<p>A list of the import job summaries.</p>"
}
},
"NextToken": {
"target": "com.amazonaws.sesv2#NextToken",
"traits": {
"smithy.api#documentation": "<p>A string token indicating that there might be additional import jobs available to be\n listed. Copy this token to a subsequent call to <code>ListImportJobs</code> with the\n same parameters to retrieve the next page of import jobs.</p>"
}
}
},
"traits": {
"smithy.api#documentation": "<p>An HTTP 200 response if the request succeeds, or an error message if the request\n fails.</p>"
}
},
"com.amazonaws.sesv2#ListManagementOptions": {
"type": "structure",
"members": {
"ContactListName": {
"target": "com.amazonaws.sesv2#ContactListName",
"traits": {
"smithy.api#documentation": "<p>The name of the contact list.</p>",
"smithy.api#required": {}
}
},
"TopicName": {
"target": "com.amazonaws.sesv2#TopicName",
"traits": {
"smithy.api#documentation": "<p>The name of the topic.</p>"
}
}
},
"traits": {
"smithy.api#documentation": "<p>An object used to specify a list or topic to which an email belongs, which will be\n used when a contact chooses to unsubscribe.</p>"
}
},
"com.amazonaws.sesv2#ListOfContactLists": {
"type": "list",
"member": {
"target": "com.amazonaws.sesv2#ContactList"
}
},
"com.amazonaws.sesv2#ListOfContacts": {
"type": "list",
"member": {
"target": "com.amazonaws.sesv2#Contact"
}
},
"com.amazonaws.sesv2#ListOfDedicatedIpPools": {
"type": "list",
"member": {
"target": "com.amazonaws.sesv2#PoolName"
},
"traits": {
"smithy.api#documentation": "<p>A list of dedicated IP pools that are associated with your AWS account.</p>"
}
},
"com.amazonaws.sesv2#ListSuppressedDestinations": {
"type": "operation",
"input": {
"target": "com.amazonaws.sesv2#ListSuppressedDestinationsRequest"
},
"output": {
"target": "com.amazonaws.sesv2#ListSuppressedDestinationsResponse"
},
"errors": [
{
"target": "com.amazonaws.sesv2#BadRequestException"
},
{
"target": "com.amazonaws.sesv2#InvalidNextTokenException"
},
{
"target": "com.amazonaws.sesv2#TooManyRequestsException"
}
],
"traits": {
"smithy.api#documentation": "<p>Retrieves a list of email addresses that are on the suppression list for your\n account.</p>",
"smithy.api#http": {
"method": "GET",
"uri": "/v2/email/suppression/addresses",
"code": 200
},
"smithy.api#paginated": {
"inputToken": "NextToken",
"outputToken": "NextToken",
"pageSize": "PageSize"
}
}
},
"com.amazonaws.sesv2#ListSuppressedDestinationsRequest": {
"type": "structure",
"members": {
"Reasons": {
"target": "com.amazonaws.sesv2#SuppressionListReasons",
"traits": {
"smithy.api#documentation": "<p>The factors that caused the email address to be added to .</p>",
"smithy.api#httpQuery": "Reason"
}
},
"StartDate": {
"target": "com.amazonaws.sesv2#Timestamp",
"traits": {
"smithy.api#documentation": "<p>Used to filter the list of suppressed email destinations so that it only includes\n addresses that were added to the list after a specific date. The date that you specify\n should be in Unix time format.</p>",
"smithy.api#httpQuery": "StartDate"
}
},
"EndDate": {
"target": "com.amazonaws.sesv2#Timestamp",
"traits": {
"smithy.api#documentation": "<p>Used to filter the list of suppressed email destinations so that it only includes\n addresses that were added to the list before a specific date. The date that you specify\n should be in Unix time format.</p>",
"smithy.api#httpQuery": "EndDate"
}
},
"NextToken": {
"target": "com.amazonaws.sesv2#NextToken",
"traits": {
"smithy.api#documentation": "<p>A token returned from a previous call to <code>ListSuppressedDestinations</code> to\n indicate the position in the list of suppressed email addresses.</p>",
"smithy.api#httpQuery": "NextToken"
}
},
"PageSize": {
"target": "com.amazonaws.sesv2#MaxItems",
"traits": {
"smithy.api#documentation": "<p>The number of results to show in a single call to\n <code>ListSuppressedDestinations</code>. If the number of results is larger than the\n number you specified in this parameter, then the response includes a\n <code>NextToken</code> element, which you can use to obtain additional\n results.</p>",
"smithy.api#httpQuery": "PageSize"
}
}
},
"traits": {
"smithy.api#documentation": "<p>A request to obtain a list of email destinations that are on the suppression list for\n your account.</p>"
}
},
"com.amazonaws.sesv2#ListSuppressedDestinationsResponse": {
"type": "structure",
"members": {
"SuppressedDestinationSummaries": {
"target": "com.amazonaws.sesv2#SuppressedDestinationSummaries",
"traits": {
"smithy.api#documentation": "<p>A list of summaries, each containing a summary for a suppressed email\n destination.</p>"
}
},
"NextToken": {
"target": "com.amazonaws.sesv2#NextToken",
"traits": {
"smithy.api#documentation": "<p>A token that indicates that there are additional email addresses on the suppression\n list for your account. To view additional suppressed addresses, issue another request to\n <code>ListSuppressedDestinations</code>, and pass this token in the\n <code>NextToken</code> parameter.</p>"
}
}
},
"traits": {
"smithy.api#documentation": "<p>A list of suppressed email addresses.</p>"
}
},
"com.amazonaws.sesv2#ListTagsForResource": {
"type": "operation",
"input": {
"target": "com.amazonaws.sesv2#ListTagsForResourceRequest"
},
"output": {
"target": "com.amazonaws.sesv2#ListTagsForResourceResponse"
},
"errors": [
{
"target": "com.amazonaws.sesv2#BadRequestException"
},
{
"target": "com.amazonaws.sesv2#NotFoundException"
},
{
"target": "com.amazonaws.sesv2#TooManyRequestsException"
}
],
"traits": {
"smithy.api#documentation": "<p>Retrieve a list of the tags (keys and values) that are associated with a specified\n resource. A <i>tag</i> is a label that you optionally define and associate\n with a resource. Each tag consists of a required <i>tag key</i> and an\n optional associated <i>tag value</i>. A tag key is a general label that\n acts as a category for more specific tag values. A tag value acts as a descriptor within\n a tag key.</p>",
"smithy.api#http": {
"method": "GET",
"uri": "/v2/email/tags",
"code": 200
}
}
},
"com.amazonaws.sesv2#ListTagsForResourceRequest": {
"type": "structure",
"members": {
"ResourceArn": {
"target": "com.amazonaws.sesv2#AmazonResourceName",
"traits": {
"smithy.api#documentation": "<p>The Amazon Resource Name (ARN) of the resource that you want to retrieve tag\n information for.</p>",
"smithy.api#httpQuery": "ResourceArn",
"smithy.api#required": {}
}
}
}
},
"com.amazonaws.sesv2#ListTagsForResourceResponse": {
"type": "structure",
"members": {
"Tags": {
"target": "com.amazonaws.sesv2#TagList",
"traits": {
"smithy.api#documentation": "<p>An array that lists all the tags that are associated with the resource. Each tag\n consists of a required tag key (<code>Key</code>) and an associated tag value\n (<code>Value</code>)</p>",
"smithy.api#required": {}
}
}
}
},
"com.amazonaws.sesv2#MailFromAttributes": {
"type": "structure",
"members": {
"MailFromDomain": {
"target": "com.amazonaws.sesv2#MailFromDomainName",
"traits": {
"smithy.api#documentation": "<p>The name of a domain that an email identity uses as a custom MAIL FROM domain.</p>",
"smithy.api#required": {}
}
},
"MailFromDomainStatus": {
"target": "com.amazonaws.sesv2#MailFromDomainStatus",
"traits": {
"smithy.api#documentation": "<p>The status of the MAIL FROM domain. This status can have the following values:</p>\n <ul>\n <li>\n <p>\n <code>PENDING</code> Amazon SES hasn't started searching for the MX record\n yet.</p>\n </li>\n <li>\n <p>\n <code>SUCCESS</code> Amazon SES detected the required MX record for the\n MAIL FROM domain.</p>\n </li>\n <li>\n <p>\n <code>FAILED</code> Amazon SES can't find the required MX record, or the\n record no longer exists.</p>\n </li>\n <li>\n <p>\n <code>TEMPORARY_FAILURE</code> A temporary issue occurred, which\n prevented Amazon SES from determining the status of the MAIL FROM domain.</p>\n </li>\n </ul>",
"smithy.api#required": {}
}
},
"BehaviorOnMxFailure": {
"target": "com.amazonaws.sesv2#BehaviorOnMxFailure",
"traits": {
"smithy.api#documentation": "<p>The action that you want to take if the required MX record can't be found when you\n send an email. When you set this value to <code>UseDefaultValue</code>, the mail is sent\n using <i>amazonses.com</i> as the MAIL FROM domain. When you set this\n value to <code>RejectMessage</code>, the Amazon SES API v2 returns a\n <code>MailFromDomainNotVerified</code> error, and doesn't attempt to deliver the\n email.</p>\n <p>These behaviors are taken when the custom MAIL FROM domain configuration is in the\n <code>Pending</code>, <code>Failed</code>, and <code>TemporaryFailure</code>\n states.</p>",
"smithy.api#required": {}
}
}
},
"traits": {
"smithy.api#documentation": "<p>A list of attributes that are associated with a MAIL FROM domain.</p>"
}
},
"com.amazonaws.sesv2#MailFromDomainName": {
"type": "string",
"traits": {
"smithy.api#documentation": "<p>The domain that you want to use as a MAIL FROM domain.</p>"
}
},
"com.amazonaws.sesv2#MailFromDomainNotVerifiedException": {
"type": "structure",
"members": {
"message": {
"target": "com.amazonaws.sesv2#ErrorMessage"
}
},
"traits": {
"smithy.api#documentation": "<p>The message can't be sent because the sending domain isn't verified.</p>",
"smithy.api#error": "client",
"smithy.api#httpError": 400
}
},
"com.amazonaws.sesv2#MailFromDomainStatus": {
"type": "string",
"traits": {
"smithy.api#documentation": "<p>The status of the MAIL FROM domain. This status can have the following values:</p>\n <ul>\n <li>\n <p>\n <code>PENDING</code> Amazon SES hasn't started searching for the MX record\n yet.</p>\n </li>\n <li>\n <p>\n <code>SUCCESS</code> Amazon SES detected the required MX record for the\n MAIL FROM domain.</p>\n </li>\n <li>\n <p>\n <code>FAILED</code> Amazon SES can't find the required MX record, or the\n record no longer exists.</p>\n </li>\n <li>\n <p>\n <code>TEMPORARY_FAILURE</code> A temporary issue occurred, which\n prevented Amazon SES from determining the status of the MAIL FROM domain.</p>\n </li>\n </ul>",
"smithy.api#enum": [
{
"value": "PENDING",
"name": "PENDING"
},
{
"value": "SUCCESS",
"name": "SUCCESS"
},
{
"value": "FAILED",
"name": "FAILED"
},
{
"value": "TEMPORARY_FAILURE",
"name": "TEMPORARY_FAILURE"
}
]
}
},
"com.amazonaws.sesv2#MailType": {
"type": "string",
"traits": {
"smithy.api#enum": [
{
"value": "MARKETING",
"name": "MARKETING"
},
{
"value": "TRANSACTIONAL",
"name": "TRANSACTIONAL"
}
]
}
},
"com.amazonaws.sesv2#Max24HourSend": {
"type": "double"
},
"com.amazonaws.sesv2#MaxItems": {
"type": "integer",
"traits": {
"smithy.api#box": {}
}
},
"com.amazonaws.sesv2#MaxSendRate": {
"type": "double"
},
"com.amazonaws.sesv2#Message": {
"type": "structure",
"members": {
"Subject": {
"target": "com.amazonaws.sesv2#Content",
"traits": {
"smithy.api#documentation": "<p>The subject line of the email. The subject line can only contain 7-bit ASCII\n characters. However, you can specify non-ASCII characters in the subject line by using\n encoded-word syntax, as described in <a href=\"https://tools.ietf.org/html/rfc2047\">RFC 2047</a>.</p>",
"smithy.api#required": {}
}
},
"Body": {
"target": "com.amazonaws.sesv2#Body",
"traits": {
"smithy.api#documentation": "<p>The body of the message. You can specify an HTML version of the message, a text-only\n version of the message, or both.</p>",
"smithy.api#required": {}
}
}
},
"traits": {
"smithy.api#documentation": "<p>Represents the email message that you're sending. The <code>Message</code> object\n consists of a subject line and a message body.</p>"
}
},
"com.amazonaws.sesv2#MessageContent": {
"type": "string",
"traits": {
"smithy.api#documentation": "<p>The body of an email message.</p>"
}
},
"com.amazonaws.sesv2#MessageData": {
"type": "string"
},
"com.amazonaws.sesv2#MessageRejected": {
"type": "structure",
"members": {
"message": {
"target": "com.amazonaws.sesv2#ErrorMessage"
}
},
"traits": {
"smithy.api#documentation": "<p>The message can't be sent because it contains invalid content.</p>",
"smithy.api#error": "client",
"smithy.api#httpError": 400
}
},
"com.amazonaws.sesv2#MessageTag": {
"type": "structure",
"members": {
"Name": {
"target": "com.amazonaws.sesv2#MessageTagName",
"traits": {
"smithy.api#documentation": "<p>The name of the message tag. The message tag name has to meet the following\n criteria:</p>\n <ul>\n <li>\n <p>It can only contain ASCII letters (az, AZ), numbers (09),\n underscores (_), or dashes (-).</p>\n </li>\n <li>\n <p>It can contain no more than 256 characters.</p>\n </li>\n </ul>",
"smithy.api#required": {}
}
},
"Value": {
"target": "com.amazonaws.sesv2#MessageTagValue",
"traits": {
"smithy.api#documentation": "<p>The value of the message tag. The message tag value has to meet the following\n criteria:</p>\n <ul>\n <li>\n <p>It can only contain ASCII letters (az, AZ), numbers (09),\n underscores (_), or dashes (-).</p>\n </li>\n <li>\n <p>It can contain no more than 256 characters.</p>\n </li>\n </ul>",
"smithy.api#required": {}
}
}
},
"traits": {
"smithy.api#documentation": "<p>Contains the name and value of a tag that you apply to an email. You can use message\n tags when you publish email sending events.\n </p>"
}
},
"com.amazonaws.sesv2#MessageTagList": {
"type": "list",
"member": {
"target": "com.amazonaws.sesv2#MessageTag"
},
"traits": {
"smithy.api#documentation": "<p>A list of message tags.</p>"
}
},
"com.amazonaws.sesv2#MessageTagName": {
"type": "string",
"traits": {
"smithy.api#documentation": "<p>The name of the message tag. The message tag name has to meet the following\n criteria:</p>\n <ul>\n <li>\n <p>It can only contain ASCII letters (az, AZ), numbers (09),\n underscores (_), or dashes (-).</p>\n </li>\n <li>\n <p>It can contain no more than 256 characters.</p>\n </li>\n </ul>"
}
},
"com.amazonaws.sesv2#MessageTagValue": {
"type": "string",
"traits": {
"smithy.api#documentation": "<p>The value of the message tag. The message tag value has to meet the following\n criteria:</p>\n <ul>\n <li>\n <p>It can only contain ASCII letters (az, AZ), numbers (09),\n underscores (_), or dashes (-).</p>\n </li>\n <li>\n <p>It can contain no more than 256 characters.</p>\n </li>\n </ul>"
}
},
"com.amazonaws.sesv2#NextToken": {
"type": "string"
},
"com.amazonaws.sesv2#NotFoundException": {
"type": "structure",
"members": {
"message": {
"target": "com.amazonaws.sesv2#ErrorMessage"
}
},
"traits": {
"smithy.api#documentation": "<p>The resource you attempted to access doesn't exist.</p>",
"smithy.api#error": "client",
"smithy.api#httpError": 404
}
},
"com.amazonaws.sesv2#OutboundMessageId": {
"type": "string"
},
"com.amazonaws.sesv2#OverallVolume": {
"type": "structure",
"members": {
"VolumeStatistics": {
"target": "com.amazonaws.sesv2#VolumeStatistics",
"traits": {
"smithy.api#documentation": "<p>An object that contains information about the numbers of messages that arrived in\n recipients' inboxes and junk mail folders.</p>"
}
},
"ReadRatePercent": {
"target": "com.amazonaws.sesv2#Percentage",
"traits": {
"smithy.api#documentation": "<p>The percentage of emails that were sent from the domain that were read by their\n recipients.</p>"
}
},
"DomainIspPlacements": {
"target": "com.amazonaws.sesv2#DomainIspPlacements",
"traits": {
"smithy.api#documentation": "<p>An object that contains inbox and junk mail placement metrics for individual email\n providers.</p>"
}
}
},
"traits": {
"smithy.api#documentation": "<p>An object that contains information about email that was sent from the selected\n domain.</p>"
}
},
"com.amazonaws.sesv2#Percentage": {
"type": "double",
"traits": {
"smithy.api#box": {},
"smithy.api#documentation": "<p>An object that contains information about inbox placement percentages.</p>"
}
},
"com.amazonaws.sesv2#Percentage100Wrapper": {
"type": "integer",
"traits": {
"smithy.api#box": {}
}
},
"com.amazonaws.sesv2#PinpointDestination": {
"type": "structure",
"members": {
"ApplicationArn": {
"target": "com.amazonaws.sesv2#AmazonResourceName",
"traits": {
"smithy.api#documentation": "<p>The Amazon Resource Name (ARN) of the Amazon Pinpoint project that you want to send email\n events to.</p>"
}
}
},
"traits": {
"smithy.api#documentation": "<p>An object that defines an Amazon Pinpoint project destination for email events. You can send\n email event data to a Amazon Pinpoint project to view metrics using the Transactional Messaging\n dashboards that are built in to Amazon Pinpoint. For more information, see <a href=\"https://docs.aws.amazon.com/pinpoint/latest/userguide/analytics-transactional-messages.html\">Transactional\n Messaging Charts</a> in the <i>Amazon Pinpoint User Guide</i>.</p>"
}
},
"com.amazonaws.sesv2#PlacementStatistics": {
"type": "structure",
"members": {
"InboxPercentage": {
"target": "com.amazonaws.sesv2#Percentage",
"traits": {
"smithy.api#documentation": "<p>The percentage of emails that arrived in recipients' inboxes during the predictive inbox placement test.</p>"
}
},
"SpamPercentage": {
"target": "com.amazonaws.sesv2#Percentage",
"traits": {
"smithy.api#documentation": "<p>The percentage of emails that arrived in recipients' spam or junk mail folders during\n the predictive inbox placement test.</p>"
}
},
"MissingPercentage": {
"target": "com.amazonaws.sesv2#Percentage",
"traits": {
"smithy.api#documentation": "<p>The percentage of emails that didn't arrive in recipients' inboxes at all during the\n predictive inbox placement test.</p>"
}
},
"SpfPercentage": {
"target": "com.amazonaws.sesv2#Percentage",
"traits": {
"smithy.api#documentation": "<p>The percentage of emails that were authenticated by using Sender Policy Framework\n (SPF) during the predictive inbox placement test.</p>"
}
},
"DkimPercentage": {
"target": "com.amazonaws.sesv2#Percentage",
"traits": {
"smithy.api#documentation": "<p>The percentage of emails that were authenticated by using DomainKeys Identified Mail\n (DKIM) during the predictive inbox placement test.</p>"
}
}
},
"traits": {
"smithy.api#documentation": "<p>An object that contains inbox placement data for an email provider.</p>"
}
},
"com.amazonaws.sesv2#Policy": {
"type": "string",
"traits": {
"smithy.api#documentation": "<p>The text of the policy in JSON format. The policy cannot exceed 4 KB.</p>\n <p>For information about the syntax of sending authorization policies, see the <a href=\"https://docs.aws.amazon.com/ses/latest/DeveloperGuide/sending-authorization.html\">Amazon SES Developer Guide</a>.</p>",
"smithy.api#length": {
"min": 1
}
}
},
"com.amazonaws.sesv2#PolicyMap": {
"type": "map",
"key": {
"target": "com.amazonaws.sesv2#PolicyName"
},
"value": {
"target": "com.amazonaws.sesv2#Policy"
},
"traits": {
"smithy.api#documentation": "<p>An object that contains mapping between <code>PolicyName</code> and\n <code>Policy</code> text.</p>"
}
},
"com.amazonaws.sesv2#PolicyName": {
"type": "string",
"traits": {
"smithy.api#documentation": "<p>The name of the policy.</p>\n <p>The policy name cannot exceed 64 characters and can only include alphanumeric\n characters, dashes, and underscores.</p>",
"smithy.api#length": {
"min": 1,
"max": 64
}
}
},
"com.amazonaws.sesv2#PoolName": {
"type": "string",
"traits": {
"smithy.api#documentation": "<p>The name of a dedicated IP pool.</p>"
}
},
"com.amazonaws.sesv2#PrivateKey": {
"type": "string",
"traits": {
"smithy.api#length": {
"min": 1,
"max": 20480
},
"smithy.api#pattern": "^[a-zA-Z0-9+\\/]+={0,2}$",
"smithy.api#sensitive": {}
}
},
"com.amazonaws.sesv2#ProcessedRecordsCount": {
"type": "integer",
"traits": {
"smithy.api#box": {}
}
},
"com.amazonaws.sesv2#PutAccountDedicatedIpWarmupAttributes": {
"type": "operation",
"input": {
"target": "com.amazonaws.sesv2#PutAccountDedicatedIpWarmupAttributesRequest"
},
"output": {
"target": "com.amazonaws.sesv2#PutAccountDedicatedIpWarmupAttributesResponse"
},
"errors": [
{
"target": "com.amazonaws.sesv2#BadRequestException"
},
{
"target": "com.amazonaws.sesv2#TooManyRequestsException"
}
],
"traits": {
"smithy.api#documentation": "<p>Enable or disable the automatic warm-up feature for dedicated IP addresses.</p>",
"smithy.api#http": {
"method": "PUT",
"uri": "/v2/email/account/dedicated-ips/warmup",
"code": 200
}
}
},
"com.amazonaws.sesv2#PutAccountDedicatedIpWarmupAttributesRequest": {
"type": "structure",
"members": {
"AutoWarmupEnabled": {
"target": "com.amazonaws.sesv2#Enabled",
"traits": {
"smithy.api#documentation": "<p>Enables or disables the automatic warm-up feature for dedicated IP addresses that are\n associated with your Amazon SES account in the current AWS Region. Set to <code>true</code>\n to enable the automatic warm-up feature, or set to <code>false</code> to disable\n it.</p>"
}
}
},
"traits": {
"smithy.api#documentation": "<p>A request to enable or disable the automatic IP address warm-up feature.</p>"
}
},
"com.amazonaws.sesv2#PutAccountDedicatedIpWarmupAttributesResponse": {
"type": "structure",
"members": {},
"traits": {
"smithy.api#documentation": "<p>An HTTP 200 response if the request succeeds, or an error message if the request\n fails.</p>"
}
},
"com.amazonaws.sesv2#PutAccountDetails": {
"type": "operation",
"input": {
"target": "com.amazonaws.sesv2#PutAccountDetailsRequest"
},
"output": {
"target": "com.amazonaws.sesv2#PutAccountDetailsResponse"
},
"errors": [
{
"target": "com.amazonaws.sesv2#BadRequestException"
},
{
"target": "com.amazonaws.sesv2#ConflictException"
},
{
"target": "com.amazonaws.sesv2#TooManyRequestsException"
}
],
"traits": {
"smithy.api#documentation": "<p>Update your Amazon SES account details.</p>",
"smithy.api#http": {
"method": "POST",
"uri": "/v2/email/account/details",
"code": 200
}
}
},
"com.amazonaws.sesv2#PutAccountDetailsRequest": {
"type": "structure",
"members": {
"MailType": {
"target": "com.amazonaws.sesv2#MailType",
"traits": {
"smithy.api#documentation": "<p>The type of email your account will send.</p>",
"smithy.api#required": {}
}
},
"WebsiteURL": {
"target": "com.amazonaws.sesv2#WebsiteURL",
"traits": {
"smithy.api#documentation": "<p>The URL of your website. This information helps us better understand the type of\n content that you plan to send.</p>",
"smithy.api#required": {}
}
},
"ContactLanguage": {
"target": "com.amazonaws.sesv2#ContactLanguage",
"traits": {
"smithy.api#documentation": "<p>The language you would prefer to be contacted with.</p>"
}
},
"UseCaseDescription": {
"target": "com.amazonaws.sesv2#UseCaseDescription",
"traits": {
"smithy.api#documentation": "<p>A description of the types of email that you plan to send.</p>",
"smithy.api#required": {}
}
},
"AdditionalContactEmailAddresses": {
"target": "com.amazonaws.sesv2#AdditionalContactEmailAddresses",
"traits": {
"smithy.api#documentation": "<p>Additional email addresses that you would like to be notified regarding Amazon SES\n matters.</p>"
}
},
"ProductionAccessEnabled": {
"target": "com.amazonaws.sesv2#EnabledWrapper",
"traits": {
"smithy.api#documentation": "<p>Indicates whether or not your account should have production access in the current\n AWS Region.</p>\n <p>If the value is <code>false</code>, then your account is in the\n <i>sandbox</i>. When your account is in the sandbox, you can only send\n email to verified identities. Additionally, the maximum number of emails you can send in\n a 24-hour period (your sending quota) is 200, and the maximum number of emails you can\n send per second (your maximum sending rate) is 1.</p>\n <p>If the value is <code>true</code>, then your account has production access. When your\n account has production access, you can send email to any address. The sending quota and\n maximum sending rate for your account vary based on your specific use case.</p>"
}
}
},
"traits": {
"smithy.api#documentation": "<p>A request to submit new account details.</p>"
}
},
"com.amazonaws.sesv2#PutAccountDetailsResponse": {
"type": "structure",
"members": {},
"traits": {
"smithy.api#documentation": "<p>An HTTP 200 response if the request succeeds, or an error message if the request\n fails.</p>"
}
},
"com.amazonaws.sesv2#PutAccountSendingAttributes": {
"type": "operation",
"input": {
"target": "com.amazonaws.sesv2#PutAccountSendingAttributesRequest"
},
"output": {
"target": "com.amazonaws.sesv2#PutAccountSendingAttributesResponse"
},
"errors": [
{
"target": "com.amazonaws.sesv2#BadRequestException"
},
{
"target": "com.amazonaws.sesv2#TooManyRequestsException"
}
],
"traits": {
"smithy.api#documentation": "<p>Enable or disable the ability of your account to send email.</p>",
"smithy.api#http": {
"method": "PUT",
"uri": "/v2/email/account/sending",
"code": 200
}
}
},
"com.amazonaws.sesv2#PutAccountSendingAttributesRequest": {
"type": "structure",
"members": {
"SendingEnabled": {
"target": "com.amazonaws.sesv2#Enabled",
"traits": {
"smithy.api#documentation": "<p>Enables or disables your account's ability to send email. Set to <code>true</code> to\n enable email sending, or set to <code>false</code> to disable email sending.</p>\n <note>\n <p>If AWS paused your account's ability to send email, you can't use this operation\n to resume your account's ability to send email.</p>\n </note>"
}
}
},
"traits": {
"smithy.api#documentation": "<p>A request to change the ability of your account to send email.</p>"
}
},
"com.amazonaws.sesv2#PutAccountSendingAttributesResponse": {
"type": "structure",
"members": {},
"traits": {
"smithy.api#documentation": "<p>An HTTP 200 response if the request succeeds, or an error message if the request\n fails.</p>"
}
},
"com.amazonaws.sesv2#PutAccountSuppressionAttributes": {
"type": "operation",
"input": {
"target": "com.amazonaws.sesv2#PutAccountSuppressionAttributesRequest"
},
"output": {
"target": "com.amazonaws.sesv2#PutAccountSuppressionAttributesResponse"
},
"errors": [
{
"target": "com.amazonaws.sesv2#BadRequestException"
},
{
"target": "com.amazonaws.sesv2#TooManyRequestsException"
}
],
"traits": {
"smithy.api#documentation": "<p>Change the settings for the account-level suppression list.</p>",
"smithy.api#http": {
"method": "PUT",
"uri": "/v2/email/account/suppression",
"code": 200
}
}
},
"com.amazonaws.sesv2#PutAccountSuppressionAttributesRequest": {
"type": "structure",
"members": {
"SuppressedReasons": {
"target": "com.amazonaws.sesv2#SuppressionListReasons",
"traits": {
"smithy.api#documentation": "<p>A list that contains the reasons that email addresses will be automatically added to\n the suppression list for your account. This list can contain any or all of the\n following:</p>\n <ul>\n <li>\n <p>\n <code>COMPLAINT</code> Amazon SES adds an email address to the suppression\n list for your account when a message sent to that address results in a\n complaint.</p>\n </li>\n <li>\n <p>\n <code>BOUNCE</code> Amazon SES adds an email address to the suppression\n list for your account when a message sent to that address results in a hard\n bounce.</p>\n </li>\n </ul>"
}
}
},
"traits": {
"smithy.api#documentation": "<p>A request to change your account's suppression preferences.</p>"
}
},
"com.amazonaws.sesv2#PutAccountSuppressionAttributesResponse": {
"type": "structure",
"members": {},
"traits": {
"smithy.api#documentation": "<p>An HTTP 200 response if the request succeeds, or an error message if the request\n fails.</p>"
}
},
"com.amazonaws.sesv2#PutConfigurationSetDeliveryOptions": {
"type": "operation",
"input": {
"target": "com.amazonaws.sesv2#PutConfigurationSetDeliveryOptionsRequest"
},
"output": {
"target": "com.amazonaws.sesv2#PutConfigurationSetDeliveryOptionsResponse"
},
"errors": [
{
"target": "com.amazonaws.sesv2#BadRequestException"
},
{
"target": "com.amazonaws.sesv2#NotFoundException"
},
{
"target": "com.amazonaws.sesv2#TooManyRequestsException"
}
],
"traits": {
"smithy.api#documentation": "<p>Associate a configuration set with a dedicated IP pool. You can use dedicated IP pools\n to create groups of dedicated IP addresses for sending specific types of email.</p>",
"smithy.api#http": {
"method": "PUT",
"uri": "/v2/email/configuration-sets/{ConfigurationSetName}/delivery-options",
"code": 200
}
}
},
"com.amazonaws.sesv2#PutConfigurationSetDeliveryOptionsRequest": {
"type": "structure",
"members": {
"ConfigurationSetName": {
"target": "com.amazonaws.sesv2#ConfigurationSetName",
"traits": {
"smithy.api#documentation": "<p>The name of the configuration set that you want to associate with a dedicated IP\n pool.</p>",
"smithy.api#httpLabel": {},
"smithy.api#required": {}
}
},
"TlsPolicy": {
"target": "com.amazonaws.sesv2#TlsPolicy",
"traits": {
"smithy.api#documentation": "<p>Specifies whether messages that use the configuration set are required to use\n Transport Layer Security (TLS). If the value is <code>Require</code>, messages are only\n delivered if a TLS connection can be established. If the value is <code>Optional</code>,\n messages can be delivered in plain text if a TLS connection can't be established.</p>"
}
},
"SendingPoolName": {
"target": "com.amazonaws.sesv2#SendingPoolName",
"traits": {
"smithy.api#documentation": "<p>The name of the dedicated IP pool that you want to associate with the configuration\n set.</p>"
}
}
},
"traits": {
"smithy.api#documentation": "<p>A request to associate a configuration set with a dedicated IP pool.</p>"
}
},
"com.amazonaws.sesv2#PutConfigurationSetDeliveryOptionsResponse": {
"type": "structure",
"members": {},
"traits": {
"smithy.api#documentation": "<p>An HTTP 200 response if the request succeeds, or an error message if the request\n fails.</p>"
}
},
"com.amazonaws.sesv2#PutConfigurationSetReputationOptions": {
"type": "operation",
"input": {
"target": "com.amazonaws.sesv2#PutConfigurationSetReputationOptionsRequest"
},
"output": {
"target": "com.amazonaws.sesv2#PutConfigurationSetReputationOptionsResponse"
},
"errors": [
{
"target": "com.amazonaws.sesv2#BadRequestException"
},
{
"target": "com.amazonaws.sesv2#NotFoundException"
},
{
"target": "com.amazonaws.sesv2#TooManyRequestsException"
}
],
"traits": {
"smithy.api#documentation": "<p>Enable or disable collection of reputation metrics for emails that you send using a\n particular configuration set in a specific AWS Region.</p>",
"smithy.api#http": {
"method": "PUT",
"uri": "/v2/email/configuration-sets/{ConfigurationSetName}/reputation-options",
"code": 200
}
}
},
"com.amazonaws.sesv2#PutConfigurationSetReputationOptionsRequest": {
"type": "structure",
"members": {
"ConfigurationSetName": {
"target": "com.amazonaws.sesv2#ConfigurationSetName",
"traits": {
"smithy.api#documentation": "<p>The name of the configuration set that you want to enable or disable reputation metric\n tracking for.</p>",
"smithy.api#httpLabel": {},
"smithy.api#required": {}
}
},
"ReputationMetricsEnabled": {
"target": "com.amazonaws.sesv2#Enabled",
"traits": {
"smithy.api#documentation": "<p>If <code>true</code>, tracking of reputation metrics is enabled for the configuration\n set. If <code>false</code>, tracking of reputation metrics is disabled for the\n configuration set.</p>"
}
}
},
"traits": {
"smithy.api#documentation": "<p>A request to enable or disable tracking of reputation metrics for a configuration\n set.</p>"
}
},
"com.amazonaws.sesv2#PutConfigurationSetReputationOptionsResponse": {
"type": "structure",
"members": {},
"traits": {
"smithy.api#documentation": "<p>An HTTP 200 response if the request succeeds, or an error message if the request\n fails.</p>"
}
},
"com.amazonaws.sesv2#PutConfigurationSetSendingOptions": {
"type": "operation",
"input": {
"target": "com.amazonaws.sesv2#PutConfigurationSetSendingOptionsRequest"
},
"output": {
"target": "com.amazonaws.sesv2#PutConfigurationSetSendingOptionsResponse"
},
"errors": [
{
"target": "com.amazonaws.sesv2#BadRequestException"
},
{
"target": "com.amazonaws.sesv2#NotFoundException"
},
{
"target": "com.amazonaws.sesv2#TooManyRequestsException"
}
],
"traits": {
"smithy.api#documentation": "<p>Enable or disable email sending for messages that use a particular configuration set\n in a specific AWS Region.</p>",
"smithy.api#http": {
"method": "PUT",
"uri": "/v2/email/configuration-sets/{ConfigurationSetName}/sending",
"code": 200
}
}
},
"com.amazonaws.sesv2#PutConfigurationSetSendingOptionsRequest": {
"type": "structure",
"members": {
"ConfigurationSetName": {
"target": "com.amazonaws.sesv2#ConfigurationSetName",
"traits": {
"smithy.api#documentation": "<p>The name of the configuration set that you want to enable or disable email sending\n for.</p>",
"smithy.api#httpLabel": {},
"smithy.api#required": {}
}
},
"SendingEnabled": {
"target": "com.amazonaws.sesv2#Enabled",
"traits": {
"smithy.api#documentation": "<p>If <code>true</code>, email sending is enabled for the configuration set. If\n <code>false</code>, email sending is disabled for the configuration set.</p>"
}
}
},
"traits": {
"smithy.api#documentation": "<p>A request to enable or disable the ability of Amazon SES to send emails that use a specific\n configuration set.</p>"
}
},
"com.amazonaws.sesv2#PutConfigurationSetSendingOptionsResponse": {
"type": "structure",
"members": {},
"traits": {
"smithy.api#documentation": "<p>An HTTP 200 response if the request succeeds, or an error message if the request\n fails.</p>"
}
},
"com.amazonaws.sesv2#PutConfigurationSetSuppressionOptions": {
"type": "operation",
"input": {
"target": "com.amazonaws.sesv2#PutConfigurationSetSuppressionOptionsRequest"
},
"output": {
"target": "com.amazonaws.sesv2#PutConfigurationSetSuppressionOptionsResponse"
},
"errors": [
{
"target": "com.amazonaws.sesv2#BadRequestException"
},
{
"target": "com.amazonaws.sesv2#NotFoundException"
},
{
"target": "com.amazonaws.sesv2#TooManyRequestsException"
}
],
"traits": {
"smithy.api#documentation": "<p>Specify the account suppression list preferences for a configuration set.</p>",
"smithy.api#http": {
"method": "PUT",
"uri": "/v2/email/configuration-sets/{ConfigurationSetName}/suppression-options",
"code": 200
}
}
},
"com.amazonaws.sesv2#PutConfigurationSetSuppressionOptionsRequest": {
"type": "structure",
"members": {
"ConfigurationSetName": {
"target": "com.amazonaws.sesv2#ConfigurationSetName",
"traits": {
"smithy.api#documentation": "<p>The name of the configuration set that you want to change the suppression list\n preferences for.</p>",
"smithy.api#httpLabel": {},
"smithy.api#required": {}
}
},
"SuppressedReasons": {
"target": "com.amazonaws.sesv2#SuppressionListReasons",
"traits": {
"smithy.api#documentation": "<p>A list that contains the reasons that email addresses are automatically added to the\n suppression list for your account. This list can contain any or all of the\n following:</p>\n <ul>\n <li>\n <p>\n <code>COMPLAINT</code> Amazon SES adds an email address to the suppression\n list for your account when a message sent to that address results in a\n complaint.</p>\n </li>\n <li>\n <p>\n <code>BOUNCE</code> Amazon SES adds an email address to the suppression\n list for your account when a message sent to that address results in a\n hard bounce.</p>\n </li>\n </ul>"
}
}
},
"traits": {
"smithy.api#documentation": "<p>A request to change the account suppression list preferences for a specific\n configuration set.</p>"
}
},
"com.amazonaws.sesv2#PutConfigurationSetSuppressionOptionsResponse": {
"type": "structure",
"members": {},
"traits": {
"smithy.api#documentation": "<p>An HTTP 200 response if the request succeeds, or an error message if the request\n fails.</p>"
}
},
"com.amazonaws.sesv2#PutConfigurationSetTrackingOptions": {
"type": "operation",
"input": {
"target": "com.amazonaws.sesv2#PutConfigurationSetTrackingOptionsRequest"
},
"output": {
"target": "com.amazonaws.sesv2#PutConfigurationSetTrackingOptionsResponse"
},
"errors": [
{
"target": "com.amazonaws.sesv2#BadRequestException"
},
{
"target": "com.amazonaws.sesv2#NotFoundException"
},
{
"target": "com.amazonaws.sesv2#TooManyRequestsException"
}
],
"traits": {
"smithy.api#documentation": "<p>Specify a custom domain to use for open and click tracking elements in email that you\n send.</p>",
"smithy.api#http": {
"method": "PUT",
"uri": "/v2/email/configuration-sets/{ConfigurationSetName}/tracking-options",
"code": 200
}
}
},
"com.amazonaws.sesv2#PutConfigurationSetTrackingOptionsRequest": {
"type": "structure",
"members": {
"ConfigurationSetName": {
"target": "com.amazonaws.sesv2#ConfigurationSetName",
"traits": {
"smithy.api#documentation": "<p>The name of the configuration set that you want to add a custom tracking domain\n to.</p>",
"smithy.api#httpLabel": {},
"smithy.api#required": {}
}
},
"CustomRedirectDomain": {
"target": "com.amazonaws.sesv2#CustomRedirectDomain",
"traits": {
"smithy.api#documentation": "<p>The domain that you want to use to track open and click events.</p>"
}
}
},
"traits": {
"smithy.api#documentation": "<p>A request to add a custom domain for tracking open and click events to a configuration\n set.</p>"
}
},
"com.amazonaws.sesv2#PutConfigurationSetTrackingOptionsResponse": {
"type": "structure",
"members": {},
"traits": {
"smithy.api#documentation": "<p>An HTTP 200 response if the request succeeds, or an error message if the request\n fails.</p>"
}
},
"com.amazonaws.sesv2#PutDedicatedIpInPool": {
"type": "operation",
"input": {
"target": "com.amazonaws.sesv2#PutDedicatedIpInPoolRequest"
},
"output": {
"target": "com.amazonaws.sesv2#PutDedicatedIpInPoolResponse"
},
"errors": [
{
"target": "com.amazonaws.sesv2#BadRequestException"
},
{
"target": "com.amazonaws.sesv2#NotFoundException"
},
{
"target": "com.amazonaws.sesv2#TooManyRequestsException"
}
],
"traits": {
"smithy.api#documentation": "<p>Move a dedicated IP address to an existing dedicated IP pool.</p>\n <note>\n <p>The dedicated IP address that you specify must already exist, and must be\n associated with your AWS account.\n \n </p>\n <p>The dedicated IP pool you specify must already exist. You can create a new pool by\n using the <code>CreateDedicatedIpPool</code> operation.</p>\n\n </note>",
"smithy.api#http": {
"method": "PUT",
"uri": "/v2/email/dedicated-ips/{Ip}/pool",
"code": 200
}
}
},
"com.amazonaws.sesv2#PutDedicatedIpInPoolRequest": {
"type": "structure",
"members": {
"Ip": {
"target": "com.amazonaws.sesv2#Ip",
"traits": {
"smithy.api#documentation": "<p>The IP address that you want to move to the dedicated IP pool. The value you specify\n has to be a dedicated IP address that's associated with your AWS account.</p>",
"smithy.api#httpLabel": {},
"smithy.api#required": {}
}
},
"DestinationPoolName": {
"target": "com.amazonaws.sesv2#PoolName",
"traits": {
"smithy.api#documentation": "<p>The name of the IP pool that you want to add the dedicated IP address to. You have to\n specify an IP pool that already exists.</p>",
"smithy.api#required": {}
}
}
},
"traits": {
"smithy.api#documentation": "<p>A request to move a dedicated IP address to a dedicated IP pool.</p>"
}
},
"com.amazonaws.sesv2#PutDedicatedIpInPoolResponse": {
"type": "structure",
"members": {},
"traits": {
"smithy.api#documentation": "<p>An HTTP 200 response if the request succeeds, or an error message if the request\n fails.</p>"
}
},
"com.amazonaws.sesv2#PutDedicatedIpWarmupAttributes": {
"type": "operation",
"input": {
"target": "com.amazonaws.sesv2#PutDedicatedIpWarmupAttributesRequest"
},
"output": {
"target": "com.amazonaws.sesv2#PutDedicatedIpWarmupAttributesResponse"
},
"errors": [
{
"target": "com.amazonaws.sesv2#BadRequestException"
},
{
"target": "com.amazonaws.sesv2#NotFoundException"
},
{
"target": "com.amazonaws.sesv2#TooManyRequestsException"
}
],
"traits": {
"smithy.api#documentation": "<p></p>",
"smithy.api#http": {
"method": "PUT",
"uri": "/v2/email/dedicated-ips/{Ip}/warmup",
"code": 200
}
}
},
"com.amazonaws.sesv2#PutDedicatedIpWarmupAttributesRequest": {
"type": "structure",
"members": {
"Ip": {
"target": "com.amazonaws.sesv2#Ip",
"traits": {
"smithy.api#documentation": "<p>The dedicated IP address that you want to update the warm-up attributes for.</p>",
"smithy.api#httpLabel": {},
"smithy.api#required": {}
}
},
"WarmupPercentage": {
"target": "com.amazonaws.sesv2#Percentage100Wrapper",
"traits": {
"smithy.api#documentation": "<p>The warm-up percentage that you want to associate with the dedicated IP\n address.</p>",
"smithy.api#required": {}
}
}
},
"traits": {
"smithy.api#documentation": "<p>A request to change the warm-up attributes for a dedicated IP address. This operation\n is useful when you want to resume the warm-up process for an existing IP address.</p>"
}
},
"com.amazonaws.sesv2#PutDedicatedIpWarmupAttributesResponse": {
"type": "structure",
"members": {},
"traits": {
"smithy.api#documentation": "<p>An HTTP 200 response if the request succeeds, or an error message if the request\n fails.</p>"
}
},
"com.amazonaws.sesv2#PutDeliverabilityDashboardOption": {
"type": "operation",
"input": {
"target": "com.amazonaws.sesv2#PutDeliverabilityDashboardOptionRequest"
},
"output": {
"target": "com.amazonaws.sesv2#PutDeliverabilityDashboardOptionResponse"
},
"errors": [
{
"target": "com.amazonaws.sesv2#AlreadyExistsException"
},
{
"target": "com.amazonaws.sesv2#BadRequestException"
},
{
"target": "com.amazonaws.sesv2#LimitExceededException"
},
{
"target": "com.amazonaws.sesv2#NotFoundException"
},
{
"target": "com.amazonaws.sesv2#TooManyRequestsException"
}
],
"traits": {
"smithy.api#documentation": "<p>Enable or disable the Deliverability dashboard. When you enable the Deliverability dashboard, you gain\n access to reputation, deliverability, and other metrics for the domains that you use to\n send email. You also gain the ability to perform predictive inbox placement tests.</p>\n \n <p>When you use the Deliverability dashboard, you pay a monthly subscription charge, in addition\n to any other fees that you accrue by using Amazon SES and other AWS services. For more\n information about the features and cost of a Deliverability dashboard subscription, see <a href=\"http://aws.amazon.com/ses/pricing/\">Amazon SES Pricing</a>.</p>",
"smithy.api#http": {
"method": "PUT",
"uri": "/v2/email/deliverability-dashboard",
"code": 200
}
}
},
"com.amazonaws.sesv2#PutDeliverabilityDashboardOptionRequest": {
"type": "structure",
"members": {
"DashboardEnabled": {
"target": "com.amazonaws.sesv2#Enabled",
"traits": {
"smithy.api#documentation": "<p>Specifies whether to enable the Deliverability dashboard. To enable the dashboard, set this\n value to <code>true</code>.</p>",
"smithy.api#required": {}
}
},
"SubscribedDomains": {
"target": "com.amazonaws.sesv2#DomainDeliverabilityTrackingOptions",
"traits": {
"smithy.api#documentation": "<p>An array of objects, one for each verified domain that you use to send email and\n enabled the Deliverability dashboard for.</p>"
}
}
},
"traits": {
"smithy.api#documentation": "<p>Enable or disable the Deliverability dashboard. When you enable the Deliverability dashboard, you gain\n access to reputation, deliverability, and other metrics for the domains that you use to\n send email using Amazon SES API v2. You also gain the ability to perform predictive inbox placement tests.</p>\n <p>When you use the Deliverability dashboard, you pay a monthly subscription charge, in addition\n to any other fees that you accrue by using Amazon SES and other AWS services. For more\n information about the features and cost of a Deliverability dashboard subscription, see <a href=\"http://aws.amazon.com/pinpoint/pricing/\">Amazon Pinpoint Pricing</a>.</p>"
}
},
"com.amazonaws.sesv2#PutDeliverabilityDashboardOptionResponse": {
"type": "structure",
"members": {},
"traits": {
"smithy.api#documentation": "<p>A response that indicates whether the Deliverability dashboard is enabled.</p>"
}
},
"com.amazonaws.sesv2#PutEmailIdentityConfigurationSetAttributes": {
"type": "operation",
"input": {
"target": "com.amazonaws.sesv2#PutEmailIdentityConfigurationSetAttributesRequest"
},
"output": {
"target": "com.amazonaws.sesv2#PutEmailIdentityConfigurationSetAttributesResponse"
},
"errors": [
{
"target": "com.amazonaws.sesv2#BadRequestException"
},
{
"target": "com.amazonaws.sesv2#NotFoundException"
},
{
"target": "com.amazonaws.sesv2#TooManyRequestsException"
}
],
"traits": {
"smithy.api#documentation": "<p>Used to associate a configuration set with an email identity.</p>",
"smithy.api#http": {
"method": "PUT",
"uri": "/v2/email/identities/{EmailIdentity}/configuration-set",
"code": 200
}
}
},
"com.amazonaws.sesv2#PutEmailIdentityConfigurationSetAttributesRequest": {
"type": "structure",
"members": {
"EmailIdentity": {
"target": "com.amazonaws.sesv2#Identity",
"traits": {
"smithy.api#documentation": "<p>The email address or domain that you want to associate with a configuration set.</p>",
"smithy.api#httpLabel": {},
"smithy.api#required": {}
}
},
"ConfigurationSetName": {
"target": "com.amazonaws.sesv2#ConfigurationSetName",
"traits": {
"smithy.api#documentation": "<p>The configuration set that you want to associate with an email identity.</p>"
}
}
},
"traits": {
"smithy.api#documentation": "<p>A request to associate a configuration set with an email identity.</p>"
}
},
"com.amazonaws.sesv2#PutEmailIdentityConfigurationSetAttributesResponse": {
"type": "structure",
"members": {},
"traits": {
"smithy.api#documentation": "<p>If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body.</p>"
}
},
"com.amazonaws.sesv2#PutEmailIdentityDkimAttributes": {
"type": "operation",
"input": {
"target": "com.amazonaws.sesv2#PutEmailIdentityDkimAttributesRequest"
},
"output": {
"target": "com.amazonaws.sesv2#PutEmailIdentityDkimAttributesResponse"
},
"errors": [
{
"target": "com.amazonaws.sesv2#BadRequestException"
},
{
"target": "com.amazonaws.sesv2#NotFoundException"
},
{
"target": "com.amazonaws.sesv2#TooManyRequestsException"
}
],
"traits": {
"smithy.api#documentation": "<p>Used to enable or disable DKIM authentication for an email identity.</p>",
"smithy.api#http": {
"method": "PUT",
"uri": "/v2/email/identities/{EmailIdentity}/dkim",
"code": 200
}
}
},
"com.amazonaws.sesv2#PutEmailIdentityDkimAttributesRequest": {
"type": "structure",
"members": {
"EmailIdentity": {
"target": "com.amazonaws.sesv2#Identity",
"traits": {
"smithy.api#documentation": "<p>The email identity that you want to change the DKIM settings for.</p>",
"smithy.api#httpLabel": {},
"smithy.api#required": {}
}
},
"SigningEnabled": {
"target": "com.amazonaws.sesv2#Enabled",
"traits": {
"smithy.api#documentation": "<p>Sets the DKIM signing configuration for the identity.</p>\n <p>When you set this value <code>true</code>, then the messages that are sent from the\n identity are signed using DKIM. If you set this value to <code>false</code>, your\n messages are sent without DKIM signing.</p>"
}
}
},
"traits": {
"smithy.api#documentation": "<p>A request to enable or disable DKIM signing of email that you send from an email\n identity.</p>"
}
},
"com.amazonaws.sesv2#PutEmailIdentityDkimAttributesResponse": {
"type": "structure",
"members": {},
"traits": {
"smithy.api#documentation": "<p>An HTTP 200 response if the request succeeds, or an error message if the request\n fails.</p>"
}
},
"com.amazonaws.sesv2#PutEmailIdentityDkimSigningAttributes": {
"type": "operation",
"input": {
"target": "com.amazonaws.sesv2#PutEmailIdentityDkimSigningAttributesRequest"
},
"output": {
"target": "com.amazonaws.sesv2#PutEmailIdentityDkimSigningAttributesResponse"
},
"errors": [
{
"target": "com.amazonaws.sesv2#BadRequestException"
},
{
"target": "com.amazonaws.sesv2#NotFoundException"
},
{
"target": "com.amazonaws.sesv2#TooManyRequestsException"
}
],
"traits": {
"smithy.api#documentation": "<p>Used to configure or change the DKIM authentication settings for an email domain\n identity. You can use this operation to do any of the following:</p>\n <ul>\n <li>\n <p>Update the signing attributes for an identity that uses Bring Your Own DKIM\n (BYODKIM).</p>\n </li>\n <li>\n <p>Change from using no DKIM authentication to using Easy DKIM.</p>\n </li>\n <li>\n <p>Change from using no DKIM authentication to using BYODKIM.</p>\n </li>\n <li>\n <p>Change from using Easy DKIM to using BYODKIM.</p>\n </li>\n <li>\n <p>Change from using BYODKIM to using Easy DKIM.</p>\n </li>\n </ul>",
"smithy.api#http": {
"method": "PUT",
"uri": "/v1/email/identities/{EmailIdentity}/dkim/signing",
"code": 200
}
}
},
"com.amazonaws.sesv2#PutEmailIdentityDkimSigningAttributesRequest": {
"type": "structure",
"members": {
"EmailIdentity": {
"target": "com.amazonaws.sesv2#Identity",
"traits": {
"smithy.api#documentation": "<p>The email identity that you want to configure DKIM for.</p>",
"smithy.api#httpLabel": {},
"smithy.api#required": {}
}
},
"SigningAttributesOrigin": {
"target": "com.amazonaws.sesv2#DkimSigningAttributesOrigin",
"traits": {
"smithy.api#documentation": "<p>The method that you want to use to configure DKIM for the identity. There are two\n possible values:</p>\n <ul>\n <li>\n <p>\n <code>AWS_SES</code> Configure DKIM for the identity by using <a href=\"https://docs.aws.amazon.com/ses/latest/DeveloperGuide/easy-dkim.html\">Easy\n DKIM</a>.</p>\n </li>\n <li>\n <p>\n <code>EXTERNAL</code> Configure DKIM for the identity by using Bring\n Your Own DKIM (BYODKIM).</p>\n </li>\n </ul>",
"smithy.api#required": {}
}
},
"SigningAttributes": {
"target": "com.amazonaws.sesv2#DkimSigningAttributes",
"traits": {
"smithy.api#documentation": "<p>An object that contains information about the private key and selector that you want\n to use to configure DKIM for the identity. This object is only required if you want to\n configure Bring Your Own DKIM (BYODKIM) for the identity.</p>"
}
}
},
"traits": {
"smithy.api#documentation": "<p>A request to change the DKIM attributes for an email identity.</p>"
}
},
"com.amazonaws.sesv2#PutEmailIdentityDkimSigningAttributesResponse": {
"type": "structure",
"members": {
"DkimStatus": {
"target": "com.amazonaws.sesv2#DkimStatus",
"traits": {
"smithy.api#documentation": "<p>The DKIM authentication status of the identity. Amazon SES determines the authentication\n status by searching for specific records in the DNS configuration for your domain. If\n you used <a href=\"https://docs.aws.amazon.com/ses/latest/DeveloperGuide/easy-dkim.html\">Easy\n DKIM</a> to set up DKIM authentication, Amazon SES tries to find three unique CNAME\n records in the DNS configuration for your domain.</p>\n <p>If you provided a public key to perform DKIM authentication, Amazon SES tries to find a TXT\n record that uses the selector that you specified. The value of the TXT record must be a\n public key that's paired with the private key that you specified in the process of\n creating the identity.</p>\n <p>The status can be one of the following:</p>\n <ul>\n <li>\n <p>\n <code>PENDING</code> The verification process was initiated, but Amazon SES\n hasn't yet detected the DKIM records in the DNS configuration for the\n domain.</p>\n </li>\n <li>\n <p>\n <code>SUCCESS</code> The verification process completed\n successfully.</p>\n </li>\n <li>\n <p>\n <code>FAILED</code> The verification process failed. This typically\n occurs when Amazon SES fails to find the DKIM records in the DNS configuration of the\n domain.</p>\n </li>\n <li>\n <p>\n <code>TEMPORARY_FAILURE</code> A temporary issue is preventing Amazon SES\n from determining the DKIM authentication status of the domain.</p>\n </li>\n <li>\n <p>\n <code>NOT_STARTED</code> The DKIM verification process hasn't been\n initiated for the domain.</p>\n </li>\n </ul>"
}
},
"DkimTokens": {
"target": "com.amazonaws.sesv2#DnsTokenList",
"traits": {
"smithy.api#documentation": "<p>If you used <a href=\"https://docs.aws.amazon.com/ses/latest/DeveloperGuide/easy-dkim.html\">Easy DKIM</a> to configure DKIM authentication for the domain, then this object\n contains a set of unique strings that you use to create a set of CNAME records that you\n add to the DNS configuration for your domain. When Amazon SES detects these records in the\n DNS configuration for your domain, the DKIM authentication process is complete.</p>\n <p>If you configured DKIM authentication for the domain by providing your own\n public-private key pair, then this object contains the selector that's associated with\n your public key.</p>\n <p>Regardless of the DKIM authentication method you use, Amazon SES searches for the\n appropriate records in the DNS configuration of the domain for up to 72 hours.</p>"
}
}
},
"traits": {
"smithy.api#documentation": "<p>If the action is successful, the service sends back an HTTP 200 response.</p>\n <p>The following data is returned in JSON format by the service.</p>"
}
},
"com.amazonaws.sesv2#PutEmailIdentityFeedbackAttributes": {
"type": "operation",
"input": {
"target": "com.amazonaws.sesv2#PutEmailIdentityFeedbackAttributesRequest"
},
"output": {
"target": "com.amazonaws.sesv2#PutEmailIdentityFeedbackAttributesResponse"
},
"errors": [
{
"target": "com.amazonaws.sesv2#BadRequestException"
},
{
"target": "com.amazonaws.sesv2#NotFoundException"
},
{
"target": "com.amazonaws.sesv2#TooManyRequestsException"
}
],
"traits": {
"smithy.api#documentation": "<p>Used to enable or disable feedback forwarding for an identity. This setting determines\n what happens when an identity is used to send an email that results in a bounce or\n complaint event.</p>\n <p>If the value is <code>true</code>, you receive email notifications when bounce or\n complaint events occur. These notifications are sent to the address that you specified\n in the <code>Return-Path</code> header of the original email.</p>\n <p>You're required to have a method of tracking bounces and complaints. If you haven't\n set up another mechanism for receiving bounce or complaint notifications (for example,\n by setting up an event destination), you receive an email notification when these events\n occur (even if this setting is disabled).</p>",
"smithy.api#http": {
"method": "PUT",
"uri": "/v2/email/identities/{EmailIdentity}/feedback",
"code": 200
}
}
},
"com.amazonaws.sesv2#PutEmailIdentityFeedbackAttributesRequest": {
"type": "structure",
"members": {
"EmailIdentity": {
"target": "com.amazonaws.sesv2#Identity",
"traits": {
"smithy.api#documentation": "<p>The email identity that you want to configure bounce and complaint feedback forwarding\n for.</p>",
"smithy.api#httpLabel": {},
"smithy.api#required": {}
}
},
"EmailForwardingEnabled": {
"target": "com.amazonaws.sesv2#Enabled",
"traits": {
"smithy.api#documentation": "<p>Sets the feedback forwarding configuration for the identity.</p>\n <p>If the value is <code>true</code>, you receive email notifications when bounce or\n complaint events occur. These notifications are sent to the address that you specified\n in the <code>Return-Path</code> header of the original email.</p>\n <p>You're required to have a method of tracking bounces and complaints. If you haven't\n set up another mechanism for receiving bounce or complaint notifications (for example,\n by setting up an event destination), you receive an email notification when these events\n occur (even if this setting is disabled).</p>"
}
}
},
"traits": {
"smithy.api#documentation": "<p>A request to set the attributes that control how bounce and complaint events are\n processed.</p>"
}
},
"com.amazonaws.sesv2#PutEmailIdentityFeedbackAttributesResponse": {
"type": "structure",
"members": {},
"traits": {
"smithy.api#documentation": "<p>An HTTP 200 response if the request succeeds, or an error message if the request\n fails.</p>"
}
},
"com.amazonaws.sesv2#PutEmailIdentityMailFromAttributes": {
"type": "operation",
"input": {
"target": "com.amazonaws.sesv2#PutEmailIdentityMailFromAttributesRequest"
},
"output": {
"target": "com.amazonaws.sesv2#PutEmailIdentityMailFromAttributesResponse"
},
"errors": [
{
"target": "com.amazonaws.sesv2#BadRequestException"
},
{
"target": "com.amazonaws.sesv2#NotFoundException"
},
{
"target": "com.amazonaws.sesv2#TooManyRequestsException"
}
],
"traits": {
"smithy.api#documentation": "<p>Used to enable or disable the custom Mail-From domain configuration for an email\n identity.</p>",
"smithy.api#http": {
"method": "PUT",
"uri": "/v2/email/identities/{EmailIdentity}/mail-from",
"code": 200
}
}
},
"com.amazonaws.sesv2#PutEmailIdentityMailFromAttributesRequest": {
"type": "structure",
"members": {
"EmailIdentity": {
"target": "com.amazonaws.sesv2#Identity",
"traits": {
"smithy.api#documentation": "<p>The verified email identity that you want to set up the custom MAIL FROM domain\n for.</p>",
"smithy.api#httpLabel": {},
"smithy.api#required": {}
}
},
"MailFromDomain": {
"target": "com.amazonaws.sesv2#MailFromDomainName",
"traits": {
"smithy.api#documentation": "<p> The custom MAIL FROM domain that you want the verified identity to use. The MAIL FROM\n domain must meet the following criteria:</p>\n <ul>\n <li>\n <p>It has to be a subdomain of the verified identity.</p>\n </li>\n <li>\n <p>It can't be used to receive email.</p>\n </li>\n <li>\n <p>It can't be used in a \"From\" address if the MAIL FROM domain is a destination\n for feedback forwarding emails.</p>\n </li>\n </ul>"
}
},
"BehaviorOnMxFailure": {
"target": "com.amazonaws.sesv2#BehaviorOnMxFailure",
"traits": {
"smithy.api#documentation": "<p>The action that you want to take if the required MX record isn't found when you send\n an email. When you set this value to <code>UseDefaultValue</code>, the mail is sent\n using <i>amazonses.com</i> as the MAIL FROM domain. When you set this\n value to <code>RejectMessage</code>, the Amazon SES API v2 returns a\n <code>MailFromDomainNotVerified</code> error, and doesn't attempt to deliver the\n email.</p>\n <p>These behaviors are taken when the custom MAIL FROM domain configuration is in the\n <code>Pending</code>, <code>Failed</code>, and <code>TemporaryFailure</code>\n states.</p>"
}
}
},
"traits": {
"smithy.api#documentation": "<p>A request to configure the custom MAIL FROM domain for a verified identity.</p>"
}
},
"com.amazonaws.sesv2#PutEmailIdentityMailFromAttributesResponse": {
"type": "structure",
"members": {},
"traits": {
"smithy.api#documentation": "<p>An HTTP 200 response if the request succeeds, or an error message if the request\n fails.</p>"
}
},
"com.amazonaws.sesv2#PutSuppressedDestination": {
"type": "operation",
"input": {
"target": "com.amazonaws.sesv2#PutSuppressedDestinationRequest"
},
"output": {
"target": "com.amazonaws.sesv2#PutSuppressedDestinationResponse"
},
"errors": [
{
"target": "com.amazonaws.sesv2#BadRequestException"
},
{
"target": "com.amazonaws.sesv2#TooManyRequestsException"
}
],
"traits": {
"smithy.api#documentation": "<p>Adds an email address to the suppression list for your account.</p>",
"smithy.api#http": {
"method": "PUT",
"uri": "/v2/email/suppression/addresses",
"code": 200
}
}
},
"com.amazonaws.sesv2#PutSuppressedDestinationRequest": {
"type": "structure",
"members": {
"EmailAddress": {
"target": "com.amazonaws.sesv2#EmailAddress",
"traits": {
"smithy.api#documentation": "<p>The email address that should be added to the suppression list for your\n account.</p>",
"smithy.api#required": {}
}
},
"Reason": {
"target": "com.amazonaws.sesv2#SuppressionListReason",
"traits": {
"smithy.api#documentation": "<p>The factors that should cause the email address to be added to the suppression list\n for your account.</p>",
"smithy.api#required": {}
}
}
},
"traits": {
"smithy.api#documentation": "<p>A request to add an email destination to the suppression list for your account.</p>"
}
},
"com.amazonaws.sesv2#PutSuppressedDestinationResponse": {
"type": "structure",
"members": {},
"traits": {
"smithy.api#documentation": "<p>An HTTP 200 response if the request succeeds, or an error message if the request\n fails.</p>"
}
},
"com.amazonaws.sesv2#RawMessage": {
"type": "structure",
"members": {
"Data": {
"target": "com.amazonaws.sesv2#RawMessageData",
"traits": {
"smithy.api#documentation": "<p>The raw email message. The message has to meet the following criteria:</p>\n <ul>\n <li>\n <p>The message has to contain a header and a body, separated by one blank\n line.</p>\n </li>\n <li>\n <p>All of the required header fields must be present in the message.</p>\n </li>\n <li>\n <p>Each part of a multipart MIME message must be formatted properly.</p>\n </li>\n <li>\n <p>Attachments must be in a file format that the Amazon SES supports.</p>\n </li>\n <li>\n <p>The entire message must be Base64 encoded.</p>\n </li>\n <li>\n <p>If any of the MIME parts in your message contain content that is outside of\n the 7-bit ASCII character range, you should encode that content to ensure that\n recipients' email clients render the message properly.</p>\n </li>\n <li>\n <p>The length of any single line of text in the message can't exceed 1,000\n characters. This restriction is defined in <a href=\"https://tools.ietf.org/html/rfc5321\">RFC 5321</a>.</p>\n </li>\n </ul>",
"smithy.api#required": {}
}
}
},
"traits": {
"smithy.api#documentation": "<p>Represents the raw content of an email message.</p>"
}
},
"com.amazonaws.sesv2#RawMessageData": {
"type": "blob",
"traits": {
"smithy.api#documentation": "<p>The raw email message. The message has to meet the following criteria:</p>\n <ul>\n <li>\n <p>The message has to contain a header and a body, separated by one blank\n line.</p>\n </li>\n <li>\n <p>All of the required header fields must be present in the message.</p>\n </li>\n <li>\n <p>Each part of a multipart MIME message must be formatted properly.</p>\n </li>\n <li>\n <p>Attachments must be in a file format that the Amazon SES API v2 supports.\n </p>\n </li>\n <li>\n <p>The entire message must be Base64 encoded.</p>\n </li>\n <li>\n <p>If any of the MIME parts in your message contain content that is outside of\n the 7-bit ASCII character range, you should encode that content to ensure that\n recipients' email clients render the message properly.</p>\n </li>\n <li>\n <p>The length of any single line of text in the message can't exceed 1,000\n characters. This restriction is defined in <a href=\"https://tools.ietf.org/html/rfc5321\">RFC 5321</a>.</p>\n </li>\n </ul>"
}
},
"com.amazonaws.sesv2#RblName": {
"type": "string",
"traits": {
"smithy.api#documentation": "<p>The name of a blacklist that an IP address was found on.</p>"
}
},
"com.amazonaws.sesv2#RenderedEmailTemplate": {
"type": "string",
"traits": {
"smithy.api#documentation": "<p>The complete MIME message rendered by applying the data in the TemplateData parameter\n to the template specified in the TemplateName parameter.</p>"
}
},
"com.amazonaws.sesv2#ReplacementEmailContent": {
"type": "structure",
"members": {
"ReplacementTemplate": {
"target": "com.amazonaws.sesv2#ReplacementTemplate",
"traits": {
"smithy.api#documentation": "<p>The <code>ReplacementTemplate</code> associated with\n <code>ReplacementEmailContent</code>.</p>"
}
}
},
"traits": {
"smithy.api#documentation": "<p>The <code>ReplaceEmailContent</code> object to be used for a specific\n <code>BulkEmailEntry</code>. The <code>ReplacementTemplate</code> can be specified\n within this object.</p>"
}
},
"com.amazonaws.sesv2#ReplacementTemplate": {
"type": "structure",
"members": {
"ReplacementTemplateData": {
"target": "com.amazonaws.sesv2#EmailTemplateData",
"traits": {
"smithy.api#documentation": "<p>A list of replacement values to apply to the template. This parameter is a JSON\n object, typically consisting of key-value pairs in which the keys correspond to\n replacement tags in the email template.</p>"
}
}
},
"traits": {
"smithy.api#documentation": "<p>An object which contains <code>ReplacementTemplateData</code> to be used for a\n specific <code>BulkEmailEntry</code>.</p>"
}
},
"com.amazonaws.sesv2#ReportId": {
"type": "string",
"traits": {
"smithy.api#documentation": "<p>A unique string that identifies a Deliverability dashboard report.</p>"
}
},
"com.amazonaws.sesv2#ReportName": {
"type": "string",
"traits": {
"smithy.api#documentation": "<p>A name that helps you identify a report generated by the Deliverability dashboard.</p>"
}
},
"com.amazonaws.sesv2#ReputationOptions": {
"type": "structure",
"members": {
"ReputationMetricsEnabled": {
"target": "com.amazonaws.sesv2#Enabled",
"traits": {
"smithy.api#documentation": "<p>If <code>true</code>, tracking of reputation metrics is enabled for the configuration\n set. If <code>false</code>, tracking of reputation metrics is disabled for the\n configuration set.</p>"
}
},
"LastFreshStart": {
"target": "com.amazonaws.sesv2#LastFreshStart",
"traits": {
"smithy.api#documentation": "<p>The date and time (in Unix time) when the reputation metrics were last given a fresh\n start. When your account is given a fresh start, your reputation metrics are calculated\n starting from the date of the fresh start.</p>"
}
}
},
"traits": {
"smithy.api#documentation": "<p>Enable or disable collection of reputation metrics for emails that you send using this\n configuration set in the current AWS Region. </p>"
}
},
"com.amazonaws.sesv2#ReviewDetails": {
"type": "structure",
"members": {
"Status": {
"target": "com.amazonaws.sesv2#ReviewStatus",
"traits": {
"smithy.api#documentation": "<p>The status of the latest review of your account. The status can be one of the\n following:</p>\n <ul>\n <li>\n <p>\n <code>PENDING</code> We have received your appeal and are in the\n process of reviewing it.</p>\n </li>\n <li>\n <p>\n <code>GRANTED</code> Your appeal has been reviewed and your production\n access has been granted.</p>\n </li>\n <li>\n <p>\n <code>DENIED</code> Your appeal has been reviewed and your production\n access has been denied.</p>\n </li>\n <li>\n <p>\n <code>FAILED</code> An internal error occurred and we didn't receive\n your appeal. You can submit your appeal again.</p>\n </li>\n </ul>"
}
},
"CaseId": {
"target": "com.amazonaws.sesv2#CaseId",
"traits": {
"smithy.api#documentation": "<p>The associated support center case ID (if any).</p>"
}
}
},
"traits": {
"smithy.api#documentation": "<p>An object that contains information about your account details review.</p>"
}
},
"com.amazonaws.sesv2#ReviewStatus": {
"type": "string",
"traits": {
"smithy.api#enum": [
{
"value": "PENDING",
"name": "PENDING"
},
{
"value": "FAILED",
"name": "FAILED"
},
{
"value": "GRANTED",
"name": "GRANTED"
},
{
"value": "DENIED",
"name": "DENIED"
}
]
}
},
"com.amazonaws.sesv2#S3Url": {
"type": "string",
"traits": {
"smithy.api#documentation": "<p>An Amazon S3 URL in the format\n s3://<i><bucket_name></i>/<i><object></i>.</p>",
"smithy.api#pattern": "^s3:\\/\\/([^\\/]+)\\/(.*?([^\\/]+)\\/?)$"
}
},
"com.amazonaws.sesv2#Selector": {
"type": "string",
"traits": {
"smithy.api#length": {
"min": 1,
"max": 63
},
"smithy.api#pattern": "^(([a-zA-Z0-9]|[a-zA-Z0-9][a-zA-Z0-9\\-]*[a-zA-Z0-9]))$"
}
},
"com.amazonaws.sesv2#SendBulkEmail": {
"type": "operation",
"input": {
"target": "com.amazonaws.sesv2#SendBulkEmailRequest"
},
"output": {
"target": "com.amazonaws.sesv2#SendBulkEmailResponse"
},
"errors": [
{
"target": "com.amazonaws.sesv2#AccountSuspendedException"
},
{
"target": "com.amazonaws.sesv2#BadRequestException"
},
{
"target": "com.amazonaws.sesv2#LimitExceededException"
},
{
"target": "com.amazonaws.sesv2#MailFromDomainNotVerifiedException"
},
{
"target": "com.amazonaws.sesv2#MessageRejected"
},
{
"target": "com.amazonaws.sesv2#NotFoundException"
},
{
"target": "com.amazonaws.sesv2#SendingPausedException"
},
{
"target": "com.amazonaws.sesv2#TooManyRequestsException"
}
],
"traits": {
"smithy.api#documentation": "<p>Composes an email message to multiple destinations.</p>",
"smithy.api#http": {
"method": "POST",
"uri": "/v2/email/outbound-bulk-emails",
"code": 200
}
}
},
"com.amazonaws.sesv2#SendBulkEmailRequest": {
"type": "structure",
"members": {
"FromEmailAddress": {
"target": "com.amazonaws.sesv2#EmailAddress",
"traits": {
"smithy.api#documentation": "<p>The email address that you want to use as the \"From\" address for the email. The\n address that you specify has to be verified.</p>"
}
},
"FromEmailAddressIdentityArn": {
"target": "com.amazonaws.sesv2#AmazonResourceName",
"traits": {
"smithy.api#documentation": "<p>This parameter is used only for sending authorization. It is the ARN of the identity\n that is associated with the sending authorization policy that permits you to use the\n email address specified in the <code>FromEmailAddress</code> parameter.</p>\n <p>For example, if the owner of example.com (which has ARN\n arn:aws:ses:us-east-1:123456789012:identity/example.com) attaches a policy to it that\n authorizes you to use sender@example.com, then you would specify the\n <code>FromEmailAddressIdentityArn</code> to be\n arn:aws:ses:us-east-1:123456789012:identity/example.com, and the\n <code>FromEmailAddress</code> to be sender@example.com.</p>\n <p>For more information about sending authorization, see the <a href=\"https://docs.aws.amazon.com/ses/latest/DeveloperGuide/sending-authorization.html\">Amazon SES Developer\n Guide</a>.</p>"
}
},
"ReplyToAddresses": {
"target": "com.amazonaws.sesv2#EmailAddressList",
"traits": {
"smithy.api#documentation": "<p>The \"Reply-to\" email addresses for the message. When the recipient replies to the\n message, each Reply-to address receives the reply.</p>"
}
},
"FeedbackForwardingEmailAddress": {
"target": "com.amazonaws.sesv2#EmailAddress",
"traits": {
"smithy.api#documentation": "<p>The address that you want bounce and complaint notifications to be sent to.</p>"
}
},
"FeedbackForwardingEmailAddressIdentityArn": {
"target": "com.amazonaws.sesv2#AmazonResourceName",
"traits": {
"smithy.api#documentation": "<p>This parameter is used only for sending authorization. It is the ARN of the identity\n that is associated with the sending authorization policy that permits you to use the\n email address specified in the <code>FeedbackForwardingEmailAddress</code>\n parameter.</p>\n <p>For example, if the owner of example.com (which has ARN\n arn:aws:ses:us-east-1:123456789012:identity/example.com) attaches a policy to it that\n authorizes you to use feedback@example.com, then you would specify the\n <code>FeedbackForwardingEmailAddressIdentityArn</code> to be\n arn:aws:ses:us-east-1:123456789012:identity/example.com, and the\n <code>FeedbackForwardingEmailAddress</code> to be feedback@example.com.</p>\n <p>For more information about sending authorization, see the <a href=\"https://docs.aws.amazon.com/ses/latest/DeveloperGuide/sending-authorization.html\">Amazon SES Developer\n Guide</a>.</p>"
}
},
"DefaultEmailTags": {
"target": "com.amazonaws.sesv2#MessageTagList",
"traits": {
"smithy.api#documentation": "<p>A list of tags, in the form of name/value pairs, to apply to an email that you send\n using the <code>SendEmail</code> operation. Tags correspond to characteristics of the\n email that you define, so that you can publish email sending events.</p>"
}
},
"DefaultContent": {
"target": "com.amazonaws.sesv2#BulkEmailContent",
"traits": {
"smithy.api#documentation": "<p>An object that contains the body of the message. You can specify a template\n message.</p>",
"smithy.api#required": {}
}
},
"BulkEmailEntries": {
"target": "com.amazonaws.sesv2#BulkEmailEntryList",
"traits": {
"smithy.api#documentation": "<p>The list of bulk email entry objects.</p>",
"smithy.api#required": {}
}
},
"ConfigurationSetName": {
"target": "com.amazonaws.sesv2#ConfigurationSetName",
"traits": {
"smithy.api#documentation": "<p>The name of the configuration set that you want to use when sending the email.</p>"
}
}
},
"traits": {
"smithy.api#documentation": "<p>Represents a request to send email messages to multiple destinations using Amazon SES. For\n more information, see the <a href=\"https://docs.aws.amazon.com/ses/latest/DeveloperGuide/send-personalized-email-api.html\">Amazon SES Developer\n Guide</a>.</p>"
}
},
"com.amazonaws.sesv2#SendBulkEmailResponse": {
"type": "structure",
"members": {
"BulkEmailEntryResults": {
"target": "com.amazonaws.sesv2#BulkEmailEntryResultList",
"traits": {
"smithy.api#required": {}
}
}
},
"traits": {
"smithy.api#documentation": "<p>The following data is returned in JSON format by the service.</p>"
}
},
"com.amazonaws.sesv2#SendCustomVerificationEmail": {
"type": "operation",
"input": {
"target": "com.amazonaws.sesv2#SendCustomVerificationEmailRequest"
},
"output": {
"target": "com.amazonaws.sesv2#SendCustomVerificationEmailResponse"
},
"errors": [
{
"target": "com.amazonaws.sesv2#BadRequestException"
},
{
"target": "com.amazonaws.sesv2#LimitExceededException"
},
{
"target": "com.amazonaws.sesv2#MailFromDomainNotVerifiedException"
},
{
"target": "com.amazonaws.sesv2#MessageRejected"
},
{
"target": "com.amazonaws.sesv2#NotFoundException"
},
{
"target": "com.amazonaws.sesv2#SendingPausedException"
},
{
"target": "com.amazonaws.sesv2#TooManyRequestsException"
}
],
"traits": {
"smithy.api#documentation": "<p>Adds an email address to the list of identities for your Amazon SES account in the current\n AWS Region and attempts to verify it. As a result of executing this operation, a\n customized verification email is sent to the specified address.</p>\n <p>To use this operation, you must first create a custom verification email template. For\n more information about creating and using custom verification email templates, see\n <a href=\"https://docs.aws.amazon.com/ses/latest/DeveloperGuide/send-email-verify-address-custom.html\">Using Custom Verification Email Templates</a> in the <i>Amazon SES Developer\n Guide</i>.</p>\n <p>You can execute this operation no more than once per second.</p>",
"smithy.api#http": {
"method": "POST",
"uri": "/v2/email/outbound-custom-verification-emails",
"code": 200
}
}
},
"com.amazonaws.sesv2#SendCustomVerificationEmailRequest": {
"type": "structure",
"members": {
"EmailAddress": {
"target": "com.amazonaws.sesv2#EmailAddress",
"traits": {
"smithy.api#documentation": "<p>The email address to verify.</p>",
"smithy.api#required": {}
}
},
"TemplateName": {
"target": "com.amazonaws.sesv2#EmailTemplateName",
"traits": {
"smithy.api#documentation": "<p>The name of the custom verification email template to use when sending the\n verification email.</p>",
"smithy.api#required": {}
}
},
"ConfigurationSetName": {
"target": "com.amazonaws.sesv2#ConfigurationSetName",
"traits": {
"smithy.api#documentation": "<p>Name of a configuration set to use when sending the verification email.</p>"
}
}
},
"traits": {
"smithy.api#documentation": "<p>Represents a request to send a custom verification email to a specified\n recipient.</p>"
}
},
"com.amazonaws.sesv2#SendCustomVerificationEmailResponse": {
"type": "structure",
"members": {
"MessageId": {
"target": "com.amazonaws.sesv2#OutboundMessageId",
"traits": {
"smithy.api#documentation": "<p>The unique message identifier returned from the\n <code>SendCustomVerificationEmail</code> operation.</p>"
}
}
},
"traits": {
"smithy.api#documentation": "<p>The following element is returned by the service.</p>"
}
},
"com.amazonaws.sesv2#SendEmail": {
"type": "operation",
"input": {
"target": "com.amazonaws.sesv2#SendEmailRequest"
},
"output": {
"target": "com.amazonaws.sesv2#SendEmailResponse"
},
"errors": [
{
"target": "com.amazonaws.sesv2#AccountSuspendedException"
},
{
"target": "com.amazonaws.sesv2#BadRequestException"
},
{
"target": "com.amazonaws.sesv2#LimitExceededException"
},
{
"target": "com.amazonaws.sesv2#MailFromDomainNotVerifiedException"
},
{
"target": "com.amazonaws.sesv2#MessageRejected"
},
{
"target": "com.amazonaws.sesv2#NotFoundException"
},
{
"target": "com.amazonaws.sesv2#SendingPausedException"
},
{
"target": "com.amazonaws.sesv2#TooManyRequestsException"
}
],
"traits": {
"smithy.api#documentation": "<p>Sends an email message. You can use the Amazon SES API v2 to send two types of\n messages:</p>\n <ul>\n <li>\n <p>\n <b>Simple</b> A standard email message. When\n you create this type of message, you specify the sender, the recipient, and the\n message body, and Amazon SES assembles the message for you.</p>\n </li>\n <li>\n <p>\n <b>Raw</b> A raw, MIME-formatted email\n message. When you send this type of email, you have to specify all of the\n message headers, as well as the message body. You can use this message type to\n send messages that contain attachments. The message that you specify has to be a\n valid MIME message.</p>\n </li>\n <li>\n <p>\n <b>Templated</b> A message that contains\n personalization tags. When you send this type of email, Amazon SES API v2 automatically\n replaces the tags with values that you specify.</p>\n </li>\n </ul>",
"smithy.api#http": {
"method": "POST",
"uri": "/v2/email/outbound-emails",
"code": 200
}
}
},
"com.amazonaws.sesv2#SendEmailRequest": {
"type": "structure",
"members": {
"FromEmailAddress": {
"target": "com.amazonaws.sesv2#EmailAddress",
"traits": {
"smithy.api#documentation": "<p>The email address that you want to use as the \"From\" address for the email. The\n address that you specify has to be verified.\n </p>"
}
},
"FromEmailAddressIdentityArn": {
"target": "com.amazonaws.sesv2#AmazonResourceName",
"traits": {
"smithy.api#documentation": "<p>This parameter is used only for sending authorization. It is the ARN of the identity\n that is associated with the sending authorization policy that permits you to use the\n email address specified in the <code>FromEmailAddress</code> parameter.</p>\n <p>For example, if the owner of example.com (which has ARN\n arn:aws:ses:us-east-1:123456789012:identity/example.com) attaches a policy to it that\n authorizes you to use sender@example.com, then you would specify the\n <code>FromEmailAddressIdentityArn</code> to be\n arn:aws:ses:us-east-1:123456789012:identity/example.com, and the\n <code>FromEmailAddress</code> to be sender@example.com.</p>\n <p>For more information about sending authorization, see the <a href=\"https://docs.aws.amazon.com/ses/latest/DeveloperGuide/sending-authorization.html\">Amazon SES Developer\n Guide</a>.</p>\n <p>For Raw emails, the <code>FromEmailAddressIdentityArn</code> value overrides the\n X-SES-SOURCE-ARN and X-SES-FROM-ARN headers specified in raw email message\n content.</p>"
}
},
"Destination": {
"target": "com.amazonaws.sesv2#Destination",
"traits": {
"smithy.api#documentation": "<p>An object that contains the recipients of the email message.</p>"
}
},
"ReplyToAddresses": {
"target": "com.amazonaws.sesv2#EmailAddressList",
"traits": {
"smithy.api#documentation": "<p>The \"Reply-to\" email addresses for the message. When the recipient replies to the\n message, each Reply-to address receives the reply.</p>"
}
},
"FeedbackForwardingEmailAddress": {
"target": "com.amazonaws.sesv2#EmailAddress",
"traits": {
"smithy.api#documentation": "<p>The address that you want bounce and complaint notifications to be sent to.</p>"
}
},
"FeedbackForwardingEmailAddressIdentityArn": {
"target": "com.amazonaws.sesv2#AmazonResourceName",
"traits": {
"smithy.api#documentation": "<p>This parameter is used only for sending authorization. It is the ARN of the identity\n that is associated with the sending authorization policy that permits you to use the\n email address specified in the <code>FeedbackForwardingEmailAddress</code>\n parameter.</p>\n <p>For example, if the owner of example.com (which has ARN\n arn:aws:ses:us-east-1:123456789012:identity/example.com) attaches a policy to it that\n authorizes you to use feedback@example.com, then you would specify the\n <code>FeedbackForwardingEmailAddressIdentityArn</code> to be\n arn:aws:ses:us-east-1:123456789012:identity/example.com, and the\n <code>FeedbackForwardingEmailAddress</code> to be feedback@example.com.</p>\n <p>For more information about sending authorization, see the <a href=\"https://docs.aws.amazon.com/ses/latest/DeveloperGuide/sending-authorization.html\">Amazon SES Developer\n Guide</a>.</p>"
}
},
"Content": {
"target": "com.amazonaws.sesv2#EmailContent",
"traits": {
"smithy.api#documentation": "<p>An object that contains the body of the message. You can send either a Simple message\n Raw message or a template Message.</p>",
"smithy.api#required": {}
}
},
"EmailTags": {
"target": "com.amazonaws.sesv2#MessageTagList",
"traits": {
"smithy.api#documentation": "<p>A list of tags, in the form of name/value pairs, to apply to an email that you send\n using the <code>SendEmail</code> operation. Tags correspond to characteristics of the\n email that you define, so that you can publish email sending events. </p>"
}
},
"ConfigurationSetName": {
"target": "com.amazonaws.sesv2#ConfigurationSetName",
"traits": {
"smithy.api#documentation": "<p>The name of the configuration set that you want to use when sending the email.</p>"
}
},
"ListManagementOptions": {
"target": "com.amazonaws.sesv2#ListManagementOptions",
"traits": {
"smithy.api#documentation": "<p>An object used to specify a list or topic to which an email belongs, which will be\n used when a contact chooses to unsubscribe.</p>"
}
}
},
"traits": {
"smithy.api#documentation": "<p>Represents a request to send a single formatted email using Amazon SES. For more\n information, see the <a href=\"https://docs.aws.amazon.com/ses/latest/DeveloperGuide/send-email-formatted.html\">Amazon SES Developer\n Guide</a>.</p>"
}
},
"com.amazonaws.sesv2#SendEmailResponse": {
"type": "structure",
"members": {
"MessageId": {
"target": "com.amazonaws.sesv2#OutboundMessageId",
"traits": {
"smithy.api#documentation": "<p>A unique identifier for the message that is generated when the message is\n accepted.</p>\n <note>\n <p>It's possible for Amazon SES to accept a message without sending it. This can happen\n when the message that you're trying to send has an attachment contains a virus, or\n when you send a templated email that contains invalid personalization content, for\n example.</p>\n </note>"
}
}
},
"traits": {
"smithy.api#documentation": "<p>A unique message ID that you receive when an email is accepted for sending.</p>"
}
},
"com.amazonaws.sesv2#SendQuota": {
"type": "structure",
"members": {
"Max24HourSend": {
"target": "com.amazonaws.sesv2#Max24HourSend",
"traits": {
"smithy.api#documentation": "<p>The maximum number of emails that you can send in the current AWS Region over a\n 24-hour period. This value is also called your <i>sending\n quota</i>.</p>"
}
},
"MaxSendRate": {
"target": "com.amazonaws.sesv2#MaxSendRate",
"traits": {
"smithy.api#documentation": "<p>The maximum number of emails that you can send per second in the current AWS Region.\n This value is also called your <i>maximum sending rate</i> or your\n <i>maximum TPS (transactions per second) rate</i>.</p>"
}
},
"SentLast24Hours": {
"target": "com.amazonaws.sesv2#SentLast24Hours",
"traits": {
"smithy.api#documentation": "<p>The number of emails sent from your Amazon SES account in the current AWS Region over the\n past 24 hours.</p>"
}
}
},
"traits": {
"smithy.api#documentation": "<p>An object that contains information about the per-day and per-second sending limits\n for your Amazon SES account in the current AWS Region.</p>"
}
},
"com.amazonaws.sesv2#SendingOptions": {
"type": "structure",
"members": {
"SendingEnabled": {
"target": "com.amazonaws.sesv2#Enabled",
"traits": {
"smithy.api#documentation": "<p>If <code>true</code>, email sending is enabled for the configuration set. If\n <code>false</code>, email sending is disabled for the configuration set.</p>"
}
}
},
"traits": {
"smithy.api#documentation": "<p>Used to enable or disable email sending for messages that use this configuration set\n in the current AWS Region.</p>"
}
},
"com.amazonaws.sesv2#SendingPausedException": {
"type": "structure",
"members": {
"message": {
"target": "com.amazonaws.sesv2#ErrorMessage"
}
},
"traits": {
"smithy.api#documentation": "<p>The message can't be sent because the account's ability to send email is currently\n paused.</p>",
"smithy.api#error": "client",
"smithy.api#httpError": 400
}
},
"com.amazonaws.sesv2#SendingPoolName": {
"type": "string",
"traits": {
"smithy.api#documentation": "<p>The name of the dedicated IP pool that you want to associate with the configuration\n set.</p>"
}
},
"com.amazonaws.sesv2#SentLast24Hours": {
"type": "double"
},
"com.amazonaws.sesv2#SimpleEmailService_v2": {
"type": "service",
"version": "2019-09-27",
"operations": [
{
"target": "com.amazonaws.sesv2#CreateConfigurationSet"
},
{
"target": "com.amazonaws.sesv2#CreateConfigurationSetEventDestination"
},
{
"target": "com.amazonaws.sesv2#CreateContact"
},
{
"target": "com.amazonaws.sesv2#CreateContactList"
},
{
"target": "com.amazonaws.sesv2#CreateCustomVerificationEmailTemplate"
},
{
"target": "com.amazonaws.sesv2#CreateDedicatedIpPool"
},
{
"target": "com.amazonaws.sesv2#CreateDeliverabilityTestReport"
},
{
"target": "com.amazonaws.sesv2#CreateEmailIdentity"
},
{
"target": "com.amazonaws.sesv2#CreateEmailIdentityPolicy"
},
{
"target": "com.amazonaws.sesv2#CreateEmailTemplate"
},
{
"target": "com.amazonaws.sesv2#CreateImportJob"
},
{
"target": "com.amazonaws.sesv2#DeleteConfigurationSet"
},
{
"target": "com.amazonaws.sesv2#DeleteConfigurationSetEventDestination"
},
{
"target": "com.amazonaws.sesv2#DeleteContact"
},
{
"target": "com.amazonaws.sesv2#DeleteContactList"
},
{
"target": "com.amazonaws.sesv2#DeleteCustomVerificationEmailTemplate"
},
{
"target": "com.amazonaws.sesv2#DeleteDedicatedIpPool"
},
{
"target": "com.amazonaws.sesv2#DeleteEmailIdentity"
},
{
"target": "com.amazonaws.sesv2#DeleteEmailIdentityPolicy"
},
{
"target": "com.amazonaws.sesv2#DeleteEmailTemplate"
},
{
"target": "com.amazonaws.sesv2#DeleteSuppressedDestination"
},
{
"target": "com.amazonaws.sesv2#GetAccount"
},
{
"target": "com.amazonaws.sesv2#GetBlacklistReports"
},
{
"target": "com.amazonaws.sesv2#GetConfigurationSet"
},
{
"target": "com.amazonaws.sesv2#GetConfigurationSetEventDestinations"
},
{
"target": "com.amazonaws.sesv2#GetContact"
},
{
"target": "com.amazonaws.sesv2#GetContactList"
},
{
"target": "com.amazonaws.sesv2#GetCustomVerificationEmailTemplate"
},
{
"target": "com.amazonaws.sesv2#GetDedicatedIp"
},
{
"target": "com.amazonaws.sesv2#GetDedicatedIps"
},
{
"target": "com.amazonaws.sesv2#GetDeliverabilityDashboardOptions"
},
{
"target": "com.amazonaws.sesv2#GetDeliverabilityTestReport"
},
{
"target": "com.amazonaws.sesv2#GetDomainDeliverabilityCampaign"
},
{
"target": "com.amazonaws.sesv2#GetDomainStatisticsReport"
},
{
"target": "com.amazonaws.sesv2#GetEmailIdentity"
},
{
"target": "com.amazonaws.sesv2#GetEmailIdentityPolicies"
},
{
"target": "com.amazonaws.sesv2#GetEmailTemplate"
},
{
"target": "com.amazonaws.sesv2#GetImportJob"
},
{
"target": "com.amazonaws.sesv2#GetSuppressedDestination"
},
{
"target": "com.amazonaws.sesv2#ListConfigurationSets"
},
{
"target": "com.amazonaws.sesv2#ListContactLists"
},
{
"target": "com.amazonaws.sesv2#ListContacts"
},
{
"target": "com.amazonaws.sesv2#ListCustomVerificationEmailTemplates"
},
{
"target": "com.amazonaws.sesv2#ListDedicatedIpPools"
},
{
"target": "com.amazonaws.sesv2#ListDeliverabilityTestReports"
},
{
"target": "com.amazonaws.sesv2#ListDomainDeliverabilityCampaigns"
},
{
"target": "com.amazonaws.sesv2#ListEmailIdentities"
},
{
"target": "com.amazonaws.sesv2#ListEmailTemplates"
},
{
"target": "com.amazonaws.sesv2#ListImportJobs"
},
{
"target": "com.amazonaws.sesv2#ListSuppressedDestinations"
},
{
"target": "com.amazonaws.sesv2#ListTagsForResource"
},
{
"target": "com.amazonaws.sesv2#PutAccountDedicatedIpWarmupAttributes"
},
{
"target": "com.amazonaws.sesv2#PutAccountDetails"
},
{
"target": "com.amazonaws.sesv2#PutAccountSendingAttributes"
},
{
"target": "com.amazonaws.sesv2#PutAccountSuppressionAttributes"
},
{
"target": "com.amazonaws.sesv2#PutConfigurationSetDeliveryOptions"
},
{
"target": "com.amazonaws.sesv2#PutConfigurationSetReputationOptions"
},
{
"target": "com.amazonaws.sesv2#PutConfigurationSetSendingOptions"
},
{
"target": "com.amazonaws.sesv2#PutConfigurationSetSuppressionOptions"
},
{
"target": "com.amazonaws.sesv2#PutConfigurationSetTrackingOptions"
},
{
"target": "com.amazonaws.sesv2#PutDedicatedIpInPool"
},
{
"target": "com.amazonaws.sesv2#PutDedicatedIpWarmupAttributes"
},
{
"target": "com.amazonaws.sesv2#PutDeliverabilityDashboardOption"
},
{
"target": "com.amazonaws.sesv2#PutEmailIdentityConfigurationSetAttributes"
},
{
"target": "com.amazonaws.sesv2#PutEmailIdentityDkimAttributes"
},
{
"target": "com.amazonaws.sesv2#PutEmailIdentityDkimSigningAttributes"
},
{
"target": "com.amazonaws.sesv2#PutEmailIdentityFeedbackAttributes"
},
{
"target": "com.amazonaws.sesv2#PutEmailIdentityMailFromAttributes"
},
{
"target": "com.amazonaws.sesv2#PutSuppressedDestination"
},
{
"target": "com.amazonaws.sesv2#SendBulkEmail"
},
{
"target": "com.amazonaws.sesv2#SendCustomVerificationEmail"
},
{
"target": "com.amazonaws.sesv2#SendEmail"
},
{
"target": "com.amazonaws.sesv2#TagResource"
},
{
"target": "com.amazonaws.sesv2#TestRenderEmailTemplate"
},
{
"target": "com.amazonaws.sesv2#UntagResource"
},
{
"target": "com.amazonaws.sesv2#UpdateConfigurationSetEventDestination"
},
{
"target": "com.amazonaws.sesv2#UpdateContact"
},
{
"target": "com.amazonaws.sesv2#UpdateContactList"
},
{
"target": "com.amazonaws.sesv2#UpdateCustomVerificationEmailTemplate"
},
{
"target": "com.amazonaws.sesv2#UpdateEmailIdentityPolicy"
},
{
"target": "com.amazonaws.sesv2#UpdateEmailTemplate"
}
],
"traits": {
"aws.api#service": {
"sdkId": "SESv2",
"arnNamespace": "ses",
"cloudFormationName": "SESv2",
"cloudTrailEventSource": "sesv2.amazonaws.com",
"endpointPrefix": "email"
},
"aws.auth#sigv4": {
"name": "ses"
},
"aws.protocols#restJson1": {},
"smithy.api#documentation": "<fullname>Amazon SES API v2</fullname>\n <p>Welcome to the Amazon SES API v2 Reference. This guide provides information about the Amazon SES API v2,\n including supported operations, data types, parameters, and schemas.</p>\n <p>\n <a href=\"https://aws.amazon.com/pinpoint\">Amazon SES</a> is an AWS service that\n you can use to send email messages to your customers.</p>\n <p>If you're new to Amazon SES API v2, you might find it helpful to also review the <a href=\"https://docs.aws.amazon.com/ses/latest/DeveloperGuide/\">Amazon Simple Email Service Developer\n Guide</a>. The <i>Amazon SES Developer Guide</i> provides information\n and code samples that demonstrate how to use Amazon SES API v2 features programmatically.</p>\n <p>The Amazon SES API v2 is available in several AWS Regions and it provides an endpoint for each\n of these Regions. For a list of all the Regions and endpoints where the API is currently\n available, see <a href=\"https://docs.aws.amazon.com/general/latest/gr/rande.html#ses_region\">AWS Service Endpoints</a> in the <i>Amazon Web Services General Reference</i>. To\n learn more about AWS Regions, see <a href=\"https://docs.aws.amazon.com/general/latest/gr/rande-manage.html\">Managing AWS Regions</a> in the\n <i>Amazon Web Services General Reference</i>.</p>\n <p>In each Region, AWS maintains multiple Availability Zones. These Availability Zones\n are physically isolated from each other, but are united by private, low-latency,\n high-throughput, and highly redundant network connections. These Availability Zones\n enable us to provide very high levels of availability and redundancy, while also\n minimizing latency. To learn more about the number of Availability Zones that are\n available in each Region, see <a href=\"http://aws.amazon.com/about-aws/global-infrastructure/\">AWS Global Infrastructure</a>.</p>",
"smithy.api#title": "Amazon Simple Email Service"
}
},
"com.amazonaws.sesv2#SnsDestination": {
"type": "structure",
"members": {
"TopicArn": {
"target": "com.amazonaws.sesv2#AmazonResourceName",
"traits": {
"smithy.api#documentation": "<p>The Amazon Resource Name (ARN) of the Amazon SNS topic that you want to publish email\n events to. For more information about Amazon SNS topics, see the <a href=\"https://docs.aws.amazon.com/sns/latest/dg/CreateTopic.html\">Amazon SNS Developer\n Guide</a>.</p>",
"smithy.api#required": {}
}
}
},
"traits": {
"smithy.api#documentation": "<p>An object that defines an Amazon SNS destination for email events. You can use Amazon SNS to\n send notification when certain email events occur.</p>"
}
},
"com.amazonaws.sesv2#Subject": {
"type": "string"
},
"com.amazonaws.sesv2#SubscriptionStatus": {
"type": "string",
"traits": {
"smithy.api#enum": [
{
"value": "OPT_IN",
"name": "OPT_IN"
},
{
"value": "OPT_OUT",
"name": "OPT_OUT"
}
]
}
},
"com.amazonaws.sesv2#SuccessRedirectionURL": {
"type": "string",
"traits": {
"smithy.api#documentation": "<p>The URL that the recipient of the verification email is sent to if his or her address\n is successfully verified.</p>"
}
},
"com.amazonaws.sesv2#SuppressedDestination": {
"type": "structure",
"members": {
"EmailAddress": {
"target": "com.amazonaws.sesv2#EmailAddress",
"traits": {
"smithy.api#documentation": "<p>The email address that is on the suppression list for your account.</p>",
"smithy.api#required": {}
}
},
"Reason": {
"target": "com.amazonaws.sesv2#SuppressionListReason",
"traits": {
"smithy.api#documentation": "<p>The reason that the address was added to the suppression list for your account.</p>",
"smithy.api#required": {}
}
},
"LastUpdateTime": {
"target": "com.amazonaws.sesv2#Timestamp",
"traits": {
"smithy.api#documentation": "<p>The date and time when the suppressed destination was last updated, shown in Unix time\n format.</p>",
"smithy.api#required": {}
}
},
"Attributes": {
"target": "com.amazonaws.sesv2#SuppressedDestinationAttributes",
"traits": {
"smithy.api#documentation": "<p>An optional value that can contain additional information about the reasons that the\n address was added to the suppression list for your account.</p>"
}
}
},
"traits": {
"smithy.api#documentation": "<p>An object that contains information about an email address that is on the suppression\n list for your account.</p>"
}
},
"com.amazonaws.sesv2#SuppressedDestinationAttributes": {
"type": "structure",
"members": {
"MessageId": {
"target": "com.amazonaws.sesv2#OutboundMessageId",
"traits": {
"smithy.api#documentation": "<p>The unique identifier of the email message that caused the email address to be added\n to the suppression list for your account.</p>"
}
},
"FeedbackId": {
"target": "com.amazonaws.sesv2#FeedbackId",
"traits": {
"smithy.api#documentation": "<p>A unique identifier that's generated when an email address is added to the suppression\n list for your account.</p>"
}
}
},
"traits": {
"smithy.api#documentation": "<p>An object that contains additional attributes that are related an email address that\n is on the suppression list for your account.</p>"
}
},
"com.amazonaws.sesv2#SuppressedDestinationSummaries": {
"type": "list",
"member": {
"target": "com.amazonaws.sesv2#SuppressedDestinationSummary"
}
},
"com.amazonaws.sesv2#SuppressedDestinationSummary": {
"type": "structure",
"members": {
"EmailAddress": {
"target": "com.amazonaws.sesv2#EmailAddress",
"traits": {
"smithy.api#documentation": "<p>The email address that's on the suppression list for your account.</p>",
"smithy.api#required": {}
}
},
"Reason": {
"target": "com.amazonaws.sesv2#SuppressionListReason",
"traits": {
"smithy.api#documentation": "<p>The reason that the address was added to the suppression list for your account.</p>",
"smithy.api#required": {}
}
},
"LastUpdateTime": {
"target": "com.amazonaws.sesv2#Timestamp",
"traits": {
"smithy.api#documentation": "<p>The date and time when the suppressed destination was last updated, shown in Unix time\n format.</p>",
"smithy.api#required": {}
}
}
},
"traits": {
"smithy.api#documentation": "<p>A summary that describes the suppressed email address.</p>"
}
},
"com.amazonaws.sesv2#SuppressionAttributes": {
"type": "structure",
"members": {
"SuppressedReasons": {
"target": "com.amazonaws.sesv2#SuppressionListReasons",
"traits": {
"smithy.api#documentation": "<p>A list that contains the reasons that email addresses will be automatically added to\n the suppression list for your account. This list can contain any or all of the\n following:</p>\n <ul>\n <li>\n <p>\n <code>COMPLAINT</code> Amazon SES adds an email address to the suppression\n list for your account when a message sent to that address results in a\n complaint.</p>\n </li>\n <li>\n <p>\n <code>BOUNCE</code> Amazon SES adds an email address to the suppression\n list for your account when a message sent to that address results in a hard\n bounce.</p>\n </li>\n </ul>"
}
}
},
"traits": {
"smithy.api#documentation": "<p>An object that contains information about the email address suppression preferences\n for your account in the current AWS Region.</p>"
}
},
"com.amazonaws.sesv2#SuppressionListDestination": {
"type": "structure",
"members": {
"SuppressionListImportAction": {
"target": "com.amazonaws.sesv2#SuppressionListImportAction",
"traits": {
"smithy.api#documentation": "<p>The type of action that you want to perform on the address. Acceptable values:</p>\n <ul>\n <li>\n <p>PUT: add the addresses to the suppression list. If the record already exists,\n it will override it with the new value.</p>\n </li>\n <li>\n <p>DELETE: remove the addresses from the suppression list.</p>\n </li>\n </ul>",
"smithy.api#required": {}
}
}
},
"traits": {
"smithy.api#documentation": "<p>An object that contains details about the action of suppression list.</p>"
}
},
"com.amazonaws.sesv2#SuppressionListImportAction": {
"type": "string",
"traits": {
"smithy.api#documentation": "<p>The type of action that you want to perform on the address. Acceptable values:</p>\n <ul>\n <li>\n <p>PUT: add the addresses to the suppression list.</p>\n </li>\n <li>\n <p>DELETE: remove the address from the suppression list.</p>\n </li>\n </ul>",
"smithy.api#enum": [
{
"value": "DELETE",
"name": "DELETE"
},
{
"value": "PUT",
"name": "PUT"
}
]
}
},
"com.amazonaws.sesv2#SuppressionListReason": {
"type": "string",
"traits": {
"smithy.api#documentation": "<p>The reason that the address was added to the suppression list for your account. The\n value can be one of the following:</p>\n <ul>\n <li>\n <p>\n <code>COMPLAINT</code> Amazon SES added an email address to the suppression\n list for your account because a message sent to that address results in a\n complaint.</p>\n </li>\n <li>\n <p>\n <code>BOUNCE</code> Amazon SES added an email address to the suppression\n list for your account because a message sent to that address results in a hard\n bounce.</p>\n </li>\n </ul>",
"smithy.api#enum": [
{
"value": "BOUNCE",
"name": "BOUNCE"
},
{
"value": "COMPLAINT",
"name": "COMPLAINT"
}
]
}
},
"com.amazonaws.sesv2#SuppressionListReasons": {
"type": "list",
"member": {
"target": "com.amazonaws.sesv2#SuppressionListReason"
}
},
"com.amazonaws.sesv2#SuppressionOptions": {
"type": "structure",
"members": {
"SuppressedReasons": {
"target": "com.amazonaws.sesv2#SuppressionListReasons",
"traits": {
"smithy.api#documentation": "<p>A list that contains the reasons that email addresses are automatically added to the\n suppression list for your account. This list can contain any or all of the\n following:</p>\n <ul>\n <li>\n <p>\n <code>COMPLAINT</code> Amazon SES adds an email address to the suppression\n list for your account when a message sent to that address results in a\n complaint.</p>\n </li>\n <li>\n <p>\n <code>BOUNCE</code> Amazon SES adds an email address to the suppression\n list for your account when a message sent to that address results in a hard\n bounce.</p>\n </li>\n </ul>"
}
}
},
"traits": {
"smithy.api#documentation": "<p>An object that contains information about the suppression list preferences for your\n account.</p>"
}
},
"com.amazonaws.sesv2#Tag": {
"type": "structure",
"members": {
"Key": {
"target": "com.amazonaws.sesv2#TagKey",
"traits": {
"smithy.api#documentation": "<p>One part of a key-value pair that defines a tag. The maximum length of a tag key is\n 128 characters. The minimum length is 1 character.</p>",
"smithy.api#required": {}
}
},
"Value": {
"target": "com.amazonaws.sesv2#TagValue",
"traits": {
"smithy.api#documentation": "<p>The optional part of a key-value pair that defines a tag. The maximum length of a tag\n value is 256 characters. The minimum length is 0 characters. If you don't want a\n resource to have a specific tag value, don't specify a value for this parameter. If you\n don't specify a value, Amazon SES sets the value to an empty string.</p>",
"smithy.api#required": {}
}
}
},
"traits": {
"smithy.api#documentation": "<p>An object that defines the tags that are associated with a resource.\n A <i>tag</i> is a label that you optionally define and associate with\n a resource. Tags can help you categorize and manage resources in different ways, such as\n by purpose, owner, environment, or other criteria. A resource can have as many as 50\n tags.</p>\n <p>Each tag consists of a required <i>tag key</i> and an\n associated <i>tag value</i>, both of which you define. A tag key is a\n general label that acts as a category for a more specific tag value. A tag value acts as\n a descriptor within a tag key. A tag key can contain as many as 128 characters. A tag\n value can contain as many as 256 characters. The characters can be Unicode letters,\n digits, white space, or one of the following symbols: _ . : / = + -. The following\n additional restrictions apply to tags:</p>\n <ul>\n <li>\n <p>Tag keys and values are case sensitive.</p>\n </li>\n <li>\n <p>For each associated resource, each tag key must be unique and it can have only\n one value.</p>\n </li>\n <li>\n <p>The <code>aws:</code> prefix is reserved for use by AWS; you cant use it in\n any tag keys or values that you define. In addition, you can't edit or remove\n tag keys or values that use this prefix. Tags that use this prefix dont count\n against the limit of 50 tags per resource.</p>\n </li>\n <li>\n <p>You can associate tags with public or shared resources, but the tags are\n available only for your AWS account, not any other accounts that share the\n resource. In addition, the tags are available only for resources that are\n located in the specified AWS Region for your AWS account.</p>\n </li>\n </ul>"
}
},
"com.amazonaws.sesv2#TagKey": {
"type": "string"
},
"com.amazonaws.sesv2#TagKeyList": {
"type": "list",
"member": {
"target": "com.amazonaws.sesv2#TagKey"
}
},
"com.amazonaws.sesv2#TagList": {
"type": "list",
"member": {
"target": "com.amazonaws.sesv2#Tag"
}
},
"com.amazonaws.sesv2#TagResource": {
"type": "operation",
"input": {
"target": "com.amazonaws.sesv2#TagResourceRequest"
},
"output": {
"target": "com.amazonaws.sesv2#TagResourceResponse"
},
"errors": [
{
"target": "com.amazonaws.sesv2#BadRequestException"
},
{
"target": "com.amazonaws.sesv2#ConcurrentModificationException"
},
{
"target": "com.amazonaws.sesv2#NotFoundException"
},
{
"target": "com.amazonaws.sesv2#TooManyRequestsException"
}
],
"traits": {
"smithy.api#documentation": "<p>Add one or more tags (keys and values) to a specified resource. A\n <i>tag</i> is a label that you optionally define and associate with a\n resource. Tags can help you categorize and manage resources in different ways, such as\n by purpose, owner, environment, or other criteria. A resource can have as many as 50\n tags.</p>\n <p>Each tag consists of a required <i>tag key</i> and an\n associated <i>tag value</i>, both of which you define. A tag key is a\n general label that acts as a category for more specific tag values. A tag value acts as\n a descriptor within a tag key.</p>",
"smithy.api#http": {
"method": "POST",
"uri": "/v2/email/tags",
"code": 200
}
}
},
"com.amazonaws.sesv2#TagResourceRequest": {
"type": "structure",
"members": {
"ResourceArn": {
"target": "com.amazonaws.sesv2#AmazonResourceName",
"traits": {
"smithy.api#documentation": "<p>The Amazon Resource Name (ARN) of the resource that you want to add one or more tags\n to.</p>",
"smithy.api#required": {}
}
},
"Tags": {
"target": "com.amazonaws.sesv2#TagList",
"traits": {
"smithy.api#documentation": "<p>A list of the tags that you want to add to the resource. A tag consists of a required\n tag key (<code>Key</code>) and an associated tag value (<code>Value</code>). The maximum\n length of a tag key is 128 characters. The maximum length of a tag value is 256\n characters.</p>",
"smithy.api#required": {}
}
}
}
},
"com.amazonaws.sesv2#TagResourceResponse": {
"type": "structure",
"members": {}
},
"com.amazonaws.sesv2#TagValue": {
"type": "string"
},
"com.amazonaws.sesv2#Template": {
"type": "structure",
"members": {
"TemplateName": {
"target": "com.amazonaws.sesv2#EmailTemplateName",
"traits": {
"smithy.api#documentation": "<p>The name of the template. You will refer to this name when you send email using the\n <code>SendTemplatedEmail</code> or <code>SendBulkTemplatedEmail</code> operations.\n </p>"
}
},
"TemplateArn": {
"target": "com.amazonaws.sesv2#AmazonResourceName",
"traits": {
"smithy.api#documentation": "<p>The Amazon Resource Name (ARN) of the template.</p>"
}
},
"TemplateData": {
"target": "com.amazonaws.sesv2#EmailTemplateData",
"traits": {
"smithy.api#documentation": "<p>An object that defines the values to use for message variables in the template. This\n object is a set of key-value pairs. Each key defines a message variable in the template.\n The corresponding value defines the value to use for that variable.</p>"
}
}
},
"traits": {
"smithy.api#documentation": "<p>An object that defines the email template to use for an email message, and the values\n to use for any message variables in that template. An <i>email\n template</i> is a type of message template that contains content that you\n want to define, save, and reuse in email messages that you send.</p>"
}
},
"com.amazonaws.sesv2#TemplateContent": {
"type": "string",
"traits": {
"smithy.api#documentation": "<p>The content of the custom verification email template.</p>"
}
},
"com.amazonaws.sesv2#TestRenderEmailTemplate": {
"type": "operation",
"input": {
"target": "com.amazonaws.sesv2#TestRenderEmailTemplateRequest"
},
"output": {
"target": "com.amazonaws.sesv2#TestRenderEmailTemplateResponse"
},
"errors": [
{
"target": "com.amazonaws.sesv2#BadRequestException"
},
{
"target": "com.amazonaws.sesv2#NotFoundException"
},
{
"target": "com.amazonaws.sesv2#TooManyRequestsException"
}
],
"traits": {
"smithy.api#documentation": "<p>Creates a preview of the MIME content of an email when provided with a template and a\n set of replacement data.</p>\n\n <p>You can execute this operation no more than once per second.</p>",
"smithy.api#http": {
"method": "POST",
"uri": "/v2/email/templates/{TemplateName}/render",
"code": 200
}
}
},
"com.amazonaws.sesv2#TestRenderEmailTemplateRequest": {
"type": "structure",
"members": {
"TemplateName": {
"target": "com.amazonaws.sesv2#EmailTemplateName",
"traits": {
"smithy.api#documentation": "<p>The name of the template that you want to render.</p>",
"smithy.api#httpLabel": {},
"smithy.api#required": {}
}
},
"TemplateData": {
"target": "com.amazonaws.sesv2#EmailTemplateData",
"traits": {
"smithy.api#documentation": "<p>A list of replacement values to apply to the template. This parameter is a JSON\n object, typically consisting of key-value pairs in which the keys correspond to\n replacement tags in the email template.</p>",
"smithy.api#required": {}
}
}
},
"traits": {
"smithy.api#documentation": "<p>>Represents a request to create a preview of the MIME content of an email when\n provided with a template and a set of replacement data.</p>"
}
},
"com.amazonaws.sesv2#TestRenderEmailTemplateResponse": {
"type": "structure",
"members": {
"RenderedTemplate": {
"target": "com.amazonaws.sesv2#RenderedEmailTemplate",
"traits": {
"smithy.api#documentation": "<p>The complete MIME message rendered by applying the data in the\n <code>TemplateData</code> parameter to the template specified in the TemplateName\n parameter.</p>",
"smithy.api#required": {}
}
}
},
"traits": {
"smithy.api#documentation": "<p>The following element is returned by the service.</p>"
}
},
"com.amazonaws.sesv2#Timestamp": {
"type": "timestamp"
},
"com.amazonaws.sesv2#TlsPolicy": {
"type": "string",
"traits": {
"smithy.api#documentation": "<p>Specifies whether messages that use the configuration set are required to use\n Transport Layer Security (TLS). If the value is <code>Require</code>, messages are only\n delivered if a TLS connection can be established. If the value is <code>Optional</code>,\n messages can be delivered in plain text if a TLS connection can't be established.</p>",
"smithy.api#enum": [
{
"value": "REQUIRE",
"name": "REQUIRE"
},
{
"value": "OPTIONAL",
"name": "OPTIONAL"
}
]
}
},
"com.amazonaws.sesv2#TooManyRequestsException": {
"type": "structure",
"members": {
"message": {
"target": "com.amazonaws.sesv2#ErrorMessage"
}
},
"traits": {
"smithy.api#documentation": "<p>Too many requests have been made to the operation.</p>",
"smithy.api#error": "client",
"smithy.api#httpError": 429
}
},
"com.amazonaws.sesv2#Topic": {
"type": "structure",
"members": {
"TopicName": {
"target": "com.amazonaws.sesv2#TopicName",
"traits": {
"smithy.api#documentation": "<p>The name of the topic.</p>",
"smithy.api#required": {}
}
},
"DisplayName": {
"target": "com.amazonaws.sesv2#DisplayName",
"traits": {
"smithy.api#documentation": "<p>The name of the topic the contact will see.</p>",
"smithy.api#required": {}
}
},
"Description": {
"target": "com.amazonaws.sesv2#Description",
"traits": {
"smithy.api#documentation": "<p>A description of what the topic is about, which the contact will see.</p>"
}
},
"DefaultSubscriptionStatus": {
"target": "com.amazonaws.sesv2#SubscriptionStatus",
"traits": {
"smithy.api#documentation": "<p>The default subscription status to be applied to a contact if the contact has not\n noted their preference for subscribing to a topic.</p>",
"smithy.api#required": {}
}
}
},
"traits": {
"smithy.api#documentation": "<p>An interest group, theme, or label within a list. Lists can have multiple\n topics.</p>"
}
},
"com.amazonaws.sesv2#TopicFilter": {
"type": "structure",
"members": {
"TopicName": {
"target": "com.amazonaws.sesv2#TopicName",
"traits": {
"smithy.api#documentation": "<p>The name of a topic on which you wish to apply the filter.</p>"
}
},
"UseDefaultIfPreferenceUnavailable": {
"target": "com.amazonaws.sesv2#UseDefaultIfPreferenceUnavailable",
"traits": {
"smithy.api#documentation": "<p>Notes that the default subscription status should be applied to a contact because the\n contact has not noted their preference for subscribing to a topic.</p>"
}
}
},
"traits": {
"smithy.api#documentation": "<p>Used for filtering by a specific topic preference.</p>"
}
},
"com.amazonaws.sesv2#TopicName": {
"type": "string"
},
"com.amazonaws.sesv2#TopicPreference": {
"type": "structure",
"members": {
"TopicName": {
"target": "com.amazonaws.sesv2#TopicName",
"traits": {
"smithy.api#documentation": "<p>The name of the topic.</p>",
"smithy.api#required": {}
}
},
"SubscriptionStatus": {
"target": "com.amazonaws.sesv2#SubscriptionStatus",
"traits": {
"smithy.api#documentation": "<p>The contact's subscription status to a topic which is either <code>OPT_IN</code> or\n <code>OPT_OUT</code>.</p>",
"smithy.api#required": {}
}
}
},
"traits": {
"smithy.api#documentation": "<p>The contact's preference for being opted-in to or opted-out of a topic.</p>"
}
},
"com.amazonaws.sesv2#TopicPreferenceList": {
"type": "list",
"member": {
"target": "com.amazonaws.sesv2#TopicPreference"
}
},
"com.amazonaws.sesv2#Topics": {
"type": "list",
"member": {
"target": "com.amazonaws.sesv2#Topic"
}
},
"com.amazonaws.sesv2#TrackingOptions": {
"type": "structure",
"members": {
"CustomRedirectDomain": {
"target": "com.amazonaws.sesv2#CustomRedirectDomain",
"traits": {
"smithy.api#documentation": "<p>The domain that you want to use for tracking open and click events.</p>",
"smithy.api#required": {}
}
}
},
"traits": {
"smithy.api#documentation": "<p>An object that defines the tracking options for a configuration set. When you use the\n Amazon SES API v2 to send an email, it contains an invisible image that's used to track when\n recipients open your email. If your email contains links, those links are changed\n slightly in order to track when recipients click them.</p>\n <p>These images and links include references to a domain operated by AWS. You can\n optionally configure the Amazon SES to use a domain that you operate for these images and\n links.</p>"
}
},
"com.amazonaws.sesv2#UnsubscribeAll": {
"type": "boolean"
},
"com.amazonaws.sesv2#UntagResource": {
"type": "operation",
"input": {
"target": "com.amazonaws.sesv2#UntagResourceRequest"
},
"output": {
"target": "com.amazonaws.sesv2#UntagResourceResponse"
},
"errors": [
{
"target": "com.amazonaws.sesv2#BadRequestException"
},
{
"target": "com.amazonaws.sesv2#ConcurrentModificationException"
},
{
"target": "com.amazonaws.sesv2#NotFoundException"
},
{
"target": "com.amazonaws.sesv2#TooManyRequestsException"
}
],
"traits": {
"smithy.api#documentation": "<p>Remove one or more tags (keys and values) from a specified resource.</p>",
"smithy.api#http": {
"method": "DELETE",
"uri": "/v2/email/tags",
"code": 200
}
}
},
"com.amazonaws.sesv2#UntagResourceRequest": {
"type": "structure",
"members": {
"ResourceArn": {
"target": "com.amazonaws.sesv2#AmazonResourceName",
"traits": {
"smithy.api#documentation": "<p>The Amazon Resource Name (ARN) of the resource that you want to remove one or more\n tags from.</p>",
"smithy.api#httpQuery": "ResourceArn",
"smithy.api#required": {}
}
},
"TagKeys": {
"target": "com.amazonaws.sesv2#TagKeyList",
"traits": {
"smithy.api#documentation": "<p>The tags (tag keys) that you want to remove from the resource. When you specify a tag\n key, the action removes both that key and its associated tag value.</p>\n <p>To remove more than one tag from the resource, append the <code>TagKeys</code>\n parameter and argument for each additional tag to remove, separated by an ampersand. For\n example:\n <code>/v2/email/tags?ResourceArn=ResourceArn&TagKeys=Key1&TagKeys=Key2</code>\n </p>",
"smithy.api#httpQuery": "TagKeys",
"smithy.api#required": {}
}
}
}
},
"com.amazonaws.sesv2#UntagResourceResponse": {
"type": "structure",
"members": {}
},
"com.amazonaws.sesv2#UpdateConfigurationSetEventDestination": {
"type": "operation",
"input": {
"target": "com.amazonaws.sesv2#UpdateConfigurationSetEventDestinationRequest"
},
"output": {
"target": "com.amazonaws.sesv2#UpdateConfigurationSetEventDestinationResponse"
},
"errors": [
{
"target": "com.amazonaws.sesv2#BadRequestException"
},
{
"target": "com.amazonaws.sesv2#NotFoundException"
},
{
"target": "com.amazonaws.sesv2#TooManyRequestsException"
}
],
"traits": {
"smithy.api#documentation": "<p>Update the configuration of an event destination for a configuration set.</p>\n <p>\n <i>Events</i> include message sends, deliveries, opens, clicks, bounces,\n and complaints. <i>Event destinations</i> are places that you can send\n information about these events to. For example, you can send event data to Amazon SNS to\n receive notifications when you receive bounces or complaints, or you can use Amazon Kinesis Data Firehose to\n stream data to Amazon S3 for long-term storage.</p>",
"smithy.api#http": {
"method": "PUT",
"uri": "/v2/email/configuration-sets/{ConfigurationSetName}/event-destinations/{EventDestinationName}",
"code": 200
}
}
},
"com.amazonaws.sesv2#UpdateConfigurationSetEventDestinationRequest": {
"type": "structure",
"members": {
"ConfigurationSetName": {
"target": "com.amazonaws.sesv2#ConfigurationSetName",
"traits": {
"smithy.api#documentation": "<p>The name of the configuration set that contains the event destination that you want to\n modify.</p>",
"smithy.api#httpLabel": {},
"smithy.api#required": {}
}
},
"EventDestinationName": {
"target": "com.amazonaws.sesv2#EventDestinationName",
"traits": {
"smithy.api#documentation": "<p>The name of the event destination that you want to modify.</p>",
"smithy.api#httpLabel": {},
"smithy.api#required": {}
}
},
"EventDestination": {
"target": "com.amazonaws.sesv2#EventDestinationDefinition",
"traits": {
"smithy.api#documentation": "<p>An object that defines the event destination.</p>",
"smithy.api#required": {}
}
}
},
"traits": {
"smithy.api#documentation": "<p>A request to change the settings for an event destination for a configuration\n set.</p>"
}
},
"com.amazonaws.sesv2#UpdateConfigurationSetEventDestinationResponse": {
"type": "structure",
"members": {},
"traits": {
"smithy.api#documentation": "<p>An HTTP 200 response if the request succeeds, or an error message if the request\n fails.</p>"
}
},
"com.amazonaws.sesv2#UpdateContact": {
"type": "operation",
"input": {
"target": "com.amazonaws.sesv2#UpdateContactRequest"
},
"output": {
"target": "com.amazonaws.sesv2#UpdateContactResponse"
},
"errors": [
{
"target": "com.amazonaws.sesv2#BadRequestException"
},
{
"target": "com.amazonaws.sesv2#ConcurrentModificationException"
},
{
"target": "com.amazonaws.sesv2#NotFoundException"
},
{
"target": "com.amazonaws.sesv2#TooManyRequestsException"
}
],
"traits": {
"smithy.api#documentation": "<p>Updates a contact's preferences for a list. It is not necessary to specify all\n existing topic preferences in the TopicPreferences object, just the ones that need\n updating.</p>",
"smithy.api#http": {
"method": "PUT",
"uri": "/v2/email/contact-lists/{ContactListName}/contacts/{EmailAddress}",
"code": 200
}
}
},
"com.amazonaws.sesv2#UpdateContactList": {
"type": "operation",
"input": {
"target": "com.amazonaws.sesv2#UpdateContactListRequest"
},
"output": {
"target": "com.amazonaws.sesv2#UpdateContactListResponse"
},
"errors": [
{
"target": "com.amazonaws.sesv2#BadRequestException"
},
{
"target": "com.amazonaws.sesv2#ConcurrentModificationException"
},
{
"target": "com.amazonaws.sesv2#NotFoundException"
},
{
"target": "com.amazonaws.sesv2#TooManyRequestsException"
}
],
"traits": {
"smithy.api#documentation": "<p>Updates contact list metadata. This operation does a complete replacement.</p>",
"smithy.api#http": {
"method": "PUT",
"uri": "/v2/email/contact-lists/{ContactListName}",
"code": 200
}
}
},
"com.amazonaws.sesv2#UpdateContactListRequest": {
"type": "structure",
"members": {
"ContactListName": {
"target": "com.amazonaws.sesv2#ContactListName",
"traits": {
"smithy.api#documentation": "<p>The name of the contact list.</p>",
"smithy.api#httpLabel": {},
"smithy.api#required": {}
}
},
"Topics": {
"target": "com.amazonaws.sesv2#Topics",
"traits": {
"smithy.api#documentation": "<p>An interest group, theme, or label within a list. A contact list can have multiple\n topics.</p>"
}
},
"Description": {
"target": "com.amazonaws.sesv2#Description",
"traits": {
"smithy.api#documentation": "<p>A description of what the contact list is about.</p>"
}
}
}
},
"com.amazonaws.sesv2#UpdateContactListResponse": {
"type": "structure",
"members": {}
},
"com.amazonaws.sesv2#UpdateContactRequest": {
"type": "structure",
"members": {
"ContactListName": {
"target": "com.amazonaws.sesv2#ContactListName",
"traits": {
"smithy.api#documentation": "<p>The name of the contact list.</p>",
"smithy.api#httpLabel": {},
"smithy.api#required": {}
}
},
"EmailAddress": {
"target": "com.amazonaws.sesv2#EmailAddress",
"traits": {
"smithy.api#documentation": "<p>The contact's email addres.</p>",
"smithy.api#httpLabel": {},
"smithy.api#required": {}
}
},
"TopicPreferences": {
"target": "com.amazonaws.sesv2#TopicPreferenceList",
"traits": {
"smithy.api#documentation": "<p>The contact's preference for being opted-in to or opted-out of a topic.</p>"
}
},
"UnsubscribeAll": {
"target": "com.amazonaws.sesv2#UnsubscribeAll",
"traits": {
"smithy.api#documentation": "<p>A boolean value status noting if the contact is unsubscribed from all contact list\n topics.</p>"
}
},
"AttributesData": {
"target": "com.amazonaws.sesv2#AttributesData",
"traits": {
"smithy.api#documentation": "<p>The attribute data attached to a contact.</p>"
}
}
}
},
"com.amazonaws.sesv2#UpdateContactResponse": {
"type": "structure",
"members": {}
},
"com.amazonaws.sesv2#UpdateCustomVerificationEmailTemplate": {
"type": "operation",
"input": {
"target": "com.amazonaws.sesv2#UpdateCustomVerificationEmailTemplateRequest"
},
"output": {
"target": "com.amazonaws.sesv2#UpdateCustomVerificationEmailTemplateResponse"
},
"errors": [
{
"target": "com.amazonaws.sesv2#BadRequestException"
},
{
"target": "com.amazonaws.sesv2#NotFoundException"
},
{
"target": "com.amazonaws.sesv2#TooManyRequestsException"
}
],
"traits": {
"smithy.api#documentation": "<p>Updates an existing custom verification email template.</p>\n <p>For more information about custom verification email templates, see <a href=\"https://docs.aws.amazon.com/ses/latest/DeveloperGuide/send-email-verify-address-custom.html\">Using Custom Verification Email Templates</a> in the <i>Amazon SES Developer\n Guide</i>.</p>\n <p>You can execute this operation no more than once per second.</p>",
"smithy.api#http": {
"method": "PUT",
"uri": "/v2/email/custom-verification-email-templates/{TemplateName}",
"code": 200
}
}
},
"com.amazonaws.sesv2#UpdateCustomVerificationEmailTemplateRequest": {
"type": "structure",
"members": {
"TemplateName": {
"target": "com.amazonaws.sesv2#EmailTemplateName",
"traits": {
"smithy.api#documentation": "<p>The name of the custom verification email template that you want to update.</p>",
"smithy.api#httpLabel": {},
"smithy.api#required": {}
}
},
"FromEmailAddress": {
"target": "com.amazonaws.sesv2#EmailAddress",
"traits": {
"smithy.api#documentation": "<p>The email address that the custom verification email is sent from.</p>",
"smithy.api#required": {}
}
},
"TemplateSubject": {
"target": "com.amazonaws.sesv2#EmailTemplateSubject",
"traits": {
"smithy.api#documentation": "<p>The subject line of the custom verification email.</p>",
"smithy.api#required": {}
}
},
"TemplateContent": {
"target": "com.amazonaws.sesv2#TemplateContent",
"traits": {
"smithy.api#documentation": "<p>The content of the custom verification email. The total size of the email must be less\n than 10 MB. The message body may contain HTML, with some limitations. For more\n information, see <a href=\"https://docs.aws.amazon.com/ses/latest/DeveloperGuide/send-email-verify-address-custom.html#custom-verification-emails-faq\">Custom Verification Email Frequently Asked Questions</a> in the <i>Amazon SES\n Developer Guide</i>.</p>",
"smithy.api#required": {}
}
},
"SuccessRedirectionURL": {
"target": "com.amazonaws.sesv2#SuccessRedirectionURL",
"traits": {
"smithy.api#documentation": "<p>The URL that the recipient of the verification email is sent to if his or her address\n is successfully verified.</p>",
"smithy.api#required": {}
}
},
"FailureRedirectionURL": {
"target": "com.amazonaws.sesv2#FailureRedirectionURL",
"traits": {
"smithy.api#documentation": "<p>The URL that the recipient of the verification email is sent to if his or her address\n is not successfully verified.</p>",
"smithy.api#required": {}
}
}
},
"traits": {
"smithy.api#documentation": "<p>Represents a request to update an existing custom verification email template.</p>"
}
},
"com.amazonaws.sesv2#UpdateCustomVerificationEmailTemplateResponse": {
"type": "structure",
"members": {},
"traits": {
"smithy.api#documentation": "<p>If the action is successful, the service sends back an HTTP 200 response with an empty\n HTTP body.</p>"
}
},
"com.amazonaws.sesv2#UpdateEmailIdentityPolicy": {
"type": "operation",
"input": {
"target": "com.amazonaws.sesv2#UpdateEmailIdentityPolicyRequest"
},
"output": {
"target": "com.amazonaws.sesv2#UpdateEmailIdentityPolicyResponse"
},
"errors": [
{
"target": "com.amazonaws.sesv2#BadRequestException"
},
{
"target": "com.amazonaws.sesv2#NotFoundException"
},
{
"target": "com.amazonaws.sesv2#TooManyRequestsException"
}
],
"traits": {
"smithy.api#documentation": "<p>Updates the specified sending authorization policy for the given identity (an email\n address or a domain). This API returns successfully even if a policy with the specified\n name does not exist.</p>\n <note>\n <p>This API is for the identity owner only. If you have not verified the identity,\n this API will return an error.</p>\n </note>\n <p>Sending authorization is a feature that enables an identity owner to authorize other\n senders to use its identities. For information about using sending authorization, see\n the <a href=\"https://docs.aws.amazon.com/ses/latest/DeveloperGuide/sending-authorization.html\">Amazon SES Developer\n Guide</a>.</p>\n\n <p>You can execute this operation no more than once per second.</p>",
"smithy.api#http": {
"method": "PUT",
"uri": "/v2/email/identities/{EmailIdentity}/policies/{PolicyName}",
"code": 200
}
}
},
"com.amazonaws.sesv2#UpdateEmailIdentityPolicyRequest": {
"type": "structure",
"members": {
"EmailIdentity": {
"target": "com.amazonaws.sesv2#Identity",
"traits": {
"smithy.api#documentation": "<p>The email identity for which you want to update policy.</p>",
"smithy.api#httpLabel": {},
"smithy.api#required": {}
}
},
"PolicyName": {
"target": "com.amazonaws.sesv2#PolicyName",
"traits": {
"smithy.api#documentation": "<p>The name of the policy.</p>\n\n <p>The policy name cannot exceed 64 characters and can only include alphanumeric\n characters, dashes, and underscores.</p>",
"smithy.api#httpLabel": {},
"smithy.api#required": {}
}
},
"Policy": {
"target": "com.amazonaws.sesv2#Policy",
"traits": {
"smithy.api#documentation": "<p>The text of the policy in JSON format. The policy cannot exceed 4 KB.</p>\n <p> For information about the syntax of sending authorization policies, see the <a href=\"https://docs.aws.amazon.com/ses/latest/DeveloperGuide/sending-authorization-policies.html\">Amazon SES Developer\n Guide</a>.</p>",
"smithy.api#required": {}
}
}
},
"traits": {
"smithy.api#documentation": "<p>Represents a request to update a sending authorization policy for an identity. Sending\n authorization is an Amazon SES feature that enables you to authorize other senders to use\n your identities. For information, see the <a href=\"https://docs.aws.amazon.com/ses/latest/DeveloperGuide/sending-authorization-identity-owner-tasks-management.html\">Amazon SES Developer Guide</a>.</p>"
}
},
"com.amazonaws.sesv2#UpdateEmailIdentityPolicyResponse": {
"type": "structure",
"members": {},
"traits": {
"smithy.api#documentation": "<p>An HTTP 200 response if the request succeeds, or an error message if the request\n fails.</p>"
}
},
"com.amazonaws.sesv2#UpdateEmailTemplate": {
"type": "operation",
"input": {
"target": "com.amazonaws.sesv2#UpdateEmailTemplateRequest"
},
"output": {
"target": "com.amazonaws.sesv2#UpdateEmailTemplateResponse"
},
"errors": [
{
"target": "com.amazonaws.sesv2#BadRequestException"
},
{
"target": "com.amazonaws.sesv2#NotFoundException"
},
{
"target": "com.amazonaws.sesv2#TooManyRequestsException"
}
],
"traits": {
"smithy.api#documentation": "<p>Updates an email template. Email templates enable you to send personalized email to\n one or more destinations in a single API operation. For more information, see the <a href=\"https://docs.aws.amazon.com/ses/latest/DeveloperGuide/send-personalized-email-api.html\">Amazon SES\n Developer Guide</a>.</p>\n <p>You can execute this operation no more than once per second.</p>",
"smithy.api#http": {
"method": "PUT",
"uri": "/v2/email/templates/{TemplateName}",
"code": 200
}
}
},
"com.amazonaws.sesv2#UpdateEmailTemplateRequest": {
"type": "structure",
"members": {
"TemplateName": {
"target": "com.amazonaws.sesv2#EmailTemplateName",
"traits": {
"smithy.api#documentation": "<p>The name of the template you want to update.</p>",
"smithy.api#httpLabel": {},
"smithy.api#required": {}
}
},
"TemplateContent": {
"target": "com.amazonaws.sesv2#EmailTemplateContent",
"traits": {
"smithy.api#documentation": "<p>The content of the email template, composed of a subject line, an HTML part, and a\n text-only part.</p>",
"smithy.api#required": {}
}
}
},
"traits": {
"smithy.api#documentation": "<p>Represents a request to update 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\n Developer Guide</a>.</p>"
}
},
"com.amazonaws.sesv2#UpdateEmailTemplateResponse": {
"type": "structure",
"members": {},
"traits": {
"smithy.api#documentation": "<p>If the action is successful, the service sends back an HTTP 200 response with an empty\n HTTP body.</p>"
}
},
"com.amazonaws.sesv2#UseCaseDescription": {
"type": "string",
"traits": {
"smithy.api#length": {
"min": 1,
"max": 5000
},
"smithy.api#sensitive": {}
}
},
"com.amazonaws.sesv2#UseDefaultIfPreferenceUnavailable": {
"type": "boolean"
},
"com.amazonaws.sesv2#Volume": {
"type": "long",
"traits": {
"smithy.api#box": {},
"smithy.api#documentation": "<p>An object that contains information about inbox placement volume.</p>"
}
},
"com.amazonaws.sesv2#VolumeStatistics": {
"type": "structure",
"members": {
"InboxRawCount": {
"target": "com.amazonaws.sesv2#Volume",
"traits": {
"smithy.api#documentation": "<p>The total number of emails that arrived in recipients' inboxes.</p>"
}
},
"SpamRawCount": {
"target": "com.amazonaws.sesv2#Volume",
"traits": {
"smithy.api#documentation": "<p>The total number of emails that arrived in recipients' spam or junk mail\n folders.</p>"
}
},
"ProjectedInbox": {
"target": "com.amazonaws.sesv2#Volume",
"traits": {
"smithy.api#documentation": "<p>An estimate of the percentage of emails sent from the current domain that will arrive\n in recipients' inboxes.</p>"
}
},
"ProjectedSpam": {
"target": "com.amazonaws.sesv2#Volume",
"traits": {
"smithy.api#documentation": "<p>An estimate of the percentage of emails sent from the current domain that will arrive\n in recipients' spam or junk mail folders.</p>"
}
}
},
"traits": {
"smithy.api#documentation": "<p>An object that contains information about the amount of email that was delivered to\n recipients.</p>"
}
},
"com.amazonaws.sesv2#WarmupStatus": {
"type": "string",
"traits": {
"smithy.api#documentation": "<p>The warmup status of a dedicated IP.</p>",
"smithy.api#enum": [
{
"value": "IN_PROGRESS",
"name": "IN_PROGRESS"
},
{
"value": "DONE",
"name": "DONE"
}
]
}
},
"com.amazonaws.sesv2#WebsiteURL": {
"type": "string",
"traits": {
"smithy.api#length": {
"min": 1,
"max": 1000
},
"smithy.api#pattern": "^(([^:/?#]+):)?(//([^/?#]*))?([^?#]*)(\\?([^#]*))?(#(.*))?",
"smithy.api#sensitive": {}
}
}
}
}