search
Search for assets, glossary terms, or data products in Amazon DataZone using text, filters, and sorting options. Retrieve paginated results with additional attributes.
Instructions
Searches for assets in Amazon DataZone.
Args: domain_identifier (str): The identifier of the Amazon DataZone domain Pattern: ^dzd[-][a-zA-Z0-9-]{1,36}$ search_scope (str): The scope of the search Valid Values: ASSET | GLOSSARY | GLOSSARY_TERM | DATA_PRODUCT additional_attributes (List[str], optional): Specifies additional attributes for the search Valid Values: FORMS | TIME_SERIES_DATA_POINT_FORMS filters (Dict[str, Any], optional): Specifies the search filters Type: FilterClause object (Union type) max_results (int, optional): Maximum number of results to return (1-50, default: 50) next_token (str, optional): Token for pagination (1-8192 characters) owning_project_identifier (str, optional): The identifier of the owning project. This is required when the user is requesting a search_scope of ASSET or DATA_PRODUCT. Pattern: ^[a-zA-Z0-9_-]{1,36}$ search_in (List[Dict[str, str]], optional): The details of the search Array Members: 1-10 items Each item contains: - attribute (str): The attribute to search in search_text (str, optional): The text to search for (1-4096 characters) sort (Dict[str, str], optional): Specifies how to sort the results Contains: - attribute (str): The attribute to sort by - order (str): The sort order (ASCENDING | DESCENDING)
Returns: Any: The API response containing: - items (list): The search results - nextToken (str): Token for pagination if more results are available - totalMatchCount (int): Total number of search results
Example:
python response = await search( domain_identifier="dzd-1234567890", search_scope="ASSET", search_text="customer data", search_in=[{"attribute": "name"}, {"attribute": "description"}], sort={"attribute": "name", "order": "ASCENDING"}, max_results=25 )
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| sort | No | ||
| filters | No | ||
| search_in | No | ||
| next_token | No | ||
| max_results | No | ||
| search_text | No | ||
| search_scope | Yes | ||
| domain_identifier | Yes | ||
| additional_attributes | No | ||
| owning_project_identifier | No |