dataplex-search-aspect-types

About

A dataplex-search-aspect-types tool allows to fetch the metadata template of aspect types based on search query. It’s compatible with the following sources:

• dataplex

dataplex-search-aspect-types accepts following parameters optionally:

• query - Narrows down the search of aspect types to value of this parameter. If not provided, it fetches all aspect types available to the user.
• pageSize - Number of returned aspect types in the search page. Defaults to 5.
• orderBy - Specifies the ordering of results. Supported values are: relevance (default), last_modified_timestamp, last_modified_timestamp asc.

Requirements

IAM Permissions

Dataplex uses Identity and Access Management (IAM) to control user and group access to Dataplex resources. Toolbox will use your Application Default Credentials (ADC) to authorize and authenticate when interacting with Dataplex.

In addition to setting the ADC for your server, you need to ensure the IAM identity has been given the correct IAM permissions for the tasks you intend to perform. See Dataplex Universal Catalog IAM permissions and Dataplex Universal Catalog IAM roles for more information on applying IAM permissions and roles to an identity.

Example

tools:
  dataplex-search-aspect-types:
    kind: dataplex-search-aspect-types
    source: my-dataplex-source
    description: Use this tool to find aspect types relevant to the query.

Reference