Skip to content

SESV2Client#

Index > SESV2 > 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#

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)
    ...
  1. See BatchGetMetricDataQueryTypeDef
  2. See BatchGetMetricDataResponseTypeDef
# batch_get_metric_data method usage example with argument unpacking

kwargs: BatchGetMetricDataRequestRequestTypeDef = {  # (1)
    "Queries": ...,
}

parent.batch_get_metric_data(**kwargs)
  1. See BatchGetMetricDataRequestRequestTypeDef

can_paginate#

Check if an operation can be paginated.

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:
    ...

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)
  1. See CancelExportJobRequestRequestTypeDef

close#

Closes underlying endpoint connections.

Type annotations and code completion for boto3.client("sesv2").close method. boto3 documentation

# close method definition

def close(
    self,
) -> None:
    ...

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]:
    ...
  1. See TrackingOptionsTypeDef
  2. See DeliveryOptionsTypeDef
  3. See ReputationOptionsTypeDef
  4. See SendingOptionsTypeDef
  5. See TagTypeDef
  6. See SuppressionOptionsTypeDef
  7. See VdmOptionsTypeDef
# create_configuration_set method usage example with argument unpacking

kwargs: CreateConfigurationSetRequestRequestTypeDef = {  # (1)
    "ConfigurationSetName": ...,
}

parent.create_configuration_set(**kwargs)
  1. See CreateConfigurationSetRequestRequestTypeDef

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]:
    ...
  1. See EventDestinationDefinitionTypeDef
# create_configuration_set_event_destination method usage example with argument unpacking

kwargs: CreateConfigurationSetEventDestinationRequestRequestTypeDef = {  # (1)
    "ConfigurationSetName": ...,
    "EventDestinationName": ...,
    "EventDestination": ...,
}

parent.create_configuration_set_event_destination(**kwargs)
  1. See CreateConfigurationSetEventDestinationRequestRequestTypeDef

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]:
    ...
  1. See TopicPreferenceTypeDef
# create_contact method usage example with argument unpacking

kwargs: CreateContactRequestRequestTypeDef = {  # (1)
    "ContactListName": ...,
    "EmailAddress": ...,
}

parent.create_contact(**kwargs)
  1. See CreateContactRequestRequestTypeDef

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]:
    ...
  1. See TopicTypeDef
  2. See TagTypeDef
# create_contact_list method usage example with argument unpacking

kwargs: CreateContactListRequestRequestTypeDef = {  # (1)
    "ContactListName": ...,
}

parent.create_contact_list(**kwargs)
  1. See CreateContactListRequestRequestTypeDef

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)
  1. See CreateCustomVerificationEmailTemplateRequestRequestTypeDef

create_dedicated_ip_pool#