aws_sdk_sesv2/types/
_bulk_email_entry_result.rs

1// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
2
3/// <p>The result of the <code>SendBulkEmail</code> operation of each specified <code>BulkEmailEntry</code>.</p>
4#[non_exhaustive]
5#[derive(::std::clone::Clone, ::std::cmp::PartialEq, ::std::fmt::Debug)]
6pub struct BulkEmailEntryResult {
7    /// <p>The status of a message sent using the <code>SendBulkTemplatedEmail</code> operation.</p>
8    /// <p>Possible values for this parameter include:</p>
9    /// <ul>
10    /// <li>
11    /// <p>SUCCESS: Amazon SES accepted the message, and will attempt to deliver it to the recipients.</p></li>
12    /// <li>
13    /// <p>MESSAGE_REJECTED: The message was rejected because it contained a virus.</p></li>
14    /// <li>
15    /// <p>MAIL_FROM_DOMAIN_NOT_VERIFIED: The sender's email address or domain was not verified.</p></li>
16    /// <li>
17    /// <p>CONFIGURATION_SET_DOES_NOT_EXIST: The configuration set you specified does not exist.</p></li>
18    /// <li>
19    /// <p>TEMPLATE_DOES_NOT_EXIST: The template you specified does not exist.</p></li>
20    /// <li>
21    /// <p>ACCOUNT_SUSPENDED: Your account has been shut down because of issues related to your email sending practices.</p></li>
22    /// <li>
23    /// <p>ACCOUNT_THROTTLED: The number of emails you can send has been reduced because your account has exceeded its allocated sending limit.</p></li>
24    /// <li>
25    /// <p>ACCOUNT_DAILY_QUOTA_EXCEEDED: You have reached or exceeded the maximum number of emails you can send from your account in a 24-hour period.</p></li>
26    /// <li>
27    /// <p>INVALID_SENDING_POOL_NAME: The configuration set you specified refers to an IP pool that does not exist.</p></li>
28    /// <li>
29    /// <p>ACCOUNT_SENDING_PAUSED: Email sending for the Amazon SES account was disabled using the <a href="https://docs.aws.amazon.com/ses/latest/APIReference/API_UpdateAccountSendingEnabled.html">UpdateAccountSendingEnabled</a> operation.</p></li>
30    /// <li>
31    /// <p>CONFIGURATION_SET_SENDING_PAUSED: Email sending for this configuration set was disabled using the <a href="https://docs.aws.amazon.com/ses/latest/APIReference/API_UpdateConfigurationSetSendingEnabled.html">UpdateConfigurationSetSendingEnabled</a> operation.</p></li>
32    /// <li>
33    /// <p>INVALID_PARAMETER_VALUE: One or more of the parameters you specified when calling this operation was invalid. See the error message for additional information.</p></li>
34    /// <li>
35    /// <p>TRANSIENT_FAILURE: Amazon SES was unable to process your request because of a temporary issue.</p></li>
36    /// <li>
37    /// <p>FAILED: Amazon SES was unable to process your request. See the error message for additional information.</p></li>
38    /// </ul>
39    pub status: ::std::option::Option<crate::types::BulkEmailStatus>,
40    /// <p>A description of an error that prevented a message being sent using the <code>SendBulkTemplatedEmail</code> operation.</p>
41    pub error: ::std::option::Option<::std::string::String>,
42    /// <p>The unique message identifier returned from the <code>SendBulkTemplatedEmail</code> operation.</p>
43    pub message_id: ::std::option::Option<::std::string::String>,
44}
45impl BulkEmailEntryResult {
46    /// <p>The status of a message sent using the <code>SendBulkTemplatedEmail</code> operation.</p>
47    /// <p>Possible values for this parameter include:</p>
48    /// <ul>
49    /// <li>
50    /// <p>SUCCESS: Amazon SES accepted the message, and will attempt to deliver it to the recipients.</p></li>
51    /// <li>
52    /// <p>MESSAGE_REJECTED: The message was rejected because it contained a virus.</p></li>
53    /// <li>
54    /// <p>MAIL_FROM_DOMAIN_NOT_VERIFIED: The sender's email address or domain was not verified.</p></li>
55    /// <li>
56    /// <p>CONFIGURATION_SET_DOES_NOT_EXIST: The configuration set you specified does not exist.</p></li>
57    /// <li>
58    /// <p>TEMPLATE_DOES_NOT_EXIST: The template you specified does not exist.</p></li>
59    /// <li>
60    /// <p>ACCOUNT_SUSPENDED: Your account has been shut down because of issues related to your email sending practices.</p></li>
61    /// <li>
62    /// <p>ACCOUNT_THROTTLED: The number of emails you can send has been reduced because your account has exceeded its allocated sending limit.</p></li>
63    /// <li>
64    /// <p>ACCOUNT_DAILY_QUOTA_EXCEEDED: You have reached or exceeded the maximum number of emails you can send from your account in a 24-hour period.</p></li>
65    /// <li>
66    /// <p>INVALID_SENDING_POOL_NAME: The configuration set you specified refers to an IP pool that does not exist.</p></li>
67    /// <li>
68    /// <p>ACCOUNT_SENDING_PAUSED: Email sending for the Amazon SES account was disabled using the <a href="https://docs.aws.amazon.com/ses/latest/APIReference/API_UpdateAccountSendingEnabled.html">UpdateAccountSendingEnabled</a> operation.</p></li>
69    /// <li>
70    /// <p>CONFIGURATION_SET_SENDING_PAUSED: Email sending for this configuration set was disabled using the <a href="https://docs.aws.amazon.com/ses/latest/APIReference/API_UpdateConfigurationSetSendingEnabled.html">UpdateConfigurationSetSendingEnabled</a> operation.</p></li>
71    /// <li>
72    /// <p>INVALID_PARAMETER_VALUE: One or more of the parameters you specified when calling this operation was invalid. See the error message for additional information.</p></li>
73    /// <li>
74    /// <p>TRANSIENT_FAILURE: Amazon SES was unable to process your request because of a temporary issue.</p></li>
75    /// <li>
76    /// <p>FAILED: Amazon SES was unable to process your request. See the error message for additional information.</p></li>
77    /// </ul>
78    pub fn status(&self) -> ::std::option::Option<&crate::types::BulkEmailStatus> {
79        self.status.as_ref()
80    }
81    /// <p>A description of an error that prevented a message being sent using the <code>SendBulkTemplatedEmail</code> operation.</p>
82    pub fn error(&self) -> ::std::option::Option<&str> {
83        self.error.as_deref()
84    }
85    /// <p>The unique message identifier returned from the <code>SendBulkTemplatedEmail</code> operation.</p>
86    pub fn message_id(&self) -> ::std::option::Option<&str> {
87        self.message_id.as_deref()
88    }
89}
90impl BulkEmailEntryResult {
91    /// Creates a new builder-style object to manufacture [`BulkEmailEntryResult`](crate::types::BulkEmailEntryResult).
92    pub fn builder() -> crate::types::builders::BulkEmailEntryResultBuilder {
93        crate::types::builders::BulkEmailEntryResultBuilder::default()
94    }
95}
96
97/// A builder for [`BulkEmailEntryResult`](crate::types::BulkEmailEntryResult).
98#[derive(::std::clone::Clone, ::std::cmp::PartialEq, ::std::default::Default, ::std::fmt::Debug)]
99#[non_exhaustive]
100pub struct BulkEmailEntryResultBuilder {
101    pub(crate) status: ::std::option::Option<crate::types::BulkEmailStatus>,
102    pub(crate) error: ::std::option::Option<::std::string::String>,
103    pub(crate) message_id: ::std::option::Option<::std::string::String>,
104}
105impl BulkEmailEntryResultBuilder {
106    /// <p>The status of a message sent using the <code>SendBulkTemplatedEmail</code> operation.</p>
107    /// <p>Possible values for this parameter include:</p>
108    /// <ul>
109    /// <li>
110    /// <p>SUCCESS: Amazon SES accepted the message, and will attempt to deliver it to the recipients.</p></li>
111    /// <li>
112    /// <p>MESSAGE_REJECTED: The message was rejected because it contained a virus.</p></li>
113    /// <li>
114    /// <p>MAIL_FROM_DOMAIN_NOT_VERIFIED: The sender's email address or domain was not verified.</p></li>
115    /// <li>
116    /// <p>CONFIGURATION_SET_DOES_NOT_EXIST: The configuration set you specified does not exist.</p></li>
117    /// <li>
118    /// <p>TEMPLATE_DOES_NOT_EXIST: The template you specified does not exist.</p></li>
119    /// <li>
120    /// <p>ACCOUNT_SUSPENDED: Your account has been shut down because of issues related to your email sending practices.</p></li>
121    /// <li>
122    /// <p>ACCOUNT_THROTTLED: The number of emails you can send has been reduced because your account has exceeded its allocated sending limit.</p></li>
123    /// <li>
124    /// <p>ACCOUNT_DAILY_QUOTA_EXCEEDED: You have reached or exceeded the maximum number of emails you can send from your account in a 24-hour period.</p></li>
125    /// <li>
126    /// <p>INVALID_SENDING_POOL_NAME: The configuration set you specified refers to an IP pool that does not exist.</p></li>
127    /// <li>
128    /// <p>ACCOUNT_SENDING_PAUSED: Email sending for the Amazon SES account was disabled using the <a href="https://docs.aws.amazon.com/ses/latest/APIReference/API_UpdateAccountSendingEnabled.html">UpdateAccountSendingEnabled</a> operation.</p></li>
129    /// <li>
130    /// <p>CONFIGURATION_SET_SENDING_PAUSED: Email sending for this configuration set was disabled using the <a href="https://docs.aws.amazon.com/ses/latest/APIReference/API_UpdateConfigurationSetSendingEnabled.html">UpdateConfigurationSetSendingEnabled</a> operation.</p></li>
131    /// <li>
132    /// <p>INVALID_PARAMETER_VALUE: One or more of the parameters you specified when calling this operation was invalid. See the error message for additional information.</p></li>
133    /// <li>
134    /// <p>TRANSIENT_FAILURE: Amazon SES was unable to process your request because of a temporary issue.</p></li>
135    /// <li>
136    /// <p>FAILED: Amazon SES was unable to process your request. See the error message for additional information.</p></li>
137    /// </ul>
138    pub fn status(mut self, input: crate::types::BulkEmailStatus) -> Self {
139        self.status = ::std::option::Option::Some(input);
140        self
141    }
142    /// <p>The status of a message sent using the <code>SendBulkTemplatedEmail</code> operation.</p>
143    /// <p>Possible values for this parameter include:</p>
144    /// <ul>
145    /// <li>
146    /// <p>SUCCESS: Amazon SES accepted the message, and will attempt to deliver it to the recipients.</p></li>
147    /// <li>
148    /// <p>MESSAGE_REJECTED: The message was rejected because it contained a virus.</p></li>
149    /// <li>
150    /// <p>MAIL_FROM_DOMAIN_NOT_VERIFIED: The sender's email address or domain was not verified.</p></li>
151    /// <li>
152    /// <p>CONFIGURATION_SET_DOES_NOT_EXIST: The configuration set you specified does not exist.</p></li>
153    /// <li>
154    /// <p>TEMPLATE_DOES_NOT_EXIST: The template you specified does not exist.</p></li>
155    /// <li>
156    /// <p>ACCOUNT_SUSPENDED: Your account has been shut down because of issues related to your email sending practices.</p></li>
157    /// <li>
158    /// <p>ACCOUNT_THROTTLED: The number of emails you can send has been reduced because your account has exceeded its allocated sending limit.</p></li>
159    /// <li>
160    /// <p>ACCOUNT_DAILY_QUOTA_EXCEEDED: You have reached or exceeded the maximum number of emails you can send from your account in a 24-hour period.</p></li>
161    /// <li>
162    /// <p>INVALID_SENDING_POOL_NAME: The configuration set you specified refers to an IP pool that does not exist.</p></li>
163    /// <li>
164    /// <p>ACCOUNT_SENDING_PAUSED: Email sending for the Amazon SES account was disabled using the <a href="https://docs.aws.amazon.com/ses/latest/APIReference/API_UpdateAccountSendingEnabled.html">UpdateAccountSendingEnabled</a> operation.</p></li>
165    /// <li>
166    /// <p>CONFIGURATION_SET_SENDING_PAUSED: Email sending for this configuration set was disabled using the <a href="https://docs.aws.amazon.com/ses/latest/APIReference/API_UpdateConfigurationSetSendingEnabled.html">UpdateConfigurationSetSendingEnabled</a> operation.</p></li>
167    /// <li>
168    /// <p>INVALID_PARAMETER_VALUE: One or more of the parameters you specified when calling this operation was invalid. See the error message for additional information.</p></li>
169    /// <li>
170    /// <p>TRANSIENT_FAILURE: Amazon SES was unable to process your request because of a temporary issue.</p></li>
171    /// <li>
172    /// <p>FAILED: Amazon SES was unable to process your request. See the error message for additional information.</p></li>
173    /// </ul>
174    pub fn set_status(mut self, input: ::std::option::Option<crate::types::BulkEmailStatus>) -> Self {
175        self.status = input;
176        self
177    }
178    /// <p>The status of a message sent using the <code>SendBulkTemplatedEmail</code> operation.</p>
179    /// <p>Possible values for this parameter include:</p>
180    /// <ul>
181    /// <li>
182    /// <p>SUCCESS: Amazon SES accepted the message, and will attempt to deliver it to the recipients.</p></li>
183    /// <li>
184    /// <p>MESSAGE_REJECTED: The message was rejected because it contained a virus.</p></li>
185    /// <li>
186    /// <p>MAIL_FROM_DOMAIN_NOT_VERIFIED: The sender's email address or domain was not verified.</p></li>
187    /// <li>
188    /// <p>CONFIGURATION_SET_DOES_NOT_EXIST: The configuration set you specified does not exist.</p></li>
189    /// <li>
190    /// <p>TEMPLATE_DOES_NOT_EXIST: The template you specified does not exist.</p></li>
191    /// <li>
192    /// <p>ACCOUNT_SUSPENDED: Your account has been shut down because of issues related to your email sending practices.</p></li>
193    /// <li>
194    /// <p>ACCOUNT_THROTTLED: The number of emails you can send has been reduced because your account has exceeded its allocated sending limit.</p></li>
195    /// <li>
196    /// <p>ACCOUNT_DAILY_QUOTA_EXCEEDED: You have reached or exceeded the maximum number of emails you can send from your account in a 24-hour period.</p></li>
197    /// <li>
198    /// <p>INVALID_SENDING_POOL_NAME: The configuration set you specified refers to an IP pool that does not exist.</p></li>
199    /// <li>
200    /// <p>ACCOUNT_SENDING_PAUSED: Email sending for the Amazon SES account was disabled using the <a href="https://docs.aws.amazon.com/ses/latest/APIReference/API_UpdateAccountSendingEnabled.html">UpdateAccountSendingEnabled</a> operation.</p></li>
201    /// <li>
202    /// <p>CONFIGURATION_SET_SENDING_PAUSED: Email sending for this configuration set was disabled using the <a href="https://docs.aws.amazon.com/ses/latest/APIReference/API_UpdateConfigurationSetSendingEnabled.html">UpdateConfigurationSetSendingEnabled</a> operation.</p></li>
203    /// <li>
204    /// <p>INVALID_PARAMETER_VALUE: One or more of the parameters you specified when calling this operation was invalid. See the error message for additional information.</p></li>
205    /// <li>
206    /// <p>TRANSIENT_FAILURE: Amazon SES was unable to process your request because of a temporary issue.</p></li>
207    /// <li>
208    /// <p>FAILED: Amazon SES was unable to process your request. See the error message for additional information.</p></li>
209    /// </ul>
210    pub fn get_status(&self) -> &::std::option::Option<crate::types::BulkEmailStatus> {
211        &self.status
212    }
213    /// <p>A description of an error that prevented a message being sent using the <code>SendBulkTemplatedEmail</code> operation.</p>
214    pub fn error(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
215        self.error = ::std::option::Option::Some(input.into());
216        self
217    }
218    /// <p>A description of an error that prevented a message being sent using the <code>SendBulkTemplatedEmail</code> operation.</p>
219    pub fn set_error(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
220        self.error = input;
221        self
222    }
223    /// <p>A description of an error that prevented a message being sent using the <code>SendBulkTemplatedEmail</code> operation.</p>
224    pub fn get_error(&self) -> &::std::option::Option<::std::string::String> {
225        &self.error
226    }
227    /// <p>The unique message identifier returned from the <code>SendBulkTemplatedEmail</code> operation.</p>
228    pub fn message_id(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
229        self.message_id = ::std::option::Option::Some(input.into());
230        self
231    }
232    /// <p>The unique message identifier returned from the <code>SendBulkTemplatedEmail</code> operation.</p>
233    pub fn set_message_id(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
234        self.message_id = input;
235        self
236    }
237    /// <p>The unique message identifier returned from the <code>SendBulkTemplatedEmail</code> operation.</p>
238    pub fn get_message_id(&self) -> &::std::option::Option<::std::string::String> {
239        &self.message_id
240    }
241    /// Consumes the builder and constructs a [`BulkEmailEntryResult`](crate::types::BulkEmailEntryResult).
242    pub fn build(self) -> crate::types::BulkEmailEntryResult {
243        crate::types::BulkEmailEntryResult {
244            status: self.status,
245            error: self.error,
246            message_id: self.message_id,
247        }
248    }
249}