SESV2Client#
Auto-generated documentation for SESV2 type annotations stubs module mypy-boto3-sesv2.
SESV2Client#
Type annotations and code completion for boto3.client("sesv2").
boto3 documentation
# SESV2Client usage example
from boto3.session import Session
from mypy_boto3_sesv2.client import SESV2Client
def get_sesv2_client() -> SESV2Client:
return Session().client("sesv2")Exceptions#
boto3 client exceptions are generated in runtime.
This class provides code completion for boto3.client("sesv2").exceptions structure.
# Exceptions.exceptions usage example
client = boto3.client("sesv2")
try:
do_something(client)
except (
client.exceptions.AccountSuspendedException,
client.exceptions.AlreadyExistsException,
client.exceptions.BadRequestException,
client.exceptions.ClientError,
client.exceptions.ConcurrentModificationException,
client.exceptions.ConflictException,
client.exceptions.InternalServiceErrorException,
client.exceptions.InvalidNextTokenException,
client.exceptions.LimitExceededException,
client.exceptions.MailFromDomainNotVerifiedException,
client.exceptions.MessageRejected,
client.exceptions.NotFoundException,
client.exceptions.SendingPausedException,
client.exceptions.TooManyRequestsException,
) as e:
print(e)# Exceptions.exceptions type checking example
from mypy_boto3_sesv2.client import Exceptions
def handle_error(exc: Exceptions.AccountSuspendedException) -> None:
...Methods#
can_paginate#
Type annotations and code completion for boto3.client("sesv2").can_paginate method.
boto3 documentation
# can_paginate method definition
def can_paginate(
self,
operation_name: str,
) -> bool:
...generate_presigned_url#
Type annotations and code completion for boto3.client("sesv2").generate_presigned_url method.
boto3 documentation
# generate_presigned_url method definition
def generate_presigned_url(
self,
ClientMethod: str,
Params: Mapping[str, Any] = ...,
ExpiresIn: int = 3600,
HttpMethod: str = ...,
) -> str:
...batch_get_metric_data#
Retrieves batches of metric data collected based on your sending activity.
Type annotations and code completion for boto3.client("sesv2").batch_get_metric_data method.
boto3 documentation
# batch_get_metric_data method definition
def batch_get_metric_data(
self,
*,
Queries: Sequence[BatchGetMetricDataQueryTypeDef], # (1)
) -> BatchGetMetricDataResponseTypeDef: # (2)
...# batch_get_metric_data method usage example with argument unpacking
kwargs: BatchGetMetricDataRequestRequestTypeDef = { # (1)
"Queries": ...,
}
parent.batch_get_metric_data(**kwargs)cancel_export_job#
Cancels an export job.
Type annotations and code completion for boto3.client("sesv2").cancel_export_job method.
boto3 documentation
# cancel_export_job method definition
def cancel_export_job(
self,
*,
JobId: str,
) -> dict[str, Any]:
...# cancel_export_job method usage example with argument unpacking
kwargs: CancelExportJobRequestRequestTypeDef = { # (1)
"JobId": ...,
}
parent.cancel_export_job(**kwargs)create_configuration_set#
Create a configuration set.
Type annotations and code completion for boto3.client("sesv2").create_configuration_set method.
boto3 documentation
# create_configuration_set method definition
def create_configuration_set(
self,
*,
ConfigurationSetName: str,
TrackingOptions: TrackingOptionsTypeDef = ..., # (1)
DeliveryOptions: DeliveryOptionsTypeDef = ..., # (2)
ReputationOptions: ReputationOptionsTypeDef = ..., # (3)
SendingOptions: SendingOptionsTypeDef = ..., # (4)
Tags: Sequence[TagTypeDef] = ..., # (5)
SuppressionOptions: SuppressionOptionsTypeDef = ..., # (6)
VdmOptions: VdmOptionsTypeDef = ..., # (7)
) -> dict[str, Any]:
...- See TrackingOptionsTypeDef
- See DeliveryOptionsTypeDef
- See ReputationOptionsTypeDef
- See SendingOptionsTypeDef
- See TagTypeDef
- See SuppressionOptionsTypeDef
- See VdmOptionsTypeDef
# create_configuration_set method usage example with argument unpacking
kwargs: CreateConfigurationSetRequestRequestTypeDef = { # (1)
"ConfigurationSetName": ...,
}
parent.create_configuration_set(**kwargs)create_configuration_set_event_destination#
Create an event destination.
Type annotations and code completion for boto3.client("sesv2").create_configuration_set_event_destination method.
boto3 documentation
# create_configuration_set_event_destination method definition
def create_configuration_set_event_destination(
self,
*,
ConfigurationSetName: str,
EventDestinationName: str,
EventDestination: EventDestinationDefinitionTypeDef, # (1)
) -> dict[str, Any]:
...# create_configuration_set_event_destination method usage example with argument unpacking
kwargs: CreateConfigurationSetEventDestinationRequestRequestTypeDef = { # (1)
"ConfigurationSetName": ...,
"EventDestinationName": ...,
"EventDestination": ...,
}
parent.create_configuration_set_event_destination(**kwargs)create_contact#
Creates a contact, which is an end-user who is receiving the email, and adds them to a contact list.
Type annotations and code completion for boto3.client("sesv2").create_contact method.
boto3 documentation
# create_contact method definition
def create_contact(
self,
*,
ContactListName: str,
EmailAddress: str,
TopicPreferences: Sequence[TopicPreferenceTypeDef] = ..., # (1)
UnsubscribeAll: bool = ...,
AttributesData: str = ...,
) -> dict[str, Any]:
...# create_contact method usage example with argument unpacking
kwargs: CreateContactRequestRequestTypeDef = { # (1)
"ContactListName": ...,
"EmailAddress": ...,
}
parent.create_contact(**kwargs)create_contact_list#
Creates a contact list.
Type annotations and code completion for boto3.client("sesv2").create_contact_list method.
boto3 documentation
# create_contact_list method definition
def create_contact_list(
self,
*,
ContactListName: str,
Topics: Sequence[TopicTypeDef] = ..., # (1)
Description: str = ...,
Tags: Sequence[TagTypeDef] = ..., # (2)
) -> dict[str, Any]:
...- See TopicTypeDef
- See TagTypeDef
# create_contact_list method usage example with argument unpacking
kwargs: CreateContactListRequestRequestTypeDef = { # (1)
"ContactListName": ...,
}
parent.create_contact_list(**kwargs)create_custom_verification_email_template#
Creates a new custom verification email template.
Type annotations and code completion for boto3.client("sesv2").create_custom_verification_email_template method.
boto3 documentation
# create_custom_verification_email_template method definition
def create_custom_verification_email_template(
self,
*,
TemplateName: str,
FromEmailAddress: str,
TemplateSubject: str,
TemplateContent: str,
SuccessRedirectionURL: str,
FailureRedirectionURL: str,
) -> dict[str, Any]:
...# create_custom_verification_email_template method usage example with argument unpacking
kwargs: CreateCustomVerificationEmailTemplateRequestRequestTypeDef = { # (1)
"TemplateName": ...,
"FromEmailAddress": ...,
"TemplateSubject": ...,
"TemplateContent": ...,
"SuccessRedirectionURL": ...,
"FailureRedirectionURL": ...,
}
parent.create_custom_verification_email_template(**kwargs)create_dedicated_ip_pool#
Create a new pool of dedicated IP addresses.
Type annotations and code completion for boto3.client("sesv2").create_dedicated_ip_pool method.
boto3 documentation
# create_dedicated_ip_pool method definition
def create_dedicated_ip_pool(
self,
*,
PoolName: str,
Tags: Sequence[TagTypeDef] = ..., # (1)
ScalingMode: ScalingModeType = ..., # (2)
) -> dict[str, Any]:
...- See TagTypeDef
- See ScalingModeType
# create_dedicated_ip_pool method usage example with argument unpacking
kwargs: CreateDedicatedIpPoolRequestRequestTypeDef = { # (1)
"PoolName": ...,
}
parent.create_dedicated_ip_pool(**kwargs)create_deliverability_test_report#
Create a new predictive inbox placement test.
Type annotations and code completion for boto3.client("sesv2").create_deliverability_test_report method.
boto3 documentation
# create_deliverability_test_report method definition
def create_deliverability_test_report(
self,
*,
FromEmailAddress: str,
Content: EmailContentTypeDef, # (1)
ReportName: str = ...,
Tags: Sequence[TagTypeDef] = ..., # (2)
) -> CreateDeliverabilityTestReportResponseTypeDef: # (3)
...# create_deliverability_test_report method usage example with argument unpacking
kwargs: CreateDeliverabilityTestReportRequestRequestTypeDef = { # (1)
"FromEmailAddress": ...,
"Content": ...,
}
parent.create_deliverability_test_report(**kwargs)create_email_identity#
Starts the process of verifying an email identity.
Type annotations and code completion for boto3.client("sesv2").create_email_identity method.
boto3 documentation
# create_email_identity method definition
def create_email_identity(
self,
*,
EmailIdentity: str,
Tags: Sequence[TagTypeDef] = ..., # (1)
DkimSigningAttributes: DkimSigningAttributesTypeDef = ..., # (2)
ConfigurationSetName: str = ...,
) -> CreateEmailIdentityResponseTypeDef: # (3)
...# create_email_identity method usage example with argument unpacking
kwargs: CreateEmailIdentityRequestRequestTypeDef = { # (1)
"EmailIdentity": ...,
}
parent.create_email_identity(**kwargs)create_email_identity_policy#
Creates the specified sending authorization policy for the given identity (an email address or a domain).
Type annotations and code completion for boto3.client("sesv2").create_email_identity_policy method.
boto3 documentation
# create_email_identity_policy method definition
def create_email_identity_policy(
self,
*,
EmailIdentity: str,
PolicyName: str,
Policy: str,
) -> dict[str, Any]:
...# create_email_identity_policy method usage example with argument unpacking
kwargs: CreateEmailIdentityPolicyRequestRequestTypeDef = { # (1)
"EmailIdentity": ...,
"PolicyName": ...,
"Policy": ...,
}
parent.create_email_identity_policy(**kwargs)create_email_template#
Creates an email template.
Type annotations and code completion for boto3.client("sesv2").create_email_template method.
boto3 documentation
# create_email_template method definition
def create_email_template(
self,
*,
TemplateName: str,
TemplateContent: EmailTemplateContentTypeDef, # (1)
) -> dict[str, Any]:
...# create_email_template method usage example with argument unpacking
kwargs: CreateEmailTemplateRequestRequestTypeDef = { # (1)
"TemplateName": ...,
"TemplateContent": ...,
}
parent.create_email_template(**kwargs)create_export_job#
Creates an export job for a data source and destination.
Type annotations and code completion for boto3.client("sesv2").create_export_job method.
boto3 documentation
# create_export_job method definition
def create_export_job(
self,
*,
ExportDataSource: ExportDataSourceTypeDef, # (1)
ExportDestination: ExportDestinationTypeDef, # (2)
) -> CreateExportJobResponseTypeDef: # (3)
...# create_export_job method usage example with argument unpacking
kwargs: CreateExportJobRequestRequestTypeDef = { # (1)
"ExportDataSource": ...,
"ExportDestination": ...,
}
parent.create_export_job(**kwargs)create_import_job#
Creates an import job for a data destination.
Type annotations and code completion for boto3.client("sesv2").create_import_job method.
boto3 documentation
# create_import_job method definition
def create_import_job(
self,
*,
ImportDestination: ImportDestinationTypeDef, # (1)
ImportDataSource: ImportDataSourceTypeDef, # (2)
) -> CreateImportJobResponseTypeDef: # (3)
...# create_import_job method usage example with argument unpacking
kwargs: CreateImportJobRequestRequestTypeDef = { # (1)
"ImportDestination": ...,
"ImportDataSource": ...,
}
parent.create_import_job(**kwargs)create_multi_region_endpoint#
Creates a multi-region endpoint (global-endpoint).
Type annotations and code completion for boto3.client("sesv2").create_multi_region_endpoint method.
boto3 documentation
# create_multi_region_endpoint method definition
def create_multi_region_endpoint(
self,
*,
EndpointName: str,
Details: DetailsTypeDef, # (1)
Tags: Sequence[TagTypeDef] = ..., # (2)
) -> CreateMultiRegionEndpointResponseTypeDef: # (3)
...# create_multi_region_endpoint method usage example with argument unpacking
kwargs: CreateMultiRegionEndpointRequestRequestTypeDef = { # (1)
"EndpointName": ...,
"Details": ...,
}
parent.create_multi_region_endpoint(**kwargs)delete_configuration_set#
Delete an existing configuration set.
Type annotations and code completion for boto3.client("sesv2").delete_configuration_set method.
boto3 documentation
# delete_configuration_set method definition
def delete_configuration_set(
self,
*,
ConfigurationSetName: str,
) -> dict[str, Any]:
...# delete_configuration_set method usage example with argument unpacking
kwargs: DeleteConfigurationSetRequestRequestTypeDef = { # (1)
"ConfigurationSetName": ...,
}
parent.delete_configuration_set(**kwargs)delete_configuration_set_event_destination#
Delete an event destination.
Type annotations and code completion for boto3.client("sesv2").delete_configuration_set_event_destination method.
boto3 documentation
# delete_configuration_set_event_destination method definition
def delete_configuration_set_event_destination(
self,
*,
ConfigurationSetName: str,
EventDestinationName: str,
) -> dict[str, Any]:
...# delete_configuration_set_event_destination method usage example with argument unpacking
kwargs: DeleteConfigurationSetEventDestinationRequestRequestTypeDef = { # (1)
"ConfigurationSetName": ...,
"EventDestinationName": ...,
}
parent.delete_configuration_set_event_destination(**kwargs)delete_contact#
Removes a contact from a contact list.
Type annotations and code completion for boto3.client("sesv2").delete_contact method.
boto3 documentation
# delete_contact method definition
def delete_contact(
self,
*,
ContactListName: str,
EmailAddress: str,
) -> dict[str, Any]:
...# delete_contact method usage example with argument unpacking
kwargs: DeleteContactRequestRequestTypeDef = { # (1)
"ContactListName": ...,
"EmailAddress": ...,
}
parent.delete_contact(**kwargs)delete_contact_list#
Deletes a contact list and all of the contacts on that list.
Type annotations and code completion for boto3.client("sesv2").delete_contact_list method.
boto3 documentation
# delete_contact_list method definition
def delete_contact_list(
self,
*,
ContactListName: str,
) -> dict[str, Any]:
...# delete_contact_list method usage example with argument unpacking
kwargs: DeleteContactListRequestRequestTypeDef = { # (1)
"ContactListName": ...,
}
parent.delete_contact_list(**kwargs)delete_custom_verification_email_template#
Deletes an existing custom verification email template.
Type annotations and code completion for boto3.client("sesv2").delete_custom_verification_email_template method.
boto3 documentation
# delete_custom_verification_email_template method definition
def delete_custom_verification_email_template(
self,
*,
TemplateName: str,
) -> dict[str, Any]:
...# delete_custom_verification_email_template method usage example with argument unpacking
kwargs: DeleteCustomVerificationEmailTemplateRequestRequestTypeDef = { # (1)
"TemplateName": ...,
}
parent.delete_custom_verification_email_template(**kwargs)delete_dedicated_ip_pool#
Delete a dedicated IP pool.
Type annotations and code completion for boto3.client("sesv2").delete_dedicated_ip_pool method.
boto3 documentation
# delete_dedicated_ip_pool method definition
def delete_dedicated_ip_pool(
self,
*,
PoolName: str,
) -> dict[str, Any]:
...# delete_dedicated_ip_pool method usage example with argument unpacking
kwargs: DeleteDedicatedIpPoolRequestRequestTypeDef = { # (1)
"PoolName": ...,
}
parent.delete_dedicated_ip_pool(**kwargs)delete_email_identity#
Deletes an email identity.
Type annotations and code completion for boto3.client("sesv2").delete_email_identity method.
boto3 documentation
# delete_email_identity method definition
def delete_email_identity(
self,
*,
EmailIdentity: str,
) -> dict[str, Any]:
...# delete_email_identity method usage example with argument unpacking
kwargs: DeleteEmailIdentityRequestRequestTypeDef = { # (1)
"EmailIdentity": ...,
}
parent.delete_email_identity(**kwargs)delete_email_identity_policy#
Deletes the specified sending authorization policy for the given identity (an email address or a domain).
Type annotations and code completion for boto3.client("sesv2").delete_email_identity_policy method.
boto3 documentation
# delete_email_identity_policy method definition
def delete_email_identity_policy(
self,
*,
EmailIdentity: str,
PolicyName: str,
) -> dict[str, Any]:
...# delete_email_identity_policy method usage example with argument unpacking
kwargs: DeleteEmailIdentityPolicyRequestRequestTypeDef = { # (1)
"EmailIdentity": ...,
"PolicyName": ...,
}
parent.delete_email_identity_policy(**kwargs)delete_email_template#
Deletes an email template.
Type annotations and code completion for boto3.client("sesv2").delete_email_template method.
boto3 documentation
# delete_email_template method definition
def delete_email_template(
self,
*,
TemplateName: str,
) -> dict[str, Any]:
...# delete_email_template method usage example with argument unpacking
kwargs: DeleteEmailTemplateRequestRequestTypeDef = { # (1)
"TemplateName": ...,
}
parent.delete_email_template(**kwargs)delete_multi_region_endpoint#
Deletes a multi-region endpoint (global-endpoint).
Type annotations and code completion for boto3.client("sesv2").delete_multi_region_endpoint method.
boto3 documentation
# delete_multi_region_endpoint method definition
def delete_multi_region_endpoint(
self,
*,
EndpointName: str,
) -> DeleteMultiRegionEndpointResponseTypeDef: # (1)
...# delete_multi_region_endpoint method usage example with argument unpacking
kwargs: DeleteMultiRegionEndpointRequestRequestTypeDef = { # (1)
"EndpointName": ...,
}
parent.delete_multi_region_endpoint(**kwargs)delete_suppressed_destination#
Removes an email address from the suppression list for your account.
Type annotations and code completion for boto3.client("sesv2").delete_suppressed_destination method.
boto3 documentation
# delete_suppressed_destination method definition
def delete_suppressed_destination(
self,
*,
EmailAddress: str,
) -> dict[str, Any]:
...# delete_suppressed_destination method usage example with argument unpacking
kwargs: DeleteSuppressedDestinationRequestRequestTypeDef = { # (1)
"EmailAddress": ...,
}
parent.delete_suppressed_destination(**kwargs)get_account#
Obtain information about the email-sending status and capabilities of your Amazon SES account in the current Amazon Web Services Region.
Type annotations and code completion for boto3.client("sesv2").get_account method.
boto3 documentation
# get_account method definition
def get_account(
self,
) -> GetAccountResponseTypeDef: # (1)
...get_blacklist_reports#
Retrieve a list of the blacklists that your dedicated IP addresses appear on.
Type annotations and code completion for boto3.client("sesv2").get_blacklist_reports method.
boto3 documentation
# get_blacklist_reports method definition
def get_blacklist_reports(
self,
*,
BlacklistItemNames: Sequence[str],
) -> GetBlacklistReportsResponseTypeDef: # (1)
...# get_blacklist_reports method usage example with argument unpacking
kwargs: GetBlacklistReportsRequestRequestTypeDef = { # (1)
"BlacklistItemNames": ...,
}
parent.get_blacklist_reports(**kwargs)get_configuration_set#
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.
Type annotations and code completion for boto3.client("sesv2").get_configuration_set method.
boto3 documentation
# get_configuration_set method definition
def get_configuration_set(
self,
*,
ConfigurationSetName: str,
) -> GetConfigurationSetResponseTypeDef: # (1)
...# get_configuration_set method usage example with argument unpacking
kwargs: GetConfigurationSetRequestRequestTypeDef = { # (1)
"ConfigurationSetName": ...,
}
parent.get_configuration_set(**kwargs)get_configuration_set_event_destinations#
Retrieve a list of event destinations that are associated with a configuration set.
Type annotations and code completion for boto3.client("sesv2").get_configuration_set_event_destinations method.
boto3 documentation
# get_configuration_set_event_destinations method definition
def get_configuration_set_event_destinations(
self,
*,
ConfigurationSetName: str,
) -> GetConfigurationSetEventDestinationsResponseTypeDef: # (1)
...# get_configuration_set_event_destinations method usage example with argument unpacking
kwargs: GetConfigurationSetEventDestinationsRequestRequestTypeDef = { # (1)
"ConfigurationSetName": ...,
}
parent.get_configuration_set_event_destinations(**kwargs)get_contact#
Returns a contact from a contact list.
Type annotations and code completion for boto3.client("sesv2").get_contact method.
boto3 documentation
# get_contact method definition
def get_contact(
self,
*,
ContactListName: str,
EmailAddress: str,
) -> GetContactResponseTypeDef: # (1)
...# get_contact method usage example with argument unpacking
kwargs: GetContactRequestRequestTypeDef = { # (1)
"ContactListName": ...,
"EmailAddress": ...,
}
parent.get_contact(**kwargs)get_contact_list#
Returns contact list metadata.
Type annotations and code completion for boto3.client("sesv2").get_contact_list method.
boto3 documentation
# get_contact_list method definition
def get_contact_list(
self,
*,
ContactListName: str,
) -> GetContactListResponseTypeDef: # (1)
...# get_contact_list method usage example with argument unpacking
kwargs: GetContactListRequestRequestTypeDef = { # (1)
"ContactListName": ...,
}
parent.get_contact_list(**kwargs)get_custom_verification_email_template#
Returns the custom email verification template for the template name you specify.
Type annotations and code completion for boto3.client("sesv2").get_custom_verification_email_template method.
boto3 documentation
# get_custom_verification_email_template method definition
def get_custom_verification_email_template(
self,
*,
TemplateName: str,
) -> GetCustomVerificationEmailTemplateResponseTypeDef: # (1)
...# get_custom_verification_email_template method usage example with argument unpacking
kwargs: GetCustomVerificationEmailTemplateRequestRequestTypeDef = { # (1)
"TemplateName": ...,
}
parent.get_custom_verification_email_template(**kwargs)get_dedicated_ip#
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.
Type annotations and code completion for boto3.client("sesv2").get_dedicated_ip method.
boto3 documentation
# get_dedicated_ip method definition
def get_dedicated_ip(
self,
*,
Ip: str,
) -> GetDedicatedIpResponseTypeDef: # (1)
...# get_dedicated_ip method usage example with argument unpacking
kwargs: GetDedicatedIpRequestRequestTypeDef = { # (1)
"Ip": ...,
}
parent.get_dedicated_ip(**kwargs)get_dedicated_ip_pool#
Retrieve information about the dedicated pool.
Type annotations and code completion for boto3.client("sesv2").get_dedicated_ip_pool method.
boto3 documentation
# get_dedicated_ip_pool method definition
def get_dedicated_ip_pool(
self,
*,
PoolName: str,
) -> GetDedicatedIpPoolResponseTypeDef: # (1)
...# get_dedicated_ip_pool method usage example with argument unpacking
kwargs: GetDedicatedIpPoolRequestRequestTypeDef = { # (1)
"PoolName": ...,
}
parent.get_dedicated_ip_pool(**kwargs)get_dedicated_ips#
List the dedicated IP addresses that are associated with your Amazon Web Services account.
Type annotations and code completion for boto3.client("sesv2").get_dedicated_ips method.
boto3 documentation
# get_dedicated_ips method definition
def get_dedicated_ips(
self,
*,
PoolName: str = ...,
NextToken: str = ...,
PageSize: int = ...,
) -> GetDedicatedIpsResponseTypeDef: # (1)
...# get_dedicated_ips method usage example with argument unpacking
kwargs: GetDedicatedIpsRequestRequestTypeDef = { # (1)
"PoolName": ...,
}
parent.get_dedicated_ips(**kwargs)get_deliverability_dashboard_options#
Retrieve information about the status of the Deliverability dashboard for your account.
Type annotations and code completion for boto3.client("sesv2").get_deliverability_dashboard_options method.
boto3 documentation
# get_deliverability_dashboard_options method definition
def get_deliverability_dashboard_options(
self,
) -> GetDeliverabilityDashboardOptionsResponseTypeDef: # (1)
...get_deliverability_test_report#
Retrieve the results of a predictive inbox placement test.
Type annotations and code completion for boto3.client("sesv2").get_deliverability_test_report method.
boto3 documentation
# get_deliverability_test_report method definition
def get_deliverability_test_report(
self,
*,
ReportId: str,
) -> GetDeliverabilityTestReportResponseTypeDef: # (1)
...# get_deliverability_test_report method usage example with argument unpacking
kwargs: GetDeliverabilityTestReportRequestRequestTypeDef = { # (1)
"ReportId": ...,
}
parent.get_deliverability_test_report(**kwargs)get_domain_deliverability_campaign#
Retrieve all the deliverability data for a specific campaign.
Type annotations and code completion for boto3.client("sesv2").get_domain_deliverability_campaign method.
boto3 documentation
# get_domain_deliverability_campaign method definition
def get_domain_deliverability_campaign(
self,
*,
CampaignId: str,
) -> GetDomainDeliverabilityCampaignResponseTypeDef: # (1)
...# get_domain_deliverability_campaign method usage example with argument unpacking
kwargs: GetDomainDeliverabilityCampaignRequestRequestTypeDef = { # (1)
"CampaignId": ...,
}
parent.get_domain_deliverability_campaign(**kwargs)get_domain_statistics_report#
Retrieve inbox placement and engagement rates for the domains that you use to send email.
Type annotations and code completion for boto3.client("sesv2").get_domain_statistics_report method.
boto3 documentation
# get_domain_statistics_report method definition
def get_domain_statistics_report(
self,
*,
Domain: str,
StartDate: TimestampTypeDef,
EndDate: TimestampTypeDef,
) -> GetDomainStatisticsReportResponseTypeDef: # (1)
...# get_domain_statistics_report method usage example with argument unpacking
kwargs: GetDomainStatisticsReportRequestRequestTypeDef = { # (1)
"Domain": ...,
"StartDate": ...,
"EndDate": ...,
}
parent.get_domain_statistics_report(**kwargs)get_email_identity#
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.
Type annotations and code completion for boto3.client("sesv2").get_email_identity method.
boto3 documentation
# get_email_identity method definition
def get_email_identity(
self,
*,
EmailIdentity: str,
) -> GetEmailIdentityResponseTypeDef: # (1)
...# get_email_identity method usage example with argument unpacking
kwargs: GetEmailIdentityRequestRequestTypeDef = { # (1)
"EmailIdentity": ...,
}
parent.get_email_identity(**kwargs)get_email_identity_policies#
Returns the requested sending authorization policies for the given identity (an email address or a domain).
Type annotations and code completion for boto3.client("sesv2").get_email_identity_policies method.
boto3 documentation
# get_email_identity_policies method definition
def get_email_identity_policies(
self,
*,
EmailIdentity: str,
) -> GetEmailIdentityPoliciesResponseTypeDef: # (1)
...# get_email_identity_policies method usage example with argument unpacking
kwargs: GetEmailIdentityPoliciesRequestRequestTypeDef = { # (1)
"EmailIdentity": ...,
}
parent.get_email_identity_policies(**kwargs)get_email_template#
Displays the template object (which includes the subject line, HTML part and text part) for the template you specify.
Type annotations and code completion for boto3.client("sesv2").get_email_template method.
boto3 documentation
# get_email_template method definition
def get_email_template(
self,
*,
TemplateName: str,
) -> GetEmailTemplateResponseTypeDef: # (1)
...# get_email_template method usage example with argument unpacking
kwargs: GetEmailTemplateRequestRequestTypeDef = { # (1)
"TemplateName": ...,
}
parent.get_email_template(**kwargs)get_export_job#
Provides information about an export job.
Type annotations and code completion for boto3.client("sesv2").get_export_job method.
boto3 documentation
# get_export_job method definition
def get_export_job(
self,
*,
JobId: str,
) -> GetExportJobResponseTypeDef: # (1)
...# get_export_job method usage example with argument unpacking
kwargs: GetExportJobRequestRequestTypeDef = { # (1)
"JobId": ...,
}
parent.get_export_job(**kwargs)get_import_job#
Provides information about an import job.
Type annotations and code completion for boto3.client("sesv2").get_import_job method.
boto3 documentation
# get_import_job method definition
def get_import_job(
self,
*,
JobId: str,
) -> GetImportJobResponseTypeDef: # (1)
...# get_import_job method usage example with argument unpacking
kwargs: GetImportJobRequestRequestTypeDef = { # (1)
"JobId": ...,
}
parent.get_import_job(**kwargs)get_message_insights#
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.
Type annotations and code completion for boto3.client("sesv2").get_message_insights method.
boto3 documentation
# get_message_insights method definition
def get_message_insights(
self,
*,
MessageId: str,
) -> GetMessageInsightsResponseTypeDef: # (1)
...# get_message_insights method usage example with argument unpacking
kwargs: GetMessageInsightsRequestRequestTypeDef = { # (1)
"MessageId": ...,
}
parent.get_message_insights(**kwargs)get_multi_region_endpoint#
Displays the multi-region endpoint (global-endpoint) configuration.
Type annotations and code completion for boto3.client("sesv2").get_multi_region_endpoint method.
boto3 documentation
# get_multi_region_endpoint method definition
def get_multi_region_endpoint(
self,
*,
EndpointName: str,
) -> GetMultiRegionEndpointResponseTypeDef: # (1)
...# get_multi_region_endpoint method usage example with argument unpacking
kwargs: GetMultiRegionEndpointRequestRequestTypeDef = { # (1)
"EndpointName": ...,
}
parent.get_multi_region_endpoint(**kwargs)get_suppressed_destination#
Retrieves information about a specific email address that's on the suppression list for your account.
Type annotations and code completion for boto3.client("sesv2").get_suppressed_destination method.
boto3 documentation
# get_suppressed_destination method definition
def get_suppressed_destination(
self,
*,
EmailAddress: str,
) -> GetSuppressedDestinationResponseTypeDef: # (1)
...# get_suppressed_destination method usage example with argument unpacking
kwargs: GetSuppressedDestinationRequestRequestTypeDef = { # (1)
"EmailAddress": ...,
}
parent.get_suppressed_destination(**kwargs)list_configuration_sets#
List all of the configuration sets associated with your account in the current region.
Type annotations and code completion for boto3.client("sesv2").list_configuration_sets method.
boto3 documentation
# list_configuration_sets method definition
def list_configuration_sets(
self,
*,
NextToken: str = ...,
PageSize: int = ...,
) -> ListConfigurationSetsResponseTypeDef: # (1)
...# list_configuration_sets method usage example with argument unpacking
kwargs: ListConfigurationSetsRequestRequestTypeDef = { # (1)
"NextToken": ...,
}
parent.list_configuration_sets(**kwargs)list_contact_lists#
Lists all of the contact lists available.
Type annotations and code completion for boto3.client("sesv2").list_contact_lists method.
boto3 documentation
# list_contact_lists method definition
def list_contact_lists(
self,
*,
PageSize: int = ...,
NextToken: str = ...,
) -> ListContactListsResponseTypeDef: # (1)
...# list_contact_lists method usage example with argument unpacking
kwargs: ListContactListsRequestRequestTypeDef = { # (1)
"PageSize": ...,
}
parent.list_contact_lists(**kwargs)list_contacts#
Lists the contacts present in a specific contact list.
Type annotations and code completion for boto3.client("sesv2").list_contacts method.
boto3 documentation
# list_contacts method definition
def list_contacts(
self,
*,
ContactListName: str,
Filter: ListContactsFilterTypeDef = ..., # (1)
PageSize: int = ...,
NextToken: str = ...,
) -> ListContactsResponseTypeDef: # (2)
...# list_contacts method usage example with argument unpacking
kwargs: ListContactsRequestRequestTypeDef = { # (1)
"ContactListName": ...,
}
parent.list_contacts(**kwargs)list_custom_verification_email_templates#
Lists the existing custom verification email templates for your account in the current Amazon Web Services Region.
Type annotations and code completion for boto3.client("sesv2").list_custom_verification_email_templates method.
boto3 documentation
# list_custom_verification_email_templates method definition
def list_custom_verification_email_templates(
self,
*,
NextToken: str = ...,
PageSize: int = ...,
) -> ListCustomVerificationEmailTemplatesResponseTypeDef: # (1)
...# list_custom_verification_email_templates method usage example with argument unpacking
kwargs: ListCustomVerificationEmailTemplatesRequestRequestTypeDef = { # (1)
"NextToken": ...,
}
parent.list_custom_verification_email_templates(**kwargs)list_dedicated_ip_pools#
List all of the dedicated IP pools that exist in your Amazon Web Services account in the current Region.
Type annotations and code completion for boto3.client("sesv2").list_dedicated_ip_pools method.
boto3 documentation
# list_dedicated_ip_pools method definition
def list_dedicated_ip_pools(
self,
*,
NextToken: str = ...,
PageSize: int = ...,
) -> ListDedicatedIpPoolsResponseTypeDef: # (1)
...# list_dedicated_ip_pools method usage example with argument unpacking
kwargs: ListDedicatedIpPoolsRequestRequestTypeDef = { # (1)
"NextToken": ...,
}
parent.list_dedicated_ip_pools(**kwargs)list_deliverability_test_reports#
Show a list of the predictive inbox placement tests that you've performed, regardless of their statuses.
Type annotations and code completion for boto3.client("sesv2").list_deliverability_test_reports method.
boto3 documentation
# list_deliverability_test_reports method definition
def list_deliverability_test_reports(
self,
*,
NextToken: str = ...,
PageSize: int = ...,
) -> ListDeliverabilityTestReportsResponseTypeDef: # (1)
...# list_deliverability_test_reports method usage example with argument unpacking
kwargs: ListDeliverabilityTestReportsRequestRequestTypeDef = { # (1)
"NextToken": ...,
}
parent.list_deliverability_test_reports(**kwargs)list_domain_deliverability_campaigns#
Retrieve deliverability data for all the campaigns that used a specific domain to send email during a specified time range.
Type annotations and code completion for boto3.client("sesv2").list_domain_deliverability_campaigns method.
boto3 documentation
# list_domain_deliverability_campaigns method definition
def list_domain_deliverability_campaigns(
self,
*,
StartDate: TimestampTypeDef,
EndDate: TimestampTypeDef,
SubscribedDomain: str,
NextToken: str = ...,
PageSize: int = ...,
) -> ListDomainDeliverabilityCampaignsResponseTypeDef: # (1)
...# list_domain_deliverability_campaigns method usage example with argument unpacking
kwargs: ListDomainDeliverabilityCampaignsRequestRequestTypeDef = { # (1)
"StartDate": ...,
"EndDate": ...,
"SubscribedDomain": ...,
}
parent.list_domain_deliverability_campaigns(**kwargs)list_email_identities#
Returns a list of all of the email identities that are associated with your Amazon Web Services account.
Type annotations and code completion for boto3.client("sesv2").list_email_identities method.
boto3 documentation
# list_email_identities method definition
def list_email_identities(
self,
*,
NextToken: str = ...,
PageSize: int = ...,
) -> ListEmailIdentitiesResponseTypeDef: # (1)
...# list_email_identities method usage example with argument unpacking
kwargs: ListEmailIdentitiesRequestRequestTypeDef = { # (1)
"NextToken": ...,
}
parent.list_email_identities(**kwargs)list_email_templates#
Lists the email templates present in your Amazon SES account in the current Amazon Web Services Region.
Type annotations and code completion for boto3.client("sesv2").list_email_templates method.
boto3 documentation
# list_email_templates method definition
def list_email_templates(
self,
*,
NextToken: str = ...,
PageSize: int = ...,
) -> ListEmailTemplatesResponseTypeDef: # (1)
...# list_email_templates method usage example with argument unpacking
kwargs: ListEmailTemplatesRequestRequestTypeDef = { # (1)
"NextToken": ...,
}
parent.list_email_templates(**kwargs)list_export_jobs#
Lists all of the export jobs.
Type annotations and code completion for boto3.client("sesv2").list_export_jobs method.
boto3 documentation
# list_export_jobs method definition
def list_export_jobs(
self,
*,
NextToken: str = ...,
PageSize: int = ...,
ExportSourceType: ExportSourceTypeType = ..., # (1)
JobStatus: JobStatusType = ..., # (2)
) -> ListExportJobsResponseTypeDef: # (3)
...# list_export_jobs method usage example with argument unpacking
kwargs: ListExportJobsRequestRequestTypeDef = { # (1)
"NextToken": ...,
}
parent.list_export_jobs(**kwargs)list_import_jobs#
Lists all of the import jobs.
Type annotations and code completion for boto3.client("sesv2").list_import_jobs method.
boto3 documentation
# list_import_jobs method definition
def list_import_jobs(
self,
*,
ImportDestinationType: ImportDestinationTypeType = ..., # (1)
NextToken: str = ...,
PageSize: int = ...,
) -> ListImportJobsResponseTypeDef: # (2)
...# list_import_jobs method usage example with argument unpacking
kwargs: ListImportJobsRequestRequestTypeDef = { # (1)
"ImportDestinationType": ...,
}
parent.list_import_jobs(**kwargs)list_multi_region_endpoints#
List the multi-region endpoints (global-endpoints).
Type annotations and code completion for boto3.client("sesv2").list_multi_region_endpoints method.
boto3 documentation
# list_multi_region_endpoints method definition
def list_multi_region_endpoints(
self,
*,
NextToken: str = ...,
PageSize: int = ...,
) -> ListMultiRegionEndpointsResponseTypeDef: # (1)
...# list_multi_region_endpoints method usage example with argument unpacking
kwargs: ListMultiRegionEndpointsRequestRequestTypeDef = { # (1)
"NextToken": ...,
}
parent.list_multi_region_endpoints(**kwargs)list_recommendations#
Lists the recommendations present in your Amazon SES account in the current Amazon Web Services Region.
Type annotations and code completion for boto3.client("sesv2").list_recommendations method.
boto3 documentation
# list_recommendations method definition
def list_recommendations(
self,
*,
Filter: Mapping[ListRecommendationsFilterKeyType, str] = ..., # (1)
NextToken: str = ...,
PageSize: int = ...,
) -> ListRecommendationsResponseTypeDef: # (2)
...# list_recommendations method usage example with argument unpacking
kwargs: ListRecommendationsRequestRequestTypeDef = { # (1)
"Filter": ...,
}
parent.list_recommendations(**kwargs)list_suppressed_destinations#
Retrieves a list of email addresses that are on the suppression list for your account.
Type annotations and code completion for boto3.client("sesv2").list_suppressed_destinations method.
boto3 documentation
# list_suppressed_destinations method definition
def list_suppressed_destinations(
self,
*,
Reasons: Sequence[SuppressionListReasonType] = ..., # (1)
StartDate: TimestampTypeDef = ...,
EndDate: TimestampTypeDef = ...,
NextToken: str = ...,
PageSize: int = ...,
) -> ListSuppressedDestinationsResponseTypeDef: # (2)
...# list_suppressed_destinations method usage example with argument unpacking
kwargs: ListSuppressedDestinationsRequestRequestTypeDef = { # (1)
"Reasons": ...,
}
parent.list_suppressed_destinations(**kwargs)list_tags_for_resource#
Retrieve a list of the tags (keys and values) that are associated with a specified resource.
Type annotations and code completion for boto3.client("sesv2").list_tags_for_resource method.
boto3 documentation
# list_tags_for_resource method definition
def list_tags_for_resource(
self,
*,
ResourceArn: str,
) -> ListTagsForResourceResponseTypeDef: # (1)
...# list_tags_for_resource method usage example with argument unpacking
kwargs: ListTagsForResourceRequestRequestTypeDef = { # (1)
"ResourceArn": ...,
}
parent.list_tags_for_resource(**kwargs)put_account_dedicated_ip_warmup_attributes#
Enable or disable the automatic warm-up feature for dedicated IP addresses.
Type annotations and code completion for boto3.client("sesv2").put_account_dedicated_ip_warmup_attributes method.
boto3 documentation
# put_account_dedicated_ip_warmup_attributes method definition
def put_account_dedicated_ip_warmup_attributes(
self,
*,
AutoWarmupEnabled: bool = ...,
) -> dict[str, Any]:
...# put_account_dedicated_ip_warmup_attributes method usage example with argument unpacking
kwargs: PutAccountDedicatedIpWarmupAttributesRequestRequestTypeDef = { # (1)
"AutoWarmupEnabled": ...,
}
parent.put_account_dedicated_ip_warmup_attributes(**kwargs)put_account_details#
Update your Amazon SES account details.
Type annotations and code completion for boto3.client("sesv2").put_account_details method.
boto3 documentation
# put_account_details method definition
def put_account_details(
self,
*,
MailType: MailTypeType, # (1)
WebsiteURL: str,
ContactLanguage: ContactLanguageType = ..., # (2)
UseCaseDescription: str = ...,
AdditionalContactEmailAddresses: Sequence[str] = ...,
ProductionAccessEnabled: bool = ...,
) -> dict[str, Any]:
...- See MailTypeType
- See ContactLanguageType
# put_account_details method usage example with argument unpacking
kwargs: PutAccountDetailsRequestRequestTypeDef = { # (1)
"MailType": ...,
"WebsiteURL": ...,
}
parent.put_account_details(**kwargs)put_account_sending_attributes#
Enable or disable the ability of your account to send email.
Type annotations and code completion for boto3.client("sesv2").put_account_sending_attributes method.
boto3 documentation
# put_account_sending_attributes method definition
def put_account_sending_attributes(
self,
*,
SendingEnabled: bool = ...,
) -> dict[str, Any]:
...# put_account_sending_attributes method usage example with argument unpacking
kwargs: PutAccountSendingAttributesRequestRequestTypeDef = { # (1)
"SendingEnabled": ...,
}
parent.put_account_sending_attributes(**kwargs)put_account_suppression_attributes#
Change the settings for the account-level suppression list.
Type annotations and code completion for boto3.client("sesv2").put_account_suppression_attributes method.
boto3 documentation
# put_account_suppression_attributes method definition
def put_account_suppression_attributes(
self,
*,
SuppressedReasons: Sequence[SuppressionListReasonType] = ..., # (1)
) -> dict[str, Any]:
...# put_account_suppression_attributes method usage example with argument unpacking
kwargs: PutAccountSuppressionAttributesRequestRequestTypeDef = { # (1)
"SuppressedReasons": ...,
}
parent.put_account_suppression_attributes(**kwargs)put_account_vdm_attributes#
Update your Amazon SES account VDM attributes.
Type annotations and code completion for boto3.client("sesv2").put_account_vdm_attributes method.
boto3 documentation
# put_account_vdm_attributes method definition
def put_account_vdm_attributes(
self,
*,
VdmAttributes: VdmAttributesTypeDef, # (1)
) -> dict[str, Any]:
...# put_account_vdm_attributes method usage example with argument unpacking
kwargs: PutAccountVdmAttributesRequestRequestTypeDef = { # (1)
"VdmAttributes": ...,
}
parent.put_account_vdm_attributes(**kwargs)put_configuration_set_delivery_options#
Associate a configuration set with a dedicated IP pool.
Type annotations and code completion for boto3.client("sesv2").put_configuration_set_delivery_options method.
boto3 documentation
# put_configuration_set_delivery_options method definition
def put_configuration_set_delivery_options(
self,
*,
ConfigurationSetName: str,
TlsPolicy: TlsPolicyType = ..., # (1)
SendingPoolName: str = ...,
MaxDeliverySeconds: int = ...,
) -> dict[str, Any]:
...- See TlsPolicyType
# put_configuration_set_delivery_options method usage example with argument unpacking
kwargs: PutConfigurationSetDeliveryOptionsRequestRequestTypeDef = { # (1)
"ConfigurationSetName": ...,
}
parent.put_configuration_set_delivery_options(**kwargs)put_configuration_set_reputation_options#
Enable or disable collection of reputation metrics for emails that you send using a particular configuration set in a specific Amazon Web Services Region.
Type annotations and code completion for boto3.client("sesv2").put_configuration_set_reputation_options method.
boto3 documentation
# put_configuration_set_reputation_options method definition
def put_configuration_set_reputation_options(
self,
*,
ConfigurationSetName: str,
ReputationMetricsEnabled: bool = ...,
) -> dict[str, Any]:
...# put_configuration_set_reputation_options method usage example with argument unpacking
kwargs: PutConfigurationSetReputationOptionsRequestRequestTypeDef = { # (1)
"ConfigurationSetName": ...,
}
parent.put_configuration_set_reputation_options(**kwargs)put_configuration_set_sending_options#
Enable or disable email sending for messages that use a particular configuration set in a specific Amazon Web Services Region.
Type annotations and code completion for boto3.client("sesv2").put_configuration_set_sending_options method.
boto3 documentation
# put_configuration_set_sending_options method definition
def put_configuration_set_sending_options(
self,
*,
ConfigurationSetName: str,
SendingEnabled: bool = ...,
) -> dict[str, Any]:
...# put_configuration_set_sending_options method usage example with argument unpacking
kwargs: PutConfigurationSetSendingOptionsRequestRequestTypeDef = { # (1)
"ConfigurationSetName": ...,
}
parent.put_configuration_set_sending_options(**kwargs)put_configuration_set_suppression_options#
Specify the account suppression list preferences for a configuration set.
Type annotations and code completion for boto3.client("sesv2").put_configuration_set_suppression_options method.
boto3 documentation
# put_configuration_set_suppression_options method definition
def put_configuration_set_suppression_options(
self,
*,
ConfigurationSetName: str,
SuppressedReasons: Sequence[SuppressionListReasonType] = ..., # (1)
) -> dict[str, Any]:
...# put_configuration_set_suppression_options method usage example with argument unpacking
kwargs: PutConfigurationSetSuppressionOptionsRequestRequestTypeDef = { # (1)
"ConfigurationSetName": ...,
}
parent.put_configuration_set_suppression_options(**kwargs)put_configuration_set_tracking_options#
Specify a custom domain to use for open and click tracking elements in email that you send.
Type annotations and code completion for boto3.client("sesv2").put_configuration_set_tracking_options method.
boto3 documentation
# put_configuration_set_tracking_options method definition
def put_configuration_set_tracking_options(
self,
*,
ConfigurationSetName: str,
CustomRedirectDomain: str = ...,
HttpsPolicy: HttpsPolicyType = ..., # (1)
) -> dict[str, Any]:
...- See HttpsPolicyType
# put_configuration_set_tracking_options method usage example with argument unpacking
kwargs: PutConfigurationSetTrackingOptionsRequestRequestTypeDef = { # (1)
"ConfigurationSetName": ...,
}
parent.put_configuration_set_tracking_options(**kwargs)put_configuration_set_vdm_options#
Specify VDM preferences for email that you send using the configuration set.
Type annotations and code completion for boto3.client("sesv2").put_configuration_set_vdm_options method.
boto3 documentation
# put_configuration_set_vdm_options method definition
def put_configuration_set_vdm_options(
self,
*,
ConfigurationSetName: str,
VdmOptions: VdmOptionsTypeDef = ..., # (1)
) -> dict[str, Any]:
...# put_configuration_set_vdm_options method usage example with argument unpacking
kwargs: PutConfigurationSetVdmOptionsRequestRequestTypeDef = { # (1)
"ConfigurationSetName": ...,
}
parent.put_configuration_set_vdm_options(**kwargs)put_dedicated_ip_in_pool#
Move a dedicated IP address to an existing dedicated IP pool.
Type annotations and code completion for boto3.client("sesv2").put_dedicated_ip_in_pool method.
boto3 documentation
# put_dedicated_ip_in_pool method definition
def put_dedicated_ip_in_pool(
self,
*,
Ip: str,
DestinationPoolName: str,
) -> dict[str, Any]:
...# put_dedicated_ip_in_pool method usage example with argument unpacking
kwargs: PutDedicatedIpInPoolRequestRequestTypeDef = { # (1)
"Ip": ...,
"DestinationPoolName": ...,
}
parent.put_dedicated_ip_in_pool(**kwargs)put_dedicated_ip_pool_scaling_attributes#
Used to convert a dedicated IP pool to a different scaling mode.
Type annotations and code completion for boto3.client("sesv2").put_dedicated_ip_pool_scaling_attributes method.
boto3 documentation
# put_dedicated_ip_pool_scaling_attributes method definition
def put_dedicated_ip_pool_scaling_attributes(
self,
*,
PoolName: str,
ScalingMode: ScalingModeType, # (1)
) -> dict[str, Any]:
...- See ScalingModeType
# put_dedicated_ip_pool_scaling_attributes method usage example with argument unpacking
kwargs: PutDedicatedIpPoolScalingAttributesRequestRequestTypeDef = { # (1)
"PoolName": ...,
"ScalingMode": ...,
}
parent.put_dedicated_ip_pool_scaling_attributes(**kwargs)put_dedicated_ip_warmup_attributes#
.
Type annotations and code completion for boto3.client("sesv2").put_dedicated_ip_warmup_attributes method.
boto3 documentation
# put_dedicated_ip_warmup_attributes method definition
def put_dedicated_ip_warmup_attributes(
self,
*,
Ip: str,
WarmupPercentage: int,
) -> dict[str, Any]:
...# put_dedicated_ip_warmup_attributes method usage example with argument unpacking
kwargs: PutDedicatedIpWarmupAttributesRequestRequestTypeDef = { # (1)
"Ip": ...,
"WarmupPercentage": ...,
}
parent.put_dedicated_ip_warmup_attributes(**kwargs)put_deliverability_dashboard_option#
Enable or disable the Deliverability dashboard.
Type annotations and code completion for boto3.client("sesv2").put_deliverability_dashboard_option method.
boto3 documentation
# put_deliverability_dashboard_option method definition
def put_deliverability_dashboard_option(
self,
*,
DashboardEnabled: bool,
SubscribedDomains: Sequence[DomainDeliverabilityTrackingOptionUnionTypeDef] = ..., # (1)
) -> dict[str, Any]:
...# put_deliverability_dashboard_option method usage example with argument unpacking
kwargs: PutDeliverabilityDashboardOptionRequestRequestTypeDef = { # (1)
"DashboardEnabled": ...,
}
parent.put_deliverability_dashboard_option(**kwargs)put_email_identity_configuration_set_attributes#
Used to associate a configuration set with an email identity.
Type annotations and code completion for boto3.client("sesv2").put_email_identity_configuration_set_attributes method.
boto3 documentation
# put_email_identity_configuration_set_attributes method definition
def put_email_identity_configuration_set_attributes(
self,
*,
EmailIdentity: str,
ConfigurationSetName: str = ...,
) -> dict[str, Any]:
...# put_email_identity_configuration_set_attributes method usage example with argument unpacking
kwargs: PutEmailIdentityConfigurationSetAttributesRequestRequestTypeDef = { # (1)
"EmailIdentity": ...,
}
parent.put_email_identity_configuration_set_attributes(**kwargs)put_email_identity_dkim_attributes#
Used to enable or disable DKIM authentication for an email identity.
Type annotations and code completion for boto3.client("sesv2").put_email_identity_dkim_attributes method.
boto3 documentation
# put_email_identity_dkim_attributes method definition
def put_email_identity_dkim_attributes(
self,
*,
EmailIdentity: str,
SigningEnabled: bool = ...,
) -> dict[str, Any]:
...# put_email_identity_dkim_attributes method usage example with argument unpacking
kwargs: PutEmailIdentityDkimAttributesRequestRequestTypeDef = { # (1)
"EmailIdentity": ...,
}
parent.put_email_identity_dkim_attributes(**kwargs)put_email_identity_dkim_signing_attributes#
Used to configure or change the DKIM authentication settings for an email domain identity.
Type annotations and code completion for boto3.client("sesv2").put_email_identity_dkim_signing_attributes method.
boto3 documentation
# put_email_identity_dkim_signing_attributes method definition
def put_email_identity_dkim_signing_attributes(
self,
*,
EmailIdentity: str,
SigningAttributesOrigin: DkimSigningAttributesOriginType, # (1)
SigningAttributes: DkimSigningAttributesTypeDef = ..., # (2)
) -> PutEmailIdentityDkimSigningAttributesResponseTypeDef: # (3)
...- See DkimSigningAttributesOriginType
- See DkimSigningAttributesTypeDef
- See PutEmailIdentityDkimSigningAttributesResponseTypeDef
# put_email_identity_dkim_signing_attributes method usage example with argument unpacking
kwargs: PutEmailIdentityDkimSigningAttributesRequestRequestTypeDef = { # (1)
"EmailIdentity": ...,
"SigningAttributesOrigin": ...,
}
parent.put_email_identity_dkim_signing_attributes(**kwargs)put_email_identity_feedback_attributes#
Used to enable or disable feedback forwarding for an identity.
Type annotations and code completion for boto3.client("sesv2").put_email_identity_feedback_attributes method.
boto3 documentation
# put_email_identity_feedback_attributes method definition
def put_email_identity_feedback_attributes(
self,
*,
EmailIdentity: str,
EmailForwardingEnabled: bool = ...,
) -> dict[str, Any]:
...# put_email_identity_feedback_attributes method usage example with argument unpacking
kwargs: PutEmailIdentityFeedbackAttributesRequestRequestTypeDef = { # (1)
"EmailIdentity": ...,
}
parent.put_email_identity_feedback_attributes(**kwargs)put_email_identity_mail_from_attributes#
Used to enable or disable the custom Mail-From domain configuration for an email identity.
Type annotations and code completion for boto3.client("sesv2").put_email_identity_mail_from_attributes method.
boto3 documentation
# put_email_identity_mail_from_attributes method definition
def put_email_identity_mail_from_attributes(
self,
*,
EmailIdentity: str,
MailFromDomain: str = ...,
BehaviorOnMxFailure: BehaviorOnMxFailureType = ..., # (1)
) -> dict[str, Any]:
...# put_email_identity_mail_from_attributes method usage example with argument unpacking
kwargs: PutEmailIdentityMailFromAttributesRequestRequestTypeDef = { # (1)
"EmailIdentity": ...,
}
parent.put_email_identity_mail_from_attributes(**kwargs)put_suppressed_destination#
Adds an email address to the suppression list for your account.
Type annotations and code completion for boto3.client("sesv2").put_suppressed_destination method.
boto3 documentation
# put_suppressed_destination method definition
def put_suppressed_destination(
self,
*,
EmailAddress: str,
Reason: SuppressionListReasonType, # (1)
) -> dict[str, Any]:
...# put_suppressed_destination method usage example with argument unpacking
kwargs: PutSuppressedDestinationRequestRequestTypeDef = { # (1)
"EmailAddress": ...,
"Reason": ...,
}
parent.put_suppressed_destination(**kwargs)send_bulk_email#
Composes an email message to multiple destinations.
Type annotations and code completion for boto3.client("sesv2").send_bulk_email method.
boto3 documentation
# send_bulk_email method definition
def send_bulk_email(
self,
*,
DefaultContent: BulkEmailContentTypeDef, # (1)
BulkEmailEntries: Sequence[BulkEmailEntryTypeDef], # (2)
FromEmailAddress: str = ...,
FromEmailAddressIdentityArn: str = ...,
ReplyToAddresses: Sequence[str] = ...,
FeedbackForwardingEmailAddress: str = ...,
FeedbackForwardingEmailAddressIdentityArn: str = ...,
DefaultEmailTags: Sequence[MessageTagTypeDef] = ..., # (3)
ConfigurationSetName: str = ...,
EndpointId: str = ...,
) -> SendBulkEmailResponseTypeDef: # (4)
...- See BulkEmailContentTypeDef
- See BulkEmailEntryTypeDef
- See MessageTagTypeDef
- See SendBulkEmailResponseTypeDef
# send_bulk_email method usage example with argument unpacking
kwargs: SendBulkEmailRequestRequestTypeDef = { # (1)
"DefaultContent": ...,
"BulkEmailEntries": ...,
}
parent.send_bulk_email(**kwargs)send_custom_verification_email#
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.
Type annotations and code completion for boto3.client("sesv2").send_custom_verification_email method.
boto3 documentation
# send_custom_verification_email method definition
def send_custom_verification_email(
self,
*,
EmailAddress: str,
TemplateName: str,
ConfigurationSetName: str = ...,
) -> SendCustomVerificationEmailResponseTypeDef: # (1)
...# send_custom_verification_email method usage example with argument unpacking
kwargs: SendCustomVerificationEmailRequestRequestTypeDef = { # (1)
"EmailAddress": ...,
"TemplateName": ...,
}
parent.send_custom_verification_email(**kwargs)send_email#
Sends an email message.
Type annotations and code completion for boto3.client("sesv2").send_email method.
boto3 documentation
# send_email method definition
def send_email(
self,
*,
Content: EmailContentTypeDef, # (1)
FromEmailAddress: str = ...,
FromEmailAddressIdentityArn: str = ...,
Destination: DestinationTypeDef = ..., # (2)
ReplyToAddresses: Sequence[str] = ...,
FeedbackForwardingEmailAddress: str = ...,
FeedbackForwardingEmailAddressIdentityArn: str = ...,
EmailTags: Sequence[MessageTagTypeDef] = ..., # (3)
ConfigurationSetName: str = ...,
EndpointId: str = ...,
ListManagementOptions: ListManagementOptionsTypeDef = ..., # (4)
) -> SendEmailResponseTypeDef: # (5)
...- See EmailContentTypeDef
- See DestinationTypeDef
- See MessageTagTypeDef
- See ListManagementOptionsTypeDef
- See SendEmailResponseTypeDef
# send_email method usage example with argument unpacking
kwargs: SendEmailRequestRequestTypeDef = { # (1)
"Content": ...,
}
parent.send_email(**kwargs)tag_resource#
Add one or more tags (keys and values) to a specified resource.
Type annotations and code completion for boto3.client("sesv2").tag_resource method.
boto3 documentation
# tag_resource method definition
def tag_resource(
self,
*,
ResourceArn: str,
Tags: Sequence[TagTypeDef], # (1)
) -> dict[str, Any]:
...- See TagTypeDef
# tag_resource method usage example with argument unpacking
kwargs: TagResourceRequestRequestTypeDef = { # (1)
"ResourceArn": ...,
"Tags": ...,
}
parent.tag_resource(**kwargs)test_render_email_template#
Creates a preview of the MIME content of an email when provided with a template and a set of replacement data.
Type annotations and code completion for boto3.client("sesv2").test_render_email_template method.
boto3 documentation
# test_render_email_template method definition
def test_render_email_template(
self,
*,
TemplateName: str,
TemplateData: str,
) -> TestRenderEmailTemplateResponseTypeDef: # (1)
...# test_render_email_template method usage example with argument unpacking
kwargs: TestRenderEmailTemplateRequestRequestTypeDef = { # (1)
"TemplateName": ...,
"TemplateData": ...,
}
parent.test_render_email_template(**kwargs)untag_resource#
Remove one or more tags (keys and values) from a specified resource.
Type annotations and code completion for boto3.client("sesv2").untag_resource method.
boto3 documentation
# untag_resource method definition
def untag_resource(
self,
*,
ResourceArn: str,
TagKeys: Sequence[str],
) -> dict[str, Any]:
...# untag_resource method usage example with argument unpacking
kwargs: UntagResourceRequestRequestTypeDef = { # (1)
"ResourceArn": ...,
"TagKeys": ...,
}
parent.untag_resource(**kwargs)update_configuration_set_event_destination#
Update the configuration of an event destination for a configuration set.
Type annotations and code completion for boto3.client("sesv2").update_configuration_set_event_destination method.
boto3 documentation
# update_configuration_set_event_destination method definition
def update_configuration_set_event_destination(
self,
*,
ConfigurationSetName: str,
EventDestinationName: str,
EventDestination: EventDestinationDefinitionTypeDef, # (1)
) -> dict[str, Any]:
...# update_configuration_set_event_destination method usage example with argument unpacking
kwargs: UpdateConfigurationSetEventDestinationRequestRequestTypeDef = { # (1)
"ConfigurationSetName": ...,
"EventDestinationName": ...,
"EventDestination": ...,
}
parent.update_configuration_set_event_destination(**kwargs)update_contact#
Updates a contact's preferences for a list.
Type annotations and code completion for boto3.client("sesv2").update_contact method.
boto3 documentation
# update_contact method definition
def update_contact(
self,
*,
ContactListName: str,
EmailAddress: str,
TopicPreferences: Sequence[TopicPreferenceTypeDef] = ..., # (1)
UnsubscribeAll: bool = ...,
AttributesData: str = ...,
) -> dict[str, Any]:
...# update_contact method usage example with argument unpacking
kwargs: UpdateContactRequestRequestTypeDef = { # (1)
"ContactListName": ...,
"EmailAddress": ...,
}
parent.update_contact(**kwargs)update_contact_list#
Updates contact list metadata.
Type annotations and code completion for boto3.client("sesv2").update_contact_list method.
boto3 documentation
# update_contact_list method definition
def update_contact_list(
self,
*,
ContactListName: str,
Topics: Sequence[TopicTypeDef] = ..., # (1)
Description: str = ...,
) -> dict[str, Any]:
...- See TopicTypeDef
# update_contact_list method usage example with argument unpacking
kwargs: UpdateContactListRequestRequestTypeDef = { # (1)
"ContactListName": ...,
}
parent.update_contact_list(**kwargs)update_custom_verification_email_template#
Updates an existing custom verification email template.
Type annotations and code completion for boto3.client("sesv2").update_custom_verification_email_template method.
boto3 documentation
# update_custom_verification_email_template method definition
def update_custom_verification_email_template(
self,
*,
TemplateName: str,
FromEmailAddress: str,
TemplateSubject: str,
TemplateContent: str,
SuccessRedirectionURL: str,
FailureRedirectionURL: str,
) -> dict[str, Any]:
...# update_custom_verification_email_template method usage example with argument unpacking
kwargs: UpdateCustomVerificationEmailTemplateRequestRequestTypeDef = { # (1)
"TemplateName": ...,
"FromEmailAddress": ...,
"TemplateSubject": ...,
"TemplateContent": ...,
"SuccessRedirectionURL": ...,
"FailureRedirectionURL": ...,
}
parent.update_custom_verification_email_template(**kwargs)update_email_identity_policy#
Updates the specified sending authorization policy for the given identity (an email address or a domain).
Type annotations and code completion for boto3.client("sesv2").update_email_identity_policy method.
boto3 documentation
# update_email_identity_policy method definition
def update_email_identity_policy(
self,
*,
EmailIdentity: str,
PolicyName: str,
Policy: str,
) -> dict[str, Any]:
...# update_email_identity_policy method usage example with argument unpacking
kwargs: UpdateEmailIdentityPolicyRequestRequestTypeDef = { # (1)
"EmailIdentity": ...,
"PolicyName": ...,
"Policy": ...,
}
parent.update_email_identity_policy(**kwargs)update_email_template#
Updates an email template.
Type annotations and code completion for boto3.client("sesv2").update_email_template method.
boto3 documentation
# update_email_template method definition
def update_email_template(
self,
*,
TemplateName: str,
TemplateContent: EmailTemplateContentTypeDef, # (1)
) -> dict[str, Any]:
...# update_email_template method usage example with argument unpacking
kwargs: UpdateEmailTemplateRequestRequestTypeDef = { # (1)
"TemplateName": ...,
"TemplateContent": ...,
}
parent.update_email_template(**kwargs)get_paginator#
Type annotations and code completion for boto3.client("sesv2").get_paginator method with overloads.
client.get_paginator("list_multi_region_endpoints")-> ListMultiRegionEndpointsPaginator