Examples#
Auto-generated documentation for SES type annotations stubs module mypy-boto3-ses.
Client#
Implicit type annotations#
Can be used with boto3-stubs[ses] package installed.
Write your SES code as usual,
type checking and code completion should work out of the box.
# SESClient usage example
from boto3.session import Session
session = Session()
client = session.client("ses") # (1)
result = client.create_custom_verification_email_template() # (2)- client: SESClient
- result: EmptyResponseMetadataTypeDef
# ListConfigurationSetsPaginator usage example
from boto3.session import Session
session = Session()
client = session.client("ses") # (1)
paginator = client.get_paginator("list_configuration_sets") # (2)
for item in paginator.paginate(...):
print(item) # (3)- client: SESClient
- paginator: ListConfigurationSetsPaginator
- item: ListConfigurationSetsResponseTypeDef
# IdentityExistsWaiter usage example
from boto3.session import Session
session = Session()
client = session.client("ses") # (1)
waiter = client.get_waiter("identity_exists") # (2)
waiter.wait()- client: SESClient
- waiter: IdentityExistsWaiter
Explicit type annotations#
With boto3-stubs-lite[ses]
or a standalone mypy_boto3_ses package, you have to explicitly specify client: SESClient type annotation.
All other type annotations are optional, as types should be discovered automatically. However, these type annotations can be helpful in your functions and methods.
# SESClient usage example with type annotations
from boto3.session import Session
from mypy_boto3_ses.client import SESClient
from mypy_boto3_ses.type_defs import EmptyResponseMetadataTypeDef
from mypy_boto3_ses.type_defs import CreateCustomVerificationEmailTemplateRequestRequestTypeDef
session = Session()
client: SESClient = session.client("ses")
kwargs: CreateCustomVerificationEmailTemplateRequestRequestTypeDef = {...}
result: EmptyResponseMetadataTypeDef = client.create_custom_verification_email_template(**kwargs)# ListConfigurationSetsPaginator usage example with type annotations
from boto3.session import Session
from mypy_boto3_ses.client import SESClient
from mypy_boto3_ses.paginator import ListConfigurationSetsPaginator
from mypy_boto3_ses.type_defs import ListConfigurationSetsResponseTypeDef
session = Session()
client: SESClient = session.client("ses")
paginator: ListConfigurationSetsPaginator = client.get_paginator("list_configuration_sets")
for item in paginator.paginate(...):
item: ListConfigurationSetsResponseTypeDef
print(item)# IdentityExistsWaiter usage example with type annotations
from boto3.session import Session
from mypy_boto3_ses.client import SESClient
from mypy_boto3_ses.waiter import IdentityExistsWaiter
session = Session()
client: SESClient = session.client("ses")
waiter: IdentityExistsWaiter = client.get_waiter("identity_exists")
waiter.wait()