Request Syntax URI Request Parameters Request Body Response Syntax Response Elements Errors See Also

CreateDataSource

Creates an Amazon DataZone data source.

Request Syntax


POST /v2/domains/domainIdentifier/data-sources HTTP/1.1
Content-type: application/json

{
   "assetFormsInput": [ 
      { 
         "content": "string",
         "formName": "string",
         "typeIdentifier": "string",
         "typeRevision": "string"
      }
   ],
   "clientToken": "string",
   "configuration": { ... },
   "connectionIdentifier": "string",
   "description": "string",
   "enableSetting": "string",
   "environmentIdentifier": "string",
   "name": "string",
   "projectIdentifier": "string",
   "publishOnImport": boolean,
   "recommendation": { 
      "enableBusinessNameGeneration": boolean
   },
   "schedule": { 
      "schedule": "string",
      "timezone": "string"
   },
   "type": "string"
}

URI Request Parameters

The request uses the following URI parameters.

domainIdentifier

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

Pattern: ^dzd[-_][a-zA-Z0-9_-]{1,36}$

Required: Yes

Request Body

The request accepts the following data in JSON format.

assetFormsInput

The metadata forms that are to be attached to the assets that this data source works with.

Type: Array of FormInput objects

Array Members: Minimum number of 0 items. Maximum number of 10 items.

Required: No

clientToken

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

Type: String

Required: No

configuration

Specifies the configuration of the data source. It can be set to either glueRunConfiguration or redshiftRunConfiguration.

Type: DataSourceConfigurationInput object

Note: This object is a Union. Only one member of this object can be specified or returned.

Required: No

connectionIdentifier

The ID of the connection.

Type: String

Pattern: ^[a-zA-Z0-9_-]{1,36}$

Required: No

description

The description of the data source.

Type: String

Length Constraints: Minimum length of 0. Maximum length of 2048.

Required: No

enableSetting

Specifies whether the data source is enabled.

Type: String

Valid Values: ENABLED | DISABLED

Required: No

environmentIdentifier

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

Type: String

Pattern: ^[a-zA-Z0-9_-]{1,36}$

Required: No

name

The name of the data source.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 256.

Required: Yes

projectIdentifier

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

Type: String

Pattern: ^[a-zA-Z0-9_-]{1,36}$

Required: Yes

publishOnImport

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

Type: Boolean

Required: No

recommendation

Specifies whether the business name generation is to be enabled for this data source.

Type: RecommendationConfiguration object

Required: No

schedule

The schedule of the data source runs.

Type: ScheduleConfiguration object

Required: No

type

The type of the data source.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 256.

Required: Yes

Response Syntax


HTTP/1.1 201
Content-type: application/json

{
   "assetFormsOutput": [ 
      { 
         "content": "string",
         "formName": "string",
         "typeName": "string",
         "typeRevision": "string"
      }
   ],
   "configuration": { ... },
   "connectionId": "string",
   "createdAt": "string",
   "description": "string",
   "domainId": "string",
   "enableSetting": "string",
   "environmentId": "string",
   "errorMessage": { 
      "errorDetail": "string",
      "errorType": "string"
   },
   "id": "string",
   "lastRunAt": "string",
   "lastRunErrorMessage": { 
      "errorDetail": "string",
      "errorType": "string"
   },
   "lastRunStatus": "string",
   "name": "string",
   "projectId": "string",
   "publishOnImport": boolean,
   "recommendation": { 
      "enableBusinessNameGeneration": boolean
   },
   "schedule": { 
      "schedule": "string",
      "timezone": "string"
   },
   "status": "string",
   "type": "string",
   "updatedAt": "string"
}

Response Elements

If the action is successful, the service sends back an HTTP 201 response.

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

assetFormsOutput

The metadata forms attached to the assets that this data source creates.

Type: Array of FormOutput objects

Array Members: Minimum number of 0 items. Maximum number of 10 items.

configuration

Specifies the configuration of the data source. It can be set to either glueRunConfiguration or redshiftRunConfiguration.

Type: DataSourceConfigurationOutput object

Note: This object is a Union. Only one member of this object can be specified or returned.

connectionId

The ID of the connection.

Type: String

createdAt

The timestamp of when the data source was created.

Type: Timestamp

description

The description of the data source.

Type: String

Length Constraints: Minimum length of 0. Maximum length of 2048.

domainId

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

Type: String

Pattern: ^dzd[-_][a-zA-Z0-9_-]{1,36}$

enableSetting

Specifies whether the data source is enabled.

Type: String

Valid Values: ENABLED | DISABLED

environmentId

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

Type: String

Pattern: ^[a-zA-Z0-9_-]{1,36}$

errorMessage

Specifies the error message that is returned if the operation cannot be successfully completed.

Type: DataSourceErrorMessage object

id

The unique identifier of the data source.

Type: String

Pattern: ^[a-zA-Z0-9_-]{1,36}$

lastRunAt

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

Type: Timestamp

lastRunErrorMessage

Specifies the error message that is returned if the operation cannot be successfully completed.

Type: DataSourceErrorMessage object

lastRunStatus

The status of the last run of this data source.

Type: String

Valid Values: REQUESTED | RUNNING | FAILED | PARTIALLY_SUCCEEDED | SUCCESS

name

The name of the data source.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 256.

projectId

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

Type: String

Pattern: ^[a-zA-Z0-9_-]{1,36}$

publishOnImport

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

Type: Boolean

recommendation

Specifies whether the business name generation is to be enabled for this data source.

Type: RecommendationConfiguration object

schedule

The schedule of the data source runs.

Type: ScheduleConfiguration object

status

The status of the data source.

Type: String

type

The type of the data source.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 256.

updatedAt

The timestamp of when the data source was updated.

Type: Timestamp

Errors

For information about the errors that are common to all actions, see Common Errors.

AccessDeniedException

You do not have sufficient access to perform this action.

HTTP Status Code: 403

ConflictException

There is a conflict while performing this action.

HTTP Status Code: 409

InternalServerException

The request has failed because of an unknown error, exception or failure.

HTTP Status Code: 500

ResourceNotFoundException

The specified resource cannot be found.

HTTP Status Code: 404

ServiceQuotaExceededException

The request has exceeded the specified service quota.

HTTP Status Code: 402

ThrottlingException

The request was denied due to request throttling.

HTTP Status Code: 429

UnauthorizedException

You do not have permission to perform this action.

HTTP Status Code: 401

ValidationException

The input fails to satisfy the constraints specified by the AWS service.

HTTP Status Code: 400