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. boto3 documentation

# get_configuration_set_event_destinations method definition

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

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

parent.get_configuration_set_event_destinations(**kwargs)
  1. See GetConfigurationSetEventDestinationsRequestRequestTypeDef

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

# get_dedicated_ip method definition

def get_dedicated_ip(
    self,
    *,
    Ip: str,
) -> GetDedicatedIpResponseTypeDef:  # (1)
    ...
  1. See GetDedicatedIpResponseTypeDef 
# get_dedicated_ip method usage example with argument unpacking

kwargs: GetDedicatedIpRequestRequestTypeDef = {  # (1)
    "Ip": ...,
}

parent.get_dedicated_ip(**kwargs)
  1. See GetDedicatedIpRequestRequestTypeDef

get_dedicated_ips#

List the dedicated IP addresses that are associated with your Amazon Pinpoint account.

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

# get_dedicated_ips method definition

def get_dedicated_ips(
    self,
    *,
    PoolName: str = ...,
    NextToken: str = ...,
    PageSize: int = ...,
) -> GetDedicatedIpsResponseTypeDef:  # (1)
    ...
  1. See GetDedicatedIpsResponseTypeDef 
# get_dedicated_ips method usage example with argument unpacking

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

parent.get_dedicated_ips(**kwargs)
  1. See GetDedicatedIpsRequestRequestTypeDef

get_deliverability_dashboard_options#

Retrieve information about the status of the Deliverability dashboard for your Amazon Pinpoint account.

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

# get_deliverability_dashboard_options method definition

def get_deliverability_dashboard_options(
    self,
) -> GetDeliverabilityDashboardOptionsResponseTypeDef:  # (1)
    ...
  1. See GetDeliverabilityDashboardOptionsResponseTypeDef

get_deliverability_test_report#

Retrieve the results of a predictive inbox placement test.

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

# get_deliverability_test_report method definition

def get_deliverability_test_report(
    self,
    *,
    ReportId: str,
) -> GetDeliverabilityTestReportResponseTypeDef:  # (1)
    ...
  1. See GetDeliverabilityTestReportResponseTypeDef 
# get_deliverability_test_report method usage example with argument unpacking

kwargs: GetDeliverabilityTestReportRequestRequestTypeDef = {  # (1)
    "ReportId": ...,
}

parent.get_deliverability_test_report(**kwargs)
  1. See GetDeliverabilityTestReportRequestRequestTypeDef

get_domain_deliverability_campaign#

Retrieve all the deliverability data for a specific campaign.

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

# get_domain_deliverability_campaign method definition

def get_domain_deliverability_campaign(
    self,
    *,
    CampaignId: str,
) -> GetDomainDeliverabilityCampaignResponseTypeDef:  # (1)
    ...
  1. See GetDomainDeliverabilityCampaignResponseTypeDef 
# get_domain_deliverability_campaign method usage example with argument unpacking

kwargs: GetDomainDeliverabilityCampaignRequestRequestTypeDef = {  # (1)
    "CampaignId": ...,
}

parent.get_domain_deliverability_campaign(**kwargs)
  1. See GetDomainDeliverabilityCampaignRequestRequestTypeDef

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("pinpoint-email").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)
    ...
  1. See GetDomainStatisticsReportResponseTypeDef 
# get_domain_statistics_report method usage example with argument unpacking

kwargs: GetDomainStatisticsReportRequestRequestTypeDef = {  # (1)
    "Domain": ...,
    "StartDate": ...,
    "EndDate": ...,
}

parent.get_domain_statistics_report(**kwargs)
  1. See GetDomainStatisticsReportRequestRequestTypeDef

get_email_identity#

Provides information about a specific identity associated with your Amazon Pinpoint account, including the identity's verification status, its DKIM authentication status, and its custom Mail-From settings.

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

# get_email_identity method definition

def get_email_identity(
    self,
    *,
    EmailIdentity: str,
) -> GetEmailIdentityResponseTypeDef:  # (1)
    ...
  1. See GetEmailIdentityResponseTypeDef 
