Amazon Simple Email Service

2025/07/31 - Amazon Simple Email Service - 12 new3 updated api methods

Changes  This release introduces support for Multi-tenant management

ListTenantResources (new) Link ¶

List all resources associated with a specific tenant.

This operation returns a list of resources (email identities, configuration sets, or email templates) that are associated with the specified tenant. You can optionally filter the results by resource type.

See also: AWS API Documentation

Request Syntax

client.list_tenant_resources(
    TenantName='string',
    Filter={
        'string': 'string'
    },
    PageSize=123,
    NextToken='string'
)
type TenantName:

string

param TenantName:

[REQUIRED]

The name of the tenant to list resources for.

type Filter:

dict

param Filter:

A map of filter keys and values for filtering the list of tenant resources. Currently, the only supported filter key is RESOURCE_TYPE.

  • (string) --

    The key used to filter tenant resources. Currently, the only supported filter key is RESOURCE_TYPE.

    • (string) --

      The value used to filter tenant resources. When filtering by RESOURCE_TYPE, valid values are EMAIL_IDENTITY, CONFIGURATION_SET, or EMAIL_TEMPLATE.

type PageSize:

integer

param PageSize:

The number of results to show in a single call to ListTenantResources. 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.

type NextToken:

string

param NextToken:

A token returned from a previous call to ListTenantResources to indicate the position in the list of tenant resources.

rtype:

dict

returns:

Response Syntax

{
    'TenantResources': [
        {
            'ResourceType': 'EMAIL_IDENTITY'|'CONFIGURATION_SET'|'EMAIL_TEMPLATE',
            'ResourceArn': 'string'
        },
    ],
    'NextToken': 'string'
}

Response Structure

  • (dict) --

    Information about resources associated with a specific tenant.

    • TenantResources (list) --

      An array that contains information about each resource associated with the tenant.

      • (dict) --

        A structure that contains information about a resource associated with a tenant.

        • ResourceType (string) --

          The type of resource associated with the tenant. Valid values are EMAIL_IDENTITY, CONFIGURATION_SET, or EMAIL_TEMPLATE.

        • ResourceArn (string) --

          The Amazon Resource Name (ARN) of the resource associated with the tenant.

    • NextToken (string) --

      A token that indicates that there are additional resources to list. To view additional resources, issue another request to ListTenantResources, and pass this token in the NextToken parameter.

ListTenants (new) Link ¶

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(
    NextToken='string',
    PageSize=123
)
type NextToken:

string

param NextToken:

A token returned from a previous call to ListTenants to indicate the position in the list of tenants.

type PageSize:

integer

param PageSize:

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.

rtype:

dict

returns:

Response Syntax

