Struct aws_sdk_sesv2::Client

pub struct Client { /* private fields */ }

Client for Amazon Simple Email Service

Client for invoking operations on Amazon Simple Email Service. Each operation on Amazon Simple Email Service is a method on this this struct. .send() MUST be invoked on the generated operations to dispatch the request to the service.

Constructing a Client

A Config is required to construct a client. For most use cases, the aws-config crate should be used to automatically resolve this config using aws_config::load_from_env(), since this will resolve an SdkConfig which can be shared across multiple different AWS SDK clients. This config resolution process can be customized by calling aws_config::from_env() instead, which returns a ConfigLoader that uses the builder pattern to customize the default config.

In the simplest case, creating a client looks as follows:

let config = aws_config::load_from_env().await;
let client = aws_sdk_sesv2::Client::new(&config);

Occasionally, SDKs may have additional service-specific that can be set on the Config that is absent from SdkConfig, or slightly different settings for a specific client may be desired. The Config struct implements From<&SdkConfig>, so setting these specific settings can be done as follows:

let sdk_config = ::aws_config::load_from_env().await;
let config = aws_sdk_sesv2::config::Builder::from(&sdk_config)
    .some_service_specific_setting("value")
    .build();

See the aws-config docs and Config for more information on customizing configuration.

Note: Client construction is expensive due to connection thread pool initialization, and should be done once at application start-up.

Using the Client

A client has a function for every operation that can be performed by the service. For example, the CancelExportJob operation has a Client::cancel_export_job, function which returns a builder for that operation. The fluent builder ultimately has a send() function that returns an async future that returns a result, as illustrated below:

let result = client.cancel_export_job()
    .job_id("example")
    .send()
    .await;

The underlying HTTP requests that get made by this can be modified with the customize_operation function on the fluent builder. See the customize module for more information.

Implementations

impl Client

pub fn batch_get_metric_data(&self) -> BatchGetMetricDataFluentBuilder

Constructs a fluent builder for the BatchGetMetricData operation.

• The fluent builder is configurable:
  • queries(BatchGetMetricDataQuery) / set_queries(Option<Vec::<BatchGetMetricDataQuery>>):
    required: true
    

    A list of queries for metrics to be retrieved.

    
    
• On success, responds with BatchGetMetricDataOutput with field(s):
  • results(Option<Vec::<MetricDataResult>>):

    A list of successfully retrieved MetricDataResult.

  • errors(Option<Vec::<MetricDataError>>):

    A list of MetricDataError encountered while processing your metric data batch request.

• On failure, responds with SdkError<BatchGetMetricDataError>

impl Client

pub fn cancel_export_job(&self) -> CancelExportJobFluentBuilder

Constructs a fluent builder for the CancelExportJob operation.

• The fluent builder is configurable:
  • job_id(impl Into<String>) / set_job_id(Option<String>):
    required: true
    

    The export job ID.

    
    
• On success, responds with CancelExportJobOutput
• On failure, responds with SdkError<CancelExportJobError>

impl Client

pub fn create_configuration_set(&self) -> CreateConfigurationSetFluentBuilder

Constructs a fluent builder for the CreateConfigurationSet operation.

• The fluent builder is configurable:
  • configuration_set_name(impl Into<String>) / set_configuration_set_name(Option<String>):
    required: true
    

    The name of the configuration set. The name can contain up to 64 alphanumeric characters, including letters, numbers, hyphens (-) and underscores (_) only.

    
    
  • tracking_options(TrackingOptions) / set_tracking_options(Option<TrackingOptions>):
    required: false
    

    An object that defines the open and click tracking options for emails that you send using the configuration set.

    
    
  • delivery_options(DeliveryOptions) / set_delivery_options(Option<DeliveryOptions>):
    required: false
    

    An object that defines the dedicated IP pool that is used to send emails that you send using the configuration set.

    
    
  • reputation_options(ReputationOptions) / set_reputation_options(Option<ReputationOptions>):
    required: false
    

    An object that defines whether or not Amazon SES collects reputation metrics for the emails that you send that use the configuration set.

    
    
  • sending_options(SendingOptions) / set_sending_options(Option<SendingOptions>):
    required: false
    

    An object that defines whether or not Amazon SES can send email that you send using the configuration set.

    
    
  • tags(Tag) / set_tags(Option<Vec::<Tag>>):
    required: false
    

    An array of objects that define the tags (keys and values) to associate with the configuration set.

    
    
  • suppression_options(SuppressionOptions) / set_suppression_options(Option<SuppressionOptions>):
    required: false
    

    An object that contains information about the suppression list preferences for your account.

    
    
  • vdm_options(VdmOptions) / set_vdm_options(Option<VdmOptions>):
    required: false
    

    An object that defines the VDM options for emails that you send using the configuration set.

    
    
• On success, responds with CreateConfigurationSetOutput
• On failure, responds with SdkError<CreateConfigurationSetError>

impl Client

pub fn create_configuration_set_event_destination( &self ) -> CreateConfigurationSetEventDestinationFluentBuilder

Constructs a fluent builder for the CreateConfigurationSetEventDestination operation.

• The fluent builder is configurable:
  • configuration_set_name(impl Into<String>) / set_configuration_set_name(Option<String>):
    required: true
    

    The name of the configuration set .

    
    
  • event_destination_name(impl Into<String>) / set_event_destination_name(Option<String>):
    required: true
    

    A name that identifies the event destination within the configuration set.

    
    
  • event_destination(EventDestinationDefinition) / set_event_destination(Option<EventDestinationDefinition>):
    required: true
    

    An object that defines the event destination.

    
    
• On success, responds with CreateConfigurationSetEventDestinationOutput
• On failure, responds with SdkError<CreateConfigurationSetEventDestinationError>

impl Client

pub fn create_contact(&self) -> CreateContactFluentBuilder

Constructs a fluent builder for the CreateContact operation.

• The fluent builder is configurable:
  • contact_list_name(impl Into<String>) / set_contact_list_name(Option<String>):
    required: true
    

    The name of the contact list to which the contact should be added.

    
    
  • email_address(impl Into<String>) / set_email_address(Option<String>):
    required: true
    

    The contact’s email address.

    
    
  • topic_preferences(TopicPreference) / set_topic_preferences(Option<Vec::<TopicPreference>>):
    required: false
    

    The contact’s preferences for being opted-in to or opted-out of topics.

    
    
  • unsubscribe_all(bool) / set_unsubscribe_all(Option<bool>):
    required: false
    

    A boolean value status noting if the contact is unsubscribed from all contact list topics.

    
    
  • attributes_data(impl Into<String>) / set_attributes_data(Option<String>):
    required: false
    

    The attribute data attached to a contact.

    
    
• On success, responds with CreateContactOutput
• On failure, responds with SdkError<CreateContactError>

impl Client

pub fn create_contact_list(&self) -> CreateContactListFluentBuilder

Constructs a fluent builder for the CreateContactList operation.

• The fluent builder is configurable:
  • contact_list_name(impl Into<String>) / set_contact_list_name(Option<String>):
    required: true
    

    The name of the contact list.

    
    
  • topics(Topic) / set_topics(Option<Vec::<Topic>>):
    required: false
    

    An interest group, theme, or label within a list. A contact list can have multiple topics.

    
    
  • description(impl Into<String>) / set_description(Option<String>):
    required: false
    

    A description of what the contact list is about.

    
    
  • tags(Tag) / set_tags(Option<Vec::<Tag>>):
    required: false
    

    The tags associated with a contact list.

    
    
• On success, responds with CreateContactListOutput
• On failure, responds with SdkError<CreateContactListError>

impl Client

pub fn create_custom_verification_email_template( &self ) -> CreateCustomVerificationEmailTemplateFluentBuilder

Constructs a fluent builder for the CreateCustomVerificationEmailTemplate operation.

• The fluent builder is configurable:
  • template_name(impl Into<String>) / set_template_name(Option<String>):
    required: true
    

    The name of the custom verification email template.

    
    
  • from_email_address(impl Into<String>) / set_from_email_address(Option<String>):
    required: true
    

    The email address that the custom verification email is sent from.

    
    
  • template_subject(impl Into<String>) / set_template_subject(Option<String>):
    required: true
    

    The subject line of the custom verification email.

    
    
  • template_content(impl Into<String>) / set_template_content(Option<String>):
    required: true
    

    The content of the custom verification email. The total size of the email must be less than 10 MB. The message body may contain HTML, with some limitations. For more information, see Custom verification email frequently asked questions in the Amazon SES Developer Guide.

    
    
  • success_redirection_url(impl Into<String>) / set_success_redirection_url(Option<String>):
    required: true
    

    The URL that the recipient of the verification email is sent to if his or her address is successfully verified.

    
    
  • failure_redirection_url(impl Into<String>) / set_failure_redirection_url(Option<String>):
    required: true
    

    The URL that the recipient of the verification email is sent to if his or her address is not successfully verified.

    
    
• On success, responds with CreateCustomVerificationEmailTemplateOutput
• On failure, responds with SdkError<CreateCustomVerificationEmailTemplateError>

impl Client

pub fn create_dedicated_ip_pool(&self) -> CreateDedicatedIpPoolFluentBuilder

Constructs a fluent builder for the CreateDedicatedIpPool operation.

• The fluent builder is configurable:
  • pool_name(impl Into<String>) / set_pool_name(Option<String>):
    required: true
    

    The name of the dedicated IP pool.

    
    
  • tags(Tag) / set_tags(Option<Vec::<Tag>>):
    required: false
    

    An object that defines the tags (keys and values) that you want to associate with the pool.

    
    
  • scaling_mode(ScalingMode) / set_scaling_mode(Option<ScalingMode>):
    required: false
    

    The type of scaling mode.

    
    
• On success, responds with CreateDedicatedIpPoolOutput
• On failure, responds with SdkError<CreateDedicatedIpPoolError>

impl Client

pub fn create_deliverability_test_report( &self ) -> CreateDeliverabilityTestReportFluentBuilder

Constructs a fluent builder for the CreateDeliverabilityTestReport operation.

• The fluent builder is configurable:
  • report_name(impl Into<String>) / set_report_name(Option<String>):
    required: false
    

    A unique name that helps you to identify the predictive inbox placement test when you retrieve the results.

    
    
  • from_email_address(impl Into<String>) / set_from_email_address(Option<String>):
    required: true
    

    The email address that the predictive inbox placement test email was sent from.

    
    
  • content(EmailContent) / set_content(Option<EmailContent>):
    required: true
    

    The HTML body of the message that you sent when you performed the predictive inbox placement test.

    
    
  • tags(Tag) / set_tags(Option<Vec::<Tag>>):
    required: false
    

    An array of objects that define the tags (keys and values) that you want to associate with the predictive inbox placement test.

    
    
• On success, responds with CreateDeliverabilityTestReportOutput with field(s):
  • report_id(String):

    A unique string that identifies the predictive inbox placement test.

  • deliverability_test_status(DeliverabilityTestStatus):

    The status of the predictive inbox placement test. If the status is IN_PROGRESS, then the predictive inbox placement test is currently running. Predictive inbox placement tests are usually complete within 24 hours of creating the test. If the status is COMPLETE, then the test is finished, and you can use the GetDeliverabilityTestReport to view the results of the test.

• On failure, responds with SdkError<CreateDeliverabilityTestReportError>

impl Client

pub fn create_email_identity(&self) -> CreateEmailIdentityFluentBuilder

Constructs a fluent builder for the CreateEmailIdentity operation.

• The fluent builder is configurable:
  • email_identity(impl Into<String>) / set_email_identity(Option<String>):
    required: true
    

    The email address or domain to verify.

    
    
  • tags(Tag) / set_tags(Option<Vec::<Tag>>):
    required: false
    

    An array of objects that define the tags (keys and values) to associate with the email identity.

    
    
  • dkim_signing_attributes(DkimSigningAttributes) / set_dkim_signing_attributes(Option<DkimSigningAttributes>):
    required: false
    

    If your request includes this object, Amazon SES configures the identity to use Bring Your Own DKIM (BYODKIM) for DKIM authentication purposes, or, configures the key length to be used for Easy DKIM.

    You can only specify this object if the email identity is a domain, as opposed to an address.

    
    
  • configuration_set_name(impl Into<String>) / set_configuration_set_name(Option<String>):
    required: false
    

    The configuration set to use by default when sending from this identity. Note that any configuration set defined in the email sending request takes precedence.

    
    
