---
title: "PATCH /v2/domains/{domainIdentifier}/data-sources/{identifier}"
method: PATCH
path: "/v2/domains/{domainIdentifier}/data-sources/{identifier}"
---

# PATCH /v2/domains/{domainIdentifier}/data-sources/{identifier}

`PATCH /v2/domains/{domainIdentifier}/data-sources/{identifier}`

Updates the specified data source in Amazon DataZone.

## Path parameters

- `domainIdentifier` string, required
- `identifier` string, required

## Request body

- object
  - `name` string, password — The name to be updated as part of the <code>UpdateDataSource</code> action.
  - `description` string, password — The description to be updated as part of the <code>UpdateDataSource</code> action.
  - `enableSetting` 'ENABLED' | 'DISABLED' — The enable setting to be updated as part of the <code>UpdateDataSource</code> action.
  - `publishOnImport` boolean — The publish on import setting to be updated as part of the <code>UpdateDataSource</code> action.
  - `assetFormsInput` FormInput[] — The asset forms to be updated as part of the <code>UpdateDataSource</code> action.
    - `formName` string, required — The name of the metadata form.
    - `typeIdentifier` string — The ID of the metadata form type.
    - `typeRevision` string — The revision of the metadata form type.
    - `content` string — The content of the metadata form.
  - `schedule` object — The details of the schedule of the data source runs.
    - `timezone` 'UTC' | 'AFRICA_JOHANNESBURG' | 'AMERICA_MONTREAL' | 'AMERICA_SAO_PAULO' | 'ASIA_BAHRAIN' | 'ASIA_BANGKOK' | 'ASIA_CALCUTTA' | 'ASIA_DUBAI' | 'ASIA_HONG_KONG' | 'ASIA_JAKARTA' | 'ASIA_KUALA_LUMPUR' | 'ASIA_SEOUL' | 'ASIA_SHANGHAI' | 'ASIA_SINGAPORE' | 'ASIA_TAIPEI' | 'ASIA_TOKYO' | 'AUSTRALIA_MELBOURNE' | 'AUSTRALIA_SYDNEY' | 'CANADA_CENTRAL' | 'CET' | 'CST6CDT' | 'ETC_GMT' | 'ETC_GMT0' | 'ETC_GMT_ADD_0' | 'ETC_GMT_ADD_1' | 'ETC_GMT_ADD_10' | 'ETC_GMT_ADD_11' | 'ETC_GMT_ADD_12' | 'ETC_GMT_ADD_2' | 'ETC_GMT_ADD_3' | 'ETC_GMT_ADD_4' | 'ETC_GMT_ADD_5' | 'ETC_GMT_ADD_6' | 'ETC_GMT_ADD_7' | 'ETC_GMT_ADD_8' | 'ETC_GMT_ADD_9' | 'ETC_GMT_NEG_0' | 'ETC_GMT_NEG_1' | 'ETC_GMT_NEG_10' | 'ETC_GMT_NEG_11' | 'ETC_GMT_NEG_12' | 'ETC_GMT_NEG_13' | 'ETC_GMT_NEG_14' | 'ETC_GMT_NEG_2' | 'ETC_GMT_NEG_3' | 'ETC_GMT_NEG_4' | 'ETC_GMT_NEG_5' | 'ETC_GMT_NEG_6' | 'ETC_GMT_NEG_7' | 'ETC_GMT_NEG_8' | 'ETC_GMT_NEG_9' | 'EUROPE_DUBLIN' | 'EUROPE_LONDON' | 'EUROPE_PARIS' | 'EUROPE_STOCKHOLM' | 'EUROPE_ZURICH' | 'ISRAEL' | 'MEXICO_GENERAL' | 'MST7MDT' | 'PACIFIC_AUCKLAND' | 'US_CENTRAL' | 'US_EASTERN' | 'US_MOUNTAIN' | 'US_PACIFIC' — The timezone of the data source run.
    - `schedule` string — The schedule of the data source runs.
  - `configuration` object — The configuration of the data source.
    - `glueRunConfiguration` object — The configuration of the Amazon Web Services Glue data source.
      - `dataAccessRole` string — The data access role included in the configuration details of the Amazon Web Services Glue data source.
      - `relationalFilterConfigurations` RelationalFilterConfiguration[], required — The relational filter configurations included in the configuration details of the Amazon Web Services Glue data source.
        - `databaseName` string, required — The database name specified in the relational filter configuration for the data source.
        - `schemaName` string — The schema name specified in the relational filter configuration for the data source.
        - `filterExpressions` FilterExpression[] — The filter expressions specified in the relational filter configuration for the data source.
          - `type` 'INCLUDE' | 'EXCLUDE', required — The search filter explresison type.
          - `expression` string, required — The search filter expression.
      - `autoImportDataQualityResult` boolean — Specifies whether to automatically import data quality metrics as part of the data source run.
      - `catalogName` string — The catalog name in the Amazon Web Services Glue run configuration.
    - `redshiftRunConfiguration` object — The configuration of the Amazon Redshift data source.
      - `dataAccessRole` string — The data access role included in the configuration details of the Amazon Redshift data source.
      - `relationalFilterConfigurations` RelationalFilterConfiguration[], required — The relational filger configurations included in the configuration details of the Amazon Redshift data source.
        - `databaseName` string, required — The database name specified in the relational filter configuration for the data source.
        - `schemaName` string — The schema name specified in the relational filter configuration for the data source.
        - `filterExpressions` FilterExpression[] — The filter expressions specified in the relational filter configuration for the data source.
          - `type` 'INCLUDE' | 'EXCLUDE', required — The search filter explresison type.
          - `expression` string, required — The search filter expression.
      - `redshiftCredentialConfiguration` RedshiftCredentialConfiguration — The details of the credentials required to access an Amazon Redshift cluster.
        - `secretManagerArn` string, required — The ARN of a secret manager for an Amazon Redshift cluster.
      - `redshiftStorage` RedshiftStorage — The details of the Amazon Redshift storage as part of the configuration of an Amazon Redshift data source run.
        - `redshiftClusterSource` object — The details of the Amazon Redshift cluster source.
          - `clusterName` string, required — The name of an Amazon Redshift cluster.
        - `redshiftServerlessSource` object — The details of the Amazon Redshift Serverless workgroup source.
          - `workgroupName` string, required — The name of the Amazon Redshift Serverless workgroup.
    - `sageMakerRunConfiguration` object — The Amazon SageMaker run configuration.
      - `trackingAssets` object, required — The tracking assets of the Amazon SageMaker run.
  - `recommendation` object — The recommendation to be updated as part of the <code>UpdateDataSource</code> action.
    - `enableBusinessNameGeneration` boolean — Specifies whether automatic business name generation is to be enabled or not as part of the recommendation configuration.
  - `retainPermissionsOnRevokeFailure` boolean — Specifies that the granted permissions are retained in case of a self-subscribe functionality failure for a data source.

