UpdateDataSource
Updates the specified data source in Amazon DataZone.
Request Syntax
PATCH /v2/domains/domainIdentifier/data-sources/identifier HTTP/1.1
Content-type: application/json
{
"assetFormsInput": [
{
"content": "string",
"formName": "string",
"typeIdentifier": "string",
"typeRevision": "string"
}
],
"configuration": { ... },
"description": "string",
"enableSetting": "string",
"name": "string",
"publishOnImport": boolean,
"recommendation": {
"enableBusinessNameGeneration": boolean
},
"retainPermissionsOnRevokeFailure": boolean,
"schedule": {
"schedule": "string",
"timezone": "string"
}
}URI Request Parameters
The request uses the following URI parameters.
- domainIdentifier
-
The identifier of the domain in which to update a data source.
Pattern:
^dzd[-_][a-zA-Z0-9_-]{1,36}$Required: Yes
- identifier
-
The identifier of the data source to be updated.
Pattern:
^[a-zA-Z0-9_-]{1,36}$Required: Yes
Request Body
The request accepts the following data in JSON format.
- assetFormsInput
-
The asset forms to be updated as part of the
UpdateDataSourceaction.Type: Array of FormInput objects
Array Members: Minimum number of 0 items. Maximum number of 10 items.
Required: No
- configuration
-
The configuration to be updated as part of the
UpdateDataSourceaction.Type: DataSourceConfigurationInput object
Note: This object is a Union. Only one member of this object can be specified or returned.
Required: No
- description
-
The description to be updated as part of the
UpdateDataSourceaction.Type: String
Length Constraints: Minimum length of 0. Maximum length of 2048.
Required: No
- enableSetting
-
The enable setting to be updated as part of the
UpdateDataSourceaction.Type: String
Valid Values:
ENABLED | DISABLEDRequired: No
- name
-
The name to be updated as part of the
UpdateDataSourceaction.Type: String
Length Constraints: Minimum length of 1. Maximum length of 256.
Required: No
- publishOnImport
-
The publish on import setting to be updated as part of the
UpdateDataSourceaction.Type: Boolean
Required: No
- recommendation
-
The recommendation to be updated as part of the
UpdateDataSourceaction.Type: RecommendationConfiguration object
Required: No
- retainPermissionsOnRevokeFailure
-
Specifies that the granted permissions are retained in case of a self-subscribe functionality failure for a data source.
Type: Boolean
Required: No
- schedule
-
The schedule to be updated as part of the
UpdateDataSourceaction.Type: ScheduleConfiguration object
Required: No
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",
"lastRunAt": "string",
"lastRunErrorMessage": {
"errorDetail": "string",
"errorType": "string"
},
"lastRunStatus": "string",
"name": "string",
"projectId": "string",
"publishOnImport": boolean,
"recommendation": {
"enableBusinessNameGeneration": boolean
},
"retainPermissionsOnRevokeFailure": 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 asset forms to be updated as part of the
UpdateDataSourceaction.Type: Array of FormOutput objects
Array Members: Minimum number of 0 items. Maximum number of 10 items.
- configuration
-
The configuration to be updated as part of the
UpdateDataSourceaction.Type: DataSourceConfigurationOutput object
Note: This object is a Union. Only one member of this object can be specified or returned.
- connectionId
-
The connection ID.
Type: String
- createdAt
-
The timestamp of when the data source was updated.
Type: Timestamp
- description
-
The description to be updated as part of the
UpdateDataSourceaction.Type: String
Length Constraints: Minimum length of 0. Maximum length of 2048.
- domainId
-
The identifier of the Amazon DataZone domain in which a data source is to be updated.
Type: String
Pattern:
^dzd[-_][a-zA-Z0-9_-]{1,36}$ - enableSetting
-
The enable setting to be updated as part of the
UpdateDataSourceaction.Type: String
Valid Values:
ENABLED | DISABLED - environmentId
-
The identifier of the environment in which a data source is to be updated.
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 identifier of the data source to be updated.
Type: String
Pattern:
^[a-zA-Z0-9_-]{1,36}$ - lastRunAt
-
The timestamp of when the data source was last run.
Type: Timestamp
- lastRunErrorMessage
-
The last run error message of the data source.
Type: DataSourceErrorMessage object
- lastRunStatus
-
The last run status of the data source.
Type: String
Valid Values:
REQUESTED | RUNNING | FAILED | PARTIALLY_SUCCEEDED | SUCCESS - name
-
The name to be updated as part of the
UpdateDataSourceaction.Type: String
Length Constraints: Minimum length of 1. Maximum length of 256.
- projectId
-
The identifier of the project where data source is to be updated.
Type: String
Pattern:
^[a-zA-Z0-9_-]{1,36}$ - publishOnImport
-
The publish on import setting to be updated as part of the
UpdateDataSourceaction.Type: Boolean
- recommendation
-
The recommendation to be updated as part of the
UpdateDataSourceaction.Type: RecommendationConfiguration object
- retainPermissionsOnRevokeFailure
-
Specifies that the granted permissions are retained in case of a self-subscribe functionality failure for a data source.
Type: Boolean
- schedule
-
The schedule to be updated as part of the
UpdateDataSourceaction.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 to be updated as part of the
UpdateDataSourceaction.Type: String
Valid Values:
CREATING | FAILED_CREATION | READY | UPDATING | FAILED_UPDATE | RUNNING | DELETING | FAILED_DELETION - type
-
The type to be updated as part of the
UpdateDataSourceaction.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
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