• On success, responds with CreateEmailIdentityOutput with field(s):
  • identity_type(Option<IdentityType>):

    The email identity type. Note: the MANAGED_DOMAIN identity type is not supported.

  • verified_for_sending_status(bool):

    Specifies whether or not the identity is verified. You can only send email from verified email addresses or domains. For more information about verifying identities, see the Amazon Pinpoint User Guide.

  • dkim_attributes(Option<DkimAttributes>):

    An object that contains information about the DKIM attributes for the identity.

• On failure, responds with SdkError<CreateEmailIdentityError>

impl Client

pub fn create_email_identity_policy( &self ) -> CreateEmailIdentityPolicyFluentBuilder

Constructs a fluent builder for the CreateEmailIdentityPolicy operation.

• The fluent builder is configurable:
  • email_identity(impl Into<String>) / set_email_identity(Option<String>):
    required: true
    

    The email identity.

    
    
  • policy_name(impl Into<String>) / set_policy_name(Option<String>):
    required: true
    

    The name of the policy.

    The policy name cannot exceed 64 characters and can only include alphanumeric characters, dashes, and underscores.

    
    
  • policy(impl Into<String>) / set_policy(Option<String>):
    required: true
    

    The text of the policy in JSON format. The policy cannot exceed 4 KB.

    For information about the syntax of sending authorization policies, see the Amazon SES Developer Guide.

    
    
• On success, responds with CreateEmailIdentityPolicyOutput
• On failure, responds with SdkError<CreateEmailIdentityPolicyError>

impl Client

pub fn create_email_template(&self) -> CreateEmailTemplateFluentBuilder

Constructs a fluent builder for the CreateEmailTemplate operation.

• The fluent builder is configurable:
  • template_name(impl Into<String>) / set_template_name(Option<String>):
    required: true
    

    The name of the template.

    
    
  • template_content(EmailTemplateContent) / set_template_content(Option<EmailTemplateContent>):
    required: true
    

    The content of the email template, composed of a subject line, an HTML part, and a text-only part.

    
    
• On success, responds with CreateEmailTemplateOutput
• On failure, responds with SdkError<CreateEmailTemplateError>

impl Client

pub fn create_export_job(&self) -> CreateExportJobFluentBuilder

Constructs a fluent builder for the CreateExportJob operation.

• The fluent builder is configurable:
  • export_data_source(ExportDataSource) / set_export_data_source(Option<ExportDataSource>):
    required: true
    

    The data source for the export job.

    
    
  • export_destination(ExportDestination) / set_export_destination(Option<ExportDestination>):
    required: true
    

    The destination for the export job.

    
    
• On success, responds with CreateExportJobOutput with field(s):
  • job_id(Option<String>):

    A string that represents the export job ID.

• On failure, responds with SdkError<CreateExportJobError>

impl Client

pub fn create_import_job(&self) -> CreateImportJobFluentBuilder

Constructs a fluent builder for the CreateImportJob operation.

• The fluent builder is configurable:
  • import_destination(ImportDestination) / set_import_destination(Option<ImportDestination>):
    required: true
    

    The destination for the import job.

    
    
  • import_data_source(ImportDataSource) / set_import_data_source(Option<ImportDataSource>):
    required: true
    

    The data source for the import job.

    
    
• On success, responds with CreateImportJobOutput with field(s):
  • job_id(Option<String>):

    A string that represents the import job ID.

• On failure, responds with SdkError<CreateImportJobError>

impl Client

pub fn delete_configuration_set(&self) -> DeleteConfigurationSetFluentBuilder

Constructs a fluent builder for the DeleteConfigurationSet operation.

• The fluent builder is configurable:
  • configuration_set_name(impl Into<String>) / set_configuration_set_name(Option<String>):
    required: true
    

    The name of the configuration set.

    
    
• On success, responds with DeleteConfigurationSetOutput
• On failure, responds with SdkError<DeleteConfigurationSetError>

impl Client

pub fn delete_configuration_set_event_destination( &self ) -> DeleteConfigurationSetEventDestinationFluentBuilder

Constructs a fluent builder for the DeleteConfigurationSetEventDestination operation.

• The fluent builder is configurable:
  • configuration_set_name(impl Into<String>) / set_configuration_set_name(Option<String>):
    required: true
    

    The name of the configuration set that contains the event destination to delete.

    
    
  • event_destination_name(impl Into<String>) / set_event_destination_name(Option<String>):
    required: true
    

    The name of the event destination to delete.

    
    
• On success, responds with DeleteConfigurationSetEventDestinationOutput
• On failure, responds with SdkError<DeleteConfigurationSetEventDestinationError>

impl Client

pub fn delete_contact(&self) -> DeleteContactFluentBuilder

Constructs a fluent builder for the DeleteContact operation.

• The fluent builder is configurable:
  • contact_list_name(impl Into<String>) / set_contact_list_name(Option<String>):
    required: true
    

    The name of the contact list from which the contact should be removed.

    
    
  • email_address(impl Into<String>) / set_email_address(Option<String>):
    required: true
    

    The contact’s email address.

    
    
• On success, responds with DeleteContactOutput
• On failure, responds with SdkError<DeleteContactError>

impl Client

pub fn delete_contact_list(&self) -> DeleteContactListFluentBuilder

Constructs a fluent builder for the DeleteContactList operation.

• The fluent builder is configurable:
  • contact_list_name(impl Into<String>) / set_contact_list_name(Option<String>):
    required: true
    

    The name of the contact list.

    
    
• On success, responds with DeleteContactListOutput
• On failure, responds with SdkError<DeleteContactListError>

impl Client

pub fn delete_custom_verification_email_template( &self ) -> DeleteCustomVerificationEmailTemplateFluentBuilder

Constructs a fluent builder for the DeleteCustomVerificationEmailTemplate operation.

• The fluent builder is configurable:
  • template_name(impl Into<String>) / set_template_name(Option<String>):
    required: true
    

    The name of the custom verification email template that you want to delete.

    
    
• On success, responds with DeleteCustomVerificationEmailTemplateOutput
• On failure, responds with SdkError<DeleteCustomVerificationEmailTemplateError>

impl Client

pub fn delete_dedicated_ip_pool(&self) -> DeleteDedicatedIpPoolFluentBuilder

Constructs a fluent builder for the DeleteDedicatedIpPool operation.

• The fluent builder is configurable:
  • pool_name(impl Into<String>) / set_pool_name(Option<String>):
    required: true
    

    The name of the dedicated IP pool that you want to delete.

    
    
• On success, responds with DeleteDedicatedIpPoolOutput
• On failure, responds with SdkError<DeleteDedicatedIpPoolError>

impl Client

pub fn delete_email_identity(&self) -> DeleteEmailIdentityFluentBuilder

Constructs a fluent builder for the DeleteEmailIdentity operation.

• The fluent builder is configurable:
  • email_identity(impl Into<String>) / set_email_identity(Option<String>):
    required: true
    

    The identity (that is, the email address or domain) to delete.

    
    
• On success, responds with DeleteEmailIdentityOutput
• On failure, responds with SdkError<DeleteEmailIdentityError>

impl Client

pub fn delete_email_identity_policy( &self ) -> DeleteEmailIdentityPolicyFluentBuilder

Constructs a fluent builder for the DeleteEmailIdentityPolicy operation.

• The fluent builder is configurable:
  • email_identity(impl Into<String>) / set_email_identity(Option<String>):
    required: true
    

    The email identity.

    
    
  • policy_name(impl Into<String>) / set_policy_name(Option<String>):
    required: true
    

    The name of the policy.

    The policy name cannot exceed 64 characters and can only include alphanumeric characters, dashes, and underscores.

    
    
• On success, responds with DeleteEmailIdentityPolicyOutput
• On failure, responds with SdkError<DeleteEmailIdentityPolicyError>

impl Client

pub fn delete_email_template(&self) -> DeleteEmailTemplateFluentBuilder

Constructs a fluent builder for the DeleteEmailTemplate operation.

• The fluent builder is configurable:
  • template_name(impl Into<String>) / set_template_name(Option<String>):
    required: true
    

    The name of the template to be deleted.

    
    
• On success, responds with DeleteEmailTemplateOutput
• On failure, responds with SdkError<DeleteEmailTemplateError>

impl Client

pub fn delete_suppressed_destination( &self ) -> DeleteSuppressedDestinationFluentBuilder

Constructs a fluent builder for the DeleteSuppressedDestination operation.

• The fluent builder is configurable:
  • email_address(impl Into<String>) / set_email_address(Option<String>):
    required: true
    

    The suppressed email destination to remove from the account suppression list.

    
    
• On success, responds with DeleteSuppressedDestinationOutput
• On failure, responds with SdkError<DeleteSuppressedDestinationError>

impl Client

pub fn get_account(&self) -> GetAccountFluentBuilder

Constructs a fluent builder for the GetAccount operation.

• The fluent builder takes no input, just send it.
• On success, responds with GetAccountOutput with field(s):
  • dedicated_ip_auto_warmup_enabled(bool):

    Indicates whether or not the automatic warm-up feature is enabled for dedicated IP addresses that are associated with your account.

  • enforcement_status(Option<String>):

    The reputation status of your Amazon SES account. The status can be one of the following:

    • HEALTHY – There are no reputation-related issues that currently impact your account.

    • PROBATION – We’ve identified potential issues with your Amazon SES account. We’re placing your account under review while you work on correcting these issues.

    • SHUTDOWN – Your account’s ability to send email is currently paused because of an issue with the email sent from your account. When you correct the issue, you can contact us and request that your account’s ability to send email is resumed.

  • production_access_enabled(bool):

    Indicates whether or not your account has production access in the current Amazon Web Services 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.

  • send_quota(Option<SendQuota>):

    An object that contains information about the per-day and per-second sending limits for your Amazon SES account in the current Amazon Web Services Region.

  • sending_enabled(bool):

    Indicates whether or not email sending is enabled for your Amazon SES account in the current Amazon Web Services Region.

  • suppression_attributes(Option<SuppressionAttributes>):

    An object that contains information about the email address suppression preferences for your account in the current Amazon Web Services Region.

  • details(Option<AccountDetails>):

    An object that defines your account details.

  • vdm_attributes(Option<VdmAttributes>):

    The VDM attributes that apply to your Amazon SES account.

• On failure, responds with SdkError<GetAccountError>

impl Client

pub fn get_blacklist_reports(&self) -> GetBlacklistReportsFluentBuilder

Constructs a fluent builder for the GetBlacklistReports operation.

• The fluent builder is configurable:
  • blacklist_item_names(impl Into<String>) / set_blacklist_item_names(Option<Vec::<String>>):
    required: true
    

    A list of IP addresses that you want to retrieve blacklist information about. You can only specify the dedicated IP addresses that you use to send email using Amazon SES or Amazon Pinpoint.

    
    
• On success, responds with GetBlacklistReportsOutput with field(s):
  • blacklist_report(HashMap::<String, Vec::<BlacklistEntry>>):

    An object that contains information about a blacklist that one of your dedicated IP addresses appears on.

• On failure, responds with SdkError<GetBlacklistReportsError>

impl Client

pub fn get_configuration_set(&self) -> GetConfigurationSetFluentBuilder

Constructs a fluent builder for the GetConfigurationSet operation.

• The fluent builder is configurable:
  • configuration_set_name(impl Into<String>) / set_configuration_set_name(Option<String>):
    required: true
    

    The name of the configuration set.

    
    
• On success, responds with GetConfigurationSetOutput with field(s):
  • configuration_set_name(Option<String>):

    The name of the configuration set.

  • tracking_options(Option<TrackingOptions>):

    An object that defines the open and click tracking options for emails that you send using the configuration set.

  • delivery_options(Option<DeliveryOptions>):

    An object that defines the dedicated IP pool that is used to send emails that you send using the configuration set.

  • reputation_options(Option<ReputationOptions>):

    An object that defines whether or not Amazon SES collects reputation metrics for the emails that you send that use the configuration set.

  • sending_options(Option<SendingOptions>):

    An object that defines whether or not Amazon SES can send email that you send using the configuration set.

  • tags(Option<Vec::<Tag>>):

    An array of objects that define the tags (keys and values) that are associated with the configuration set.

  • suppression_options(Option<SuppressionOptions>):

    An object that contains information about the suppression list preferences for your account.

  • vdm_options(Option<VdmOptions>):

    An object that contains information about the VDM preferences for your configuration set.

