2025/08/25 - Amazon DataZone - 2 new 16 updated api methods
Changes Releasing the following features - Asset classification that lets users use restricted terms for classifying assets if they have the right permissions. Also adding a new enum value "Moving" to project status.
Associates governed terms with an asset.
See also: AWS API Documentation
Request Syntax
client.associate_governed_terms(
domainIdentifier='string',
entityIdentifier='string',
entityType='ASSET',
governedGlossaryTerms=[
'string',
]
)
string
[REQUIRED]
The ID of the domain where governed terms are to be associated with an asset.
string
[REQUIRED]
The ID of the asset with which you want to associate a governed term.
string
[REQUIRED]
The type of the asset with which you want to associate a governed term.
list
[REQUIRED]
The glossary terms in a restricted glossary.
(string) --
dict
Response Syntax
{}
Response Structure
(dict) --
Disassociates restricted terms from an asset.
See also: AWS API Documentation
Request Syntax
client.disassociate_governed_terms(
domainIdentifier='string',
entityIdentifier='string',
entityType='ASSET',
governedGlossaryTerms=[
'string',
]
)
string
[REQUIRED]
The ID of the domain where you want to disassociate restricted terms from an asset.
string
[REQUIRED]
The ID of an asset from which you want to disassociate restricted terms.
string
[REQUIRED]
The type of the asset from which you want to disassociate restricted terms.
list
[REQUIRED]
The restricted glossary terms that you want to disassociate from an asset.
(string) --
dict
Response Syntax
{}
Response Structure
(dict) --
{'governedGlossaryTerms': ['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.
If the value for the externalIdentifier parameter is specified, it must be a unique value.
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',
],
'governedGlossaryTerms': [
'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) --
governedGlossaryTerms (list) --
The glossary terms in a restricted glossary.
(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.
{'governedGlossaryTerms': ['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',
],
'governedGlossaryTerms': [
'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) --
governedGlossaryTerms (list) --
The glossary terms in a restricted glossary.
(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.
{'usageRestrictions': ['ASSET_GOVERNED_TERMS']}
Creates an Amazon DataZone business glossary.
See also: AWS API Documentation
Request Syntax
client.create_glossary(
clientToken='string',
description='string',
domainIdentifier='string',
name='string',
owningProjectIdentifier='string',
status='DISABLED'|'ENABLED',
usageRestrictions=[
'ASSET_GOVERNED_TERMS',
]
)
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 description of this business glossary.
string
[REQUIRED]
The ID of the Amazon DataZone domain in which this business glossary is created.
string
[REQUIRED]
The name of this business glossary.
string
[REQUIRED]
The ID of the project that currently owns business glossary.
string
The status of this business glossary.
list
The usage restriction of the restricted glossary.
(string) --
dict
Response Syntax
{
'description': 'string',
'domainId': 'string',
'id': 'string',
'name': 'string',
'owningProjectId': 'string',
'status': 'DISABLED'|'ENABLED',
'usageRestrictions': [
'ASSET_GOVERNED_TERMS',
]
}
Response Structure
(dict) --
description (string) --
The description of this business glossary.
domainId (string) --
The ID of the Amazon DataZone domain in which this business glossary is created.
id (string) --
The ID of this business glossary.
name (string) --
The name of this business glossary.
owningProjectId (string) --
The ID of the project that currently owns this business glossary.
status (string) --
The status of this business glossary.
usageRestrictions (list) --
The usage restriction of the restricted glossary.
(string) --
{'usageRestrictions': ['ASSET_GOVERNED_TERMS']}
Creates a business glossary term.
See also: AWS API Documentation
Request Syntax
client.create_glossary_term(
clientToken='string',
domainIdentifier='string',
glossaryIdentifier='string',
longDescription='string',
name='string',
shortDescription='string',
status='ENABLED'|'DISABLED',
termRelations={
'classifies': [
'string',
],
'isA': [
'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 this business glossary term is created.
string
[REQUIRED]
The ID of the business glossary in which this term is created.
string
The long description of this business glossary term.
string
[REQUIRED]
The name of this business glossary term.
string
The short description of this business glossary term.
string
The status of this business glossary term.
dict
The term relations of this business glossary term.
classifies (list) --
The classifies of the term relations.
(string) --
isA (list) --
The isA property of the term relations.
(string) --
dict
Response Syntax
{
'domainId': 'string',
'glossaryId': 'string',
'id': 'string',
'longDescription': 'string',
'name': 'string',
'shortDescription': 'string',
'status': 'ENABLED'|'DISABLED',
'termRelations': {
'classifies': [
'string',
],
'isA': [
'string',
]
},
'usageRestrictions': [
'ASSET_GOVERNED_TERMS',
]
}
Response Structure
(dict) --
domainId (string) --
The ID of the Amazon DataZone domain in which this business glossary term is created.
glossaryId (string) --
The ID of the business glossary in which this term is created.
id (string) --
The ID of this business glossary term.
longDescription (string) --
The long description of this business glossary term.
name (string) --
The name of this business glossary term.
shortDescription (string) --
The short description of this business glossary term.
status (string) --
The status of this business glossary term.
termRelations (dict) --
The term relations of this business glossary term.
classifies (list) --
The classifies of the term relations.
(string) --
isA (list) --
The isA property of the term relations.
(string) --
usageRestrictions (list) --
The usage restriction of the restricted glossary.
(string) --
{'projectStatus': {'MOVING'}}
Creates an Amazon DataZone project.
See also: AWS API Documentation
Request Syntax
client.create_project(
description='string',
domainIdentifier='string',
domainUnitId='string',
glossaryTerms=[
'string',
],
name='string',
projectProfileId='string',
userParameters=[
{
'environmentConfigurationName': 'string',
'environmentId': 'string',
'environmentParameters': [
{
'name': 'string',
'value': 'string'
},
],
'environmentResolvedAccount': {
'awsAccountId': 'string',
'regionName': 'string',
'sourceAccountPoolId': 'string'
}
},
]
)
string
The description of the Amazon DataZone project.
string
[REQUIRED]
The ID of the Amazon DataZone domain in which this project is created.
string
The ID of the domain unit. This parameter is not required and if it is not specified, then the project is created at the root domain unit level.
list
The glossary terms that can be used in this Amazon DataZone project.
(string) --
string
[REQUIRED]
The name of the Amazon DataZone project.
string
The ID of the project profile.
list
The user parameters of the project.
(dict) --
The environment configuration user parameters.
environmentConfigurationName (string) --
The environment configuration name.
environmentId (string) --
The ID of the environment.
environmentParameters (list) --
The environment parameters.
(dict) --
The parameter details of an evironment profile.
name (string) --
The name of an environment profile parameter.
value (string) --
The value of an environment profile parameter.
environmentResolvedAccount (dict) --
Specifies the account/Region that is to be used during project creation for a particular blueprint.
awsAccountId (string) -- [REQUIRED]
The ID of the resolved account.
regionName (string) -- [REQUIRED]
The name of the resolved Region.
sourceAccountPoolId (string) --
The ID of the account pool.
dict
Response Syntax
{
'createdAt': datetime(2015, 1, 1),
'createdBy': 'string',
'description': 'string',
'domainId': 'string',
'domainUnitId': 'string',
'environmentDeploymentDetails': {
'environmentFailureReasons': {
'string': [
{
'code': 'string',
'message': 'string'
},
]
},
'overallDeploymentStatus': 'PENDING_DEPLOYMENT'|'IN_PROGRESS'|'SUCCESSFUL'|'FAILED_VALIDATION'|'FAILED_DEPLOYMENT'
},
'failureReasons': [
{
'code': 'string',
'message': 'string'
},
],
'glossaryTerms': [
'string',
],
'id': 'string',
'lastUpdatedAt': datetime(2015, 1, 1),
'name': 'string',
'projectProfileId': 'string',
'projectStatus': 'ACTIVE'|'DELETING'|'DELETE_FAILED'|'UPDATING'|'UPDATE_FAILED'|'MOVING',
'userParameters': [
{
'environmentConfigurationName': 'string',
'environmentId': 'string',
'environmentParameters': [
{
'name': 'string',
'value': 'string'
},
],
'environmentResolvedAccount': {
'awsAccountId': 'string',
'regionName': 'string',
'sourceAccountPoolId': 'string'
}
},
]
}
Response Structure
(dict) --
createdAt (datetime) --
The timestamp of when the project was created.
createdBy (string) --
The Amazon DataZone user who created the project.
description (string) --
The description of the project.
domainId (string) --
The identifier of the Amazon DataZone domain in which the project was created.
domainUnitId (string) --
The ID of the domain unit.
environmentDeploymentDetails (dict) --
The environment deployment details.
environmentFailureReasons (dict) --
Environment failure reasons.
(string) --
(list) --
(dict) --
The failure reasons for the environment deployment.
code (string) --
The error code for the failure reason for the environment deployment.
message (string) --
The error message for the failure reason for the environment deployment.
overallDeploymentStatus (string) --
The overall deployment status of the environment.
failureReasons (list) --
Specifies the error message that is returned if the operation cannot be successfully completed.
(dict) --
Specifies the error message that is returned if the operation cannot be successfully completed.
code (string) --
The code of the project deletion error.
message (string) --
The message of the project deletion error.
glossaryTerms (list) --
The glossary terms that can be used in the project.
(string) --
id (string) --
The ID of the Amazon DataZone project.
lastUpdatedAt (datetime) --
The timestamp of when the project was last updated.
name (string) --
The name of the project.
projectProfileId (string) --
The project profile ID.
projectStatus (string) --
The status of the Amazon DataZone project that was created.
userParameters (list) --
The user parameters of the project.
(dict) --
The environment configuration user parameters.
environmentConfigurationName (string) --
The environment configuration name.
environmentId (string) --
The ID of the environment.
environmentParameters (list) --
The environment parameters.
(dict) --
The parameter details of an evironment profile.
name (string) --
The name of an environment profile parameter.
value (string) --
The value of an environment profile parameter.
environmentResolvedAccount (dict) --
Specifies the account/Region that is to be used during project creation for a particular blueprint.
awsAccountId (string) --
The ID of the resolved account.
regionName (string) --
The name of the resolved Region.
sourceAccountPoolId (string) --
The ID of the account pool.
{'governedGlossaryTerms': ['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.
This parameter supports either the value of assetId or externalIdentifier as input. If you are passing the value of externalIdentifier, you must prefix this value with externalIdentifer%2F.
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',
],
'governedGlossaryTerms': [
'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) --
governedGlossaryTerms (list) --
The restricted glossary terms attached to an 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.
{'usageRestrictions': ['ASSET_GOVERNED_TERMS']}
Gets a business glossary in Amazon DataZone.
See also: AWS API Documentation
Request Syntax
client.get_glossary(
domainIdentifier='string',
identifier='string'
)
string
[REQUIRED]
The ID of the Amazon DataZone domain in which this business glossary exists.
string
[REQUIRED]
The ID of the business glossary.
dict
Response Syntax
{
'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',
'usageRestrictions': [
'ASSET_GOVERNED_TERMS',
]
}
Response Structure
(dict) --
createdAt (datetime) --
The timestamp of when this business glossary was created.
createdBy (string) --
The Amazon DataZone user who created this business glossary.
description (string) --
The description of the business glossary.
domainId (string) --
The ID of the Amazon DataZone domain in which this business glossary exists.
id (string) --
The ID of the business glossary.
name (string) --
The name of the business glossary.
owningProjectId (string) --
The ID of the project that owns this business glossary.
status (string) --
The status of the business glossary.
updatedAt (datetime) --
The timestamp of when the business glossary was updated.
updatedBy (string) --
The Amazon DataZone user who updated the business glossary.
usageRestrictions (list) --
The usage restriction of the restricted glossary.
(string) --
{'usageRestrictions': ['ASSET_GOVERNED_TERMS']}
Gets a business glossary term in Amazon DataZone.
See also: AWS API Documentation
Request Syntax
client.get_glossary_term(
domainIdentifier='string',
identifier='string'
)
string
[REQUIRED]
The ID of the Amazon DataZone domain in which this business glossary term exists.
string
[REQUIRED]
The ID of the business glossary term.
dict
Response Syntax
{
'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',
'usageRestrictions': [
'ASSET_GOVERNED_TERMS',
]
}
Response Structure
(dict) --
createdAt (datetime) --
The timestamp of when the business glossary term was created.
createdBy (string) --
The Amazon DataZone user who created the business glossary.
domainId (string) --
The ID of the Amazon DataZone domain in which this business glossary term exists.
glossaryId (string) --
The ID of the business glossary to which this term belongs.
id (string) --
The ID 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 decription 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 the business glossary term was updated.
updatedBy (string) --
The Amazon DataZone user who updated the business glossary term.
usageRestrictions (list) --
The usage restriction of a term within a restricted glossary.
(string) --
{'item': {'assetListing': {'governedGlossaryTerms': [{'name': 'string',
'shortDescription': 'string'}]}}}
Gets a listing (a record of an asset at a given time). If you specify a listing version, only details that are specific to that version are returned.
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'
},
],
'governedGlossaryTerms': [
{
'name': 'string',
'shortDescription': 'string'
},
],
'latestTimeSeriesDataPointForms': [
{
'contentSummary': 'string',
'formName': 'string',
'id': 'string',
'timestamp': datetime(2015, 1, 1),
'typeIdentifier': 'string',
'typeRevision': 'string'
},
],
'owningProjectId': 'string'
},
'dataProductListing': {
'createdAt': datetime(2015, 1, 1),
'dataProductId': 'string',
'dataProductRevision': 'string',
'forms': 'string',
'glossaryTerms': [
{
'name': 'string',
'shortDescription': 'string'
},
],
'items': [
{
'glossaryTerms': [
{
'name': 'string',
'shortDescription': 'string'
},
],
'listingId': 'string',
'listingRevision': '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.
governedGlossaryTerms (list) --
The restricted glossary terms associated with an 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.
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.
dataProductListing (dict) --
The data product listing.
createdAt (datetime) --
The timestamp at which the data product listing was created.
dataProductId (string) --
The ID of the data product listing.
dataProductRevision (string) --
The revision of the data product listing.
forms (string) --
The metadata forms of the data product listing.
glossaryTerms (list) --
The glossary terms of the data product listing.
(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.
items (list) --
The data assets of the data product listing.
(dict) --
The summary of the listing of the data product.
glossaryTerms (list) --
The glossary terms of the data product.
(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.
listingId (string) --
The ID of the data product listing.
listingRevision (string) --
The revision of the data product listing.
owningProjectId (string) --
The ID of the owning project of the data product listing.
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.
{'projectStatus': {'MOVING'}}
Gets a project in Amazon DataZone.
See also: AWS API Documentation
Request Syntax
client.get_project(
domainIdentifier='string',
identifier='string'
)
string
[REQUIRED]
The ID of the Amazon DataZone domain in which the project exists.
string
[REQUIRED]
The ID of the project.
dict
Response Syntax
{
'createdAt': datetime(2015, 1, 1),
'createdBy': 'string',
'description': 'string',
'domainId': 'string',
'domainUnitId': 'string',
'environmentDeploymentDetails': {
'environmentFailureReasons': {
'string': [
{
'code': 'string',
'message': 'string'
},
]
},
'overallDeploymentStatus': 'PENDING_DEPLOYMENT'|'IN_PROGRESS'|'SUCCESSFUL'|'FAILED_VALIDATION'|'FAILED_DEPLOYMENT'
},
'failureReasons': [
{
'code': 'string',
'message': 'string'
},
],
'glossaryTerms': [
'string',
],
'id': 'string',
'lastUpdatedAt': datetime(2015, 1, 1),
'name': 'string',
'projectProfileId': 'string',
'projectStatus': 'ACTIVE'|'DELETING'|'DELETE_FAILED'|'UPDATING'|'UPDATE_FAILED'|'MOVING',
'userParameters': [
{
'environmentConfigurationName': 'string',
'environmentId': 'string',
'environmentParameters': [
{
'name': 'string',
'value': 'string'
},
],
'environmentResolvedAccount': {
'awsAccountId': 'string',
'regionName': 'string',
'sourceAccountPoolId': 'string'
}
},
]
}
Response Structure
(dict) --
createdAt (datetime) --
The timestamp of when the project was created.
createdBy (string) --
The Amazon DataZone user who created the project.
description (string) --
The description of the project.
domainId (string) --
The ID of the Amazon DataZone domain in which the project exists.
domainUnitId (string) --
The ID of the domain unit.
environmentDeploymentDetails (dict) --
The environment deployment status of a project.
environmentFailureReasons (dict) --
Environment failure reasons.
(string) --
(list) --
(dict) --
The failure reasons for the environment deployment.
code (string) --
The error code for the failure reason for the environment deployment.
message (string) --
The error message for the failure reason for the environment deployment.
overallDeploymentStatus (string) --
The overall deployment status of the environment.
failureReasons (list) --
Specifies the error message that is returned if the operation cannot be successfully completed.
(dict) --
Specifies the error message that is returned if the operation cannot be successfully completed.
code (string) --
The code of the project deletion error.
message (string) --
The message of the project deletion error.
glossaryTerms (list) --
The business glossary terms that can be used in the project.
(string) --
id (string) --
>The ID of the project.
lastUpdatedAt (datetime) --
The timestamp of when the project was last updated.
name (string) --
The name of the project.
projectProfileId (string) --
The ID of the project profile of a project.
projectStatus (string) --
The status of the project.
userParameters (list) --
The user parameters of a project.
(dict) --
The environment configuration user parameters.
environmentConfigurationName (string) --
The environment configuration name.
environmentId (string) --
The ID of the environment.
environmentParameters (list) --
The environment parameters.
(dict) --
The parameter details of an evironment profile.
name (string) --
The name of an environment profile parameter.
value (string) --
The value of an environment profile parameter.
environmentResolvedAccount (dict) --
Specifies the account/Region that is to be used during project creation for a particular blueprint.
awsAccountId (string) --
The ID of the resolved account.
regionName (string) --
The name of the resolved Region.
sourceAccountPoolId (string) --
The ID of the account pool.
{'items': {'projectStatus': {'MOVING'}}}
Lists Amazon DataZone projects.
See also: AWS API Documentation
Request Syntax
client.list_projects(
domainIdentifier='string',
groupIdentifier='string',
maxResults=123,
name='string',
nextToken='string',
userIdentifier='string'
)
string
[REQUIRED]
The identifier of the Amazon DataZone domain.
string
The identifier of a group.
integer
The maximum number of projects to return in a single call to ListProjects. When the number of projects 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 ListProjects to list the next set of projects.
string
The name of the project.
string
When the number of projects 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 projects, the response includes a pagination token named NextToken. You can specify this NextToken value in a subsequent call to ListProjects to list the next set of projects.
string
The identifier of the Amazon DataZone user.
dict
Response Syntax
{
'items': [
{
'createdAt': datetime(2015, 1, 1),
'createdBy': 'string',
'description': 'string',
'domainId': 'string',
'domainUnitId': 'string',
'failureReasons': [
{
'code': 'string',
'message': 'string'
},
],
'id': 'string',
'name': 'string',
'projectStatus': 'ACTIVE'|'DELETING'|'DELETE_FAILED'|'UPDATING'|'UPDATE_FAILED'|'MOVING',
'updatedAt': datetime(2015, 1, 1)
},
],
'nextToken': 'string'
}
Response Structure
(dict) --
items (list) --
The results of the ListProjects action.
(dict) --
The details of a Amazon DataZone project.
createdAt (datetime) --
The timestamp of when a project was created.
createdBy (string) --
The Amazon DataZone user who created the project.
description (string) --
The description of a project.
domainId (string) --
The identifier of a Amazon DataZone domain where the project exists.
domainUnitId (string) --
The ID of the domain unit.
failureReasons (list) --
Specifies the error message that is returned if the operation cannot be successfully completed.
(dict) --
Specifies the error message that is returned if the operation cannot be successfully completed.
code (string) --
The code of the project deletion error.
message (string) --
The message of the project deletion error.
id (string) --
The identifier of a project.
name (string) --
The name of a project.
projectStatus (string) --
The status of the project.
updatedAt (datetime) --
The timestamp of when the project was updated.
nextToken (string) --
When the number of projects 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 projects, the response includes a pagination token named NextToken. You can specify this NextToken value in a subsequent call to ListProjects to list the next set of projects.
{'items': {'assetItem': {'governedGlossaryTerms': ['string']},
'glossaryItem': {'usageRestrictions': ['ASSET_GOVERNED_TERMS']},
'glossaryTermItem': {'usageRestrictions': ['ASSET_GOVERNED_TERMS']}}}
Searches for assets in Amazon DataZone.
See also: AWS API Documentation
Request Syntax
client.search(
additionalAttributes=[
'FORMS'|'TIME_SERIES_DATA_POINT_FORMS'|'TEXT_MATCH_RATIONALE',
],
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'|'DATA_PRODUCT',
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'
},
],
'matchRationale': [
{
'textMatches': [
{
'attribute': 'string',
'matchOffsets': [
{
'endOffset': 123,
'startOffset': 123
},
],
'text': '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',
],
'governedGlossaryTerms': [
'string',
],
'identifier': 'string',
'name': 'string',
'owningProjectId': 'string',
'typeIdentifier': 'string',
'typeRevision': 'string'
},
'dataProductItem': {
'additionalAttributes': {
'matchRationale': [
{
'textMatches': [
{
'attribute': 'string',
'matchOffsets': [
{
'endOffset': 123,
'startOffset': 123
},
],
'text': 'string'
},
]
},
]
},
'createdAt': datetime(2015, 1, 1),
'createdBy': 'string',
'description': 'string',
'domainId': 'string',
'firstRevisionCreatedAt': datetime(2015, 1, 1),
'firstRevisionCreatedBy': 'string',
'glossaryTerms': [
'string',
],
'id': 'string',
'name': 'string',
'owningProjectId': 'string'
},
'glossaryItem': {
'additionalAttributes': {
'matchRationale': [
{
'textMatches': [
{
'attribute': 'string',
'matchOffsets': [
{
'endOffset': 123,
'startOffset': 123
},
],
'text': 'string'
},
]
},
]
},
'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',
'usageRestrictions': [
'ASSET_GOVERNED_TERMS',
]
},
'glossaryTermItem': {
'additionalAttributes': {
'matchRationale': [
{
'textMatches': [
{
'attribute': 'string',
'matchOffsets': [
{
'endOffset': 123,
'startOffset': 123
},
],
'text': 'string'
},
]
},
]
},
'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',
'usageRestrictions': [
'ASSET_GOVERNED_TERMS',
]
}
},
],
'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.
matchRationale (list) --
List of rationales indicating why this item was matched by search.
(dict) --
A rationale indicating why this item was matched by search.
textMatches (list) --
A list of TextMatchItems.
(dict) --
A structure indicating matched terms for an attribute.
attribute (string) --
The name of the attribute.
matchOffsets (list) --
List of offsets indicating matching terms in the TextMatchItem text.
(dict) --
The offset of a matched term.
endOffset (integer) --
The 0-indexed number indicating the end position (exclusive) of a matched term.
startOffset (integer) --
The 0-indexed number indicating the start position (inclusive) of a matched term.
text (string) --
Snippet of attribute text containing highlighted content.
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) --
governedGlossaryTerms (list) --
The restricted glossary terms accociated with an 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.
additionalAttributes (dict) --
The additional attributes of an Amazon DataZone data product.
matchRationale (list) --
List of rationales indicating why this item was matched by search.
(dict) --
A rationale indicating why this item was matched by search.
textMatches (list) --
A list of TextMatchItems.
(dict) --
A structure indicating matched terms for an attribute.
attribute (string) --
The name of the attribute.
matchOffsets (list) --
List of offsets indicating matching terms in the TextMatchItem text.
(dict) --
The offset of a matched term.
endOffset (integer) --
The 0-indexed number indicating the end position (exclusive) of a matched term.
startOffset (integer) --
The 0-indexed number indicating the start position (inclusive) of a matched term.
text (string) --
Snippet of attribute text containing highlighted content.
createdAt (datetime) --
The timestamp at which the data product was created.
createdBy (string) --
The user who created the data product.
description (string) --
The description of the data product.
domainId (string) --
The ID of the domain where the data product lives.
firstRevisionCreatedAt (datetime) --
The timestamp at which first revision of the data product was created.
firstRevisionCreatedBy (string) --
The user who created the first revision of the data product.
glossaryTerms (list) --
The glossary terms of the data product.
(string) --
id (string) --
The ID of the data product.
name (string) --
The name of the data product.
owningProjectId (string) --
The ID of the owning project of the data product.
glossaryItem (dict) --
The glossary item included in the search results.
additionalAttributes (dict) --
The additional attributes of an Amazon DataZone glossary.
matchRationale (list) --
List of rationales indicating why this item was matched by search.
(dict) --
A rationale indicating why this item was matched by search.
textMatches (list) --
A list of TextMatchItems.
(dict) --
A structure indicating matched terms for an attribute.
attribute (string) --
The name of the attribute.
matchOffsets (list) --
List of offsets indicating matching terms in the TextMatchItem text.
(dict) --
The offset of a matched term.
endOffset (integer) --
The 0-indexed number indicating the end position (exclusive) of a matched term.
startOffset (integer) --
The 0-indexed number indicating the start position (inclusive) of a matched term.
text (string) --
Snippet of attribute text containing highlighted content.
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.
usageRestrictions (list) --
The usage restrictions associated with a goverened glossary term.
(string) --
glossaryTermItem (dict) --
The glossary term item included in the search results.
additionalAttributes (dict) --
The additional attributes of an Amazon DataZone glossary term.
matchRationale (list) --
List of rationales indicating why this item was matched by search.
(dict) --
A rationale indicating why this item was matched by search.
textMatches (list) --
A list of TextMatchItems.
(dict) --
A structure indicating matched terms for an attribute.
attribute (string) --
The name of the attribute.
matchOffsets (list) --
List of offsets indicating matching terms in the TextMatchItem text.
(dict) --
The offset of a matched term.
endOffset (integer) --
The 0-indexed number indicating the end position (exclusive) of a matched term.
startOffset (integer) --
The 0-indexed number indicating the start position (inclusive) of a matched term.
text (string) --
Snippet of attribute text containing highlighted content.
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.
usageRestrictions (list) --
The usage restrictions associated with a goverened glossary term.
(string) --
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.
{'items': {'assetListing': {'governedGlossaryTerms': [{'name': 'string',
'shortDescription': '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'|'TEXT_MATCH_RATIONALE',
],
aggregations=[
{
'attribute': 'string',
'displayValue': 'string'
},
],
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) --
list
Enables you to specify one or more attributes to compute and return counts grouped by field values.
(dict) --
An aggregation list item.
attribute (string) -- [REQUIRED]
An attribute on which to compute aggregations.
displayValue (string) --
The display value of the aggregation list item. Supported values include value and glossaryTerm.name.
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
{
'aggregates': [
{
'attribute': 'string',
'displayValue': 'string',
'items': [
{
'count': 123,
'displayValue': 'string',
'value': 'string'
},
]
},
],
'items': [
{
'assetListing': {
'additionalAttributes': {
'forms': 'string',
'latestTimeSeriesDataPointForms': [
{
'contentSummary': 'string',
'formName': 'string',
'id': 'string',
'timestamp': datetime(2015, 1, 1),
'typeIdentifier': 'string',
'typeRevision': 'string'
},
],
'matchRationale': [
{
'textMatches': [
{
'attribute': 'string',
'matchOffsets': [
{
'endOffset': 123,
'startOffset': 123
},
],
'text': 'string'
},
]
},
]
},
'createdAt': datetime(2015, 1, 1),
'description': 'string',
'entityId': 'string',
'entityRevision': 'string',
'entityType': 'string',
'glossaryTerms': [
{
'name': 'string',
'shortDescription': 'string'
},
],
'governedGlossaryTerms': [
{
'name': 'string',
'shortDescription': 'string'
},
],
'listingCreatedBy': 'string',
'listingId': 'string',
'listingRevision': 'string',
'listingUpdatedBy': 'string',
'name': 'string',
'owningProjectId': 'string'
},
'dataProductListing': {
'additionalAttributes': {
'forms': 'string',
'matchRationale': [
{
'textMatches': [
{
'attribute': 'string',
'matchOffsets': [
{
'endOffset': 123,
'startOffset': 123
},
],
'text': 'string'
},
]
},
]
},
'createdAt': datetime(2015, 1, 1),
'description': 'string',
'entityId': 'string',
'entityRevision': 'string',
'glossaryTerms': [
{
'name': 'string',
'shortDescription': 'string'
},
],
'items': [
{
'glossaryTerms': [
{
'name': 'string',
'shortDescription': 'string'
},
],
'listingId': 'string',
'listingRevision': 'string'
},
],
'listingCreatedBy': 'string',
'listingId': 'string',
'listingRevision': 'string',
'listingUpdatedBy': 'string',
'name': 'string',
'owningProjectId': 'string'
}
},
],
'nextToken': 'string',
'totalMatchCount': 123
}
Response Structure
(dict) --
aggregates (list) --
Contains computed counts grouped by field values based on the requested aggregation attributes for the matching listings.
(dict) --
The aggregation for an attribute.
attribute (string) --
The attribute for this aggregation.
displayValue (string) --
The display value of the aggregation output item.
items (list) --
A list of aggregation output items.
(dict) --
An aggregation output item.
count (integer) --
The count of the aggregation output item.
displayValue (string) --
The display value of the aggregation. If the attribute being aggregated corresponds to the id of a public resource, the service automatically resolves the id to the provided display value.
value (string) --
The attribute value of the aggregation output item.
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.
matchRationale (list) --
List of rationales indicating why this item was matched by search.
(dict) --
A rationale indicating why this item was matched by search.
textMatches (list) --
A list of TextMatchItems.
(dict) --
A structure indicating matched terms for an attribute.
attribute (string) --
The name of the attribute.
matchOffsets (list) --
List of offsets indicating matching terms in the TextMatchItem text.
(dict) --
The offset of a matched term.
endOffset (integer) --
The 0-indexed number indicating the end position (exclusive) of a matched term.
startOffset (integer) --
The 0-indexed number indicating the start position (inclusive) of a matched term.
text (string) --
Snippet of attribute text containing highlighted content.
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.
governedGlossaryTerms (list) --
The restricted glossary terms associated with an 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.
dataProductListing (dict) --
The data product listing.
additionalAttributes (dict) --
The additional attributes of the asset of the data product.
forms (string) --
The metadata forms of the asset of the data product.
matchRationale (list) --
List of rationales indicating why this item was matched by search.
(dict) --
A rationale indicating why this item was matched by search.
textMatches (list) --
A list of TextMatchItems.
(dict) --
A structure indicating matched terms for an attribute.
attribute (string) --
The name of the attribute.
matchOffsets (list) --
List of offsets indicating matching terms in the TextMatchItem text.
(dict) --
The offset of a matched term.
endOffset (integer) --
The 0-indexed number indicating the end position (exclusive) of a matched term.
startOffset (integer) --
The 0-indexed number indicating the start position (inclusive) of a matched term.
text (string) --
Snippet of attribute text containing highlighted content.
createdAt (datetime) --
The timestamp at which the asset of the data product listing was created.
description (string) --
The description of the asset of the asset of the data product.
entityId (string) --
The entity ID of the asset of the asset of the data product.
entityRevision (string) --
The revision of the asset of the asset of the data product.
glossaryTerms (list) --
The glossary terms of the asset of the asset of the data product.
(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.
items (list) --
The data of the asset of the data product.
(dict) --
The results of the data product summary.
glossaryTerms (list) --
The glossary terms of the data product listing.
(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.
listingId (string) --
The ID of the data product listing.
listingRevision (string) --
The revision of the data product listing.
listingCreatedBy (string) --
The timestamp at which the listing was created.
listingId (string) --
The ID of the listing.
listingRevision (string) --
The revision of the listing.
listingUpdatedBy (string) --
The user who updated the listing.
name (string) --
The name of the asset of the data product.
owningProjectId (string) --
The ID of the owning project of the asset of the data product.
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.
{'usageRestrictions': ['ASSET_GOVERNED_TERMS']}
Updates the business glossary in Amazon DataZone.
See also: AWS API Documentation
Request Syntax
client.update_glossary(
clientToken='string',
description='string',
domainIdentifier='string',
identifier='string',
name='string',
status='DISABLED'|'ENABLED'
)
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 description to be updated as part of the UpdateGlossary action.
string
[REQUIRED]
The identifier of the Amazon DataZone domain in which a business glossary is to be updated.
string
[REQUIRED]
The identifier of the business glossary to be updated.
string
The name to be updated as part of the UpdateGlossary action.
string
The status to be updated as part of the UpdateGlossary action.
dict
Response Syntax
{
'description': 'string',
'domainId': 'string',
'id': 'string',
'name': 'string',
'owningProjectId': 'string',
'status': 'DISABLED'|'ENABLED',
'usageRestrictions': [
'ASSET_GOVERNED_TERMS',
]
}
Response Structure
(dict) --
description (string) --
The description to be updated as part of the UpdateGlossary action.
domainId (string) --
The identifier of the Amazon DataZone domain in which a business glossary is to be updated.
id (string) --
The identifier of the business glossary that is to be updated.
name (string) --
The name to be updated as part of the UpdateGlossary action.
owningProjectId (string) --
The identifier of the project in which to update a business glossary.
status (string) --
The status to be updated as part of the UpdateGlossary action.
usageRestrictions (list) --
The usage restriction of the restricted glossary.
(string) --
{'usageRestrictions': ['ASSET_GOVERNED_TERMS']}
Updates a business glossary term in Amazon DataZone.
See also: AWS API Documentation
Request Syntax
client.update_glossary_term(
domainIdentifier='string',
glossaryIdentifier='string',
identifier='string',
longDescription='string',
name='string',
shortDescription='string',
status='ENABLED'|'DISABLED',
termRelations={
'classifies': [
'string',
],
'isA': [
'string',
]
}
)
string
[REQUIRED]
The identifier of the Amazon DataZone domain in which a business glossary term is to be updated.
string
The identifier of the business glossary in which a term is to be updated.
string
[REQUIRED]
The identifier of the business glossary term that is to be updated.
string
The long description to be updated as part of the UpdateGlossaryTerm action.
string
The name to be updated as part of the UpdateGlossaryTerm action.
string
The short description to be updated as part of the UpdateGlossaryTerm action.
string
The status to be updated as part of the UpdateGlossaryTerm action.
dict
The term relations to be updated as part of the UpdateGlossaryTerm action.
classifies (list) --
The classifies of the term relations.
(string) --
isA (list) --
The isA property of the term relations.
(string) --
dict
Response Syntax
{
'domainId': 'string',
'glossaryId': 'string',
'id': 'string',
'longDescription': 'string',
'name': 'string',
'shortDescription': 'string',
'status': 'ENABLED'|'DISABLED',
'termRelations': {
'classifies': [
'string',
],
'isA': [
'string',
]
},
'usageRestrictions': [
'ASSET_GOVERNED_TERMS',
]
}
Response Structure
(dict) --
domainId (string) --
The identifier of the Amazon DataZone domain in which a business glossary term is to be updated.
glossaryId (string) --
The identifier of the business glossary in which a term is to be updated.
id (string) --
The identifier of the business glossary term that is to be updated.
longDescription (string) --
The long description to be updated as part of the UpdateGlossaryTerm action.
name (string) --
The name to be updated as part of the UpdateGlossaryTerm action.
shortDescription (string) --
The short description to be updated as part of the UpdateGlossaryTerm action.
status (string) --
The status to be updated as part of the UpdateGlossaryTerm action.
termRelations (dict) --
The term relations to be updated as part of the UpdateGlossaryTerm action.
classifies (list) --
The classifies of the term relations.
(string) --
isA (list) --
The isA property of the term relations.
(string) --
usageRestrictions (list) --
The usage restriction of a term within a restricted glossary.
(string) --
{'projectStatus': {'MOVING'}}
Updates the specified project in Amazon DataZone.
See also: AWS API Documentation
Request Syntax
client.update_project(
description='string',
domainIdentifier='string',
domainUnitId='string',
environmentDeploymentDetails={
'environmentFailureReasons': {
'string': [
{
'code': 'string',
'message': 'string'
},
]
},
'overallDeploymentStatus': 'PENDING_DEPLOYMENT'|'IN_PROGRESS'|'SUCCESSFUL'|'FAILED_VALIDATION'|'FAILED_DEPLOYMENT'
},
glossaryTerms=[
'string',
],
identifier='string',
name='string',
projectProfileVersion='string',
userParameters=[
{
'environmentConfigurationName': 'string',
'environmentId': 'string',
'environmentParameters': [
{
'name': 'string',
'value': 'string'
},
],
'environmentResolvedAccount': {
'awsAccountId': 'string',
'regionName': 'string',
'sourceAccountPoolId': 'string'
}
},
]
)
string
The description to be updated as part of the UpdateProject action.
string
[REQUIRED]
The ID of the Amazon DataZone domain where a project is being updated.
string
The ID of the domain unit.
dict
The environment deployment details of the project.
environmentFailureReasons (dict) --
Environment failure reasons.
(string) --
(list) --
(dict) --
The failure reasons for the environment deployment.
code (string) --
The error code for the failure reason for the environment deployment.
message (string) -- [REQUIRED]
The error message for the failure reason for the environment deployment.
overallDeploymentStatus (string) --
The overall deployment status of the environment.
list
The glossary terms to be updated as part of the UpdateProject action.
(string) --
string
[REQUIRED]
The identifier of the project that is to be updated.
string
The name to be updated as part of the UpdateProject action.
string
The project profile version to which the project should be updated. You can only specify the following string for this parameter: latest.
list
The user parameters of the project.
(dict) --
The environment configuration user parameters.
environmentConfigurationName (string) --
The environment configuration name.
environmentId (string) --
The ID of the environment.
environmentParameters (list) --
The environment parameters.
(dict) --
The parameter details of an evironment profile.
name (string) --
The name of an environment profile parameter.
value (string) --
The value of an environment profile parameter.
environmentResolvedAccount (dict) --
Specifies the account/Region that is to be used during project creation for a particular blueprint.
awsAccountId (string) -- [REQUIRED]
The ID of the resolved account.
regionName (string) -- [REQUIRED]
The name of the resolved Region.
sourceAccountPoolId (string) --
The ID of the account pool.
dict
Response Syntax
{
'createdAt': datetime(2015, 1, 1),
'createdBy': 'string',
'description': 'string',
'domainId': 'string',
'domainUnitId': 'string',
'environmentDeploymentDetails': {
'environmentFailureReasons': {
'string': [
{
'code': 'string',
'message': 'string'
},
]
},
'overallDeploymentStatus': 'PENDING_DEPLOYMENT'|'IN_PROGRESS'|'SUCCESSFUL'|'FAILED_VALIDATION'|'FAILED_DEPLOYMENT'
},
'failureReasons': [
{
'code': 'string',
'message': 'string'
},
],
'glossaryTerms': [
'string',
],
'id': 'string',
'lastUpdatedAt': datetime(2015, 1, 1),
'name': 'string',
'projectProfileId': 'string',
'projectStatus': 'ACTIVE'|'DELETING'|'DELETE_FAILED'|'UPDATING'|'UPDATE_FAILED'|'MOVING',
'userParameters': [
{
'environmentConfigurationName': 'string',
'environmentId': 'string',
'environmentParameters': [
{
'name': 'string',
'value': 'string'
},
],
'environmentResolvedAccount': {
'awsAccountId': 'string',
'regionName': 'string',
'sourceAccountPoolId': 'string'
}
},
]
}
Response Structure
(dict) --
createdAt (datetime) --
The timestamp of when the project was created.
createdBy (string) --
The Amazon DataZone user who created the project.
description (string) --
The description of the project that is to be updated.
domainId (string) --
The identifier of the Amazon DataZone domain in which a project is updated.
domainUnitId (string) --
The ID of the domain unit.
environmentDeploymentDetails (dict) --
The environment deployment details of the project.
environmentFailureReasons (dict) --
Environment failure reasons.
(string) --
(list) --
(dict) --
The failure reasons for the environment deployment.
code (string) --
The error code for the failure reason for the environment deployment.
message (string) --
The error message for the failure reason for the environment deployment.
overallDeploymentStatus (string) --
The overall deployment status of the environment.
failureReasons (list) --
Specifies the error message that is returned if the operation cannot be successfully completed.
(dict) --
Specifies the error message that is returned if the operation cannot be successfully completed.
code (string) --
The code of the project deletion error.
message (string) --
The message of the project deletion error.
glossaryTerms (list) --
The glossary terms of the project that are to be updated.
(string) --
id (string) --
The identifier of the project that is to be updated.
lastUpdatedAt (datetime) --
The timestamp of when the project was last updated.
name (string) --
The name of the project that is to be updated.
projectProfileId (string) --
The ID of the project profile.
projectStatus (string) --
The status of the project.
userParameters (list) --
The user parameters of the project.
(dict) --
The environment configuration user parameters.
environmentConfigurationName (string) --
The environment configuration name.
environmentId (string) --
The ID of the environment.
environmentParameters (list) --
The environment parameters.
(dict) --
The parameter details of an evironment profile.
name (string) --
The name of an environment profile parameter.
value (string) --
The value of an environment profile parameter.
environmentResolvedAccount (dict) --
Specifies the account/Region that is to be used during project creation for a particular blueprint.
awsAccountId (string) --
The ID of the resolved account.
regionName (string) --
The name of the resolved Region.
sourceAccountPoolId (string) --
The ID of the account pool.