diff --git a/clients/client-sesv2/src/commands/CreateDeliverabilityTestReportCommand.ts b/clients/client-sesv2/src/commands/CreateDeliverabilityTestReportCommand.ts index ee801fa682977..3abf6627e742e 100644 --- a/clients/client-sesv2/src/commands/CreateDeliverabilityTestReportCommand.ts +++ b/clients/client-sesv2/src/commands/CreateDeliverabilityTestReportCommand.ts @@ -65,6 +65,12 @@ export interface CreateDeliverabilityTestReportCommandOutput * Charset: "STRING_VALUE", * }, * }, + * Headers: [ // MessageHeaderList + * { // MessageHeader + * Name: "STRING_VALUE", // required + * Value: "STRING_VALUE", // required + * }, + * ], * }, * Raw: { // RawMessage * Data: "BLOB_VALUE", // required @@ -73,6 +79,12 @@ export interface CreateDeliverabilityTestReportCommandOutput * TemplateName: "STRING_VALUE", * TemplateArn: "STRING_VALUE", * TemplateData: "STRING_VALUE", + * Headers: [ + * { + * Name: "STRING_VALUE", // required + * Value: "STRING_VALUE", // required + * }, + * ], * }, * }, * Tags: [ // TagList diff --git a/clients/client-sesv2/src/commands/PutEmailIdentityFeedbackAttributesCommand.ts b/clients/client-sesv2/src/commands/PutEmailIdentityFeedbackAttributesCommand.ts index 645dea779b5f3..bbe87175f0d99 100644 --- a/clients/client-sesv2/src/commands/PutEmailIdentityFeedbackAttributesCommand.ts +++ b/clients/client-sesv2/src/commands/PutEmailIdentityFeedbackAttributesCommand.ts @@ -5,10 +5,8 @@ import { Command as $Command } from "@smithy/smithy-client"; import { MetadataBearer as __MetadataBearer } from "@smithy/types"; import { commonParams } from "../endpoint/EndpointParameters"; -import { - PutEmailIdentityFeedbackAttributesRequest, - PutEmailIdentityFeedbackAttributesResponse, -} from "../models/models_0"; +import { PutEmailIdentityFeedbackAttributesRequest } from "../models/models_0"; +import { PutEmailIdentityFeedbackAttributesResponse } from "../models/models_1"; import { de_PutEmailIdentityFeedbackAttributesCommand, se_PutEmailIdentityFeedbackAttributesCommand, diff --git a/clients/client-sesv2/src/commands/SendBulkEmailCommand.ts b/clients/client-sesv2/src/commands/SendBulkEmailCommand.ts index 73d7dffe59a52..381b5783f3f46 100644 --- a/clients/client-sesv2/src/commands/SendBulkEmailCommand.ts +++ b/clients/client-sesv2/src/commands/SendBulkEmailCommand.ts @@ -54,6 +54,12 @@ export interface SendBulkEmailCommandOutput extends SendBulkEmailResponse, __Met * TemplateName: "STRING_VALUE", * TemplateArn: "STRING_VALUE", * TemplateData: "STRING_VALUE", + * Headers: [ // MessageHeaderList + * { // MessageHeader + * Name: "STRING_VALUE", // required + * Value: "STRING_VALUE", // required + * }, + * ], * }, * }, * BulkEmailEntries: [ // BulkEmailEntryList // required diff --git a/clients/client-sesv2/src/commands/SendEmailCommand.ts b/clients/client-sesv2/src/commands/SendEmailCommand.ts index ef4ef406e2f7e..d946947138459 100644 --- a/clients/client-sesv2/src/commands/SendEmailCommand.ts +++ b/clients/client-sesv2/src/commands/SendEmailCommand.ts @@ -93,6 +93,12 @@ export interface SendEmailCommandOutput extends SendEmailResponse, __MetadataBea * Charset: "STRING_VALUE", * }, * }, + * Headers: [ // MessageHeaderList + * { // MessageHeader + * Name: "STRING_VALUE", // required + * Value: "STRING_VALUE", // required + * }, + * ], * }, * Raw: { // RawMessage * Data: "BLOB_VALUE", // required @@ -101,6 +107,12 @@ export interface SendEmailCommandOutput extends SendEmailResponse, __MetadataBea * TemplateName: "STRING_VALUE", * TemplateArn: "STRING_VALUE", * TemplateData: "STRING_VALUE", + * Headers: [ + * { + * Name: "STRING_VALUE", // required + * Value: "STRING_VALUE", // required + * }, + * ], * }, * }, * EmailTags: [ // MessageTagList diff --git a/clients/client-sesv2/src/commands/UpdateContactCommand.ts b/clients/client-sesv2/src/commands/UpdateContactCommand.ts index 4242ffb1429d2..4f33eabec67e2 100644 --- a/clients/client-sesv2/src/commands/UpdateContactCommand.ts +++ b/clients/client-sesv2/src/commands/UpdateContactCommand.ts @@ -28,9 +28,12 @@ export interface UpdateContactCommandOutput extends UpdateContactResponse, __Met /** * @public - *
Updates a contact's preferences for a list. It is not necessary to specify all - * existing topic preferences in the TopicPreferences object, just the ones that need - * updating.
+ *Updates a contact's preferences for a list.
+ *You must specify all existing topic preferences in the
+ * TopicPreferences
object, not just the ones that need updating;
+ * otherwise, all your existing preferences will be removed.
Contains the name and value of a message header that you add to an email.
+ */ +export interface MessageHeader { + /** + * @public + *The name of the message header. The message header name has to meet the following + * criteria:
+ *Can contain any printable ASCII character (33 - 126) except for colon (:).
+ *Can contain no more than 126 characters.
+ *The value of the message header. The message header value has to meet the following + * criteria:
+ *Can contain any printable ASCII character.
+ *Can contain no more than 870 characters.
+ *An object that defines the email template to use for an email message, and the values @@ -684,6 +720,12 @@ export interface Template { * The corresponding value defines the value to use for that variable.
*/ TemplateData?: string; + + /** + * @public + *The list of message headers that will be added to the email message.
+ */ + Headers?: MessageHeader[]; } /** @@ -1231,8 +1273,8 @@ export interface ContactListDestination { /** * @public - *>The type of action to perform on the addresses. The following are the - * possible values:
+ *>The type of action to perform on the addresses. The following are the possible + * values:
*PUT: add the addresses to the contact list. If the record already exists, it @@ -1999,8 +2041,8 @@ export interface RawMessage { *
Attachments must be in a file format that the Amazon SES supports.
*The raw data of the message needs to base64-encoded if you are accessing - * Amazon SES directly through the HTTPS interface. If you are accessing Amazon SES using an Amazon Web Services + *
The raw data of the message needs to base64-encoded if you are accessing Amazon SES + * directly through the HTTPS interface. If you are accessing Amazon SES using an Amazon Web Services * SDK, the SDK takes care of the base 64-encoding for you.
*The list of message headers that will be added to the email message.
+ */ + Headers?: MessageHeader[]; } /** @@ -2074,8 +2122,8 @@ export interface EmailContent { * *The raw data of the message needs to base64-encoded if you are accessing - * Amazon SES directly through the HTTPS interface. If you are accessing Amazon SES using an Amazon Web Services + *
The raw data of the message needs to base64-encoded if you are accessing Amazon SES + * directly through the HTTPS interface. If you are accessing Amazon SES using an Amazon Web Services * SDK, the SDK takes care of the base 64-encoding for you.
*An object containing additional settings for your VDM configuration as applicable to the Dashboard.
+ *An object containing additional settings for your VDM configuration as applicable to + * the Dashboard.
*/ export interface DashboardAttributes { /** * @public - *Specifies the status of your VDM engagement metrics collection. Can be one of the following:
+ *Specifies the status of your VDM engagement metrics collection. Can be one of the + * following:
*
- * ENABLED
– Amazon SES enables engagement metrics for your account.
ENABLED
– Amazon SES enables engagement metrics for your
+ * account.
*
- * DISABLED
– Amazon SES disables engagement metrics for your account.
DISABLED
– Amazon SES disables engagement metrics for your
+ * account.
* An object containing additional settings for your VDM configuration as applicable to the Guardian.
+ *An object containing additional settings for your VDM configuration as applicable to + * the Guardian.
*/ export interface GuardianAttributes { /** * @public - *Specifies the status of your VDM optimized shared delivery. Can be one of the following:
+ *Specifies the status of your VDM optimized shared delivery. Can be one of the + * following:
*
- * ENABLED
– Amazon SES enables optimized shared delivery for your account.
ENABLED
– Amazon SES enables optimized shared delivery for your
+ * account.
*
- * DISABLED
– Amazon SES disables optimized shared delivery for your account.
DISABLED
– Amazon SES disables optimized shared delivery for
+ * your account.
* Specifies additional settings for your VDM configuration as applicable to the Dashboard.
+ *Specifies additional settings for your VDM configuration as applicable to the + * Dashboard.
*/ DashboardAttributes?: DashboardAttributes; /** * @public - *Specifies additional settings for your VDM configuration as applicable to the Guardian.
+ *Specifies additional settings for your VDM configuration as applicable to the + * Guardian.
*/ GuardianAttributes?: GuardianAttributes; } @@ -4277,9 +4335,8 @@ export interface GetAccountResponse { * Region. *If the value is false
, then your account is in the
* sandbox. When your account is in the sandbox, you can only send
- * email to verified identities. Additionally, the maximum number of emails you can send in
- * a 24-hour period (your sending quota) is 200, and the maximum number of emails you can
- * send per second (your maximum sending rate) is 1.
If the value is true
, then your account has production access. When your
* account has production access, you can send email to any address. The sending quota and
* maximum sending rate for your account vary based on your specific use case.
The number of contacts that may be returned at once, which is dependent on if there
- * are more or less contacts than the value of the PageSize. Use this parameter to
- * paginate results. If additional contacts exist beyond the specified limit, the
+ * are more or less contacts than the value of the PageSize. Use this parameter to paginate
+ * results. If additional contacts exist beyond the specified limit, the
* NextToken
element is sent in the response. Use the
* NextToken
value in subsequent requests to retrieve additional
* contacts.
If the value is false
, then your account is in the
* sandbox. When your account is in the sandbox, you can only send
- * email to verified identities. Additionally, the maximum number of emails you can send in
- * a 24-hour period (your sending quota) is 200, and the maximum number of emails you can
- * send per second (your maximum sending rate) is 1.
If the value is true
, then your account has production access. When your
* account has production access, you can send email to any address. The sending quota and
* maximum sending rate for your account vary based on your specific use case.
An HTTP 200 response if the request succeeds, or an error message if the request - * fails.
- */ -export interface PutEmailIdentityFeedbackAttributesResponse {} - /** * @internal */ diff --git a/clients/client-sesv2/src/models/models_1.ts b/clients/client-sesv2/src/models/models_1.ts index 4f8778445af61..97c78ad0d136a 100644 --- a/clients/client-sesv2/src/models/models_1.ts +++ b/clients/client-sesv2/src/models/models_1.ts @@ -16,6 +16,13 @@ import { TopicPreference, } from "./models_0"; +/** + * @public + *An HTTP 200 response if the request succeeds, or an error message if the request + * fails.
+ */ +export interface PutEmailIdentityFeedbackAttributesResponse {} + /** * @public *A request to configure the custom MAIL FROM domain for a verified identity.
@@ -104,8 +111,8 @@ export interface PutSuppressedDestinationResponse {} export interface SendBulkEmailRequest { /** * @public - *The email address to use as the "From" address for the email. The - * address that you specify has to be verified.
+ *The email address to use as the "From" address for the email. The address that you + * specify has to be verified.
*/ FromEmailAddress?: string; @@ -244,8 +251,8 @@ export interface SendCustomVerificationEmailResponse { export interface SendEmailRequest { /** * @public - *The email address to use as the "From" address for the email. The - * address that you specify has to be verified. + *
The email address to use as the "From" address for the email. The address that you + * specify has to be verified. *
*/ FromEmailAddress?: string; @@ -307,8 +314,8 @@ export interface SendEmailRequest { /** * @public - *An object that contains the body of the message. You can send either a Simple message - * Raw message or a template Message.
+ *An object that contains the body of the message. You can send either a Simple message, + * Raw message, or a Templated message.
*/ Content: EmailContent | undefined; @@ -344,10 +351,10 @@ export interface SendEmailResponse { *A unique identifier for the message that is generated when the message is * accepted.
*It's possible for Amazon SES to accept a message without sending it. This can happen - * when the message that you're trying to send has an attachment contains a virus, or - * when you send a templated email that contains invalid personalization content, for - * example.
+ *It's possible for Amazon SES to accept a message without sending it. For example, this + * can happen when the message that you're trying to send has an attachment that + * contains a virus, or when you send a templated email that contains invalid + * personalization content.
*>The type of action to perform on the addresses. The following are the \n possible values:
\nPUT: add the addresses to the contact list. If the record already exists, it\n will override it with the new value.
\nDELETE: remove the addresses from the contact list.
\n>The type of action to perform on the addresses. The following are the possible\n values:
\nPUT: add the addresses to the contact list. If the record already exists, it\n will override it with the new value.
\nDELETE: remove the addresses from the contact list.
\nSpecifies the status of your VDM engagement metrics collection. Can be one of the following:
\n\n ENABLED
– Amazon SES enables engagement metrics for your account.
\n DISABLED
– Amazon SES disables engagement metrics for your account.
Specifies the status of your VDM engagement metrics collection. Can be one of the\n following:
\n\n ENABLED
– Amazon SES enables engagement metrics for your\n account.
\n DISABLED
– Amazon SES disables engagement metrics for your\n account.
An object containing additional settings for your VDM configuration as applicable to the Dashboard.
" + "smithy.api#documentation": "An object containing additional settings for your VDM configuration as applicable to\n the Dashboard.
" } }, "com.amazonaws.sesv2#DashboardOptions": { @@ -3276,7 +3276,7 @@ "Raw": { "target": "com.amazonaws.sesv2#RawMessage", "traits": { - "smithy.api#documentation": "The raw email message. The message has to meet the following criteria:
\nThe message has to contain a header and a body, separated by one blank\n line.
\nAll of the required header fields must be present in the message.
\nEach part of a multipart MIME message must be formatted properly.
\nIf you include attachments, they must be in a file format that the Amazon SES API v2\n supports.\n
\nThe raw data of the message needs to base64-encoded if you are accessing\n Amazon SES directly through the HTTPS interface. If you are accessing Amazon SES using an Amazon Web Services\n SDK, the SDK takes care of the base 64-encoding for you.
\nIf 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.
\nThe length of any single line of text in the message can't exceed 1,000\n characters. This restriction is defined in RFC 5321.
\nThe raw email message. The message has to meet the following criteria:
\nThe message has to contain a header and a body, separated by one blank\n line.
\nAll of the required header fields must be present in the message.
\nEach part of a multipart MIME message must be formatted properly.
\nIf you include attachments, they must be in a file format that the Amazon SES API v2\n supports.\n
\nThe raw data of the message needs to base64-encoded if you are accessing Amazon SES\n directly through the HTTPS interface. If you are accessing Amazon SES using an Amazon Web Services\n SDK, the SDK takes care of the base 64-encoding for you.
\nIf 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.
\nThe length of any single line of text in the message can't exceed 1,000\n characters. This restriction is defined in RFC 5321.
\nIndicates whether or not your account has production access in the current Amazon Web Services\n Region.
\nIf the value is false
, then your account is in the\n sandbox. 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.
If the value is true
, 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.
Indicates whether or not your account has production access in the current Amazon Web Services\n Region.
\nIf the value is false
, then your account is in the\n sandbox. When your account is in the sandbox, you can only send\n email to verified identities.\n
If the value is true
, 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.
Specifies the status of your VDM optimized shared delivery. Can be one of the following:
\n\n ENABLED
– Amazon SES enables optimized shared delivery for your account.
\n DISABLED
– Amazon SES disables optimized shared delivery for your account.
Specifies the status of your VDM optimized shared delivery. Can be one of the\n following:
\n\n ENABLED
– Amazon SES enables optimized shared delivery for your\n account.
\n DISABLED
– Amazon SES disables optimized shared delivery for\n your account.
An object containing additional settings for your VDM configuration as applicable to the Guardian.
" + "smithy.api#documentation": "An object containing additional settings for your VDM configuration as applicable to\n the Guardian.
" } }, "com.amazonaws.sesv2#GuardianOptions": { @@ -6327,7 +6327,7 @@ "PageSize": { "target": "com.amazonaws.sesv2#MaxItems", "traits": { - "smithy.api#documentation": "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 NextToken
element is sent in the response. Use the\n NextToken
value in subsequent requests to retrieve additional\n contacts.
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 paginate\n results. If additional contacts exist beyond the specified limit, the\n NextToken
element is sent in the response. Use the\n NextToken
value in subsequent requests to retrieve additional\n contacts.
The body of the message. You can specify an HTML version of the message, a text-only\n version of the message, or both.
", "smithy.api#required": {} } + }, + "Headers": { + "target": "com.amazonaws.sesv2#MessageHeaderList", + "traits": { + "smithy.api#documentation": "The list of message headers that will be added to the email message.
" + } } }, "traits": { @@ -7483,6 +7489,63 @@ "com.amazonaws.sesv2#MessageData": { "type": "string" }, + "com.amazonaws.sesv2#MessageHeader": { + "type": "structure", + "members": { + "Name": { + "target": "com.amazonaws.sesv2#MessageHeaderName", + "traits": { + "smithy.api#documentation": "The name of the message header. The message header name has to meet the following\n criteria:
\nCan contain any printable ASCII character (33 - 126) except for colon (:).
\nCan contain no more than 126 characters.
\nThe value of the message header. The message header value has to meet the following\n criteria:
\nCan contain any printable ASCII character.
\nCan contain no more than 870 characters.
\nContains the name and value of a message header that you add to an email.
" + } + }, + "com.amazonaws.sesv2#MessageHeaderList": { + "type": "list", + "member": { + "target": "com.amazonaws.sesv2#MessageHeader" + }, + "traits": { + "smithy.api#documentation": "A list of message headers. The list of message headers has to meet the following\n criteria:
\nCan contain no more than 15 headers in one message.
\nThe name of the message header. The message header name has to meet the following\n criteria:
\nCan contain any printable ASCII character (33 - 126) except for colon (:).
\nCan contain no more than 126 characters.
\nThe value of the message header. The message header value has to meet the following\n criteria:
\nCan contain any printable ASCII character.
\nIndicates whether or not your account should have production access in the current\n Amazon Web Services Region.
\nIf the value is false
, then your account is in the\n sandbox. 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.
If the value is true
, 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.
Indicates whether or not your account should have production access in the current\n Amazon Web Services Region.
\nIf the value is false
, then your account is in the\n sandbox. When your account is in the sandbox, you can only send\n email to verified identities.\n
If the value is true
, 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.
The raw email message. The message has to meet the following criteria:
\nThe message has to contain a header and a body, separated by one blank\n line.
\nAll of the required header fields must be present in the message.
\nEach part of a multipart MIME message must be formatted properly.
\nAttachments must be in a file format that the Amazon SES supports.
\nThe raw data of the message needs to base64-encoded if you are accessing\n Amazon SES directly through the HTTPS interface. If you are accessing Amazon SES using an Amazon Web Services\n SDK, the SDK takes care of the base 64-encoding for you.
\nIf 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.
\nThe length of any single line of text in the message can't exceed 1,000\n characters. This restriction is defined in RFC 5321.
\nThe raw email message. The message has to meet the following criteria:
\nThe message has to contain a header and a body, separated by one blank\n line.
\nAll of the required header fields must be present in the message.
\nEach part of a multipart MIME message must be formatted properly.
\nAttachments must be in a file format that the Amazon SES supports.
\nThe raw data of the message needs to base64-encoded if you are accessing Amazon SES\n directly through the HTTPS interface. If you are accessing Amazon SES using an Amazon Web Services\n SDK, the SDK takes care of the base 64-encoding for you.
\nIf 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.
\nThe length of any single line of text in the message can't exceed 1,000\n characters. This restriction is defined in RFC 5321.
\nThe email address to use as the \"From\" address for the email. The\n address that you specify has to be verified.
" + "smithy.api#documentation": "The email address to use as the \"From\" address for the email. The address that you\n specify has to be verified.
" } }, "FromEmailAddressIdentityArn": { @@ -9927,7 +9990,7 @@ "FromEmailAddress": { "target": "com.amazonaws.sesv2#EmailAddress", "traits": { - "smithy.api#documentation": "The email address to use as the \"From\" address for the email. The\n address that you specify has to be verified.\n
" + "smithy.api#documentation": "The email address to use as the \"From\" address for the email. The address that you\n specify has to be verified.\n
" } }, "FromEmailAddressIdentityArn": { @@ -9963,7 +10026,7 @@ "Content": { "target": "com.amazonaws.sesv2#EmailContent", "traits": { - "smithy.api#documentation": "An object that contains the body of the message. You can send either a Simple message\n Raw message or a template Message.
", + "smithy.api#documentation": "An object that contains the body of the message. You can send either a Simple message,\n Raw message, or a Templated message.
", "smithy.api#required": {} } }, @@ -9997,7 +10060,7 @@ "MessageId": { "target": "com.amazonaws.sesv2#OutboundMessageId", "traits": { - "smithy.api#documentation": "A unique identifier for the message that is generated when the message is\n accepted.
\nIt'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.
\nA unique identifier for the message that is generated when the message is\n accepted.
\nIt's possible for Amazon SES to accept a message without sending it. For example, this\n can happen when the message that you're trying to send has an attachment that\n contains a virus, or when you send a templated email that contains invalid\n personalization content.
\nAn 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.
" } + }, + "Headers": { + "target": "com.amazonaws.sesv2#MessageHeaderList", + "traits": { + "smithy.api#documentation": "The list of message headers that will be added to the email message.
" + } } }, "traits": { @@ -12021,7 +12090,7 @@ } ], "traits": { - "smithy.api#documentation": "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.
", + "smithy.api#documentation": "Updates a contact's preferences for a list.
\nYou must specify all existing topic preferences in the\n TopicPreferences
object, not just the ones that need updating;\n otherwise, all your existing preferences will be removed.
Specifies additional settings for your VDM configuration as applicable to the Dashboard.
" + "smithy.api#documentation": "Specifies additional settings for your VDM configuration as applicable to the\n Dashboard.
" } }, "GuardianAttributes": { "target": "com.amazonaws.sesv2#GuardianAttributes", "traits": { - "smithy.api#documentation": "Specifies additional settings for your VDM configuration as applicable to the Guardian.
" + "smithy.api#documentation": "Specifies additional settings for your VDM configuration as applicable to the\n Guardian.
" } } },