# get_email_identity method usage example with argument unpacking

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

parent.get_email_identity(**kwargs)
  1. See GetEmailIdentityRequestRequestTypeDef

list_configuration_sets#

List all of the configuration sets associated with your Amazon Pinpoint account in the current region.

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

# list_configuration_sets method definition

def list_configuration_sets(
    self,
    *,
    NextToken: str = ...,
    PageSize: int = ...,
) -> ListConfigurationSetsResponseTypeDef:  # (1)
    ...
  1. See ListConfigurationSetsResponseTypeDef 
# list_configuration_sets method usage example with argument unpacking

kwargs: ListConfigurationSetsRequestRequestTypeDef = {  # (1)
    "NextToken": ...,
}

parent.list_configuration_sets(**kwargs)
  1. See ListConfigurationSetsRequestRequestTypeDef

list_dedicated_ip_pools#

List all of the dedicated IP pools that exist in your Amazon Pinpoint account in the current AWS Region.

Type annotations and code completion for boto3.client("pinpoint-email").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)
    ...
  1. See ListDedicatedIpPoolsResponseTypeDef 
# list_dedicated_ip_pools method usage example with argument unpacking

kwargs: ListDedicatedIpPoolsRequestRequestTypeDef = {  # (1)
    "NextToken": ...,
}

parent.list_dedicated_ip_pools(**kwargs)
  1. See ListDedicatedIpPoolsRequestRequestTypeDef

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("pinpoint-email").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)
    ...
  1. See ListDeliverabilityTestReportsResponseTypeDef 
# list_deliverability_test_reports method usage example with argument unpacking

kwargs: ListDeliverabilityTestReportsRequestRequestTypeDef = {  # (1)
    "NextToken": ...,
}

parent.list_deliverability_test_reports(**kwargs)
  1. See ListDeliverabilityTestReportsRequestRequestTypeDef

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("pinpoint-email").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)
    ...
  1. See ListDomainDeliverabilityCampaignsResponseTypeDef 
# list_domain_deliverability_campaigns method usage example with argument unpacking

kwargs: ListDomainDeliverabilityCampaignsRequestRequestTypeDef = {  # (1)
    "StartDate": ...,
    "EndDate": ...,
    "SubscribedDomain": ...,
}

parent.list_domain_deliverability_campaigns(**kwargs)
  1. See ListDomainDeliverabilityCampaignsRequestRequestTypeDef

list_email_identities#

Returns a list of all of the email identities that are associated with your Amazon Pinpoint account.

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

# list_email_identities method definition

def list_email_identities(
    self,
    *,
    NextToken: str = ...,
    PageSize: int = ...,
) -> ListEmailIdentitiesResponseTypeDef:  # (1)
    ...
  1. See ListEmailIdentitiesResponseTypeDef 
# list_email_identities method usage example with argument unpacking

kwargs: ListEmailIdentitiesRequestRequestTypeDef = {  # (1)
    "NextToken": ...,
}

parent.list_email_identities(**kwargs)
  1. See ListEmailIdentitiesRequestRequestTypeDef

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

# list_tags_for_resource method definition

def list_tags_for_resource(
    self,
    *,
    ResourceArn: str,
) -> ListTagsForResourceResponseTypeDef:  # (1)
    ...
  1. See ListTagsForResourceResponseTypeDef 
# list_tags_for_resource method usage example with argument unpacking

kwargs: ListTagsForResourceRequestRequestTypeDef = {  # (1)
    "ResourceArn": ...,
}

parent.list_tags_for_resource(**kwargs)
  1. See ListTagsForResourceRequestRequestTypeDef

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("pinpoint-email").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)
  1. See PutAccountDedicatedIpWarmupAttributesRequestRequestTypeDef

put_account_sending_attributes#

Enable or disable the ability of your account to send email.

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

put_configuration_set_delivery_options#

Associate a configuration set with a dedicated IP pool.

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

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

parent.put_configuration_set_delivery_options(**kwargs)
  1. See PutConfigurationSetDeliveryOptionsRequestRequestTypeDef

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 AWS Region.

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

