# WARNING: DO NOT EDIT, AUTO-GENERATED CODE!
# See https://github.com/aws-beam/aws-codegen for more details.
defmodule AWS.SESv2 do
@moduledoc """
Amazon SES API v2
[Amazon SES](http://aws.amazon.com/ses) is an Amazon Web Services service that you can use to send email messages to your customers.
If you're new to Amazon SES API v2, you might find it helpful to review the
[Amazon Simple Email Service Developer
Guide](https://docs.aws.amazon.com/ses/latest/DeveloperGuide/). The *Amazon SES
Developer Guide* provides information
and code samples that demonstrate how to use Amazon SES API v2 features
programmatically.
"""
alias AWS.Client
alias AWS.Request
@typedoc """
## Example:
create_custom_verification_email_template_response() :: %{}
"""
@type create_custom_verification_email_template_response() :: %{}
@typedoc """
## Example:
delete_multi_region_endpoint_request() :: %{}
"""
@type delete_multi_region_endpoint_request() :: %{}
@typedoc """
## Example:
put_configuration_set_tracking_options_response() :: %{}
"""
@type put_configuration_set_tracking_options_response() :: %{}
@typedoc """
## Example:
tracking_options() :: %{
"CustomRedirectDomain" => String.t() | atom(),
"HttpsPolicy" => list(any())
}
"""
@type tracking_options() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
create_import_job_response() :: %{
"JobId" => String.t() | atom()
}
"""
@type create_import_job_response() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
get_email_identity_response() :: %{
"ConfigurationSetName" => String.t() | atom(),
"DkimAttributes" => dkim_attributes(),
"FeedbackForwardingStatus" => boolean(),
"IdentityType" => list(any()),
"MailFromAttributes" => mail_from_attributes(),
"Policies" => map(),
"Tags" => list(tag()),
"VerificationInfo" => verification_info(),
"VerificationStatus" => list(any()),
"VerifiedForSendingStatus" => boolean()
}
"""
@type get_email_identity_response() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
dkim_signing_attributes() :: %{
"DomainSigningAttributesOrigin" => list(any()),
"DomainSigningPrivateKey" => String.t() | atom(),
"DomainSigningSelector" => String.t() | atom(),
"NextSigningKeyLength" => list(any())
}
"""
@type dkim_signing_attributes() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
tenant_resource() :: %{
"ResourceArn" => String.t() | atom(),
"ResourceType" => list(any())
}
"""
@type tenant_resource() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
dashboard_options() :: %{
"EngagementMetrics" => list(any())
}
"""
@type dashboard_options() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
put_email_identity_dkim_attributes_response() :: %{}
"""
@type put_email_identity_dkim_attributes_response() :: %{}
@typedoc """
## Example:
delete_configuration_set_response() :: %{}
"""
@type delete_configuration_set_response() :: %{}
@typedoc """
## Example:
put_account_suppression_attributes_response() :: %{}
"""
@type put_account_suppression_attributes_response() :: %{}
@typedoc """
## Example:
update_email_identity_policy_response() :: %{}
"""
@type update_email_identity_policy_response() :: %{}
@typedoc """
## Example:
put_configuration_set_archiving_options_request() :: %{
optional("ArchiveArn") => String.t() | atom()
}
"""
@type put_configuration_set_archiving_options_request() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
list_deliverability_test_reports_request() :: %{
optional("NextToken") => String.t() | atom(),
optional("PageSize") => integer()
}
"""
@type list_deliverability_test_reports_request() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
get_suppressed_destination_request() :: %{}
"""
@type get_suppressed_destination_request() :: %{}
@typedoc """
## Example:
list_export_jobs_request() :: %{
optional("ExportSourceType") => list(any()),
optional("JobStatus") => list(any()),
optional("NextToken") => String.t() | atom(),
optional("PageSize") => integer()
}
"""
@type list_export_jobs_request() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
tag_resource_request() :: %{
required("ResourceArn") => String.t() | atom(),
required("Tags") => list(tag())
}
"""
@type tag_resource_request() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
create_import_job_request() :: %{
required("ImportDataSource") => import_data_source(),
required("ImportDestination") => import_destination()
}
"""
@type create_import_job_request() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
suppression_attributes() :: %{
"SuppressedReasons" => list(list(any())())
}
"""
@type suppression_attributes() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
update_reputation_entity_policy_request() :: %{
required("ReputationEntityPolicy") => String.t() | atom()
}
"""
@type update_reputation_entity_policy_request() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
put_account_sending_attributes_request() :: %{
optional("SendingEnabled") => boolean()
}
"""
@type put_account_sending_attributes_request() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
get_account_response() :: %{
"DedicatedIpAutoWarmupEnabled" => boolean(),
"Details" => account_details(),
"EnforcementStatus" => String.t() | atom(),
"ProductionAccessEnabled" => boolean(),
"SendQuota" => send_quota(),
"SendingEnabled" => boolean(),
"SuppressionAttributes" => suppression_attributes(),
"VdmAttributes" => vdm_attributes()
}
"""
@type get_account_response() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
create_tenant_response() :: %{
"CreatedTimestamp" => non_neg_integer(),
"SendingStatus" => list(any()),
"Tags" => list(tag()),
"TenantArn" => String.t() | atom(),
"TenantId" => String.t() | atom(),
"TenantName" => String.t() | atom()
}
"""
@type create_tenant_response() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
delete_contact_request() :: %{}
"""
@type delete_contact_request() :: %{}
@typedoc """
## Example:
get_deliverability_test_report_request() :: %{}
"""
@type get_deliverability_test_report_request() :: %{}
@typedoc """
## Example:
get_contact_list_response() :: %{
"ContactListName" => String.t() | atom(),
"CreatedTimestamp" => non_neg_integer(),
"Description" => String.t() | atom(),
"LastUpdatedTimestamp" => non_neg_integer(),
"Tags" => list(tag()),
"Topics" => list(topic())
}
"""
@type get_contact_list_response() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
volume_statistics() :: %{
"InboxRawCount" => float(),
"ProjectedInbox" => float(),
"ProjectedSpam" => float(),
"SpamRawCount" => float()
}
"""
@type volume_statistics() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
delete_contact_list_response() :: %{}
"""
@type delete_contact_list_response() :: %{}
@typedoc """
## Example:
list_email_identities_response() :: %{
"EmailIdentities" => list(identity_info()),
"NextToken" => String.t() | atom()
}
"""
@type list_email_identities_response() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
update_email_template_request() :: %{
required("TemplateContent") => email_template_content()
}
"""
@type update_email_template_request() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
create_dedicated_ip_pool_response() :: %{}
"""
@type create_dedicated_ip_pool_response() :: %{}
@typedoc """
## Example:
put_configuration_set_reputation_options_response() :: %{}
"""
@type put_configuration_set_reputation_options_response() :: %{}
@typedoc """
## Example:
cancel_export_job_response() :: %{}
"""
@type cancel_export_job_response() :: %{}
@typedoc """
## Example:
delete_tenant_resource_association_response() :: %{}
"""
@type delete_tenant_resource_association_response() :: %{}
@typedoc """
## Example:
create_email_identity_policy_request() :: %{
required("Policy") => String.t() | atom()
}
"""
@type create_email_identity_policy_request() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
list_contacts_filter() :: %{
"FilteredStatus" => list(any()),
"TopicFilter" => topic_filter()
}
"""
@type list_contacts_filter() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
untag_resource_response() :: %{}
"""
@type untag_resource_response() :: %{}
@typedoc """
## Example:
list_reputation_entities_request() :: %{
optional("Filter") => map(),
optional("NextToken") => String.t() | atom(),
optional("PageSize") => integer()
}
"""
@type list_reputation_entities_request() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
put_email_identity_feedback_attributes_request() :: %{
optional("EmailForwardingEnabled") => boolean()
}
"""
@type put_email_identity_feedback_attributes_request() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
isp_placement() :: %{
"IspName" => String.t() | atom(),
"PlacementStatistics" => placement_statistics()
}
"""
@type isp_placement() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
list_tenants_request() :: %{
optional("NextToken") => String.t() | atom(),
optional("PageSize") => integer()
}
"""
@type list_tenants_request() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
event_details() :: %{
"Bounce" => bounce(),
"Complaint" => complaint()
}
"""
@type event_details() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
email_template_content() :: %{
"Html" => String.t() | atom(),
"Subject" => String.t() | atom(),
"Text" => String.t() | atom()
}
"""
@type email_template_content() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
list_contact_lists_request() :: %{
optional("NextToken") => String.t() | atom(),
optional("PageSize") => integer()
}
"""
@type list_contact_lists_request() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
contact_list_destination() :: %{
"ContactListImportAction" => list(any()),
"ContactListName" => String.t() | atom()
}
"""
@type contact_list_destination() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
put_configuration_set_vdm_options_request() :: %{
optional("VdmOptions") => vdm_options()
}
"""
@type put_configuration_set_vdm_options_request() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
list_deliverability_test_reports_response() :: %{
"DeliverabilityTestReports" => list(deliverability_test_report()),
"NextToken" => String.t() | atom()
}
"""
@type list_deliverability_test_reports_response() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
kinesis_firehose_destination() :: %{
"DeliveryStreamArn" => String.t() | atom(),
"IamRoleArn" => String.t() | atom()
}
"""
@type kinesis_firehose_destination() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
vdm_options() :: %{
"DashboardOptions" => dashboard_options(),
"GuardianOptions" => guardian_options()
}
"""
@type vdm_options() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
already_exists_exception() :: %{
"message" => String.t() | atom()
}
"""
@type already_exists_exception() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
put_account_dedicated_ip_warmup_attributes_response() :: %{}
"""
@type put_account_dedicated_ip_warmup_attributes_response() :: %{}
@typedoc """
## Example:
update_contact_list_response() :: %{}
"""
@type update_contact_list_response() :: %{}
@typedoc """
## Example:
verification_info() :: %{
"ErrorType" => list(any()),
"LastCheckedTimestamp" => non_neg_integer(),
"LastSuccessTimestamp" => non_neg_integer(),
"SOARecord" => s_o_a_record()
}
"""
@type verification_info() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
create_export_job_response() :: %{
"JobId" => String.t() | atom()
}
"""
@type create_export_job_response() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
message_insights_data_source() :: %{
"EndDate" => non_neg_integer(),
"Exclude" => message_insights_filters(),
"Include" => message_insights_filters(),
"MaxResults" => integer(),
"StartDate" => non_neg_integer()
}
"""
@type message_insights_data_source() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
suppressed_destination_summary() :: %{
"EmailAddress" => String.t() | atom(),
"LastUpdateTime" => non_neg_integer(),
"Reason" => list(any())
}
"""
@type suppressed_destination_summary() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
route_details() :: %{
"Region" => String.t() | atom()
}
"""
@type route_details() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
delete_tenant_request() :: %{
required("TenantName") => String.t() | atom()
}
"""
@type delete_tenant_request() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
delete_email_identity_policy_response() :: %{}
"""
@type delete_email_identity_policy_response() :: %{}
@typedoc """
## Example:
list_multi_region_endpoints_request() :: %{
optional("NextToken") => String.t() | atom(),
optional("PageSize") => integer()
}
"""
@type list_multi_region_endpoints_request() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
send_quota() :: %{
"Max24HourSend" => float(),
"MaxSendRate" => float(),
"SentLast24Hours" => float()
}
"""
@type send_quota() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
get_custom_verification_email_template_response() :: %{
"FailureRedirectionURL" => String.t() | atom(),
"FromEmailAddress" => String.t() | atom(),
"SuccessRedirectionURL" => String.t() | atom(),
"TemplateContent" => String.t() | atom(),
"TemplateName" => String.t() | atom(),
"TemplateSubject" => String.t() | atom()
}
"""
@type get_custom_verification_email_template_response() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
dkim_attributes() :: %{
"CurrentSigningKeyLength" => list(any()),
"LastKeyGenerationTimestamp" => non_neg_integer(),
"NextSigningKeyLength" => list(any()),
"SigningAttributesOrigin" => list(any()),
"SigningEnabled" => boolean(),
"Status" => list(any()),
"Tokens" => list(String.t() | atom())
}
"""
@type dkim_attributes() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
get_email_identity_policies_response() :: %{
"Policies" => map()
}
"""
@type get_email_identity_policies_response() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
put_dedicated_ip_pool_scaling_attributes_request() :: %{
required("ScalingMode") => list(any())
}
"""
@type put_dedicated_ip_pool_scaling_attributes_request() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
create_email_identity_response() :: %{
"DkimAttributes" => dkim_attributes(),
"IdentityType" => list(any()),
"VerifiedForSendingStatus" => boolean()
}
"""
@type create_email_identity_response() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
list_email_templates_request() :: %{
optional("NextToken") => String.t() | atom(),
optional("PageSize") => integer()
}
"""
@type list_email_templates_request() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
test_render_email_template_request() :: %{
required("TemplateData") => String.t() | atom()
}
"""
@type test_render_email_template_request() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
sending_paused_exception() :: %{
"message" => String.t() | atom()
}
"""
@type sending_paused_exception() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
put_deliverability_dashboard_option_request() :: %{
optional("SubscribedDomains") => list(domain_deliverability_tracking_option()),
required("DashboardEnabled") => boolean()
}
"""
@type put_deliverability_dashboard_option_request() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
attachment() :: %{
"ContentDescription" => String.t() | atom(),
"ContentDisposition" => list(any()),
"ContentId" => String.t() | atom(),
"ContentTransferEncoding" => list(any()),
"ContentType" => String.t() | atom(),
"FileName" => String.t() | atom(),
"RawContent" => binary()
}
"""
@type attachment() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
put_account_details_request() :: %{
optional("AdditionalContactEmailAddresses") => list(String.t() | atom()),
optional("ContactLanguage") => list(any()),
optional("ProductionAccessEnabled") => boolean(),
optional("UseCaseDescription") => String.t() | atom(),
required("MailType") => list(any()),
required("WebsiteURL") => String.t() | atom()
}
"""
@type put_account_details_request() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
send_bulk_email_response() :: %{
"BulkEmailEntryResults" => list(bulk_email_entry_result())
}
"""
@type send_bulk_email_response() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
get_custom_verification_email_template_request() :: %{}
"""
@type get_custom_verification_email_template_request() :: %{}
@typedoc """
## Example:
put_configuration_set_delivery_options_response() :: %{}
"""
@type put_configuration_set_delivery_options_response() :: %{}
@typedoc """
## Example:
account_suspended_exception() :: %{
"message" => String.t() | atom()
}
"""
@type account_suspended_exception() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
resource_tenant_metadata() :: %{
"AssociatedTimestamp" => non_neg_integer(),
"ResourceArn" => String.t() | atom(),
"TenantId" => String.t() | atom(),
"TenantName" => String.t() | atom()
}
"""
@type resource_tenant_metadata() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
email_content() :: %{
"Raw" => raw_message(),
"Simple" => message(),
"Template" => template()
}
"""
@type email_content() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
get_deliverability_dashboard_options_response() :: %{
"AccountStatus" => list(any()),
"ActiveSubscribedDomains" => list(domain_deliverability_tracking_option()),
"DashboardEnabled" => boolean(),
"PendingExpirationSubscribedDomains" => list(domain_deliverability_tracking_option()),
"SubscriptionExpiryDate" => non_neg_integer()
}
"""
@type get_deliverability_dashboard_options_response() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
get_domain_deliverability_campaign_request() :: %{}
"""
@type get_domain_deliverability_campaign_request() :: %{}
@typedoc """
## Example:
delete_configuration_set_event_destination_response() :: %{}
"""
@type delete_configuration_set_event_destination_response() :: %{}
@typedoc """
## Example:
list_multi_region_endpoints_response() :: %{
"MultiRegionEndpoints" => list(multi_region_endpoint()),
"NextToken" => String.t() | atom()
}
"""
@type list_multi_region_endpoints_response() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
put_account_vdm_attributes_response() :: %{}
"""
@type put_account_vdm_attributes_response() :: %{}
@typedoc """
## Example:
tenant_info() :: %{
"CreatedTimestamp" => non_neg_integer(),
"TenantArn" => String.t() | atom(),
"TenantId" => String.t() | atom(),
"TenantName" => String.t() | atom()
}
"""
@type tenant_info() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
delete_email_identity_request() :: %{}
"""
@type delete_email_identity_request() :: %{}
@typedoc """
## Example:
s_o_a_record() :: %{
"AdminEmail" => String.t() | atom(),
"PrimaryNameServer" => String.t() | atom(),
"SerialNumber" => float()
}
"""
@type s_o_a_record() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
internal_service_error_exception() :: %{
"message" => String.t() | atom()
}
"""
@type internal_service_error_exception() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
cloud_watch_dimension_configuration() :: %{
"DefaultDimensionValue" => String.t() | atom(),
"DimensionName" => String.t() | atom(),
"DimensionValueSource" => list(any())
}
"""
@type cloud_watch_dimension_configuration() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
put_configuration_set_archiving_options_response() :: %{}
"""
@type put_configuration_set_archiving_options_response() :: %{}
@typedoc """
## Example:
delete_custom_verification_email_template_response() :: %{}
"""
@type delete_custom_verification_email_template_response() :: %{}
@typedoc """
## Example:
put_suppressed_destination_request() :: %{
required("EmailAddress") => String.t() | atom(),
required("Reason") => list(any())
}
"""
@type put_suppressed_destination_request() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
untag_resource_request() :: %{
required("ResourceArn") => String.t() | atom(),
required("TagKeys") => list(String.t() | atom())
}
"""
@type untag_resource_request() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
too_many_requests_exception() :: %{
"message" => String.t() | atom()
}
"""
@type too_many_requests_exception() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
create_deliverability_test_report_response() :: %{
"DeliverabilityTestStatus" => list(any()),
"ReportId" => String.t() | atom()
}
"""
@type create_deliverability_test_report_response() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
event_destination_definition() :: %{
"CloudWatchDestination" => cloud_watch_destination(),
"Enabled" => boolean(),
"EventBridgeDestination" => event_bridge_destination(),
"KinesisFirehoseDestination" => kinesis_firehose_destination(),
"MatchingEventTypes" => list(list(any())()),
"PinpointDestination" => pinpoint_destination(),
"SnsDestination" => sns_destination()
}
"""
@type event_destination_definition() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
list_suppressed_destinations_response() :: %{
"NextToken" => String.t() | atom(),
"SuppressedDestinationSummaries" => list(suppressed_destination_summary())
}
"""
@type list_suppressed_destinations_response() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
list_domain_deliverability_campaigns_response() :: %{
"DomainDeliverabilityCampaigns" => list(domain_deliverability_campaign()),
"NextToken" => String.t() | atom()
}
"""
@type list_domain_deliverability_campaigns_response() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
delete_configuration_set_request() :: %{}
"""
@type delete_configuration_set_request() :: %{}
@typedoc """
## Example:
put_account_suppression_attributes_request() :: %{
optional("SuppressedReasons") => list(list(any())())
}
"""
@type put_account_suppression_attributes_request() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
get_tenant_response() :: %{
"Tenant" => tenant()
}
"""
@type get_tenant_response() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
send_email_response() :: %{
"MessageId" => String.t() | atom()
}
"""
@type send_email_response() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
list_suppressed_destinations_request() :: %{
optional("EndDate") => non_neg_integer(),
optional("NextToken") => String.t() | atom(),
optional("PageSize") => integer(),
optional("Reasons") => list(list(any())()),
optional("StartDate") => non_neg_integer()
}
"""
@type list_suppressed_destinations_request() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
delete_dedicated_ip_pool_request() :: %{}
"""
@type delete_dedicated_ip_pool_request() :: %{}
@typedoc """
## Example:
delete_email_template_request() :: %{}
"""
@type delete_email_template_request() :: %{}
@typedoc """
## Example:
cloud_watch_destination() :: %{
"DimensionConfigurations" => list(cloud_watch_dimension_configuration())
}
"""
@type cloud_watch_destination() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
blacklist_entry() :: %{
"Description" => String.t() | atom(),
"ListingTime" => non_neg_integer(),
"RblName" => String.t() | atom()
}
"""
@type blacklist_entry() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
put_configuration_set_suppression_options_request() :: %{
optional("SuppressedReasons") => list(list(any())())
}
"""
@type put_configuration_set_suppression_options_request() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
mail_from_domain_not_verified_exception() :: %{
"message" => String.t() | atom()
}
"""
@type mail_from_domain_not_verified_exception() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
overall_volume() :: %{
"DomainIspPlacements" => list(domain_isp_placement()),
"ReadRatePercent" => float(),
"VolumeStatistics" => volume_statistics()
}
"""
@type overall_volume() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
get_dedicated_ip_pool_request() :: %{}
"""
@type get_dedicated_ip_pool_request() :: %{}
@typedoc """
## Example:
domain_isp_placement() :: %{
"InboxPercentage" => float(),
"InboxRawCount" => float(),
"IspName" => String.t() | atom(),
"SpamPercentage" => float(),
"SpamRawCount" => float()
}
"""
@type domain_isp_placement() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
create_email_template_request() :: %{
required("TemplateContent") => email_template_content(),
required("TemplateName") => String.t() | atom()
}
"""
@type create_email_template_request() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
create_contact_response() :: %{}
"""
@type create_contact_response() :: %{}
@typedoc """
## Example:
reputation_entity() :: %{
"AwsSesManagedStatus" => status_record(),
"CustomerManagedStatus" => status_record(),
"ReputationEntityReference" => String.t() | atom(),
"ReputationEntityType" => list(any()),
"ReputationImpact" => list(any()),
"ReputationManagementPolicy" => String.t() | atom(),
"SendingStatusAggregate" => list(any())
}
"""
@type reputation_entity() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
dedicated_ip() :: %{
"Ip" => String.t() | atom(),
"PoolName" => String.t() | atom(),
"WarmupPercentage" => integer(),
"WarmupStatus" => list(any())
}
"""
@type dedicated_ip() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
create_email_identity_policy_response() :: %{}
"""
@type create_email_identity_policy_response() :: %{}
@typedoc """
## Example:
email_insights() :: %{
"Destination" => String.t() | atom(),
"Events" => list(insights_event()),
"Isp" => String.t() | atom()
}
"""
@type email_insights() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
get_blacklist_reports_request() :: %{
required("BlacklistItemNames") => list(String.t() | atom())
}
"""
@type get_blacklist_reports_request() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
put_email_identity_configuration_set_attributes_response() :: %{}
"""
@type put_email_identity_configuration_set_attributes_response() :: %{}
@typedoc """
## Example:
message_insights_filters() :: %{
"Destination" => list(String.t() | atom()),
"FromEmailAddress" => list(String.t() | atom()),
"Isp" => list(String.t() | atom()),
"LastDeliveryEvent" => list(list(any())()),
"LastEngagementEvent" => list(list(any())()),
"Subject" => list(String.t() | atom())
}
"""
@type message_insights_filters() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
mail_from_attributes() :: %{
"BehaviorOnMxFailure" => list(any()),
"MailFromDomain" => String.t() | atom(),
"MailFromDomainStatus" => list(any())
}
"""
@type mail_from_attributes() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
tenant() :: %{
"CreatedTimestamp" => non_neg_integer(),
"SendingStatus" => list(any()),
"Tags" => list(tag()),
"TenantArn" => String.t() | atom(),
"TenantId" => String.t() | atom(),
"TenantName" => String.t() | atom()
}
"""
@type tenant() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
create_configuration_set_response() :: %{}
"""
@type create_configuration_set_response() :: %{}
@typedoc """
## Example:
list_custom_verification_email_templates_request() :: %{
optional("NextToken") => String.t() | atom(),
optional("PageSize") => integer()
}
"""
@type list_custom_verification_email_templates_request() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
reputation_options() :: %{
"LastFreshStart" => non_neg_integer(),
"ReputationMetricsEnabled" => boolean()
}
"""
@type reputation_options() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
put_deliverability_dashboard_option_response() :: %{}
"""
@type put_deliverability_dashboard_option_response() :: %{}
@typedoc """
## Example:
list_resource_tenants_request() :: %{
optional("NextToken") => String.t() | atom(),
optional("PageSize") => integer(),
required("ResourceArn") => String.t() | atom()
}
"""
@type list_resource_tenants_request() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
get_reputation_entity_response() :: %{
"ReputationEntity" => reputation_entity()
}
"""
@type get_reputation_entity_response() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
list_import_jobs_request() :: %{
optional("ImportDestinationType") => list(any()),
optional("NextToken") => String.t() | atom(),
optional("PageSize") => integer()
}
"""
@type list_import_jobs_request() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
delete_suppressed_destination_response() :: %{}
"""
@type delete_suppressed_destination_response() :: %{}
@typedoc """
## Example:
create_email_identity_request() :: %{
optional("ConfigurationSetName") => String.t() | atom(),
optional("DkimSigningAttributes") => dkim_signing_attributes(),
optional("Tags") => list(tag()),
required("EmailIdentity") => String.t() | atom()
}
"""
@type create_email_identity_request() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
inbox_placement_tracking_option() :: %{
"Global" => boolean(),
"TrackedIsps" => list(String.t() | atom())
}
"""
@type inbox_placement_tracking_option() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
put_configuration_set_suppression_options_response() :: %{}
"""
@type put_configuration_set_suppression_options_response() :: %{}
@typedoc """
## Example:
conflict_exception() :: %{
"message" => String.t() | atom()
}
"""
@type conflict_exception() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
get_export_job_request() :: %{}
"""
@type get_export_job_request() :: %{}
@typedoc """
## Example:
message_header() :: %{
"Name" => String.t() | atom(),
"Value" => String.t() | atom()
}
"""
@type message_header() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
batch_get_metric_data_query() :: %{
"Dimensions" => map(),
"EndDate" => non_neg_integer(),
"Id" => String.t() | atom(),
"Metric" => list(any()),
"Namespace" => list(any()),
"StartDate" => non_neg_integer()
}
"""
@type batch_get_metric_data_query() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
get_message_insights_request() :: %{}
"""
@type get_message_insights_request() :: %{}
@typedoc """
## Example:
delete_suppressed_destination_request() :: %{}
"""
@type delete_suppressed_destination_request() :: %{}
@typedoc """
## Example:
export_data_source() :: %{
"MessageInsightsDataSource" => message_insights_data_source(),
"MetricsDataSource" => metrics_data_source()
}
"""
@type export_data_source() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
metric_data_error() :: %{
"Code" => list(any()),
"Id" => String.t() | atom(),
"Message" => String.t() | atom()
}
"""
@type metric_data_error() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
tag() :: %{
"Key" => String.t() | atom(),
"Value" => String.t() | atom()
}
"""
@type tag() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
list_resource_tenants_response() :: %{
"NextToken" => String.t() | atom(),
"ResourceTenants" => list(resource_tenant_metadata())
}
"""
@type list_resource_tenants_response() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
get_export_job_response() :: %{
"CompletedTimestamp" => non_neg_integer(),
"CreatedTimestamp" => non_neg_integer(),
"ExportDataSource" => export_data_source(),
"ExportDestination" => export_destination(),
"ExportSourceType" => list(any()),
"FailureInfo" => failure_info(),
"JobId" => String.t() | atom(),
"JobStatus" => list(any()),
"Statistics" => export_statistics()
}
"""
@type get_export_job_response() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
event_destination() :: %{
"CloudWatchDestination" => cloud_watch_destination(),
"Enabled" => boolean(),
"EventBridgeDestination" => event_bridge_destination(),
"KinesisFirehoseDestination" => kinesis_firehose_destination(),
"MatchingEventTypes" => list(list(any())()),
"Name" => String.t() | atom(),
"PinpointDestination" => pinpoint_destination(),
"SnsDestination" => sns_destination()
}
"""
@type event_destination() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
update_contact_response() :: %{}
"""
@type update_contact_response() :: %{}
@typedoc """
## Example:
guardian_attributes() :: %{
"OptimizedSharedDelivery" => list(any())
}
"""
@type guardian_attributes() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
update_configuration_set_event_destination_request() :: %{
required("EventDestination") => event_destination_definition()
}
"""
@type update_configuration_set_event_destination_request() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
message_tag() :: %{
"Name" => String.t() | atom(),
"Value" => String.t() | atom()
}
"""
@type message_tag() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
list_domain_deliverability_campaigns_request() :: %{
optional("NextToken") => String.t() | atom(),
optional("PageSize") => integer(),
required("EndDate") => non_neg_integer(),
required("StartDate") => non_neg_integer()
}
"""
@type list_domain_deliverability_campaigns_request() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
suppression_list_destination() :: %{
"SuppressionListImportAction" => list(any())
}
"""
@type suppression_list_destination() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
get_configuration_set_event_destinations_request() :: %{}
"""
@type get_configuration_set_event_destinations_request() :: %{}
@typedoc """
## Example:
multi_region_endpoint() :: %{
"CreatedTimestamp" => non_neg_integer(),
"EndpointId" => String.t() | atom(),
"EndpointName" => String.t() | atom(),
"LastUpdatedTimestamp" => non_neg_integer(),
"Regions" => list(String.t() | atom()),
"Status" => list(any())
}
"""
@type multi_region_endpoint() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
put_configuration_set_vdm_options_response() :: %{}
"""
@type put_configuration_set_vdm_options_response() :: %{}
@typedoc """
## Example:
get_domain_statistics_report_request() :: %{
required("EndDate") => non_neg_integer(),
required("StartDate") => non_neg_integer()
}
"""
@type get_domain_statistics_report_request() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
recommendation() :: %{
"CreatedTimestamp" => non_neg_integer(),
"Description" => String.t() | atom(),
"Impact" => list(any()),
"LastUpdatedTimestamp" => non_neg_integer(),
"ResourceArn" => String.t() | atom(),
"Status" => list(any()),
"Type" => list(any())
}
"""
@type recommendation() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
details() :: %{
"RoutesDetails" => list(route_details())
}
"""
@type details() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
put_account_dedicated_ip_warmup_attributes_request() :: %{
optional("AutoWarmupEnabled") => boolean()
}
"""
@type put_account_dedicated_ip_warmup_attributes_request() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
get_import_job_request() :: %{}
"""
@type get_import_job_request() :: %{}
@typedoc """
## Example:
put_dedicated_ip_in_pool_response() :: %{}
"""
@type put_dedicated_ip_in_pool_response() :: %{}
@typedoc """
## Example:
invalid_next_token_exception() :: %{
"message" => String.t() | atom()
}
"""
@type invalid_next_token_exception() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
topic() :: %{
"DefaultSubscriptionStatus" => list(any()),
"Description" => String.t() | atom(),
"DisplayName" => String.t() | atom(),
"TopicName" => String.t() | atom()
}
"""
@type topic() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
delete_email_template_response() :: %{}
"""
@type delete_email_template_response() :: %{}
@typedoc """
## Example:
update_reputation_entity_policy_response() :: %{}
"""
@type update_reputation_entity_policy_response() :: %{}
@typedoc """
## Example:
account_details() :: %{
"AdditionalContactEmailAddresses" => list(String.t() | atom()),
"ContactLanguage" => list(any()),
"MailType" => list(any()),
"ReviewDetails" => review_details(),
"UseCaseDescription" => String.t() | atom(),
"WebsiteURL" => String.t() | atom()
}
"""
@type account_details() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
not_found_exception() :: %{
"message" => String.t() | atom()
}
"""
@type not_found_exception() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
send_custom_verification_email_response() :: %{
"MessageId" => String.t() | atom()
}
"""
@type send_custom_verification_email_response() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
route() :: %{
"Region" => String.t() | atom()
}
"""
@type route() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
get_multi_region_endpoint_response() :: %{
"CreatedTimestamp" => non_neg_integer(),
"EndpointId" => String.t() | atom(),
"EndpointName" => String.t() | atom(),
"LastUpdatedTimestamp" => non_neg_integer(),
"Routes" => list(route()),
"Status" => list(any())
}
"""
@type get_multi_region_endpoint_response() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
placement_statistics() :: %{
"DkimPercentage" => float(),
"InboxPercentage" => float(),
"MissingPercentage" => float(),
"SpamPercentage" => float(),
"SpfPercentage" => float()
}
"""
@type placement_statistics() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
identity_info() :: %{
"IdentityName" => String.t() | atom(),
"IdentityType" => list(any()),
"SendingEnabled" => boolean(),
"VerificationStatus" => list(any())
}
"""
@type identity_info() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
metrics_data_source() :: %{
"Dimensions" => map(),
"EndDate" => non_neg_integer(),
"Metrics" => list(export_metric()),
"Namespace" => list(any()),
"StartDate" => non_neg_integer()
}
"""
@type metrics_data_source() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
list_management_options() :: %{
"ContactListName" => String.t() | atom(),
"TopicName" => String.t() | atom()
}
"""
@type list_management_options() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
create_custom_verification_email_template_request() :: %{
required("FailureRedirectionURL") => String.t() | atom(),
required("FromEmailAddress") => String.t() | atom(),
required("SuccessRedirectionURL") => String.t() | atom(),
required("TemplateContent") => String.t() | atom(),
required("TemplateName") => String.t() | atom(),
required("TemplateSubject") => String.t() | atom()
}
"""
@type create_custom_verification_email_template_request() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
batch_get_metric_data_request() :: %{
required("Queries") => list(batch_get_metric_data_query())
}
"""
@type batch_get_metric_data_request() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
list_tags_for_resource_response() :: %{
"Tags" => list(tag())
}
"""
@type list_tags_for_resource_response() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
list_configuration_sets_response() :: %{
"ConfigurationSets" => list(String.t() | atom()),
"NextToken" => String.t() | atom()
}
"""
@type list_configuration_sets_response() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
list_dedicated_ip_pools_request() :: %{
optional("NextToken") => String.t() | atom(),
optional("PageSize") => integer()
}
"""
@type list_dedicated_ip_pools_request() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
update_custom_verification_email_template_request() :: %{
required("FailureRedirectionURL") => String.t() | atom(),
required("FromEmailAddress") => String.t() | atom(),
required("SuccessRedirectionURL") => String.t() | atom(),
required("TemplateContent") => String.t() | atom(),
required("TemplateSubject") => String.t() | atom()
}
"""
@type update_custom_verification_email_template_request() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
get_configuration_set_event_destinations_response() :: %{
"EventDestinations" => list(event_destination())
}
"""
@type get_configuration_set_event_destinations_response() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
list_tenant_resources_request() :: %{
optional("Filter") => map(),
optional("NextToken") => String.t() | atom(),
optional("PageSize") => integer(),
required("TenantName") => String.t() | atom()
}
"""
@type list_tenant_resources_request() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
get_domain_deliverability_campaign_response() :: %{
"DomainDeliverabilityCampaign" => domain_deliverability_campaign()
}
"""
@type get_domain_deliverability_campaign_response() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
list_configuration_sets_request() :: %{
optional("NextToken") => String.t() | atom(),
optional("PageSize") => integer()
}
"""
@type list_configuration_sets_request() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
bounce() :: %{
"BounceSubType" => String.t() | atom(),
"BounceType" => list(any()),
"DiagnosticCode" => String.t() | atom()
}
"""
@type bounce() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
get_dedicated_ips_request() :: %{
optional("NextToken") => String.t() | atom(),
optional("PageSize") => integer(),
optional("PoolName") => String.t() | atom()
}
"""
@type get_dedicated_ips_request() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
delete_multi_region_endpoint_response() :: %{
"Status" => list(any())
}
"""
@type delete_multi_region_endpoint_response() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
raw_message() :: %{
"Data" => binary()
}
"""
@type raw_message() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
put_dedicated_ip_in_pool_request() :: %{
required("DestinationPoolName") => String.t() | atom()
}
"""
@type put_dedicated_ip_in_pool_request() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
get_message_insights_response() :: %{
"EmailTags" => list(message_tag()),
"FromEmailAddress" => String.t() | atom(),
"Insights" => list(email_insights()),
"MessageId" => String.t() | atom(),
"Subject" => String.t() | atom()
}
"""
@type get_message_insights_response() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
list_custom_verification_email_templates_response() :: %{
"CustomVerificationEmailTemplates" => list(custom_verification_email_template_metadata()),
"NextToken" => String.t() | atom()
}
"""
@type list_custom_verification_email_templates_response() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
put_email_identity_dkim_attributes_request() :: %{
optional("SigningEnabled") => boolean()
}
"""
@type put_email_identity_dkim_attributes_request() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
delete_custom_verification_email_template_request() :: %{}
"""
@type delete_custom_verification_email_template_request() :: %{}
@typedoc """
## Example:
dashboard_attributes() :: %{
"EngagementMetrics" => list(any())
}
"""
@type dashboard_attributes() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
delete_tenant_resource_association_request() :: %{
required("ResourceArn") => String.t() | atom(),
required("TenantName") => String.t() | atom()
}
"""
@type delete_tenant_resource_association_request() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
put_configuration_set_sending_options_response() :: %{}
"""
@type put_configuration_set_sending_options_response() :: %{}
@typedoc """
## Example:
replacement_email_content() :: %{
"ReplacementTemplate" => replacement_template()
}
"""
@type replacement_email_content() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
create_contact_list_request() :: %{
optional("Description") => String.t() | atom(),
optional("Tags") => list(tag()),
optional("Topics") => list(topic()),
required("ContactListName") => String.t() | atom()
}
"""
@type create_contact_list_request() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
create_multi_region_endpoint_request() :: %{
optional("Tags") => list(tag()),
required("Details") => details(),
required("EndpointName") => String.t() | atom()
}
"""
@type create_multi_region_endpoint_request() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
contact() :: %{
"EmailAddress" => String.t() | atom(),
"LastUpdatedTimestamp" => non_neg_integer(),
"TopicDefaultPreferences" => list(topic_preference()),
"TopicPreferences" => list(topic_preference()),
"UnsubscribeAll" => boolean()
}
"""
@type contact() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
export_job_summary() :: %{
"CompletedTimestamp" => non_neg_integer(),
"CreatedTimestamp" => non_neg_integer(),
"ExportSourceType" => list(any()),
"JobId" => String.t() | atom(),
"JobStatus" => list(any())
}
"""
@type export_job_summary() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
get_suppressed_destination_response() :: %{
"SuppressedDestination" => suppressed_destination()
}
"""
@type get_suppressed_destination_response() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
vdm_attributes() :: %{
"DashboardAttributes" => dashboard_attributes(),
"GuardianAttributes" => guardian_attributes(),
"VdmEnabled" => list(any())
}
"""
@type vdm_attributes() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
export_statistics() :: %{
"ExportedRecordsCount" => integer(),
"ProcessedRecordsCount" => integer()
}
"""
@type export_statistics() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
send_bulk_email_request() :: %{
optional("ConfigurationSetName") => String.t() | atom(),
optional("DefaultEmailTags") => list(message_tag()),
optional("EndpointId") => String.t() | atom(),
optional("FeedbackForwardingEmailAddress") => String.t() | atom(),
optional("FeedbackForwardingEmailAddressIdentityArn") => String.t() | atom(),
optional("FromEmailAddress") => String.t() | atom(),
optional("FromEmailAddressIdentityArn") => String.t() | atom(),
optional("ReplyToAddresses") => list(String.t() | atom()),
optional("TenantName") => String.t() | atom(),
required("BulkEmailEntries") => list(bulk_email_entry()),
required("DefaultContent") => bulk_email_content()
}
"""
@type send_bulk_email_request() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
delete_dedicated_ip_pool_response() :: %{}
"""
@type delete_dedicated_ip_pool_response() :: %{}
@typedoc """
## Example:
suppressed_destination() :: %{
"Attributes" => suppressed_destination_attributes(),
"EmailAddress" => String.t() | atom(),
"LastUpdateTime" => non_neg_integer(),
"Reason" => list(any())
}
"""
@type suppressed_destination() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
insights_event() :: %{
"Details" => event_details(),
"Timestamp" => non_neg_integer(),
"Type" => list(any())
}
"""
@type insights_event() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
create_export_job_request() :: %{
required("ExportDataSource") => export_data_source(),
required("ExportDestination") => export_destination()
}
"""
@type create_export_job_request() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
put_configuration_set_tracking_options_request() :: %{
optional("CustomRedirectDomain") => String.t() | atom(),
optional("HttpsPolicy") => list(any())
}
"""
@type put_configuration_set_tracking_options_request() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
create_dedicated_ip_pool_request() :: %{
optional("ScalingMode") => list(any()),
optional("Tags") => list(tag()),
required("PoolName") => String.t() | atom()
}
"""
@type create_dedicated_ip_pool_request() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
event_bridge_destination() :: %{
"EventBusArn" => String.t() | atom()
}
"""
@type event_bridge_destination() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
send_custom_verification_email_request() :: %{
optional("ConfigurationSetName") => String.t() | atom(),
required("EmailAddress") => String.t() | atom(),
required("TemplateName") => String.t() | atom()
}
"""
@type send_custom_verification_email_request() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
update_reputation_entity_customer_managed_status_response() :: %{}
"""
@type update_reputation_entity_customer_managed_status_response() :: %{}
@typedoc """
## Example:
get_dedicated_ip_response() :: %{
"DedicatedIp" => dedicated_ip()
}
"""
@type get_dedicated_ip_response() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
put_email_identity_dkim_signing_attributes_request() :: %{
optional("SigningAttributes") => dkim_signing_attributes(),
required("SigningAttributesOrigin") => list(any())
}
"""
@type put_email_identity_dkim_signing_attributes_request() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
list_tenant_resources_response() :: %{
"NextToken" => String.t() | atom(),
"TenantResources" => list(tenant_resource())
}
"""
@type list_tenant_resources_response() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
list_tenants_response() :: %{
"NextToken" => String.t() | atom(),
"Tenants" => list(tenant_info())
}
"""
@type list_tenants_response() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
list_import_jobs_response() :: %{
"ImportJobs" => list(import_job_summary()),
"NextToken" => String.t() | atom()
}
"""
@type list_import_jobs_response() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
batch_get_metric_data_response() :: %{
"Errors" => list(metric_data_error()),
"Results" => list(metric_data_result())
}
"""
@type batch_get_metric_data_response() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
update_custom_verification_email_template_response() :: %{}
"""
@type update_custom_verification_email_template_response() :: %{}
@typedoc """
## Example:
delete_configuration_set_event_destination_request() :: %{}
"""
@type delete_configuration_set_event_destination_request() :: %{}
@typedoc """
## Example:
put_dedicated_ip_pool_scaling_attributes_response() :: %{}
"""
@type put_dedicated_ip_pool_scaling_attributes_response() :: %{}
@typedoc """
## Example:
update_reputation_entity_customer_managed_status_request() :: %{
required("SendingStatus") => list(any())
}
"""
@type update_reputation_entity_customer_managed_status_request() :: %{
(String.t() | atom()) => any()
}
@typedoc """
## Example:
get_contact_request() :: %{}
"""
@type get_contact_request() :: %{}
@typedoc """
## Example:
create_configuration_set_event_destination_response() :: %{}
"""
@type create_configuration_set_event_destination_response() :: %{}
@typedoc """
## Example:
import_destination() :: %{
"ContactListDestination" => contact_list_destination(),
"SuppressionListDestination" => suppression_list_destination()
}
"""
@type import_destination() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
list_contacts_request() :: %{
optional("Filter") => list_contacts_filter(),
optional("NextToken") => String.t() | atom(),
optional("PageSize") => integer()
}
"""
@type list_contacts_request() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
bulk_email_content() :: %{
"Template" => template()
}
"""
@type bulk_email_content() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
delete_contact_response() :: %{}
"""
@type delete_contact_response() :: %{}
@typedoc """
## Example:
put_configuration_set_delivery_options_request() :: %{
optional("MaxDeliverySeconds") => float(),
optional("SendingPoolName") => String.t() | atom(),
optional("TlsPolicy") => list(any())
}
"""
@type put_configuration_set_delivery_options_request() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
list_reputation_entities_response() :: %{
"NextToken" => String.t() | atom(),
"ReputationEntities" => list(reputation_entity())
}
"""
@type list_reputation_entities_response() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
put_email_identity_mail_from_attributes_request() :: %{
optional("BehaviorOnMxFailure") => list(any()),
optional("MailFromDomain") => String.t() | atom()
}
"""
@type put_email_identity_mail_from_attributes_request() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
dedicated_ip_pool() :: %{
"PoolName" => String.t() | atom(),
"ScalingMode" => list(any())
}
"""
@type dedicated_ip_pool() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
delete_email_identity_response() :: %{}
"""
@type delete_email_identity_response() :: %{}
@typedoc """
## Example:
get_import_job_response() :: %{
"CompletedTimestamp" => non_neg_integer(),
"CreatedTimestamp" => non_neg_integer(),
"FailedRecordsCount" => integer(),
"FailureInfo" => failure_info(),
"ImportDataSource" => import_data_source(),
"ImportDestination" => import_destination(),
"JobId" => String.t() | atom(),
"JobStatus" => list(any()),
"ProcessedRecordsCount" => integer()
}
"""
@type get_import_job_response() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
create_deliverability_test_report_request() :: %{
optional("ReportName") => String.t() | atom(),
optional("Tags") => list(tag()),
required("Content") => email_content(),
required("FromEmailAddress") => String.t() | atom()
}
"""
@type create_deliverability_test_report_request() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
topic_preference() :: %{
"SubscriptionStatus" => list(any()),
"TopicName" => String.t() | atom()
}
"""
@type topic_preference() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
list_contacts_response() :: %{
"Contacts" => list(contact()),
"NextToken" => String.t() | atom()
}
"""
@type list_contacts_response() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
create_contact_list_response() :: %{}
"""
@type create_contact_list_response() :: %{}
@typedoc """
## Example:
archiving_options() :: %{
"ArchiveArn" => String.t() | atom()
}
"""
@type archiving_options() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
suppression_options() :: %{
"SuppressedReasons" => list(list(any())())
}
"""
@type suppression_options() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
daily_volume() :: %{
"DomainIspPlacements" => list(domain_isp_placement()),
"StartDate" => non_neg_integer(),
"VolumeStatistics" => volume_statistics()
}
"""
@type daily_volume() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
status_record() :: %{
"Cause" => String.t() | atom(),
"LastUpdatedTimestamp" => non_neg_integer(),
"Status" => list(any())
}
"""
@type status_record() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
tag_resource_response() :: %{}
"""
@type tag_resource_response() :: %{}
@typedoc """
## Example:
import_job_summary() :: %{
"CreatedTimestamp" => non_neg_integer(),
"FailedRecordsCount" => integer(),
"ImportDestination" => import_destination(),
"JobId" => String.t() | atom(),
"JobStatus" => list(any()),
"ProcessedRecordsCount" => integer()
}
"""
@type import_job_summary() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
get_reputation_entity_request() :: %{}
"""
@type get_reputation_entity_request() :: %{}
@typedoc """
## Example:
create_multi_region_endpoint_response() :: %{
"EndpointId" => String.t() | atom(),
"Status" => list(any())
}
"""
@type create_multi_region_endpoint_response() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
sending_options() :: %{
"SendingEnabled" => boolean()
}
"""
@type sending_options() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
delete_tenant_response() :: %{}
"""
@type delete_tenant_response() :: %{}
@typedoc """
## Example:
delete_email_identity_policy_request() :: %{}
"""
@type delete_email_identity_policy_request() :: %{}
@typedoc """
## Example:
concurrent_modification_exception() :: %{
"message" => String.t() | atom()
}
"""
@type concurrent_modification_exception() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
create_tenant_resource_association_response() :: %{}
"""
@type create_tenant_resource_association_response() :: %{}
@typedoc """
## Example:
list_email_templates_response() :: %{
"NextToken" => String.t() | atom(),
"TemplatesMetadata" => list(email_template_metadata())
}
"""
@type list_email_templates_response() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
get_blacklist_reports_response() :: %{
"BlacklistReport" => map()
}
"""
@type get_blacklist_reports_response() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
update_contact_request() :: %{
optional("AttributesData") => String.t() | atom(),
optional("TopicPreferences") => list(topic_preference()),
optional("UnsubscribeAll") => boolean()
}
"""
@type update_contact_request() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
put_email_identity_dkim_signing_attributes_response() :: %{
"DkimStatus" => list(any()),
"DkimTokens" => list(String.t() | atom())
}
"""
@type put_email_identity_dkim_signing_attributes_response() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
cancel_export_job_request() :: %{}
"""
@type cancel_export_job_request() :: %{}
@typedoc """
## Example:
create_tenant_resource_association_request() :: %{
required("ResourceArn") => String.t() | atom(),
required("TenantName") => String.t() | atom()
}
"""
@type create_tenant_resource_association_request() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
list_tags_for_resource_request() :: %{
required("ResourceArn") => String.t() | atom()
}
"""
@type list_tags_for_resource_request() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
destination() :: %{
"BccAddresses" => list(String.t() | atom()),
"CcAddresses" => list(String.t() | atom()),
"ToAddresses" => list(String.t() | atom())
}
"""
@type destination() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
get_multi_region_endpoint_request() :: %{}
"""
@type get_multi_region_endpoint_request() :: %{}
@typedoc """
## Example:
body() :: %{
"Html" => content(),
"Text" => content()
}
"""
@type body() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
get_deliverability_dashboard_options_request() :: %{}
"""
@type get_deliverability_dashboard_options_request() :: %{}
@typedoc """
## Example:
get_domain_statistics_report_response() :: %{
"DailyVolumes" => list(daily_volume()),
"OverallVolume" => overall_volume()
}
"""
@type get_domain_statistics_report_response() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
put_account_sending_attributes_response() :: %{}
"""
@type put_account_sending_attributes_response() :: %{}
@typedoc """
## Example:
get_email_identity_policies_request() :: %{}
"""
@type get_email_identity_policies_request() :: %{}
@typedoc """
## Example:
message_rejected() :: %{
"message" => String.t() | atom()
}
"""
@type message_rejected() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
create_contact_request() :: %{
optional("AttributesData") => String.t() | atom(),
optional("TopicPreferences") => list(topic_preference()),
optional("UnsubscribeAll") => boolean(),
required("EmailAddress") => String.t() | atom()
}
"""
@type create_contact_request() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
contact_list() :: %{
"ContactListName" => String.t() | atom(),
"LastUpdatedTimestamp" => non_neg_integer()
}
"""
@type contact_list() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
guardian_options() :: %{
"OptimizedSharedDelivery" => list(any())
}
"""
@type guardian_options() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
list_dedicated_ip_pools_response() :: %{
"DedicatedIpPools" => list(String.t() | atom()),
"NextToken" => String.t() | atom()
}
"""
@type list_dedicated_ip_pools_response() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
get_configuration_set_request() :: %{}
"""
@type get_configuration_set_request() :: %{}
@typedoc """
## Example:
put_email_identity_mail_from_attributes_response() :: %{}
"""
@type put_email_identity_mail_from_attributes_response() :: %{}
@typedoc """
## Example:
create_configuration_set_event_destination_request() :: %{
required("EventDestination") => event_destination_definition(),
required("EventDestinationName") => String.t() | atom()
}
"""
@type create_configuration_set_event_destination_request() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
domain_deliverability_tracking_option() :: %{
"Domain" => String.t() | atom(),
"InboxPlacementTrackingOption" => inbox_placement_tracking_option(),
"SubscriptionStartDate" => non_neg_integer()
}
"""
@type domain_deliverability_tracking_option() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
delete_contact_list_request() :: %{}
"""
@type delete_contact_list_request() :: %{}
@typedoc """
## Example:
put_configuration_set_sending_options_request() :: %{
optional("SendingEnabled") => boolean()
}
"""
@type put_configuration_set_sending_options_request() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
get_dedicated_ip_pool_response() :: %{
"DedicatedIpPool" => dedicated_ip_pool()
}
"""
@type get_dedicated_ip_pool_response() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
bulk_email_entry_result() :: %{
"Error" => String.t() | atom(),
"MessageId" => String.t() | atom(),
"Status" => list(any())
}
"""
@type bulk_email_entry_result() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
limit_exceeded_exception() :: %{
"message" => String.t() | atom()
}
"""
@type limit_exceeded_exception() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
delivery_options() :: %{
"MaxDeliverySeconds" => float(),
"SendingPoolName" => String.t() | atom(),
"TlsPolicy" => list(any())
}
"""
@type delivery_options() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
update_configuration_set_event_destination_response() :: %{}
"""
@type update_configuration_set_event_destination_response() :: %{}
@typedoc """
## Example:
get_tenant_request() :: %{
required("TenantName") => String.t() | atom()
}
"""
@type get_tenant_request() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
bad_request_exception() :: %{
"message" => String.t() | atom()
}
"""
@type bad_request_exception() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
get_email_template_response() :: %{
"TemplateContent" => email_template_content(),
"TemplateName" => String.t() | atom()
}
"""
@type get_email_template_response() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
content() :: %{
"Charset" => String.t() | atom(),
"Data" => String.t() | atom()
}
"""
@type content() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
update_email_identity_policy_request() :: %{
required("Policy") => String.t() | atom()
}
"""
@type update_email_identity_policy_request() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
put_suppressed_destination_response() :: %{}
"""
@type put_suppressed_destination_response() :: %{}
@typedoc """
## Example:
get_email_template_request() :: %{}
"""
@type get_email_template_request() :: %{}
@typedoc """
## Example:
put_account_vdm_attributes_request() :: %{
required("VdmAttributes") => vdm_attributes()
}
"""
@type put_account_vdm_attributes_request() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
get_configuration_set_response() :: %{
"ArchivingOptions" => archiving_options(),
"ConfigurationSetName" => String.t() | atom(),
"DeliveryOptions" => delivery_options(),
"ReputationOptions" => reputation_options(),
"SendingOptions" => sending_options(),
"SuppressionOptions" => suppression_options(),
"Tags" => list(tag()),
"TrackingOptions" => tracking_options(),
"VdmOptions" => vdm_options()
}
"""
@type get_configuration_set_response() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
update_email_template_response() :: %{}
"""
@type update_email_template_response() :: %{}
@typedoc """
## Example:
suppressed_destination_attributes() :: %{
"FeedbackId" => String.t() | atom(),
"MessageId" => String.t() | atom()
}
"""
@type suppressed_destination_attributes() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
template() :: %{
"Attachments" => list(attachment()),
"Headers" => list(message_header()),
"TemplateArn" => String.t() | atom(),
"TemplateContent" => email_template_content(),
"TemplateData" => String.t() | atom(),
"TemplateName" => String.t() | atom()
}
"""
@type template() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
send_email_request() :: %{
optional("ConfigurationSetName") => String.t() | atom(),
optional("Destination") => destination(),
optional("EmailTags") => list(message_tag()),
optional("EndpointId") => String.t() | atom(),
optional("FeedbackForwardingEmailAddress") => String.t() | atom(),
optional("FeedbackForwardingEmailAddressIdentityArn") => String.t() | atom(),
optional("FromEmailAddress") => String.t() | atom(),
optional("FromEmailAddressIdentityArn") => String.t() | atom(),
optional("ListManagementOptions") => list_management_options(),
optional("ReplyToAddresses") => list(String.t() | atom()),
optional("TenantName") => String.t() | atom(),
required("Content") => email_content()
}
"""
@type send_email_request() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
get_contact_list_request() :: %{}
"""
@type get_contact_list_request() :: %{}
@typedoc """
## Example:
put_account_details_response() :: %{}
"""
@type put_account_details_response() :: %{}
@typedoc """
## Example:
review_details() :: %{
"CaseId" => String.t() | atom(),
"Status" => list(any())
}
"""
@type review_details() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
put_dedicated_ip_warmup_attributes_response() :: %{}
"""
@type put_dedicated_ip_warmup_attributes_response() :: %{}
@typedoc """
## Example:
list_export_jobs_response() :: %{
"ExportJobs" => list(export_job_summary()),
"NextToken" => String.t() | atom()
}
"""
@type list_export_jobs_response() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
failure_info() :: %{
"ErrorMessage" => String.t() | atom(),
"FailedRecordsS3Url" => String.t() | atom()
}
"""
@type failure_info() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
import_data_source() :: %{
"DataFormat" => list(any()),
"S3Url" => String.t() | atom()
}
"""
@type import_data_source() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
put_dedicated_ip_warmup_attributes_request() :: %{
required("WarmupPercentage") => integer()
}
"""
@type put_dedicated_ip_warmup_attributes_request() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
domain_deliverability_campaign() :: %{
"CampaignId" => String.t() | atom(),
"DeleteRate" => float(),
"Esps" => list(String.t() | atom()),
"FirstSeenDateTime" => non_neg_integer(),
"FromAddress" => String.t() | atom(),
"ImageUrl" => String.t() | atom(),
"InboxCount" => float(),
"LastSeenDateTime" => non_neg_integer(),
"ProjectedVolume" => float(),
"ReadDeleteRate" => float(),
"ReadRate" => float(),
"SendingIps" => list(String.t() | atom()),
"SpamCount" => float(),
"Subject" => String.t() | atom()
}
"""
@type domain_deliverability_campaign() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
replacement_template() :: %{
"ReplacementTemplateData" => String.t() | atom()
}
"""
@type replacement_template() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
list_recommendations_response() :: %{
"NextToken" => String.t() | atom(),
"Recommendations" => list(recommendation())
}
"""
@type list_recommendations_response() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
create_tenant_request() :: %{
optional("Tags") => list(tag()),
required("TenantName") => String.t() | atom()
}
"""
@type create_tenant_request() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
put_email_identity_configuration_set_attributes_request() :: %{
optional("ConfigurationSetName") => String.t() | atom()
}
"""
@type put_email_identity_configuration_set_attributes_request() :: %{
(String.t() | atom()) => any()
}
@typedoc """
## Example:
get_account_request() :: %{}
"""
@type get_account_request() :: %{}
@typedoc """
## Example:
get_dedicated_ip_request() :: %{}
"""
@type get_dedicated_ip_request() :: %{}
@typedoc """
## Example:
export_destination() :: %{
"DataFormat" => list(any()),
"S3Url" => String.t() | atom()
}
"""
@type export_destination() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
get_contact_response() :: %{
"AttributesData" => String.t() | atom(),
"ContactListName" => String.t() | atom(),
"CreatedTimestamp" => non_neg_integer(),
"EmailAddress" => String.t() | atom(),
"LastUpdatedTimestamp" => non_neg_integer(),
"TopicDefaultPreferences" => list(topic_preference()),
"TopicPreferences" => list(topic_preference()),
"UnsubscribeAll" => boolean()
}
"""
@type get_contact_response() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
list_email_identities_request() :: %{
optional("NextToken") => String.t() | atom(),
optional("PageSize") => integer()
}
"""
@type list_email_identities_request() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
complaint() :: %{
"ComplaintFeedbackType" => String.t() | atom(),
"ComplaintSubType" => String.t() | atom()
}
"""
@type complaint() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
put_configuration_set_reputation_options_request() :: %{
optional("ReputationMetricsEnabled") => boolean()
}
"""
@type put_configuration_set_reputation_options_request() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
bulk_email_entry() :: %{
optional("ReplacementEmailContent") => replacement_email_content(),
optional("ReplacementHeaders") => list(message_header()),
optional("ReplacementTags") => list(message_tag()),
required("Destination") => destination()
}
"""
@type bulk_email_entry() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
create_configuration_set_request() :: %{
optional("ArchivingOptions") => archiving_options(),
optional("DeliveryOptions") => delivery_options(),
optional("ReputationOptions") => reputation_options(),
optional("SendingOptions") => sending_options(),
optional("SuppressionOptions") => suppression_options(),
optional("Tags") => list(tag()),
optional("TrackingOptions") => tracking_options(),
optional("VdmOptions") => vdm_options(),
required("ConfigurationSetName") => String.t() | atom()
}
"""
@type create_configuration_set_request() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
email_template_metadata() :: %{
"CreatedTimestamp" => non_neg_integer(),
"TemplateName" => String.t() | atom()
}
"""
@type email_template_metadata() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
export_metric() :: %{
"Aggregation" => list(any()),
"Name" => list(any())
}
"""
@type export_metric() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
sns_destination() :: %{
"TopicArn" => String.t() | atom()
}
"""
@type sns_destination() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
test_render_email_template_response() :: %{
"RenderedTemplate" => String.t() | atom()
}
"""
@type test_render_email_template_response() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
create_email_template_response() :: %{}
"""
@type create_email_template_response() :: %{}
@typedoc """
## Example:
update_contact_list_request() :: %{
optional("Description") => String.t() | atom(),
optional("Topics") => list(topic())
}
"""
@type update_contact_list_request() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
metric_data_result() :: %{
"Id" => String.t() | atom(),
"Timestamps" => list(non_neg_integer()),
"Values" => list(float())
}
"""
@type metric_data_result() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
pinpoint_destination() :: %{
"ApplicationArn" => String.t() | atom()
}
"""
@type pinpoint_destination() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
put_email_identity_feedback_attributes_response() :: %{}
"""
@type put_email_identity_feedback_attributes_response() :: %{}
@typedoc """
## Example:
deliverability_test_report() :: %{
"CreateDate" => non_neg_integer(),
"DeliverabilityTestStatus" => list(any()),
"FromEmailAddress" => String.t() | atom(),
"ReportId" => String.t() | atom(),
"ReportName" => String.t() | atom(),
"Subject" => String.t() | atom()
}
"""
@type deliverability_test_report() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
get_deliverability_test_report_response() :: %{
"DeliverabilityTestReport" => deliverability_test_report(),
"IspPlacements" => list(isp_placement()),
"Message" => String.t() | atom(),
"OverallPlacement" => placement_statistics(),
"Tags" => list(tag())
}
"""
@type get_deliverability_test_report_response() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
list_recommendations_request() :: %{
optional("Filter") => map(),
optional("NextToken") => String.t() | atom(),
optional("PageSize") => integer()
}
"""
@type list_recommendations_request() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
custom_verification_email_template_metadata() :: %{
"FailureRedirectionURL" => String.t() | atom(),
"FromEmailAddress" => String.t() | atom(),
"SuccessRedirectionURL" => String.t() | atom(),
"TemplateName" => String.t() | atom(),
"TemplateSubject" => String.t() | atom()
}
"""
@type custom_verification_email_template_metadata() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
topic_filter() :: %{
"TopicName" => String.t() | atom(),
"UseDefaultIfPreferenceUnavailable" => boolean()
}
"""
@type topic_filter() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
get_email_identity_request() :: %{}
"""
@type get_email_identity_request() :: %{}
@typedoc """
## Example:
get_dedicated_ips_response() :: %{
"DedicatedIps" => list(dedicated_ip()),
"NextToken" => String.t() | atom()
}
"""
@type get_dedicated_ips_response() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
list_contact_lists_response() :: %{
"ContactLists" => list(contact_list()),
"NextToken" => String.t() | atom()
}
"""
@type list_contact_lists_response() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
message() :: %{
"Attachments" => list(attachment()),
"Body" => body(),
"Headers" => list(message_header()),
"Subject" => content()
}
"""
@type message() :: %{(String.t() | atom()) => any()}
@type batch_get_metric_data_errors() ::
bad_request_exception()
| not_found_exception()
| too_many_requests_exception()
| internal_service_error_exception()
@type cancel_export_job_errors() ::
bad_request_exception() | not_found_exception() | too_many_requests_exception()
@type create_configuration_set_errors() ::
bad_request_exception()
| limit_exceeded_exception()
| concurrent_modification_exception()
| not_found_exception()
| too_many_requests_exception()
| already_exists_exception()
@type create_configuration_set_event_destination_errors() ::
bad_request_exception()
| limit_exceeded_exception()
| not_found_exception()
| too_many_requests_exception()
| already_exists_exception()
@type create_contact_errors() ::
bad_request_exception()
| not_found_exception()
| too_many_requests_exception()
| already_exists_exception()
@type create_contact_list_errors() ::
bad_request_exception()
| limit_exceeded_exception()
| too_many_requests_exception()
| already_exists_exception()
@type create_custom_verification_email_template_errors() ::
bad_request_exception()
| limit_exceeded_exception()
| not_found_exception()
| too_many_requests_exception()
| already_exists_exception()
@type create_dedicated_ip_pool_errors() ::
bad_request_exception()
| limit_exceeded_exception()
| concurrent_modification_exception()
| too_many_requests_exception()
| already_exists_exception()
@type create_deliverability_test_report_errors() ::
bad_request_exception()
| limit_exceeded_exception()
| message_rejected()
| concurrent_modification_exception()
| not_found_exception()
| mail_from_domain_not_verified_exception()
| too_many_requests_exception()
| account_suspended_exception()
| sending_paused_exception()
@type create_email_identity_errors() ::
bad_request_exception()
| limit_exceeded_exception()
| concurrent_modification_exception()
| not_found_exception()
| too_many_requests_exception()
| already_exists_exception()
@type create_email_identity_policy_errors() ::
bad_request_exception()
| limit_exceeded_exception()
| not_found_exception()
| too_many_requests_exception()
| already_exists_exception()
@type create_email_template_errors() ::
bad_request_exception()
| limit_exceeded_exception()
| too_many_requests_exception()
| already_exists_exception()
@type create_export_job_errors() ::
bad_request_exception()
| limit_exceeded_exception()
| not_found_exception()
| too_many_requests_exception()
@type create_import_job_errors() ::
bad_request_exception() | limit_exceeded_exception() | too_many_requests_exception()
@type create_multi_region_endpoint_errors() ::
bad_request_exception()
| limit_exceeded_exception()
| too_many_requests_exception()
| already_exists_exception()
@type create_tenant_errors() ::
bad_request_exception()
| limit_exceeded_exception()
| too_many_requests_exception()
| already_exists_exception()
@type create_tenant_resource_association_errors() ::
bad_request_exception()
| not_found_exception()
| too_many_requests_exception()
| already_exists_exception()
@type delete_configuration_set_errors() ::
bad_request_exception()
| concurrent_modification_exception()
| not_found_exception()
| too_many_requests_exception()
@type delete_configuration_set_event_destination_errors() ::
bad_request_exception() | not_found_exception() | too_many_requests_exception()
@type delete_contact_errors() ::
bad_request_exception() | not_found_exception() | too_many_requests_exception()
@type delete_contact_list_errors() ::
bad_request_exception()
| concurrent_modification_exception()
| not_found_exception()
| too_many_requests_exception()
@type delete_custom_verification_email_template_errors() ::
bad_request_exception() | not_found_exception() | too_many_requests_exception()
@type delete_dedicated_ip_pool_errors() ::
bad_request_exception()
| concurrent_modification_exception()
| not_found_exception()
| too_many_requests_exception()
@type delete_email_identity_errors() ::
bad_request_exception()
| concurrent_modification_exception()
| not_found_exception()
| too_many_requests_exception()
@type delete_email_identity_policy_errors() ::
bad_request_exception() | not_found_exception() | too_many_requests_exception()
@type delete_email_template_errors() ::
bad_request_exception() | not_found_exception() | too_many_requests_exception()
@type delete_multi_region_endpoint_errors() ::
bad_request_exception()
| concurrent_modification_exception()
| not_found_exception()
| too_many_requests_exception()
@type delete_suppressed_destination_errors() ::
bad_request_exception() | not_found_exception() | too_many_requests_exception()
@type delete_tenant_errors() ::
bad_request_exception() | not_found_exception() | too_many_requests_exception()
@type delete_tenant_resource_association_errors() ::
bad_request_exception() | not_found_exception() | too_many_requests_exception()
@type get_account_errors() :: bad_request_exception() | too_many_requests_exception()
@type get_blacklist_reports_errors() ::
bad_request_exception() | not_found_exception() | too_many_requests_exception()
@type get_configuration_set_errors() ::
bad_request_exception() | not_found_exception() | too_many_requests_exception()
@type get_configuration_set_event_destinations_errors() ::
bad_request_exception() | not_found_exception() | too_many_requests_exception()
@type get_contact_errors() ::
bad_request_exception() | not_found_exception() | too_many_requests_exception()
@type get_contact_list_errors() ::
bad_request_exception() | not_found_exception() | too_many_requests_exception()
@type get_custom_verification_email_template_errors() ::
bad_request_exception() | not_found_exception() | too_many_requests_exception()
@type get_dedicated_ip_errors() ::
bad_request_exception() | not_found_exception() | too_many_requests_exception()
@type get_dedicated_ip_pool_errors() ::
bad_request_exception() | not_found_exception() | too_many_requests_exception()
@type get_dedicated_ips_errors() ::
bad_request_exception() | not_found_exception() | too_many_requests_exception()
@type get_deliverability_dashboard_options_errors() ::
bad_request_exception() | limit_exceeded_exception() | too_many_requests_exception()
@type get_deliverability_test_report_errors() ::
bad_request_exception() | not_found_exception() | too_many_requests_exception()
@type get_domain_deliverability_campaign_errors() ::
bad_request_exception() | not_found_exception() | too_many_requests_exception()
@type get_domain_statistics_report_errors() ::
bad_request_exception() | not_found_exception() | too_many_requests_exception()
@type get_email_identity_errors() ::
bad_request_exception() | not_found_exception() | too_many_requests_exception()
@type get_email_identity_policies_errors() ::
bad_request_exception() | not_found_exception() | too_many_requests_exception()
@type get_email_template_errors() ::
bad_request_exception() | not_found_exception() | too_many_requests_exception()
@type get_export_job_errors() ::
bad_request_exception() | not_found_exception() | too_many_requests_exception()
@type get_import_job_errors() ::
bad_request_exception() | not_found_exception() | too_many_requests_exception()
@type get_message_insights_errors() ::
bad_request_exception() | not_found_exception() | too_many_requests_exception()
@type get_multi_region_endpoint_errors() ::
bad_request_exception() | not_found_exception() | too_many_requests_exception()
@type get_reputation_entity_errors() ::
bad_request_exception() | not_found_exception() | too_many_requests_exception()
@type get_suppressed_destination_errors() ::
bad_request_exception() | not_found_exception() | too_many_requests_exception()
@type get_tenant_errors() ::
bad_request_exception() | not_found_exception() | too_many_requests_exception()
@type list_configuration_sets_errors() ::
bad_request_exception() | too_many_requests_exception()
@type list_contact_lists_errors() :: bad_request_exception() | too_many_requests_exception()
@type list_contacts_errors() ::
bad_request_exception() | not_found_exception() | too_many_requests_exception()
@type list_custom_verification_email_templates_errors() ::
bad_request_exception() | too_many_requests_exception()
@type list_dedicated_ip_pools_errors() ::
bad_request_exception() | too_many_requests_exception()
@type list_deliverability_test_reports_errors() ::
bad_request_exception() | not_found_exception() | too_many_requests_exception()
@type list_domain_deliverability_campaigns_errors() ::
bad_request_exception() | not_found_exception() | too_many_requests_exception()
@type list_email_identities_errors() :: bad_request_exception() | too_many_requests_exception()
@type list_email_templates_errors() :: bad_request_exception() | too_many_requests_exception()
@type list_export_jobs_errors() :: bad_request_exception() | too_many_requests_exception()
@type list_import_jobs_errors() :: bad_request_exception() | too_many_requests_exception()
@type list_multi_region_endpoints_errors() ::
bad_request_exception() | too_many_requests_exception()
@type list_recommendations_errors() ::
bad_request_exception() | not_found_exception() | too_many_requests_exception()
@type list_reputation_entities_errors() ::
bad_request_exception() | too_many_requests_exception()
@type list_resource_tenants_errors() ::
bad_request_exception() | not_found_exception() | too_many_requests_exception()
@type list_suppressed_destinations_errors() ::
bad_request_exception() | invalid_next_token_exception() | too_many_requests_exception()
@type list_tags_for_resource_errors() ::
bad_request_exception() | not_found_exception() | too_many_requests_exception()
@type list_tenant_resources_errors() ::
bad_request_exception() | not_found_exception() | too_many_requests_exception()
@type list_tenants_errors() :: bad_request_exception() | too_many_requests_exception()
@type put_account_dedicated_ip_warmup_attributes_errors() ::
bad_request_exception() | too_many_requests_exception()
@type put_account_details_errors() ::
bad_request_exception() | conflict_exception() | too_many_requests_exception()
@type put_account_sending_attributes_errors() ::
bad_request_exception() | too_many_requests_exception()
@type put_account_suppression_attributes_errors() ::
bad_request_exception() | too_many_requests_exception()
@type put_account_vdm_attributes_errors() ::
bad_request_exception() | too_many_requests_exception()
@type put_configuration_set_archiving_options_errors() ::
bad_request_exception() | not_found_exception() | too_many_requests_exception()
@type put_configuration_set_delivery_options_errors() ::
bad_request_exception() | not_found_exception() | too_many_requests_exception()
@type put_configuration_set_reputation_options_errors() ::
bad_request_exception() | not_found_exception() | too_many_requests_exception()
@type put_configuration_set_sending_options_errors() ::
bad_request_exception() | not_found_exception() | too_many_requests_exception()
@type put_configuration_set_suppression_options_errors() ::
bad_request_exception() | not_found_exception() | too_many_requests_exception()
@type put_configuration_set_tracking_options_errors() ::
bad_request_exception() | not_found_exception() | too_many_requests_exception()
@type put_configuration_set_vdm_options_errors() ::
bad_request_exception() | not_found_exception() | too_many_requests_exception()
@type put_dedicated_ip_in_pool_errors() ::
bad_request_exception() | not_found_exception() | too_many_requests_exception()
@type put_dedicated_ip_pool_scaling_attributes_errors() ::
bad_request_exception()
| concurrent_modification_exception()
| not_found_exception()
| too_many_requests_exception()
@type put_dedicated_ip_warmup_attributes_errors() ::
bad_request_exception() | not_found_exception() | too_many_requests_exception()
@type put_deliverability_dashboard_option_errors() ::
bad_request_exception()
| limit_exceeded_exception()
| not_found_exception()
| too_many_requests_exception()
| already_exists_exception()
@type put_email_identity_configuration_set_attributes_errors() ::
bad_request_exception() | not_found_exception() | too_many_requests_exception()
@type put_email_identity_dkim_attributes_errors() ::
bad_request_exception() | not_found_exception() | too_many_requests_exception()
@type put_email_identity_dkim_signing_attributes_errors() ::
bad_request_exception() | not_found_exception() | too_many_requests_exception()
@type put_email_identity_feedback_attributes_errors() ::
bad_request_exception() | not_found_exception() | too_many_requests_exception()
@type put_email_identity_mail_from_attributes_errors() ::
bad_request_exception() | not_found_exception() | too_many_requests_exception()
@type put_suppressed_destination_errors() ::
bad_request_exception() | too_many_requests_exception()
@type send_bulk_email_errors() ::
bad_request_exception()
| limit_exceeded_exception()
| message_rejected()
| not_found_exception()
| mail_from_domain_not_verified_exception()
| too_many_requests_exception()
| account_suspended_exception()
| sending_paused_exception()
@type send_custom_verification_email_errors() ::
bad_request_exception()
| limit_exceeded_exception()
| message_rejected()
| not_found_exception()
| mail_from_domain_not_verified_exception()
| too_many_requests_exception()
| sending_paused_exception()
@type send_email_errors() ::
bad_request_exception()
| limit_exceeded_exception()
| message_rejected()
| not_found_exception()
| mail_from_domain_not_verified_exception()
| too_many_requests_exception()
| account_suspended_exception()
| sending_paused_exception()
@type tag_resource_errors() ::
bad_request_exception()
| concurrent_modification_exception()
| not_found_exception()
| too_many_requests_exception()
@type test_render_email_template_errors() ::
bad_request_exception() | not_found_exception() | too_many_requests_exception()
@type untag_resource_errors() ::
bad_request_exception()
| concurrent_modification_exception()
| not_found_exception()
| too_many_requests_exception()
@type update_configuration_set_event_destination_errors() ::
bad_request_exception() | not_found_exception() | too_many_requests_exception()
@type update_contact_errors() ::
bad_request_exception()
| concurrent_modification_exception()
| not_found_exception()
| too_many_requests_exception()
@type update_contact_list_errors() ::
bad_request_exception()
| concurrent_modification_exception()
| not_found_exception()
| too_many_requests_exception()
@type update_custom_verification_email_template_errors() ::
bad_request_exception() | not_found_exception() | too_many_requests_exception()
@type update_email_identity_policy_errors() ::
bad_request_exception() | not_found_exception() | too_many_requests_exception()
@type update_email_template_errors() ::
bad_request_exception() | not_found_exception() | too_many_requests_exception()
@type update_reputation_entity_customer_managed_status_errors() ::
bad_request_exception() | conflict_exception() | too_many_requests_exception()
@type update_reputation_entity_policy_errors() ::
bad_request_exception() | conflict_exception() | too_many_requests_exception()
def metadata do
%{
api_version: "2019-09-27",
content_type: "application/x-amz-json-1.1",
credential_scope: nil,
endpoint_prefix: "email",
global?: false,
hostname: nil,
protocol: "rest-json",
service_id: "SESv2",
signature_version: "v4",
signing_name: "ses",
target_prefix: nil
}
end
@doc """
Retrieves batches of metric data collected based on your sending activity.
You can execute this operation no more than 16 times per second,
and with at most 160 queries from the batches per second (cumulative).
"""
@spec batch_get_metric_data(map(), batch_get_metric_data_request(), list()) ::
{:ok, batch_get_metric_data_response(), any()}
| {:error, {:unexpected_response, any()}}
| {:error, term()}
| {:error, batch_get_metric_data_errors()}
def batch_get_metric_data(%Client{} = client, input, options \\ []) do
url_path = "/v2/email/metrics/batch"
headers = []
custom_headers = []
query_params = []
meta = metadata()
Request.request_rest(
client,
meta,
:post,
url_path,
query_params,
custom_headers ++ headers,
input,
options,
200
)
end
@doc """
Cancels an export job.
"""
@spec cancel_export_job(map(), String.t() | atom(), cancel_export_job_request(), list()) ::
{:ok, cancel_export_job_response(), any()}
| {:error, {:unexpected_response, any()}}
| {:error, term()}
| {:error, cancel_export_job_errors()}
def cancel_export_job(%Client{} = client, job_id, input, options \\ []) do
url_path = "/v2/email/export-jobs/#{AWS.Util.encode_uri(job_id)}/cancel"
headers = []
custom_headers = []
query_params = []
meta = metadata()
Request.request_rest(
client,
meta,
:put,
url_path,
query_params,
custom_headers ++ headers,
input,
options,
200
)
end
@doc """
Create a configuration set.
*Configuration sets* are groups of
rules that you can apply to the emails that you send. You apply a configuration
set to
an email by specifying the name of the configuration set when you call the
Amazon SES API v2. When
you apply a configuration set to an email, all of the rules in that
configuration set
are applied to the email.
"""
@spec create_configuration_set(map(), create_configuration_set_request(), list()) ::
{:ok, create_configuration_set_response(), any()}
| {:error, {:unexpected_response, any()}}
| {:error, term()}
| {:error, create_configuration_set_errors()}
def create_configuration_set(%Client{} = client, input, options \\ []) do
url_path = "/v2/email/configuration-sets"
headers = []
custom_headers = []
query_params = []
meta = metadata()
Request.request_rest(
client,
meta,
:post,
url_path,
query_params,
custom_headers ++ headers,
input,
options,
200
)
end
@doc """
Create an event destination.
*Events* include message sends,
deliveries, opens, clicks, bounces, and complaints. *Event
destinations* are places that you can send information about these events
to. For example, you can send event data to Amazon EventBridge and associate a
rule to send the event
to the specified target.
A single configuration set can include more than one event destination.
"""
@spec create_configuration_set_event_destination(
map(),
String.t() | atom(),
create_configuration_set_event_destination_request(),
list()
) ::
{:ok, create_configuration_set_event_destination_response(), any()}
| {:error, {:unexpected_response, any()}}
| {:error, term()}
| {:error, create_configuration_set_event_destination_errors()}
def create_configuration_set_event_destination(
%Client{} = client,
configuration_set_name,
input,
options \\ []
) do
url_path =
"/v2/email/configuration-sets/#{AWS.Util.encode_uri(configuration_set_name)}/event-destinations"
headers = []
custom_headers = []
query_params = []
meta = metadata()
Request.request_rest(
client,
meta,
:post,
url_path,
query_params,
custom_headers ++ headers,
input,
options,
200
)
end
@doc """
Creates a contact, which is an end-user who is receiving the email, and adds
them to a
contact list.
"""
@spec create_contact(map(), String.t() | atom(), create_contact_request(), list()) ::
{:ok, create_contact_response(), any()}
| {:error, {:unexpected_response, any()}}
| {:error, term()}
| {:error, create_contact_errors()}
def create_contact(%Client{} = client, contact_list_name, input, options \\ []) do
url_path = "/v2/email/contact-lists/#{AWS.Util.encode_uri(contact_list_name)}/contacts"
headers = []
custom_headers = []
query_params = []
meta = metadata()
Request.request_rest(
client,
meta,
:post,
url_path,
query_params,
custom_headers ++ headers,
input,
options,
200
)
end
@doc """
Creates a contact list.
"""
@spec create_contact_list(map(), create_contact_list_request(), list()) ::
{:ok, create_contact_list_response(), any()}
| {:error, {:unexpected_response, any()}}
| {:error, term()}
| {:error, create_contact_list_errors()}
def create_contact_list(%Client{} = client, input, options \\ []) do
url_path = "/v2/email/contact-lists"
headers = []
custom_headers = []
query_params = []
meta = metadata()
Request.request_rest(
client,
meta,
:post,
url_path,
query_params,
custom_headers ++ headers,
input,
options,
200
)
end
@doc """
Creates a new custom verification email template.
For more information about custom verification email templates, see [Using custom verification email
templates](https://docs.aws.amazon.com/ses/latest/dg/creating-identities.html#send-email-verify-address-custom)
in the *Amazon SES Developer
Guide*.
You can execute this operation no more than once per second.
"""
@spec create_custom_verification_email_template(
map(),
create_custom_verification_email_template_request(),
list()
) ::
{:ok, create_custom_verification_email_template_response(), any()}
| {:error, {:unexpected_response, any()}}
| {:error, term()}
| {:error, create_custom_verification_email_template_errors()}
def create_custom_verification_email_template(%Client{} = client, input, options \\ []) do
url_path = "/v2/email/custom-verification-email-templates"
headers = []
custom_headers = []
query_params = []
meta = metadata()
Request.request_rest(
client,
meta,
:post,
url_path,
query_params,
custom_headers ++ headers,
input,
options,
200
)
end
@doc """
Create a new pool of dedicated IP addresses.
A pool can include one or more dedicated
IP addresses that are associated with your Amazon Web Services account. You can
associate a pool with
a configuration set. When you send an email that uses that configuration set,
the
message is sent from one of the addresses in the associated pool.
"""
@spec create_dedicated_ip_pool(map(), create_dedicated_ip_pool_request(), list()) ::
{:ok, create_dedicated_ip_pool_response(), any()}
| {:error, {:unexpected_response, any()}}
| {:error, term()}
| {:error, create_dedicated_ip_pool_errors()}
def create_dedicated_ip_pool(%Client{} = client, input, options \\ []) do
url_path = "/v2/email/dedicated-ip-pools"
headers = []
custom_headers = []
query_params = []
meta = metadata()
Request.request_rest(
client,
meta,
:post,
url_path,
query_params,
custom_headers ++ headers,
input,
options,
200
)
end
@doc """
Create a new predictive inbox placement test.
Predictive inbox placement tests can help you predict how your messages will be
handled
by various email providers around the world. When you perform a predictive inbox
placement test, you provide a
sample message that contains the content that you plan to send to your
customers. Amazon SES
then sends that message to special email addresses spread across several major
email
providers. After about 24 hours, the test is complete, and you can use the
`GetDeliverabilityTestReport` operation to view the results of the
test.
"""
@spec create_deliverability_test_report(
map(),
create_deliverability_test_report_request(),
list()
) ::
{:ok, create_deliverability_test_report_response(), any()}
| {:error, {:unexpected_response, any()}}
| {:error, term()}
| {:error, create_deliverability_test_report_errors()}
def create_deliverability_test_report(%Client{} = client, input, options \\ []) do
url_path = "/v2/email/deliverability-dashboard/test"
headers = []
custom_headers = []
query_params = []
meta = metadata()
Request.request_rest(
client,
meta,
:post,
url_path,
query_params,
custom_headers ++ headers,
input,
options,
200
)
end
@doc """
Starts the process of verifying an email identity.
An *identity* is
an email address or domain that you use when you send email. Before you can use
an
identity to send email, you first have to verify it. By verifying an identity,
you
demonstrate that you're the owner of the identity, and that you've given Amazon
SES API v2
permission to send email from the identity.
When you verify an email address, Amazon SES sends an email to the address. Your
email
address is verified as soon as you follow the link in the verification email.
When you verify a domain without specifying the `DkimSigningAttributes`
object, this operation provides a set of DKIM tokens. You can convert these
tokens into
CNAME records, which you then add to the DNS configuration for your domain. Your
domain
is verified when Amazon SES detects these records in the DNS configuration for
your domain.
This verification method is known as [Easy DKIM](https://docs.aws.amazon.com/ses/latest/DeveloperGuide/easy-dkim.html).
Alternatively, you can perform the verification process by providing your own
public-private key pair. This verification method is known as Bring Your Own
DKIM
(BYODKIM). To use BYODKIM, your call to the `CreateEmailIdentity` operation
has to include the `DkimSigningAttributes` object. When you specify this
object, you provide a selector (a component of the DNS record name that
identifies the
public key to use for DKIM authentication) and a private key.
When you verify a domain, this operation provides a set of DKIM tokens, which
you can
convert into CNAME tokens. You add these CNAME tokens to the DNS configuration
for your
domain. Your domain is verified when Amazon SES detects these records in the DNS
configuration for your domain. For some DNS providers, it can take 72 hours or
more to
complete the domain verification process.
Additionally, you can associate an existing configuration set with the email
identity that you're verifying.
"""
@spec create_email_identity(map(), create_email_identity_request(), list()) ::
{:ok, create_email_identity_response(), any()}
| {:error, {:unexpected_response, any()}}
| {:error, term()}
| {:error, create_email_identity_errors()}
def create_email_identity(%Client{} = client, input, options \\ []) do
url_path = "/v2/email/identities"
headers = []
custom_headers = []
query_params = []
meta = metadata()
Request.request_rest(
client,
meta,
:post,
url_path,
query_params,
custom_headers ++ headers,
input,
options,
200
)
end
@doc """
Creates the specified sending authorization policy for the given identity (an
email
address or a domain).
This API is for the identity owner only. If you have not verified the identity,
this API will return an error.
Sending authorization is a feature that enables an identity owner to authorize
other
senders to use its identities. For information about using sending
authorization, see
the [Amazon SES Developer Guide](https://docs.aws.amazon.com/ses/latest/DeveloperGuide/sending-authorization.html).
You can execute this operation no more than once per second.
"""
@spec create_email_identity_policy(
map(),
String.t() | atom(),
String.t() | atom(),
create_email_identity_policy_request(),
list()
) ::
{:ok, create_email_identity_policy_response(), any()}
| {:error, {:unexpected_response, any()}}
| {:error, term()}
| {:error, create_email_identity_policy_errors()}
def create_email_identity_policy(
%Client{} = client,
email_identity,
policy_name,
input,
options \\ []
) do
url_path =
"/v2/email/identities/#{AWS.Util.encode_uri(email_identity)}/policies/#{AWS.Util.encode_uri(policy_name)}"
headers = []
custom_headers = []
query_params = []
meta = metadata()
Request.request_rest(
client,
meta,
:post,
url_path,
query_params,
custom_headers ++ headers,
input,
options,
200
)
end
@doc """
Creates an email template.
Email templates enable you to send personalized email to
one or more destinations in a single API operation. For more information, see
the [Amazon SES Developer Guide](https://docs.aws.amazon.com/ses/latest/DeveloperGuide/send-personalized-email-api.html).
You can execute this operation no more than once per second.
"""
@spec create_email_template(map(), create_email_template_request(), list()) ::
{:ok, create_email_template_response(), any()}
| {:error, {:unexpected_response, any()}}
| {:error, term()}
| {:error, create_email_template_errors()}
def create_email_template(%Client{} = client, input, options \\ []) do
url_path = "/v2/email/templates"
headers = []
custom_headers = []
query_params = []
meta = metadata()
Request.request_rest(
client,
meta,
:post,
url_path,
query_params,
custom_headers ++ headers,
input,
options,
200
)
end
@doc """
Creates an export job for a data source and destination.
You can execute this operation no more than once per second.
"""
@spec create_export_job(map(), create_export_job_request(), list()) ::
{:ok, create_export_job_response(), any()}
| {:error, {:unexpected_response, any()}}
| {:error, term()}
| {:error, create_export_job_errors()}
def create_export_job(%Client{} = client, input, options \\ []) do
url_path = "/v2/email/export-jobs"
headers = []
custom_headers = []
query_params = []
meta = metadata()
Request.request_rest(
client,
meta,
:post,
url_path,
query_params,
custom_headers ++ headers,
input,
options,
200
)
end
@doc """
Creates an import job for a data destination.
"""
@spec create_import_job(map(), create_import_job_request(), list()) ::
{:ok, create_import_job_response(), any()}
| {:error, {:unexpected_response, any()}}
| {:error, term()}
| {:error, create_import_job_errors()}
def create_import_job(%Client{} = client, input, options \\ []) do
url_path = "/v2/email/import-jobs"
headers = []
custom_headers = []
query_params = []
meta = metadata()
Request.request_rest(
client,
meta,
:post,
url_path,
query_params,
custom_headers ++ headers,
input,
options,
200
)
end
@doc """
Creates a multi-region endpoint (global-endpoint).
The primary region is going to be the AWS-Region where the operation is
executed.
The secondary region has to be provided in request's parameters.
From the data flow standpoint there is no difference between primary
and secondary regions - sending traffic will be split equally between the two.
The primary region is the region where the resource has been created and where
it can be managed.
"""
@spec create_multi_region_endpoint(map(), create_multi_region_endpoint_request(), list()) ::
{:ok, create_multi_region_endpoint_response(), any()}
| {:error, {:unexpected_response, any()}}
| {:error, term()}
| {:error, create_multi_region_endpoint_errors()}
def create_multi_region_endpoint(%Client{} = client, input, options \\ []) do
url_path = "/v2/email/multi-region-endpoints"
headers = []
custom_headers = []
query_params = []
meta = metadata()
Request.request_rest(
client,
meta,
:post,
url_path,
query_params,
custom_headers ++ headers,
input,
options,
200
)
end
@doc """
Create a tenant.
*Tenants* are logical containers that group related SES resources together.
Each tenant can have its own set of resources like email identities,
configuration sets,
and templates, along with reputation metrics and sending status. This helps
isolate and manage
email sending for different customers or business units within your Amazon SES
API v2 account.
"""
@spec create_tenant(map(), create_tenant_request(), list()) ::
{:ok, create_tenant_response(), any()}
| {:error, {:unexpected_response, any()}}
| {:error, term()}
| {:error, create_tenant_errors()}
def create_tenant(%Client{} = client, input, options \\ []) do
url_path = "/v2/email/tenants"
headers = []
custom_headers = []
query_params = []
meta = metadata()
Request.request_rest(
client,
meta,
:post,
url_path,
query_params,
custom_headers ++ headers,
input,
options,
200
)
end
@doc """
Associate a resource with a tenant.
*Resources* can be email identities, configuration sets, or email templates.
When you associate a resource with a tenant, you can use that resource when
sending emails
on behalf of that tenant.
A single resource can be associated with multiple tenants, allowing for resource
sharing
across different tenants while maintaining isolation in email sending
operations.
"""
@spec create_tenant_resource_association(
map(),
create_tenant_resource_association_request(),
list()
) ::
{:ok, create_tenant_resource_association_response(), any()}
| {:error, {:unexpected_response, any()}}
| {:error, term()}
| {:error, create_tenant_resource_association_errors()}
def create_tenant_resource_association(%Client{} = client, input, options \\ []) do
url_path = "/v2/email/tenants/resources"
headers = []
custom_headers = []
query_params = []
meta = metadata()
Request.request_rest(
client,
meta,
:post,
url_path,
query_params,
custom_headers ++ headers,
input,
options,
200
)
end
@doc """
Delete an existing configuration set.
*Configuration sets* are groups of rules that you can apply to the
emails you send. You apply a configuration set to an email by including a
reference to
the configuration set in the headers of the email. When you apply a
configuration set to
an email, all of the rules in that configuration set are applied to the email.
"""
@spec delete_configuration_set(
map(),
String.t() | atom(),
delete_configuration_set_request(),
list()
) ::
{:ok, delete_configuration_set_response(), any()}
| {:error, {:unexpected_response, any()}}
| {:error, term()}
| {:error, delete_configuration_set_errors()}
def delete_configuration_set(%Client{} = client, configuration_set_name, input, options \\ []) do
url_path = "/v2/email/configuration-sets/#{AWS.Util.encode_uri(configuration_set_name)}"
headers = []
custom_headers = []
query_params = []
meta = metadata()
Request.request_rest(
client,
meta,
:delete,
url_path,
query_params,
custom_headers ++ headers,
input,
options,
200
)
end
@doc """
Delete an event destination.
*Events* include message sends, deliveries, opens, clicks, bounces,
and complaints. *Event destinations* are places that you can send
information about these events to. For example, you can send event data to
Amazon EventBridge and
associate a rule to send the event to the specified target.
"""
@spec delete_configuration_set_event_destination(
map(),
String.t() | atom(),
String.t() | atom(),
delete_configuration_set_event_destination_request(),
list()
) ::
{:ok, delete_configuration_set_event_destination_response(), any()}
| {:error, {:unexpected_response, any()}}
| {:error, term()}
| {:error, delete_configuration_set_event_destination_errors()}
def delete_configuration_set_event_destination(
%Client{} = client,
configuration_set_name,
event_destination_name,
input,
options \\ []
) do
url_path =
"/v2/email/configuration-sets/#{AWS.Util.encode_uri(configuration_set_name)}/event-destinations/#{AWS.Util.encode_uri(event_destination_name)}"
headers = []
custom_headers = []
query_params = []
meta = metadata()
Request.request_rest(
client,
meta,
:delete,
url_path,
query_params,
custom_headers ++ headers,
input,
options,
200
)
end
@doc """
Removes a contact from a contact list.
"""
@spec delete_contact(
map(),
String.t() | atom(),
String.t() | atom(),
delete_contact_request(),
list()
) ::
{:ok, delete_contact_response(), any()}
| {:error, {:unexpected_response, any()}}
| {:error, term()}
| {:error, delete_contact_errors()}
def delete_contact(%Client{} = client, contact_list_name, email_address, input, options \\ []) do
url_path =
"/v2/email/contact-lists/#{AWS.Util.encode_uri(contact_list_name)}/contacts/#{AWS.Util.encode_uri(email_address)}"
headers = []
custom_headers = []
query_params = []
meta = metadata()
Request.request_rest(
client,
meta,
:delete,
url_path,
query_params,
custom_headers ++ headers,
input,
options,
200
)
end
@doc """
Deletes a contact list and all of the contacts on that list.
"""
@spec delete_contact_list(map(), String.t() | atom(), delete_contact_list_request(), list()) ::
{:ok, delete_contact_list_response(), any()}
| {:error, {:unexpected_response, any()}}
| {:error, term()}
| {:error, delete_contact_list_errors()}
def delete_contact_list(%Client{} = client, contact_list_name, input, options \\ []) do
url_path = "/v2/email/contact-lists/#{AWS.Util.encode_uri(contact_list_name)}"
headers = []
custom_headers = []
query_params = []
meta = metadata()
Request.request_rest(
client,
meta,
:delete,
url_path,
query_params,
custom_headers ++ headers,
input,
options,
200
)
end
@doc """
Deletes an existing custom verification email template.
For more information about custom verification email templates, see [Using custom verification email
templates](https://docs.aws.amazon.com/ses/latest/dg/creating-identities.html#send-email-verify-address-custom)
in the *Amazon SES Developer
Guide*.
You can execute this operation no more than once per second.
"""
@spec delete_custom_verification_email_template(
map(),
String.t() | atom(),
delete_custom_verification_email_template_request(),
list()
) ::
{:ok, delete_custom_verification_email_template_response(), any()}
| {:error, {:unexpected_response, any()}}
| {:error, term()}
| {:error, delete_custom_verification_email_template_errors()}
def delete_custom_verification_email_template(
%Client{} = client,
template_name,
input,
options \\ []
) do
url_path =
"/v2/email/custom-verification-email-templates/#{AWS.Util.encode_uri(template_name)}"
headers = []
custom_headers = []
query_params = []
meta = metadata()
Request.request_rest(
client,
meta,
:delete,
url_path,
query_params,
custom_headers ++ headers,
input,
options,
200
)
end
@doc """
Delete a dedicated IP pool.
"""
@spec delete_dedicated_ip_pool(
map(),
String.t() | atom(),
delete_dedicated_ip_pool_request(),
list()
) ::
{:ok, delete_dedicated_ip_pool_response(), any()}
| {:error, {:unexpected_response, any()}}
| {:error, term()}
| {:error, delete_dedicated_ip_pool_errors()}
def delete_dedicated_ip_pool(%Client{} = client, pool_name, input, options \\ []) do
url_path = "/v2/email/dedicated-ip-pools/#{AWS.Util.encode_uri(pool_name)}"
headers = []
custom_headers = []
query_params = []
meta = metadata()
Request.request_rest(
client,
meta,
:delete,
url_path,
query_params,
custom_headers ++ headers,
input,
options,
200
)
end
@doc """
Deletes an email identity.
An identity can be either an email address or a domain
name.
"""
@spec delete_email_identity(map(), String.t() | atom(), delete_email_identity_request(), list()) ::
{:ok, delete_email_identity_response(), any()}
| {:error, {:unexpected_response, any()}}
| {:error, term()}
| {:error, delete_email_identity_errors()}
def delete_email_identity(%Client{} = client, email_identity, input, options \\ []) do
url_path = "/v2/email/identities/#{AWS.Util.encode_uri(email_identity)}"
headers = []
custom_headers = []
query_params = []
meta = metadata()
Request.request_rest(
client,
meta,
:delete,
url_path,
query_params,
custom_headers ++ headers,
input,
options,
200
)
end
@doc """
Deletes the specified sending authorization policy for the given identity (an
email
address or a domain).
This API returns successfully even if a policy with the specified
name does not exist.
This API is for the identity owner only. If you have not verified the identity,
this API will return an error.
Sending authorization is a feature that enables an identity owner to authorize
other
senders to use its identities. For information about using sending
authorization, see
the [Amazon SES Developer Guide](https://docs.aws.amazon.com/ses/latest/DeveloperGuide/sending-authorization.html).
You can execute this operation no more than once per second.
"""
@spec delete_email_identity_policy(
map(),
String.t() | atom(),
String.t() | atom(),
delete_email_identity_policy_request(),
list()
) ::
{:ok, delete_email_identity_policy_response(), any()}
| {:error, {:unexpected_response, any()}}
| {:error, term()}
| {:error, delete_email_identity_policy_errors()}
def delete_email_identity_policy(
%Client{} = client,
email_identity,
policy_name,
input,
options \\ []
) do
url_path =
"/v2/email/identities/#{AWS.Util.encode_uri(email_identity)}/policies/#{AWS.Util.encode_uri(policy_name)}"
headers = []
custom_headers = []
query_params = []
meta = metadata()
Request.request_rest(
client,
meta,
:delete,
url_path,
query_params,
custom_headers ++ headers,
input,
options,
200
)
end
@doc """
Deletes an email template.
You can execute this operation no more than once per second.
"""
@spec delete_email_template(map(), String.t() | atom(), delete_email_template_request(), list()) ::
{:ok, delete_email_template_response(), any()}
| {:error, {:unexpected_response, any()}}
| {:error, term()}
| {:error, delete_email_template_errors()}
def delete_email_template(%Client{} = client, template_name, input, options \\ []) do
url_path = "/v2/email/templates/#{AWS.Util.encode_uri(template_name)}"
headers = []
custom_headers = []
query_params = []
meta = metadata()
Request.request_rest(
client,
meta,
:delete,
url_path,
query_params,
custom_headers ++ headers,
input,
options,
200
)
end
@doc """
Deletes a multi-region endpoint (global-endpoint).
Only multi-region endpoints (global-endpoints) whose primary region is the
AWS-Region
where operation is executed can be deleted.
"""
@spec delete_multi_region_endpoint(
map(),
String.t() | atom(),
delete_multi_region_endpoint_request(),
list()
) ::
{:ok, delete_multi_region_endpoint_response(), any()}
| {:error, {:unexpected_response, any()}}
| {:error, term()}
| {:error, delete_multi_region_endpoint_errors()}
def delete_multi_region_endpoint(%Client{} = client, endpoint_name, input, options \\ []) do
url_path = "/v2/email/multi-region-endpoints/#{AWS.Util.encode_uri(endpoint_name)}"
headers = []
custom_headers = []
query_params = []
meta = metadata()
Request.request_rest(
client,
meta,
:delete,
url_path,
query_params,
custom_headers ++ headers,
input,
options,
200
)
end
@doc """
Removes an email address from the suppression list for your account.
"""
@spec delete_suppressed_destination(
map(),
String.t() | atom(),
delete_suppressed_destination_request(),
list()
) ::
{:ok, delete_suppressed_destination_response(), any()}
| {:error, {:unexpected_response, any()}}
| {:error, term()}
| {:error, delete_suppressed_destination_errors()}
def delete_suppressed_destination(%Client{} = client, email_address, input, options \\ []) do
url_path = "/v2/email/suppression/addresses/#{AWS.Util.encode_uri(email_address)}"
headers = []
custom_headers = []
query_params = []
meta = metadata()
Request.request_rest(
client,
meta,
:delete,
url_path,
query_params,
custom_headers ++ headers,
input,
options,
200
)
end
@doc """
Delete an existing tenant.
When you delete a tenant, its associations with resources
are removed, but the resources themselves are not deleted.
"""
@spec delete_tenant(map(), delete_tenant_request(), list()) ::
{:ok, delete_tenant_response(), any()}
| {:error, {:unexpected_response, any()}}
| {:error, term()}
| {:error, delete_tenant_errors()}
def delete_tenant(%Client{} = client, input, options \\ []) do
url_path = "/v2/email/tenants/delete"
headers = []
custom_headers = []
query_params = []
meta = metadata()
Request.request_rest(
client,
meta,
:post,
url_path,
query_params,
custom_headers ++ headers,
input,
options,
200
)
end
@doc """
Delete an association between a tenant and a resource.
When you delete a tenant-resource association, the resource itself is not
deleted,
only its association with the specific tenant is removed. After removal, the
resource
will no longer be available for use with that tenant's email sending operations.
"""
@spec delete_tenant_resource_association(
map(),
delete_tenant_resource_association_request(),
list()
) ::
{:ok, delete_tenant_resource_association_response(), any()}
| {:error, {:unexpected_response, any()}}
| {:error, term()}
| {:error, delete_tenant_resource_association_errors()}
def delete_tenant_resource_association(%Client{} = client, input, options \\ []) do
url_path = "/v2/email/tenants/resources/delete"
headers = []
custom_headers = []
query_params = []
meta = metadata()
Request.request_rest(
client,
meta,
:post,
url_path,
query_params,
custom_headers ++ headers,
input,
options,
200
)
end
@doc """
Obtain information about the email-sending status and capabilities of your
Amazon SES
account in the current Amazon Web Services Region.
"""
@spec get_account(map(), list()) ::
{:ok, get_account_response(), any()}
| {:error, {:unexpected_response, any()}}
| {:error, term()}
| {:error, get_account_errors()}
def get_account(%Client{} = client, options \\ []) do
url_path = "/v2/email/account"
headers = []
query_params = []
meta = metadata()
Request.request_rest(client, meta, :get, url_path, query_params, headers, nil, options, 200)
end
@doc """
Retrieve a list of the blacklists that your dedicated IP addresses appear on.
"""
@spec get_blacklist_reports(map(), String.t() | atom(), list()) ::
{:ok, get_blacklist_reports_response(), any()}
| {:error, {:unexpected_response, any()}}
| {:error, term()}
| {:error, get_blacklist_reports_errors()}
def get_blacklist_reports(%Client{} = client, blacklist_item_names, options \\ []) do
url_path = "/v2/email/deliverability-dashboard/blacklist-report"
headers = []
query_params = []
query_params =
if !is_nil(blacklist_item_names) do
[{"BlacklistItemNames", blacklist_item_names} | query_params]
else
query_params
end
meta = metadata()
Request.request_rest(client, meta, :get, url_path, query_params, headers, nil, options, 200)
end
@doc """
Get information about an existing configuration set, including the dedicated IP
pool
that it's associated with, whether or not it's enabled for sending email, and
more.
*Configuration sets* are groups of rules that you can apply to the
emails you send. You apply a configuration set to an email by including a
reference to
the configuration set in the headers of the email. When you apply a
configuration set to
an email, all of the rules in that configuration set are applied to the email.
"""
@spec get_configuration_set(map(), String.t() | atom(), list()) ::
{:ok, get_configuration_set_response(), any()}
| {:error, {:unexpected_response, any()}}
| {:error, term()}
| {:error, get_configuration_set_errors()}
def get_configuration_set(%Client{} = client, configuration_set_name, options \\ []) do
url_path = "/v2/email/configuration-sets/#{AWS.Util.encode_uri(configuration_set_name)}"
headers = []
query_params = []
meta = metadata()
Request.request_rest(client, meta, :get, url_path, query_params, headers, nil, options, 200)
end
@doc """
Retrieve a list of event destinations that are associated with a configuration
set.
*Events* include message sends, deliveries, opens, clicks, bounces,
and complaints. *Event destinations* are places that you can send
information about these events to. For example, you can send event data to
Amazon EventBridge and
associate a rule to send the event to the specified target.
"""
@spec get_configuration_set_event_destinations(map(), String.t() | atom(), list()) ::
{:ok, get_configuration_set_event_destinations_response(), any()}
| {:error, {:unexpected_response, any()}}
| {:error, term()}
| {:error, get_configuration_set_event_destinations_errors()}
def get_configuration_set_event_destinations(
%Client{} = client,
configuration_set_name,
options \\ []
) do
url_path =
"/v2/email/configuration-sets/#{AWS.Util.encode_uri(configuration_set_name)}/event-destinations"
headers = []
query_params = []
meta = metadata()
Request.request_rest(client, meta, :get, url_path, query_params, headers, nil, options, 200)
end
@doc """
Returns a contact from a contact list.
"""
@spec get_contact(map(), String.t() | atom(), String.t() | atom(), list()) ::
{:ok, get_contact_response(), any()}
| {:error, {:unexpected_response, any()}}
| {:error, term()}
| {:error, get_contact_errors()}
def get_contact(%Client{} = client, contact_list_name, email_address, options \\ []) do
url_path =
"/v2/email/contact-lists/#{AWS.Util.encode_uri(contact_list_name)}/contacts/#{AWS.Util.encode_uri(email_address)}"
headers = []
query_params = []
meta = metadata()
Request.request_rest(client, meta, :get, url_path, query_params, headers, nil, options, 200)
end
@doc """
Returns contact list metadata.
It does not return any information about the contacts
present in the list.
"""
@spec get_contact_list(map(), String.t() | atom(), list()) ::
{:ok, get_contact_list_response(), any()}
| {:error, {:unexpected_response, any()}}
| {:error, term()}
| {:error, get_contact_list_errors()}
def get_contact_list(%Client{} = client, contact_list_name, options \\ []) do
url_path = "/v2/email/contact-lists/#{AWS.Util.encode_uri(contact_list_name)}"
headers = []
query_params = []
meta = metadata()
Request.request_rest(client, meta, :get, url_path, query_params, headers, nil, options, 200)
end
@doc """
Returns the custom email verification template for the template name you
specify.
For more information about custom verification email templates, see [Using custom verification email
templates](https://docs.aws.amazon.com/ses/latest/dg/creating-identities.html#send-email-verify-address-custom)
in the *Amazon SES Developer
Guide*.
You can execute this operation no more than once per second.
"""
@spec get_custom_verification_email_template(map(), String.t() | atom(), list()) ::
{:ok, get_custom_verification_email_template_response(), any()}
| {:error, {:unexpected_response, any()}}
| {:error, term()}
| {:error, get_custom_verification_email_template_errors()}
def get_custom_verification_email_template(%Client{} = client, template_name, options \\ []) do
url_path =
"/v2/email/custom-verification-email-templates/#{AWS.Util.encode_uri(template_name)}"
headers = []
query_params = []
meta = metadata()
Request.request_rest(client, meta, :get, url_path, query_params, headers, nil, options, 200)
end
@doc """
Get information about a dedicated IP address, including the name of the
dedicated IP
pool that it's associated with, as well information about the automatic warm-up
process
for the address.
"""
@spec get_dedicated_ip(map(), String.t() | atom(), list()) ::
{:ok, get_dedicated_ip_response(), any()}
| {:error, {:unexpected_response, any()}}
| {:error, term()}
| {:error, get_dedicated_ip_errors()}
def get_dedicated_ip(%Client{} = client, ip, options \\ []) do
url_path = "/v2/email/dedicated-ips/#{AWS.Util.encode_uri(ip)}"
headers = []
query_params = []
meta = metadata()
Request.request_rest(client, meta, :get, url_path, query_params, headers, nil, options, 200)
end
@doc """
Retrieve information about the dedicated pool.
"""
@spec get_dedicated_ip_pool(map(), String.t() | atom(), list()) ::
{:ok, get_dedicated_ip_pool_response(), any()}
| {:error, {:unexpected_response, any()}}
| {:error, term()}
| {:error, get_dedicated_ip_pool_errors()}
def get_dedicated_ip_pool(%Client{} = client, pool_name, options \\ []) do
url_path = "/v2/email/dedicated-ip-pools/#{AWS.Util.encode_uri(pool_name)}"
headers = []
query_params = []
meta = metadata()
Request.request_rest(client, meta, :get, url_path, query_params, headers, nil, options, 200)
end
@doc """
List the dedicated IP addresses that are associated with your Amazon Web
Services
account.
"""
@spec get_dedicated_ips(
map(),
String.t() | atom() | nil,
String.t() | atom() | nil,
String.t() | atom() | nil,
list()
) ::
{:ok, get_dedicated_ips_response(), any()}
| {:error, {:unexpected_response, any()}}
| {:error, term()}
| {:error, get_dedicated_ips_errors()}
def get_dedicated_ips(
%Client{} = client,
next_token \\ nil,
page_size \\ nil,
pool_name \\ nil,
options \\ []
) do
url_path = "/v2/email/dedicated-ips"
headers = []
query_params = []
query_params =
if !is_nil(pool_name) do
[{"PoolName", pool_name} | query_params]
else
query_params
end
query_params =
if !is_nil(page_size) do
[{"PageSize", page_size} | query_params]
else
query_params
end
query_params =
if !is_nil(next_token) do
[{"NextToken", next_token} | query_params]
else
query_params
end
meta = metadata()
Request.request_rest(client, meta, :get, url_path, query_params, headers, nil, options, 200)
end
@doc """
Retrieve information about the status of the Deliverability dashboard for your
account.
When
the Deliverability dashboard is enabled, you gain access to reputation,
deliverability, and other
metrics for the domains that you use to send email. You also gain the ability to
perform
predictive inbox placement tests.
When you use the Deliverability dashboard, you pay a monthly subscription
charge, in addition
to any other fees that you accrue by using Amazon SES and other Amazon Web
Services services. For more
information about the features and cost of a Deliverability dashboard
subscription, see [Amazon SES Pricing](http://aws.amazon.com/ses/pricing/).
"""
@spec get_deliverability_dashboard_options(map(), list()) ::
{:ok, get_deliverability_dashboard_options_response(), any()}
| {:error, {:unexpected_response, any()}}
| {:error, term()}
| {:error, get_deliverability_dashboard_options_errors()}
def get_deliverability_dashboard_options(%Client{} = client, options \\ []) do
url_path = "/v2/email/deliverability-dashboard"
headers = []
query_params = []
meta = metadata()
Request.request_rest(client, meta, :get, url_path, query_params, headers, nil, options, 200)
end
@doc """
Retrieve the results of a predictive inbox placement test.
"""
@spec get_deliverability_test_report(map(), String.t() | atom(), list()) ::
{:ok, get_deliverability_test_report_response(), any()}
| {:error, {:unexpected_response, any()}}
| {:error, term()}
| {:error, get_deliverability_test_report_errors()}
def get_deliverability_test_report(%Client{} = client, report_id, options \\ []) do
url_path = "/v2/email/deliverability-dashboard/test-reports/#{AWS.Util.encode_uri(report_id)}"
headers = []
query_params = []
meta = metadata()
Request.request_rest(client, meta, :get, url_path, query_params, headers, nil, options, 200)
end
@doc """
Retrieve all the deliverability data for a specific campaign.
This data is available
for a campaign only if the campaign sent email by using a domain that the
Deliverability dashboard is enabled for.
"""
@spec get_domain_deliverability_campaign(map(), String.t() | atom(), list()) ::
{:ok, get_domain_deliverability_campaign_response(), any()}
| {:error, {:unexpected_response, any()}}
| {:error, term()}
| {:error, get_domain_deliverability_campaign_errors()}
def get_domain_deliverability_campaign(%Client{} = client, campaign_id, options \\ []) do
url_path = "/v2/email/deliverability-dashboard/campaigns/#{AWS.Util.encode_uri(campaign_id)}"
headers = []
query_params = []
meta = metadata()
Request.request_rest(client, meta, :get, url_path, query_params, headers, nil, options, 200)
end
@doc """
Retrieve inbox placement and engagement rates for the domains that you use to
send
email.
"""
@spec get_domain_statistics_report(
map(),
String.t() | atom(),
String.t() | atom(),
String.t() | atom(),
list()
) ::
{:ok, get_domain_statistics_report_response(), any()}
| {:error, {:unexpected_response, any()}}
| {:error, term()}
| {:error, get_domain_statistics_report_errors()}
def get_domain_statistics_report(
%Client{} = client,
domain,
end_date,
start_date,
options \\ []
) do
url_path =
"/v2/email/deliverability-dashboard/statistics-report/#{AWS.Util.encode_uri(domain)}"
headers = []
query_params = []
query_params =
if !is_nil(start_date) do
[{"StartDate", start_date} | query_params]
else
query_params
end
query_params =
if !is_nil(end_date) do
[{"EndDate", end_date} | query_params]
else
query_params
end
meta = metadata()
Request.request_rest(client, meta, :get, url_path, query_params, headers, nil, options, 200)
end
@doc """
Provides information about a specific identity, including the identity's
verification
status, sending authorization policies, its DKIM authentication status, and its
custom
Mail-From settings.
"""
@spec get_email_identity(map(), String.t() | atom(), list()) ::
{:ok, get_email_identity_response(), any()}
| {:error, {:unexpected_response, any()}}
| {:error, term()}
| {:error, get_email_identity_errors()}
def get_email_identity(%Client{} = client, email_identity, options \\ []) do
url_path = "/v2/email/identities/#{AWS.Util.encode_uri(email_identity)}"
headers = []
query_params = []
meta = metadata()
Request.request_rest(client, meta, :get, url_path, query_params, headers, nil, options, 200)
end
@doc """
Returns the requested sending authorization policies for the given identity (an
email
address or a domain).
The policies are returned as a map of policy names to policy
contents. You can retrieve a maximum of 20 policies at a time.
This API is for the identity owner only. If you have not verified the identity,
this API will return an error.
Sending authorization is a feature that enables an identity owner to authorize
other
senders to use its identities. For information about using sending
authorization, see
the [Amazon SES Developer Guide](https://docs.aws.amazon.com/ses/latest/DeveloperGuide/sending-authorization.html).
You can execute this operation no more than once per second.
"""
@spec get_email_identity_policies(map(), String.t() | atom(), list()) ::
{:ok, get_email_identity_policies_response(), any()}
| {:error, {:unexpected_response, any()}}
| {:error, term()}
| {:error, get_email_identity_policies_errors()}
def get_email_identity_policies(%Client{} = client, email_identity, options \\ []) do
url_path = "/v2/email/identities/#{AWS.Util.encode_uri(email_identity)}/policies"
headers = []
query_params = []
meta = metadata()
Request.request_rest(client, meta, :get, url_path, query_params, headers, nil, options, 200)
end
@doc """
Displays the template object (which includes the subject line, HTML part and
text
part) for the template you specify.
You can execute this operation no more than once per second.
"""
@spec get_email_template(map(), String.t() | atom(), list()) ::
{:ok, get_email_template_response(), any()}
| {:error, {:unexpected_response, any()}}
| {:error, term()}
| {:error, get_email_template_errors()}
def get_email_template(%Client{} = client, template_name, options \\ []) do
url_path = "/v2/email/templates/#{AWS.Util.encode_uri(template_name)}"
headers = []
query_params = []
meta = metadata()
Request.request_rest(client, meta, :get, url_path, query_params, headers, nil, options, 200)
end
@doc """
Provides information about an export job.
"""
@spec get_export_job(map(), String.t() | atom(), list()) ::
{:ok, get_export_job_response(), any()}
| {:error, {:unexpected_response, any()}}
| {:error, term()}
| {:error, get_export_job_errors()}
def get_export_job(%Client{} = client, job_id, options \\ []) do
url_path = "/v2/email/export-jobs/#{AWS.Util.encode_uri(job_id)}"
headers = []
query_params = []
meta = metadata()
Request.request_rest(client, meta, :get, url_path, query_params, headers, nil, options, 200)
end
@doc """
Provides information about an import job.
"""
@spec get_import_job(map(), String.t() | atom(), list()) ::
{:ok, get_import_job_response(), any()}
| {:error, {:unexpected_response, any()}}
| {:error, term()}
| {:error, get_import_job_errors()}
def get_import_job(%Client{} = client, job_id, options \\ []) do
url_path = "/v2/email/import-jobs/#{AWS.Util.encode_uri(job_id)}"
headers = []
query_params = []
meta = metadata()
Request.request_rest(client, meta, :get, url_path, query_params, headers, nil, options, 200)
end
@doc """
Provides information about a specific message, including the from address, the
subject, the recipient address, email tags, as well as events associated with
the message.
You can execute this operation no more than once per second.
"""
@spec get_message_insights(map(), String.t() | atom(), list()) ::
{:ok, get_message_insights_response(), any()}
| {:error, {:unexpected_response, any()}}
| {:error, term()}
| {:error, get_message_insights_errors()}
def get_message_insights(%Client{} = client, message_id, options \\ []) do
url_path = "/v2/email/insights/#{AWS.Util.encode_uri(message_id)}"
headers = []
query_params = []
meta = metadata()
Request.request_rest(client, meta, :get, url_path, query_params, headers, nil, options, 200)
end
@doc """
Displays the multi-region endpoint (global-endpoint) configuration.
Only multi-region endpoints (global-endpoints) whose primary region is the
AWS-Region
where operation is executed can be displayed.
"""
@spec get_multi_region_endpoint(map(), String.t() | atom(), list()) ::
{:ok, get_multi_region_endpoint_response(), any()}
| {:error, {:unexpected_response, any()}}
| {:error, term()}
| {:error, get_multi_region_endpoint_errors()}
def get_multi_region_endpoint(%Client{} = client, endpoint_name, options \\ []) do
url_path = "/v2/email/multi-region-endpoints/#{AWS.Util.encode_uri(endpoint_name)}"
headers = []
query_params = []
meta = metadata()
Request.request_rest(client, meta, :get, url_path, query_params, headers, nil, options, 200)
end
@doc """
Retrieve information about a specific reputation entity, including its
reputation
management policy, customer-managed status, Amazon Web Services Amazon
SES-managed status, and aggregate
sending status.
*Reputation entities* represent resources in your Amazon SES account that have
reputation
tracking and management capabilities. The reputation impact reflects the highest
impact reputation finding for the entity. Reputation findings can be retrieved
using the `ListRecommendations` operation.
"""
@spec get_reputation_entity(map(), String.t() | atom(), String.t() | atom(), list()) ::
{:ok, get_reputation_entity_response(), any()}
| {:error, {:unexpected_response, any()}}
| {:error, term()}
| {:error, get_reputation_entity_errors()}
def get_reputation_entity(
%Client{} = client,
reputation_entity_reference,
reputation_entity_type,
options \\ []
) do
url_path =
"/v2/email/reputation/entities/#{AWS.Util.encode_uri(reputation_entity_type)}/#{AWS.Util.encode_uri(reputation_entity_reference)}"
headers = []
query_params = []
meta = metadata()
Request.request_rest(client, meta, :get, url_path, query_params, headers, nil, options, 200)
end
@doc """
Retrieves information about a specific email address that's on the suppression
list
for your account.
"""
@spec get_suppressed_destination(map(), String.t() | atom(), list()) ::
{:ok, get_suppressed_destination_response(), any()}
| {:error, {:unexpected_response, any()}}
| {:error, term()}
| {:error, get_suppressed_destination_errors()}
def get_suppressed_destination(%Client{} = client, email_address, options \\ []) do
url_path = "/v2/email/suppression/addresses/#{AWS.Util.encode_uri(email_address)}"
headers = []
query_params = []
meta = metadata()
Request.request_rest(client, meta, :get, url_path, query_params, headers, nil, options, 200)
end
@doc """
Get information about a specific tenant, including the tenant's name, ID, ARN,
creation timestamp, tags, and sending status.
"""
@spec get_tenant(map(), get_tenant_request(), list()) ::
{:ok, get_tenant_response(), any()}
| {:error, {:unexpected_response, any()}}
| {:error, term()}
| {:error, get_tenant_errors()}
def get_tenant(%Client{} = client, input, options \\ []) do
url_path = "/v2/email/tenants/get"
headers = []
custom_headers = []
query_params = []
meta = metadata()
Request.request_rest(
client,
meta,
:post,
url_path,
query_params,
custom_headers ++ headers,
input,
options,
200
)
end
@doc """
List all of the configuration sets associated with your account in the current
region.
*Configuration sets* are groups of rules that you can apply to the
emails you send. You apply a configuration set to an email by including a
reference to
the configuration set in the headers of the email. When you apply a
configuration set to
an email, all of the rules in that configuration set are applied to the email.
"""
@spec list_configuration_sets(
map(),
String.t() | atom() | nil,
String.t() | atom() | nil,
list()
) ::
{:ok, list_configuration_sets_response(), any()}
| {:error, {:unexpected_response, any()}}
| {:error, term()}
| {:error, list_configuration_sets_errors()}
def list_configuration_sets(
%Client{} = client,
next_token \\ nil,
page_size \\ nil,
options \\ []
) do
url_path = "/v2/email/configuration-sets"
headers = []
query_params = []
query_params =
if !is_nil(page_size) do
[{"PageSize", page_size} | query_params]
else
query_params
end
query_params =
if !is_nil(next_token) do
[{"NextToken", next_token} | query_params]
else
query_params
end
meta = metadata()
Request.request_rest(client, meta, :get, url_path, query_params, headers, nil, options, 200)
end
@doc """
Lists all of the contact lists available.
If your output includes a "NextToken" field with a string value, this indicates
there may be additional
contacts on the filtered list - regardless of the number of contacts returned.
"""
@spec list_contact_lists(map(), String.t() | atom() | nil, String.t() | atom() | nil, list()) ::
{:ok, list_contact_lists_response(), any()}
| {:error, {:unexpected_response, any()}}
| {:error, term()}
| {:error, list_contact_lists_errors()}
def list_contact_lists(%Client{} = client, next_token \\ nil, page_size \\ nil, options \\ []) do
url_path = "/v2/email/contact-lists"
headers = []
query_params = []
query_params =
if !is_nil(page_size) do
[{"PageSize", page_size} | query_params]
else
query_params
end
query_params =
if !is_nil(next_token) do
[{"NextToken", next_token} | query_params]
else
query_params
end
meta = metadata()
Request.request_rest(client, meta, :get, url_path, query_params, headers, nil, options, 200)
end
@doc """
Lists the contacts present in a specific contact list.
"""
@spec list_contacts(map(), String.t() | atom(), list_contacts_request(), list()) ::
{:ok, list_contacts_response(), any()}
| {:error, {:unexpected_response, any()}}
| {:error, term()}
| {:error, list_contacts_errors()}
def list_contacts(%Client{} = client, contact_list_name, input, options \\ []) do
url_path = "/v2/email/contact-lists/#{AWS.Util.encode_uri(contact_list_name)}/contacts/list"
headers = []
custom_headers = []
query_params = []
meta = metadata()
Request.request_rest(
client,
meta,
:post,
url_path,
query_params,
custom_headers ++ headers,
input,
options,
200
)
end
@doc """
Lists the existing custom verification email templates for your account in the
current
Amazon Web Services Region.
For more information about custom verification email templates, see [Using custom verification email
templates](https://docs.aws.amazon.com/ses/latest/dg/creating-identities.html#send-email-verify-address-custom)
in the *Amazon SES Developer
Guide*.
You can execute this operation no more than once per second.
"""
@spec list_custom_verification_email_templates(
map(),
String.t() | atom() | nil,
String.t() | atom() | nil,
list()
) ::
{:ok, list_custom_verification_email_templates_response(), any()}
| {:error, {:unexpected_response, any()}}
| {:error, term()}
| {:error, list_custom_verification_email_templates_errors()}
def list_custom_verification_email_templates(
%Client{} = client,
next_token \\ nil,
page_size \\ nil,
options \\ []
) do
url_path = "/v2/email/custom-verification-email-templates"
headers = []
query_params = []
query_params =
if !is_nil(page_size) do
[{"PageSize", page_size} | query_params]
else
query_params
end
query_params =
if !is_nil(next_token) do
[{"NextToken", next_token} | query_params]
else
query_params
end
meta = metadata()
Request.request_rest(client, meta, :get, url_path, query_params, headers, nil, options, 200)
end
@doc """
List all of the dedicated IP pools that exist in your Amazon Web Services
account in the current
Region.
"""
@spec list_dedicated_ip_pools(
map(),
String.t() | atom() | nil,
String.t() | atom() | nil,
list()
) ::
{:ok, list_dedicated_ip_pools_response(), any()}
| {:error, {:unexpected_response, any()}}
| {:error, term()}
| {:error, list_dedicated_ip_pools_errors()}
def list_dedicated_ip_pools(
%Client{} = client,
next_token \\ nil,
page_size \\ nil,
options \\ []
) do
url_path = "/v2/email/dedicated-ip-pools"
headers = []
query_params = []
query_params =
if !is_nil(page_size) do
[{"PageSize", page_size} | query_params]
else
query_params
end
query_params =
if !is_nil(next_token) do
[{"NextToken", next_token} | query_params]
else
query_params
end
meta = metadata()
Request.request_rest(client, meta, :get, url_path, query_params, headers, nil, options, 200)
end
@doc """
Show a list of the predictive inbox placement tests that you've performed,
regardless of their statuses.
For
predictive inbox placement tests that are complete, you can use the
`GetDeliverabilityTestReport`
operation to view the results.
"""
@spec list_deliverability_test_reports(
map(),
String.t() | atom() | nil,
String.t() | atom() | nil,
list()
) ::
{:ok, list_deliverability_test_reports_response(), any()}
| {:error, {:unexpected_response, any()}}
| {:error, term()}
| {:error, list_deliverability_test_reports_errors()}
def list_deliverability_test_reports(
%Client{} = client,
next_token \\ nil,
page_size \\ nil,
options \\ []
) do
url_path = "/v2/email/deliverability-dashboard/test-reports"
headers = []
query_params = []
query_params =
if !is_nil(page_size) do
[{"PageSize", page_size} | query_params]
else
query_params
end
query_params =
if !is_nil(next_token) do
[{"NextToken", next_token} | query_params]
else
query_params
end
meta = metadata()
Request.request_rest(client, meta, :get, url_path, query_params, headers, nil, options, 200)
end
@doc """
Retrieve deliverability data for all the campaigns that used a specific domain
to send
email during a specified time range.
This data is available for a domain only if you
enabled the Deliverability dashboard for the domain.
"""
@spec list_domain_deliverability_campaigns(
map(),
String.t() | atom(),
String.t() | atom(),
String.t() | atom() | nil,
String.t() | atom() | nil,
String.t() | atom(),
list()
) ::
{:ok, list_domain_deliverability_campaigns_response(), any()}
| {:error, {:unexpected_response, any()}}
| {:error, term()}
| {:error, list_domain_deliverability_campaigns_errors()}
def list_domain_deliverability_campaigns(
%Client{} = client,
subscribed_domain,
end_date,
next_token \\ nil,
page_size \\ nil,
start_date,
options \\ []
) do
url_path =
"/v2/email/deliverability-dashboard/domains/#{AWS.Util.encode_uri(subscribed_domain)}/campaigns"
headers = []
query_params = []
query_params =
if !is_nil(start_date) do
[{"StartDate", start_date} | query_params]
else
query_params
end
query_params =
if !is_nil(page_size) do
[{"PageSize", page_size} | query_params]
else
query_params
end
query_params =
if !is_nil(next_token) do
[{"NextToken", next_token} | query_params]
else
query_params
end
query_params =
if !is_nil(end_date) do
[{"EndDate", end_date} | query_params]
else
query_params
end
meta = metadata()
Request.request_rest(client, meta, :get, url_path, query_params, headers, nil, options, 200)
end
@doc """
Returns a list of all of the email identities that are associated with your
Amazon Web Services
account.
An identity can be either an email address or a domain. This operation returns
identities that are verified as well as those that aren't. This operation
returns
identities that are associated with Amazon SES and Amazon Pinpoint.
"""
@spec list_email_identities(map(), String.t() | atom() | nil, String.t() | atom() | nil, list()) ::
{:ok, list_email_identities_response(), any()}
| {:error, {:unexpected_response, any()}}
| {:error, term()}
| {:error, list_email_identities_errors()}
def list_email_identities(
%Client{} = client,
next_token \\ nil,
page_size \\ nil,
options \\ []
) do
url_path = "/v2/email/identities"
headers = []
query_params = []
query_params =
if !is_nil(page_size) do
[{"PageSize", page_size} | query_params]
else
query_params
end
query_params =
if !is_nil(next_token) do
[{"NextToken", next_token} | query_params]
else
query_params
end
meta = metadata()
Request.request_rest(client, meta, :get, url_path, query_params, headers, nil, options, 200)
end
@doc """
Lists the email templates present in your Amazon SES account in the current
Amazon Web Services
Region.
You can execute this operation no more than once per second.
"""
@spec list_email_templates(map(), String.t() | atom() | nil, String.t() | atom() | nil, list()) ::
{:ok, list_email_templates_response(), any()}
| {:error, {:unexpected_response, any()}}
| {:error, term()}
| {:error, list_email_templates_errors()}
def list_email_templates(%Client{} = client, next_token \\ nil, page_size \\ nil, options \\ []) do
url_path = "/v2/email/templates"
headers = []
query_params = []
query_params =
if !is_nil(page_size) do
[{"PageSize", page_size} | query_params]
else
query_params
end
query_params =
if !is_nil(next_token) do
[{"NextToken", next_token} | query_params]
else
query_params
end
meta = metadata()
Request.request_rest(client, meta, :get, url_path, query_params, headers, nil, options, 200)
end
@doc """
Lists all of the export jobs.
"""
@spec list_export_jobs(map(), list_export_jobs_request(), list()) ::
{:ok, list_export_jobs_response(), any()}
| {:error, {:unexpected_response, any()}}
| {:error, term()}
| {:error, list_export_jobs_errors()}
def list_export_jobs(%Client{} = client, input, options \\ []) do
url_path = "/v2/email/list-export-jobs"
headers = []
custom_headers = []
query_params = []
meta = metadata()
Request.request_rest(
client,
meta,
:post,
url_path,
query_params,
custom_headers ++ headers,
input,
options,
200
)
end
@doc """
Lists all of the import jobs.
"""
@spec list_import_jobs(map(), list_import_jobs_request(), list()) ::
{:ok, list_import_jobs_response(), any()}
| {:error, {:unexpected_response, any()}}
| {:error, term()}
| {:error, list_import_jobs_errors()}
def list_import_jobs(%Client{} = client, input, options \\ []) do
url_path = "/v2/email/import-jobs/list"
headers = []
custom_headers = []
query_params = []
meta = metadata()
Request.request_rest(
client,
meta,
:post,
url_path,
query_params,
custom_headers ++ headers,
input,
options,
200
)
end
@doc """
List the multi-region endpoints (global-endpoints).
Only multi-region endpoints (global-endpoints) whose primary region is the
AWS-Region
where operation is executed will be listed.
"""
@spec list_multi_region_endpoints(
map(),
String.t() | atom() | nil,
String.t() | atom() | nil,
list()
) ::
{:ok, list_multi_region_endpoints_response(), any()}
| {:error, {:unexpected_response, any()}}
| {:error, term()}
| {:error, list_multi_region_endpoints_errors()}
def list_multi_region_endpoints(
%Client{} = client,
next_token \\ nil,
page_size \\ nil,
options \\ []
) do
url_path = "/v2/email/multi-region-endpoints"
headers = []
query_params = []
query_params =
if !is_nil(page_size) do
[{"PageSize", page_size} | query_params]
else
query_params
end
query_params =
if !is_nil(next_token) do
[{"NextToken", next_token} | query_params]
else
query_params
end
meta = metadata()
Request.request_rest(client, meta, :get, url_path, query_params, headers, nil, options, 200)
end
@doc """
Lists the recommendations present in your Amazon SES account in the current
Amazon Web Services Region.
You can execute this operation no more than once per second.
"""
@spec list_recommendations(map(), list_recommendations_request(), list()) ::
{:ok, list_recommendations_response(), any()}
| {:error, {:unexpected_response, any()}}
| {:error, term()}
| {:error, list_recommendations_errors()}
def list_recommendations(%Client{} = client, input, options \\ []) do
url_path = "/v2/email/vdm/recommendations"
headers = []
custom_headers = []
query_params = []
meta = metadata()
Request.request_rest(
client,
meta,
:post,
url_path,
query_params,
custom_headers ++ headers,
input,
options,
200
)
end
@doc """
List reputation entities in your Amazon SES account in the current Amazon Web
Services Region.
You can filter the results by entity type, reputation impact, sending status,
or entity reference prefix.
*Reputation entities* represent resources in your account that have reputation
tracking and management capabilities. Use this operation to get an overview of
all entities and their current reputation status.
"""
@spec list_reputation_entities(map(), list_reputation_entities_request(), list()) ::
{:ok, list_reputation_entities_response(), any()}
| {:error, {:unexpected_response, any()}}
| {:error, term()}
| {:error, list_reputation_entities_errors()}
def list_reputation_entities(%Client{} = client, input, options \\ []) do
url_path = "/v2/email/reputation/entities"
headers = []
custom_headers = []
query_params = []
meta = metadata()
Request.request_rest(
client,
meta,
:post,
url_path,
query_params,
custom_headers ++ headers,
input,
options,
200
)
end
@doc """
List all tenants associated with a specific resource.
This operation returns a list of tenants that are associated with the specified
resource. This is useful for understanding which tenants are currently using a
particular
resource such as an email identity, configuration set, or email template.
"""
@spec list_resource_tenants(map(), list_resource_tenants_request(), list()) ::
{:ok, list_resource_tenants_response(), any()}
| {:error, {:unexpected_response, any()}}
| {:error, term()}
| {:error, list_resource_tenants_errors()}
def list_resource_tenants(%Client{} = client, input, options \\ []) do
url_path = "/v2/email/resources/tenants/list"
headers = []
custom_headers = []
query_params = []
meta = metadata()
Request.request_rest(
client,
meta,
:post,
url_path,
query_params,
custom_headers ++ headers,
input,
options,
200
)
end
@doc """
Retrieves a list of email addresses that are on the suppression list for your
account.
"""
@spec list_suppressed_destinations(
map(),
String.t() | atom() | nil,
String.t() | atom() | nil,
String.t() | atom() | nil,
String.t() | atom() | nil,
String.t() | atom() | nil,
list()
) ::
{:ok, list_suppressed_destinations_response(), any()}
| {:error, {:unexpected_response, any()}}
| {:error, term()}
| {:error, list_suppressed_destinations_errors()}
def list_suppressed_destinations(
%Client{} = client,
end_date \\ nil,
next_token \\ nil,
page_size \\ nil,
reasons \\ nil,
start_date \\ nil,
options \\ []
) do
url_path = "/v2/email/suppression/addresses"
headers = []
query_params = []
query_params =
if !is_nil(start_date) do
[{"StartDate", start_date} | query_params]
else
query_params
end
query_params =
if !is_nil(reasons) do
[{"Reason", reasons} | query_params]
else
query_params
end
query_params =
if !is_nil(page_size) do
[{"PageSize", page_size} | query_params]
else
query_params
end
query_params =
if !is_nil(next_token) do
[{"NextToken", next_token} | query_params]
else
query_params
end
query_params =
if !is_nil(end_date) do
[{"EndDate", end_date} | query_params]
else
query_params
end
meta = metadata()
Request.request_rest(client, meta, :get, url_path, query_params, headers, nil, options, 200)
end
@doc """
Retrieve a list of the tags (keys and values) that are associated with a
specified
resource.
A *tag* is a label that you optionally define and associate
with a resource. Each tag consists of a required *tag key* and an
optional associated *tag value*. A tag key is a general label that
acts as a category for more specific tag values. A tag value acts as a
descriptor within
a tag key.
"""
@spec list_tags_for_resource(map(), String.t() | atom(), list()) ::
{:ok, list_tags_for_resource_response(), any()}
| {:error, {:unexpected_response, any()}}
| {:error, term()}
| {:error, list_tags_for_resource_errors()}
def list_tags_for_resource(%Client{} = client, resource_arn, options \\ []) do
url_path = "/v2/email/tags"
headers = []
query_params = []
query_params =
if !is_nil(resource_arn) do
[{"ResourceArn", resource_arn} | query_params]
else
query_params
end
meta = metadata()
Request.request_rest(client, meta, :get, url_path, query_params, headers, nil, options, 200)
end
@doc """
List all resources associated with a specific tenant.
This operation returns a list of resources (email identities, configuration
sets,
or email templates) that are associated with the specified tenant. You can
optionally
filter the results by resource type.
"""
@spec list_tenant_resources(map(), list_tenant_resources_request(), list()) ::
{:ok, list_tenant_resources_response(), any()}
| {:error, {:unexpected_response, any()}}
| {:error, term()}
| {:error, list_tenant_resources_errors()}
def list_tenant_resources(%Client{} = client, input, options \\ []) do
url_path = "/v2/email/tenants/resources/list"
headers = []
custom_headers = []
query_params = []
meta = metadata()
Request.request_rest(
client,
meta,
:post,
url_path,
query_params,
custom_headers ++ headers,
input,
options,
200
)
end
@doc """
List all tenants associated with your account in the current Amazon Web Services
Region.
This operation returns basic information about each tenant,
such as tenant name, ID, ARN, and creation timestamp.
"""
@spec list_tenants(map(), list_tenants_request(), list()) ::
{:ok, list_tenants_response(), any()}
| {:error, {:unexpected_response, any()}}
| {:error, term()}
| {:error, list_tenants_errors()}
def list_tenants(%Client{} = client, input, options \\ []) do
url_path = "/v2/email/tenants/list"
headers = []
custom_headers = []
query_params = []
meta = metadata()
Request.request_rest(
client,
meta,
:post,
url_path,
query_params,
custom_headers ++ headers,
input,
options,
200
)
end
@doc """
Enable or disable the automatic warm-up feature for dedicated IP addresses.
"""
@spec put_account_dedicated_ip_warmup_attributes(
map(),
put_account_dedicated_ip_warmup_attributes_request(),
list()
) ::
{:ok, put_account_dedicated_ip_warmup_attributes_response(), any()}
| {:error, {:unexpected_response, any()}}
| {:error, term()}
| {:error, put_account_dedicated_ip_warmup_attributes_errors()}
def put_account_dedicated_ip_warmup_attributes(%Client{} = client, input, options \\ []) do
url_path = "/v2/email/account/dedicated-ips/warmup"
headers = []
custom_headers = []
query_params = []
meta = metadata()
Request.request_rest(
client,
meta,
:put,
url_path,
query_params,
custom_headers ++ headers,
input,
options,
200
)
end
@doc """
Update your Amazon SES account details.
"""
@spec put_account_details(map(), put_account_details_request(), list()) ::
{:ok, put_account_details_response(), any()}
| {:error, {:unexpected_response, any()}}
| {:error, term()}
| {:error, put_account_details_errors()}
def put_account_details(%Client{} = client, input, options \\ []) do
url_path = "/v2/email/account/details"
headers = []
custom_headers = []
query_params = []
meta = metadata()
Request.request_rest(
client,
meta,
:post,
url_path,
query_params,
custom_headers ++ headers,
input,
options,
200
)
end
@doc """
Enable or disable the ability of your account to send email.
"""
@spec put_account_sending_attributes(map(), put_account_sending_attributes_request(), list()) ::
{:ok, put_account_sending_attributes_response(), any()}
| {:error, {:unexpected_response, any()}}
| {:error, term()}
| {:error, put_account_sending_attributes_errors()}
def put_account_sending_attributes(%Client{} = client, input, options \\ []) do
url_path = "/v2/email/account/sending"
headers = []
custom_headers = []
query_params = []
meta = metadata()
Request.request_rest(
client,
meta,
:put,
url_path,
query_params,
custom_headers ++ headers,
input,
options,
200
)
end
@doc """
Change the settings for the account-level suppression list.
"""
@spec put_account_suppression_attributes(
map(),
put_account_suppression_attributes_request(),
list()
) ::
{:ok, put_account_suppression_attributes_response(), any()}
| {:error, {:unexpected_response, any()}}
| {:error, term()}
| {:error, put_account_suppression_attributes_errors()}
def put_account_suppression_attributes(%Client{} = client, input, options \\ []) do
url_path = "/v2/email/account/suppression"
headers = []
custom_headers = []
query_params = []
meta = metadata()
Request.request_rest(
client,
meta,
:put,
url_path,
query_params,
custom_headers ++ headers,
input,
options,
200
)
end
@doc """
Update your Amazon SES account VDM attributes.
You can execute this operation no more than once per second.
"""
@spec put_account_vdm_attributes(map(), put_account_vdm_attributes_request(), list()) ::
{:ok, put_account_vdm_attributes_response(), any()}
| {:error, {:unexpected_response, any()}}
| {:error, term()}
| {:error, put_account_vdm_attributes_errors()}
def put_account_vdm_attributes(%Client{} = client, input, options \\ []) do
url_path = "/v2/email/account/vdm"
headers = []
custom_headers = []
query_params = []
meta = metadata()
Request.request_rest(
client,
meta,
:put,
url_path,
query_params,
custom_headers ++ headers,
input,
options,
200
)
end
@doc """
Associate the configuration set with a MailManager archive.
When you send email using the
`SendEmail` or `SendBulkEmail` operations the message as it will be given
to the receiving SMTP server will be archived, along with the recipient
information.
"""
@spec put_configuration_set_archiving_options(
map(),
String.t() | atom(),
put_configuration_set_archiving_options_request(),
list()
) ::
{:ok, put_configuration_set_archiving_options_response(), any()}
| {:error, {:unexpected_response, any()}}
| {:error, term()}
| {:error, put_configuration_set_archiving_options_errors()}
def put_configuration_set_archiving_options(
%Client{} = client,
configuration_set_name,
input,
options \\ []
) do
url_path =
"/v2/email/configuration-sets/#{AWS.Util.encode_uri(configuration_set_name)}/archiving-options"
headers = []
custom_headers = []
query_params = []
meta = metadata()
Request.request_rest(
client,
meta,
:put,
url_path,
query_params,
custom_headers ++ headers,
input,
options,
200
)
end
@doc """
Associate a configuration set with a dedicated IP pool.
You can use dedicated IP pools
to create groups of dedicated IP addresses for sending specific types of email.
"""
@spec put_configuration_set_delivery_options(
map(),
String.t() | atom(),
put_configuration_set_delivery_options_request(),
list()
) ::
{:ok, put_configuration_set_delivery_options_response(), any()}
| {:error, {:unexpected_response, any()}}
| {:error, term()}
| {:error, put_configuration_set_delivery_options_errors()}
def put_configuration_set_delivery_options(
%Client{} = client,
configuration_set_name,
input,
options \\ []
) do
url_path =
"/v2/email/configuration-sets/#{AWS.Util.encode_uri(configuration_set_name)}/delivery-options"
headers = []
custom_headers = []
query_params = []
meta = metadata()
Request.request_rest(
client,
meta,
:put,
url_path,
query_params,
custom_headers ++ headers,
input,
options,
200
)
end
@doc """
Enable or disable collection of reputation metrics for emails that you send
using a
particular configuration set in a specific Amazon Web Services Region.
"""
@spec put_configuration_set_reputation_options(
map(),
String.t() | atom(),
put_configuration_set_reputation_options_request(),
list()
) ::
{:ok, put_configuration_set_reputation_options_response(), any()}
| {:error, {:unexpected_response, any()}}
| {:error, term()}
| {:error, put_configuration_set_reputation_options_errors()}
def put_configuration_set_reputation_options(
%Client{} = client,
configuration_set_name,
input,
options \\ []
) do
url_path =
"/v2/email/configuration-sets/#{AWS.Util.encode_uri(configuration_set_name)}/reputation-options"
headers = []
custom_headers = []
query_params = []
meta = metadata()
Request.request_rest(
client,
meta,
:put,
url_path,
query_params,
custom_headers ++ headers,
input,
options,
200
)
end
@doc """
Enable or disable email sending for messages that use a particular configuration
set
in a specific Amazon Web Services Region.
"""
@spec put_configuration_set_sending_options(
map(),
String.t() | atom(),
put_configuration_set_sending_options_request(),
list()
) ::
{:ok, put_configuration_set_sending_options_response(), any()}
| {:error, {:unexpected_response, any()}}
| {:error, term()}
| {:error, put_configuration_set_sending_options_errors()}
def put_configuration_set_sending_options(
%Client{} = client,
configuration_set_name,
input,
options \\ []
) do
url_path =
"/v2/email/configuration-sets/#{AWS.Util.encode_uri(configuration_set_name)}/sending"
headers = []
custom_headers = []
query_params = []
meta = metadata()
Request.request_rest(
client,
meta,
:put,
url_path,
query_params,
custom_headers ++ headers,
input,
options,
200
)
end
@doc """
Specify the account suppression list preferences for a configuration set.
"""
@spec put_configuration_set_suppression_options(
map(),
String.t() | atom(),
put_configuration_set_suppression_options_request(),
list()
) ::
{:ok, put_configuration_set_suppression_options_response(), any()}
| {:error, {:unexpected_response, any()}}
| {:error, term()}
| {:error, put_configuration_set_suppression_options_errors()}
def put_configuration_set_suppression_options(
%Client{} = client,
configuration_set_name,
input,
options \\ []
) do
url_path =
"/v2/email/configuration-sets/#{AWS.Util.encode_uri(configuration_set_name)}/suppression-options"
headers = []
custom_headers = []
query_params = []
meta = metadata()
Request.request_rest(
client,
meta,
:put,
url_path,
query_params,
custom_headers ++ headers,
input,
options,
200
)
end
@doc """
Specify a custom domain to use for open and click tracking elements in email
that you
send.
"""
@spec put_configuration_set_tracking_options(
map(),
String.t() | atom(),
put_configuration_set_tracking_options_request(),
list()
) ::
{:ok, put_configuration_set_tracking_options_response(), any()}
| {:error, {:unexpected_response, any()}}
| {:error, term()}
| {:error, put_configuration_set_tracking_options_errors()}
def put_configuration_set_tracking_options(
%Client{} = client,
configuration_set_name,
input,
options \\ []
) do
url_path =
"/v2/email/configuration-sets/#{AWS.Util.encode_uri(configuration_set_name)}/tracking-options"
headers = []
custom_headers = []
query_params = []
meta = metadata()
Request.request_rest(
client,
meta,
:put,
url_path,
query_params,
custom_headers ++ headers,
input,
options,
200
)
end
@doc """
Specify VDM preferences for email that you send using the configuration set.
You can execute this operation no more than once per second.
"""
@spec put_configuration_set_vdm_options(
map(),
String.t() | atom(),
put_configuration_set_vdm_options_request(),
list()
) ::
{:ok, put_configuration_set_vdm_options_response(), any()}
| {:error, {:unexpected_response, any()}}
| {:error, term()}
| {:error, put_configuration_set_vdm_options_errors()}
def put_configuration_set_vdm_options(
%Client{} = client,
configuration_set_name,
input,
options \\ []
) do
url_path =
"/v2/email/configuration-sets/#{AWS.Util.encode_uri(configuration_set_name)}/vdm-options"
headers = []
custom_headers = []
query_params = []
meta = metadata()
Request.request_rest(
client,
meta,
:put,
url_path,
query_params,
custom_headers ++ headers,
input,
options,
200
)
end
@doc """
Move a dedicated IP address to an existing dedicated IP pool.
The dedicated IP address that you specify must already exist, and must be
associated with your Amazon Web Services account.
The dedicated IP pool you specify must already exist. You can create a new pool
by
using the `CreateDedicatedIpPool` operation.
"""
@spec put_dedicated_ip_in_pool(
map(),
String.t() | atom(),
put_dedicated_ip_in_pool_request(),
list()
) ::
{:ok, put_dedicated_ip_in_pool_response(), any()}
| {:error, {:unexpected_response, any()}}
| {:error, term()}
| {:error, put_dedicated_ip_in_pool_errors()}
def put_dedicated_ip_in_pool(%Client{} = client, ip, input, options \\ []) do
url_path = "/v2/email/dedicated-ips/#{AWS.Util.encode_uri(ip)}/pool"
headers = []
custom_headers = []
query_params = []
meta = metadata()
Request.request_rest(
client,
meta,
:put,
url_path,
query_params,
custom_headers ++ headers,
input,
options,
200
)
end
@doc """
Used to convert a dedicated IP pool to a different scaling mode.
`MANAGED` pools cannot be converted to `STANDARD` scaling mode.
"""
@spec put_dedicated_ip_pool_scaling_attributes(
map(),
String.t() | atom(),
put_dedicated_ip_pool_scaling_attributes_request(),
list()
) ::
{:ok, put_dedicated_ip_pool_scaling_attributes_response(), any()}
| {:error, {:unexpected_response, any()}}
| {:error, term()}
| {:error, put_dedicated_ip_pool_scaling_attributes_errors()}
def put_dedicated_ip_pool_scaling_attributes(
%Client{} = client,
pool_name,
input,
options \\ []
) do
url_path = "/v2/email/dedicated-ip-pools/#{AWS.Util.encode_uri(pool_name)}/scaling"
headers = []
custom_headers = []
query_params = []
meta = metadata()
Request.request_rest(
client,
meta,
:put,
url_path,
query_params,
custom_headers ++ headers,
input,
options,
200
)
end
@spec put_dedicated_ip_warmup_attributes(
map(),
String.t() | atom(),
put_dedicated_ip_warmup_attributes_request(),
list()
) ::
{:ok, put_dedicated_ip_warmup_attributes_response(), any()}
| {:error, {:unexpected_response, any()}}
| {:error, term()}
| {:error, put_dedicated_ip_warmup_attributes_errors()}
def put_dedicated_ip_warmup_attributes(%Client{} = client, ip, input, options \\ []) do
url_path = "/v2/email/dedicated-ips/#{AWS.Util.encode_uri(ip)}/warmup"
headers = []
custom_headers = []
query_params = []
meta = metadata()
Request.request_rest(
client,
meta,
:put,
url_path,
query_params,
custom_headers ++ headers,
input,
options,
200
)
end
@doc """
Enable or disable the Deliverability dashboard.
When you enable the Deliverability dashboard, you gain
access to reputation, deliverability, and other metrics for the domains that you
use to
send email. You also gain the ability to perform predictive inbox placement
tests.
When you use the Deliverability dashboard, you pay a monthly subscription
charge, in addition
to any other fees that you accrue by using Amazon SES and other Amazon Web
Services services. For more
information about the features and cost of a Deliverability dashboard
subscription, see [Amazon SES Pricing](http://aws.amazon.com/ses/pricing/).
"""
@spec put_deliverability_dashboard_option(
map(),
put_deliverability_dashboard_option_request(),
list()
) ::
{:ok, put_deliverability_dashboard_option_response(), any()}
| {:error, {:unexpected_response, any()}}
| {:error, term()}
| {:error, put_deliverability_dashboard_option_errors()}
def put_deliverability_dashboard_option(%Client{} = client, input, options \\ []) do
url_path = "/v2/email/deliverability-dashboard"
headers = []
custom_headers = []
query_params = []
meta = metadata()
Request.request_rest(
client,
meta,
:put,
url_path,
query_params,
custom_headers ++ headers,
input,
options,
200
)
end
@doc """
Used to associate a configuration set with an email identity.
"""
@spec put_email_identity_configuration_set_attributes(
map(),
String.t() | atom(),
put_email_identity_configuration_set_attributes_request(),
list()
) ::
{:ok, put_email_identity_configuration_set_attributes_response(), any()}
| {:error, {:unexpected_response, any()}}
| {:error, term()}
| {:error, put_email_identity_configuration_set_attributes_errors()}
def put_email_identity_configuration_set_attributes(
%Client{} = client,
email_identity,
input,
options \\ []
) do
url_path = "/v2/email/identities/#{AWS.Util.encode_uri(email_identity)}/configuration-set"
headers = []
custom_headers = []
query_params = []
meta = metadata()
Request.request_rest(
client,
meta,
:put,
url_path,
query_params,
custom_headers ++ headers,
input,
options,
200
)
end
@doc """
Used to enable or disable DKIM authentication for an email identity.
"""
@spec put_email_identity_dkim_attributes(
map(),
String.t() | atom(),
put_email_identity_dkim_attributes_request(),
list()
) ::
{:ok, put_email_identity_dkim_attributes_response(), any()}
| {:error, {:unexpected_response, any()}}
| {:error, term()}
| {:error, put_email_identity_dkim_attributes_errors()}
def put_email_identity_dkim_attributes(%Client{} = client, email_identity, input, options \\ []) do
url_path = "/v2/email/identities/#{AWS.Util.encode_uri(email_identity)}/dkim"
headers = []
custom_headers = []
query_params = []
meta = metadata()
Request.request_rest(
client,
meta,
:put,
url_path,
query_params,
custom_headers ++ headers,
input,
options,
200
)
end
@doc """
Used to configure or change the DKIM authentication settings for an email domain
identity.
You can use this operation to do any of the following:
*
Update the signing attributes for an identity that uses Bring Your Own DKIM
(BYODKIM).
*
Update the key length that should be used for Easy DKIM.
*
Change from using no DKIM authentication to using Easy DKIM.
*
Change from using no DKIM authentication to using BYODKIM.
*
Change from using Easy DKIM to using BYODKIM.
*
Change from using BYODKIM to using Easy DKIM.
"""
@spec put_email_identity_dkim_signing_attributes(
map(),
String.t() | atom(),
put_email_identity_dkim_signing_attributes_request(),
list()
) ::
{:ok, put_email_identity_dkim_signing_attributes_response(), any()}
| {:error, {:unexpected_response, any()}}
| {:error, term()}
| {:error, put_email_identity_dkim_signing_attributes_errors()}
def put_email_identity_dkim_signing_attributes(
%Client{} = client,
email_identity,
input,
options \\ []
) do
url_path = "/v1/email/identities/#{AWS.Util.encode_uri(email_identity)}/dkim/signing"
headers = []
custom_headers = []
query_params = []
meta = metadata()
Request.request_rest(
client,
meta,
:put,
url_path,
query_params,
custom_headers ++ headers,
input,
options,
200
)
end
@doc """
Used to enable or disable feedback forwarding for an identity.
This setting determines
what happens when an identity is used to send an email that results in a bounce
or
complaint event.
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).
"""
@spec put_email_identity_feedback_attributes(
map(),
String.t() | atom(),
put_email_identity_feedback_attributes_request(),
list()
) ::
{:ok, put_email_identity_feedback_attributes_response(), any()}
| {:error, {:unexpected_response, any()}}
| {:error, term()}
| {:error, put_email_identity_feedback_attributes_errors()}
def put_email_identity_feedback_attributes(
%Client{} = client,
email_identity,
input,
options \\ []
) do
url_path = "/v2/email/identities/#{AWS.Util.encode_uri(email_identity)}/feedback"
headers = []
custom_headers = []
query_params = []
meta = metadata()
Request.request_rest(
client,
meta,
:put,
url_path,
query_params,
custom_headers ++ headers,
input,
options,
200
)
end
@doc """
Used to enable or disable the custom Mail-From domain configuration for an email
identity.
"""
@spec put_email_identity_mail_from_attributes(
map(),
String.t() | atom(),
put_email_identity_mail_from_attributes_request(),
list()
) ::
{:ok, put_email_identity_mail_from_attributes_response(), any()}
| {:error, {:unexpected_response, any()}}
| {:error, term()}
| {:error, put_email_identity_mail_from_attributes_errors()}
def put_email_identity_mail_from_attributes(
%Client{} = client,
email_identity,
input,
options \\ []
) do
url_path = "/v2/email/identities/#{AWS.Util.encode_uri(email_identity)}/mail-from"
headers = []
custom_headers = []
query_params = []
meta = metadata()
Request.request_rest(
client,
meta,
:put,
url_path,
query_params,
custom_headers ++ headers,
input,
options,
200
)
end
@doc """
Adds an email address to the suppression list for your account.
"""
@spec put_suppressed_destination(map(), put_suppressed_destination_request(), list()) ::
{:ok, put_suppressed_destination_response(), any()}
| {:error, {:unexpected_response, any()}}
| {:error, term()}
| {:error, put_suppressed_destination_errors()}
def put_suppressed_destination(%Client{} = client, input, options \\ []) do
url_path = "/v2/email/suppression/addresses"
headers = []
custom_headers = []
query_params = []
meta = metadata()
Request.request_rest(
client,
meta,
:put,
url_path,
query_params,
custom_headers ++ headers,
input,
options,
200
)
end
@doc """
Composes an email message to multiple destinations.
"""
@spec send_bulk_email(map(), send_bulk_email_request(), list()) ::
{:ok, send_bulk_email_response(), any()}
| {:error, {:unexpected_response, any()}}
| {:error, term()}
| {:error, send_bulk_email_errors()}
def send_bulk_email(%Client{} = client, input, options \\ []) do
url_path = "/v2/email/outbound-bulk-emails"
headers = []
custom_headers = []
query_params = []
meta = metadata()
Request.request_rest(
client,
meta,
:post,
url_path,
query_params,
custom_headers ++ headers,
input,
options,
200
)
end
@doc """
Adds an email address to the list of identities for your Amazon SES account in
the current
Amazon Web Services Region and attempts to verify it.
As a result of executing this
operation, a customized verification email is sent to the specified address.
To use this operation, you must first create a custom verification email
template. For
more information about creating and using custom verification email templates,
see
[Using custom verification email
templates](https://docs.aws.amazon.com/ses/latest/dg/creating-identities.html#send-email-verify-address-custom)
in the *Amazon SES Developer
Guide*.
You can execute this operation no more than once per second.
"""
@spec send_custom_verification_email(map(), send_custom_verification_email_request(), list()) ::
{:ok, send_custom_verification_email_response(), any()}
| {:error, {:unexpected_response, any()}}
| {:error, term()}
| {:error, send_custom_verification_email_errors()}
def send_custom_verification_email(%Client{} = client, input, options \\ []) do
url_path = "/v2/email/outbound-custom-verification-emails"
headers = []
custom_headers = []
query_params = []
meta = metadata()
Request.request_rest(
client,
meta,
:post,
url_path,
query_params,
custom_headers ++ headers,
input,
options,
200
)
end
@doc """
Sends an email message.
You can use the Amazon SES API v2 to send the following types of
messages:
*
**Simple** – A standard email message. When
you create this type of message, you specify the sender, the recipient, and the
message body, and Amazon SES assembles the message for you.
*
**Raw** – A raw, MIME-formatted email
message. When you send this type of email, you have to specify all of the
message headers, as well as the message body. You can use this message type to
send messages that contain attachments. The message that you specify has to be a
valid MIME message.
*
**Templated** – A message that contains
personalization tags. When you send this type of email, Amazon SES API v2
automatically
replaces the tags with values that you specify.
"""
@spec send_email(map(), send_email_request(), list()) ::
{:ok, send_email_response(), any()}
| {:error, {:unexpected_response, any()}}
| {:error, term()}
| {:error, send_email_errors()}
def send_email(%Client{} = client, input, options \\ []) do
url_path = "/v2/email/outbound-emails"
headers = []
custom_headers = []
query_params = []
meta = metadata()
Request.request_rest(
client,
meta,
:post,
url_path,
query_params,
custom_headers ++ headers,
input,
options,
200
)
end
@doc """
Add one or more tags (keys and values) to a specified resource.
A
*tag* is a label that you optionally define and associate with a
resource. Tags can help you categorize and manage resources in different ways,
such as
by purpose, owner, environment, or other criteria. A resource can have as many
as 50
tags.
Each tag consists of a required *tag key* and an
associated *tag value*, both of which you define. A tag key is a
general label that acts as a category for more specific tag values. A tag value
acts as
a descriptor within a tag key.
"""
@spec tag_resource(map(), tag_resource_request(), list()) ::
{:ok, tag_resource_response(), any()}
| {:error, {:unexpected_response, any()}}
| {:error, term()}
| {:error, tag_resource_errors()}
def tag_resource(%Client{} = client, input, options \\ []) do
url_path = "/v2/email/tags"
headers = []
custom_headers = []
query_params = []
meta = metadata()
Request.request_rest(
client,
meta,
:post,
url_path,
query_params,
custom_headers ++ headers,
input,
options,
200
)
end
@doc """
Creates a preview of the MIME content of an email when provided with a template
and a
set of replacement data.
You can execute this operation no more than once per second.
"""
@spec test_render_email_template(
map(),
String.t() | atom(),
test_render_email_template_request(),
list()
) ::
{:ok, test_render_email_template_response(), any()}
| {:error, {:unexpected_response, any()}}
| {:error, term()}
| {:error, test_render_email_template_errors()}
def test_render_email_template(%Client{} = client, template_name, input, options \\ []) do
url_path = "/v2/email/templates/#{AWS.Util.encode_uri(template_name)}/render"
headers = []
custom_headers = []
query_params = []
meta = metadata()
Request.request_rest(
client,
meta,
:post,
url_path,
query_params,
custom_headers ++ headers,
input,
options,
200
)
end
@doc """
Remove one or more tags (keys and values) from a specified resource.
"""
@spec untag_resource(map(), untag_resource_request(), list()) ::
{:ok, untag_resource_response(), any()}
| {:error, {:unexpected_response, any()}}
| {:error, term()}
| {:error, untag_resource_errors()}
def untag_resource(%Client{} = client, input, options \\ []) do
url_path = "/v2/email/tags"
headers = []
custom_headers = []
{query_params, input} =
[
{"ResourceArn", "ResourceArn"},
{"TagKeys", "TagKeys"}
]
|> Request.build_params(input)
meta = metadata()
Request.request_rest(
client,
meta,
:delete,
url_path,
query_params,
custom_headers ++ headers,
input,
options,
200
)
end
@doc """
Update the configuration of an event destination for a configuration set.
*Events* include message sends, deliveries, opens, clicks, bounces,
and complaints. *Event destinations* are places that you can send
information about these events to. For example, you can send event data to
Amazon EventBridge and
associate a rule to send the event to the specified target.
"""
@spec update_configuration_set_event_destination(
map(),
String.t() | atom(),
String.t() | atom(),
update_configuration_set_event_destination_request(),
list()
) ::
{:ok, update_configuration_set_event_destination_response(), any()}
| {:error, {:unexpected_response, any()}}
| {:error, term()}
| {:error, update_configuration_set_event_destination_errors()}
def update_configuration_set_event_destination(
%Client{} = client,
configuration_set_name,
event_destination_name,
input,
options \\ []
) do
url_path =
"/v2/email/configuration-sets/#{AWS.Util.encode_uri(configuration_set_name)}/event-destinations/#{AWS.Util.encode_uri(event_destination_name)}"
headers = []
custom_headers = []
query_params = []
meta = metadata()
Request.request_rest(
client,
meta,
:put,
url_path,
query_params,
custom_headers ++ headers,
input,
options,
200
)
end
@doc """
Updates a contact's preferences for a list.
You must specify all existing topic preferences in the
`TopicPreferences` object, not just the ones that need updating;
otherwise, all your existing preferences will be removed.
"""
@spec update_contact(
map(),
String.t() | atom(),
String.t() | atom(),
update_contact_request(),
list()
) ::
{:ok, update_contact_response(), any()}
| {:error, {:unexpected_response, any()}}
| {:error, term()}
| {:error, update_contact_errors()}
def update_contact(%Client{} = client, contact_list_name, email_address, input, options \\ []) do
url_path =
"/v2/email/contact-lists/#{AWS.Util.encode_uri(contact_list_name)}/contacts/#{AWS.Util.encode_uri(email_address)}"
headers = []
custom_headers = []
query_params = []
meta = metadata()
Request.request_rest(
client,
meta,
:put,
url_path,
query_params,
custom_headers ++ headers,
input,
options,
200
)
end
@doc """
Updates contact list metadata.
This operation does a complete replacement.
"""
@spec update_contact_list(map(), String.t() | atom(), update_contact_list_request(), list()) ::
{:ok, update_contact_list_response(), any()}
| {:error, {:unexpected_response, any()}}
| {:error, term()}
| {:error, update_contact_list_errors()}
def update_contact_list(%Client{} = client, contact_list_name, input, options \\ []) do
url_path = "/v2/email/contact-lists/#{AWS.Util.encode_uri(contact_list_name)}"
headers = []
custom_headers = []
query_params = []
meta = metadata()
Request.request_rest(
client,
meta,
:put,
url_path,
query_params,
custom_headers ++ headers,
input,
options,
200
)
end
@doc """
Updates an existing custom verification email template.
For more information about custom verification email templates, see [Using custom verification email
templates](https://docs.aws.amazon.com/ses/latest/dg/creating-identities.html#send-email-verify-address-custom)
in the *Amazon SES Developer
Guide*.
You can execute this operation no more than once per second.
"""
@spec update_custom_verification_email_template(
map(),
String.t() | atom(),
update_custom_verification_email_template_request(),
list()
) ::
{:ok, update_custom_verification_email_template_response(), any()}
| {:error, {:unexpected_response, any()}}
| {:error, term()}
| {:error, update_custom_verification_email_template_errors()}
def update_custom_verification_email_template(
%Client{} = client,
template_name,
input,
options \\ []
) do
url_path =
"/v2/email/custom-verification-email-templates/#{AWS.Util.encode_uri(template_name)}"
headers = []
custom_headers = []
query_params = []
meta = metadata()
Request.request_rest(
client,
meta,
:put,
url_path,
query_params,
custom_headers ++ headers,
input,
options,
200
)
end
@doc """
Updates the specified sending authorization policy for the given identity (an
email
address or a domain).
This API returns successfully even if a policy with the specified
name does not exist.
This API is for the identity owner only. If you have not verified the identity,
this API will return an error.
Sending authorization is a feature that enables an identity owner to authorize
other
senders to use its identities. For information about using sending
authorization, see
the [Amazon SES Developer Guide](https://docs.aws.amazon.com/ses/latest/DeveloperGuide/sending-authorization.html).
You can execute this operation no more than once per second.
"""
@spec update_email_identity_policy(
map(),
String.t() | atom(),
String.t() | atom(),
update_email_identity_policy_request(),
list()
) ::
{:ok, update_email_identity_policy_response(), any()}
| {:error, {:unexpected_response, any()}}
| {:error, term()}
| {:error, update_email_identity_policy_errors()}
def update_email_identity_policy(
%Client{} = client,
email_identity,
policy_name,
input,
options \\ []
) do
url_path =
"/v2/email/identities/#{AWS.Util.encode_uri(email_identity)}/policies/#{AWS.Util.encode_uri(policy_name)}"
headers = []
custom_headers = []
query_params = []
meta = metadata()
Request.request_rest(
client,
meta,
:put,
url_path,
query_params,
custom_headers ++ headers,
input,
options,
200
)
end
@doc """
Updates an email template.
Email templates enable you to send personalized email to
one or more destinations in a single API operation. For more information, see
the [Amazon SES Developer Guide](https://docs.aws.amazon.com/ses/latest/DeveloperGuide/send-personalized-email-api.html).
You can execute this operation no more than once per second.
"""
@spec update_email_template(map(), String.t() | atom(), update_email_template_request(), list()) ::
{:ok, update_email_template_response(), any()}
| {:error, {:unexpected_response, any()}}
| {:error, term()}
| {:error, update_email_template_errors()}
def update_email_template(%Client{} = client, template_name, input, options \\ []) do
url_path = "/v2/email/templates/#{AWS.Util.encode_uri(template_name)}"
headers = []
custom_headers = []
query_params = []
meta = metadata()
Request.request_rest(
client,
meta,
:put,
url_path,
query_params,
custom_headers ++ headers,
input,
options,
200
)
end
@doc """
Update the customer-managed sending status for a reputation entity.
This allows
you to enable, disable, or reinstate sending for the entity.
The customer-managed status works in conjunction with the Amazon Web Services
Amazon SES-managed status
to determine the overall sending capability. When you update the
customer-managed status,
the Amazon Web Services Amazon SES-managed status remains unchanged. If Amazon
Web Services Amazon SES has disabled the entity,
it will not be allowed to send regardless of the customer-managed status
setting. When you
reinstate an entity through the customer-managed status, it can continue sending
only if
the Amazon Web Services Amazon SES-managed status also permits sending, even if
there are active reputation
findings, until the findings are resolved or new violations occur.
"""
@spec update_reputation_entity_customer_managed_status(
map(),
String.t() | atom(),
String.t() | atom(),
update_reputation_entity_customer_managed_status_request(),
list()
) ::
{:ok, update_reputation_entity_customer_managed_status_response(), any()}
| {:error, {:unexpected_response, any()}}
| {:error, term()}
| {:error, update_reputation_entity_customer_managed_status_errors()}
def update_reputation_entity_customer_managed_status(
%Client{} = client,
reputation_entity_reference,
reputation_entity_type,
input,
options \\ []
) do
url_path =
"/v2/email/reputation/entities/#{AWS.Util.encode_uri(reputation_entity_type)}/#{AWS.Util.encode_uri(reputation_entity_reference)}/customer-managed-status"
headers = []
custom_headers = []
query_params = []
meta = metadata()
Request.request_rest(
client,
meta,
:put,
url_path,
query_params,
custom_headers ++ headers,
input,
options,
200
)
end
@doc """
Update the reputation management policy for a reputation entity.
The policy
determines how the entity responds to reputation findings, such as automatically
pausing sending when certain thresholds are exceeded.
Reputation management policies are Amazon Web Services Amazon SES-managed
(predefined policies).
You can select from none, standard, and strict policies.
"""
@spec update_reputation_entity_policy(
map(),
String.t() | atom(),
String.t() | atom(),
update_reputation_entity_policy_request(),
list()
) ::
{:ok, update_reputation_entity_policy_response(), any()}
| {:error, {:unexpected_response, any()}}
| {:error, term()}
| {:error, update_reputation_entity_policy_errors()}
def update_reputation_entity_policy(
%Client{} = client,
reputation_entity_reference,
reputation_entity_type,
input,
options \\ []
) do
url_path =
"/v2/email/reputation/entities/#{AWS.Util.encode_uri(reputation_entity_type)}/#{AWS.Util.encode_uri(reputation_entity_reference)}/policy"
headers = []
custom_headers = []
query_params = []
meta = metadata()
Request.request_rest(
client,
meta,
:put,
url_path,
query_params,
custom_headers ++ headers,
input,
options,
200
)
end
end