• On failure, responds with SdkError<GetConfigurationSetError>

impl Client

pub fn get_configuration_set_event_destinations( &self ) -> GetConfigurationSetEventDestinationsFluentBuilder

Constructs a fluent builder for the GetConfigurationSetEventDestinations operation.

• The fluent builder is configurable:
  • configuration_set_name(impl Into<String>) / set_configuration_set_name(Option<String>):
    required: true
    

    The name of the configuration set that contains the event destination.

    
    
• On success, responds with GetConfigurationSetEventDestinationsOutput with field(s):
  • event_destinations(Option<Vec::<EventDestination>>):

    An array that includes all of the events destinations that have been configured for the configuration set.

• On failure, responds with SdkError<GetConfigurationSetEventDestinationsError>

impl Client

pub fn get_contact(&self) -> GetContactFluentBuilder

Constructs a fluent builder for the GetContact operation.

• The fluent builder is configurable:
  • contact_list_name(impl Into<String>) / set_contact_list_name(Option<String>):
    required: true
    

    The name of the contact list to which the contact belongs.

    
    
  • email_address(impl Into<String>) / set_email_address(Option<String>):
    required: true
    

    The contact’s email address.

    
    
• On success, responds with GetContactOutput with field(s):
  • contact_list_name(Option<String>):

    The name of the contact list to which the contact belongs.

  • email_address(Option<String>):

    The contact’s email address.

  • topic_preferences(Option<Vec::<TopicPreference>>):

    The contact’s preference for being opted-in to or opted-out of a topic.>

  • topic_default_preferences(Option<Vec::<TopicPreference>>):

    The default topic preferences applied to the contact.

  • unsubscribe_all(bool):

    A boolean value status noting if the contact is unsubscribed from all contact list topics.

  • attributes_data(Option<String>):

    The attribute data attached to a contact.

  • created_timestamp(Option<DateTime>):

    A timestamp noting when the contact was created.

  • last_updated_timestamp(Option<DateTime>):

    A timestamp noting the last time the contact’s information was updated.

• On failure, responds with SdkError<GetContactError>

impl Client

pub fn get_contact_list(&self) -> GetContactListFluentBuilder

Constructs a fluent builder for the GetContactList operation.

• The fluent builder is configurable:
  • contact_list_name(impl Into<String>) / set_contact_list_name(Option<String>):
    required: true
    

    The name of the contact list.

    
    
• On success, responds with GetContactListOutput with field(s):
  • contact_list_name(Option<String>):

    The name of the contact list.

  • topics(Option<Vec::<Topic>>):

    An interest group, theme, or label within a list. A contact list can have multiple topics.

  • description(Option<String>):

    A description of what the contact list is about.

  • created_timestamp(Option<DateTime>):

    A timestamp noting when the contact list was created.

  • last_updated_timestamp(Option<DateTime>):

    A timestamp noting the last time the contact list was updated.

  • tags(Option<Vec::<Tag>>):

    The tags associated with a contact list.

• On failure, responds with SdkError<GetContactListError>

impl Client

pub fn get_custom_verification_email_template( &self ) -> GetCustomVerificationEmailTemplateFluentBuilder

Constructs a fluent builder for the GetCustomVerificationEmailTemplate operation.

• The fluent builder is configurable:
  • template_name(impl Into<String>) / set_template_name(Option<String>):
    required: true
    

    The name of the custom verification email template that you want to retrieve.

    
    
• On success, responds with GetCustomVerificationEmailTemplateOutput with field(s):
  • template_name(Option<String>):

    The name of the custom verification email template.

  • from_email_address(Option<String>):

    The email address that the custom verification email is sent from.

  • template_subject(Option<String>):

    The subject line of the custom verification email.

  • template_content(Option<String>):

    The content of the custom verification email.

  • success_redirection_url(Option<String>):

    The URL that the recipient of the verification email is sent to if his or her address is successfully verified.

  • failure_redirection_url(Option<String>):

    The URL that the recipient of the verification email is sent to if his or her address is not successfully verified.

• On failure, responds with SdkError<GetCustomVerificationEmailTemplateError>

impl Client

pub fn get_dedicated_ip(&self) -> GetDedicatedIpFluentBuilder

Constructs a fluent builder for the GetDedicatedIp operation.

• The fluent builder is configurable:
  • ip(impl Into<String>) / set_ip(Option<String>):
    required: true
    

    The IP address that you want to obtain more information about. The value you specify has to be a dedicated IP address that’s assocaited with your Amazon Web Services account.

    
    
• On success, responds with GetDedicatedIpOutput with field(s):
  • dedicated_ip(Option<DedicatedIp>):

    An object that contains information about a dedicated IP address.

• On failure, responds with SdkError<GetDedicatedIpError>

impl Client

pub fn get_dedicated_ip_pool(&self) -> GetDedicatedIpPoolFluentBuilder

Constructs a fluent builder for the GetDedicatedIpPool operation.

• The fluent builder is configurable:
  • pool_name(impl Into<String>) / set_pool_name(Option<String>):
    required: true
    

    The name of the dedicated IP pool to retrieve.

    
    
• On success, responds with GetDedicatedIpPoolOutput with field(s):
  • dedicated_ip_pool(Option<DedicatedIpPool>):

    An object that contains information about a dedicated IP pool.

• On failure, responds with SdkError<GetDedicatedIpPoolError>

impl Client

pub fn get_dedicated_ips(&self) -> GetDedicatedIpsFluentBuilder

Constructs a fluent builder for the GetDedicatedIps operation. This operation supports pagination; See into_paginator().

• The fluent builder is configurable:
  • pool_name(impl Into<String>) / set_pool_name(Option<String>):
    required: false
    

    The name of the IP pool that the dedicated IP address is associated with.

    
    
  • next_token(impl Into<String>) / set_next_token(Option<String>):
    required: false
    

    A token returned from a previous call to GetDedicatedIps to indicate the position of the dedicated IP pool in the list of IP pools.

    
    
  • page_size(i32) / set_page_size(Option<i32>):
    required: false
    

    The number of results to show in a single call to GetDedicatedIpsRequest. If the number of results is larger than the number you specified in this parameter, then the response includes a NextToken element, which you can use to obtain additional results.

    
    
• On success, responds with GetDedicatedIpsOutput with field(s):
  • dedicated_ips(Option<Vec::<DedicatedIp>>):

    A list of dedicated IP addresses that are associated with your Amazon Web Services account.

  • next_token(Option<String>):

    A token that indicates that there are additional dedicated IP addresses to list. To view additional addresses, issue another request to GetDedicatedIps, passing this token in the NextToken parameter.

• On failure, responds with SdkError<GetDedicatedIpsError>

impl Client

pub fn get_deliverability_dashboard_options( &self ) -> GetDeliverabilityDashboardOptionsFluentBuilder

Constructs a fluent builder for the GetDeliverabilityDashboardOptions operation.

• The fluent builder takes no input, just send it.
• On success, responds with GetDeliverabilityDashboardOptionsOutput with field(s):
  • dashboard_enabled(bool):

    Specifies whether the Deliverability dashboard is enabled. If this value is true, the dashboard is enabled.

  • subscription_expiry_date(Option<DateTime>):

    The date when your current subscription to the Deliverability dashboard is scheduled to expire, if your subscription is scheduled to expire at the end of the current calendar month. This value is null if you have an active subscription that isn’t due to expire at the end of the month.

  • account_status(Option<DeliverabilityDashboardAccountStatus>):

    The current status of your Deliverability dashboard subscription. If this value is PENDING_EXPIRATION, your subscription is scheduled to expire at the end of the current calendar month.

  • active_subscribed_domains(Option<Vec::<DomainDeliverabilityTrackingOption>>):

    An array of objects, one for each verified domain that you use to send email and currently has an active Deliverability dashboard subscription that isn’t scheduled to expire at the end of the current calendar month.

  • pending_expiration_subscribed_domains(Option<Vec::<DomainDeliverabilityTrackingOption>>):

    An array of objects, one for each verified domain that you use to send email and currently has an active Deliverability dashboard subscription that’s scheduled to expire at the end of the current calendar month.

• On failure, responds with SdkError<GetDeliverabilityDashboardOptionsError>

impl Client

pub fn get_deliverability_test_report( &self ) -> GetDeliverabilityTestReportFluentBuilder

Constructs a fluent builder for the GetDeliverabilityTestReport operation.

• The fluent builder is configurable:
  • report_id(impl Into<String>) / set_report_id(Option<String>):
    required: true
    

    A unique string that identifies the predictive inbox placement test.

    
    
• On success, responds with GetDeliverabilityTestReportOutput with field(s):
  • deliverability_test_report(Option<DeliverabilityTestReport>):

    An object that contains the results of the predictive inbox placement test.

  • overall_placement(Option<PlacementStatistics>):

    An object that specifies how many test messages that were sent during the predictive inbox placement test were delivered to recipients’ inboxes, how many were sent to recipients’ spam folders, and how many weren’t delivered.

  • isp_placements(Vec::<IspPlacement>):

    An object that describes how the test email was handled by several email providers, including Gmail, Hotmail, Yahoo, AOL, and others.

  • message(Option<String>):

    An object that contains the message that you sent when you performed this predictive inbox placement test.

  • tags(Option<Vec::<Tag>>):

    An array of objects that define the tags (keys and values) that are associated with the predictive inbox placement test.

• On failure, responds with SdkError<GetDeliverabilityTestReportError>

impl Client

pub fn get_domain_deliverability_campaign( &self ) -> GetDomainDeliverabilityCampaignFluentBuilder

Constructs a fluent builder for the GetDomainDeliverabilityCampaign operation.

• The fluent builder is configurable:
  • campaign_id(impl Into<String>) / set_campaign_id(Option<String>):
    required: true
    

    The unique identifier for the campaign. The Deliverability dashboard automatically generates and assigns this identifier to a campaign.

    
    
• On success, responds with GetDomainDeliverabilityCampaignOutput with field(s):
  • domain_deliverability_campaign(Option<DomainDeliverabilityCampaign>):

    An object that contains the deliverability data for the campaign.

• On failure, responds with SdkError<GetDomainDeliverabilityCampaignError>

impl Client

pub fn get_domain_statistics_report( &self ) -> GetDomainStatisticsReportFluentBuilder

Constructs a fluent builder for the GetDomainStatisticsReport operation.

• The fluent builder is configurable:
  • domain(impl Into<String>) / set_domain(Option<String>):
    required: true
    

    The domain that you want to obtain deliverability metrics for.

    
    
  • start_date(DateTime) / set_start_date(Option<DateTime>):
    required: true
    

    The first day (in Unix time) that you want to obtain domain deliverability metrics for.

    
    
  • end_date(DateTime) / set_end_date(Option<DateTime>):
    required: true
    

    The last day (in Unix time) that you want to obtain domain deliverability metrics for. The EndDate that you specify has to be less than or equal to 30 days after the StartDate.

    
    
• On success, responds with GetDomainStatisticsReportOutput with field(s):
  • overall_volume(Option<OverallVolume>):

    An object that contains deliverability metrics for the domain that you specified. The data in this object is a summary of all of the data that was collected from the StartDate to the EndDate.

  • daily_volumes(Vec::<DailyVolume>):

    An object that contains deliverability metrics for the domain that you specified. This object contains data for each day, starting on the StartDate and ending on the EndDate.

• On failure, responds with SdkError<GetDomainStatisticsReportError>

impl Client

pub fn get_email_identity(&self) -> GetEmailIdentityFluentBuilder

Constructs a fluent builder for the GetEmailIdentity operation.

• The fluent builder is configurable:
  • email_identity(impl Into<String>) / set_email_identity(Option<String>):
    required: true
    

    The email identity.

    
    