## Response `200`

Success

- UpdateDataSourceOutput
  - `id` string, required — The identifier of the data source to be updated.
  - `status` 'CREATING' | 'FAILED_CREATION' | 'READY' | 'UPDATING' | 'FAILED_UPDATE' | 'RUNNING' | 'DELETING' | 'FAILED_DELETION' — The status to be updated as part of the <code>UpdateDataSource</code> action.
  - `type` string — The type to be updated as part of the <code>UpdateDataSource</code> action.
  - `name` string, password, required — The name to be updated as part of the <code>UpdateDataSource</code> action.
  - `description` string, password — The description to be updated as part of the <code>UpdateDataSource</code> action.
  - `domainId` string, required — The identifier of the Amazon DataZone domain in which a data source is to be updated.
  - `projectId` string, required — The identifier of the project where data source is to be updated.
  - `environmentId` string — The identifier of the environment in which a data source is to be updated.
  - `connectionId` string — The connection ID.
  - `configuration` object — The configuration to be updated as part of the <code>UpdateDataSource</code> action.
    - `glueRunConfiguration` object — The configuration of the Amazon Web Services Glue data source.
      - `accountId` string — The Amazon Web Services account ID included in the configuration details of the Amazon Web Services Glue data source.
      - `region` string — The Amazon Web Services region included in the configuration details of the Amazon Web Services Glue data source.
      - `dataAccessRole` string — The data access role included in the configuration details of the Amazon Web Services Glue data source.
      - `relationalFilterConfigurations` RelationalFilterConfiguration[], required — The relational filter configurations included in the configuration details of the Amazon Web Services Glue data source.
        - `databaseName` string, required — The database name specified in the relational filter configuration for the data source.
        - `schemaName` string — The schema name specified in the relational filter configuration for the data source.
        - `filterExpressions` FilterExpression[] — The filter expressions specified in the relational filter configuration for the data source.
          - `type` 'INCLUDE' | 'EXCLUDE', required — The search filter explresison type.
          - `expression` string, required — The search filter expression.
      - `autoImportDataQualityResult` boolean — Specifies whether to automatically import data quality metrics as part of the data source run.
      - `catalogName` string — The catalog name in the Amazon Web Services Glue run configuration.
    - `redshiftRunConfiguration` object — The configuration of the Amazon Redshift data source.
      - `accountId` string — The ID of the Amazon Web Services account included in the configuration details of the Amazon Redshift data source.
      - `region` string — The Amazon Web Services region included in the configuration details of the Amazon Redshift data source.
      - `dataAccessRole` string — The data access role included in the configuration details of the Amazon Redshift data source.
      - `relationalFilterConfigurations` RelationalFilterConfiguration[], required — The relational filger configurations included in the configuration details of the Amazon Redshift data source.
        - `databaseName` string, required — The database name specified in the relational filter configuration for the data source.
        - `schemaName` string — The schema name specified in the relational filter configuration for the data source.
        - `filterExpressions` FilterExpression[] — The filter expressions specified in the relational filter configuration for the data source.
          - `type` 'INCLUDE' | 'EXCLUDE', required — The search filter explresison type.
          - `expression` string, required — The search filter expression.
      - `redshiftCredentialConfiguration` RedshiftCredentialConfiguration — The details of the credentials required to access an Amazon Redshift cluster.
        - `secretManagerArn` string, required — The ARN of a secret manager for an Amazon Redshift cluster.
      - `redshiftStorage` RedshiftStorage, required — The details of the Amazon Redshift storage as part of the configuration of an Amazon Redshift data source run.
        - `redshiftClusterSource` object — The details of the Amazon Redshift cluster source.
          - `clusterName` string, required — The name of an Amazon Redshift cluster.
        - `redshiftServerlessSource` object — The details of the Amazon Redshift Serverless workgroup source.
          - `workgroupName` string, required — The name of the Amazon Redshift Serverless workgroup.
    - `sageMakerRunConfiguration` object — The Amazon SageMaker run configuration.
      - `accountId` string — The Amazon SageMaker account ID.
      - `region` string — The Amazon SageMaker Region.
      - `trackingAssets` object, required — The tracking assets of the Amazon SageMaker.
  - `recommendation` object — The recommendation to be updated as part of the <code>UpdateDataSource</code> action.
    - `enableBusinessNameGeneration` boolean — Specifies whether automatic business name generation is to be enabled or not as part of the recommendation configuration.
  - `enableSetting` 'ENABLED' | 'DISABLED' — The enable setting to be updated as part of the <code>UpdateDataSource</code> action.
  - `publishOnImport` boolean — The publish on import setting to be updated as part of the <code>UpdateDataSource</code> action.
  - `assetFormsOutput` FormOutput[] — The asset forms to be updated as part of the <code>UpdateDataSource</code> action.
    - `formName` string, required — The name of the metadata form.
    - `typeName` string, password — The name of the metadata form type.
    - `typeRevision` string — The revision of the metadata form type.
    - `content` string — The content of the metadata form.
  - `schedule` object — The schedule to be updated as part of the <code>UpdateDataSource</code> action.
    - `timezone` 'UTC' | 'AFRICA_JOHANNESBURG' | 'AMERICA_MONTREAL' | 'AMERICA_SAO_PAULO' | 'ASIA_BAHRAIN' | 'ASIA_BANGKOK' | 'ASIA_CALCUTTA' | 'ASIA_DUBAI' | 'ASIA_HONG_KONG' | 'ASIA_JAKARTA' | 'ASIA_KUALA_LUMPUR' | 'ASIA_SEOUL' | 'ASIA_SHANGHAI' | 'ASIA_SINGAPORE' | 'ASIA_TAIPEI' | 'ASIA_TOKYO' | 'AUSTRALIA_MELBOURNE' | 'AUSTRALIA_SYDNEY' | 'CANADA_CENTRAL' | 'CET' | 'CST6CDT' | 'ETC_GMT' | 'ETC_GMT0' | 'ETC_GMT_ADD_0' | 'ETC_GMT_ADD_1' | 'ETC_GMT_ADD_10' | 'ETC_GMT_ADD_11' | 'ETC_GMT_ADD_12' | 'ETC_GMT_ADD_2' | 'ETC_GMT_ADD_3' | 'ETC_GMT_ADD_4' | 'ETC_GMT_ADD_5' | 'ETC_GMT_ADD_6' | 'ETC_GMT_ADD_7' | 'ETC_GMT_ADD_8' | 'ETC_GMT_ADD_9' | 'ETC_GMT_NEG_0' | 'ETC_GMT_NEG_1' | 'ETC_GMT_NEG_10' | 'ETC_GMT_NEG_11' | 'ETC_GMT_NEG_12' | 'ETC_GMT_NEG_13' | 'ETC_GMT_NEG_14' | 'ETC_GMT_NEG_2' | 'ETC_GMT_NEG_3' | 'ETC_GMT_NEG_4' | 'ETC_GMT_NEG_5' | 'ETC_GMT_NEG_6' | 'ETC_GMT_NEG_7' | 'ETC_GMT_NEG_8' | 'ETC_GMT_NEG_9' | 'EUROPE_DUBLIN' | 'EUROPE_LONDON' | 'EUROPE_PARIS' | 'EUROPE_STOCKHOLM' | 'EUROPE_ZURICH' | 'ISRAEL' | 'MEXICO_GENERAL' | 'MST7MDT' | 'PACIFIC_AUCKLAND' | 'US_CENTRAL' | 'US_EASTERN' | 'US_MOUNTAIN' | 'US_PACIFIC' — The timezone of the data source run.
    - `schedule` string — The schedule of the data source runs.
  - `lastRunStatus` 'REQUESTED' | 'RUNNING' | 'FAILED' | 'PARTIALLY_SUCCEEDED' | 'SUCCESS' — The last run status of the data source.
  - `lastRunAt` string, date-time — The timestamp of when the data source was last run.
  - `lastRunErrorMessage` object — The last run error message of the data source.
    - `errorType` 'ACCESS_DENIED_EXCEPTION' | 'CONFLICT_EXCEPTION' | 'INTERNAL_SERVER_EXCEPTION' | 'RESOURCE_NOT_FOUND_EXCEPTION' | 'SERVICE_QUOTA_EXCEEDED_EXCEPTION' | 'THROTTLING_EXCEPTION' | 'VALIDATION_EXCEPTION', required — The type of the error message that is returned if the operation cannot be successfully completed.
    - `errorDetail` string — The details of the error message that is returned if the operation cannot be successfully completed.
  - `errorMessage` object — Specifies the error message that is returned if the operation cannot be successfully completed.
    - `errorType` 'ACCESS_DENIED_EXCEPTION' | 'CONFLICT_EXCEPTION' | 'INTERNAL_SERVER_EXCEPTION' | 'RESOURCE_NOT_FOUND_EXCEPTION' | 'SERVICE_QUOTA_EXCEEDED_EXCEPTION' | 'THROTTLING_EXCEPTION' | 'VALIDATION_EXCEPTION', required — The type of the error message that is returned if the operation cannot be successfully completed.
    - `errorDetail` string — The details of the error message that is returned if the operation cannot be successfully completed.
  - `createdAt` string, date-time — The timestamp of when the data source was updated.
  - `updatedAt` string, date-time — The timestamp of when the data source was updated.
  - `selfGrantStatus` object — Specifies the status of the self-granting functionality.
    - `glueSelfGrantStatus` object — The details for the self granting status for a Glue data source.
      - `selfGrantStatusDetails` SelfGrantStatusDetail[], required — The details for the self granting status for a Glue data source.
        - `databaseName` string, required — The name of the database used for the data source.
        - `schemaName` string — The name of the schema used in the data source.
        - `status` 'GRANT_PENDING' | 'REVOKE_PENDING' | 'GRANT_IN_PROGRESS' | 'REVOKE_IN_PROGRESS' | 'GRANTED' | 'GRANT_FAILED' | 'REVOKE_FAILED', required — The self granting status of the data source.
        - `failureCause` string — The reason for why the operation failed.
    - `redshiftSelfGrantStatus` object — The details for the self granting status for an Amazon Redshift data source.
      - `selfGrantStatusDetails` SelfGrantStatusDetail[], required — The details for the self granting status for an Amazon Redshift data source.
        - `databaseName` string, required — The name of the database used for the data source.
        - `schemaName` string — The name of the schema used in the data source.
        - `status` 'GRANT_PENDING' | 'REVOKE_PENDING' | 'GRANT_IN_PROGRESS' | 'REVOKE_IN_PROGRESS' | 'GRANTED' | 'GRANT_FAILED' | 'REVOKE_FAILED', required — The self granting status of the data source.
        - `failureCause` string — The reason for why the operation failed.
  - `retainPermissionsOnRevokeFailure` boolean — Specifies that the granted permissions are retained in case of a self-subscribe functionality failure for a data source.

## Other responses

- `480` — InternalServerException
- `481` — ResourceNotFoundException
- `482` — AccessDeniedException
- `483` — ThrottlingException
- `484` — ServiceQuotaExceededException
- `485` — ConflictException
- `486` — ValidationException
- `487` — UnauthorizedException

---

[API](https://skmtc.net/aws/apis/datazone.md) · [All operations](https://skmtc.net/aws/apis/datazone/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/aws/datazone/versions/055599054b53/schema)