Note:

You are viewing the documentation for an older major version of the AWS CLI (version 1).

AWS CLI version 2, the latest major version of AWS CLI, is now stable and recommended for general use. To view this page for the AWS CLI version 2, click here. For more information see the AWS CLI version 2 installation instructions and migration guide.

[ aws . datazone ]

update-data-source¶

Description¶

Updates the specified data source in Amazon DataZone.

Synopsis¶

  update-data-source
[--asset-forms-input <value>]
[--configuration <value>]
[--description <value>]
--domain-identifier <value>
[--enable-setting <value>]
--identifier <value>
[--name <value>]
[--publish-on-import | --no-publish-on-import]
[--recommendation <value>]
[--retain-permissions-on-revoke-failure | --no-retain-permissions-on-revoke-failure]
[--schedule <value>]
[--cli-input-json <value>]
[--generate-cli-skeleton <value>]
[--debug]
[--endpoint-url <value>]
[--no-verify-ssl]
[--no-paginate]
[--output <value>]
[--query <value>]
[--profile <value>]
[--region <value>]
[--version <value>]
[--color <value>]
[--no-sign-request]
[--ca-bundle <value>]
[--cli-read-timeout <value>]
[--cli-connect-timeout <value>]

Options¶

--asset-forms-input (list)

The asset forms to be updated as part of the UpdateDataSource action.

(structure)

The details of a metadata form.

content -> (string)

The content of the metadata form.

formName -> (string)

The name of the metadata form.

typeIdentifier -> (string)

The ID of the metadata form type.

typeRevision -> (string)

The revision of the metadata form type.

Shorthand Syntax:

content=string,formName=string,typeIdentifier=string,typeRevision=string ...

JSON Syntax:

[
  {
    "content": "string",
    "formName": "string",
    "typeIdentifier": "string",
    "typeRevision": "string"
  }
  ...
]

--configuration (tagged union structure)

The configuration to be updated as part of the UpdateDataSource action.

Note
This is a Tagged Union structure. Only one of the following top level keys can be set: glueRunConfiguration, redshiftRunConfiguration, sageMakerRunConfiguration.

glueRunConfiguration -> (structure)

The configuration of the Amazon Web Services Glue data source.

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.

dataAccessRole -> (string)

The data access role included in the configuration details of the Amazon Web Services Glue data source.

relationalFilterConfigurations -> (list)

The relational filter configurations included in the configuration details of the Amazon Web Services Glue data source.

(structure)

The relational filter configuration for the data source.

databaseName -> (string)

The database name specified in the relational filter configuration for the data source.

filterExpressions -> (list)

The filter expressions specified in the relational filter configuration for the data source.

(structure)

A filter expression in Amazon DataZone.

expression -> (string)

The search filter expression.

type -> (string)

The search filter explresison type.

schemaName -> (string)

The schema name specified in the relational filter configuration for the data source.

redshiftRunConfiguration -> (structure)

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.

redshiftCredentialConfiguration -> (structure)

The details of the credentials required to access an Amazon Redshift cluster.

secretManagerArn -> (string)

The ARN of a secret manager for an Amazon Redshift cluster.

redshiftStorage -> (tagged union structure)

The details of the Amazon Redshift storage as part of the configuration of an Amazon Redshift data source run.

Note
This is a Tagged Union structure. Only one of the following top level keys can be set: redshiftClusterSource, redshiftServerlessSource.

redshiftClusterSource -> (structure)

The details of the Amazon Redshift cluster source.

clusterName -> (string)

The name of an Amazon Redshift cluster.

redshiftServerlessSource -> (structure)

The details of the Amazon Redshift Serverless workgroup source.

workgroupName -> (string)

The name of the Amazon Redshift Serverless workgroup.

relationalFilterConfigurations -> (list)

The relational filger configurations included in the configuration details of the Amazon Redshift data source.

(structure)

The relational filter configuration for the data source.

databaseName -> (string)

The database name specified in the relational filter configuration for the data source.

filterExpressions -> (list)

The filter expressions specified in the relational filter configuration for the data source.

(structure)

A filter expression in Amazon DataZone.

expression -> (string)

The search filter expression.

type -> (string)

The search filter explresison type.

schemaName -> (string)

The schema name specified in the relational filter configuration for the data source.

sageMakerRunConfiguration -> (structure)

The Amazon SageMaker run configuration.

trackingAssets -> (map)

The tracking assets of the Amazon SageMaker run.

key -> (string)

value -> (list)

(string)

JSON Syntax:

{
  "glueRunConfiguration": {
    "autoImportDataQualityResult": true|false,
    "catalogName": "string",
    "dataAccessRole": "string",
    "relationalFilterConfigurations": [
      {
        "databaseName": "string",
        "filterExpressions": [
          {
            "expression": "string",
            "type": "INCLUDE"|"EXCLUDE"
          }
          ...
        ],
        "schemaName": "string"
      }
      ...
    ]
  },
  "redshiftRunConfiguration": {
    "dataAccessRole": "string",
    "redshiftCredentialConfiguration": {
      "secretManagerArn": "string"
    },
    "redshiftStorage": {
      "redshiftClusterSource": {
        "clusterName": "string"
      },
      "redshiftServerlessSource": {
        "workgroupName": "string"
      }
    },
    "relationalFilterConfigurations": [
      {
        "databaseName": "string",
        "filterExpressions": [
          {
            "expression": "string",
            "type": "INCLUDE"|"EXCLUDE"
          }
          ...
        ],
        "schemaName": "string"
      }
      ...
    ]
  },
  "sageMakerRunConfiguration": {
    "trackingAssets": {"string": ["string", ...]
      ...}
  }
}

--description (string)

The description to be updated as part of the UpdateDataSource action.

--domain-identifier (string)

The identifier of the domain in which to update a data source.

--enable-setting (string)

The enable setting to be updated as part of the UpdateDataSource action.

Possible values:

ENABLED

DISABLED

--identifier (string)

The identifier of the data source to be updated.

--name (string)

The name to be updated as part of the UpdateDataSource action.

--publish-on-import | --no-publish-on-import (boolean)

The publish on import setting to be updated as part of the UpdateDataSource action.

--recommendation (structure)

The recommendation to be updated as part of the UpdateDataSource action.

enableBusinessNameGeneration -> (boolean)

Specifies whether automatic business name generation is to be enabled or not as part of the recommendation configuration.

Shorthand Syntax:

enableBusinessNameGeneration=boolean

JSON Syntax:

{
  "enableBusinessNameGeneration": true|false
}

--retain-permissions-on-revoke-failure | --no-retain-permissions-on-revoke-failure (boolean)

Specifies that the granted permissions are retained in case of a self-subscribe functionality failure for a data source.

--schedule (structure)

The schedule to be updated as part of the UpdateDataSource action.

schedule -> (string)

The schedule of the data source runs.

timezone -> (string)

The timezone of the data source run.

Shorthand Syntax:

schedule=string,timezone=string

JSON Syntax:

{
  "schedule": "string",
  "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"
}

--cli-input-json (string) Performs service operation based on the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, the CLI values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally.

--generate-cli-skeleton (string) Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value input, prints a sample input JSON that can be used as an argument for --cli-input-json. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command.

Global Options¶

--debug (boolean)

Turn on debug logging.

--endpoint-url (string)

Override command's default URL with the given URL.

--no-verify-ssl (boolean)

By default, the AWS CLI uses SSL when communicating with AWS services. For each SSL connection, the AWS CLI will verify SSL certificates. This option overrides the default behavior of verifying SSL certificates.

--no-paginate (boolean)

Disable automatic pagination. If automatic pagination is disabled, the AWS CLI will only make one call, for the first page of results.

--output (string)

The formatting style for command output.

json
text
table

--query (string)

A JMESPath query to use in filtering the response data.

--profile (string)

Use a specific profile from your credential file.

--region (string)

The region to use. Overrides config/env settings.

--version (string)

Display the version of this tool.

--color (string)

Turn on/off color output.

on
off
auto

--no-sign-request (boolean)

Do not sign requests. Credentials will not be loaded if this argument is provided.

--ca-bundle (string)

The CA certificate bundle to use when verifying SSL certificates. Overrides config/env settings.

--cli-read-timeout (int)

The maximum socket read time in seconds. If the value is set to 0, the socket read will be blocking and not timeout. The default value is 60 seconds.

--cli-connect-timeout (int)

The maximum socket connect time in seconds. If the value is set to 0, the socket connect will be blocking and not timeout. The default value is 60 seconds.

Output¶

assetFormsOutput -> (list)

The asset forms to be updated as part of the UpdateDataSource action.

(structure)

The details of a metadata form.

content -> (string)

The content of the metadata form.

formName -> (string)

The name of the metadata form.

typeName -> (string)

The name of the metadata form type.

typeRevision -> (string)

The revision of the metadata form type.

configuration -> (tagged union structure)

The configuration to be updated as part of the UpdateDataSource action.

Note
This is a Tagged Union structure. Only one of the following top level keys can be set: glueRunConfiguration, redshiftRunConfiguration, sageMakerRunConfiguration.

glueRunConfiguration -> (structure)

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.

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.

dataAccessRole -> (string)

The data access role 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.

relationalFilterConfigurations -> (list)

The relational filter configurations included in the configuration details of the Amazon Web Services Glue data source.

(structure)

The relational filter configuration for the data source.

databaseName -> (string)

The database name specified in the relational filter configuration for the data source.

filterExpressions -> (list)

The filter expressions specified in the relational filter configuration for the data source.

(structure)

A filter expression in Amazon DataZone.

expression -> (string)

The search filter expression.

type -> (string)

The search filter explresison type.

schemaName -> (string)

The schema name specified in the relational filter configuration for the data source.