• On success, responds with GetEmailIdentityOutput with field(s):
  • identity_type(Option<IdentityType>):

    The email identity type. Note: the MANAGED_DOMAIN identity type is not supported.

  • feedback_forwarding_status(bool):

    The feedback forwarding configuration for the identity.

    If the value is true, you receive email notifications when bounce or complaint events occur. These notifications are sent to the address that you specified in the Return-Path header of the original email.

    You’re required to have a method of tracking bounces and complaints. If you haven’t set up another mechanism for receiving bounce or complaint notifications (for example, by setting up an event destination), you receive an email notification when these events occur (even if this setting is disabled).

  • verified_for_sending_status(bool):

    Specifies whether or not the identity is verified. You can only send email from verified email addresses or domains. For more information about verifying identities, see the Amazon Pinpoint User Guide.

  • dkim_attributes(Option<DkimAttributes>):

    An object that contains information about the DKIM attributes for the identity.

  • mail_from_attributes(Option<MailFromAttributes>):

    An object that contains information about the Mail-From attributes for the email identity.

  • policies(Option<HashMap::<String, String>>):

    A map of policy names to policies.

  • tags(Option<Vec::<Tag>>):

    An array of objects that define the tags (keys and values) that are associated with the email identity.

  • configuration_set_name(Option<String>):

    The configuration set used by default when sending from this identity.

  • verification_status(Option<VerificationStatus>):

    The verification status of the identity. The status can be one of the following:

    • PENDING – The verification process was initiated, but Amazon SES hasn’t yet been able to verify the identity.

    • SUCCESS – The verification process completed successfully.

    • FAILED – The verification process failed.

    • TEMPORARY_FAILURE – A temporary issue is preventing Amazon SES from determining the verification status of the identity.

    • NOT_STARTED – The verification process hasn’t been initiated for the identity.

  • verification_info(Option<VerificationInfo>):

    An object that contains additional information about the verification status for the identity.

• On failure, responds with SdkError<GetEmailIdentityError>

impl Client

pub fn get_email_identity_policies( &self ) -> GetEmailIdentityPoliciesFluentBuilder

Constructs a fluent builder for the GetEmailIdentityPolicies operation.

• The fluent builder is configurable:
  • email_identity(impl Into<String>) / set_email_identity(Option<String>):
    required: true
    

    The email identity.

    
    
• On success, responds with GetEmailIdentityPoliciesOutput with field(s):
  • policies(Option<HashMap::<String, String>>):

    A map of policy names to policies.

• On failure, responds with SdkError<GetEmailIdentityPoliciesError>

impl Client

pub fn get_email_template(&self) -> GetEmailTemplateFluentBuilder

Constructs a fluent builder for the GetEmailTemplate operation.

• The fluent builder is configurable:
  • template_name(impl Into<String>) / set_template_name(Option<String>):
    required: true
    

    The name of the template.

    
    
• On success, responds with GetEmailTemplateOutput with field(s):
  • template_name(String):

    The name of the template.

  • template_content(Option<EmailTemplateContent>):

    The content of the email template, composed of a subject line, an HTML part, and a text-only part.

• On failure, responds with SdkError<GetEmailTemplateError>

impl Client

pub fn get_export_job(&self) -> GetExportJobFluentBuilder

Constructs a fluent builder for the GetExportJob operation.

• The fluent builder is configurable:
  • job_id(impl Into<String>) / set_job_id(Option<String>):
    required: true
    

    The export job ID.

    
    
• On success, responds with GetExportJobOutput with field(s):
  • job_id(Option<String>):

    The export job ID.

  • export_source_type(Option<ExportSourceType>):

    The type of source of the export job.

  • job_status(Option<JobStatus>):

    The status of the export job.

  • export_destination(Option<ExportDestination>):

    The destination of the export job.

  • export_data_source(Option<ExportDataSource>):

    The data source of the export job.

  • created_timestamp(Option<DateTime>):

    The timestamp of when the export job was created.

  • completed_timestamp(Option<DateTime>):

    The timestamp of when the export job was completed.

  • failure_info(Option<FailureInfo>):

    The failure details about an export job.

  • statistics(Option<ExportStatistics>):

    The statistics about the export job.

• On failure, responds with SdkError<GetExportJobError>

impl Client

pub fn get_import_job(&self) -> GetImportJobFluentBuilder

Constructs a fluent builder for the GetImportJob operation.

• The fluent builder is configurable:
  • job_id(impl Into<String>) / set_job_id(Option<String>):
    required: true
    

    The ID of the import job.

    
    
• On success, responds with GetImportJobOutput with field(s):
  • job_id(Option<String>):

    A string that represents the import job ID.

  • import_destination(Option<ImportDestination>):

    The destination of the import job.

  • import_data_source(Option<ImportDataSource>):

    The data source of the import job.

  • failure_info(Option<FailureInfo>):

    The failure details about an import job.

  • job_status(Option<JobStatus>):

    The status of the import job.

  • created_timestamp(Option<DateTime>):

    The time stamp of when the import job was created.

  • completed_timestamp(Option<DateTime>):

    The time stamp of when the import job was completed.

  • processed_records_count(Option<i32>):

    The current number of records processed.

  • failed_records_count(Option<i32>):

    The number of records that failed processing because of invalid input or other reasons.

• On failure, responds with SdkError<GetImportJobError>

impl Client

pub fn get_message_insights(&self) -> GetMessageInsightsFluentBuilder

Constructs a fluent builder for the GetMessageInsights operation.

• The fluent builder is configurable:
  • message_id(impl Into<String>) / set_message_id(Option<String>):
    required: true
    

    A MessageId is a unique identifier for a message, and is returned when sending emails through Amazon SES.

    
    
• On success, responds with GetMessageInsightsOutput with field(s):
  • message_id(Option<String>):

    A unique identifier for the message.

  • from_email_address(Option<String>):

    The from address used to send the message.

  • subject(Option<String>):

    The subject line of the message.

  • email_tags(Option<Vec::<MessageTag>>):

    A list of tags, in the form of name/value pairs, that were applied to the email you sent, along with Amazon SES Auto-Tags.

  • insights(Option<Vec::<EmailInsights>>):

    A set of insights associated with the message.

• On failure, responds with SdkError<GetMessageInsightsError>

impl Client

pub fn get_suppressed_destination( &self ) -> GetSuppressedDestinationFluentBuilder

Constructs a fluent builder for the GetSuppressedDestination operation.

• The fluent builder is configurable:
  • email_address(impl Into<String>) / set_email_address(Option<String>):
    required: true
    

    The email address that’s on the account suppression list.

    
    
• On success, responds with GetSuppressedDestinationOutput with field(s):
  • suppressed_destination(Option<SuppressedDestination>):

    An object containing information about the suppressed email address.

• On failure, responds with SdkError<GetSuppressedDestinationError>

impl Client

pub fn list_configuration_sets(&self) -> ListConfigurationSetsFluentBuilder

Constructs a fluent builder for the ListConfigurationSets operation. This operation supports pagination; See into_paginator().

• The fluent builder is configurable:
  • next_token(impl Into<String>) / set_next_token(Option<String>):
    required: false
    

    A token returned from a previous call to ListConfigurationSets to indicate the position in the list of configuration sets.

    
    
  • page_size(i32) / set_page_size(Option<i32>):
    required: false
    

    The number of results to show in a single call to ListConfigurationSets. If the number of results is larger than the number you specified in this parameter, then the response includes a NextToken element, which you can use to obtain additional results.

    
    
• On success, responds with ListConfigurationSetsOutput with field(s):
  • configuration_sets(Option<Vec::<String>>):

    An array that contains all of the configuration sets in your Amazon SES account in the current Amazon Web Services Region.

  • next_token(Option<String>):

    A token that indicates that there are additional configuration sets to list. To view additional configuration sets, issue another request to ListConfigurationSets, and pass this token in the NextToken parameter.

• On failure, responds with SdkError<ListConfigurationSetsError>

impl Client

pub fn list_contact_lists(&self) -> ListContactListsFluentBuilder

Constructs a fluent builder for the ListContactLists operation. This operation supports pagination; See into_paginator().

• The fluent builder is configurable:
  • page_size(i32) / set_page_size(Option<i32>):
    required: false
    

    Maximum number of contact lists to return at once. Use this parameter to paginate results. If additional contact lists exist beyond the specified limit, the NextToken element is sent in the response. Use the NextToken value in subsequent requests to retrieve additional lists.

    
    
  • next_token(impl Into<String>) / set_next_token(Option<String>):
    required: false
    

    A string token indicating that there might be additional contact lists available to be listed. Use the token provided in the Response to use in the subsequent call to ListContactLists with the same parameters to retrieve the next page of contact lists.

    
    
• On success, responds with ListContactListsOutput with field(s):
  • contact_lists(Option<Vec::<ContactList>>):

    The available contact lists.

  • next_token(Option<String>):

    A string token indicating that there might be additional contact lists available to be listed. Copy this token to a subsequent call to ListContactLists with the same parameters to retrieve the next page of contact lists.

• On failure, responds with SdkError<ListContactListsError>

impl Client

pub fn list_contacts(&self) -> ListContactsFluentBuilder

Constructs a fluent builder for the ListContacts operation. This operation supports pagination; See into_paginator().

• The fluent builder is configurable:
  • contact_list_name(impl Into<String>) / set_contact_list_name(Option<String>):
    required: true
    

    The name of the contact list.

    
    
  • filter(ListContactsFilter) / set_filter(Option<ListContactsFilter>):
    required: false
    

    A filter that can be applied to a list of contacts.

    
    
  • page_size(i32) / set_page_size(Option<i32>):
    required: false
    

    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 NextToken element is sent in the response. Use the NextToken value in subsequent requests to retrieve additional contacts.

    
    
  • next_token(impl Into<String>) / set_next_token(Option<String>):
    required: false
    

    A string token indicating that there might be additional contacts available to be listed. Use the token provided in the Response to use in the subsequent call to ListContacts with the same parameters to retrieve the next page of contacts.

    
    
• On success, responds with ListContactsOutput with field(s):
  • contacts(Option<Vec::<Contact>>):

    The contacts present in a specific contact list.

  • next_token(Option<String>):

    A string token indicating that there might be additional contacts available to be listed. Copy this token to a subsequent call to ListContacts with the same parameters to retrieve the next page of contacts.

• On failure, responds with SdkError<ListContactsError>

impl Client

pub fn list_custom_verification_email_templates( &self ) -> ListCustomVerificationEmailTemplatesFluentBuilder

Constructs a fluent builder for the ListCustomVerificationEmailTemplates operation. This operation supports pagination; See into_paginator().

• The fluent builder is configurable:
  • next_token(impl Into<String>) / set_next_token(Option<String>):
    required: false
    

    A token returned from a previous call to ListCustomVerificationEmailTemplates to indicate the position in the list of custom verification email templates.

    
    
  • page_size(i32) / set_page_size(Option<i32>):
    required: false
    

    The number of results to show in a single call to ListCustomVerificationEmailTemplates. If the number of results is larger than the number you specified in this parameter, then the response includes a NextToken element, which you can use to obtain additional results.

    The value you specify has to be at least 1, and can be no more than 50.

    
    
• On success, responds with ListCustomVerificationEmailTemplatesOutput with field(s):
  • custom_verification_email_templates(Option<Vec::<CustomVerificationEmailTemplateMetadata>>):

    A list of the custom verification email templates that exist in your account.

  • next_token(Option<String>):

    A token indicating that there are additional custom verification email templates available to be listed. Pass this token to a subsequent call to ListCustomVerificationEmailTemplates to retrieve the next 50 custom verification email templates.

• On failure, responds with SdkError<ListCustomVerificationEmailTemplatesError>

impl Client

pub fn list_dedicated_ip_pools(&self) -> ListDedicatedIpPoolsFluentBuilder

Constructs a fluent builder for the ListDedicatedIpPools operation. This operation supports pagination; See into_paginator().

• The fluent builder is configurable:
  • next_token(impl Into<String>) / set_next_token(Option<String>):
    required: false
    

    A token returned from a previous call to ListDedicatedIpPools to indicate the position in the list of dedicated IP pools.

    
    
  • page_size(i32) / set_page_size(Option<i32>):
    required: false
    

    The number of results to show in a single call to ListDedicatedIpPools. If the number of results is larger than the number you specified in this parameter, then the response includes a NextToken element, which you can use to obtain additional results.

    
    
• On success, responds with ListDedicatedIpPoolsOutput with field(s):
  • dedicated_ip_pools(Option<Vec::<String>>):

    A list of all of the dedicated IP pools that are associated with your Amazon Web Services account in the current Region.

  • next_token(Option<String>):

    A token that indicates that there are additional IP pools to list. To view additional IP pools, issue another request to ListDedicatedIpPools, passing this token in the NextToken parameter.

