delete-data-source¶

Description¶

Deletes a data source in Amazon DataZone.

Synopsis¶

  delete-data-source
[--client-token <value>]
--domain-identifier <value>
--identifier <value>
[--retain-permissions-on-revoke-failure | --no-retain-permissions-on-revoke-failure]
[--cli-input-json | --cli-input-yaml]
[--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>]
[--cli-binary-format <value>]
[--no-cli-pager]
[--cli-auto-prompt]
[--no-cli-auto-prompt]

Options¶

--client-token (string)

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

--domain-identifier (string) [required]

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

Constraints:

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

--identifier (string) [required]

The identifier of the data source that is deleted.

Constraints:

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

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

--cli-input-json | --cli-input-yaml (string) Reads arguments from the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, those 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. This may not be specified along with --cli-input-yaml.

--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. Similarly, if provided yaml-input it will print a sample input YAML that can be used with --cli-input-yaml. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command. The generated JSON skeleton is not stable between versions of the AWS CLI and there are no backwards compatibility guarantees in the JSON skeleton generated.

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
yaml
yaml-stream

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

--cli-binary-format (string)

The formatting style to be used for binary blobs. The default format is base64. The base64 format expects binary blobs to be provided as a base64 encoded string. The raw-in-base64-out format preserves compatibility with AWS CLI V1 behavior and binary values must be passed literally. When providing contents from a file that map to a binary blob fileb:// will always be treated as binary and use the file contents directly regardless of the cli-binary-format setting. When using file:// the file contents will need to properly formatted for the configured cli-binary-format.

base64
raw-in-base64-out

--no-cli-pager (boolean)

Disable cli pager for output.

--cli-auto-prompt (boolean)

Automatically prompt for CLI input parameters.

--no-cli-auto-prompt (boolean)

Disable automatically prompt for CLI input parameters.

Output¶

assetFormsOutput -> (list)

The asset data forms associated with this data source.

Constraints:

min: 0

max: 10

(structure)

The details of a metadata form.

content -> (string)

The content of the metadata form.

formName -> (string) [required]

The name of the metadata form.

Constraints:

min: 1

max: 128

pattern: ^(?![0-9_])\w+$|^_\w*[a-zA-Z0-9]\w*$

typeName -> (string)

The name of the metadata form type.

Constraints:

min: 1

max: 128

pattern: ^(amazon.datazone.)?(?![0-9_])\w+$|^_\w*[a-zA-Z0-9]\w*$

typeRevision -> (string)

The revision of the metadata form type.

Constraints:

min: 1

max: 64

configuration -> (tagged union structure)

The configuration of the data source that is deleted.

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.

Constraints:

min: 12

max: 12

pattern: ^\d{12}$

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.

Constraints:

min: 1

max: 128

dataAccessRole -> (string)

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

Constraints:

pattern: ^arn:aws[^:]*:iam::\d{12}:(role|role/service-role)/[\w+=,.@-]{1,128}$

region -> (string)

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

Constraints:

min: 4

max: 16

pattern: [a-z]{2}-?(iso|gov)?-{1}[a-z]*-{1}[0-9]

relationalFilterConfigurations -> (list) [required]

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) [required]

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

Constraints:

min: 1

max: 128

filterExpressions -> (list)

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

(structure)

A filter expression in Amazon DataZone.

expression -> (string) [required]

The search filter expression.

Constraints:

min: 1

max: 2048

type -> (string) [required]

The search filter explresison type.

Possible values:

INCLUDE

EXCLUDE

schemaName -> (string)

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

Constraints:

min: 1

max: 128

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.

Constraints:

min: 12

max: 12

pattern: ^\d{12}$

dataAccessRole -> (string)

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

Constraints:

pattern: ^arn:aws[^:]*:iam::\d{12}:(role|role/service-role)/[\w+=,.@-]{1,128}$

redshiftCredentialConfiguration -> (structure)

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.

Constraints:

min: 0

max: 256

pattern: ^arn:aws[^:]*:secretsmanager:[a-z]{2}-?(iso|gov)?-{1}[a-z]*-{1}[0-9]:\d{12}:secret:.*$

redshiftStorage -> (tagged union structure) [required]

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) [required]

The name of an Amazon Redshift cluster.

Constraints:

min: 1

max: 63

pattern: ^[0-9a-z].[a-z0-9\-]*$

redshiftServerlessSource -> (structure)

The details of the Amazon Redshift Serverless workgroup source.

workgroupName -> (string) [required]

The name of the Amazon Redshift Serverless workgroup.

Constraints:

min: 3

max: 64

pattern: ^[a-z0-9-]+$

region -> (string)

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

Constraints:

min: 4

max: 16

pattern: [a-z]{2}-?(iso|gov)?-{1}[a-z]*-{1}[0-9]

relationalFilterConfigurations -> (list) [required]

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) [required]

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

Constraints:

min: 1

max: 128

filterExpressions -> (list)

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

(structure)

A filter expression in Amazon DataZone.

expression -> (string) [required]

The search filter expression.

Constraints:

min: 1

max: 2048

type -> (string) [required]

The search filter explresison type.

Possible values:

INCLUDE

