SESClient#
Auto-generated documentation for SES type annotations stubs module mypy-boto3-ses.
SESClient#
Type annotations and code completion for boto3.client("ses")
.
boto3 documentation
# SESClient usage example
from boto3.session import Session
from mypy_boto3_ses.client import SESClient
def get_ses_client() -> SESClient:
return Session().client("ses")
Exceptions#
boto3
client exceptions are generated in runtime.
This class provides code completion for boto3.client("ses").exceptions
structure.
# Exceptions.exceptions usage example
client = boto3.client("ses")
try:
do_something(client)
except (
client.exceptions.AccountSendingPausedException,
client.exceptions.AlreadyExistsException,
client.exceptions.CannotDeleteException,
client.exceptions.ClientError,
client.exceptions.ConfigurationSetAlreadyExistsException,
client.exceptions.ConfigurationSetDoesNotExistException,
client.exceptions.ConfigurationSetSendingPausedException,
client.exceptions.CustomVerificationEmailInvalidContentException,
client.exceptions.CustomVerificationEmailTemplateAlreadyExistsException,
client.exceptions.CustomVerificationEmailTemplateDoesNotExistException,
client.exceptions.EventDestinationAlreadyExistsException,
client.exceptions.EventDestinationDoesNotExistException,
client.exceptions.FromEmailAddressNotVerifiedException,
client.exceptions.InvalidCloudWatchDestinationException,
client.exceptions.InvalidConfigurationSetException,
client.exceptions.InvalidDeliveryOptionsException,
client.exceptions.InvalidFirehoseDestinationException,
client.exceptions.InvalidLambdaFunctionException,
client.exceptions.InvalidPolicyException,
client.exceptions.InvalidRenderingParameterException,
client.exceptions.InvalidS3ConfigurationException,
client.exceptions.InvalidSNSDestinationException,
client.exceptions.InvalidSnsTopicException,
client.exceptions.InvalidTemplateException,
client.exceptions.InvalidTrackingOptionsException,
client.exceptions.LimitExceededException,
client.exceptions.MailFromDomainNotVerifiedException,
client.exceptions.MessageRejected,
client.exceptions.MissingRenderingAttributeException,
client.exceptions.ProductionAccessNotGrantedException,
client.exceptions.RuleDoesNotExistException,
client.exceptions.RuleSetDoesNotExistException,
client.exceptions.TemplateDoesNotExistException,
client.exceptions.TrackingOptionsAlreadyExistsException,
client.exceptions.TrackingOptionsDoesNotExistException,
) as e:
print(e)
# Exceptions.exceptions type checking example
from mypy_boto3_ses.client import Exceptions
def handle_error(exc: Exceptions.AccountSendingPausedException) -> None:
...
Methods#
can_paginate#
Check if an operation can be paginated.
Type annotations and code completion for boto3.client("ses").can_paginate
method.
boto3 documentation
# can_paginate method definition
def can_paginate(
self,
operation_name: str,
) -> bool:
...
clone_receipt_rule_set#
Creates a receipt rule set by cloning an existing one.
Type annotations and code completion for boto3.client("ses").clone_receipt_rule_set
method.
boto3 documentation
# clone_receipt_rule_set method definition
def clone_receipt_rule_set(
self,
*,
RuleSetName: str,
OriginalRuleSetName: str,
) -> Dict[str, Any]:
...
# clone_receipt_rule_set method usage example with argument unpacking
kwargs: CloneReceiptRuleSetRequestRequestTypeDef = { # (1)
"RuleSetName": ...,
"OriginalRuleSetName": ...,
}
parent.clone_receipt_rule_set(**kwargs)
close#
Closes underlying endpoint connections.
Type annotations and code completion for boto3.client("ses").close
method.
boto3 documentation
# close method definition
def close(
self,
) -> None:
...
create_configuration_set#
Creates a configuration set.
Type annotations and code completion for boto3.client("ses").create_configuration_set
method.
boto3 documentation
# create_configuration_set method definition
def create_configuration_set(
self,
*,
ConfigurationSet: ConfigurationSetTypeDef, # (1)
) -> Dict[str, Any]:
...
# create_configuration_set method usage example with argument unpacking
kwargs: CreateConfigurationSetRequestRequestTypeDef = { # (1)
"ConfigurationSet": ...,
}
parent.create_configuration_set(**kwargs)
create_configuration_set_event_destination#
Creates a configuration set event destination.
Type annotations and code completion for boto3.client("ses").create_configuration_set_event_destination
method.
boto3 documentation
# create_configuration_set_event_destination method definition
def create_configuration_set_event_destination(
self,
*,
ConfigurationSetName: str,
EventDestination: EventDestinationTypeDef, # (1)
) -> Dict[str, Any]:
...
# create_configuration_set_event_destination method usage example with argument unpacking
kwargs: CreateConfigurationSetEventDestinationRequestRequestTypeDef = { # (1)
"ConfigurationSetName": ...,
"EventDestination": ...,
}
parent.create_configuration_set_event_destination(**kwargs)
create_configuration_set_tracking_options#
Creates an association between a configuration set and a custom domain for open and click event tracking.
Type annotations and code completion for boto3.client("ses").create_configuration_set_tracking_options
method.
boto3 documentation
# create_configuration_set_tracking_options method definition
def create_configuration_set_tracking_options(
self,
*,
ConfigurationSetName: str,
TrackingOptions: TrackingOptionsTypeDef, # (1)
) -> Dict[str, Any]:
...
# create_configuration_set_tracking_options method usage example with argument unpacking
kwargs: CreateConfigurationSetTrackingOptionsRequestRequestTypeDef = { # (1)
"ConfigurationSetName": ...,
"TrackingOptions": ...,
}
parent.create_configuration_set_tracking_options(**kwargs)
create_custom_verification_email_template#
Creates a new custom verification email template.
Type annotations and code completion for boto3.client("ses").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,
) -> EmptyResponseMetadataTypeDef: # (1)
...
# 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_receipt_filter#
Creates a new IP address filter.
Type annotations and code completion for boto3.client("ses").create_receipt_filter
method.
boto3 documentation
# create_receipt_filter method definition
def create_receipt_filter(
self,
*,
Filter: ReceiptFilterTypeDef, # (1)
) -> Dict[str, Any]:
...
# create_receipt_filter method usage example with argument unpacking
kwargs: CreateReceiptFilterRequestRequestTypeDef = { # (1)
"Filter": ...,
}
parent.create_receipt_filter(**kwargs)
create_receipt_rule#
Creates a receipt rule.
Type annotations and code completion for boto3.client("ses").create_receipt_rule
method.
boto3 documentation
# create_receipt_rule method definition
def create_receipt_rule(
self,
*,
RuleSetName: str,
Rule: ReceiptRuleTypeDef, # (1)
After: str = ...,
) -> Dict[str, Any]:
...
# create_receipt_rule method usage example with argument unpacking
kwargs: CreateReceiptRuleRequestRequestTypeDef = { # (1)
"RuleSetName": ...,
"Rule": ...,
}
parent.create_receipt_rule(**kwargs)
create_receipt_rule_set#
Creates an empty receipt rule set.
Type annotations and code completion for boto3.client("ses").create_receipt_rule_set
method.
boto3 documentation
# create_receipt_rule_set method definition
def create_receipt_rule_set(
self,
*,
RuleSetName: str,
) -> Dict[str, Any]:
...
# create_receipt_rule_set method usage example with argument unpacking
kwargs: CreateReceiptRuleSetRequestRequestTypeDef = { # (1)
"RuleSetName": ...,
}
parent.create_receipt_rule_set(**kwargs)
create_template#
Creates an email template.
Type annotations and code completion for boto3.client("ses").create_template
method.
boto3 documentation
# create_template method definition
def create_template(
self,
*,
Template: TemplateTypeDef, # (1)
) -> Dict[str, Any]:
...
- See TemplateTypeDef
# create_template method usage example with argument unpacking
kwargs: CreateTemplateRequestRequestTypeDef = { # (1)
"Template": ...,
}
parent.create_template(**kwargs)
delete_configuration_set#
Deletes a configuration set.
Type annotations and code completion for boto3.client("ses").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#
Deletes a configuration set event destination.
Type annotations and code completion for boto3.client("ses").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_configuration_set_tracking_options#
Deletes an association between a configuration set and a custom domain for open and click event tracking.
Type annotations and code completion for boto3.client("ses").delete_configuration_set_tracking_options
method.
boto3 documentation
# delete_configuration_set_tracking_options method definition
def delete_configuration_set_tracking_options(
self,
*,
ConfigurationSetName: str,
) -> Dict[str, Any]:
...
# delete_configuration_set_tracking_options method usage example with argument unpacking
kwargs: DeleteConfigurationSetTrackingOptionsRequestRequestTypeDef = { # (1)
"ConfigurationSetName": ...,
}
parent.delete_configuration_set_tracking_options(**kwargs)
delete_custom_verification_email_template#
Deletes an existing custom verification email template.
Type annotations and code completion for boto3.client("ses").delete_custom_verification_email_template
method.
boto3 documentation
# delete_custom_verification_email_template method definition
def delete_custom_verification_email_template(
self,
*,
TemplateName: str,
) -> EmptyResponseMetadataTypeDef: # (1)
...
# delete_custom_verification_email_template method usage example with argument unpacking
kwargs: DeleteCustomVerificationEmailTemplateRequestRequestTypeDef = { # (1)
"TemplateName": ...,
}
parent.delete_custom_verification_email_template(**kwargs)
delete_identity#
Deletes the specified identity (an email address or a domain) from the list of verified identities.
Type annotations and code completion for boto3.client("ses").delete_identity
method.
boto3 documentation
# delete_identity method definition
def delete_identity(
self,
*,
Identity: str,
) -> Dict[str, Any]:
...
# delete_identity method usage example with argument unpacking
kwargs: DeleteIdentityRequestRequestTypeDef = { # (1)
"Identity": ...,
}
parent.delete_identity(**kwargs)
delete_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("ses").delete_identity_policy
method.
boto3 documentation
# delete_identity_policy method definition
def delete_identity_policy(
self,
*,
Identity: str,
PolicyName: str,
) -> Dict[str, Any]:
...
# delete_identity_policy method usage example with argument unpacking
kwargs: DeleteIdentityPolicyRequestRequestTypeDef = { # (1)
"Identity": ...,
"PolicyName": ...,
}
parent.delete_identity_policy(**kwargs)
delete_receipt_filter#
Deletes the specified IP address filter.
Type annotations and code completion for boto3.client("ses").delete_receipt_filter
method.
boto3 documentation
# delete_receipt_filter method definition
def delete_receipt_filter(
self,
*,
FilterName: str,
) -> Dict[str, Any]:
...
# delete_receipt_filter method usage example with argument unpacking
kwargs: DeleteReceiptFilterRequestRequestTypeDef = { # (1)
"FilterName": ...,
}
parent.delete_receipt_filter(**kwargs)
delete_receipt_rule#
Deletes the specified receipt rule.
Type annotations and code completion for boto3.client("ses").delete_receipt_rule
method.
boto3 documentation
# delete_receipt_rule method definition
def delete_receipt_rule(
self,
*,
RuleSetName: str,
RuleName: str,
) -> Dict[str, Any]:
...
# delete_receipt_rule method usage example with argument unpacking
kwargs: DeleteReceiptRuleRequestRequestTypeDef = { # (1)
"RuleSetName": ...,
"RuleName": ...,
}
parent.delete_receipt_rule(**kwargs)
delete_receipt_rule_set#
Deletes the specified receipt rule set and all of the receipt rules it contains.
Type annotations and code completion for boto3.client("ses").delete_receipt_rule_set
method.
boto3 documentation
# delete_receipt_rule_set method definition
def delete_receipt_rule_set(
self,
*,
RuleSetName: str,
) -> Dict[str, Any]:
...
# delete_receipt_rule_set method usage example with argument unpacking
kwargs: DeleteReceiptRuleSetRequestRequestTypeDef = { # (1)
"RuleSetName": ...,
}
parent.delete_receipt_rule_set(**kwargs)
delete_template#
Deletes an email template.
Type annotations and code completion for boto3.client("ses").delete_template
method.
boto3 documentation
# delete_template method definition
def delete_template(
self,
*,
TemplateName: str,
) -> Dict[str, Any]:
...
# delete_template method usage example with argument unpacking
kwargs: DeleteTemplateRequestRequestTypeDef = { # (1)
"TemplateName": ...,
}
parent.delete_template(**kwargs)
delete_verified_email_address#
Deprecated.
Type annotations and code completion for boto3.client("ses").delete_verified_email_address
method.
boto3 documentation
# delete_verified_email_address method definition
def delete_verified_email_address(
self,
*,
EmailAddress: str,
) -> EmptyResponseMetadataTypeDef: # (1)
...
# delete_verified_email_address method usage example with argument unpacking
kwargs: DeleteVerifiedEmailAddressRequestRequestTypeDef = { # (1)
"EmailAddress": ...,
}
parent.delete_verified_email_address(**kwargs)
describe_active_receipt_rule_set#
Returns the metadata and receipt rules for the receipt rule set that is currently active.
Type annotations and code completion for boto3.client("ses").describe_active_receipt_rule_set
method.
boto3 documentation
# describe_active_receipt_rule_set method definition
def describe_active_receipt_rule_set(
self,
) -> DescribeActiveReceiptRuleSetResponseTypeDef: # (1)
...
describe_configuration_set#
Returns the details of the specified configuration set.
Type annotations and code completion for boto3.client("ses").describe_configuration_set
method.
boto3 documentation
# describe_configuration_set method definition
def describe_configuration_set(
self,
*,
ConfigurationSetName: str,
ConfigurationSetAttributeNames: Sequence[ConfigurationSetAttributeType] = ..., # (1)
) -> DescribeConfigurationSetResponseTypeDef: # (2)
...
# describe_configuration_set method usage example with argument unpacking
kwargs: DescribeConfigurationSetRequestRequestTypeDef = { # (1)
"ConfigurationSetName": ...,
}
parent.describe_configuration_set(**kwargs)
describe_receipt_rule#
Returns the details of the specified receipt rule.
Type annotations and code completion for boto3.client("ses").describe_receipt_rule
method.
boto3 documentation
# describe_receipt_rule method definition
def describe_receipt_rule(
self,
*,
RuleSetName: str,
RuleName: str,
) -> DescribeReceiptRuleResponseTypeDef: # (1)
...
# describe_receipt_rule method usage example with argument unpacking
kwargs: DescribeReceiptRuleRequestRequestTypeDef = { # (1)
"RuleSetName": ...,
"RuleName": ...,
}
parent.describe_receipt_rule(**kwargs)
describe_receipt_rule_set#
Returns the details of the specified receipt rule set.
Type annotations and code completion for boto3.client("ses").describe_receipt_rule_set
method.
boto3 documentation
# describe_receipt_rule_set method definition
def describe_receipt_rule_set(
self,
*,
RuleSetName: str,
) -> DescribeReceiptRuleSetResponseTypeDef: # (1)
...
# describe_receipt_rule_set method usage example with argument unpacking
kwargs: DescribeReceiptRuleSetRequestRequestTypeDef = { # (1)
"RuleSetName": ...,
}
parent.describe_receipt_rule_set(**kwargs)
generate_presigned_url#
Generate a presigned url given a client, its method, and arguments.
Type annotations and code completion for boto3.client("ses").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_sending_enabled#
Returns the email sending status of the Amazon SES account for the current Region.
Type annotations and code completion for boto3.client("ses").get_account_sending_enabled
method.
boto3 documentation
# get_account_sending_enabled method definition
def get_account_sending_enabled(
self,
) -> GetAccountSendingEnabledResponseTypeDef: # (1)
...
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("ses").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)