2024/04/03 - Amazon DataZone - 4 new10 updated api methods
Changes This release supports the feature of dataQuality to enrich asset with dataQualityResult in Amazon DataZone.
Lists time series data points.
See also: AWS API Documentation
Request Syntax
client.list_time_series_data_points(
domainIdentifier='string',
endedAt=datetime(2015, 1, 1),
entityIdentifier='string',
entityType='ASSET'|'LISTING',
formName='string',
maxResults=123,
nextToken='string',
startedAt=datetime(2015, 1, 1)
)
string
[REQUIRED]
The ID of the Amazon DataZone domain that houses the assets for which you want to list time series data points.
datetime
The timestamp at which the data points that you wanted to list ended.
string
[REQUIRED]
The ID of the asset for which you want to list data points.
string
[REQUIRED]
The type of the asset for which you want to list data points.
string
[REQUIRED]
The name of the time series data points form.
integer
The maximum number of data points to return in a single call to ListTimeSeriesDataPoints. When the number of data points to be listed is greater than the value of MaxResults, the response contains a NextToken value that you can use in a subsequent call to ListTimeSeriesDataPoints to list the next set of data points.
string
When the number of data points is greater than the default value for the MaxResults parameter, or if you explicitly specify a value for MaxResults that is less than the number of data points, the response includes a pagination token named NextToken. You can specify this NextToken value in a subsequent call to ListTimeSeriesDataPoints to list the next set of data points.
datetime
The timestamp at which the data points that you want to list started.
dict
Response Syntax
{
'items': [
{
'contentSummary': 'string',
'formName': 'string',
'id': 'string',
'timestamp': datetime(2015, 1, 1),
'typeIdentifier': 'string',
'typeRevision': 'string'
},
],
'nextToken': 'string'
}
Response Structure
(dict) --
items (list) --
The results of the ListTimeSeriesDataPoints action.
(dict) --
The summary of the time series data points form.
contentSummary (string) --
The content of the summary of the time series data points form.
formName (string) --
The name of the time series data points summary form.
id (string) --
The ID of the time series data points summary form.
timestamp (datetime) --
The timestamp of the time series data points summary form.
typeIdentifier (string) --
The type ID of the time series data points summary form.
typeRevision (string) --
The type revision of the time series data points summary form.
nextToken (string) --
When the number of data points is greater than the default value for the MaxResults parameter, or if you explicitly specify a value for MaxResults that is less than the number of data points, the response includes a pagination token named NextToken. You can specify this NextToken value in a subsequent call to ListTimeSeriesDataPoints to list the next set of data points.
Gets the existing data point for the asset.
See also: AWS API Documentation
Request Syntax
client.get_time_series_data_point(
domainIdentifier='string',
entityIdentifier='string',
entityType='ASSET'|'LISTING',
formName='string',
identifier='string'
)
string
[REQUIRED]
The ID of the Amazon DataZone domain that houses the asset for which you want to get the data point.
string
[REQUIRED]
The ID of the asset for which you want to get the data point.
string
[REQUIRED]
The type of the asset for which you want to get the data point.
string
[REQUIRED]
The name of the time series form that houses the data point that you want to get.
string
[REQUIRED]
The ID of the data point that you want to get.
dict
Response Syntax
{
'domainId': 'string',
'entityId': 'string',
'entityType': 'ASSET'|'LISTING',
'form': {
'content': 'string',
'formName': 'string',
'id': 'string',
'timestamp': datetime(2015, 1, 1),
'typeIdentifier': 'string',
'typeRevision': 'string'
},
'formName': 'string'
}
Response Structure
(dict) --
domainId (string) --
The ID of the Amazon DataZone domain that houses the asset data point that you want to get.
entityId (string) --
The ID of the asset for which you want to get the data point.
entityType (string) --
The type of the asset for which you want to get the data point.
form (dict) --
The time series form that houses the data point that you want to get.
content (string) --
The content of the time series data points form.
formName (string) --
The name of the time series data points form.
id (string) --
The ID of the time series data points form.
timestamp (datetime) --
The timestamp of the time series data points form.
typeIdentifier (string) --
The ID of the type of the time series data points form.
typeRevision (string) --
The revision type of the time series data points form.
formName (string) --
The name of the time series form that houses the data point that you want to get.
Posts time series data points to Amazon DataZone for the specified asset.
See also: AWS API Documentation
Request Syntax
client.post_time_series_data_points(
clientToken='string',
domainIdentifier='string',
entityIdentifier='string',
entityType='ASSET'|'LISTING',
forms=[
{
'content': 'string',
'formName': 'string',
'timestamp': datetime(2015, 1, 1),
'typeIdentifier': 'string',
'typeRevision': 'string'
},
]
)
string
A unique, case-sensitive identifier that is provided to ensure the idempotency of the request.
This field is autopopulated if not provided.
string
[REQUIRED]
The ID of the Amazon DataZone domain in which you want to post time series data points.
string
[REQUIRED]
The ID of the asset for which you want to post time series data points.
string
[REQUIRED]
The type of the asset for which you want to post data points.
list
[REQUIRED]
The forms that contain the data points that you want to post.
(dict) --
The time series data points form.
content (string) --
The content of the time series data points form.
formName (string) -- [REQUIRED]
The name of the time series data points form.
timestamp (datetime) -- [REQUIRED]
The timestamp of the time series data points form.
typeIdentifier (string) -- [REQUIRED]
The ID of the type of the time series data points form.
typeRevision (string) --
The revision type of the time series data points form.
dict
Response Syntax
{
'domainId': 'string',
'entityId': 'string',
'entityType': 'ASSET'|'LISTING',
'forms': [
{
'content': 'string',
'formName': 'string',
'id': 'string',
'timestamp': datetime(2015, 1, 1),
'typeIdentifier': 'string',
'typeRevision': 'string'
},
]
}
Response Structure
(dict) --
domainId (string) --
The ID of the Amazon DataZone domain in which you want to post time series data points.
entityId (string) --
The ID of the asset for which you want to post time series data points.
entityType (string) --
The type of the asset for which you want to post data points.
forms (list) --
The forms that contain the data points that you have posted.
(dict) --
The time series data points form.
content (string) --
The content of the time series data points form.
formName (string) --
The name of the time series data points form.
id (string) --
The ID of the time series data points form.
timestamp (datetime) --
The timestamp of the time series data points form.
typeIdentifier (string) --
The ID of the type of the time series data points form.
typeRevision (string) --
The revision type of the time series data points form.
Deletes the specified time series form for the specified asset.
See also: AWS API Documentation
Request Syntax
client.delete_time_series_data_points(
clientToken='string',
domainIdentifier='string',
entityIdentifier='string',
entityType='ASSET'|'LISTING',
formName='string'
)
string
A unique, case-sensitive identifier to ensure idempotency of the request. This field is automatically populated if not provided.
This field is autopopulated if not provided.
string
[REQUIRED]
The ID of the Amazon DataZone domain that houses the asset for which you want to delete a time series form.
string
[REQUIRED]
The ID of the asset for which you want to delete a time series form.
string
[REQUIRED]
The type of the asset for which you want to delete a time series form.
string
[REQUIRED]
The name of the time series form that you want to delete.
dict
Response Syntax
{}
Response Structure
(dict) --
{'latestTimeSeriesDataPointFormsOutput': [{'contentSummary': 'string',
'formName': 'string',
'id': 'string',
'timestamp': 'timestamp',
'typeIdentifier': 'string',
'typeRevision': 'string'}]}
Creates an asset in Amazon DataZone catalog.
See also: AWS API Documentation
Request Syntax
client.create_asset(
clientToken='string',
description='string',
domainIdentifier='string',
externalIdentifier='string',
formsInput=[
{
'content': 'string',
'formName': 'string',
'typeIdentifier': 'string',
'typeRevision': 'string'
},
],
glossaryTerms=[
'string',
],
name='string',
owningProjectIdentifier='string',
predictionConfiguration={
'businessNameGeneration': {
'enabled': True|False
}
},
typeIdentifier='string',
typeRevision='string'
)
string
A unique, case-sensitive identifier that is provided to ensure the idempotency of the request.
This field is autopopulated if not provided.
string
Asset description.
string
[REQUIRED]
Amazon DataZone domain where the asset is created.
string
The external identifier of the asset.
list
Metadata forms attached to the asset.
(dict) --
The details of a metadata form.
content (string) --
The content of the metadata form.
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.
list
Glossary terms attached to the asset.
(string) --
string
[REQUIRED]
Asset name.
string
[REQUIRED]
The unique identifier of the project that owns this asset.
dict
The configuration of the automatically generated business-friendly metadata for the asset.
businessNameGeneration (dict) --
The business name generation mechanism.
enabled (boolean) --
Specifies whether the business name generation is enabled.
string
[REQUIRED]
The unique identifier of this asset's type.
string
The revision of this asset's type.
dict
Response Syntax
{
'createdAt': datetime(2015, 1, 1),
'createdBy': 'string',
'description': 'string',
'domainId': 'string',
'externalIdentifier': 'string',
'firstRevisionCreatedAt': datetime(2015, 1, 1),
'firstRevisionCreatedBy': 'string',
'formsOutput': [
{
'content': 'string',
'formName': 'string',
'typeName': 'string',
'typeRevision': 'string'
},
],
'glossaryTerms': [
'string',
],
'id': 'string',
'latestTimeSeriesDataPointFormsOutput': [
{
'contentSummary': 'string',
'formName': 'string',
'id': 'string',
'timestamp': datetime(2015, 1, 1),
'typeIdentifier': 'string',
'typeRevision': 'string'
},
],
'listing': {
'listingId': 'string',
'listingStatus': 'CREATING'|'ACTIVE'|'INACTIVE'
},
'name': 'string',
'owningProjectId': 'string',
'predictionConfiguration': {
'businessNameGeneration': {
'enabled': True|False
}
},
'readOnlyFormsOutput': [
{
'content': 'string',
'formName': 'string',
'typeName': 'string',
'typeRevision': 'string'
},
],
'revision': 'string',
'typeIdentifier': 'string',
'typeRevision': 'string'
}
Response Structure
(dict) --
createdAt (datetime) --
The timestamp of when the asset was created.
createdBy (string) --
The Amazon DataZone user that created this asset in the catalog.
description (string) --
The description of the created asset.
domainId (string) --
The ID of the Amazon DataZone domain in which the asset was created.
externalIdentifier (string) --
The external identifier of the asset.
firstRevisionCreatedAt (datetime) --
The timestamp of when the first revision of the asset took place.
firstRevisionCreatedBy (string) --
The Amazon DataZone user that made the first revision of the asset.
formsOutput (list) --
The metadata forms that are attached to the created asset.
(dict) --
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.
glossaryTerms (list) --
The glossary terms that are attached to the created asset.
(string) --
id (string) --
The unique identifier of the created asset.
latestTimeSeriesDataPointFormsOutput (list) --
The latest data point that was imported into the time series form for the asset.
(dict) --
The summary of the time series data points form.
contentSummary (string) --
The content of the summary of the time series data points form.
formName (string) --
The name of the time series data points summary form.
id (string) --
The ID of the time series data points summary form.
timestamp (datetime) --
The timestamp of the time series data points summary form.
typeIdentifier (string) --
The type ID of the time series data points summary form.
typeRevision (string) --
The type revision of the time series data points summary form.
listing (dict) --
The details of an asset published in an Amazon DataZone catalog.
listingId (string) --
The identifier of an asset published in an Amazon DataZone catalog.
listingStatus (string) --
The status of an asset published in an Amazon DataZone catalog.
name (string) --
The name of the created asset.
owningProjectId (string) --
The ID of the Amazon DataZone project that owns the created asset.
predictionConfiguration (dict) --
The configuration of the automatically generated business-friendly metadata for the asset.
businessNameGeneration (dict) --
The business name generation mechanism.
enabled (boolean) --
Specifies whether the business name generation is enabled.
readOnlyFormsOutput (list) --
The read-only metadata forms that are attached to the created asset.
(dict) --
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.
revision (string) --
The revision of the asset.
typeIdentifier (string) --
The identifier of the created asset type.
typeRevision (string) --
The revision type of the asset.
{'latestTimeSeriesDataPointFormsOutput': [{'contentSummary': 'string',
'formName': 'string',
'id': 'string',
'timestamp': 'timestamp',
'typeIdentifier': 'string',
'typeRevision': 'string'}]}
Creates a revision of the asset.
See also: AWS API Documentation
Request Syntax
client.create_asset_revision(
clientToken='string',
description='string',
domainIdentifier='string',
formsInput=[
{
'content': 'string',
'formName': 'string',
'typeIdentifier': 'string',
'typeRevision': 'string'
},
],
glossaryTerms=[
'string',
],
identifier='string',
name='string',
predictionConfiguration={
'businessNameGeneration': {
'enabled': True|False
}
},
typeRevision='string'
)
string
A unique, case-sensitive identifier that is provided to ensure the idempotency of the request.
This field is autopopulated if not provided.
string
The revised description of the asset.
string
[REQUIRED]
The unique identifier of the domain where the asset is being revised.
list
The metadata forms to be attached to the asset as part of asset revision.
(dict) --
The details of a metadata form.
content (string) --
The content of the metadata form.
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.
list
The glossary terms to be attached to the asset as part of asset revision.
(string) --
string
[REQUIRED]
The identifier of the asset.
string
[REQUIRED]
Te revised name of the asset.
dict
The configuration of the automatically generated business-friendly metadata for the asset.
businessNameGeneration (dict) --
The business name generation mechanism.
enabled (boolean) --
Specifies whether the business name generation is enabled.
string
The revision type of the asset.
dict
Response Syntax
{
'createdAt': datetime(2015, 1, 1),
'createdBy': 'string',
'description': 'string',
'domainId': 'string',
'externalIdentifier': 'string',
'firstRevisionCreatedAt': datetime(2015, 1, 1),
'firstRevisionCreatedBy': 'string',
'formsOutput': [
{
'content': 'string',
'formName': 'string',
'typeName': 'string',
'typeRevision': 'string'
},
],
'glossaryTerms': [
'string',
],
'id': 'string',
'latestTimeSeriesDataPointFormsOutput': [
{
'contentSummary': 'string',
'formName': 'string',
'id': 'string',
'timestamp': datetime(2015, 1, 1),
'typeIdentifier': 'string',
'typeRevision': 'string'
},
],
'listing': {
'listingId': 'string',
'listingStatus': 'CREATING'|'ACTIVE'|'INACTIVE'
},
'name': 'string',
'owningProjectId': 'string',
'predictionConfiguration': {
'businessNameGeneration': {
'enabled': True|False
}
},
'readOnlyFormsOutput': [
{
'content': 'string',
'formName': 'string',
'typeName': 'string',
'typeRevision': 'string'
},
],
'revision': 'string',
'typeIdentifier': 'string',
'typeRevision': 'string'
}
Response Structure
(dict) --
createdAt (datetime) --
The timestamp of when the asset revision occured.
createdBy (string) --
The Amazon DataZone user who performed the asset revision.
description (string) --
The revised asset description.
domainId (string) --
The unique identifier of the Amazon DataZone domain where the asset was revised.
externalIdentifier (string) --
The external identifier of the asset.
firstRevisionCreatedAt (datetime) --
The timestamp of when the first asset revision occured.
firstRevisionCreatedBy (string) --
The Amazon DataZone user who performed the first asset revision.
formsOutput (list) --
The metadata forms that were attached to the asset as part of the asset revision.
(dict) --
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.
glossaryTerms (list) --
The glossary terms that were attached to the asset as part of asset revision.
(string) --
id (string) --
The unique identifier of the asset revision.
latestTimeSeriesDataPointFormsOutput (list) --
The latest data point that was imported into the time series form for the asset.
(dict) --
The summary of the time series data points form.
contentSummary (string) --
The content of the summary of the time series data points form.
formName (string) --
The name of the time series data points summary form.
id (string) --
The ID of the time series data points summary form.
timestamp (datetime) --
The timestamp of the time series data points summary form.
typeIdentifier (string) --
The type ID of the time series data points summary form.
typeRevision (string) --
The type revision of the time series data points summary form.
listing (dict) --
The details of an asset published in an Amazon DataZone catalog.
listingId (string) --
The identifier of an asset published in an Amazon DataZone catalog.
listingStatus (string) --
The status of an asset published in an Amazon DataZone catalog.
name (string) --
The revised name of the asset.
owningProjectId (string) --
The unique identifier of the revised project that owns the asset.
predictionConfiguration (dict) --
The configuration of the automatically generated business-friendly metadata for the asset.
businessNameGeneration (dict) --
The business name generation mechanism.
enabled (boolean) --
Specifies whether the business name generation is enabled.
readOnlyFormsOutput (list) --
The read-only metadata forms that were attached to the asset as part of the asset revision.
(dict) --
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.
revision (string) --
The revision of the asset.
typeIdentifier (string) --
The identifier of the revision type.
typeRevision (string) --
The revision type of the asset.
{'configuration': {'glueRunConfiguration': {'autoImportDataQualityResult': 'boolean'}}}
Creates an Amazon DataZone data source.
See also: AWS API Documentation
Request Syntax
client.create_data_source(
assetFormsInput=[
{
'content': 'string',
'formName': 'string',
'typeIdentifier': 'string',
'typeRevision': 'string'
},
],
clientToken='string',
configuration={
'glueRunConfiguration': {
'autoImportDataQualityResult': True|False,
'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'
},
]
}
},
description='string',
domainIdentifier='string',
enableSetting='ENABLED'|'DISABLED',
environmentIdentifier='string',
name='string',
projectIdentifier='string',
publishOnImport=True|False,
recommendation={
'enableBusinessNameGeneration': True|False
},
schedule={
'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'
},
type='string'
)
list
The metadata forms that are to be attached to the assets that this data source works with.
(dict) --
The details of a metadata form.
content (string) --
The content of the metadata form.
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.
string
A unique, case-sensitive identifier that is provided to ensure the idempotency of the request.
This field is autopopulated if not provided.
dict
Specifies the configuration of the data source. It can be set to either glueRunConfiguration or redshiftRunConfiguration.
glueRunConfiguration (dict) --
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.
dataAccessRole (string) --
The data access role included in the configuration details of the Amazon Web Services Glue data source.
relationalFilterConfigurations (list) -- [REQUIRED]
The relational filter configurations included in the configuration details of the Amazon Web Services Glue data source.
(dict) --
The relational filter configuration for the data source.
databaseName (string) -- [REQUIRED]
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.
(dict) --
A filter expression in Amazon DataZone.
expression (string) -- [REQUIRED]
The search filter expression.
type (string) -- [REQUIRED]
The search filter explresison type.
schemaName (string) --
The schema name specified in the relational filter configuration for the data source.
redshiftRunConfiguration (dict) --
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 (dict) -- [REQUIRED]
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 (dict) -- [REQUIRED]
The details of the Amazon Redshift storage as part of the configuration of an Amazon Redshift data source run.
redshiftClusterSource (dict) --
The details of the Amazon Redshift cluster source.
clusterName (string) -- [REQUIRED]
The name of an Amazon Redshift cluster.
redshiftServerlessSource (dict) --
The details of the Amazon Redshift Serverless workgroup source.
workgroupName (string) -- [REQUIRED]
The name of the Amazon Redshift Serverless workgroup.
relationalFilterConfigurations (list) -- [REQUIRED]
The relational filger configurations included in the configuration details of the Amazon Redshift data source.
(dict) --
The relational filter configuration for the data source.
databaseName (string) -- [REQUIRED]
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.
(dict) --
A filter expression in Amazon DataZone.
expression (string) -- [REQUIRED]
The search filter expression.
type (string) -- [REQUIRED]
The search filter explresison type.
schemaName (string) --
The schema name specified in the relational filter configuration for the data source.
string
The description of the data source.
string
[REQUIRED]
The ID of the Amazon DataZone domain where the data source is created.
string
Specifies whether the data source is enabled.
string
[REQUIRED]
The unique identifier of the Amazon DataZone environment to which the data source publishes assets.
string
[REQUIRED]
The name of the data source.
string
[REQUIRED]
The identifier of the Amazon DataZone project in which you want to add this data source.
boolean
Specifies whether the assets that this data source creates in the inventory are to be also automatically published to the catalog.
dict
Specifies whether the business name generation is to be enabled for this data source.
enableBusinessNameGeneration (boolean) --
Specifies whether automatic business name generation is to be enabled or not as part of the recommendation configuration.
dict
The schedule of the data source runs.
schedule (string) --
The schedule of the data source runs.
timezone (string) --
The timezone of the data source run.
string
[REQUIRED]
The type of the data source.
dict
Response Syntax
{
'assetFormsOutput': [
{
'content': 'string',
'formName': 'string',
'typeName': 'string',
'typeRevision': 'string'
},
],
'configuration': {
'glueRunConfiguration': {
'accountId': 'string',
'autoImportDataQualityResult': True|False,
'dataAccessRole': 'string',
'region': 'string',
'relationalFilterConfigurations': [
{
'databaseName': 'string',
'filterExpressions': [
{
'expression': 'string',
'type': 'INCLUDE'|'EXCLUDE'
},
],
'schemaName': 'string'
},
]
},
'redshiftRunConfiguration': {
'accountId': 'string',
'dataAccessRole': 'string',
'redshiftCredentialConfiguration': {
'secretManagerArn': 'string'
},
'redshiftStorage': {
'redshiftClusterSource': {
'clusterName': 'string'
},
'redshiftServerlessSource': {
'workgroupName': 'string'
}
},
'region': 'string',
'relationalFilterConfigurations': [
{
'databaseName': 'string',
'filterExpressions': [
{
'expression': 'string',
'type': 'INCLUDE'|'EXCLUDE'
},
],
'schemaName': 'string'
},
]
}
},
'createdAt': datetime(2015, 1, 1),
'description': 'string',
'domainId': 'string',
'enableSetting': 'ENABLED'|'DISABLED',
'environmentId': 'string',
'errorMessage': {
'errorDetail': 'string',
'errorType': 'ACCESS_DENIED_EXCEPTION'|'CONFLICT_EXCEPTION'|'INTERNAL_SERVER_EXCEPTION'|'RESOURCE_NOT_FOUND_EXCEPTION'|'SERVICE_QUOTA_EXCEEDED_EXCEPTION'|'THROTTLING_EXCEPTION'|'VALIDATION_EXCEPTION'
},
'id': 'string',
'lastRunAt': datetime(2015, 1, 1),
'lastRunErrorMessage': {
'errorDetail': 'string',
'errorType': 'ACCESS_DENIED_EXCEPTION'|'CONFLICT_EXCEPTION'|'INTERNAL_SERVER_EXCEPTION'|'RESOURCE_NOT_FOUND_EXCEPTION'|'SERVICE_QUOTA_EXCEEDED_EXCEPTION'|'THROTTLING_EXCEPTION'|'VALIDATION_EXCEPTION'
},
'lastRunStatus': 'REQUESTED'|'RUNNING'|'FAILED'|'PARTIALLY_SUCCEEDED'|'SUCCESS',
'name': 'string',
'projectId': 'string',
'publishOnImport': True|False,
'recommendation': {
'enableBusinessNameGeneration': True|False
},
'schedule': {
'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'
},
'status': 'CREATING'|'FAILED_CREATION'|'READY'|'UPDATING'|'FAILED_UPDATE'|'RUNNING'|'DELETING'|'FAILED_DELETION',
'type': 'string',
'updatedAt': datetime(2015, 1, 1)
}
Response Structure
(dict) --
assetFormsOutput (list) --
The metadata forms attached to the assets that this data source creates.
(dict) --
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 (dict) --
Specifies the configuration of the data source. It can be set to either glueRunConfiguration or redshiftRunConfiguration.
glueRunConfiguration (dict) --
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.
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.
(dict) --
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.
(dict) --
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 (dict) --
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 (dict) --
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 (dict) --
The details of the Amazon Redshift storage as part of the configuration of an Amazon Redshift data source run.
redshiftClusterSource (dict) --
The details of the Amazon Redshift cluster source.
clusterName (string) --
The name of an Amazon Redshift cluster.
redshiftServerlessSource (dict) --
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.
(dict) --
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.
(dict) --
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.
createdAt (datetime) --
The timestamp of when the data source was created.
description (string) --
The description of the data source.
domainId (string) --
The ID of the Amazon DataZone domain in which the data source is created.
enableSetting (string) --
Specifies whether the data source is enabled.
environmentId (string) --
The unique identifier of the Amazon DataZone environment to which the data source publishes assets.
errorMessage (dict) --
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 unique identifier of the data source.
lastRunAt (datetime) --
The timestamp that specifies when the data source was last run.
lastRunErrorMessage (dict) --
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.
lastRunStatus (string) --
The status of the last run of this data source.
name (string) --
The name of the data source.
projectId (string) --
The ID of the Amazon DataZone project to which the data source is added.
publishOnImport (boolean) --
Specifies whether the assets that this data source creates in the inventory are to be also automatically published to the catalog.
recommendation (dict) --
Specifies whether the business name generation is to be enabled for this data source.
enableBusinessNameGeneration (boolean) --
Specifies whether automatic business name generation is to be enabled or not as part of the recommendation configuration.
schedule (dict) --
The schedule of the data source runs.
schedule (string) --
The schedule of the data source runs.
timezone (string) --
The timezone of the data source run.
status (string) --
The status of the data source.
type (string) --
The type of the data source.
updatedAt (datetime) --
The timestamp of when the data source was updated.
{'configuration': {'glueRunConfiguration': {'autoImportDataQualityResult': 'boolean'}}}
Deletes a data source in Amazon DataZone.
See also: AWS API Documentation
Request Syntax
client.delete_data_source(
clientToken='string',
domainIdentifier='string',
identifier='string'
)
string
A unique, case-sensitive identifier that is provided to ensure the idempotency of the request.
This field is autopopulated if not provided.
string
[REQUIRED]
The ID of the Amazon DataZone domain in which the data source is deleted.
string
[REQUIRED]
The identifier of the data source that is deleted.
dict
Response Syntax
{
'assetFormsOutput': [
{
'content': 'string',
'formName': 'string',
'typeName': 'string',
'typeRevision': 'string'
},
],
'configuration': {
'glueRunConfiguration': {
'accountId': 'string',
'autoImportDataQualityResult': True|False,
'dataAccessRole': 'string',
'region': 'string',
'relationalFilterConfigurations': [
{
'databaseName': 'string',
'filterExpressions': [
{
'expression': 'string',
'type': 'INCLUDE'|'EXCLUDE'
},
],
'schemaName': 'string'
},
]
},
'redshiftRunConfiguration': {
'accountId': 'string',
'dataAccessRole': 'string',
'redshiftCredentialConfiguration': {
'secretManagerArn': 'string'
},
'redshiftStorage': {
'redshiftClusterSource': {
'clusterName': 'string'
},
'redshiftServerlessSource': {
'workgroupName': 'string'
}
},
'region': 'string',
'relationalFilterConfigurations': [
{
'databaseName': 'string',
'filterExpressions': [
{
'expression': 'string',
'type': 'INCLUDE'|'EXCLUDE'
},
],
'schemaName': 'string'
},
]
}
},
'createdAt': datetime(2015, 1, 1),
'description': 'string',
'domainId': 'string',
'enableSetting': 'ENABLED'|'DISABLED',
'environmentId': 'string',
'errorMessage': {
'errorDetail': 'string',
'errorType': 'ACCESS_DENIED_EXCEPTION'|'CONFLICT_EXCEPTION'|'INTERNAL_SERVER_EXCEPTION'|'RESOURCE_NOT_FOUND_EXCEPTION'|'SERVICE_QUOTA_EXCEEDED_EXCEPTION'|'THROTTLING_EXCEPTION'|'VALIDATION_EXCEPTION'
},
'id': 'string',
'lastRunAt': datetime(2015, 1, 1),
'lastRunErrorMessage': {
'errorDetail': 'string',
'errorType': 'ACCESS_DENIED_EXCEPTION'|'CONFLICT_EXCEPTION'|'INTERNAL_SERVER_EXCEPTION'|'RESOURCE_NOT_FOUND_EXCEPTION'|'SERVICE_QUOTA_EXCEEDED_EXCEPTION'|'THROTTLING_EXCEPTION'|'VALIDATION_EXCEPTION'
},
'lastRunStatus': 'REQUESTED'|'RUNNING'|'FAILED'|'PARTIALLY_SUCCEEDED'|'SUCCESS',
'name': 'string',
'projectId': 'string',
'publishOnImport': True|False,
'schedule': {
'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'
},
'status': 'CREATING'|'FAILED_CREATION'|'READY'|'UPDATING'|'FAILED_UPDATE'|'RUNNING'|'DELETING'|'FAILED_DELETION',
'type': 'string',
'updatedAt': datetime(2015, 1, 1)
}
Response Structure
(dict) --
assetFormsOutput (list) --
The asset data forms associated with this data source.
(dict) --
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 (dict) --
The configuration of the data source that is deleted.
glueRunConfiguration (dict) --
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.
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.
(dict) --
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.
(dict) --
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 (dict) --
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 (dict) --
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 (dict) --
The details of the Amazon Redshift storage as part of the configuration of an Amazon Redshift data source run.
redshiftClusterSource (dict) --
The details of the Amazon Redshift cluster source.
clusterName (string) --
The name of an Amazon Redshift cluster.
redshiftServerlessSource (dict) --
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.
(dict) --
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.
(dict) --
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.
createdAt (datetime) --
The timestamp of when this data source was created.
description (string) --
The description of the data source that is deleted.
domainId (string) --
The ID of the Amazon DataZone domain in which the data source is deleted.
enableSetting (string) --
The enable setting of the data source that specifies whether the data source is enabled or disabled.
environmentId (string) --
The ID of the environemnt associated with this data source.
errorMessage (dict) --
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 ID of the data source that is deleted.
lastRunAt (datetime) --
The timestamp of when the data source was last run.
lastRunErrorMessage (dict) --
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.
lastRunStatus (string) --
The status of the last run of this data source.
name (string) --
The name of the data source that is deleted.
projectId (string) --
The ID of the project in which this data source exists and from which it's deleted.
publishOnImport (boolean) --
Specifies whether the assets that this data source creates in the inventory are to be also automatically published to the catalog.
schedule (dict) --
The schedule of runs for this data source.
schedule (string) --
The schedule of the data source runs.
timezone (string) --
The timezone of the data source run.
status (string) --
The status of this data source.
type (string) --
The type of this data source.
updatedAt (datetime) --
The timestamp of when this data source was updated.
{'latestTimeSeriesDataPointFormsOutput': [{'contentSummary': 'string',
'formName': 'string',
'id': 'string',
'timestamp': 'timestamp',
'typeIdentifier': 'string',
'typeRevision': 'string'}]}
Gets an Amazon DataZone asset.
See also: AWS API Documentation
Request Syntax
client.get_asset(
domainIdentifier='string',
identifier='string',
revision='string'
)
string
[REQUIRED]
The ID of the Amazon DataZone domain to which the asset belongs.
string
[REQUIRED]
The ID of the Amazon DataZone asset.
string
The revision of the Amazon DataZone asset.
dict
Response Syntax
{
'createdAt': datetime(2015, 1, 1),
'createdBy': 'string',
'description': 'string',
'domainId': 'string',
'externalIdentifier': 'string',
'firstRevisionCreatedAt': datetime(2015, 1, 1),
'firstRevisionCreatedBy': 'string',
'formsOutput': [
{
'content': 'string',
'formName': 'string',
'typeName': 'string',
'typeRevision': 'string'
},
],
'glossaryTerms': [
'string',
],
'id': 'string',
'latestTimeSeriesDataPointFormsOutput': [
{
'contentSummary': 'string',
'formName': 'string',
'id': 'string',
'timestamp': datetime(2015, 1, 1),
'typeIdentifier': 'string',
'typeRevision': 'string'
},
],
'listing': {
'listingId': 'string',
'listingStatus': 'CREATING'|'ACTIVE'|'INACTIVE'
},
'name': 'string',
'owningProjectId': 'string',
'readOnlyFormsOutput': [
{
'content': 'string',
'formName': 'string',
'typeName': 'string',
'typeRevision': 'string'
},
],
'revision': 'string',
'typeIdentifier': 'string',
'typeRevision': 'string'
}
Response Structure
(dict) --
createdAt (datetime) --
The timestamp of when the asset was created.
createdBy (string) --
The Amazon DataZone user who created the asset.
description (string) --
The description of the Amazon DataZone asset.
domainId (string) --
The ID of the Amazon DataZone domain to which the asset belongs.
externalIdentifier (string) --
The external ID of the asset.
firstRevisionCreatedAt (datetime) --
The timestamp of when the first revision of the asset was created.
firstRevisionCreatedBy (string) --
The Amazon DataZone user who created the first revision of the asset.
formsOutput (list) --
The metadata forms attached to the asset.
(dict) --
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.
glossaryTerms (list) --
The business glossary terms attached to the asset.
(string) --
id (string) --
The ID of the asset.
latestTimeSeriesDataPointFormsOutput (list) --
The latest data point that was imported into the time series form for the asset.
(dict) --
The summary of the time series data points form.
contentSummary (string) --
The content of the summary of the time series data points form.
formName (string) --
The name of the time series data points summary form.
id (string) --
The ID of the time series data points summary form.
timestamp (datetime) --
The timestamp of the time series data points summary form.
typeIdentifier (string) --
The type ID of the time series data points summary form.
typeRevision (string) --
The type revision of the time series data points summary form.
listing (dict) --
The listing of the asset.
listingId (string) --
The identifier of an asset published in an Amazon DataZone catalog.
listingStatus (string) --
The status of an asset published in an Amazon DataZone catalog.
name (string) --
The name of the asset.
owningProjectId (string) --
The ID of the project that owns the asset.
readOnlyFormsOutput (list) --
The read-only metadata forms attached to the asset.
(dict) --
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.
revision (string) --
The revision of the asset.
typeIdentifier (string) --
The ID of the asset type.
typeRevision (string) --
The revision of the asset type.
{'configuration': {'glueRunConfiguration': {'autoImportDataQualityResult': 'boolean'}}}
Gets an Amazon DataZone data source.
See also: AWS API Documentation
Request Syntax
client.get_data_source(
domainIdentifier='string',
identifier='string'
)
string
[REQUIRED]
The ID of the Amazon DataZone domain in which the data source exists.
string
[REQUIRED]
The ID of the Amazon DataZone data source.
dict
Response Syntax
{
'assetFormsOutput': [
{
'content': 'string',
'formName': 'string',
'typeName': 'string',
'typeRevision': 'string'
},
],
'configuration': {
'glueRunConfiguration': {
'accountId': 'string',
'autoImportDataQualityResult': True|False,
'dataAccessRole': 'string',
'region': 'string',
'relationalFilterConfigurations': [
{
'databaseName': 'string',
'filterExpressions': [
{
'expression': 'string',
'type': 'INCLUDE'|'EXCLUDE'
},
],
'schemaName': 'string'
},
]
},
'redshiftRunConfiguration': {
'accountId': 'string',
'dataAccessRole': 'string',
'redshiftCredentialConfiguration': {
'secretManagerArn': 'string'
},
'redshiftStorage': {
'redshiftClusterSource': {
'clusterName': 'string'
},
'redshiftServerlessSource': {
'workgroupName': 'string'
}
},
'region': 'string',
'relationalFilterConfigurations': [
{
'databaseName': 'string',
'filterExpressions': [
{
'expression': 'string',
'type': 'INCLUDE'|'EXCLUDE'
},
],
'schemaName': 'string'
},
]
}
},
'createdAt': datetime(2015, 1, 1),
'description': 'string',
'domainId': 'string',
'enableSetting': 'ENABLED'|'DISABLED',
'environmentId': 'string',
'errorMessage': {
'errorDetail': 'string',
'errorType': 'ACCESS_DENIED_EXCEPTION'|'CONFLICT_EXCEPTION'|'INTERNAL_SERVER_EXCEPTION'|'RESOURCE_NOT_FOUND_EXCEPTION'|'SERVICE_QUOTA_EXCEEDED_EXCEPTION'|'THROTTLING_EXCEPTION'|'VALIDATION_EXCEPTION'
},
'id': 'string',
'lastRunAssetCount': 123,
'lastRunAt': datetime(2015, 1, 1),
'lastRunErrorMessage': {
'errorDetail': 'string',
'errorType': 'ACCESS_DENIED_EXCEPTION'|'CONFLICT_EXCEPTION'|'INTERNAL_SERVER_EXCEPTION'|'RESOURCE_NOT_FOUND_EXCEPTION'|'SERVICE_QUOTA_EXCEEDED_EXCEPTION'|'THROTTLING_EXCEPTION'|'VALIDATION_EXCEPTION'
},
'lastRunStatus': 'REQUESTED'|'RUNNING'|'FAILED'|'PARTIALLY_SUCCEEDED'|'SUCCESS',
'name': 'string',
'projectId': 'string',
'publishOnImport': True|False,
'recommendation': {
'enableBusinessNameGeneration': True|False
},
'schedule': {
'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'
},
'status': 'CREATING'|'FAILED_CREATION'|'READY'|'UPDATING'|'FAILED_UPDATE'|'RUNNING'|'DELETING'|'FAILED_DELETION',
'type': 'string',
'updatedAt': datetime(2015, 1, 1)
}
Response Structure
(dict) --
assetFormsOutput (list) --
The metadata forms attached to the assets created by this data source.
(dict) --
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 (dict) --
The configuration of the data source.
glueRunConfiguration (dict) --
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.
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.
(dict) --
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.
(dict) --
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 (dict) --
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 (dict) --
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 (dict) --
The details of the Amazon Redshift storage as part of the configuration of an Amazon Redshift data source run.
redshiftClusterSource (dict) --
The details of the Amazon Redshift cluster source.
clusterName (string) --
The name of an Amazon Redshift cluster.
redshiftServerlessSource (dict) --
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.
(dict) --
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.
(dict) --
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.
createdAt (datetime) --
The timestamp of when the data source was created.
description (string) --
The description of the data source.
domainId (string) --
The ID of the Amazon DataZone domain in which the data source exists.
enableSetting (string) --
Specifies whether this data source is enabled or not.
environmentId (string) --
The ID of the environment where this data source creates and publishes assets,
errorMessage (dict) --
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 ID of the data source.
lastRunAssetCount (integer) --
The number of assets created by the data source during its last run.
lastRunAt (datetime) --
The timestamp of the last run of the data source.
lastRunErrorMessage (dict) --
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.
lastRunStatus (string) --
The status of the last run of the data source.
name (string) --
The name of the data source.
projectId (string) --
The ID of the project where the data source creates and publishes assets.
publishOnImport (boolean) --
Specifies whether the assets that this data source creates in the inventory are to be also automatically published to the catalog.
recommendation (dict) --
The recommendation configuration of the data source.
enableBusinessNameGeneration (boolean) --
Specifies whether automatic business name generation is to be enabled or not as part of the recommendation configuration.
schedule (dict) --
The schedule of the data source runs.
schedule (string) --
The schedule of the data source runs.
timezone (string) --
The timezone of the data source run.
status (string) --
The status of the data source.
type (string) --
The type of the data source.
updatedAt (datetime) --
The timestamp of when the data source was updated.
{'item': {'assetListing': {'latestTimeSeriesDataPointForms': [{'contentSummary': 'string',
'formName': 'string',
'id': 'string',
'timestamp': 'timestamp',
'typeIdentifier': 'string',
'typeRevision': 'string'}]}}}
Gets a listing (a record of an asset at a given time).
See also: AWS API Documentation
Request Syntax
client.get_listing(
domainIdentifier='string',
identifier='string',
listingRevision='string'
)
string
[REQUIRED]
The ID of the Amazon DataZone domain.
string
[REQUIRED]
The ID of the listing.
string
The revision of the listing.
dict
Response Syntax
{
'createdAt': datetime(2015, 1, 1),
'createdBy': 'string',
'description': 'string',
'domainId': 'string',
'id': 'string',
'item': {
'assetListing': {
'assetId': 'string',
'assetRevision': 'string',
'assetType': 'string',
'createdAt': datetime(2015, 1, 1),
'forms': 'string',
'glossaryTerms': [
{
'name': 'string',
'shortDescription': 'string'
},
],
'latestTimeSeriesDataPointForms': [
{
'contentSummary': 'string',
'formName': 'string',
'id': 'string',
'timestamp': datetime(2015, 1, 1),
'typeIdentifier': 'string',
'typeRevision': 'string'
},
],
'owningProjectId': 'string'
}
},
'listingRevision': 'string',
'name': 'string',
'status': 'CREATING'|'ACTIVE'|'INACTIVE',
'updatedAt': datetime(2015, 1, 1),
'updatedBy': 'string'
}
Response Structure
(dict) --
createdAt (datetime) --
The timestamp of when the listing was created.
createdBy (string) --
The Amazon DataZone user who created the listing.
description (string) --
The description of the listing.
domainId (string) --
The ID of the Amazon DataZone domain.
id (string) --
The ID of the listing.
item (dict) --
The details of a listing.
assetListing (dict) --
An asset published in an Amazon DataZone catalog.
assetId (string) --
The identifier of an asset published in an Amazon DataZone catalog.
assetRevision (string) --
The revision of an asset published in an Amazon DataZone catalog.
assetType (string) --
The type of an asset published in an Amazon DataZone catalog.
createdAt (datetime) --
The timestamp of when an asset published in an Amazon DataZone catalog was created.
forms (string) --
The metadata forms attached to an asset published in an Amazon DataZone catalog.
glossaryTerms (list) --
The glossary terms attached to an asset published in an Amazon DataZone catalog.
(dict) --
Details of a glossary term attached to the inventory asset.
name (string) --
The name of a glossary term attached to the inventory asset.
shortDescription (string) --
The shoft description of a glossary term attached to the inventory asset.
latestTimeSeriesDataPointForms (list) --
The latest time series data points forms included in the additional attributes of an asset.
(dict) --
The summary of the time series data points form.
contentSummary (string) --
The content of the summary of the time series data points form.
formName (string) --
The name of the time series data points summary form.
id (string) --
The ID of the time series data points summary form.
timestamp (datetime) --
The timestamp of the time series data points summary form.
typeIdentifier (string) --
The type ID of the time series data points summary form.
typeRevision (string) --
The type revision of the time series data points summary form.
owningProjectId (string) --
The identifier of the project where an asset published in an Amazon DataZone catalog exists.
listingRevision (string) --
The revision of a listing.
name (string) --
The name of the listing.
status (string) --
The status of the listing.
updatedAt (datetime) --
The timestamp of when the listing was updated.
updatedBy (string) --
The Amazon DataZone user who updated the listing.
{'additionalAttributes': {'TIME_SERIES_DATA_POINT_FORMS'}}
Response {'items': {'assetItem': {'additionalAttributes': {'latestTimeSeriesDataPointFormsOutput': [{'contentSummary': 'string',
'formName': 'string',
'id': 'string',
'timestamp': 'timestamp',
'typeIdentifier': 'string',
'typeRevision': 'string'}]}}}}
Searches for assets in Amazon DataZone.
See also: AWS API Documentation
Request Syntax
client.search(
additionalAttributes=[
'FORMS'|'TIME_SERIES_DATA_POINT_FORMS',
],
domainIdentifier='string',
filters={
'and': [
{'... recursive ...'},
],
'filter': {
'attribute': 'string',
'value': 'string'
},
'or': [
{'... recursive ...'},
]
},
maxResults=123,
nextToken='string',
owningProjectIdentifier='string',
searchIn=[
{
'attribute': 'string'
},
],
searchScope='ASSET'|'GLOSSARY'|'GLOSSARY_TERM',
searchText='string',
sort={
'attribute': 'string',
'order': 'ASCENDING'|'DESCENDING'
}
)
list
Specifies additional attributes for the Search action.
(string) --
string
[REQUIRED]
The identifier of the Amazon DataZone domain.
dict
Specifies the search filters.
and (list) --
The 'and' search filter clause in Amazon DataZone.
(dict) --
A search filter clause in Amazon DataZone.
filter (dict) --
A search filter in Amazon DataZone.
attribute (string) -- [REQUIRED]
A search filter attribute in Amazon DataZone.
value (string) -- [REQUIRED]
A search filter value in Amazon DataZone.
or (list) --
The 'or' search filter clause in Amazon DataZone.
(dict) --
A search filter clause in Amazon DataZone.
integer
The maximum number of results to return in a single call to Search. When the number of results to be listed is greater than the value of MaxResults, the response contains a NextToken value that you can use in a subsequent call to Search to list the next set of results.
string
When the number of results is greater than the default value for the MaxResults parameter, or if you explicitly specify a value for MaxResults that is less than the number of results, the response includes a pagination token named NextToken. You can specify this NextToken value in a subsequent call to Search to list the next set of results.
string
The identifier of the owning project specified for the search.
list
The details of the search.
(dict) --
The details of the search.
attribute (string) -- [REQUIRED]
The search attribute.
string
[REQUIRED]
The scope of the search.
string
Specifies the text for which to search.
dict
Specifies the way in which the search results are to be sorted.
attribute (string) -- [REQUIRED]
The attribute detail of the way to sort search results.
order (string) --
The order detail of the wya to sort search results.
dict
Response Syntax
{
'items': [
{
'assetItem': {
'additionalAttributes': {
'formsOutput': [
{
'content': 'string',
'formName': 'string',
'typeName': 'string',
'typeRevision': 'string'
},
],
'latestTimeSeriesDataPointFormsOutput': [
{
'contentSummary': 'string',
'formName': 'string',
'id': 'string',
'timestamp': datetime(2015, 1, 1),
'typeIdentifier': 'string',
'typeRevision': 'string'
},
],
'readOnlyFormsOutput': [
{
'content': 'string',
'formName': 'string',
'typeName': 'string',
'typeRevision': 'string'
},
]
},
'createdAt': datetime(2015, 1, 1),
'createdBy': 'string',
'description': 'string',
'domainId': 'string',
'externalIdentifier': 'string',
'firstRevisionCreatedAt': datetime(2015, 1, 1),
'firstRevisionCreatedBy': 'string',
'glossaryTerms': [
'string',
],
'identifier': 'string',
'name': 'string',
'owningProjectId': 'string',
'typeIdentifier': 'string',
'typeRevision': 'string'
},
'dataProductItem': {
'createdAt': datetime(2015, 1, 1),
'createdBy': 'string',
'dataProductItems': [
{
'domainId': 'string',
'itemId': 'string'
},
],
'description': 'string',
'domainId': 'string',
'glossaryTerms': [
'string',
],
'id': 'string',
'name': 'string',
'owningProjectId': 'string',
'updatedAt': datetime(2015, 1, 1),
'updatedBy': 'string'
},
'glossaryItem': {
'createdAt': datetime(2015, 1, 1),
'createdBy': 'string',
'description': 'string',
'domainId': 'string',
'id': 'string',
'name': 'string',
'owningProjectId': 'string',
'status': 'DISABLED'|'ENABLED',
'updatedAt': datetime(2015, 1, 1),
'updatedBy': 'string'
},
'glossaryTermItem': {
'createdAt': datetime(2015, 1, 1),
'createdBy': 'string',
'domainId': 'string',
'glossaryId': 'string',
'id': 'string',
'longDescription': 'string',
'name': 'string',
'shortDescription': 'string',
'status': 'ENABLED'|'DISABLED',
'termRelations': {
'classifies': [
'string',
],
'isA': [
'string',
]
},
'updatedAt': datetime(2015, 1, 1),
'updatedBy': 'string'
}
},
],
'nextToken': 'string',
'totalMatchCount': 123
}
Response Structure
(dict) --
items (list) --
The results of the Search action.
(dict) --
The details of the search results.
assetItem (dict) --
The asset item included in the search results.
additionalAttributes (dict) --
The additional attributes of a Amazon DataZone inventory asset.
formsOutput (list) --
The forms included in the additional attributes of an inventory asset.
(dict) --
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.
latestTimeSeriesDataPointFormsOutput (list) --
The latest time series data points forms included in the additional attributes of an asset.
(dict) --
The summary of the time series data points form.
contentSummary (string) --
The content of the summary of the time series data points form.
formName (string) --
The name of the time series data points summary form.
id (string) --
The ID of the time series data points summary form.
timestamp (datetime) --
The timestamp of the time series data points summary form.
typeIdentifier (string) --
The type ID of the time series data points summary form.
typeRevision (string) --
The type revision of the time series data points summary form.
readOnlyFormsOutput (list) --
The read-only forms included in the additional attributes of an inventory asset.
(dict) --
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.
createdAt (datetime) --
The timestamp of when the Amazon DataZone inventory asset was created.
createdBy (string) --
The Amazon DataZone user who created the inventory asset.
description (string) --
The description of an Amazon DataZone inventory asset.
domainId (string) --
The identifier of the Amazon DataZone domain in which the inventory asset exists.
externalIdentifier (string) --
The external identifier of the Amazon DataZone inventory asset.
firstRevisionCreatedAt (datetime) --
The timestamp of when the first revision of the inventory asset was created.
firstRevisionCreatedBy (string) --
The Amazon DataZone user who created the first revision of the inventory asset.
glossaryTerms (list) --
The glossary terms attached to the Amazon DataZone inventory asset.
(string) --
identifier (string) --
the identifier of the Amazon DataZone inventory asset.
name (string) --
The name of the Amazon DataZone inventory asset.
owningProjectId (string) --
The identifier of the Amazon DataZone project that owns the inventory asset.
typeIdentifier (string) --
The identifier of the asset type of the specified Amazon DataZone inventory asset.
typeRevision (string) --
The revision of the inventory asset type.
dataProductItem (dict) --
The data product item included in the search results.
createdAt (datetime) --
createdBy (string) --
dataProductItems (list) --
(dict) --
domainId (string) --
itemId (string) --
description (string) --
domainId (string) --
glossaryTerms (list) --
(string) --
id (string) --
name (string) --
owningProjectId (string) --
updatedAt (datetime) --
updatedBy (string) --
glossaryItem (dict) --
The glossary item included in the search results.
createdAt (datetime) --
The timestamp of when the glossary was created.
createdBy (string) --
The Amazon DataZone user who created the glossary.
description (string) --
The business glossary description.
domainId (string) --
The identifier of the Amazon DataZone domain in which the business glossary exists.
id (string) --
The identifier of the glossary.
name (string) --
The name of the glossary.
owningProjectId (string) --
The identifier of the project that owns the business glosary.
status (string) --
The business glossary status.
updatedAt (datetime) --
The timestamp of when the business glossary was updated.
updatedBy (string) --
The Amazon DataZone user who updated the business glossary.
glossaryTermItem (dict) --
The glossary term item included in the search results.
createdAt (datetime) --
The timestamp of when a business glossary term was created.
createdBy (string) --
The Amazon DataZone user who created the business glossary.
domainId (string) --
The identifier of the Amazon DataZone domain in which the business glossary exists.
glossaryId (string) --
The identifier of the business glossary to which the term belongs.
id (string) --
The identifier of the business glossary term.
longDescription (string) --
The long description of the business glossary term.
name (string) --
The name of the business glossary term.
shortDescription (string) --
The short description of the business glossary term.
status (string) --
The status of the business glossary term.
termRelations (dict) --
The relations of the business glossary term.
classifies (list) --
The classifies of the term relations.
(string) --
isA (list) --
The isA property of the term relations.
(string) --
updatedAt (datetime) --
The timestamp of when a business glossary term was updated.
updatedBy (string) --
The Amazon DataZone user who updated the business glossary term.
nextToken (string) --
When the number of results is greater than the default value for the MaxResults parameter, or if you explicitly specify a value for MaxResults that is less than the number of results, the response includes a pagination token named NextToken. You can specify this NextToken value in a subsequent call to Search to list the next set of results.
totalMatchCount (integer) --
Total number of search results.
{'additionalAttributes': {'TIME_SERIES_DATA_POINT_FORMS'}}
Response {'items': {'assetListing': {'additionalAttributes': {'latestTimeSeriesDataPointForms': [{'contentSummary': 'string',
'formName': 'string',
'id': 'string',
'timestamp': 'timestamp',
'typeIdentifier': 'string',
'typeRevision': 'string'}]}}}}
Searches listings (records of an asset at a given time) in Amazon DataZone.
See also: AWS API Documentation
Request Syntax
client.search_listings(
additionalAttributes=[
'FORMS'|'TIME_SERIES_DATA_POINT_FORMS',
],
domainIdentifier='string',
filters={
'and': [
{'... recursive ...'},
],
'filter': {
'attribute': 'string',
'value': 'string'
},
'or': [
{'... recursive ...'},
]
},
maxResults=123,
nextToken='string',
searchIn=[
{
'attribute': 'string'
},
],
searchText='string',
sort={
'attribute': 'string',
'order': 'ASCENDING'|'DESCENDING'
}
)
list
Specifies additional attributes for the search.
(string) --
string
[REQUIRED]
The identifier of the domain in which to search listings.
dict
Specifies the filters for the search of listings.
and (list) --
The 'and' search filter clause in Amazon DataZone.
(dict) --
A search filter clause in Amazon DataZone.
filter (dict) --
A search filter in Amazon DataZone.
attribute (string) -- [REQUIRED]
A search filter attribute in Amazon DataZone.
value (string) -- [REQUIRED]
A search filter value in Amazon DataZone.
or (list) --
The 'or' search filter clause in Amazon DataZone.
(dict) --
A search filter clause in Amazon DataZone.
integer
The maximum number of results to return in a single call to SearchListings. When the number of results to be listed is greater than the value of MaxResults, the response contains a NextToken value that you can use in a subsequent call to SearchListings to list the next set of results.
string
When the number of results is greater than the default value for the MaxResults parameter, or if you explicitly specify a value for MaxResults that is less than the number of results, the response includes a pagination token named NextToken. You can specify this NextToken value in a subsequent call to SearchListings to list the next set of results.
list
The details of the search.
(dict) --
The details of the search.
attribute (string) -- [REQUIRED]
The search attribute.
string
Specifies the text for which to search.
dict
Specifies the way for sorting the search results.
attribute (string) -- [REQUIRED]
The attribute detail of the way to sort search results.
order (string) --
The order detail of the wya to sort search results.
dict
Response Syntax
{
'items': [
{
'assetListing': {
'additionalAttributes': {
'forms': 'string',
'latestTimeSeriesDataPointForms': [
{
'contentSummary': 'string',
'formName': 'string',
'id': 'string',
'timestamp': datetime(2015, 1, 1),
'typeIdentifier': 'string',
'typeRevision': 'string'
},
]
},
'createdAt': datetime(2015, 1, 1),
'description': 'string',
'entityId': 'string',
'entityRevision': 'string',
'entityType': 'string',
'glossaryTerms': [
{
'name': 'string',
'shortDescription': 'string'
},
],
'listingCreatedBy': 'string',
'listingId': 'string',
'listingRevision': 'string',
'listingUpdatedBy': 'string',
'name': 'string',
'owningProjectId': 'string'
}
},
],
'nextToken': 'string',
'totalMatchCount': 123
}
Response Structure
(dict) --
items (list) --
The results of the SearchListings action.
(dict) --
The details of the results of the SearchListings action.
assetListing (dict) --
The asset listing included in the results of the SearchListings action.
additionalAttributes (dict) --
The additional attributes of an asset published in an Amazon DataZone catalog.
forms (string) --
The metadata forms that form additional attributes of the metadata asset.
latestTimeSeriesDataPointForms (list) --
The latest time series data points forms included in the additional attributes of an asset.
(dict) --
The summary of the time series data points form.
contentSummary (string) --
The content of the summary of the time series data points form.
formName (string) --
The name of the time series data points summary form.
id (string) --
The ID of the time series data points summary form.
timestamp (datetime) --
The timestamp of the time series data points summary form.
typeIdentifier (string) --
The type ID of the time series data points summary form.
typeRevision (string) --
The type revision of the time series data points summary form.
createdAt (datetime) --
The timestamp of when an asset published in an Amazon DataZone catalog was created.
description (string) --
The description of an asset published in an Amazon DataZone catalog.
entityId (string) --
The identifier of the inventory asset.
entityRevision (string) --
The revision of the inventory asset.
entityType (string) --
The type of the inventory asset.
glossaryTerms (list) --
Glossary terms attached to the inventory asset.
(dict) --
Details of a glossary term attached to the inventory asset.
name (string) --
The name of a glossary term attached to the inventory asset.
shortDescription (string) --
The shoft description of a glossary term attached to the inventory asset.
listingCreatedBy (string) --
The Amazon DataZone user who created the listing.
listingId (string) --
The identifier of the listing (asset published in Amazon DataZone catalog).
listingRevision (string) --
The revision of the listing (asset published in Amazon DataZone catalog).
listingUpdatedBy (string) --
The Amazon DataZone user who updated the listing.
name (string) --
The name of the inventory asset.
owningProjectId (string) --
The identifier of the project that owns the inventory asset.
nextToken (string) --
When the number of results is greater than the default value for the MaxResults parameter, or if you explicitly specify a value for MaxResults that is less than the number of results, the response includes a pagination token named NextToken. You can specify this NextToken value in a subsequent call to SearchListings to list the next set of results.
totalMatchCount (integer) --
Total number of search results.
{'configuration': {'glueRunConfiguration': {'autoImportDataQualityResult': 'boolean'}}}
Updates the specified data source in Amazon DataZone.
See also: AWS API Documentation
Request Syntax
client.update_data_source(
assetFormsInput=[
{
'content': 'string',
'formName': 'string',
'typeIdentifier': 'string',
'typeRevision': 'string'
},
],
configuration={
'glueRunConfiguration': {
'autoImportDataQualityResult': True|False,
'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'
},
]
}
},
description='string',
domainIdentifier='string',
enableSetting='ENABLED'|'DISABLED',
identifier='string',
name='string',
publishOnImport=True|False,
recommendation={
'enableBusinessNameGeneration': True|False
},
schedule={
'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'
}
)
list
The asset forms to be updated as part of the UpdateDataSource action.
(dict) --
The details of a metadata form.
content (string) --
The content of the metadata form.
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.
dict
The configuration to be updated as part of the UpdateDataSource action.
glueRunConfiguration (dict) --
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.
dataAccessRole (string) --
The data access role included in the configuration details of the Amazon Web Services Glue data source.
relationalFilterConfigurations (list) -- [REQUIRED]
The relational filter configurations included in the configuration details of the Amazon Web Services Glue data source.
(dict) --
The relational filter configuration for the data source.
databaseName (string) -- [REQUIRED]
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.
(dict) --
A filter expression in Amazon DataZone.
expression (string) -- [REQUIRED]
The search filter expression.
type (string) -- [REQUIRED]
The search filter explresison type.
schemaName (string) --
The schema name specified in the relational filter configuration for the data source.
redshiftRunConfiguration (dict) --
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 (dict) -- [REQUIRED]
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 (dict) -- [REQUIRED]
The details of the Amazon Redshift storage as part of the configuration of an Amazon Redshift data source run.
redshiftClusterSource (dict) --
The details of the Amazon Redshift cluster source.
clusterName (string) -- [REQUIRED]
The name of an Amazon Redshift cluster.
redshiftServerlessSource (dict) --
The details of the Amazon Redshift Serverless workgroup source.
workgroupName (string) -- [REQUIRED]
The name of the Amazon Redshift Serverless workgroup.
relationalFilterConfigurations (list) -- [REQUIRED]
The relational filger configurations included in the configuration details of the Amazon Redshift data source.
(dict) --
The relational filter configuration for the data source.
databaseName (string) -- [REQUIRED]
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.
(dict) --
A filter expression in Amazon DataZone.
expression (string) -- [REQUIRED]
The search filter expression.
type (string) -- [REQUIRED]
The search filter explresison type.
schemaName (string) --
The schema name specified in the relational filter configuration for the data source.
string
The description to be updated as part of the UpdateDataSource action.
string
[REQUIRED]
The identifier of the domain in which to update a data source.
string
The enable setting to be updated as part of the UpdateDataSource action.
string
[REQUIRED]
The identifier of the data source to be updated.
string
The name to be updated as part of the UpdateDataSource action.
boolean
The publish on import setting to be updated as part of the UpdateDataSource action.
dict
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.
dict
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.
dict
Response Syntax
{
'assetFormsOutput': [
{
'content': 'string',
'formName': 'string',
'typeName': 'string',
'typeRevision': 'string'
},
],
'configuration': {
'glueRunConfiguration': {
'accountId': 'string',
'autoImportDataQualityResult': True|False,
'dataAccessRole': 'string',
'region': 'string',
'relationalFilterConfigurations': [
{
'databaseName': 'string',
'filterExpressions': [
{
'expression': 'string',
'type': 'INCLUDE'|'EXCLUDE'
},
],
'schemaName': 'string'
},
]
},
'redshiftRunConfiguration': {
'accountId': 'string',
'dataAccessRole': 'string',
'redshiftCredentialConfiguration': {
'secretManagerArn': 'string'
},
'redshiftStorage': {
'redshiftClusterSource': {
'clusterName': 'string'
},
'redshiftServerlessSource': {
'workgroupName': 'string'
}
},
'region': 'string',
'relationalFilterConfigurations': [
{
'databaseName': 'string',
'filterExpressions': [
{
'expression': 'string',
'type': 'INCLUDE'|'EXCLUDE'
},
],
'schemaName': 'string'
},
]
}
},
'createdAt': datetime(2015, 1, 1),
'description': 'string',
'domainId': 'string',
'enableSetting': 'ENABLED'|'DISABLED',
'environmentId': 'string',
'errorMessage': {
'errorDetail': 'string',
'errorType': 'ACCESS_DENIED_EXCEPTION'|'CONFLICT_EXCEPTION'|'INTERNAL_SERVER_EXCEPTION'|'RESOURCE_NOT_FOUND_EXCEPTION'|'SERVICE_QUOTA_EXCEEDED_EXCEPTION'|'THROTTLING_EXCEPTION'|'VALIDATION_EXCEPTION'
},
'id': 'string',
'lastRunAt': datetime(2015, 1, 1),
'lastRunErrorMessage': {
'errorDetail': 'string',
'errorType': 'ACCESS_DENIED_EXCEPTION'|'CONFLICT_EXCEPTION'|'INTERNAL_SERVER_EXCEPTION'|'RESOURCE_NOT_FOUND_EXCEPTION'|'SERVICE_QUOTA_EXCEEDED_EXCEPTION'|'THROTTLING_EXCEPTION'|'VALIDATION_EXCEPTION'
},
'lastRunStatus': 'REQUESTED'|'RUNNING'|'FAILED'|'PARTIALLY_SUCCEEDED'|'SUCCESS',
'name': 'string',
'projectId': 'string',
'publishOnImport': True|False,
'recommendation': {
'enableBusinessNameGeneration': True|False
},
'schedule': {
'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'
},
'status': 'CREATING'|'FAILED_CREATION'|'READY'|'UPDATING'|'FAILED_UPDATE'|'RUNNING'|'DELETING'|'FAILED_DELETION',
'type': 'string',
'updatedAt': datetime(2015, 1, 1)
}
Response Structure
(dict) --
assetFormsOutput (list) --
The asset forms to be updated as part of the UpdateDataSource action.
(dict) --
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 (dict) --
The configuration to be updated as part of the UpdateDataSource action.
glueRunConfiguration (dict) --
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.
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.
(dict) --
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.
(dict) --
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 (dict) --
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 (dict) --
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 (dict) --
The details of the Amazon Redshift storage as part of the configuration of an Amazon Redshift data source run.
redshiftClusterSource (dict) --
The details of the Amazon Redshift cluster source.
clusterName (string) --
The name of an Amazon Redshift cluster.
redshiftServerlessSource (dict) --
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.
(dict) --
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.
(dict) --
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.
createdAt (datetime) --
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 (dict) --
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 (datetime) --
The timestamp of when the data source was last run.
lastRunErrorMessage (dict) --
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 (dict) --
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.
schedule (dict) --
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.
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 (datetime) --
The timestamp of when the data source was updated.