EXCLUDE

schemaName -> (string)

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

Constraints:

min: 1

max: 128

sageMakerRunConfiguration -> (structure)

The Amazon SageMaker run configuration.

accountId -> (string)

The Amazon SageMaker account ID.

Constraints:

min: 12

max: 12

pattern: ^\d{12}$

region -> (string)

The Amazon SageMaker Region.

Constraints:

min: 4

max: 16

pattern: [a-z]{2}-?(iso|gov)?-{1}[a-z]*-{1}[0-9]

trackingAssets -> (map) [required]

The tracking assets of the Amazon SageMaker.

Constraints:

min: 1

max: 1

key -> (string)

Constraints:

min: 1

max: 64

value -> (list)

Constraints:

min: 0

max: 500

(string)

Constraints:

pattern: ^arn:aws[^:]*:sagemaker:[a-z]{2}-?(iso|gov)?-{1}[a-z]*-{1}[0-9]:\d{12}:[\w+=,.@-]{1,128}/[\w+=,.@-]{1,256}$

connectionId -> (string)

The ID of the connection that is deleted.

createdAt -> (timestamp)

The timestamp of when this data source was created.

description -> (string)

The description of the data source that is deleted.

Constraints:

min: 0

max: 2048

domainId -> (string)

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

Constraints:

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

enableSetting -> (string)

The enable setting of the data source that specifies whether the data source is enabled or disabled.

Possible values:

ENABLED

DISABLED

environmentId -> (string)

The ID of the environemnt associated with this data source.

Constraints:

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

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) [required]

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

Possible values:

ACCESS_DENIED_EXCEPTION

CONFLICT_EXCEPTION

INTERNAL_SERVER_EXCEPTION

RESOURCE_NOT_FOUND_EXCEPTION

SERVICE_QUOTA_EXCEEDED_EXCEPTION

THROTTLING_EXCEPTION

VALIDATION_EXCEPTION

id -> (string)

The ID of the data source that is deleted.

Constraints:

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

lastRunAt -> (timestamp)

The timestamp of when the data source was last run.

lastRunErrorMessage -> (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) [required]

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

Possible values:

ACCESS_DENIED_EXCEPTION

CONFLICT_EXCEPTION

INTERNAL_SERVER_EXCEPTION

RESOURCE_NOT_FOUND_EXCEPTION

SERVICE_QUOTA_EXCEEDED_EXCEPTION

THROTTLING_EXCEPTION

VALIDATION_EXCEPTION

lastRunStatus -> (string)

The status of the last run of this data source.

Possible values:

REQUESTED

RUNNING

FAILED

PARTIALLY_SUCCEEDED

SUCCESS

name -> (string)

The name of the data source that is deleted.

Constraints:

min: 1

max: 256

projectId -> (string)

The ID of the project in which this data source exists and from which it’s deleted.

Constraints:

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

publishOnImport -> (boolean)

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

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 of runs for this data source.

schedule -> (string)

The schedule of the data source runs.

Constraints:

min: 1

max: 256

pattern: cron$(\b[0-5]?[0-9]\b) (\b2[0-3]\b|\b[0-1]?[0-9]\b) ([-?*,/\dLW]){1,83} ([-*,/\d]|[a-zA-Z]{3}){1,23} ([-?#*,/\dL]|[a-zA-Z]{3}){1,13} ([^$]+)\)

timezone -> (string)

The timezone of the data source run.

Possible values:

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

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) [required]

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

(structure)

The details for the self granting status.

databaseName -> (string) [required]

The name of the database used for the data source.

Constraints:

min: 1

max: 128

failureCause -> (string)

The reason for why the operation failed.

schemaName -> (string)

The name of the schema used in the data source.

Constraints:

min: 1

max: 128

status -> (string) [required]

The self granting status of the data source.

Possible values:

GRANT_PENDING

REVOKE_PENDING

GRANT_IN_PROGRESS

REVOKE_IN_PROGRESS

GRANTED

GRANT_FAILED

REVOKE_FAILED

redshiftSelfGrantStatus -> (structure)

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

selfGrantStatusDetails -> (list) [required]

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

(structure)

The details for the self granting status.

databaseName -> (string) [required]

The name of the database used for the data source.

Constraints:

min: 1

max: 128

failureCause -> (string)

The reason for why the operation failed.

schemaName -> (string)

The name of the schema used in the data source.

Constraints:

min: 1

max: 128

status -> (string) [required]

The self granting status of the data source.

Possible values:

GRANT_PENDING

REVOKE_PENDING

GRANT_IN_PROGRESS

REVOKE_IN_PROGRESS

GRANTED

GRANT_FAILED

REVOKE_FAILED

status -> (string)

The status of this data source.

Possible values:

CREATING

FAILED_CREATION

READY

UPDATING

FAILED_UPDATE

RUNNING

DELETING

FAILED_DELETION

type -> (string)

The type of this data source.

Constraints:

min: 1

max: 256

updatedAt -> (timestamp)

The timestamp of when this data source was updated.

Table of Contents

Feedback

User Guide

delete-data-source¶

Description¶

Synopsis¶

Options¶

Global Options¶

Output¶

Note

Note

Note