Sign in

v1

latestOpenAPI 3.0.0Apache 2.0 License2026-07-141891,2951.1 MB

Creates an Amazon DataZone data source.

post/v2/domains/{domainIdentifier}/data-sources

Path parameters

domainIdentifierstring required

The ID of the Amazon DataZone domain where the data source is created.

Request body

namestring password required

The name of the data source.

descriptionstring password

The description of the data source.

projectIdentifierstring required

The identifier of the Amazon DataZone project in which you want to add this data source.

environmentIdentifierstring

The unique identifier of the Amazon DataZone environment to which the data source publishes assets.

connectionIdentifierstring

The ID of the connection.

typestring required

The type of the data source. In Amazon DataZone, you can use data sources to import technical metadata of assets (data) from the source databases or data warehouses into Amazon DataZone. In the current release of Amazon DataZone, you can create and run data sources for Amazon Web Services Glue and Amazon Redshift.

enableSetting'ENABLED' | 'DISABLED'

Specifies whether the data source is enabled.

publishOnImportboolean

Specifies whether the assets that this data source creates in the inventory are to be also automatically published to the catalog.

clientTokenstring

A unique, case-sensitive identifier that is provided to ensure the idempotency of the request.

Response

Success

idstring required

The unique identifier of the data source.

status'CREATING' | 'FAILED_CREATION' | 'READY' | 'UPDATING' | 'FAILED_UPDATE' | 'RUNNING' | 'DELETING' | 'FAILED_DELETION'

The status of the data source.

typestring

The type of the data source.

namestring password required

The name of the data source.

descriptionstring password

The description of the data source.

domainIdstring required

The ID of the Amazon DataZone domain in which the data source is created.

projectIdstring required

The ID of the Amazon DataZone project to which the data source is added.

environmentIdstring

The unique identifier of the Amazon DataZone environment to which the data source publishes assets.

connectionIdstring

The ID of the connection.

enableSetting'ENABLED' | 'DISABLED'

Specifies whether the data source is enabled.

publishOnImportboolean

Specifies whether the assets that this data source creates in the inventory are to be also automatically published to the catalog.

lastRunStatus'REQUESTED' | 'RUNNING' | 'FAILED' | 'PARTIALLY_SUCCEEDED' | 'SUCCESS'

The status of the last run of this data source.

lastRunAtstring date-time

The timestamp that specifies when the data source was last run.

createdAtstring date-time

The timestamp of when the data source was created.

updatedAtstring date-time

The timestamp of when the data source was updated.