• On failure, responds with SdkError<ListDedicatedIpPoolsError>

impl Client

pub fn list_deliverability_test_reports( &self ) -> ListDeliverabilityTestReportsFluentBuilder

Constructs a fluent builder for the ListDeliverabilityTestReports operation. This operation supports pagination; See into_paginator().

• The fluent builder is configurable:
  • next_token(impl Into<String>) / set_next_token(Option<String>):
    required: false
    

    A token returned from a previous call to ListDeliverabilityTestReports to indicate the position in the list of predictive inbox placement tests.

    
    
  • page_size(i32) / set_page_size(Option<i32>):
    required: false
    

    The number of results to show in a single call to ListDeliverabilityTestReports. If the number of results is larger than the number you specified in this parameter, then the response includes a NextToken element, which you can use to obtain additional results.

    The value you specify has to be at least 0, and can be no more than 1000.

    
    
• On success, responds with ListDeliverabilityTestReportsOutput with field(s):
  • deliverability_test_reports(Vec::<DeliverabilityTestReport>):

    An object that contains a lists of predictive inbox placement tests that you’ve performed.

  • next_token(Option<String>):

    A token that indicates that there are additional predictive inbox placement tests to list. To view additional predictive inbox placement tests, issue another request to ListDeliverabilityTestReports, and pass this token in the NextToken parameter.

• On failure, responds with SdkError<ListDeliverabilityTestReportsError>

impl Client

pub fn list_domain_deliverability_campaigns( &self ) -> ListDomainDeliverabilityCampaignsFluentBuilder

Constructs a fluent builder for the ListDomainDeliverabilityCampaigns operation. This operation supports pagination; See into_paginator().

• The fluent builder is configurable:
  • start_date(DateTime) / set_start_date(Option<DateTime>):
    required: true
    

    The first day that you want to obtain deliverability data for.

    
    
  • end_date(DateTime) / set_end_date(Option<DateTime>):
    required: true
    

    The last day that you want to obtain deliverability data for. This value has to be less than or equal to 30 days after the value of the StartDate parameter.

    
    
  • subscribed_domain(impl Into<String>) / set_subscribed_domain(Option<String>):
    required: true
    

    The domain to obtain deliverability data for.

    
    
  • next_token(impl Into<String>) / set_next_token(Option<String>):
    required: false
    

    A token that’s returned from a previous call to the ListDomainDeliverabilityCampaigns operation. This token indicates the position of a campaign in the list of campaigns.

    
    
  • page_size(i32) / set_page_size(Option<i32>):
    required: false
    

    The maximum number of results to include in response to a single call to the ListDomainDeliverabilityCampaigns operation. If the number of results is larger than the number that you specify in this parameter, the response includes a NextToken element, which you can use to obtain additional results.

    
    
• On success, responds with ListDomainDeliverabilityCampaignsOutput with field(s):
  • domain_deliverability_campaigns(Vec::<DomainDeliverabilityCampaign>):

    An array of responses, one for each campaign that used the domain to send email during the specified time range.

  • next_token(Option<String>):

    A token that’s returned from a previous call to the ListDomainDeliverabilityCampaigns operation. This token indicates the position of the campaign in the list of campaigns.

• On failure, responds with SdkError<ListDomainDeliverabilityCampaignsError>

impl Client

pub fn list_email_identities(&self) -> ListEmailIdentitiesFluentBuilder

Constructs a fluent builder for the ListEmailIdentities operation. This operation supports pagination; See into_paginator().

• The fluent builder is configurable:
  • next_token(impl Into<String>) / set_next_token(Option<String>):
    required: false
    

    A token returned from a previous call to ListEmailIdentities to indicate the position in the list of identities.

    
    
  • page_size(i32) / set_page_size(Option<i32>):
    required: false
    

    The number of results to show in a single call to ListEmailIdentities. If the number of results is larger than the number you specified in this parameter, then the response includes a NextToken element, which you can use to obtain additional results.

    The value you specify has to be at least 0, and can be no more than 1000.

    
    
• On success, responds with ListEmailIdentitiesOutput with field(s):
  • email_identities(Option<Vec::<IdentityInfo>>):

    An array that includes all of the email identities associated with your Amazon Web Services account.

  • next_token(Option<String>):

    A token that indicates that there are additional configuration sets to list. To view additional configuration sets, issue another request to ListEmailIdentities, and pass this token in the NextToken parameter.

• On failure, responds with SdkError<ListEmailIdentitiesError>

impl Client

pub fn list_email_templates(&self) -> ListEmailTemplatesFluentBuilder

Constructs a fluent builder for the ListEmailTemplates operation. This operation supports pagination; See into_paginator().

• The fluent builder is configurable:
  • next_token(impl Into<String>) / set_next_token(Option<String>):
    required: false
    

    A token returned from a previous call to ListEmailTemplates to indicate the position in the list of email templates.

    
    
  • page_size(i32) / set_page_size(Option<i32>):
    required: false
    

    The number of results to show in a single call to ListEmailTemplates. If the number of results is larger than the number you specified in this parameter, then the response includes a NextToken element, which you can use to obtain additional results.

    The value you specify has to be at least 1, and can be no more than 100.

    
    
• On success, responds with ListEmailTemplatesOutput with field(s):
  • templates_metadata(Option<Vec::<EmailTemplateMetadata>>):

    An array the contains the name and creation time stamp for each template in your Amazon SES account.

  • next_token(Option<String>):

    A token indicating that there are additional email templates available to be listed. Pass this token to a subsequent ListEmailTemplates call to retrieve the next 10 email templates.

• On failure, responds with SdkError<ListEmailTemplatesError>

impl Client

pub fn list_export_jobs(&self) -> ListExportJobsFluentBuilder

Constructs a fluent builder for the ListExportJobs operation. This operation supports pagination; See into_paginator().

• The fluent builder is configurable:
  • next_token(impl Into<String>) / set_next_token(Option<String>):
    required: false
    

    The pagination token returned from a previous call to ListExportJobs to indicate the position in the list of export jobs.

    
    
  • page_size(i32) / set_page_size(Option<i32>):
    required: false
    

    Maximum number of export jobs to return at once. Use this parameter to paginate results. If additional export jobs exist beyond the specified limit, the NextToken element is sent in the response. Use the NextToken value in subsequent calls to ListExportJobs to retrieve additional export jobs.

    
    
  • export_source_type(ExportSourceType) / set_export_source_type(Option<ExportSourceType>):
    required: false
    

    A value used to list export jobs that have a certain ExportSourceType.

    
    
  • job_status(JobStatus) / set_job_status(Option<JobStatus>):
    required: false
    

    A value used to list export jobs that have a certain JobStatus.

    
    
• On success, responds with ListExportJobsOutput with field(s):
  • export_jobs(Option<Vec::<ExportJobSummary>>):

    A list of the export job summaries.

  • next_token(Option<String>):

    A string token indicating that there might be additional export jobs available to be listed. Use this token to a subsequent call to ListExportJobs with the same parameters to retrieve the next page of export jobs.

• On failure, responds with SdkError<ListExportJobsError>

impl Client

pub fn list_import_jobs(&self) -> ListImportJobsFluentBuilder

Constructs a fluent builder for the ListImportJobs operation. This operation supports pagination; See into_paginator().

• The fluent builder is configurable:
  • import_destination_type(ImportDestinationType) / set_import_destination_type(Option<ImportDestinationType>):
    required: false
    

    The destination of the import job, which can be used to list import jobs that have a certain ImportDestinationType.

    
    
  • next_token(impl Into<String>) / set_next_token(Option<String>):
    required: false
    

    A string token indicating that there might be additional import jobs available to be listed. Copy this token to a subsequent call to ListImportJobs with the same parameters to retrieve the next page of import jobs.

    
    
  • page_size(i32) / set_page_size(Option<i32>):
    required: false
    

    Maximum number of import jobs to return at once. Use this parameter to paginate results. If additional import jobs exist beyond the specified limit, the NextToken element is sent in the response. Use the NextToken value in subsequent requests to retrieve additional addresses.

    
    
• On success, responds with ListImportJobsOutput with field(s):
  • import_jobs(Option<Vec::<ImportJobSummary>>):

    A list of the import job summaries.

  • next_token(Option<String>):

    A string token indicating that there might be additional import jobs available to be listed. Copy this token to a subsequent call to ListImportJobs with the same parameters to retrieve the next page of import jobs.

• On failure, responds with SdkError<ListImportJobsError>

impl Client

pub fn list_recommendations(&self) -> ListRecommendationsFluentBuilder

Constructs a fluent builder for the ListRecommendations operation. This operation supports pagination; See into_paginator().

• The fluent builder is configurable:
  • filter(ListRecommendationsFilterKey, impl Into<String>) / set_filter(Option<HashMap::<ListRecommendationsFilterKey, String>>):
    required: false
    

    Filters applied when retrieving recommendations. Can eiter be an individual filter, or combinations of STATUS and IMPACT or STATUS and TYPE

    
    
  • next_token(impl Into<String>) / set_next_token(Option<String>):
    required: false
    

    A token returned from a previous call to ListRecommendations to indicate the position in the list of recommendations.

    
    
  • page_size(i32) / set_page_size(Option<i32>):
    required: false
    

    The number of results to show in a single call to ListRecommendations. If the number of results is larger than the number you specified in this parameter, then the response includes a NextToken element, which you can use to obtain additional results.

    The value you specify has to be at least 1, and can be no more than 100.

    
    
• On success, responds with ListRecommendationsOutput with field(s):
  • recommendations(Option<Vec::<Recommendation>>):

    The recommendations applicable to your account.

  • next_token(Option<String>):

    A string token indicating that there might be additional recommendations available to be listed. Use the token provided in the ListRecommendationsResponse to use in the subsequent call to ListRecommendations with the same parameters to retrieve the next page of recommendations.

• On failure, responds with SdkError<ListRecommendationsError>

impl Client

pub fn list_suppressed_destinations( &self ) -> ListSuppressedDestinationsFluentBuilder

Constructs a fluent builder for the ListSuppressedDestinations operation. This operation supports pagination; See into_paginator().

• The fluent builder is configurable:
  • reasons(SuppressionListReason) / set_reasons(Option<Vec::<SuppressionListReason>>):
    required: false
    

    The factors that caused the email address to be added to .

    
    
  • start_date(DateTime) / set_start_date(Option<DateTime>):
    required: false
    

    Used to filter the list of suppressed email destinations so that it only includes addresses that were added to the list after a specific date.

    
    
  • end_date(DateTime) / set_end_date(Option<DateTime>):
    required: false
    

    Used to filter the list of suppressed email destinations so that it only includes addresses that were added to the list before a specific date.

    
    
  • next_token(impl Into<String>) / set_next_token(Option<String>):
    required: false
    

    A token returned from a previous call to ListSuppressedDestinations to indicate the position in the list of suppressed email addresses.

    
    
  • page_size(i32) / set_page_size(Option<i32>):
    required: false
    

    The number of results to show in a single call to ListSuppressedDestinations. If the number of results is larger than the number you specified in this parameter, then the response includes a NextToken element, which you can use to obtain additional results.

    
    
• On success, responds with ListSuppressedDestinationsOutput with field(s):
  • suppressed_destination_summaries(Option<Vec::<SuppressedDestinationSummary>>):

    A list of summaries, each containing a summary for a suppressed email destination.

  • next_token(Option<String>):

    A token that indicates that there are additional email addresses on the suppression list for your account. To view additional suppressed addresses, issue another request to ListSuppressedDestinations, and pass this token in the NextToken parameter.

• On failure, responds with SdkError<ListSuppressedDestinationsError>

impl Client

pub fn list_tags_for_resource(&self) -> ListTagsForResourceFluentBuilder

Constructs a fluent builder for the ListTagsForResource operation.

• The fluent builder is configurable:
  • resource_arn(impl Into<String>) / set_resource_arn(Option<String>):
    required: true
    

    The Amazon Resource Name (ARN) of the resource that you want to retrieve tag information for.

    
    
• On success, responds with ListTagsForResourceOutput with field(s):
  • tags(Vec::<Tag>):

    An array that lists all the tags that are associated with the resource. Each tag consists of a required tag key (Key) and an associated tag value (Value)

• On failure, responds with SdkError<ListTagsForResourceError>