put_configuration_set_sending_options#

Enable or disable email sending for messages that use a particular configuration set in a specific AWS Region.

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

put_configuration_set_tracking_options#

Specify a custom domain to use for open and click tracking elements in email that you send using Amazon Pinpoint.

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

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

parent.put_configuration_set_tracking_options(**kwargs)
  1. See PutConfigurationSetTrackingOptionsRequestRequestTypeDef

put_dedicated_ip_in_pool#

Move a dedicated IP address to an existing dedicated IP pool.

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

put_dedicated_ip_warmup_attributes#

See also: AWS API Documentation.

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

put_deliverability_dashboard_option#

Enable or disable the Deliverability dashboard for your Amazon Pinpoint account.

Type annotations and code completion for boto3.client("pinpoint-email").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]:
    ...
  1. See DomainDeliverabilityTrackingOptionTypeDef DomainDeliverabilityTrackingOptionOutputTypeDef 
# put_deliverability_dashboard_option method usage example with argument unpacking

kwargs: PutDeliverabilityDashboardOptionRequestRequestTypeDef = {  # (1)
    "DashboardEnabled": ...,
}

parent.put_deliverability_dashboard_option(**kwargs)
  1. See PutDeliverabilityDashboardOptionRequestRequestTypeDef

put_email_identity_dkim_attributes#

Used to enable or disable DKIM authentication for an email identity.

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

put_email_identity_feedback_attributes#

Used to enable or disable feedback forwarding for an identity.

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

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("pinpoint-email").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]:
    ...
  1. See BehaviorOnMxFailureType 
# put_email_identity_mail_from_attributes method usage example with argument unpacking

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

parent.put_email_identity_mail_from_attributes(**kwargs)
  1. See PutEmailIdentityMailFromAttributesRequestRequestTypeDef

send_email#

Sends an email message.

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

# send_email method definition

def send_email(
    self,
    *,
    Destination: DestinationTypeDef,  # (1)
    Content: EmailContentTypeDef,  # (2)
    FromEmailAddress: str = ...,
    ReplyToAddresses: Sequence[str] = ...,
    FeedbackForwardingEmailAddress: str = ...,
    EmailTags: Sequence[MessageTagTypeDef] = ...,  # (3)
    ConfigurationSetName: str = ...,
) -> SendEmailResponseTypeDef:  # (4)
    ...
  1. See DestinationTypeDef
  2. See EmailContentTypeDef
  3. See MessageTagTypeDef
  4. See SendEmailResponseTypeDef 
# send_email method usage example with argument unpacking

kwargs: SendEmailRequestRequestTypeDef = {  # (1)
    "Destination": ...,
    "Content": ...,
}

parent.send_email(**kwargs)
  1. See SendEmailRequestRequestTypeDef

tag_resource#

Add one or more tags (keys and values) to a specified resource.

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

# tag_resource method definition

def tag_resource(
    self,
    *,
    ResourceArn: str,
    Tags: Sequence[TagTypeDef],  # (1)
) -> Dict[str, Any]:
    ...
  1. See TagTypeDef 
# tag_resource method usage example with argument unpacking

kwargs: TagResourceRequestRequestTypeDef = {  # (1)
    "ResourceArn": ...,
    "Tags": ...,
}

parent.tag_resource(**kwargs)
  1. See TagResourceRequestRequestTypeDef

untag_resource#

Remove one or more tags (keys and values) from a specified resource.

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

update_configuration_set_event_destination#

Update the configuration of an event destination for a configuration set.

Type annotations and code completion for boto3.client("pinpoint-email").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]:
    ...
  1. See EventDestinationDefinitionTypeDef 
# update_configuration_set_event_destination method usage example with argument unpacking

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

parent.update_configuration_set_event_destination(**kwargs)
  1. See UpdateConfigurationSetEventDestinationRequestRequestTypeDef

get_paginator#

Type annotations and code completion for boto3.client("pinpoint-email").get_paginator method with overloads.