Docs
Connectors

Amazon SES connector

Transactional email sending, verified identities, events, and deliverability.

View Markdown

Use this as an implementation starting point: adapt the worked example to the requested dataset and the source documentation. See Custom API for the shared SDK pattern and document-upload workflow.

What this connector is for

Transactional email sending, verified identities, events, and deliverability.

Use this guide to choose the resources and row meanings for a Vortexify source integration. Connection ownership belongs to a connector; each dataset gets its own sync, configuration, and extraction behavior.

Data and tables you can pull

The following table families are a starting point for source selection. They describe possible datasets to implement using the vendor reference, not a guarantee that the example implements every table. Actual availability depends on the product edition, deployment, account permissions, and API/schema version.

Suggested tableOne row represents
email_identitiesa email identity
configuration_setsa configuration set
contact_listsa contact list
suppressed_destinationsa suppressed destination
message_insightsa message insight

Relationships and extraction considerations

These are proposed dataset names, not a universal schema guaranteed by the vendor. Preserve source object IDs and relationship references, and split nested child collections into separate tables when appropriate. Choose the concrete endpoint/report and row meaning from the vendor reference before implementing a sync.

Connecting to Amazon SES

Set service_name to sesv2 and choose a region. IAM permissions must cover the selected read operation. This is a configuration/reporting source, not an inbox archive or a message-sending example.

The example's config keys show the connection fields it uses. Store credentials in platform configuration marked as secret; host/project/database identifiers are ordinary connection settings. Environment and network access must match the selected source.

requirements.in

Declare these packages in the resource's requirements.in. Use the published vortexify package for the SDK and the source-specific driver/client shown below. Choose compatible dependency versions for your runtime; the connector and sync reference explains where each file belongs.

vortexify==0.1.1
pandas>=2,<3
boto3

Set service_name to sesv2 and choose a region. IAM permissions must cover the selected read operation. This is a configuration/reporting source, not an inbox archive or a message-sending example.

Worked example: email identity pages

This source-read pattern shows how to shape the selected resource into DataFrames. Use it inside the dataset sync, retaining shared connection ownership in the connector. Its scope is the named resource and filters; adapt the projection, batching, and preview to the requested table.

Connection factory

Use this client in the owning connector's client() method and release it in close().

import boto3


def make_client(config: dict):
    return boto3.client(
        config["service_name"],
        region_name=config["region"],
        aws_access_key_id=config.get("access_key_id"),
        aws_secret_access_key=config.get("secret_access_key"),
        aws_session_token=config.get("session_token"),
    )

Source read

import pandas as pd


def read_batches(client):
    params = {"PageSize": 100}
    seen = set()
    while True:
        page = client.list_email_identities(**params)
        if page.get("EmailIdentities"):
            yield pd.DataFrame(page["EmailIdentities"])
        token = page.get("NextToken")
        if not token:
            break
        if token in seen:
            raise ValueError("SES repeated its continuation token")
        seen.add(token)
        params["NextToken"] = token

What to adapt

Use service_name=sesv2 in the selected region. These are sending-identity configuration rows, not historical email messages. SES sending events need a separately configured event destination. Preview uses list_email_identities(PageSize=100) on a fresh client.

Use the custom API SDK starting point to connect the read operation to Connector and Sync. For a source with its own driver, retain that client in Connector.client() and replace the HTTP request with the driver read. An extract(*, avg_row_size_bytes=None) implementation yields bounded DataFrames. An independent preview() uses a fresh connector and a small read; it must not call extraction or advance real state.

Choose explicit output columns and stable IDs for the requested table. The examples use json_normalize where useful to illustrate row shaping; nested arrays still need deliberate child tables and a stable declared output schema. A first-page sample is useful for development, while a full sync must follow all relevant continuation/parent-resource paths. Design incremental watermarks, update/deletion behavior, and rate-limit handling for the actual source before enabling incremental mode.

The purpose is to give a coding agent a concrete pattern to adapt, including for similar sources. These snippets are examples rather than a claim of complete vendor coverage. Check the source operation reference and representative responses before running with a customer's account; live vendor execution has not been verified here.

Sources and further reading