impl Client

pub fn put_account_dedicated_ip_warmup_attributes( &self ) -> PutAccountDedicatedIpWarmupAttributesFluentBuilder

Constructs a fluent builder for the PutAccountDedicatedIpWarmupAttributes operation.

• The fluent builder is configurable:
  • auto_warmup_enabled(bool) / set_auto_warmup_enabled(Option<bool>):
    required: false
    

    Enables or disables the automatic warm-up feature for dedicated IP addresses that are associated with your Amazon SES account in the current Amazon Web Services Region. Set to true to enable the automatic warm-up feature, or set to false to disable it.

    
    
• On success, responds with PutAccountDedicatedIpWarmupAttributesOutput
• On failure, responds with SdkError<PutAccountDedicatedIpWarmupAttributesError>

impl Client

pub fn put_account_details(&self) -> PutAccountDetailsFluentBuilder

Constructs a fluent builder for the PutAccountDetails operation.

• The fluent builder is configurable:
  • mail_type(MailType) / set_mail_type(Option<MailType>):
    required: true
    

    The type of email your account will send.

    
    
  • website_url(impl Into<String>) / set_website_url(Option<String>):
    required: true
    

    The URL of your website. This information helps us better understand the type of content that you plan to send.

    
    
  • contact_language(ContactLanguage) / set_contact_language(Option<ContactLanguage>):
    required: false
    

    The language you would prefer to be contacted with.

    
    
  • use_case_description(impl Into<String>) / set_use_case_description(Option<String>):
    required: true
    

    A description of the types of email that you plan to send.

    
    
  • additional_contact_email_addresses(impl Into<String>) / set_additional_contact_email_addresses(Option<Vec::<String>>):
    required: false
    

    Additional email addresses that you would like to be notified regarding Amazon SES matters.

    
    
  • production_access_enabled(bool) / set_production_access_enabled(Option<bool>):
    required: false
    

    Indicates whether or not your account should have production access in the current Amazon Web Services 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.

    
    
• On success, responds with PutAccountDetailsOutput
• On failure, responds with SdkError<PutAccountDetailsError>

impl Client

pub fn put_account_sending_attributes( &self ) -> PutAccountSendingAttributesFluentBuilder

Constructs a fluent builder for the PutAccountSendingAttributes operation.

• The fluent builder is configurable:
  • sending_enabled(bool) / set_sending_enabled(Option<bool>):
    required: false
    

    Enables or disables your account’s ability to send email. Set to true to enable email sending, or set to false to disable email sending.

    If Amazon Web Services paused your account’s ability to send email, you can’t use this operation to resume your account’s ability to send email.

    
    
• On success, responds with PutAccountSendingAttributesOutput
• On failure, responds with SdkError<PutAccountSendingAttributesError>

impl Client

pub fn put_account_suppression_attributes( &self ) -> PutAccountSuppressionAttributesFluentBuilder

Constructs a fluent builder for the PutAccountSuppressionAttributes operation.

• The fluent builder is configurable:
  • suppressed_reasons(SuppressionListReason) / set_suppressed_reasons(Option<Vec::<SuppressionListReason>>):
    required: false
    

    A list that contains the reasons that email addresses will be automatically added to the suppression list for your account. This list can contain any or all of the following:

    • COMPLAINT – Amazon SES adds an email address to the suppression list for your account when a message sent to that address results in a complaint.

    • BOUNCE – Amazon SES adds an email address to the suppression list for your account when a message sent to that address results in a hard bounce.

    
    
• On success, responds with PutAccountSuppressionAttributesOutput
• On failure, responds with SdkError<PutAccountSuppressionAttributesError>

impl Client

pub fn put_account_vdm_attributes(&self) -> PutAccountVdmAttributesFluentBuilder

Constructs a fluent builder for the PutAccountVdmAttributes operation.

• The fluent builder is configurable:
  • vdm_attributes(VdmAttributes) / set_vdm_attributes(Option<VdmAttributes>):
    required: true
    

    The VDM attributes that you wish to apply to your Amazon SES account.

    
    
• On success, responds with PutAccountVdmAttributesOutput
• On failure, responds with SdkError<PutAccountVdmAttributesError>

impl Client

pub fn put_configuration_set_delivery_options( &self ) -> PutConfigurationSetDeliveryOptionsFluentBuilder

Constructs a fluent builder for the PutConfigurationSetDeliveryOptions operation.

• The fluent builder is configurable:
  • configuration_set_name(impl Into<String>) / set_configuration_set_name(Option<String>):
    required: true
    

    The name of the configuration set to associate with a dedicated IP pool.

    
    
  • tls_policy(TlsPolicy) / set_tls_policy(Option<TlsPolicy>):
    required: false
    

    Specifies whether messages that use the configuration set are required to use Transport Layer Security (TLS). If the value is Require, messages are only delivered if a TLS connection can be established. If the value is Optional, messages can be delivered in plain text if a TLS connection can’t be established.

    
    
  • sending_pool_name(impl Into<String>) / set_sending_pool_name(Option<String>):
    required: false
    

    The name of the dedicated IP pool to associate with the configuration set.

    
    
• On success, responds with PutConfigurationSetDeliveryOptionsOutput
• On failure, responds with SdkError<PutConfigurationSetDeliveryOptionsError>

impl Client

pub fn put_configuration_set_reputation_options( &self ) -> PutConfigurationSetReputationOptionsFluentBuilder

Constructs a fluent builder for the PutConfigurationSetReputationOptions operation.

• The fluent builder is configurable:
  • configuration_set_name(impl Into<String>) / set_configuration_set_name(Option<String>):
    required: true
    

    The name of the configuration set.

    
    
  • reputation_metrics_enabled(bool) / set_reputation_metrics_enabled(Option<bool>):
    required: false
    

    If true, tracking of reputation metrics is enabled for the configuration set. If false, tracking of reputation metrics is disabled for the configuration set.

    
    
• On success, responds with PutConfigurationSetReputationOptionsOutput
• On failure, responds with SdkError<PutConfigurationSetReputationOptionsError>

impl Client

pub fn put_configuration_set_sending_options( &self ) -> PutConfigurationSetSendingOptionsFluentBuilder

Constructs a fluent builder for the PutConfigurationSetSendingOptions operation.

• The fluent builder is configurable:
  • configuration_set_name(impl Into<String>) / set_configuration_set_name(Option<String>):
    required: true
    

    The name of the configuration set to enable or disable email sending for.

    
    
  • sending_enabled(bool) / set_sending_enabled(Option<bool>):
    required: false
    

    If true, email sending is enabled for the configuration set. If false, email sending is disabled for the configuration set.

    
    
• On success, responds with PutConfigurationSetSendingOptionsOutput
• On failure, responds with SdkError<PutConfigurationSetSendingOptionsError>

impl Client

pub fn put_configuration_set_suppression_options( &self ) -> PutConfigurationSetSuppressionOptionsFluentBuilder

Constructs a fluent builder for the PutConfigurationSetSuppressionOptions operation.

• The fluent builder is configurable:
  • configuration_set_name(impl Into<String>) / set_configuration_set_name(Option<String>):
    required: true
    

    The name of the configuration set to change the suppression list preferences for.

    
    
  • suppressed_reasons(SuppressionListReason) / set_suppressed_reasons(Option<Vec::<SuppressionListReason>>):
    required: false
    

    A list that contains the reasons that email addresses are automatically added to the suppression list for your account. This list can contain any or all of the following:

    • COMPLAINT – Amazon SES adds an email address to the suppression list for your account when a message sent to that address results in a complaint.

    • BOUNCE – Amazon SES adds an email address to the suppression list for your account when a message sent to that address results in a hard bounce.

    
    
• On success, responds with PutConfigurationSetSuppressionOptionsOutput
• On failure, responds with SdkError<PutConfigurationSetSuppressionOptionsError>

impl Client

pub fn put_configuration_set_tracking_options( &self ) -> PutConfigurationSetTrackingOptionsFluentBuilder

Constructs a fluent builder for the PutConfigurationSetTrackingOptions operation.

• The fluent builder is configurable:
  • configuration_set_name(impl Into<String>) / set_configuration_set_name(Option<String>):
    required: true
    

    The name of the configuration set.

    
    
  • custom_redirect_domain(impl Into<String>) / set_custom_redirect_domain(Option<String>):
    required: false
    

    The domain to use to track open and click events.

    
    
• On success, responds with PutConfigurationSetTrackingOptionsOutput
• On failure, responds with SdkError<PutConfigurationSetTrackingOptionsError>

impl Client

pub fn put_configuration_set_vdm_options( &self ) -> PutConfigurationSetVdmOptionsFluentBuilder

Constructs a fluent builder for the PutConfigurationSetVdmOptions operation.

• The fluent builder is configurable:
  • configuration_set_name(impl Into<String>) / set_configuration_set_name(Option<String>):
    required: true
    

    The name of the configuration set.

    
    
  • vdm_options(VdmOptions) / set_vdm_options(Option<VdmOptions>):
    required: false
    

    The VDM options to apply to the configuration set.

    
    
• On success, responds with PutConfigurationSetVdmOptionsOutput
• On failure, responds with SdkError<PutConfigurationSetVdmOptionsError>

impl Client

pub fn put_dedicated_ip_in_pool(&self) -> PutDedicatedIpInPoolFluentBuilder

Constructs a fluent builder for the PutDedicatedIpInPool operation.

• The fluent builder is configurable:
  • ip(impl Into<String>) / set_ip(Option<String>):
    required: true
    

    The IP address that you want to move to the dedicated IP pool. The value you specify has to be a dedicated IP address that’s associated with your Amazon Web Services account.

    
    
  • destination_pool_name(impl Into<String>) / set_destination_pool_name(Option<String>):
    required: true
    

    The name of the IP pool that you want to add the dedicated IP address to. You have to specify an IP pool that already exists.

    
    
• On success, responds with PutDedicatedIpInPoolOutput
• On failure, responds with SdkError<PutDedicatedIpInPoolError>

impl Client

pub fn put_dedicated_ip_pool_scaling_attributes( &self ) -> PutDedicatedIpPoolScalingAttributesFluentBuilder

Constructs a fluent builder for the PutDedicatedIpPoolScalingAttributes operation.

• The fluent builder is configurable:
  • pool_name(impl Into<String>) / set_pool_name(Option<String>):
    required: true
    

    The name of the dedicated IP pool.

    
    
  • scaling_mode(ScalingMode) / set_scaling_mode(Option<ScalingMode>):
    required: true
    

    The scaling mode to apply to the dedicated IP pool.

    Changing the scaling mode from MANAGED to STANDARD is not supported.

    
    
• On success, responds with PutDedicatedIpPoolScalingAttributesOutput
• On failure, responds with SdkError<PutDedicatedIpPoolScalingAttributesError>

impl Client

pub fn put_dedicated_ip_warmup_attributes( &self ) -> PutDedicatedIpWarmupAttributesFluentBuilder

Constructs a fluent builder for the PutDedicatedIpWarmupAttributes operation.

• The fluent builder is configurable:
  • ip(impl Into<String>) / set_ip(Option<String>):
    required: true
    

    The dedicated IP address that you want to update the warm-up attributes for.

    
    
  • warmup_percentage(i32) / set_warmup_percentage(Option<i32>):
    required: true
    

    The warm-up percentage that you want to associate with the dedicated IP address.

    
    
• On success, responds with PutDedicatedIpWarmupAttributesOutput
• On failure, responds with SdkError<PutDedicatedIpWarmupAttributesError>

impl Client

pub fn put_deliverability_dashboard_option( &self ) -> PutDeliverabilityDashboardOptionFluentBuilder

Constructs a fluent builder for the PutDeliverabilityDashboardOption operation.

• The fluent builder is configurable:
  • dashboard_enabled(bool) / set_dashboard_enabled(Option<bool>):
    required: true
    

    Specifies whether to enable the Deliverability dashboard. To enable the dashboard, set this value to true.

    
    
  • subscribed_domains(DomainDeliverabilityTrackingOption) / set_subscribed_domains(Option<Vec::<DomainDeliverabilityTrackingOption>>):
    required: false
    

    An array of objects, one for each verified domain that you use to send email and enabled the Deliverability dashboard for.

    
    
• On success, responds with PutDeliverabilityDashboardOptionOutput
• On failure, responds with SdkError<PutDeliverabilityDashboardOptionError>

