Sign in

v1

latestOpenAPI 3.0.0Apache 2.0 License2026-07-141891,2951.1 MB

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).

post/v2/domains/{domainIdentifier}/types-search

Path parameters

domainIdentifierstring required

The identifier of the Amazon DataZone domain in which to invoke the <code>SearchTypes</code> action.

Request body

maxResultsinteger

The maximum number of results to return in a single call to <code>SearchTypes</code>. When the number of results to be listed is greater than the value of <code>MaxResults</code>, the response contains a <code>NextToken</code> value that you can use in a subsequent call to <code>SearchTypes</code> to list the next set of results.

nextTokenstring

When the number of results is greater than the default value for the <code>MaxResults</code> parameter, or if you explicitly specify a value for <code>MaxResults</code> that is less than the number of results, the response includes a pagination token named <code>NextToken</code>. You can specify this <code>NextToken</code> value in a subsequent call to <code>SearchTypes</code> to list the next set of results.

searchScope'ASSET_TYPE' | 'FORM_TYPE' | 'LINEAGE_NODE_TYPE' required

Specifies the scope of the search for types.

searchTextstring

Specifies the text for which to search.

managedboolean required

Specifies whether the search is managed.

Response

Success

nextTokenstring

When the number of results is greater than the default value for the <code>MaxResults</code> parameter, or if you explicitly specify a value for <code>MaxResults</code> that is less than the number of results, the response includes a pagination token named <code>NextToken</code>. You can specify this <code>NextToken</code> value in a subsequent call to <code>SearchTypes</code> to list the next set of results.

totalMatchCountinteger

Total number of search results.