{
    'Tenants': [
        {
            'TenantName': 'string',
            'TenantId': 'string',
            'TenantArn': 'string',
            'CreatedTimestamp': datetime(2015, 1, 1)
        },
    ],
    '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.

    • 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.

DeleteTenant (new) Link ¶

Delete an existing tenant.

When you delete a tenant, its associations with resources are removed, but the resources themselves are not deleted.

See also: AWS API Documentation

Request Syntax

client.delete_tenant(
    TenantName='string'
)
type TenantName:

string

param TenantName:

[REQUIRED]

The name of the tenant to delete.

rtype:

dict

returns:

Response Syntax

{}

Response Structure

  • (dict) --

    If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body.

ListReputationEntities (new) Link ¶

List reputation entities in your Amazon SES account in the current Amazon Web Services Region. You can filter the results by entity type, reputation impact, sending status, or entity reference prefix.

Reputation entities represent resources in your account that have reputation tracking and management capabilities. Use this operation to get an overview of all entities and their current reputation status.

See also: AWS API Documentation

Request Syntax

client.list_reputation_entities(
    Filter={
        'string': 'string'
    },
    NextToken='string',
    PageSize=123
)
type Filter:

dict

param Filter:

An object that contains filters to apply when listing reputation entities. You can filter by entity type, reputation impact, sending status, or entity reference prefix.

  • (string) --

    The filter key to use when listing reputation entities. This can be one of the following:

    • ENTITY_TYPE – Filter by entity type.

    • REPUTATION_IMPACT – Filter by reputation impact level.

    • SENDING_STATUS – Filter by aggregate sending status.

    • ENTITY_REFERENCE_PREFIX – Filter by entity reference prefix.

    • (string) --

      The filter value to match against the specified filter key.

type NextToken:

string

param NextToken:

A token returned from a previous call to ListReputationEntities to indicate the position in the list of reputation entities.

type PageSize:

integer

param PageSize:

The number of results to show in a single call to ListReputationEntities. 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.

rtype:

dict

returns:

Response Syntax

{
    'ReputationEntities': [
        {
            'ReputationEntityReference': 'string',
            'ReputationEntityType': 'RESOURCE',
            'ReputationManagementPolicy': 'string',
            'CustomerManagedStatus': {
                'Status': 'ENABLED'|'REINSTATED'|'DISABLED',
                'Cause': 'string',
                'LastUpdatedTimestamp': datetime(2015, 1, 1)
            },
            'AwsSesManagedStatus': {
                'Status': 'ENABLED'|'REINSTATED'|'DISABLED',
                'Cause': 'string',
                'LastUpdatedTimestamp': datetime(2015, 1, 1)
            },
            'SendingStatusAggregate': 'ENABLED'|'REINSTATED'|'DISABLED',
            'ReputationImpact': 'LOW'|'HIGH'
        },
    ],
    'NextToken': 'string'
}

Response Structure

  • (dict) --

    A list of reputation entities in your account.

    • ReputationEntities (list) --

      An array that contains information about the reputation entities in your account.

      • (dict) --

        An object that contains information about a reputation entity, including its reference, type, policy, status records, and reputation impact.

        • ReputationEntityReference (string) --

          The unique identifier for the reputation entity. For resource-type entities, this is the Amazon Resource Name (ARN) of the resource.

        • ReputationEntityType (string) --

          The type of reputation entity. Currently, only RESOURCE type entities are supported.

        • ReputationManagementPolicy (string) --

          The Amazon Resource Name (ARN) of the reputation management policy applied to this entity. This is an Amazon Web Services Amazon SES-managed policy.

        • CustomerManagedStatus (dict) --

          The customer-managed status record for this reputation entity, including the current status, cause description, and last updated timestamp.

          • Status (string) --

            The current sending status. This can be one of the following:

            • ENABLED – Sending is allowed.

            • DISABLED – Sending is prevented.

            • REINSTATED – Sending is allowed even with active reputation findings.

          • Cause (string) --

            A description of the reason for the current status, or null if no specific cause is available.

          • LastUpdatedTimestamp (datetime) --

            The timestamp when this status was last updated.

        • AwsSesManagedStatus (dict) --

          The Amazon Web Services Amazon SES-managed status record for this reputation entity, including the current status, cause description, and last updated timestamp.

          • Status (string) --

            The current sending status. This can be one of the following:

            • ENABLED – Sending is allowed.

            • DISABLED – Sending is prevented.

            • REINSTATED – Sending is allowed even with active reputation findings.

          • Cause (string) --

            A description of the reason for the current status, or null if no specific cause is available.

          • LastUpdatedTimestamp (datetime) --

            The timestamp when this status was last updated.

        • SendingStatusAggregate (string) --

          The aggregate sending status that determines whether the entity is allowed to send emails. This status is derived from both the customer-managed and Amazon Web Services Amazon SES-managed statuses. If either the customer-managed status or the Amazon Web Services Amazon SES-managed status is DISABLED, the aggregate status will be DISABLED and the entity will not be allowed to send emails. When the customer-managed status is set to REINSTATED, the entity can continue sending even if there are active reputation findings, provided the Amazon Web Services Amazon SES-managed status also permits sending. The entity can only send emails when both statuses permit sending.

        • ReputationImpact (string) --

          The reputation impact level for this entity, representing the highest impact reputation finding currently active. Reputation findings can be retrieved using the ListRecommendations operation.

    • NextToken (string) --

      A token that indicates that there are additional reputation entities to list. To view additional reputation entities, issue another request to ListReputationEntities, and pass this token in the NextToken parameter.

DeleteTenantResourceAssociation (new) Link ¶

Delete an association between a tenant and a resource.

When you delete a tenant-resource association, the resource itself is not deleted, only its association with the specific tenant is removed. After removal, the resource will no longer be available for use with that tenant's email sending operations.

See also: AWS API Documentation

Request Syntax

client.delete_tenant_resource_association(
    TenantName='string',
    ResourceArn='string'
)
type TenantName:

string

param TenantName:

[REQUIRED]

The name of the tenant to remove the resource association from.

type ResourceArn:

string

param ResourceArn:

[REQUIRED]

The Amazon Resource Name (ARN) of the resource to remove from the tenant association.

rtype:

dict

returns:

Response Syntax

{}

Response Structure

  • (dict) --

    If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body.

GetTenant (new) Link ¶

Get information about a specific tenant, including the tenant's name, ID, ARN, creation timestamp, tags, and sending status.

See also: AWS API Documentation

Request Syntax

client.get_tenant(
    TenantName='string'
)
type TenantName:

string

param TenantName:

[REQUIRED]

The name of the tenant to retrieve information about.

rtype:

dict

returns:

Response Syntax

{
    'Tenant': {
        'TenantName': 'string',
        'TenantId': 'string',
        'TenantArn': 'string',
        'CreatedTimestamp': datetime(2015, 1, 1),
        'Tags': [
            {
                'Key': 'string',
                'Value': 'string'
            },
        ],
        'SendingStatus': 'ENABLED'|'REINSTATED'|'DISABLED'
    }
}

Response Structure

  • (dict) --

    Information about a specific tenant.

    • Tenant (dict) --

      A structure that contains details about the 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.

      • Tags (list) --

        An array of objects that define the tags (keys and values) associated with the tenant.

        • (dict) --

          An object that defines the tags that are associated with a resource. A tag is a label that you optionally define and associate with a resource. Tags can help you categorize and manage resources in different ways, such as by purpose, owner, environment, or other criteria. A resource can have as many as 50 tags.

          Each tag consists of a required tag key and an associated tag value, both of which you define. A tag key is a general label that acts as a category for a more specific tag value. A tag value acts as a descriptor within a tag key. A tag key can contain as many as 128 characters. A tag value can contain as many as 256 characters. The characters can be Unicode letters, digits, white space, or one of the following symbols: _ . : / = + -. The following additional restrictions apply to tags:

          • Tag keys and values are case sensitive.

          • For each associated resource, each tag key must be unique and it can have only one value.

          • The  aws: prefix is reserved for use by Amazon Web Services; you can’t use it in any tag keys or values that you define. In addition, you can't edit or remove tag keys or values that use this prefix. Tags that use this prefix don’t count against the limit of 50 tags per resource.

          • You can associate tags with public or shared resources, but the tags are available only for your Amazon Web Services account, not any other accounts that share the resource. In addition, the tags are available only for resources that are located in the specified Amazon Web Services Region for your Amazon Web Services account.

          • Key (string) --

            One part of a key-value pair that defines a tag. The maximum length of a tag key is 128 characters. The minimum length is 1 character.

          • Value (string) --

            The optional part of a key-value pair that defines a tag. The maximum length of a tag value is 256 characters. The minimum length is 0 characters. If you don't want a resource to have a specific tag value, don't specify a value for this parameter. If you don't specify a value, Amazon SES sets the value to an empty string.

      • SendingStatus (string) --

        The status of sending capability for the tenant.

CreateTenantResourceAssociation (new) Link ¶

Associate a resource with a tenant.

Resources can be email identities, configuration sets, or email templates. When you associate a resource with a tenant, you can use that resource when sending emails on behalf of that tenant.

A single resource can be associated with multiple tenants, allowing for resource sharing across different tenants while maintaining isolation in email sending operations.

See also: AWS API Documentation

Request Syntax

client.create_tenant_resource_association(
    TenantName='string',
    ResourceArn='string'
)
type TenantName:

string

param TenantName:

[REQUIRED]

The name of the tenant to associate the resource with.

type ResourceArn:

string

param ResourceArn:

[REQUIRED]

The Amazon Resource Name (ARN) of the resource to associate with the tenant.

rtype:

dict

returns:

Response Syntax

{}

Response Structure

  • (dict) --

    If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body.

ListResourceTenants (new) Link ¶

List all tenants associated with a specific resource.

This operation returns a list of tenants that are associated with the specified resource. This is useful for understanding which tenants are currently using a particular resource such as an email identity, configuration set, or email template.

See also: AWS API Documentation

Request Syntax

client.list_resource_tenants(
    ResourceArn='string',
    PageSize=123,
    NextToken='string'
)
type ResourceArn:

string

param ResourceArn:

[REQUIRED]

The Amazon Resource Name (ARN) of the resource to list associated tenants for.

type PageSize:

integer

param PageSize:

The number of results to show in a single call to ListResourceTenants. 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.

type NextToken:

string

param NextToken:

A token returned from a previous call to ListResourceTenants to indicate the position in the list of resource tenants.

rtype:

dict

returns:

Response Syntax

{
    'ResourceTenants': [
        {
            'TenantName': 'string',
            'TenantId': 'string',
            'ResourceArn': 'string',
            'AssociatedTimestamp': datetime(2015, 1, 1)
        },
    ],
    'NextToken': 'string'
}

Response Structure

  • (dict) --

    Information about tenants associated with a specific resource.

    • ResourceTenants (list) --

      An array that contains information about each tenant associated with the resource.

      • (dict) --

        A structure that contains information about a tenant associated with a resource.

        • TenantName (string) --

          The name of the tenant associated with the resource.

        • TenantId (string) --

          A unique identifier for the tenant associated with the resource.

        • ResourceArn (string) --

          The Amazon Resource Name (ARN) of the resource.

        • AssociatedTimestamp (datetime) --

          The date and time when the resource was associated with the tenant.

    • NextToken (string) --

      A token that indicates that there are additional tenants to list. To view additional tenants, issue another request to ListResourceTenants, and pass this token in the NextToken parameter.

UpdateReputationEntityPolicy (new) Link ¶

Update the reputation management policy for a reputation entity. The policy determines how the entity responds to reputation findings, such as automatically pausing sending when certain thresholds are exceeded.

Reputation management policies are Amazon Web Services Amazon SES-managed (predefined policies). You can select from none, standard, and strict policies.

See also: AWS API Documentation

Request Syntax

client.update_reputation_entity_policy(
    ReputationEntityType='RESOURCE',
    ReputationEntityReference='string',
    ReputationEntityPolicy='string'
)
type ReputationEntityType:

string

param ReputationEntityType:

[REQUIRED]

The type of reputation entity. Currently, only RESOURCE type entities are supported.

type ReputationEntityReference:

string

param ReputationEntityReference:

[REQUIRED]

The unique identifier for the reputation entity. For resource-type entities, this is the Amazon Resource Name (ARN) of the resource.

type ReputationEntityPolicy:

string

param ReputationEntityPolicy:

[REQUIRED]

The Amazon Resource Name (ARN) of the reputation management policy to apply to this entity. This is an Amazon Web Services Amazon SES-managed policy.

rtype:

dict

returns:

Response Syntax

{}

Response Structure

  • (dict) --

    If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body.

UpdateReputationEntityCustomerManagedStatus (new) Link ¶

Update the customer-managed sending status for a reputation entity. This allows you to enable, disable, or reinstate sending for the entity.

The customer-managed status works in conjunction with the Amazon Web Services Amazon SES-managed status to determine the overall sending capability. When you update the customer-managed status, the Amazon Web Services Amazon SES-managed status remains unchanged. If Amazon Web Services Amazon SES has disabled the entity, it will not be allowed to send regardless of the customer-managed status setting. When you reinstate an entity through the customer-managed status, it can continue sending only if the Amazon Web Services Amazon SES-managed status also permits sending, even if there are active reputation findings, until the findings are resolved or new violations occur.

See also: AWS API Documentation

Request Syntax

client.update_reputation_entity_customer_managed_status(
    ReputationEntityType='RESOURCE',
    ReputationEntityReference='string',
    SendingStatus='ENABLED'|'REINSTATED'|'DISABLED'
)
type ReputationEntityType:

string

param ReputationEntityType:

[REQUIRED]

The type of reputation entity. Currently, only RESOURCE type entities are supported.

type ReputationEntityReference:

string

param ReputationEntityReference:

[REQUIRED]

The unique identifier for the reputation entity. For resource-type entities, this is the Amazon Resource Name (ARN) of the resource.

type SendingStatus:

string

param SendingStatus:

[REQUIRED]

The new customer-managed sending status for the reputation entity. This can be one of the following:

  • ENABLED – Allow sending for this entity.

  • DISABLED – Prevent sending for this entity.

  • REINSTATED – Allow sending even if there are active reputation findings.

rtype:

dict

returns:

Response Syntax

{}

Response Structure

  • (dict) --

    If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body.

CreateTenant (new) Link ¶

Create a tenant.

Tenants are logical containers that group related SES resources together. Each tenant can have its own set of resources like email identities, configuration sets, and templates, along with reputation metrics and sending status. This helps isolate and manage email sending for different customers or business units within your Amazon SES API v2 account.

See also: AWS API Documentation

Request Syntax

client.create_tenant(
    TenantName='string',
    Tags=[
        {
            'Key': 'string',
            'Value': 'string'
        },
    ]
)
type TenantName:

string

param TenantName:

[REQUIRED]

The name of the tenant to create. The name can contain up to 64 alphanumeric characters, including letters, numbers, hyphens (-) and underscores (_) only.

type Tags:

list

param Tags:

An array of objects that define the tags (keys and values) to associate with the tenant

  • (dict) --

    An object that defines the tags that are associated with a resource. A tag is a label that you optionally define and associate with a resource. Tags can help you categorize and manage resources in different ways, such as by purpose, owner, environment, or other criteria. A resource can have as many as 50 tags.

    Each tag consists of a required tag key and an associated tag value, both of which you define. A tag key is a general label that acts as a category for a more specific tag value. A tag value acts as a descriptor within a tag key. A tag key can contain as many as 128 characters. A tag value can contain as many as 256 characters. The characters can be Unicode letters, digits, white space, or one of the following symbols: _ . : / = + -. The following additional restrictions apply to tags:

    • Tag keys and values are case sensitive.

    • For each associated resource, each tag key must be unique and it can have only one value.

    • The  aws: prefix is reserved for use by Amazon Web Services; you can’t use it in any tag keys or values that you define. In addition, you can't edit or remove tag keys or values that use this prefix. Tags that use this prefix don’t count against the limit of 50 tags per resource.

    • You can associate tags with public or shared resources, but the tags are available only for your Amazon Web Services account, not any other accounts that share the resource. In addition, the tags are available only for resources that are located in the specified Amazon Web Services Region for your Amazon Web Services account.

    • Key (string) -- [REQUIRED]

      One part of a key-value pair that defines a tag. The maximum length of a tag key is 128 characters. The minimum length is 1 character.

    • Value (string) -- [REQUIRED]

      The optional part of a key-value pair that defines a tag. The maximum length of a tag value is 256 characters. The minimum length is 0 characters. If you don't want a resource to have a specific tag value, don't specify a value for this parameter. If you don't specify a value, Amazon SES sets the value to an empty string.

rtype:

dict

returns:

Response Syntax

{
    'TenantName': 'string',
    'TenantId': 'string',
    'TenantArn': 'string',
    'CreatedTimestamp': datetime(2015, 1, 1),
    'Tags': [
        {
            'Key': 'string',
            'Value': 'string'
        },
    ],
    'SendingStatus': 'ENABLED'|'REINSTATED'|'DISABLED'
}

Response Structure

  • (dict) --

    Information about a newly created 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.

    • Tags (list) --

      An array of objects that define the tags (keys and values) associated with the tenant.

      • (dict) --

        An object that defines the tags that are associated with a resource. A tag is a label that you optionally define and associate with a resource. Tags can help you categorize and manage resources in different ways, such as by purpose, owner, environment, or other criteria. A resource can have as many as 50 tags.

        Each tag consists of a required tag key and an associated tag value, both of which you define. A tag key is a general label that acts as a category for a more specific tag value. A tag value acts as a descriptor within a tag key. A tag key can contain as many as 128 characters. A tag value can contain as many as 256 characters. The characters can be Unicode letters, digits, white space, or one of the following symbols: _ . : / = + -. The following additional restrictions apply to tags:

        • Tag keys and values are case sensitive.

        • For each associated resource, each tag key must be unique and it can have only one value.

        • The  aws: prefix is reserved for use by Amazon Web Services; you can’t use it in any tag keys or values that you define. In addition, you can't edit or remove tag keys or values that use this prefix. Tags that use this prefix don’t count against the limit of 50 tags per resource.

        • You can associate tags with public or shared resources, but the tags are available only for your Amazon Web Services account, not any other accounts that share the resource. In addition, the tags are available only for resources that are located in the specified Amazon Web Services Region for your Amazon Web Services account.

        • Key (string) --

          One part of a key-value pair that defines a tag. The maximum length of a tag key is 128 characters. The minimum length is 1 character.

        • Value (string) --

          The optional part of a key-value pair that defines a tag. The maximum length of a tag value is 256 characters. The minimum length is 0 characters. If you don't want a resource to have a specific tag value, don't specify a value for this parameter. If you don't specify a value, Amazon SES sets the value to an empty string.

    • SendingStatus (string) --

      The status of email sending capability for the tenant.

GetReputationEntity (new) Link ¶

Retrieve information about a specific reputation entity, including its reputation management policy, customer-managed status, Amazon Web Services Amazon SES-managed status, and aggregate sending status.

Reputation entities represent resources in your Amazon SES account that have reputation tracking and management capabilities. The reputation impact reflects the highest impact reputation finding for the entity. Reputation findings can be retrieved using the ListRecommendations operation.

See also: AWS API Documentation

Request Syntax

client.get_reputation_entity(
    ReputationEntityReference='string',
    ReputationEntityType='RESOURCE'
)
type ReputationEntityReference:

string

param ReputationEntityReference:

[REQUIRED]

The unique identifier for the reputation entity. For resource-type entities, this is the Amazon Resource Name (ARN) of the resource.

type ReputationEntityType:

string

param ReputationEntityType:

[REQUIRED]

The type of reputation entity. Currently, only RESOURCE type entities are supported.

rtype:

dict

returns:

Response Syntax

{
    'ReputationEntity': {
        'ReputationEntityReference': 'string',
        'ReputationEntityType': 'RESOURCE',
        'ReputationManagementPolicy': 'string',
        'CustomerManagedStatus': {
            'Status': 'ENABLED'|'REINSTATED'|'DISABLED',
            'Cause': 'string',
            'LastUpdatedTimestamp': datetime(2015, 1, 1)
        },
        'AwsSesManagedStatus': {
            'Status': 'ENABLED'|'REINSTATED'|'DISABLED',
            'Cause': 'string',
            'LastUpdatedTimestamp': datetime(2015, 1, 1)
        },
        'SendingStatusAggregate': 'ENABLED'|'REINSTATED'|'DISABLED',
        'ReputationImpact': 'LOW'|'HIGH'
    }
}

Response Structure

  • (dict) --

    Information about the requested reputation entity.

    • ReputationEntity (dict) --

      The reputation entity information, including status records, policy configuration, and reputation impact.

      • ReputationEntityReference (string) --

        The unique identifier for the reputation entity. For resource-type entities, this is the Amazon Resource Name (ARN) of the resource.

      • ReputationEntityType (string) --

        The type of reputation entity. Currently, only RESOURCE type entities are supported.

      • ReputationManagementPolicy (string) --

        The Amazon Resource Name (ARN) of the reputation management policy applied to this entity. This is an Amazon Web Services Amazon SES-managed policy.

      • CustomerManagedStatus (dict) --

        The customer-managed status record for this reputation entity, including the current status, cause description, and last updated timestamp.

        • Status (string) --

          The current sending status. This can be one of the following:

          • ENABLED – Sending is allowed.

          • DISABLED – Sending is prevented.

          • REINSTATED – Sending is allowed even with active reputation findings.

        • Cause (string) --

          A description of the reason for the current status, or null if no specific cause is available.

        • LastUpdatedTimestamp (datetime) --

          The timestamp when this status was last updated.

      • AwsSesManagedStatus (dict) --

        The Amazon Web Services Amazon SES-managed status record for this reputation entity, including the current status, cause description, and last updated timestamp.

        • Status (string) --

          The current sending status. This can be one of the following:

          • ENABLED – Sending is allowed.

          • DISABLED – Sending is prevented.

          • REINSTATED – Sending is allowed even with active reputation findings.

        • Cause (string) --

          A description of the reason for the current status, or null if no specific cause is available.

        • LastUpdatedTimestamp (datetime) --

          The timestamp when this status was last updated.

      • SendingStatusAggregate (string) --

        The aggregate sending status that determines whether the entity is allowed to send emails. This status is derived from both the customer-managed and Amazon Web Services Amazon SES-managed statuses. If either the customer-managed status or the Amazon Web Services Amazon SES-managed status is DISABLED, the aggregate status will be DISABLED and the entity will not be allowed to send emails. When the customer-managed status is set to REINSTATED, the entity can continue sending even if there are active reputation findings, provided the Amazon Web Services Amazon SES-managed status also permits sending. The entity can only send emails when both statuses permit sending.

      • ReputationImpact (string) --

        The reputation impact level for this entity, representing the highest impact reputation finding currently active. Reputation findings can be retrieved using the ListRecommendations operation.

ListRecommendations (updated) Link ¶
Changes (response)
{'Recommendations': {'Type': {'FEEDBACK_3P', 'IP_LISTING', 'BOUNCE'}}}

Lists the recommendations present in your Amazon SES account in the current Amazon Web Services Region.

You can execute this operation no more than once per second.

See also: AWS API Documentation

Request Syntax

client.list_recommendations(
    Filter={
        'string': 'string'
    },
    NextToken='string',
    PageSize=123
)
type Filter:

dict

param Filter:

Filters applied when retrieving recommendations. Can eiter be an individual filter, or combinations of STATUS and IMPACT or STATUS and TYPE

  • (string) --

    The ListRecommendations filter type. This can be one of the following:

    • TYPE – The recommendation type, with values like DKIM, SPF, DMARC, BIMI, or COMPLAINT.

    • IMPACT – The recommendation impact, with values like HIGH or LOW.

    • STATUS – The recommendation status, with values like OPEN or FIXED.

    • RESOURCE_ARN – The resource affected by the recommendation, with values like arn:aws:ses:us-east-1:123456789012:identity/example.com.

    • (string) --

type NextToken:

string

param NextToken:

A token returned from a previous call to ListRecommendations to indicate the position in the list of recommendations.

type PageSize:

integer

param PageSize:

The number of results to show in a single call to ListRecommendations. 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 1, and can be no more than 100.

rtype:

dict

returns:

Response Syntax

{
    'Recommendations': [
        {
            'ResourceArn': 'string',
            'Type': 'DKIM'|'DMARC'|'SPF'|'BIMI'|'COMPLAINT'|'BOUNCE'|'FEEDBACK_3P'|'IP_LISTING',
            'Description': 'string',
            'Status': 'OPEN'|'FIXED',
            'CreatedTimestamp': datetime(2015, 1, 1),
            'LastUpdatedTimestamp': datetime(2015, 1, 1),
            'Impact': 'LOW'|'HIGH'
        },
    ],
    'NextToken': 'string'
}

Response Structure

  • (dict) --

    Contains the response to your request to retrieve the list of recommendations for your account.

    • Recommendations (list) --

      The recommendations applicable to your account.

      • (dict) --

        A recommendation generated for your account.

        • ResourceArn (string) --

          The resource affected by the recommendation, with values like arn:aws:ses:us-east-1:123456789012:identity/example.com.

        • Type (string) --

          The recommendation type, with values like DKIM, SPF, DMARC, BIMI, or COMPLAINT.

        • Description (string) --

          The recommendation description / disambiguator - e.g. DKIM1 and DKIM2 are different recommendations about your DKIM setup.

        • Status (string) --

          The recommendation status, with values like OPEN or FIXED.

        • CreatedTimestamp (datetime) --

          The first time this issue was encountered and the recommendation was generated.

        • LastUpdatedTimestamp (datetime) --

          The last time the recommendation was updated.

        • Impact (string) --

          The recommendation impact, with values like HIGH or LOW.

    • NextToken (string) --

      A string token indicating that there might be additional recommendations available to be listed. Use the token provided in the ListRecommendationsResponse to use in the subsequent call to ListRecommendations with the same parameters to retrieve the next page of recommendations.

SendBulkEmail (updated) Link ¶
Changes (request)
{'TenantName': 'string'}

Composes an email message to multiple destinations.

See also: AWS API Documentation

Request Syntax

client.send_bulk_email(
    FromEmailAddress='string',
    FromEmailAddressIdentityArn='string',
    ReplyToAddresses=[
        'string',
    ],
    FeedbackForwardingEmailAddress='string',
    FeedbackForwardingEmailAddressIdentityArn='string',
    DefaultEmailTags=[
        {
            'Name': 'string',
            'Value': 'string'
        },
    ],
    DefaultContent={
        'Template': {
            'TemplateName': 'string',
            'TemplateArn': 'string',
            'TemplateContent': {
                'Subject': 'string',
                'Text': 'string',
                'Html': 'string'
            },
            'TemplateData': 'string',
            'Headers': [
                {
                    'Name': 'string',
                    'Value': 'string'
                },
            ],
            'Attachments': [
                {
                    'RawContent': b'bytes',
                    'ContentDisposition': 'ATTACHMENT'|'INLINE',
                    'FileName': 'string',
                    'ContentDescription': 'string',
                    'ContentId': 'string',
                    'ContentTransferEncoding': 'BASE64'|'QUOTED_PRINTABLE'|'SEVEN_BIT',
                    'ContentType': 'string'
                },
            ]
        }
    },
    BulkEmailEntries=[
        {
            'Destination': {
                'ToAddresses': [
                    'string',
                ],
                'CcAddresses': [
                    'string',
                ],
                'BccAddresses': [
                    'string',
                ]
            },
            'ReplacementTags': [
                {
                    'Name': 'string',
                    'Value': 'string'
                },
            ],
            'ReplacementEmailContent': {
                'ReplacementTemplate': {
                    'ReplacementTemplateData': 'string'
                }
            },
            'ReplacementHeaders': [
                {
                    'Name': 'string',
                    'Value': 'string'
                },
            ]
        },
    ],
    ConfigurationSetName='string',
    EndpointId='string',
    TenantName='string'
)
type FromEmailAddress:

string

param FromEmailAddress:

The email address to use as the "From" address for the email. The address that you specify has to be verified.

type FromEmailAddressIdentityArn:

string

param FromEmailAddressIdentityArn:

This parameter is used only for sending authorization. It is the ARN of the identity that is associated with the sending authorization policy that permits you to use the email address specified in the FromEmailAddress parameter.

For example, if the owner of example.com (which has ARN arn:aws:ses:us-east-1:123456789012:identity/example.com) attaches a policy to it that authorizes you to use sender@example.com, then you would specify the FromEmailAddressIdentityArn to be arn:aws:ses:us-east-1:123456789012:identity/example.com, and the FromEmailAddress to be sender@example.com.

For more information about sending authorization, see the Amazon SES Developer Guide.

type ReplyToAddresses:

list

param ReplyToAddresses:

The "Reply-to" email addresses for the message. When the recipient replies to the message, each Reply-to address receives the reply.

  • (string) --

type FeedbackForwardingEmailAddress:

string

param FeedbackForwardingEmailAddress:

The address that you want bounce and complaint notifications to be sent to.

type FeedbackForwardingEmailAddressIdentityArn:

string

param FeedbackForwardingEmailAddressIdentityArn:

This parameter is used only for sending authorization. It is the ARN of the identity that is associated with the sending authorization policy that permits you to use the email address specified in the FeedbackForwardingEmailAddress parameter.

For example, if the owner of example.com (which has ARN arn:aws:ses:us-east-1:123456789012:identity/example.com) attaches a policy to it that authorizes you to use feedback@example.com, then you would specify the FeedbackForwardingEmailAddressIdentityArn to be arn:aws:ses:us-east-1:123456789012:identity/example.com, and the FeedbackForwardingEmailAddress to be feedback@example.com.

For more information about sending authorization, see the Amazon SES Developer Guide.

type DefaultEmailTags:

list

param DefaultEmailTags:

A list of tags, in the form of name/value pairs, to apply to an email that you send using the SendEmail operation. Tags correspond to characteristics of the email that you define, so that you can publish email sending events.

  • (dict) --

    Contains the name and value of a tag that you apply to an email. You can use message tags when you publish email sending events.

    • Name (string) -- [REQUIRED]

      The name of the message tag. The message tag name has to meet the following criteria:

      • It can only contain ASCII letters (a–z, A–Z), numbers (0–9), underscores (_), or dashes (-).

      • It can contain no more than 256 characters.

    • Value (string) -- [REQUIRED]

      The value of the message tag. The message tag value has to meet the following criteria:

      • It can only contain ASCII letters (a–z, A–Z), numbers (0–9), underscores (_), or dashes (-).

      • It can contain no more than 256 characters.

type DefaultContent:

dict

param DefaultContent:

[REQUIRED]

An object that contains the body of the message. You can specify a template message.

  • Template (dict) --

    The template to use for the bulk email message.

    • TemplateName (string) --

      The name of the template. You will refer to this name when you send email using the SendEmail or SendBulkEmail operations.

    • TemplateArn (string) --

      The Amazon Resource Name (ARN) of the template.

    • TemplateContent (dict) --

      The content of the template.

      • Subject (string) --

        The subject line of the email.

      • Text (string) --

        The email body that will be visible to recipients whose email clients do not display HTML.

      • Html (string) --

        The HTML body of the email.

    • TemplateData (string) --

      An object that defines the values to use for message variables in the template. This object is a set of key-value pairs. Each key defines a message variable in the template. The corresponding value defines the value to use for that variable.

    • Headers (list) --

      The list of message headers that will be added to the email message.

      • (dict) --

        Contains the name and value of a message header that you add to an email.

        • Name (string) -- [REQUIRED]

          The name of the message header. The message header name has to meet the following criteria:

          • Can contain any printable ASCII character (33 - 126) except for colon (:).

          • Can contain no more than 126 characters.

        • Value (string) -- [REQUIRED]

          The value of the message header. The message header value has to meet the following criteria:

          • Can contain any printable ASCII character.

          • Can contain no more than 870 characters.

    • Attachments (list) --

      The List of attachments to include in your email. All recipients will receive the same attachments.

      • (dict) --

        Contains metadata and attachment raw content.

        • RawContent (bytes) -- [REQUIRED]

          The raw data of the attachment. It needs to be base64-encoded if you are accessing Amazon SES directly through the HTTPS interface. If you are accessing Amazon SES using an Amazon Web Services SDK, the SDK takes care of the base 64-encoding for you.

        • ContentDisposition (string) --

          A standard descriptor indicating how the attachment should be rendered in the email. Supported values: ATTACHMENT or INLINE.

        • FileName (string) -- [REQUIRED]

          The file name for the attachment as it will appear in the email. Amazon SES restricts certain file extensions. To ensure attachments are accepted, check the Unsupported attachment types in the Amazon SES Developer Guide.

        • ContentDescription (string) --

          A brief description of the attachment content.

        • ContentId (string) --

          Unique identifier for the attachment, used for referencing attachments with INLINE disposition in HTML content.

        • ContentTransferEncoding (string) --

          Specifies how the attachment is encoded. Supported values: BASE64, QUOTED_PRINTABLE, SEVEN_BIT.

        • ContentType (string) --

          The MIME type of the attachment.

type BulkEmailEntries:

list

param BulkEmailEntries:

[REQUIRED]

The list of bulk email entry objects.

  • (dict) --

    • Destination (dict) -- [REQUIRED]

      Represents the destination of the message, consisting of To:, CC:, and BCC: fields.

      • ToAddresses (list) --

        An array that contains the email addresses of the "To" recipients for the email.

        • (string) --

      • CcAddresses (list) --

        An array that contains the email addresses of the "CC" (carbon copy) recipients for the email.

        • (string) --

      • BccAddresses (list) --

        An array that contains the email addresses of the "BCC" (blind carbon copy) recipients for the email.

        • (string) --

    • ReplacementTags (list) --

      A list of tags, in the form of name/value pairs, to apply to an email that you send using the SendBulkTemplatedEmail operation. Tags correspond to characteristics of the email that you define, so that you can publish email sending events.

      • (dict) --

        Contains the name and value of a tag that you apply to an email. You can use message tags when you publish email sending events.

        • Name (string) -- [REQUIRED]

          The name of the message tag. The message tag name has to meet the following criteria:

          • It can only contain ASCII letters (a–z, A–Z), numbers (0–9), underscores (_), or dashes (-).

          • It can contain no more than 256 characters.

        • Value (string) -- [REQUIRED]

          The value of the message tag. The message tag value has to meet the following criteria:

          • It can only contain ASCII letters (a–z, A–Z), numbers (0–9), underscores (_), or dashes (-).

          • It can contain no more than 256 characters.

    • ReplacementEmailContent (dict) --

      The ReplacementEmailContent associated with a BulkEmailEntry.

      • ReplacementTemplate (dict) --

        The ReplacementTemplate associated with ReplacementEmailContent.

        • ReplacementTemplateData (string) --

          A list of replacement values to apply to the template. This parameter is a JSON object, typically consisting of key-value pairs in which the keys correspond to replacement tags in the email template.

    • ReplacementHeaders (list) --

      The list of message headers associated with the BulkEmailEntry data type.

      • Headers Not Present in BulkEmailEntry: If a header is specified in Template but not in BulkEmailEntry, the header from Template will be added to the outgoing email.

      • Headers Present in BulkEmailEntry: If a header is specified in BulkEmailEntry, it takes precedence over any header of the same name specified in Template:

        • If the header is also defined within Template, the value from BulkEmailEntry will replace the header's value in the email.

        • If the header is not defined within Template, it will simply be added to the email as specified in BulkEmailEntry.

      • (dict) --

        Contains the name and value of a message header that you add to an email.

        • Name (string) -- [REQUIRED]

          The name of the message header. The message header name has to meet the following criteria:

          • Can contain any printable ASCII character (33 - 126) except for colon (:).

          • Can contain no more than 126 characters.

        • Value (string) -- [REQUIRED]

          The value of the message header. The message header value has to meet the following criteria:

          • Can contain any printable ASCII character.

          • Can contain no more than 870 characters.

type ConfigurationSetName:

string

param ConfigurationSetName:

The name of the configuration set to use when sending the email.

type EndpointId:

string

param EndpointId:

The ID of the multi-region endpoint (global-endpoint).

type TenantName:

string

param TenantName:

The name of the tenant through which this bulk email will be sent.

rtype:

dict

returns:

Response Syntax

{
    'BulkEmailEntryResults': [
        {
            'Status': 'SUCCESS'|'MESSAGE_REJECTED'|'MAIL_FROM_DOMAIN_NOT_VERIFIED'|'CONFIGURATION_SET_NOT_FOUND'|'TEMPLATE_NOT_FOUND'|'ACCOUNT_SUSPENDED'|'ACCOUNT_THROTTLED'|'ACCOUNT_DAILY_QUOTA_EXCEEDED'|'INVALID_SENDING_POOL_NAME'|'ACCOUNT_SENDING_PAUSED'|'CONFIGURATION_SET_SENDING_PAUSED'|'INVALID_PARAMETER'|'TRANSIENT_FAILURE'|'FAILED',
            'Error': 'string',
            'MessageId': 'string'
        },
    ]
}

Response Structure

  • (dict) --

    The following data is returned in JSON format by the service.

    • BulkEmailEntryResults (list) --

      One object per intended recipient. Check each response object and retry any messages with a failure status.

      • (dict) --

        The result of the SendBulkEmail operation of each specified BulkEmailEntry.

        • Status (string) --

          The status of a message sent using the SendBulkTemplatedEmail operation.

          Possible values for this parameter include:

          • SUCCESS: Amazon SES accepted the message, and will attempt to deliver it to the recipients.

          • MESSAGE_REJECTED: The message was rejected because it contained a virus.

          • MAIL_FROM_DOMAIN_NOT_VERIFIED: The sender's email address or domain was not verified.

          • CONFIGURATION_SET_DOES_NOT_EXIST: The configuration set you specified does not exist.

          • TEMPLATE_DOES_NOT_EXIST: The template you specified does not exist.

          • ACCOUNT_SUSPENDED: Your account has been shut down because of issues related to your email sending practices.

          • ACCOUNT_THROTTLED: The number of emails you can send has been reduced because your account has exceeded its allocated sending limit.

          • ACCOUNT_DAILY_QUOTA_EXCEEDED: You have reached or exceeded the maximum number of emails you can send from your account in a 24-hour period.

          • INVALID_SENDING_POOL_NAME: The configuration set you specified refers to an IP pool that does not exist.

          • ACCOUNT_SENDING_PAUSED: Email sending for the Amazon SES account was disabled using the UpdateAccountSendingEnabled operation.

          • CONFIGURATION_SET_SENDING_PAUSED: Email sending for this configuration set was disabled using the UpdateConfigurationSetSendingEnabled operation.

          • INVALID_PARAMETER_VALUE: One or more of the parameters you specified when calling this operation was invalid. See the error message for additional information.

          • TRANSIENT_FAILURE: Amazon SES was unable to process your request because of a temporary issue.

          • FAILED: Amazon SES was unable to process your request. See the error message for additional information.

        • Error (string) --

          A description of an error that prevented a message being sent using the SendBulkTemplatedEmail operation.

        • MessageId (string) --

          The unique message identifier returned from the SendBulkTemplatedEmail operation.

SendEmail (updated) Link ¶
Changes (request)
{'TenantName': 'string'}

Sends an email message. You can use the Amazon SES API v2 to send the following types of messages:

  • Simple – A standard email message. When you create this type of message, you specify the sender, the recipient, and the message body, and Amazon SES assembles the message for you.

  • Raw – A raw, MIME-formatted email message. When you send this type of email, you have to specify all of the message headers, as well as the message body. You can use this message type to send messages that contain attachments. The message that you specify has to be a valid MIME message.

  • Templated – A message that contains personalization tags. When you send this type of email, Amazon SES API v2 automatically replaces the tags with values that you specify.

See also: AWS API Documentation

Request Syntax

client.send_email(
    FromEmailAddress='string',
    FromEmailAddressIdentityArn='string',
    Destination={
        'ToAddresses': [
            'string',
        ],
        'CcAddresses': [
            'string',
        ],
        'BccAddresses': [
            'string',
        ]
    },
    ReplyToAddresses=[
        'string',
    ],
    FeedbackForwardingEmailAddress='string',
    FeedbackForwardingEmailAddressIdentityArn='string',
    Content={
        'Simple': {
            'Subject': {
                'Data': 'string',
                'Charset': 'string'
            },
            'Body': {
                'Text': {
                    'Data': 'string',
                    'Charset': 'string'
                },
                'Html': {
                    'Data': 'string',
                    'Charset': 'string'
                }
            },
            'Headers': [
                {
                    'Name': 'string',
                    'Value': 'string'
                },
            ],
            'Attachments': [
                {
                    'RawContent': b'bytes',
                    'ContentDisposition': 'ATTACHMENT'|'INLINE',
                    'FileName': 'string',
                    'ContentDescription': 'string',
                    'ContentId': 'string',
                    'ContentTransferEncoding': 'BASE64'|'QUOTED_PRINTABLE'|'SEVEN_BIT',
                    'ContentType': 'string'
                },
            ]
        },
        'Raw': {
            'Data': b'bytes'
        },
        'Template': {
            'TemplateName': 'string',
            'TemplateArn': 'string',
            'TemplateContent': {
                'Subject': 'string',
                'Text': 'string',
                'Html': 'string'
            },
            'TemplateData': 'string',
            'Headers': [
                {
                    'Name': 'string',
                    'Value': 'string'
                },
            ],
            'Attachments': [
                {
                    'RawContent': b'bytes',
                    'ContentDisposition': 'ATTACHMENT'|'INLINE',
                    'FileName': 'string',
                    'ContentDescription': 'string',
                    'ContentId': 'string',
                    'ContentTransferEncoding': 'BASE64'|'QUOTED_PRINTABLE'|'SEVEN_BIT',
                    'ContentType': 'string'
                },
            ]
        }
    },
    EmailTags=[
        {
            'Name': 'string',
            'Value': 'string'
        },
    ],
    ConfigurationSetName='string',
    EndpointId='string',
    TenantName='string',
    ListManagementOptions={
        'ContactListName': 'string',
        'TopicName': 'string'
    }
)
type FromEmailAddress:

string

param FromEmailAddress:

The email address to use as the "From" address for the email. The address that you specify has to be verified.

type FromEmailAddressIdentityArn:

string

param FromEmailAddressIdentityArn:

This parameter is used only for sending authorization. It is the ARN of the identity that is associated with the sending authorization policy that permits you to use the email address specified in the FromEmailAddress parameter.

For example, if the owner of example.com (which has ARN arn:aws:ses:us-east-1:123456789012:identity/example.com) attaches a policy to it that authorizes you to use sender@example.com, then you would specify the FromEmailAddressIdentityArn to be arn:aws:ses:us-east-1:123456789012:identity/example.com, and the FromEmailAddress to be sender@example.com.

For more information about sending authorization, see the Amazon SES Developer Guide.

For Raw emails, the FromEmailAddressIdentityArn value overrides the X-SES-SOURCE-ARN and X-SES-FROM-ARN headers specified in raw email message content.

type Destination:

dict

param Destination:

An object that contains the recipients of the email message.

  • ToAddresses (list) --

    An array that contains the email addresses of the "To" recipients for the email.

    • (string) --

  • CcAddresses (list) --

    An array that contains the email addresses of the "CC" (carbon copy) recipients for the email.

    • (string) --

  • BccAddresses (list) --

    An array that contains the email addresses of the "BCC" (blind carbon copy) recipients for the email.

    • (string) --

type ReplyToAddresses:

list

param ReplyToAddresses:

The "Reply-to" email addresses for the message. When the recipient replies to the message, each Reply-to address receives the reply.

  • (string) --

type FeedbackForwardingEmailAddress:

string

param FeedbackForwardingEmailAddress:

The address that you want bounce and complaint notifications to be sent to.

type FeedbackForwardingEmailAddressIdentityArn:

string

param FeedbackForwardingEmailAddressIdentityArn:

This parameter is used only for sending authorization. It is the ARN of the identity that is associated with the sending authorization policy that permits you to use the email address specified in the FeedbackForwardingEmailAddress parameter.

For example, if the owner of example.com (which has ARN arn:aws:ses:us-east-1:123456789012:identity/example.com) attaches a policy to it that authorizes you to use feedback@example.com, then you would specify the FeedbackForwardingEmailAddressIdentityArn to be arn:aws:ses:us-east-1:123456789012:identity/example.com, and the FeedbackForwardingEmailAddress to be feedback@example.com.

For more information about sending authorization, see the Amazon SES Developer Guide.

type Content:

dict

param Content:

[REQUIRED]

An object that contains the body of the message. You can send either a Simple message, Raw message, or a Templated message.

  • Simple (dict) --

    The simple email message. The message consists of a subject, message body and attachments list.

    • Subject (dict) -- [REQUIRED]

      The subject line of the email. The subject line can only contain 7-bit ASCII characters. However, you can specify non-ASCII characters in the subject line by using encoded-word syntax, as described in RFC 2047.

      • Data (string) -- [REQUIRED]

        The content of the message itself.

      • Charset (string) --

        The character set for the content. Because of the constraints of the SMTP protocol, Amazon SES uses 7-bit ASCII by default. If the text includes characters outside of the ASCII range, you have to specify a character set. For example, you could specify UTF-8, ISO-8859-1, or Shift_JIS.

    • Body (dict) -- [REQUIRED]

      The body of the message. You can specify an HTML version of the message, a text-only version of the message, or both.

      • Text (dict) --

        An object that represents the version of the message that is displayed in email clients that don't support HTML, or clients where the recipient has disabled HTML rendering.

        • Data (string) -- [REQUIRED]

          The content of the message itself.

        • Charset (string) --

          The character set for the content. Because of the constraints of the SMTP protocol, Amazon SES uses 7-bit ASCII by default. If the text includes characters outside of the ASCII range, you have to specify a character set. For example, you could specify UTF-8, ISO-8859-1, or Shift_JIS.

      • Html (dict) --

        An object that represents the version of the message that is displayed in email clients that support HTML. HTML messages can include formatted text, hyperlinks, images, and more.

        • Data (string) -- [REQUIRED]

          The content of the message itself.

        • Charset (string) --

          The character set for the content. Because of the constraints of the SMTP protocol, Amazon SES uses 7-bit ASCII by default. If the text includes characters outside of the ASCII range, you have to specify a character set. For example, you could specify UTF-8, ISO-8859-1, or Shift_JIS.

    • Headers (list) --

      The list of message headers that will be added to the email message.

      • (dict) --

        Contains the name and value of a message header that you add to an email.

        • Name (string) -- [REQUIRED]

          The name of the message header. The message header name has to meet the following criteria:

          • Can contain any printable ASCII character (33 - 126) except for colon (:).

          • Can contain no more than 126 characters.

        • Value (string) -- [REQUIRED]

          The value of the message header. The message header value has to meet the following criteria:

          • Can contain any printable ASCII character.

          • Can contain no more than 870 characters.

    • Attachments (list) --

      The List of attachments to include in your email. All recipients will receive the same attachments.

      • (dict) --

        Contains metadata and attachment raw content.

        • RawContent (bytes) -- [REQUIRED]

          The raw data of the attachment. It needs to be base64-encoded if you are accessing Amazon SES directly through the HTTPS interface. If you are accessing Amazon SES using an Amazon Web Services SDK, the SDK takes care of the base 64-encoding for you.

        • ContentDisposition (string) --

          A standard descriptor indicating how the attachment should be rendered in the email. Supported values: ATTACHMENT or INLINE.

        • FileName (string) -- [REQUIRED]

          The file name for the attachment as it will appear in the email. Amazon SES restricts certain file extensions. To ensure attachments are accepted, check the Unsupported attachment types in the Amazon SES Developer Guide.

        • ContentDescription (string) --

          A brief description of the attachment content.

        • ContentId (string) --

          Unique identifier for the attachment, used for referencing attachments with INLINE disposition in HTML content.

        • ContentTransferEncoding (string) --

          Specifies how the attachment is encoded. Supported values: BASE64, QUOTED_PRINTABLE, SEVEN_BIT.

        • ContentType (string) --

          The MIME type of the attachment.

  • Raw (dict) --

    The raw email message. The message has to meet the following criteria:

    • The message has to contain a header and a body, separated by one blank line.

    • All of the required header fields must be present in the message.

    • Each part of a multipart MIME message must be formatted properly.

    • If you include attachments, they must be in a file format that the Amazon SES API v2 supports.

    • The raw data of the message needs to base64-encoded if you are accessing Amazon SES directly through the HTTPS interface. If you are accessing Amazon SES using an Amazon Web Services SDK, the SDK takes care of the base 64-encoding for you.

    • If any of the MIME parts in your message contain content that is outside of the 7-bit ASCII character range, you should encode that content to ensure that recipients' email clients render the message properly.

    • The length of any single line of text in the message can't exceed 1,000 characters. This restriction is defined in RFC 5321.

    • Data (bytes) -- [REQUIRED]

      The raw email message. The message has to meet the following criteria:

      • The message has to contain a header and a body, separated by one blank line.

      • All of the required header fields must be present in the message.

      • Each part of a multipart MIME message must be formatted properly.

      • Attachments must be in a file format that the Amazon SES supports.

      • The raw data of the message needs to base64-encoded if you are accessing Amazon SES directly through the HTTPS interface. If you are accessing Amazon SES using an Amazon Web Services SDK, the SDK takes care of the base 64-encoding for you.

      • If any of the MIME parts in your message contain content that is outside of the 7-bit ASCII character range, you should encode that content to ensure that recipients' email clients render the message properly.

      • The length of any single line of text in the message can't exceed 1,000 characters. This restriction is defined in RFC 5321.

  • Template (dict) --

    The template to use for the email message.

    • TemplateName (string) --

      The name of the template. You will refer to this name when you send email using the SendEmail or SendBulkEmail operations.

    • TemplateArn (string) --

      The Amazon Resource Name (ARN) of the template.

    • TemplateContent (dict) --

      The content of the template.

      • Subject (string) --

        The subject line of the email.

      • Text (string) --

        The email body that will be visible to recipients whose email clients do not display HTML.

      • Html (string) --

        The HTML body of the email.

    • TemplateData (string) --

      An object that defines the values to use for message variables in the template. This object is a set of key-value pairs. Each key defines a message variable in the template. The corresponding value defines the value to use for that variable.

    • Headers (list) --

      The list of message headers that will be added to the email message.

      • (dict) --

        Contains the name and value of a message header that you add to an email.

        • Name (string) -- [REQUIRED]

          The name of the message header. The message header name has to meet the following criteria:

          • Can contain any printable ASCII character (33 - 126) except for colon (:).

          • Can contain no more than 126 characters.

        • Value (string) -- [REQUIRED]

          The value of the message header. The message header value has to meet the following criteria:

          • Can contain any printable ASCII character.

          • Can contain no more than 870 characters.

    • Attachments (list) --

      The List of attachments to include in your email. All recipients will receive the same attachments.

      • (dict) --

        Contains metadata and attachment raw content.

        • RawContent (bytes) -- [REQUIRED]

          The raw data of the attachment. It needs to be base64-encoded if you are accessing Amazon SES directly through the HTTPS interface. If you are accessing Amazon SES using an Amazon Web Services SDK, the SDK takes care of the base 64-encoding for you.

        • ContentDisposition (string) --

          A standard descriptor indicating how the attachment should be rendered in the email. Supported values: ATTACHMENT or INLINE.

        • FileName (string) -- [REQUIRED]

          The file name for the attachment as it will appear in the email. Amazon SES restricts certain file extensions. To ensure attachments are accepted, check the Unsupported attachment types in the Amazon SES Developer Guide.

        • ContentDescription (string) --

          A brief description of the attachment content.

        • ContentId (string) --

          Unique identifier for the attachment, used for referencing attachments with INLINE disposition in HTML content.

        • ContentTransferEncoding (string) --

          Specifies how the attachment is encoded. Supported values: BASE64, QUOTED_PRINTABLE, SEVEN_BIT.

        • ContentType (string) --

          The MIME type of the attachment.

type EmailTags:

list

param EmailTags:

A list of tags, in the form of name/value pairs, to apply to an email that you send using the SendEmail operation. Tags correspond to characteristics of the email that you define, so that you can publish email sending events.

  • (dict) --

    Contains the name and value of a tag that you apply to an email. You can use message tags when you publish email sending events.

    • Name (string) -- [REQUIRED]

      The name of the message tag. The message tag name has to meet the following criteria:

      • It can only contain ASCII letters (a–z, A–Z), numbers (0–9), underscores (_), or dashes (-).

      • It can contain no more than 256 characters.

    • Value (string) -- [REQUIRED]

      The value of the message tag. The message tag value has to meet the following criteria:

      • It can only contain ASCII letters (a–z, A–Z), numbers (0–9), underscores (_), or dashes (-).

      • It can contain no more than 256 characters.

type ConfigurationSetName:

string

param ConfigurationSetName:

The name of the configuration set to use when sending the email.

type EndpointId:

string

param EndpointId:

The ID of the multi-region endpoint (global-endpoint).

type TenantName:

string

param TenantName:

The name of the tenant through which this email will be sent.

type ListManagementOptions:

dict

param ListManagementOptions:

An object used to specify a list or topic to which an email belongs, which will be used when a contact chooses to unsubscribe.

  • ContactListName (string) -- [REQUIRED]

    The name of the contact list.

  • TopicName (string) --

    The name of the topic.

rtype:

dict

returns:

Response Syntax

{
    'MessageId': 'string'
}

Response Structure

  • (dict) --

    A unique message ID that you receive when an email is accepted for sending.

    • MessageId (string) --

      A unique identifier for the message that is generated when the message is accepted.