impl Client

pub fn put_email_identity_configuration_set_attributes( &self ) -> PutEmailIdentityConfigurationSetAttributesFluentBuilder

Constructs a fluent builder for the PutEmailIdentityConfigurationSetAttributes operation.

• The fluent builder is configurable:
  • email_identity(impl Into<String>) / set_email_identity(Option<String>):
    required: true
    

    The email address or domain to associate with a configuration set.

    
    
  • configuration_set_name(impl Into<String>) / set_configuration_set_name(Option<String>):
    required: false
    

    The configuration set to associate with an email identity.

    
    
• On success, responds with PutEmailIdentityConfigurationSetAttributesOutput
• On failure, responds with SdkError<PutEmailIdentityConfigurationSetAttributesError>

impl Client

pub fn put_email_identity_dkim_attributes( &self ) -> PutEmailIdentityDkimAttributesFluentBuilder

Constructs a fluent builder for the PutEmailIdentityDkimAttributes operation.

• The fluent builder is configurable:
  • email_identity(impl Into<String>) / set_email_identity(Option<String>):
    required: true
    

    The email identity.

    
    
  • signing_enabled(bool) / set_signing_enabled(Option<bool>):
    required: false
    

    Sets the DKIM signing configuration for the identity.

    When you set this value true, then the messages that are sent from the identity are signed using DKIM. If you set this value to false, your messages are sent without DKIM signing.

    
    
• On success, responds with PutEmailIdentityDkimAttributesOutput
• On failure, responds with SdkError<PutEmailIdentityDkimAttributesError>

impl Client

pub fn put_email_identity_dkim_signing_attributes( &self ) -> PutEmailIdentityDkimSigningAttributesFluentBuilder

Constructs a fluent builder for the PutEmailIdentityDkimSigningAttributes operation.

• The fluent builder is configurable:
  • email_identity(impl Into<String>) / set_email_identity(Option<String>):
    required: true
    

    The email identity.

    
    
  • signing_attributes_origin(DkimSigningAttributesOrigin) / set_signing_attributes_origin(Option<DkimSigningAttributesOrigin>):
    required: true
    

    The method to use to configure DKIM for the identity. There are the following possible values:

    • AWS_SES – Configure DKIM for the identity by using Easy DKIM.

    • EXTERNAL – Configure DKIM for the identity by using Bring Your Own DKIM (BYODKIM).

    
    
  • signing_attributes(DkimSigningAttributes) / set_signing_attributes(Option<DkimSigningAttributes>):
    required: false
    

    An object that contains information about the private key and selector that you want to use to configure DKIM for the identity for Bring Your Own DKIM (BYODKIM) for the identity, or, configures the key length to be used for Easy DKIM.

    
    
• On success, responds with PutEmailIdentityDkimSigningAttributesOutput with field(s):
  • dkim_status(Option<DkimStatus>):

    The DKIM authentication status of the identity. Amazon SES determines the authentication status by searching for specific records in the DNS configuration for your domain. If you used Easy DKIM to set up DKIM authentication, Amazon SES tries to find three unique CNAME records in the DNS configuration for your domain.

    If you provided a public key to perform DKIM authentication, Amazon SES tries to find a TXT record that uses the selector that you specified. The value of the TXT record must be a public key that’s paired with the private key that you specified in the process of creating the identity.

    The status can be one of the following:

    • PENDING – The verification process was initiated, but Amazon SES hasn’t yet detected the DKIM records in the DNS configuration for the domain.

    • SUCCESS – The verification process completed successfully.

    • FAILED – The verification process failed. This typically occurs when Amazon SES fails to find the DKIM records in the DNS configuration of the domain.

    • TEMPORARY_FAILURE – A temporary issue is preventing Amazon SES from determining the DKIM authentication status of the domain.

    • NOT_STARTED – The DKIM verification process hasn’t been initiated for the domain.

  • dkim_tokens(Option<Vec::<String>>):

    If you used Easy DKIM to configure DKIM authentication for the domain, then this object contains a set of unique strings that you use to create a set of CNAME records that you add to the DNS configuration for your domain. When Amazon SES detects these records in the DNS configuration for your domain, the DKIM authentication process is complete.

    If you configured DKIM authentication for the domain by providing your own public-private key pair, then this object contains the selector that’s associated with your public key.

    Regardless of the DKIM authentication method you use, Amazon SES searches for the appropriate records in the DNS configuration of the domain for up to 72 hours.

• On failure, responds with SdkError<PutEmailIdentityDkimSigningAttributesError>

impl Client

pub fn put_email_identity_feedback_attributes( &self ) -> PutEmailIdentityFeedbackAttributesFluentBuilder

Constructs a fluent builder for the PutEmailIdentityFeedbackAttributes operation.

• The fluent builder is configurable:
  • email_identity(impl Into<String>) / set_email_identity(Option<String>):
    required: true
    

    The email identity.

    
    
  • email_forwarding_enabled(bool) / set_email_forwarding_enabled(Option<bool>):
    required: false
    

    Sets the feedback forwarding configuration for the identity.

    If the value is true, you receive email notifications when bounce or complaint events occur. These notifications are sent to the address that you specified in the Return-Path header of the original email.

    You’re required to have a method of tracking bounces and complaints. If you haven’t set up another mechanism for receiving bounce or complaint notifications (for example, by setting up an event destination), you receive an email notification when these events occur (even if this setting is disabled).

    
    
• On success, responds with PutEmailIdentityFeedbackAttributesOutput
• On failure, responds with SdkError<PutEmailIdentityFeedbackAttributesError>

impl Client

pub fn put_email_identity_mail_from_attributes( &self ) -> PutEmailIdentityMailFromAttributesFluentBuilder

Constructs a fluent builder for the PutEmailIdentityMailFromAttributes operation.

• The fluent builder is configurable:
  • email_identity(impl Into<String>) / set_email_identity(Option<String>):
    required: true
    

    The verified email identity.

    
    
  • mail_from_domain(impl Into<String>) / set_mail_from_domain(Option<String>):
    required: false
    

    The custom MAIL FROM domain that you want the verified identity to use. The MAIL FROM domain must meet the following criteria:

    • It has to be a subdomain of the verified identity.

    • It can’t be used to receive email.

    • It can’t be used in a “From” address if the MAIL FROM domain is a destination for feedback forwarding emails.

    
    
  • behavior_on_mx_failure(BehaviorOnMxFailure) / set_behavior_on_mx_failure(Option<BehaviorOnMxFailure>):
    required: false
    

    The action to take if the required MX record isn’t found when you send an email. When you set this value to UseDefaultValue, the mail is sent using amazonses.com as the MAIL FROM domain. When you set this value to RejectMessage, the Amazon SES API v2 returns a MailFromDomainNotVerified error, and doesn’t attempt to deliver the email.

    These behaviors are taken when the custom MAIL FROM domain configuration is in the Pending, Failed, and TemporaryFailure states.

    
    
• On success, responds with PutEmailIdentityMailFromAttributesOutput
• On failure, responds with SdkError<PutEmailIdentityMailFromAttributesError>

impl Client

pub fn put_suppressed_destination( &self ) -> PutSuppressedDestinationFluentBuilder

Constructs a fluent builder for the PutSuppressedDestination operation.

• The fluent builder is configurable:
  • email_address(impl Into<String>) / set_email_address(Option<String>):
    required: true
    

    The email address that should be added to the suppression list for your account.

    
    
  • reason(SuppressionListReason) / set_reason(Option<SuppressionListReason>):
    required: true
    

    The factors that should cause the email address to be added to the suppression list for your account.

    
    
• On success, responds with PutSuppressedDestinationOutput
• On failure, responds with SdkError<PutSuppressedDestinationError>

impl Client

pub fn send_bulk_email(&self) -> SendBulkEmailFluentBuilder

Constructs a fluent builder for the SendBulkEmail operation.

• The fluent builder is configurable:
  • from_email_address(impl Into<String>) / set_from_email_address(Option<String>):
    required: false
    

    The email address to use as the “From” address for the email. The address that you specify has to be verified.

    
    
  • from_email_address_identity_arn(impl Into<String>) / set_from_email_address_identity_arn(Option<String>):
    required: false
    

    This parameter is used only for sending authorization. It is the ARN of the identity that is associated with the sending authorization policy that permits you to use the email address specified in the FromEmailAddress parameter.

    For example, if the owner of example.com (which has ARN arn:aws:ses:us-east-1:123456789012:identity/example.com) attaches a policy to it that authorizes you to use sender@example.com, then you would specify the FromEmailAddressIdentityArn to be arn:aws:ses:us-east-1:123456789012:identity/example.com, and the FromEmailAddress to be sender@example.com.

    For more information about sending authorization, see the Amazon SES Developer Guide.

    
    
  • reply_to_addresses(impl Into<String>) / set_reply_to_addresses(Option<Vec::<String>>):
    required: false
    

    The “Reply-to” email addresses for the message. When the recipient replies to the message, each Reply-to address receives the reply.

    
    
  • feedback_forwarding_email_address(impl Into<String>) / set_feedback_forwarding_email_address(Option<String>):
    required: false
    

    The address that you want bounce and complaint notifications to be sent to.

    
    
  • feedback_forwarding_email_address_identity_arn(impl Into<String>) / set_feedback_forwarding_email_address_identity_arn(Option<String>):
    required: false
    

    This parameter is used only for sending authorization. It is the ARN of the identity that is associated with the sending authorization policy that permits you to use the email address specified in the FeedbackForwardingEmailAddress parameter.

    For example, if the owner of example.com (which has ARN arn:aws:ses:us-east-1:123456789012:identity/example.com) attaches a policy to it that authorizes you to use feedback@example.com, then you would specify the FeedbackForwardingEmailAddressIdentityArn to be arn:aws:ses:us-east-1:123456789012:identity/example.com, and the FeedbackForwardingEmailAddress to be feedback@example.com.

    For more information about sending authorization, see the Amazon SES Developer Guide.

    
    
  • default_email_tags(MessageTag) / set_default_email_tags(Option<Vec::<MessageTag>>):
    required: false
    

    A list of tags, in the form of name/value pairs, to apply to an email that you send using the SendEmail operation. Tags correspond to characteristics of the email that you define, so that you can publish email sending events.

    
    
  • default_content(BulkEmailContent) / set_default_content(Option<BulkEmailContent>):
    required: true
    

    An object that contains the body of the message. You can specify a template message.

    
    
  • bulk_email_entries(BulkEmailEntry) / set_bulk_email_entries(Option<Vec::<BulkEmailEntry>>):
    required: true
    

    The list of bulk email entry objects.

    
    
  • configuration_set_name(impl Into<String>) / set_configuration_set_name(Option<String>):
    required: false
    

    The name of the configuration set to use when sending the email.

    
    
• On success, responds with SendBulkEmailOutput with field(s):
  • bulk_email_entry_results(Vec::<BulkEmailEntryResult>):

    One object per intended recipient. Check each response object and retry any messages with a failure status.

• On failure, responds with SdkError<SendBulkEmailError>

impl Client

pub fn send_custom_verification_email( &self ) -> SendCustomVerificationEmailFluentBuilder

Constructs a fluent builder for the SendCustomVerificationEmail operation.

• The fluent builder is configurable:
  • email_address(impl Into<String>) / set_email_address(Option<String>):
    required: true
    

    The email address to verify.

    
    
  • template_name(impl Into<String>) / set_template_name(Option<String>):
    required: true
    

    The name of the custom verification email template to use when sending the verification email.

    
    
  • configuration_set_name(impl Into<String>) / set_configuration_set_name(Option<String>):
    required: false
    

    Name of a configuration set to use when sending the verification email.

    
    
• On success, responds with SendCustomVerificationEmailOutput with field(s):
  • message_id(Option<String>):

    The unique message identifier returned from the SendCustomVerificationEmail operation.

• On failure, responds with SdkError<SendCustomVerificationEmailError>

impl Client

pub fn send_email(&self) -> SendEmailFluentBuilder

Constructs a fluent builder for the SendEmail operation.

