2026/09/29 - Amazon Simple Email Service - 3 updated api methods
Changes Added Filter support for ListTenants, ListEmailIdentities, and ListConfigurationSets APIs.
{'Filter': {'CONFIGURATION_SET_NAME_CONTAINS': 'string'}}
List all of the configuration sets associated with your account in the current region.
Configuration sets are groups of rules that you can apply to the emails you send. You apply a configuration set to an email by including a reference to the configuration set in the headers of the email. When you apply a configuration set to an email, all of the rules in that configuration set are applied to the email.
See also: AWS API Documentation
Request Syntax
client.list_configuration_sets(
Filter={
'string': 'string'
},
NextToken='string',
PageSize=123
)
dict
An object that contains filters to apply when listing configuration sets. You can filter by configuration set name.
(string) --
The filter key to use when listing configuration sets. This can be one of the following:
CONFIGURATION_SET_NAME_CONTAINS – Filter by a substring of the configuration set name.
(string) --
string
A token returned from a previous call to ListConfigurationSets to indicate the position in the list of configuration sets.
integer
The number of results to show in a single call to ListConfigurationSets. If the number of results is larger than the number you specified in this parameter, then the response includes a NextToken element, which you can use to obtain additional results.
dict
Response Syntax
{
'ConfigurationSets': [
'string',
],
'NextToken': 'string'
}
Response Structure
(dict) --
A list of configuration sets in your Amazon SES account in the current Amazon Web Services Region.
ConfigurationSets (list) --
An array that contains all of the configuration sets in your Amazon SES account in the current Amazon Web Services Region.
(string) --
The name of a configuration set.
Configuration sets are groups of rules that you can apply to the emails you send. You apply a configuration set to an email by including a reference to the configuration set in the headers of the email. When you apply a configuration set to an email, all of the rules in that configuration set are applied to the email.
NextToken (string) --
A token that indicates that there are additional configuration sets to list. To view additional configuration sets, issue another request to ListConfigurationSets, and pass this token in the NextToken parameter.
{'Filter': {'IDENTITY_NAME_CONTAINS | IDENTITY_TYPE | VERIFICATION_STATUS': 'string'}}
Returns a list of all of the email identities that are associated with your Amazon Web Services account. An identity can be either an email address or a domain. This operation returns identities that are verified as well as those that aren't. This operation returns identities that are associated with Amazon SES and Amazon Pinpoint.
See also: AWS API Documentation
Request Syntax
client.list_email_identities(
Filter={
'string': 'string'
},
NextToken='string',
PageSize=123
)
dict
An object that contains filters to apply when listing email identities. You can filter by identity name, identity type, or verification status.
(string) --
The filter key to use when listing email identities. This can be one of the following:
IDENTITY_NAME_CONTAINS – Filter by a substring of the identity name.
IDENTITY_TYPE – Filter by identity type.
VERIFICATION_STATUS – Filter by verification status.
(string) --
string
A token returned from a previous call to ListEmailIdentities to indicate the position in the list of identities.
integer
The number of results to show in a single call to ListEmailIdentities. If the number of results is larger than the number you specified in this parameter, then the response includes a NextToken element, which you can use to obtain additional results.
The value you specify has to be at least 0, and can be no more than 1000.
dict
Response Syntax
{
'EmailIdentities': [
{
'IdentityType': 'EMAIL_ADDRESS'|'DOMAIN'|'MANAGED_DOMAIN',
'IdentityName': 'string',
'SendingEnabled': True|False,
'VerificationStatus': 'PENDING'|'SUCCESS'|'FAILED'|'TEMPORARY_FAILURE'|'NOT_STARTED'
},
],
'NextToken': 'string'
}
Response Structure
(dict) --
A list of all of the identities that you've attempted to verify, regardless of whether or not those identities were successfully verified.
EmailIdentities (list) --
An array that includes all of the email identities associated with your Amazon Web Services account.
(dict) --
Information about an email identity.
IdentityType (string) --
The email identity type. Note: the MANAGED_DOMAIN type is not supported for email identity types.
IdentityName (string) --
The address or domain of the identity.
SendingEnabled (boolean) --
Indicates whether or not you can send email from the identity.
An identity is an email address or domain that you send email from. Before you can send email from an identity, you have to demostrate that you own the identity, and that you authorize Amazon SES to send email from that identity.
VerificationStatus (string) --
The verification status of the identity. The status can be one of the following:
PENDING – The verification process was initiated, but Amazon SES hasn't yet been able to verify the identity.
SUCCESS – The verification process completed successfully.
FAILED – The verification process failed.
TEMPORARY_FAILURE – A temporary issue is preventing Amazon SES from determining the verification status of the identity.
NOT_STARTED – The verification process hasn't been initiated for the identity.
NextToken (string) --
A token that indicates that there are additional configuration sets to list. To view additional configuration sets, issue another request to ListEmailIdentities, and pass this token in the NextToken parameter.
{'Filter': {'TENANT_NAME_CONTAINS | SENDING_STATUS': 'string'}}
Response {'Tenants': {'SendingStatus': 'ENABLED | REINSTATED | DISABLED'}}
List all tenants associated with your account in the current Amazon Web Services Region.
This operation returns basic information about each tenant, such as tenant name, ID, ARN, and creation timestamp.
See also: AWS API Documentation
Request Syntax
client.list_tenants(
Filter={
'string': 'string'
},
NextToken='string',
PageSize=123
)
dict
An object that contains filters to apply when listing tenants. You can filter by tenant name or sending status.
(string) --
The filter key to use when listing tenants. This can be one of the following:
TENANT_NAME_CONTAINS – Filter by a substring of the tenant name.
SENDING_STATUS – Filter by sending status.
(string) --
string
A token returned from a previous call to ListTenants to indicate the position in the list of tenants.
integer
The number of results to show in a single call to ListTenants. If the number of results is larger than the number you specified in this parameter, then the response includes a NextToken element, which you can use to obtain additional results.
dict
Response Syntax
{
'Tenants': [
{
'TenantName': 'string',
'TenantId': 'string',
'TenantArn': 'string',
'CreatedTimestamp': datetime(2015, 1, 1),
'SendingStatus': 'ENABLED'|'REINSTATED'|'DISABLED'
},
],
'NextToken': 'string'
}
Response Structure
(dict) --
Information about tenants associated with your account.
Tenants (list) --
An array that contains basic information about each tenant.
(dict) --
A structure that contains basic information about a tenant.
TenantName (string) --
The name of the tenant.
TenantId (string) --
A unique identifier for the tenant.
TenantArn (string) --
The Amazon Resource Name (ARN) of the tenant.
CreatedTimestamp (datetime) --
The date and time when the tenant was created.
SendingStatus (string) --
The sending status for a reputation entity. This can be one of the following:
ENABLED – Sending is allowed for this entity.
DISABLED – Sending is prevented for this entity.
REINSTATED – Sending is allowed even if there are active reputation findings.
NextToken (string) --
A token that indicates that there are additional tenants to list. To view additional tenants, issue another request to ListTenants, and pass this token in the NextToken parameter.