search_types
Search for type definitions in Amazon DataZone by specifying domain, scope, and criteria. Returns matching asset, form, or lineage node types.
Instructions
Invokes the SearchTypes action in a specified Amazon DataZone domain to retrieve type definitions (e.g., asset types, form types, or lineage node types) that match the search criteria.
Args: domain_identifier (str): The identifier of the Amazon DataZone domain in which to invoke the SearchTypes action. Pattern: ^dzd[-][a-zA-Z0-9-]{1,36}$ (Required)
managed (bool): Whether the search is for managed types. (Required)
filters (dict, optional): A FilterClause object specifying a single filter for the search.
Only one member of the union type may be used.
max_results (int, optional): The maximum number of results to return in a single call.
Valid range: 1–50. Default is service-defined.
next_token (str, optional): Token for paginating results. Used to retrieve the next page of results
when the number of results exceeds max_results.
Length constraints: 1–8192 characters.
search_in (List[dict], optional): A list of SearchInItem objects specifying search fields.
Minimum of 1 item, maximum of 10.
search_scope (str): The scope of the search. Valid values:
"ASSET_TYPE", "FORM_TYPE", "LINEAGE_NODE_TYPE". (Required)
search_text (str, optional): The free-text string to search for.
Length constraints: 1–4096 characters.
sort (dict, optional): A SearchSort object specifying how to sort the results.Returns: dict: A response object containing: - items (List[dict]): A list of SearchTypesResultItem objects matching the query. - nextToken (str): A pagination token for retrieving the next set of results. - totalMatchCount (int): Total number of matching items.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| sort | No | ||
| filters | No | ||
| managed | Yes | ||
| search_in | No | ||
| next_token | No | ||
| max_results | No | ||
| search_text | No | ||
| search_scope | Yes | ||
| domain_identifier | Yes | ||
| owning_project_identifier | No |