• The fluent builder is configurable:
  • from_email_address(impl Into<String>) / set_from_email_address(Option<String>):
    required: false
    

    The email address to use as the “From” address for the email. The address that you specify has to be verified.

    
    
  • from_email_address_identity_arn(impl Into<String>) / set_from_email_address_identity_arn(Option<String>):
    required: false
    

    This parameter is used only for sending authorization. It is the ARN of the identity that is associated with the sending authorization policy that permits you to use the email address specified in the FromEmailAddress parameter.

    For example, if the owner of example.com (which has ARN arn:aws:ses:us-east-1:123456789012:identity/example.com) attaches a policy to it that authorizes you to use sender@example.com, then you would specify the FromEmailAddressIdentityArn to be arn:aws:ses:us-east-1:123456789012:identity/example.com, and the FromEmailAddress to be sender@example.com.

    For more information about sending authorization, see the Amazon SES Developer Guide.

    For Raw emails, the FromEmailAddressIdentityArn value overrides the X-SES-SOURCE-ARN and X-SES-FROM-ARN headers specified in raw email message content.

    
    
  • destination(Destination) / set_destination(Option<Destination>):
    required: false
    

    An object that contains the recipients of the email message.

    
    
  • reply_to_addresses(impl Into<String>) / set_reply_to_addresses(Option<Vec::<String>>):
    required: false
    

    The “Reply-to” email addresses for the message. When the recipient replies to the message, each Reply-to address receives the reply.

    
    
  • feedback_forwarding_email_address(impl Into<String>) / set_feedback_forwarding_email_address(Option<String>):
    required: false
    

    The address that you want bounce and complaint notifications to be sent to.

    
    
  • feedback_forwarding_email_address_identity_arn(impl Into<String>) / set_feedback_forwarding_email_address_identity_arn(Option<String>):
    required: false
    

    This parameter is used only for sending authorization. It is the ARN of the identity that is associated with the sending authorization policy that permits you to use the email address specified in the FeedbackForwardingEmailAddress parameter.

    For example, if the owner of example.com (which has ARN arn:aws:ses:us-east-1:123456789012:identity/example.com) attaches a policy to it that authorizes you to use feedback@example.com, then you would specify the FeedbackForwardingEmailAddressIdentityArn to be arn:aws:ses:us-east-1:123456789012:identity/example.com, and the FeedbackForwardingEmailAddress to be feedback@example.com.

    For more information about sending authorization, see the Amazon SES Developer Guide.

    
    
  • content(EmailContent) / set_content(Option<EmailContent>):
    required: true
    

    An object that contains the body of the message. You can send either a Simple message Raw message or a template Message.

    
    
  • email_tags(MessageTag) / set_email_tags(Option<Vec::<MessageTag>>):
    required: false
    

    A list of tags, in the form of name/value pairs, to apply to an email that you send using the SendEmail operation. Tags correspond to characteristics of the email that you define, so that you can publish email sending events.

    
    
  • configuration_set_name(impl Into<String>) / set_configuration_set_name(Option<String>):
    required: false
    

    The name of the configuration set to use when sending the email.

    
    
  • list_management_options(ListManagementOptions) / set_list_management_options(Option<ListManagementOptions>):
    required: false
    

    An object used to specify a list or topic to which an email belongs, which will be used when a contact chooses to unsubscribe.

    
    
• On success, responds with SendEmailOutput with field(s):
  • message_id(Option<String>):

    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.

• On failure, responds with SdkError<SendEmailError>

impl Client

pub fn tag_resource(&self) -> TagResourceFluentBuilder

Constructs a fluent builder for the TagResource operation.

• The fluent builder is configurable:
  • resource_arn(impl Into<String>) / set_resource_arn(Option<String>):
    required: true
    

    The Amazon Resource Name (ARN) of the resource that you want to add one or more tags to.

    
    
  • tags(Tag) / set_tags(Option<Vec::<Tag>>):
    required: true
    

    A list of the tags that you want to add to the resource. A tag consists of a required tag key (Key) and an associated tag value (Value). The maximum length of a tag key is 128 characters. The maximum length of a tag value is 256 characters.

    
    
• On success, responds with TagResourceOutput
• On failure, responds with SdkError<TagResourceError>

impl Client

pub fn test_render_email_template(&self) -> TestRenderEmailTemplateFluentBuilder

Constructs a fluent builder for the TestRenderEmailTemplate operation.

• The fluent builder is configurable:
  • template_name(impl Into<String>) / set_template_name(Option<String>):
    required: true
    

    The name of the template.

    
    
  • template_data(impl Into<String>) / set_template_data(Option<String>):
    required: true
    

    A list of replacement values to apply to the template. This parameter is a JSON object, typically consisting of key-value pairs in which the keys correspond to replacement tags in the email template.

    
    
• On success, responds with TestRenderEmailTemplateOutput with field(s):
  • rendered_template(String):

    The complete MIME message rendered by applying the data in the TemplateData parameter to the template specified in the TemplateName parameter.

• On failure, responds with SdkError<TestRenderEmailTemplateError>

impl Client

pub fn untag_resource(&self) -> UntagResourceFluentBuilder

Constructs a fluent builder for the UntagResource operation.

• The fluent builder is configurable:
  • resource_arn(impl Into<String>) / set_resource_arn(Option<String>):
    required: true
    

    The Amazon Resource Name (ARN) of the resource that you want to remove one or more tags from.

    
    
  • tag_keys(impl Into<String>) / set_tag_keys(Option<Vec::<String>>):
    required: true
    

    The tags (tag keys) that you want to remove from the resource. When you specify a tag key, the action removes both that key and its associated tag value.

    To remove more than one tag from the resource, append the TagKeys parameter and argument for each additional tag to remove, separated by an ampersand. For example: /v2/email/tags?ResourceArn=ResourceArn&TagKeys=Key1&TagKeys=Key2

    
    
• On success, responds with UntagResourceOutput
• On failure, responds with SdkError<UntagResourceError>

impl Client

pub fn update_configuration_set_event_destination( &self ) -> UpdateConfigurationSetEventDestinationFluentBuilder

Constructs a fluent builder for the UpdateConfigurationSetEventDestination operation.

• The fluent builder is configurable:
  • configuration_set_name(impl Into<String>) / set_configuration_set_name(Option<String>):
    required: true
    

    The name of the configuration set that contains the event destination to modify.

    
    
  • event_destination_name(impl Into<String>) / set_event_destination_name(Option<String>):
    required: true
    

    The name of the event destination.

    
    
  • event_destination(EventDestinationDefinition) / set_event_destination(Option<EventDestinationDefinition>):
    required: true
    

    An object that defines the event destination.

    
    
• On success, responds with UpdateConfigurationSetEventDestinationOutput
• On failure, responds with SdkError<UpdateConfigurationSetEventDestinationError>

impl Client

pub fn update_contact(&self) -> UpdateContactFluentBuilder

Constructs a fluent builder for the UpdateContact operation.

• The fluent builder is configurable:
  • contact_list_name(impl Into<String>) / set_contact_list_name(Option<String>):
    required: true
    

    The name of the contact list.

    
    
  • email_address(impl Into<String>) / set_email_address(Option<String>):
    required: true
    

    The contact’s email address.

    
    
  • topic_preferences(TopicPreference) / set_topic_preferences(Option<Vec::<TopicPreference>>):
    required: false
    

    The contact’s preference for being opted-in to or opted-out of a topic.

    
    
  • unsubscribe_all(bool) / set_unsubscribe_all(Option<bool>):
    required: false
    

    A boolean value status noting if the contact is unsubscribed from all contact list topics.

    
    
  • attributes_data(impl Into<String>) / set_attributes_data(Option<String>):
    required: false
    

    The attribute data attached to a contact.

    
    
• On success, responds with UpdateContactOutput
• On failure, responds with SdkError<UpdateContactError>

impl Client

pub fn update_contact_list(&self) -> UpdateContactListFluentBuilder

Constructs a fluent builder for the UpdateContactList operation.

• The fluent builder is configurable:
  • contact_list_name(impl Into<String>) / set_contact_list_name(Option<String>):
    required: true
    

    The name of the contact list.

    
    
  • topics(Topic) / set_topics(Option<Vec::<Topic>>):
    required: false
    

    An interest group, theme, or label within a list. A contact list can have multiple topics.

    
    
  • description(impl Into<String>) / set_description(Option<String>):
    required: false
    

    A description of what the contact list is about.

    
    
• On success, responds with UpdateContactListOutput
• On failure, responds with SdkError<UpdateContactListError>

impl Client

pub fn update_custom_verification_email_template( &self ) -> UpdateCustomVerificationEmailTemplateFluentBuilder

Constructs a fluent builder for the UpdateCustomVerificationEmailTemplate operation.

• The fluent builder is configurable:
  • template_name(impl Into<String>) / set_template_name(Option<String>):
    required: true
    

    The name of the custom verification email template that you want to update.

    
    
  • from_email_address(impl Into<String>) / set_from_email_address(Option<String>):
    required: true
    

    The email address that the custom verification email is sent from.

    
    
  • template_subject(impl Into<String>) / set_template_subject(Option<String>):
    required: true
    

    The subject line of the custom verification email.

    
    
  • template_content(impl Into<String>) / set_template_content(Option<String>):
    required: true
    

    The content of the custom verification email. The total size of the email must be less than 10 MB. The message body may contain HTML, with some limitations. For more information, see Custom verification email frequently asked questions in the Amazon SES Developer Guide.

    
    
  • success_redirection_url(impl Into<String>) / set_success_redirection_url(Option<String>):
    required: true
    

    The URL that the recipient of the verification email is sent to if his or her address is successfully verified.

    
    
  • failure_redirection_url(impl Into<String>) / set_failure_redirection_url(Option<String>):
    required: true
    

    The URL that the recipient of the verification email is sent to if his or her address is not successfully verified.

    
    
• On success, responds with UpdateCustomVerificationEmailTemplateOutput
• On failure, responds with SdkError<UpdateCustomVerificationEmailTemplateError>

impl Client

pub fn update_email_identity_policy( &self ) -> UpdateEmailIdentityPolicyFluentBuilder

Constructs a fluent builder for the UpdateEmailIdentityPolicy operation.

• The fluent builder is configurable:
  • email_identity(impl Into<String>) / set_email_identity(Option<String>):
    required: true
    

    The email identity.

    
    
  • policy_name(impl Into<String>) / set_policy_name(Option<String>):
    required: true
    

    The name of the policy.

    The policy name cannot exceed 64 characters and can only include alphanumeric characters, dashes, and underscores.

    
    
  • policy(impl Into<String>) / set_policy(Option<String>):
    required: true
    

    The text of the policy in JSON format. The policy cannot exceed 4 KB.

    For information about the syntax of sending authorization policies, see the Amazon SES Developer Guide.

    
    
• On success, responds with UpdateEmailIdentityPolicyOutput
• On failure, responds with SdkError<UpdateEmailIdentityPolicyError>

impl Client

pub fn update_email_template(&self) -> UpdateEmailTemplateFluentBuilder

Constructs a fluent builder for the UpdateEmailTemplate operation.

• The fluent builder is configurable:
  • template_name(impl Into<String>) / set_template_name(Option<String>):
    required: true
    

    The name of the template.

    
    
  • template_content(EmailTemplateContent) / set_template_content(Option<EmailTemplateContent>):
    required: true
    

    The content of the email template, composed of a subject line, an HTML part, and a text-only part.

    
    
• On success, responds with UpdateEmailTemplateOutput
• On failure, responds with SdkError<UpdateEmailTemplateError>

impl Client

pub fn from_conf(conf: Config) -> Self

Creates a new client from the service Config.

Panics

This method will panic in the following cases:

• Retries or timeouts are enabled without a sleep_impl configured.
• Identity caching is enabled without a sleep_impl and time_source configured.
• No behavior_version is provided.

The panic message for each of these will have instructions on how to resolve them.

pub fn config(&self) -> &Config

Returns the client’s configuration.

impl Client

pub fn new(sdk_config: &SdkConfig) -> Self

Creates a new client from an SDK Config.

Panics

• This method will panic if the sdk_config is missing an async sleep implementation. If you experience this panic, set the sleep_impl on the Config passed into this function to fix it.
• This method will panic if the sdk_config is missing an HTTP connector. If you experience this panic, set the http_connector on the Config passed into this function to fix it.
• This method will panic if no BehaviorVersion is provided. If you experience this panic, set behavior_version on the Config or enable the behavior-version-latest Cargo feature.

Trait Implementations

impl Clone for Client

fn clone(&self) -> Client

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for Client

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.