export_dataset_to_s3

DatasetsApi.export_dataset_to_s3(id, role_id, _request_timeout=None, _request_auth=None, _content_type=None, _headers=None, _host_index=0)

Export DynamoDB dataset to S3

Triggers asynchronous DynamoDB PITR export to S3 via Step Functions. API path supports DynamoDB datasets only (Iceberg/s3athena exports are schedule-driven). No request body. Caller needs datasets.manage role permission; code does not enforce an additional owner-only check. Email notification is sent when export completes.

Parameters:

  • id (str) – Dataset ID (DynamoDB target) to export. (required)

  • role_id (str) – Amorphic role ID with datasets.manage permission. (required)

  • _request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

  • _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

  • _content_type (str, Optional) – force content-type for the request.

  • _headers (dict, optional) – set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.

  • _host_index (int, optional) – set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.

Return type:

ExportDatasetToS3Response

Returns:

Returns the result object.

Request and Response Examples

HTTP: PUT /datasets/{id}/export-to-s3

Success (HTTP 200)

Export triggered asynchronously; email follows on completion.

Request / response example

{
  "Message": "Export to s3 triggered, Once completed, you will receive an email notification with more info!"
}

Errors

Documented error codes: DS-1001, DS-1002, DS-1040, DB-1007.

HTTP 400

Validation failure. Codes include DS-1001 (missing), DS-1002 (inactive), DS-1040 (wrong target / Iceberg via API), DB-1007 (PITR enable fail).

Unsupported target

{
  "Message": "DS-1040 - Export to S3 is not supported for this dataset target"
}

HTTP 500

Backend/generic failure.