Skip to content

PinpointEmailClient#

Index > PinpointEmail > PinpointEmailClient

Auto-generated documentation for PinpointEmail type annotations stubs module mypy-boto3-pinpoint-email.

PinpointEmailClient#

Type annotations and code completion for boto3.client("pinpoint-email"). boto3 documentation

# PinpointEmailClient usage example

from boto3.session import Session
from mypy_boto3_pinpoint_email.client import PinpointEmailClient

def get_pinpoint-email_client() -> PinpointEmailClient:
    return Session().client("pinpoint-email")

Exceptions#

boto3 client exceptions are generated in runtime. This class provides code completion for boto3.client("pinpoint-email").exceptions structure.

# Exceptions.exceptions usage example

client = boto3.client("pinpoint-email")

try:
    do_something(client)
except (
    client.exceptions.AccountSuspendedException,
    client.exceptions.AlreadyExistsException,
    client.exceptions.BadRequestException,
    client.exceptions.ClientError,
    client.exceptions.ConcurrentModificationException,
    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_pinpoint_email.client import Exceptions

def handle_error(exc: Exceptions.AccountSuspendedException) -> None:
    ...

Methods#

can_paginate#

Check if an operation can be paginated.

Type annotations and code completion for boto3.client("pinpoint-email").can_paginate method. boto3 documentation

# can_paginate method definition

def can_paginate(
    self,
    operation_name: str,
) -> bool:
    ...

close#

Closes underlying endpoint connections.

Type annotations and code completion for boto3.client("pinpoint-email").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("pinpoint-email").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)
) -> Dict[str, Any]:
    ...
  1. See TrackingOptionsTypeDef
  2. See DeliveryOptionsTypeDef
  3. See ReputationOptionsTypeDef
  4. See SendingOptionsTypeDef
  5. See TagTypeDef
# 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("pinpoint-email").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_dedicated_ip_pool#

Create a new pool of dedicated IP addresses.

Type annotations and code completion for boto3.client("pinpoint-email").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)
) -> Dict[str, Any]:
    ...
  1. See TagTypeDef
# create_dedicated_ip_pool method usage example with argument unpacking

kwargs: CreateDedicatedIpPoolRequestRequestTypeDef = {  # (1)
    "PoolName": ...,
}

parent.create_dedicated_ip_pool(**kwargs)
  1. See CreateDedicatedIpPoolRequestRequestTypeDef

create_deliverability_test_report#

Create a new predictive inbox placement test.

Type annotations and code completion for boto3.client("pinpoint-email").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)
    ...
  1. See EmailContentTypeDef
  2. See TagTypeDef
  3. See CreateDeliverabilityTestReportResponseTypeDef
# create_deliverability_test_report method usage example with argument unpacking

kwargs: CreateDeliverabilityTestReportRequestRequestTypeDef = {  # (1)
    "FromEmailAddress": ...,
    "Content": ...,
}

parent.create_deliverability_test_report(**kwargs)
  1. See CreateDeliverabilityTestReportRequestRequestTypeDef

create_email_identity#

Verifies an email identity for use with Amazon Pinpoint.

Type annotations and code completion for boto3.client("pinpoint-email").create_email_identity method. boto3 documentation

# create_email_identity method definition

def create_email_identity(
    self,
    *,
    EmailIdentity: str,
    Tags: Sequence[TagTypeDef] = ...,  # (1)
) -> CreateEmailIdentityResponseTypeDef:  # (2)
    ...
  1. See TagTypeDef
  2. See CreateEmailIdentityResponseTypeDef
# create_email_identity method usage example with argument unpacking

kwargs: CreateEmailIdentityRequestRequestTypeDef = {  # (1)
    "EmailIdentity": ...,
}

parent.create_email_identity(**kwargs)
  1. See CreateEmailIdentityRequestRequestTypeDef

delete_configuration_set#

Delete an existing configuration set.

Type annotations and code completion for boto3.client("pinpoint-email").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)
  1. See DeleteConfigurationSetRequestRequestTypeDef

delete_configuration_set_event_destination#

Delete an event destination.

Type annotations and code completion for boto3.client("pinpoint-email").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)
  1. See DeleteConfigurationSetEventDestinationRequestRequestTypeDef

delete_dedicated_ip_pool#

Delete a dedicated IP pool.

Type annotations and code completion for boto3.client("pinpoint-email").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)
  1. See DeleteDedicatedIpPoolRequestRequestTypeDef

delete_email_identity#

Deletes an email identity that you previously verified for use with Amazon Pinpoint.

Type annotations and code completion for boto3.client("pinpoint-email").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)
  1. See DeleteEmailIdentityRequestRequestTypeDef

generate_presigned_url#

Generate a presigned url given a client, its method, and arguments.

Type annotations and code completion for boto3.client("pinpoint-email").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:
    ...

get_account#

Obtain information about the email-sending status and capabilities of your Amazon Pinpoint account in the current AWS Region.

Type annotations and code completion for boto3.client("pinpoint-email").get_account method. boto3 documentation

# get_account method definition

def get_account(
    self,
) -> GetAccountResponseTypeDef:  # (1)
    ...
  1. See GetAccountResponseTypeDef

get_blacklist_reports#

Retrieve a list of the blacklists that your dedicated IP addresses appear on.

Type annotations and code completion for boto3.client("pinpoint-email").get_blacklist_reports method. boto3 documentation

# get_blacklist_reports method definition

def get_blacklist_reports(
    self,
    *,
    BlacklistItemNames: Sequence[str],
) -> GetBlacklistReportsResponseTypeDef:  # (1)
    ...
  1. See GetBlacklistReportsResponseTypeDef
# get_blacklist_reports method usage example with argument unpacking

kwargs: GetBlacklistReportsRequestRequestTypeDef = {  # (1)
    "BlacklistItemNames": ...,
}

parent.get_blacklist_reports(**kwargs)
  1. See GetBlacklistReportsRequestRequestTypeDef

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("pinpoint-email").get_configuration_set method. boto3 documentation

# get_configuration_set method definition

def get_configuration_set(
    self,
    *,
    ConfigurationSetName: str,
) -> GetConfigurationSetResponseTypeDef:  # (1)
    ...
  1. See GetConfigurationSetResponseTypeDef
# get_configuration_set method usage example with argument unpacking

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

parent.get_configuration_set(**kwargs)
  1. See GetConfigurationSetRequestRequestTypeDef

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("pinpoint-email").get_configuration_set_event_destinations method.