AWS SDK for pandas Python API Docs | dltHub
Build a AWS SDK for pandas-to-database pipeline in Python using dlt with AI Workbench support for Claude Code, Cursor, and Codex.
Last updated:
AWS SDK for pandas (awswrangler) is a Python library that provides high-level helpers to read/write data between pandas and many AWS services (S3, Glue, Athena, OpenSearch, Redshift, DynamoDB, Timestream, etc.). The REST API base URL is There is no single global REST base URL for aws-sdk-pandas itself. For OpenSearch-related operations the REST endpoints are the target OpenSearch domain endpoint, e.g. https://<DOMAIN-ENDPOINT> (OpenSearch domain endpoint; operations map to paths like /_search and /_bulk). and All requests to AWS services use AWS credentials (SigV4 via boto3); aws-sdk-pandas functions accept a boto3_session or use the default AWS SDK credential resolution..
dlt is an open-source Python library that handles authentication, pagination, and schema evolution automatically. dlthub provides AI context files that enable code assistants to generate production-ready pipelines. Install with uv pip install "dlt[workspace]" and start loading AWS SDK for pandas data in under 10 minutes.
What data can I load from AWS SDK for pandas?
Here are some of the endpoints you can load from AWS SDK for pandas:
| Resource | Endpoint | Method | Data selector | Description |
|---|---|---|---|---|
| connect | (no REST path; helper) | n/a | Create a boto3/opensearch client connection to an OpenSearch domain (uses domain host). | |
| search | _search | GET/POST | hits.hits | Run OpenSearch DSL search and return pandas DataFrame; underlying REST returns hits.hits array containing documents. |
| search_by_sql | _plugins/_sql | POST | hits.hits | Execute SQL query via OpenSearch SQL plugin; results come back in hits.hits. |
| index_df | _bulk | POST | items | Bulk indexing via OpenSearch bulk API; response payload is bulk API response containing 'items' array and 'errors' flag. |
| index_documents | _bulk | POST | items | Bulk index provided documents to an index; response contains 'items' array. |
| create_index | /{index} (PUT) | PUT | Create an OpenSearch index; returns OpenSearch create-index response (acknowledgement dict). | |
| delete_index | /{index} (DELETE) | DELETE | Delete an OpenSearch index; returns OpenSearch delete response. | |
| index_csv / index_json | _bulk | POST | items | Helpers that read CSV/JSON and call bulk API; bulk response with 'items'. |
How do I authenticate with the AWS SDK for pandas API?
aws-sdk-pandas uses boto3 sessions and AWS SigV4 signing. Supply valid AWS credentials via boto3_session parameter, environment variables, AWS credentials file, or IAM role no manual Bearer header required; the library uses boto3/opensearchpy clients which sign requests automatically.
1. Get your credentials
- Open AWS Console IAM Users Create user.
- Select programmatic access and attach policies granting access to target services (e.g., AmazonOpenSearchServiceFullAccess, S3, Glue as needed).
- After creation, copy Access key ID and Secret access key.
- Configure credentials locally via AWS CLI: aws configure (enter access key, secret, default region) or set env vars AWS_ACCESS_KEY_ID and AWS_SECRET_ACCESS_KEY, or create a profile in ~/.aws/credentials.
2. Add them to .dlt/secrets.toml
[sources.aws_sdk_for_pandas_source] aws_access_key_id = "YOUR_ACCESS_KEY_ID" aws_secret_access_key = "YOUR_SECRET_ACCESS_KEY" aws_region = "us-west-2" aws_profile = "your_profile_name"
dlt reads this automatically at runtime — never hardcode tokens in your pipeline script. For production environments, see setting up credentials with dlt for environment variable and vault-based options.
How do I set up and run the pipeline?
Set up a virtual environment and install dlt:
uv venv && source .venv/bin/activate uv pip install "dlt[workspace]"
1. Install the dlt AI Workbench:
dlt ai init --agent <your-agent> # <agent>: claude | cursor | codex
This installs project rules, a secrets management skill, appropriate ignore files, and configures the dlt MCP server for your agent. Learn more →
2. Install the rest-api-pipeline toolkit:
dlt ai toolkit rest-api-pipeline install
This loads the skills and context about dlt the agent uses to build the pipeline iteratively, efficiently, and safely. The agent uses MCP tools to inspect credentials — it never needs to read your secrets.toml directly. Learn more →
3. Start LLM-assisted coding:
Use /find-source to load data from the AWS SDK for pandas API into DuckDB.
The rest-api-pipeline toolkit takes over from here — it reads relevant API documentation, presents you with options for which endpoints to load, and follows a structured workflow to scaffold, debug, and validate the pipeline step by step.
4. Run the pipeline:
python aws_sdk_for_pandas_pipeline.py
If everything is configured correctly, you'll see output like this:
Pipeline aws_sdk_for_pandas_pipeline load step completed in 0.26 seconds 1 load package(s) were loaded to destination duckdb and into dataset aws_sdk_for_pandas_data The duckdb destination used duckdb:/aws_sdk_for_pandas.duckdb location to store data Load package 1749667187.541553 is LOADED and contains no failed jobs
Inspect your pipeline and data:
dlt pipeline aws_sdk_for_pandas_pipeline show
This opens the Pipeline Dashboard where you can verify pipeline state, load metrics, schema (tables, columns, types), and query the loaded data directly.
Python pipeline example
This example loads search and index_df from the AWS SDK for pandas API into DuckDB. It mirrors the endpoint and data selector configuration from the table above:
import dlt from dlt.sources.rest_api import RESTAPIConfig, rest_api_resources @dlt.source def aws_sdk_for_pandas_source(boto3_session=dlt.secrets.value): config: RESTAPIConfig = { "client": { "base_url": "There is no single global REST base URL for aws-sdk-pandas itself. For OpenSearch-related operations the REST endpoints are the target OpenSearch domain endpoint, e.g. https://<DOMAIN-ENDPOINT> (OpenSearch domain endpoint; operations map to paths like /_search and /_bulk).", "auth": { "type": "aws_sigv4", "aws_access_key_id": boto3_session, }, }, "resources": [ {"name": "search", "endpoint": {"path": "_search", "data_selector": "hits.hits"}}, {"name": "index_df", "endpoint": {"path": "_bulk", "data_selector": "items"}} ], } yield from rest_api_resources(config) def get_data() -> None: pipeline = dlt.pipeline( pipeline_name="aws_sdk_for_pandas_pipeline", destination="duckdb", dataset_name="aws_sdk_for_pandas_data", ) load_info = pipeline.run(aws_sdk_for_pandas_source()) print(load_info)
To add more endpoints, append entries from the resource table to the "resources" list using the same name, path, and data_selector pattern.
How do I query the loaded data?
Once the pipeline runs, dlt creates one table per resource. You can query with Python or SQL.
Python (pandas DataFrame):
import dlt data = dlt.pipeline("aws_sdk_for_pandas_pipeline").dataset() sessions_df = data.search.df() print(sessions_df.head())
SQL (DuckDB example):
SELECT * FROM aws_sdk_for_pandas_data.search LIMIT 10;
In a marimo or Jupyter notebook:
import dlt data = dlt.pipeline("aws_sdk_for_pandas_pipeline").dataset() data.search.df().head()
See how to explore your data in marimo Notebooks and how to query your data in Python with dataset.
What destinations can I load AWS SDK for pandas data to?
dlt supports loading into any of these destinations — only the destination parameter changes:
| Destination | Example value |
|---|---|
| DuckDB (local, default) | "duckdb" |
| PostgreSQL | "postgres" |
| BigQuery | "bigquery" |
| Snowflake | "snowflake" |
| Redshift | "redshift" |
| Databricks | "databricks" |
| Filesystem (S3, GCS, Azure) | "filesystem" |
Change the destination in dlt.pipeline(destination="snowflake") and add credentials in .dlt/secrets.toml. See the full destinations list.
Troubleshooting
Authentication failures
If boto3 cannot find credentials, awswrangler/opensearch.connect will fail. Verify AWS_ACCESS_KEY_ID and AWS_SECRET_ACCESS_KEY, aws_region or configured profile; run aws sts get-caller-identity to confirm active credentials. Ensure the IAM user/role has required OpenSearch permissions.
Bulk indexing errors
Bulk responses include an 'errors' boolean and an 'items' array with per-item statuses. Inspect response['items'] to find failed items and their error.reason; retry failed items after correcting mapping/type issues.
Rate limits and throttling
OpenSearch may return 429 Too Many Requests for heavy_bulk loads. Backoff and retry; reduce concurrency (use_threads param in index_df) or batch size to mitigate throttling.
Ensure that the API key is valid to avoid 401 Unauthorized errors. Also, verify endpoint paths and parameters to avoid 404 Not Found errors.
Next steps
Continue your data engineering journey with the other toolkits of the dltHub AI Workbench:
data-exploration— Build custom notebooks, charts, and dashboards for deeper analysis with marimo notebooks.dlthub-runtime— Deploy, schedule, and monitor your pipeline in production.
dlt ai toolkit data-exploration install dlt ai toolkit dlthub-runtime install
Was this page helpful?
Community Hub
Need more dlt context for AWS SDK for pandas?
Request dlt skills, commands, AGENT.md files, and AI-native context.