2026/01/16 - Amazon DataZone - 3 updated api methods
Changes This release adds support for numeric filtering and complex free-text searches cases for the Search and SearchListings APIs.
{'filters': {'filter': {'intValue': 'long',
'operator': 'EQ | LE | LT | GE | GT | TEXT_SEARCH'}}}
Searches for assets in Amazon DataZone.
Search in Amazon DataZone is a powerful capability that enables users to discover and explore data assets, glossary terms, and data products across their organization. It provides both basic and advanced search functionality, allowing users to find resources based on names, descriptions, metadata, and other attributes. Search can be scoped to specific types of resources (like assets, glossary terms, or data products) and can be filtered using various criteria such as creation date, owner, or status. The search functionality is essential for making the wealth of data resources in an organization discoverable and usable, helping users find the right data for their needs quickly and efficiently.
Many search commands in Amazon DataZone are paginated, including search and search-types. When the result set is large, Amazon DataZone returns a nextToken in the response. This token can be used to retrieve the next page of results.
Prerequisites:
The --domain-identifier must refer to an existing Amazon DataZone domain.
--search-scope must be one of: ASSET, GLOSSARY_TERM, DATA_PRODUCT, or GLOSSARY.
The user must have search permissions in the specified domain.
If using --filters, ensure that the JSON is well-formed and that each filter includes valid attribute and value keys.
For paginated results, be prepared to use --next-token to fetch additional pages.
To run a standard free-text search, the searchText parameter must be supplied. By default, all searchable fields are indexed for semantic search and will return semantic matches for SearchListings queries. To prevent semantic search indexing for a custom form attribute, see the CreateFormType API documentation. To run a lexical search query, enclose the query with double quotes (""). This will disable semantic search even for fields that have semantic search enabled and will only return results that contain the keywords wrapped by double quotes (order of tokens in the query is not enforced). Free-text search is supported for all attributes annotated with @amazon.datazone#searchable.
To run a filtered search, provide filter clause using the filters parameter. To filter on glossary terms, use the special attribute __DataZoneGlossaryTerms. To filter on an indexed numeric attribute (i.e., a numeric attribute annotated with @amazon.datazone#sortable), provide a filter using the intValue parameter. The filters parameter can also be used to run more advanced free-text searches that target specific attributes (attributes must be annotated with @amazon.datazone#searchable for free-text search). Create/update timestamp filtering is supported using the special creationTime/ lastUpdatedTime attributes. Filter types can be mixed and matched to power complex queries.
To find out whether an attribute has been annotated and indexed for a given search type, use the GetFormType API to retrieve the form containing the attribute.
See also: AWS API Documentation
Request Syntax
client.search(
domainIdentifier='string',
owningProjectIdentifier='string',
maxResults=123,
nextToken='string',
searchScope='ASSET'|'GLOSSARY'|'GLOSSARY_TERM'|'DATA_PRODUCT',
searchText='string',
searchIn=[
{
'attribute': 'string'
},
],
filters={
'filter': {
'attribute': 'string',
'value': 'string',
'intValue': 123,
'operator': 'EQ'|'LE'|'LT'|'GE'|'GT'|'TEXT_SEARCH'
},
'and': [
{'... recursive ...'},
],
'or': [
{'... recursive ...'},
]
},
sort={
'attribute': 'string',
'order': 'ASCENDING'|'DESCENDING'
},
additionalAttributes=[
'FORMS'|'TIME_SERIES_DATA_POINT_FORMS'|'TEXT_MATCH_RATIONALE',
]
)
string
[REQUIRED]
The identifier of the Amazon DataZone domain.
string
The identifier of the owning project specified for the search.
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
[REQUIRED]
The scope of the search.
string
Specifies the text for which to search.
list
The details of the search.
(dict) --
The details of the search.
attribute (string) -- [REQUIRED]
The search attribute.
dict
Specifies the search filters.
filter (dict) --
A search filter in Amazon DataZone.
attribute (string) -- [REQUIRED]
A search filter attribute in Amazon DataZone.
value (string) --
A search filter string value in Amazon DataZone.
intValue (integer) --
A search filter integer value in Amazon DataZone.
operator (string) --
Specifies the search filter operator.
and (list) --
The 'and' search filter clause in Amazon DataZone.
(dict) --
A search filter clause in Amazon DataZone.
or (list) --
The 'or' search filter clause in Amazon DataZone.
(dict) --
A search filter clause in Amazon DataZone.
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.
list
Specifies additional attributes for the Search action.
(string) --
dict
Response Syntax
{
'items': [
{
'glossaryItem': {
'domainId': 'string',
'id': 'string',
'name': 'string',
'owningProjectId': 'string',
'description': 'string',
'status': 'DISABLED'|'ENABLED',
'usageRestrictions': [
'ASSET_GOVERNED_TERMS',
],
'createdAt': datetime(2015, 1, 1),
'createdBy': 'string',
'updatedAt': datetime(2015, 1, 1),
'updatedBy': 'string',
'additionalAttributes': {
'matchRationale': [
{
'textMatches': [
{
'attribute': 'string',
'text': 'string',
'matchOffsets': [
{
'startOffset': 123,
'endOffset': 123
},
]
},
]
},
]
}
},
'glossaryTermItem': {
'domainId': 'string',
'glossaryId': 'string',
'id': 'string',
'name': 'string',
'shortDescription': 'string',
'usageRestrictions': [
'ASSET_GOVERNED_TERMS',
],
'longDescription': 'string',
'termRelations': {
'isA': [
'string',
],
'classifies': [
'string',
]
},
'status': 'ENABLED'|'DISABLED',
'createdAt': datetime(2015, 1, 1),
'createdBy': 'string',
'updatedAt': datetime(2015, 1, 1),
'updatedBy': 'string',
'additionalAttributes': {
'matchRationale': [
{
'textMatches': [
{
'attribute': 'string',
'text': 'string',
'matchOffsets': [
{
'startOffset': 123,
'endOffset': 123
},
]
},
]
},
]
}
},
'assetItem': {
'domainId': 'string',
'identifier': 'string',
'name': 'string',
'typeIdentifier': 'string',
'typeRevision': 'string',
'externalIdentifier': 'string',
'description': 'string',
'createdAt': datetime(2015, 1, 1),
'createdBy': 'string',
'firstRevisionCreatedAt': datetime(2015, 1, 1),
'firstRevisionCreatedBy': 'string',
'glossaryTerms': [
'string',
],
'owningProjectId': 'string',
'additionalAttributes': {
'formsOutput': [
{
'formName': 'string',
'typeName': 'string',
'typeRevision': 'string',
'content': 'string'
},
],
'readOnlyFormsOutput': [
{
'formName': 'string',
'typeName': 'string',
'typeRevision': 'string',
'content': 'string'
},
],
'latestTimeSeriesDataPointFormsOutput': [
{
'formName': 'string',
'typeIdentifier': 'string',
'typeRevision': 'string',
'timestamp': datetime(2015, 1, 1),
'contentSummary': 'string',
'id': 'string'
},
],
'matchRationale': [
{
'textMatches': [
{
'attribute': 'string',
'text': 'string',
'matchOffsets': [
{
'startOffset': 123,
'endOffset': 123
},
]
},
]
},
]
},
'governedGlossaryTerms': [
'string',
]
},
'dataProductItem': {
'domainId': 'string',
'id': 'string',
'name': 'string',
'owningProjectId': 'string',
'description': 'string',
'glossaryTerms': [
'string',
],
'createdAt': datetime(2015, 1, 1),
'createdBy': 'string',
'firstRevisionCreatedAt': datetime(2015, 1, 1),
'firstRevisionCreatedBy': 'string',
'additionalAttributes': {
'matchRationale': [
{
'textMatches': [
{
'attribute': 'string',
'text': 'string',
'matchOffsets': [
{
'startOffset': 123,
'endOffset': 123
},
]
},
]
},
]
}
}
},
],
'nextToken': 'string',
'totalMatchCount': 123
}
Response Structure
(dict) --
items (list) --
The results of the Search action.
(dict) --
The details of the search results.
glossaryItem (dict) --
The glossary item included in the search results.
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.
description (string) --
The business glossary description.
status (string) --
The business glossary status.
usageRestrictions (list) --
The usage restrictions associated with a goverened glossary term.
(string) --
createdAt (datetime) --
The timestamp of when the glossary was created.
createdBy (string) --
The Amazon DataZone user who created the glossary.
updatedAt (datetime) --
The timestamp of when the business glossary was updated.
updatedBy (string) --
The Amazon DataZone user who updated the business glossary.
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.
text (string) --
Snippet of attribute text containing highlighted content.
matchOffsets (list) --
List of offsets indicating matching terms in the TextMatchItem text.
(dict) --
The offset of a matched term.
startOffset (integer) --
The 0-indexed number indicating the start position (inclusive) of a matched term.
endOffset (integer) --
The 0-indexed number indicating the end position (exclusive) of a matched term.
glossaryTermItem (dict) --
The glossary term item included in the search results.
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.
name (string) --
The name of the business glossary term.
shortDescription (string) --
The short description of the business glossary term.
usageRestrictions (list) --
The usage restrictions associated with a goverened glossary term.
(string) --
longDescription (string) --
The long description of the business glossary term.
termRelations (dict) --
The relations of the business glossary term.
isA (list) --
The isA property of the term relations.
(string) --
classifies (list) --
The classifies of the term relations.
(string) --
status (string) --
The status of the business glossary term.
createdAt (datetime) --
The timestamp of when a business glossary term was created.
createdBy (string) --
The Amazon DataZone user who created the business glossary.
updatedAt (datetime) --
The timestamp of when a business glossary term was updated.
updatedBy (string) --
The Amazon DataZone user who updated the business glossary term.
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.
text (string) --
Snippet of attribute text containing highlighted content.
matchOffsets (list) --
List of offsets indicating matching terms in the TextMatchItem text.
(dict) --
The offset of a matched term.
startOffset (integer) --
The 0-indexed number indicating the start position (inclusive) of a matched term.
endOffset (integer) --
The 0-indexed number indicating the end position (exclusive) of a matched term.
assetItem (dict) --
The asset item included in the search results.
domainId (string) --
The identifier of the Amazon DataZone domain in which the inventory asset exists.
identifier (string) --
the identifier of the Amazon DataZone inventory asset.
name (string) --
The name of the Amazon DataZone 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.
externalIdentifier (string) --
The external identifier of the Amazon DataZone inventory asset.
description (string) --
The description of an Amazon DataZone inventory asset.
createdAt (datetime) --
The timestamp of when the Amazon DataZone inventory asset was created.
createdBy (string) --
The Amazon DataZone user who created the 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) --
owningProjectId (string) --
The identifier of the Amazon DataZone project that owns the inventory asset.
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.
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.
content (string) --
The content of the metadata form.
readOnlyFormsOutput (list) --
The read-only forms included in the additional attributes of an inventory asset.
(dict) --
The details of a 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.
content (string) --
The content of the metadata form.
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.
formName (string) --
The name 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.
timestamp (datetime) --
The timestamp of the time series data points summary form.
contentSummary (string) --
The content of the summary of the time series data points form.
id (string) --
The ID 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.
text (string) --
Snippet of attribute text containing highlighted content.
matchOffsets (list) --
List of offsets indicating matching terms in the TextMatchItem text.
(dict) --
The offset of a matched term.
startOffset (integer) --
The 0-indexed number indicating the start position (inclusive) of a matched term.
endOffset (integer) --
The 0-indexed number indicating the end position (exclusive) of a matched term.
governedGlossaryTerms (list) --
The restricted glossary terms accociated with an asset.
(string) --
dataProductItem (dict) --
The data product.
domainId (string) --
The ID of the domain where the data product lives.
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.
description (string) --
The description of the data product.
glossaryTerms (list) --
The glossary terms of the data product.
(string) --
createdAt (datetime) --
The timestamp at which the data product was created.
createdBy (string) --
The user who created the data product.
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.
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.
text (string) --
Snippet of attribute text containing highlighted content.
matchOffsets (list) --
List of offsets indicating matching terms in the TextMatchItem text.
(dict) --
The offset of a matched term.
startOffset (integer) --
The 0-indexed number indicating the start position (inclusive) of a matched term.
endOffset (integer) --
The 0-indexed number indicating the end position (exclusive) of a matched 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.
{'filters': {'filter': {'intValue': 'long',
'operator': 'EQ | LE | LT | GE | GT | TEXT_SEARCH'}}}
Searches listings in Amazon DataZone.
SearchListings is a powerful capability that enables users to discover and explore published assets and data products across their organization. It provides both basic and advanced search functionality, allowing users to find resources based on names, descriptions, metadata, and other attributes. SearchListings also supports filtering using various criteria such as creation date, owner, or status. This API is essential for making the wealth of data resources in an organization discoverable and usable, helping users find the right data for their needs quickly and efficiently.
SearchListings returns results in a paginated format. When the result set is large, the response will include a nextToken, which can be used to retrieve the next page of results.
The SearchListings API gives users flexibility in specifying what kind of search is run.
To run a standard free-text search, the searchText parameter must be supplied. By default, all searchable fields are indexed for semantic search and will return semantic matches for SearchListings queries. To prevent semantic search indexing for a custom form attribute, see the CreateFormType API documentation. To run a lexical search query, enclose the query with double quotes (""). This will disable semantic search even for fields that have semantic search enabled and will only return results that contain the keywords wrapped by double quotes (order of tokens in the query is not enforced). Free-text search is supported for all attributes annotated with @amazon.datazone#searchable.
To run a filtered search, provide filter clause using the filters parameter. To filter on glossary terms, use the special attribute __DataZoneGlossaryTerms. To filter on an indexed numeric attribute (i.e., a numeric attribute annotated with @amazon.datazone#sortable), provide a filter using the intValue parameter. The filters parameter can also be used to run more advanced free-text searches that target specific attributes (attributes must be annotated with @amazon.datazone#searchable for free-text search). Create/update timestamp filtering is supported using the special creationTime/ lastUpdatedTime attributes. Filter types can be mixed and matched to power complex queries.
To find out whether an attribute has been annotated and indexed for a given search type, use the GetFormType API to retrieve the form containing the attribute.
See also: AWS API Documentation
Request Syntax
client.search_listings(
domainIdentifier='string',
searchText='string',
searchIn=[
{
'attribute': 'string'
},
],
maxResults=123,
nextToken='string',
filters={
'filter': {
'attribute': 'string',
'value': 'string',
'intValue': 123,
'operator': 'EQ'|'LE'|'LT'|'GE'|'GT'|'TEXT_SEARCH'
},
'and': [
{'... recursive ...'},
],
'or': [
{'... recursive ...'},
]
},
aggregations=[
{
'attribute': 'string',
'displayValue': 'string'
},
],
sort={
'attribute': 'string',
'order': 'ASCENDING'|'DESCENDING'
},
additionalAttributes=[
'FORMS'|'TIME_SERIES_DATA_POINT_FORMS'|'TEXT_MATCH_RATIONALE',
]
)
string
[REQUIRED]
The identifier of the domain in which to search listings.
string
Specifies the text for which to search.
list
The details of the search.
(dict) --
The details of the search.
attribute (string) -- [REQUIRED]
The search attribute.
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.
dict
Specifies the filters for the search of listings.
filter (dict) --
A search filter in Amazon DataZone.
attribute (string) -- [REQUIRED]
A search filter attribute in Amazon DataZone.
value (string) --
A search filter string value in Amazon DataZone.
intValue (integer) --
A search filter integer value in Amazon DataZone.
operator (string) --
Specifies the search filter operator.
and (list) --
The 'and' search filter clause in Amazon DataZone.
(dict) --
A search filter clause in Amazon DataZone.
or (list) --
The 'or' search filter clause in Amazon DataZone.
(dict) --
A search filter clause in Amazon DataZone.
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.
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.
list
Specifies additional attributes for the search.
(string) --
dict
Response Syntax
{
'items': [
{
'assetListing': {
'listingId': 'string',
'listingRevision': 'string',
'name': 'string',
'entityId': 'string',
'entityRevision': 'string',
'entityType': 'string',
'description': 'string',
'createdAt': datetime(2015, 1, 1),
'listingCreatedBy': 'string',
'listingUpdatedBy': 'string',
'glossaryTerms': [
{
'name': 'string',
'shortDescription': 'string'
},
],
'governedGlossaryTerms': [
{
'name': 'string',
'shortDescription': 'string'
},
],
'owningProjectId': 'string',
'additionalAttributes': {
'forms': 'string',
'matchRationale': [
{
'textMatches': [
{
'attribute': 'string',
'text': 'string',
'matchOffsets': [
{
'startOffset': 123,
'endOffset': 123
},
]
},
]
},
],
'latestTimeSeriesDataPointForms': [
{
'formName': 'string',
'typeIdentifier': 'string',
'typeRevision': 'string',
'timestamp': datetime(2015, 1, 1),
'contentSummary': 'string',
'id': 'string'
},
]
}
},
'dataProductListing': {
'listingId': 'string',
'listingRevision': 'string',
'name': 'string',
'entityId': 'string',
'entityRevision': 'string',
'description': 'string',
'createdAt': datetime(2015, 1, 1),
'listingCreatedBy': 'string',
'listingUpdatedBy': 'string',
'glossaryTerms': [
{
'name': 'string',
'shortDescription': 'string'
},
],
'owningProjectId': 'string',
'additionalAttributes': {
'forms': 'string',
'matchRationale': [
{
'textMatches': [
{
'attribute': 'string',
'text': 'string',
'matchOffsets': [
{
'startOffset': 123,
'endOffset': 123
},
]
},
]
},
]
},
'items': [
{
'listingId': 'string',
'listingRevision': 'string',
'glossaryTerms': [
{
'name': 'string',
'shortDescription': 'string'
},
]
},
]
}
},
],
'nextToken': 'string',
'totalMatchCount': 123,
'aggregates': [
{
'attribute': 'string',
'displayValue': 'string',
'items': [
{
'value': 'string',
'count': 123,
'displayValue': 'string'
},
]
},
]
}
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.
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).
name (string) --
The name of the inventory asset.
entityId (string) --
The identifier of the inventory asset.
entityRevision (string) --
The revision of the inventory asset.
entityType (string) --
The type of the inventory asset.
description (string) --
The description 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.
listingCreatedBy (string) --
The Amazon DataZone user who created the listing.
listingUpdatedBy (string) --
The Amazon DataZone user who updated the listing.
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.
owningProjectId (string) --
The identifier of the project that owns the inventory asset.
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.
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.
text (string) --
Snippet of attribute text containing highlighted content.
matchOffsets (list) --
List of offsets indicating matching terms in the TextMatchItem text.
(dict) --
The offset of a matched term.
startOffset (integer) --
The 0-indexed number indicating the start position (inclusive) of a matched term.
endOffset (integer) --
The 0-indexed number indicating the end position (exclusive) of a matched term.
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.
formName (string) --
The name 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.
timestamp (datetime) --
The timestamp of the time series data points summary form.
contentSummary (string) --
The content of the summary of the time series data points form.
id (string) --
The ID of the time series data points summary form.
dataProductListing (dict) --
The data product listing.
listingId (string) --
The ID of the listing.
listingRevision (string) --
The revision of the listing.
name (string) --
The name 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.
description (string) --
The description of the asset of the asset of the data product.
createdAt (datetime) --
The timestamp at which the asset of the data product listing was created.
listingCreatedBy (string) --
The timestamp at which the listing was created.
listingUpdatedBy (string) --
The user who updated the listing.
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.
owningProjectId (string) --
The ID of the owning project of the asset of the data product.
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.
text (string) --
Snippet of attribute text containing highlighted content.
matchOffsets (list) --
List of offsets indicating matching terms in the TextMatchItem text.
(dict) --
The offset of a matched term.
startOffset (integer) --
The 0-indexed number indicating the start position (inclusive) of a matched term.
endOffset (integer) --
The 0-indexed number indicating the end position (exclusive) of a matched term.
items (list) --
The data of the asset of the data product.
(dict) --
The results of the data product summary.
listingId (string) --
The ID of the data product listing.
listingRevision (string) --
The revision 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.
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.
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.
value (string) --
The attribute value of the 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.
{'filters': {'filter': {'intValue': 'long',
'operator': 'EQ | LE | LT | GE | GT | TEXT_SEARCH'}}}
Searches for types in Amazon DataZone.
Prerequisites:
The --domain-identifier must refer to an existing Amazon DataZone domain.
--search-scope must be one of the valid values including: ASSET_TYPE, GLOSSARY_TERM_TYPE, DATA_PRODUCT_TYPE.
The --managed flag must be present without a value.
The user must have permissions for form or asset types in the domain.
If using --filters, ensure that the JSON is valid.
Filters contain correct structure (attribute, value, operator).
See also: AWS API Documentation
Request Syntax
client.search_types(
domainIdentifier='string',
maxResults=123,
nextToken='string',
searchScope='ASSET_TYPE'|'FORM_TYPE'|'LINEAGE_NODE_TYPE',
searchText='string',
searchIn=[
{
'attribute': 'string'
},
],
filters={
'filter': {
'attribute': 'string',
'value': 'string',
'intValue': 123,
'operator': 'EQ'|'LE'|'LT'|'GE'|'GT'|'TEXT_SEARCH'
},
'and': [
{'... recursive ...'},
],
'or': [
{'... recursive ...'},
]
},
sort={
'attribute': 'string',
'order': 'ASCENDING'|'DESCENDING'
},
managed=True|False
)
string
[REQUIRED]
The identifier of the Amazon DataZone domain in which to invoke the SearchTypes action.
integer
The maximum number of results to return in a single call to SearchTypes. 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 SearchTypes 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 SearchTypes to list the next set of results.
string
[REQUIRED]
Specifies the scope of the search for types.
string
Specifies the text for which to search.
list
The details of the search.
(dict) --
The details of the search.
attribute (string) -- [REQUIRED]
The search attribute.
dict
The filters for the SearchTypes action.
filter (dict) --
A search filter in Amazon DataZone.
attribute (string) -- [REQUIRED]
A search filter attribute in Amazon DataZone.
value (string) --
A search filter string value in Amazon DataZone.
intValue (integer) --
A search filter integer value in Amazon DataZone.
operator (string) --
Specifies the search filter operator.
and (list) --
The 'and' search filter clause in Amazon DataZone.
(dict) --
A search filter clause in Amazon DataZone.
or (list) --
The 'or' search filter clause in Amazon DataZone.
(dict) --
A search filter clause in Amazon DataZone.
dict
The specifies the way to sort the SearchTypes 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.
boolean
[REQUIRED]
Specifies whether the search is managed.
dict
Response Syntax
{
'items': [
{
'assetTypeItem': {
'domainId': 'string',
'name': 'string',
'revision': 'string',
'description': 'string',
'formsOutput': {
'string': {
'typeName': 'string',
'typeRevision': 'string',
'required': True|False
}
},
'owningProjectId': 'string',
'originDomainId': 'string',
'originProjectId': 'string',
'createdAt': datetime(2015, 1, 1),
'createdBy': 'string',
'updatedAt': datetime(2015, 1, 1),
'updatedBy': 'string'
},
'formTypeItem': {
'domainId': 'string',
'name': 'string',
'revision': 'string',
'model': {
'smithy': 'string'
},
'status': 'ENABLED'|'DISABLED',
'owningProjectId': 'string',
'originDomainId': 'string',
'originProjectId': 'string',
'createdAt': datetime(2015, 1, 1),
'createdBy': 'string',
'description': 'string',
'imports': [
{
'name': 'string',
'revision': 'string'
},
]
},
'lineageNodeTypeItem': {
'domainId': 'string',
'name': 'string',
'description': 'string',
'createdAt': datetime(2015, 1, 1),
'createdBy': 'string',
'updatedAt': datetime(2015, 1, 1),
'updatedBy': 'string',
'revision': 'string',
'formsOutput': {
'string': {
'typeName': 'string',
'typeRevision': 'string',
'required': True|False
}
}
}
},
],
'nextToken': 'string',
'totalMatchCount': 123
}
Response Structure
(dict) --
items (list) --
The results of the SearchTypes action.
(dict) --
The details of the results of the SearchTypes action.
assetTypeItem (dict) --
The asset type included in the results of the SearchTypes action.
domainId (string) --
The identifier of the Amazon DataZone domain where the asset type exists.
name (string) --
The name of the asset type.
revision (string) --
The revision of the asset type.
description (string) --
The description of the asset type.
formsOutput (dict) --
The forms included in the details of the asset type.
(string) --
(dict) --
The details of the form entry.
typeName (string) --
The name of the type of the form entry.
typeRevision (string) --
The type revision of the form entry.
required (boolean) --
Specifies whether a form entry is required.
owningProjectId (string) --
The identifier of the Amazon DataZone project that owns the asset type.
originDomainId (string) --
The identifier of the Amazon DataZone domain where the asset type was originally created.
originProjectId (string) --
The identifier of the Amazon DataZone project where the asset type exists.
createdAt (datetime) --
The timestamp of when the asset type was created.
createdBy (string) --
The Amazon DataZone user who created the asset type.
updatedAt (datetime) --
The timestamp of when the asset type was updated.
updatedBy (string) --
The Amazon DataZone user who updated the asset type.
formTypeItem (dict) --
The form type included in the results of the SearchTypes action.
domainId (string) --
The identifier of the Amazon DataZone domain in which the form type exists.
name (string) --
The name of the form type.
revision (string) --
The revision of the form type.
model (dict) --
The model of the form type.
smithy (string) --
Indicates the smithy model of the API.
status (string) --
The status of the form type.
owningProjectId (string) --
The identifier of the project that owns the form type.
originDomainId (string) --
The identifier of the Amazon DataZone domain in which the form type was originally created.
originProjectId (string) --
The identifier of the project in which the form type was originally created.
createdAt (datetime) --
The timestamp of when the metadata form type was created.
createdBy (string) --
The Amazon DataZone user who created teh metadata form type.
description (string) --
The description of the metadata form type.
imports (list) --
The imports specified in the form type.
(dict) --
The details of the import of the metadata form type.
name (string) --
The name of the import.
revision (string) --
The revision of the import.
lineageNodeTypeItem (dict) --
The details of a data lineage node type.
domainId (string) --
The ID of the domain where the data lineage node type lives.
name (string) --
The name of the data lineage node type.
description (string) --
The description of the data lineage node type.
createdAt (datetime) --
The timestamp at which the data lineage node type was created.
createdBy (string) --
The user who created the data lineage node type.
updatedAt (datetime) --
The timestamp at which the data lineage node type was updated.
updatedBy (string) --
The user who updated the data lineage node type.
revision (string) --
The revision of the data lineage node type.
formsOutput (dict) --
The forms output of the data lineage node type.
(string) --
(dict) --
The details of the form entry.
typeName (string) --
The name of the type of the form entry.
typeRevision (string) --
The type revision of the form entry.
required (boolean) --
Specifies whether a form entry is required.
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 SearchTypes to list the next set of results.
totalMatchCount (integer) --
Total number of search results.