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

GetDataSource

Gets an Amazon DataZone data source.

Request Syntax


GET /v2/domains/domainIdentifier/data-sources/identifier HTTP/1.1

URI Request Parameters

The request uses the following URI parameters.

domainIdentifier

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

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

Required: Yes

identifier

The ID of the Amazon DataZone data source.

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

Required: Yes

Request Body

The request does not have a request body.

Response Syntax


HTTP/1.1 200
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",
   "lastRunAssetCount": number,
   "lastRunAt": "string",
   "lastRunErrorMessage": { 
      "errorDetail": "string",
      "errorType": "string"
   },
   "lastRunStatus": "string",
   "name": "string",
   "projectId": "string",
   "publishOnImport": boolean,
   "recommendation": { 
      "enableBusinessNameGeneration": boolean
   },
   "schedule": { 
      "schedule": "string",
      "timezone": "string"
   },
   "selfGrantStatus": { ... },
   "status": "string",
   "type": "string",
   "updatedAt": "string"
}

Response Elements

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

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

assetFormsOutput

The metadata forms attached to the assets created by this data source.

Type: Array of FormOutput objects

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

configuration

The configuration of the data source.

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 exists.

Type: String

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

enableSetting

Specifies whether this data source is enabled or not.

Type: String

Valid Values: ENABLED | DISABLED

environmentId

The ID of the environment where this data source creates and 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 ID of the data source.

Type: String

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

lastRunAssetCount

The number of assets created by the data source during its last run.

Type: Integer

lastRunAt

The timestamp of the last run of the data source.

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 the 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 project where the data source creates and publishes assets.

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

The recommendation configuration of the data source.

Type: RecommendationConfiguration object

schedule

The schedule of the data source runs.

Type: ScheduleConfiguration object

selfGrantStatus

Specifies the status of the self-granting functionality.

Type: SelfGrantStatusOutput object

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

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