redshiftRunConfiguration -> (structure)

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.

dataAccessRole -> (string)

The data access role included in the configuration details of the Amazon Redshift data source.

redshiftCredentialConfiguration -> (structure)

The details of the credentials required to access an Amazon Redshift cluster.

secretManagerArn -> (string)

The ARN of a secret manager for an Amazon Redshift cluster.

redshiftStorage -> (tagged union structure)

The details of the Amazon Redshift storage as part of the configuration of an Amazon Redshift data source run.

Note
This is a Tagged Union structure. Only one of the following top level keys can be set: redshiftClusterSource, redshiftServerlessSource.

redshiftClusterSource -> (structure)

The details of the Amazon Redshift cluster source.

clusterName -> (string)

The name of an Amazon Redshift cluster.

redshiftServerlessSource -> (structure)

The details of the Amazon Redshift Serverless workgroup source.

workgroupName -> (string)

The name of the Amazon Redshift Serverless workgroup.

region -> (string)

The Amazon Web Services region included in the configuration details of the Amazon Redshift data source.

relationalFilterConfigurations -> (list)

The relational filger configurations included in the configuration details of the Amazon Redshift data source.

(structure)

The relational filter configuration for the data source.

databaseName -> (string)

The database name specified in the relational filter configuration for the data source.

filterExpressions -> (list)

The filter expressions specified in the relational filter configuration for the data source.

(structure)

A filter expression in Amazon DataZone.

expression -> (string)

The search filter expression.

type -> (string)

The search filter explresison type.

schemaName -> (string)

The schema name specified in the relational filter configuration for the data source.

sageMakerRunConfiguration -> (structure)

The Amazon SageMaker run configuration.

accountId -> (string)

The Amazon SageMaker account ID.

region -> (string)

The Amazon SageMaker Region.

trackingAssets -> (map)

The tracking assets of the Amazon SageMaker.

key -> (string)

value -> (list)

(string)

connectionId -> (string)

The connection ID.

createdAt -> (timestamp)

The timestamp of when the data source was updated.

description -> (string)

The description to be updated as part of the UpdateDataSource action.

domainId -> (string)

The identifier of the Amazon DataZone domain in which a data source is to be updated.

enableSetting -> (string)

The enable setting to be updated as part of the UpdateDataSource action.

environmentId -> (string)

The identifier of the environment in which a data source is to be updated.

errorMessage -> (structure)

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

errorType -> (string)

The type of the error message that is returned if the operation cannot be successfully completed.

id -> (string)

The identifier of the data source to be updated.

lastRunAt -> (timestamp)

The timestamp of when the data source was last run.

lastRunErrorMessage -> (structure)

The last run error message of the data source.

errorDetail -> (string)

The details of the error message that is returned if the operation cannot be successfully completed.

errorType -> (string)

The type of the error message that is returned if the operation cannot be successfully completed.

lastRunStatus -> (string)

The last run status of the data source.

name -> (string)

The name to be updated as part of the UpdateDataSource action.

projectId -> (string)

The identifier of the project where data source is to be updated.

publishOnImport -> (boolean)

The publish on import setting to be updated as part of the UpdateDataSource action.

recommendation -> (structure)

The recommendation to be updated as part of the UpdateDataSource 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.

schedule -> (structure)

The schedule to be updated as part of the UpdateDataSource action.

schedule -> (string)

The schedule of the data source runs.

timezone -> (string)

The timezone of the data source run.

selfGrantStatus -> (tagged union structure)

Specifies the status of the self-granting functionality.

Note
This is a Tagged Union structure. Only one of the following top level keys can be set: glueSelfGrantStatus, redshiftSelfGrantStatus.

glueSelfGrantStatus -> (structure)

The details for the self granting status for a Glue data source.

selfGrantStatusDetails -> (list)

The details for the self granting status for a Glue data source.

(structure)

The details for the self granting status.

databaseName -> (string)

The name of the database used for the data source.

failureCause -> (string)

The reason for why the operation failed.

schemaName -> (string)

The name of the schema used in the data source.

status -> (string)

The self granting status of the data source.

redshiftSelfGrantStatus -> (structure)

The details for the self granting status for an Amazon Redshift data source.

selfGrantStatusDetails -> (list)

The details for the self granting status for an Amazon Redshift data source.

(structure)

The details for the self granting status.

databaseName -> (string)

The name of the database used for the data source.

failureCause -> (string)

The reason for why the operation failed.

schemaName -> (string)

The name of the schema used in the data source.

status -> (string)

The self granting status of the data source.

status -> (string)

The status to be updated as part of the UpdateDataSource action.

type -> (string)

The type to be updated as part of the UpdateDataSource action.

updatedAt -> (timestamp)

The timestamp of when the data source was updated.

Table Of Contents

Feedback

User Guide

Note:

update-data-source¶

Description¶

Synopsis¶

Options¶

Note

Note

Global Options¶

Output¶

Note

Note

Note